klaviyo-api-sdk 8.0.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (613) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +289 -0
  3. data/README.md +1414 -402
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +11 -11
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +645 -573
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +1764 -1446
  8. data/lib/klaviyo-api-sdk/api/coupons_api.rb +329 -281
  9. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +11 -5
  10. data/lib/klaviyo-api-sdk/api/events_api.rb +140 -122
  11. data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
  12. data/lib/klaviyo-api-sdk/api/forms_api.rb +80 -60
  13. data/lib/klaviyo-api-sdk/api/images_api.rb +40 -28
  14. data/lib/klaviyo-api-sdk/api/lists_api.rb +328 -153
  15. data/lib/klaviyo-api-sdk/api/metrics_api.rb +590 -21
  16. data/lib/klaviyo-api-sdk/api/profiles_api.rb +1054 -548
  17. data/lib/klaviyo-api-sdk/api/reporting_api.rb +341 -19
  18. data/lib/klaviyo-api-sdk/api/reviews_api.rb +212 -0
  19. data/lib/klaviyo-api-sdk/api/segments_api.rb +341 -166
  20. data/lib/klaviyo-api-sdk/api/tags_api.rb +745 -625
  21. data/lib/klaviyo-api-sdk/api/templates_api.rb +493 -84
  22. data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +250 -0
  23. data/lib/klaviyo-api-sdk/api/webhooks_api.rb +32 -32
  24. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  25. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  26. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  27. data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
  28. data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
  29. data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
  30. data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
  31. data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
  32. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
  34. data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
  35. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  36. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
  37. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
  38. data/lib/klaviyo-api-sdk/models/block_display_options.rb +274 -0
  39. data/lib/klaviyo-api-sdk/models/block_enum.rb +36 -0
  40. data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
  41. data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
  42. data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
  43. data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
  44. data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
  45. data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
  46. data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
  47. data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
  48. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  49. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  50. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
  51. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  52. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  53. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
  54. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  56. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  57. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  58. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
  60. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  62. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
  64. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
  65. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  66. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  67. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  68. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
  69. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  71. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  72. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
  73. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  76. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  77. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  78. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  79. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  80. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +273 -0
  83. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +239 -0
  84. data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
  85. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
  86. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -1
  88. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  93. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  113. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  120. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  127. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  152. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/content_repeat.rb +238 -0
  179. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
  192. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
  194. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +245 -0
  205. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  206. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/device_metadata.rb +3 -3
  214. data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
  215. data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +36 -0
  216. data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +288 -0
  217. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +2 -2
  221. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +19 -19
  222. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb +105 -0
  223. data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
  227. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  230. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +13 -2
  235. data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
  236. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
  242. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
  243. data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
  244. data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
  245. data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
  249. data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
  250. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -1
  252. data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +273 -0
  253. data/lib/klaviyo-api-sdk/models/{utm_params_sub_object.rb → flow_tracking_setting_static_param.rb} +15 -16
  254. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -1
  261. data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +36 -0
  264. data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +224 -0
  265. data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +238 -0
  266. data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +314 -0
  267. data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +36 -0
  268. data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +224 -0
  269. data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +238 -0
  270. data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +287 -0
  271. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
  284. data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/html_block.rb +252 -0
  287. data/lib/klaviyo-api-sdk/models/html_block_data.rb +248 -0
  288. data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
  289. data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
  304. data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
  305. data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
  306. data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
  307. data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
  308. data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
  309. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  310. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  312. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  313. data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
  314. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  316. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  317. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  318. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
  320. data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
  321. data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
  323. data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
  324. data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
  325. data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
  328. data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
  329. data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
  330. data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
  332. data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
  333. data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
  334. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  335. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  336. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  337. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
  339. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  340. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
  342. data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
  343. data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
  344. data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
  345. data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
  349. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
  351. data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
  353. data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
  354. data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
  356. data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
  360. data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
  363. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  364. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
  365. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
  367. data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
  369. data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
  370. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  371. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  372. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
  373. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  374. data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
  375. data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
  376. data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
  378. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
  379. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
  380. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
  381. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
  382. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
  383. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
  384. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
  387. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  388. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
  390. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
  391. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
  392. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
  393. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
  394. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
  395. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
  396. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
  397. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
  398. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  399. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
  400. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  401. data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
  402. data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
  403. data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
  404. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
  405. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
  406. data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
  407. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  408. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
  409. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
  410. data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
  411. data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
  412. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
  413. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
  414. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
  415. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
  416. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
  417. data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
  418. data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
  419. data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
  420. data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
  421. data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
  422. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  423. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  424. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
  425. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
  426. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
  427. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
  428. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  429. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  430. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
  431. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  432. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
  433. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  434. data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
  435. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
  436. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
  437. data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
  438. data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
  439. data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
  440. data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
  441. data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
  442. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
  443. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
  444. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
  445. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
  446. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
  447. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
  448. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
  449. data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
  450. data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
  451. data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
  452. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
  453. data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
  454. data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
  455. data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
  456. data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
  457. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  458. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  459. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  460. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  461. data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
  462. data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
  463. data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
  464. data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
  465. data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
  466. data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
  467. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
  468. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
  469. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
  470. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
  471. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  472. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
  473. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  474. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  475. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
  476. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  477. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
  478. data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
  479. data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
  480. data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
  481. data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
  482. data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
  483. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
  484. data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
  485. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
  486. data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +2 -7
  487. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
  488. data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
  489. data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
  490. data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
  491. data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
  492. data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
  493. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  494. data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
  495. data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
  496. data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
  497. data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
  498. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  499. data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
  500. data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
  501. data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
  502. data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
  503. data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
  504. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
  505. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  506. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
  507. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
  508. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  509. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
  510. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
  511. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  512. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  513. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
  514. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  515. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  516. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  517. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  518. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  519. data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
  520. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  521. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
  522. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  523. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  524. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
  525. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
  526. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  527. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
  528. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
  529. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  530. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
  531. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  532. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  533. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
  534. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  535. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  536. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
  537. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
  538. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  539. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  540. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  541. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
  542. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
  543. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  544. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  545. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
  546. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  547. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  548. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  549. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  550. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  551. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
  552. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  553. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  554. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  555. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
  556. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  557. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  558. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  559. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  560. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  561. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  562. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  563. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  564. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
  565. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  566. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  567. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
  568. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  569. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  570. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  571. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
  572. data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
  573. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  574. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  575. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
  576. data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
  577. data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
  578. data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
  579. data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
  580. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  581. data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
  582. data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
  583. data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
  584. data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
  585. data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
  586. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
  587. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
  588. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
  589. data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
  590. data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
  591. data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
  592. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
  593. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
  594. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
  595. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
  596. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
  597. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
  598. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
  599. data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
  600. data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
  601. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
  602. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
  603. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
  604. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
  605. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
  606. data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
  607. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
  608. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
  609. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
  610. data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
  611. data/lib/klaviyo-api-sdk/version.rb +1 -1
  612. data/lib/klaviyo-api-sdk.rb +58 -3
  613. metadata +64 -9
@@ -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: 2024-07-15
6
+ The version of the OpenAPI document: 2024-10-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -19,6 +19,334 @@ module KlaviyoAPI
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Bulk Subscribe Profiles
23
+ # 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: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
24
+ # @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.
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [nil]
27
+ def bulk_subscribe_profiles(subscription_create_job_create_query, opts = {})
28
+ bulk_subscribe_profiles_with_http_info(subscription_create_job_create_query, opts)
29
+ nil
30
+ end
31
+
32
+ # alias of `bulk_subscribe_profiles`
33
+ alias subscribe_profiles bulk_subscribe_profiles
34
+
35
+ # alias of `bulk_subscribe_profiles`
36
+ alias create_profile_subscription_bulk_create_job bulk_subscribe_profiles
37
+
38
+ # Bulk Subscribe Profiles
39
+ # 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: 1000 This endpoint now supports a &#x60;historical_import&#x60; flag. If this flag is set &#x60;true&#x60;, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \&quot;Added to list\&quot; flows. This is useful for importing historical data where you have already collected consent. If &#x60;historical_import&#x60; is set to true, the &#x60;consented_at&#x60; field is required and must be in the past.&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;
40
+ # @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.
41
+ # @param [Hash] opts the optional parameters
42
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
43
+ def bulk_subscribe_profiles_with_http_info(subscription_create_job_create_query, opts = {})
44
+ if @api_client.config.debugging
45
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_subscribe_profiles ...'
46
+ end
47
+ # verify the required parameter 'subscription_create_job_create_query' is set
48
+ if @api_client.config.client_side_validation && subscription_create_job_create_query.nil?
49
+ fail ArgumentError, "Missing the required parameter 'subscription_create_job_create_query' when calling ProfilesApi.bulk_subscribe_profiles"
50
+ end
51
+ # resource path
52
+ local_var_path = '/api/profile-subscription-bulk-create-jobs'
53
+
54
+ # query parameters
55
+ query_params = opts[:query_params] || {}
56
+
57
+ # header parameters
58
+ header_params = opts[:header_params] || {}
59
+ # klaviyo api revision
60
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
61
+ # HTTP header 'Accept' (if needed)
62
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
63
+ # HTTP header 'Content-Type'
64
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
65
+ if !content_type.nil?
66
+ header_params['Content-Type'] = content_type
67
+ end
68
+
69
+ # form parameters
70
+ form_params = opts[:form_params] || {}
71
+
72
+ # http body (model)
73
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_create_job_create_query)
74
+
75
+ # return_type
76
+ return_type = opts[:debug_return_type]
77
+
78
+ # auth_names
79
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
80
+
81
+ new_options = opts.merge(
82
+ :operation => :"ProfilesApi.bulk_subscribe_profiles",
83
+ :header_params => header_params,
84
+ :query_params => query_params,
85
+ :form_params => form_params,
86
+ :body => post_body,
87
+ :auth_names => auth_names,
88
+ :return_type => return_type
89
+ )
90
+
91
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug "API called: ProfilesApi#bulk_subscribe_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
94
+ end
95
+ return data, status_code, headers
96
+ end
97
+
98
+ # alias of `bulk_subscribe_profiles_with_http_info`
99
+ alias subscribe_profiles_with_http_info bulk_subscribe_profiles_with_http_info
100
+
101
+ # alias of `bulk_subscribe_profiles_with_http_info`
102
+ alias create_profile_subscription_bulk_create_job_with_http_info bulk_subscribe_profiles_with_http_info
103
+
104
+ # Bulk Suppress Profiles
105
+ # Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
106
+ # @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.
107
+ # @param [Hash] opts the optional parameters
108
+ # @return [Hash<String, Object>]
109
+ def bulk_suppress_profiles(suppression_create_job_create_query, opts = {})
110
+ data, _status_code, _headers = bulk_suppress_profiles_with_http_info(suppression_create_job_create_query, opts)
111
+ data
112
+ end
113
+
114
+ # alias of `bulk_suppress_profiles`
115
+ alias suppress_profiles bulk_suppress_profiles
116
+
117
+ # alias of `bulk_suppress_profiles`
118
+ alias create_profile_suppression_bulk_create_job bulk_suppress_profiles
119
+
120
+ # Bulk Suppress Profiles
121
+ # Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address 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;
122
+ # @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.
123
+ # @param [Hash] opts the optional parameters
124
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
125
+ def bulk_suppress_profiles_with_http_info(suppression_create_job_create_query, opts = {})
126
+ if @api_client.config.debugging
127
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_suppress_profiles ...'
128
+ end
129
+ # verify the required parameter 'suppression_create_job_create_query' is set
130
+ if @api_client.config.client_side_validation && suppression_create_job_create_query.nil?
131
+ fail ArgumentError, "Missing the required parameter 'suppression_create_job_create_query' when calling ProfilesApi.bulk_suppress_profiles"
132
+ end
133
+ # resource path
134
+ local_var_path = '/api/profile-suppression-bulk-create-jobs'
135
+
136
+ # query parameters
137
+ query_params = opts[:query_params] || {}
138
+
139
+ # header parameters
140
+ header_params = opts[:header_params] || {}
141
+ # klaviyo api revision
142
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
143
+ # HTTP header 'Accept' (if needed)
144
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
145
+ # HTTP header 'Content-Type'
146
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
147
+ if !content_type.nil?
148
+ header_params['Content-Type'] = content_type
149
+ end
150
+
151
+ # form parameters
152
+ form_params = opts[:form_params] || {}
153
+
154
+ # http body (model)
155
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_create_job_create_query)
156
+
157
+ # return_type
158
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
159
+
160
+ # auth_names
161
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
162
+
163
+ new_options = opts.merge(
164
+ :operation => :"ProfilesApi.bulk_suppress_profiles",
165
+ :header_params => header_params,
166
+ :query_params => query_params,
167
+ :form_params => form_params,
168
+ :body => post_body,
169
+ :auth_names => auth_names,
170
+ :return_type => return_type
171
+ )
172
+
173
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug "API called: ProfilesApi#bulk_suppress_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
176
+ end
177
+ return data, status_code, headers
178
+ end
179
+
180
+ # alias of `bulk_suppress_profiles_with_http_info`
181
+ alias suppress_profiles_with_http_info bulk_suppress_profiles_with_http_info
182
+
183
+ # alias of `bulk_suppress_profiles_with_http_info`
184
+ alias create_profile_suppression_bulk_create_job_with_http_info bulk_suppress_profiles_with_http_info
185
+
186
+ # Bulk Unsubscribe Profiles
187
+ # 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`
188
+ # @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.
189
+ # @param [Hash] opts the optional parameters
190
+ # @return [nil]
191
+ def bulk_unsubscribe_profiles(subscription_delete_job_create_query, opts = {})
192
+ bulk_unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts)
193
+ nil
194
+ end
195
+
196
+ # alias of `bulk_unsubscribe_profiles`
197
+ alias unsubscribe_profiles bulk_unsubscribe_profiles
198
+
199
+ # alias of `bulk_unsubscribe_profiles`
200
+ alias create_profile_subscription_bulk_delete_job bulk_unsubscribe_profiles
201
+
202
+ # Bulk Unsubscribe Profiles
203
+ # 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;
204
+ # @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.
205
+ # @param [Hash] opts the optional parameters
206
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
207
+ def bulk_unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts = {})
208
+ if @api_client.config.debugging
209
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_unsubscribe_profiles ...'
210
+ end
211
+ # verify the required parameter 'subscription_delete_job_create_query' is set
212
+ if @api_client.config.client_side_validation && subscription_delete_job_create_query.nil?
213
+ fail ArgumentError, "Missing the required parameter 'subscription_delete_job_create_query' when calling ProfilesApi.bulk_unsubscribe_profiles"
214
+ end
215
+ # resource path
216
+ local_var_path = '/api/profile-subscription-bulk-delete-jobs'
217
+
218
+ # query parameters
219
+ query_params = opts[:query_params] || {}
220
+
221
+ # header parameters
222
+ header_params = opts[:header_params] || {}
223
+ # klaviyo api revision
224
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
225
+ # HTTP header 'Accept' (if needed)
226
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
227
+ # HTTP header 'Content-Type'
228
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
229
+ if !content_type.nil?
230
+ header_params['Content-Type'] = content_type
231
+ end
232
+
233
+ # form parameters
234
+ form_params = opts[:form_params] || {}
235
+
236
+ # http body (model)
237
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_delete_job_create_query)
238
+
239
+ # return_type
240
+ return_type = opts[:debug_return_type]
241
+
242
+ # auth_names
243
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
244
+
245
+ new_options = opts.merge(
246
+ :operation => :"ProfilesApi.bulk_unsubscribe_profiles",
247
+ :header_params => header_params,
248
+ :query_params => query_params,
249
+ :form_params => form_params,
250
+ :body => post_body,
251
+ :auth_names => auth_names,
252
+ :return_type => return_type
253
+ )
254
+
255
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
256
+ if @api_client.config.debugging
257
+ @api_client.config.logger.debug "API called: ProfilesApi#bulk_unsubscribe_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
258
+ end
259
+ return data, status_code, headers
260
+ end
261
+
262
+ # alias of `bulk_unsubscribe_profiles_with_http_info`
263
+ alias unsubscribe_profiles_with_http_info bulk_unsubscribe_profiles_with_http_info
264
+
265
+ # alias of `bulk_unsubscribe_profiles_with_http_info`
266
+ alias create_profile_subscription_bulk_delete_job_with_http_info bulk_unsubscribe_profiles_with_http_info
267
+
268
+ # Bulk Unsuppress Profiles
269
+ # Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
270
+ # @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.
271
+ # @param [Hash] opts the optional parameters
272
+ # @return [Hash<String, Object>]
273
+ def bulk_unsuppress_profiles(suppression_delete_job_create_query, opts = {})
274
+ data, _status_code, _headers = bulk_unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts)
275
+ data
276
+ end
277
+
278
+ # alias of `bulk_unsuppress_profiles`
279
+ alias unsuppress_profiles bulk_unsuppress_profiles
280
+
281
+ # alias of `bulk_unsuppress_profiles`
282
+ alias create_profile_suppression_bulk_delete_job bulk_unsuppress_profiles
283
+
284
+ # Bulk Unsuppress Profiles
285
+ # Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. This only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email address 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;
286
+ # @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.
287
+ # @param [Hash] opts the optional parameters
288
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
289
+ def bulk_unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts = {})
290
+ if @api_client.config.debugging
291
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.bulk_unsuppress_profiles ...'
292
+ end
293
+ # verify the required parameter 'suppression_delete_job_create_query' is set
294
+ if @api_client.config.client_side_validation && suppression_delete_job_create_query.nil?
295
+ fail ArgumentError, "Missing the required parameter 'suppression_delete_job_create_query' when calling ProfilesApi.bulk_unsuppress_profiles"
296
+ end
297
+ # resource path
298
+ local_var_path = '/api/profile-suppression-bulk-delete-jobs'
299
+
300
+ # query parameters
301
+ query_params = opts[:query_params] || {}
302
+
303
+ # header parameters
304
+ header_params = opts[:header_params] || {}
305
+ # klaviyo api revision
306
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
307
+ # HTTP header 'Accept' (if needed)
308
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
309
+ # HTTP header 'Content-Type'
310
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
311
+ if !content_type.nil?
312
+ header_params['Content-Type'] = content_type
313
+ end
314
+
315
+ # form parameters
316
+ form_params = opts[:form_params] || {}
317
+
318
+ # http body (model)
319
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_delete_job_create_query)
320
+
321
+ # return_type
322
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
323
+
324
+ # auth_names
325
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
326
+
327
+ new_options = opts.merge(
328
+ :operation => :"ProfilesApi.bulk_unsuppress_profiles",
329
+ :header_params => header_params,
330
+ :query_params => query_params,
331
+ :form_params => form_params,
332
+ :body => post_body,
333
+ :auth_names => auth_names,
334
+ :return_type => return_type
335
+ )
336
+
337
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
338
+ if @api_client.config.debugging
339
+ @api_client.config.logger.debug "API called: ProfilesApi#bulk_unsuppress_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
340
+ end
341
+ return data, status_code, headers
342
+ end
343
+
344
+ # alias of `bulk_unsuppress_profiles_with_http_info`
345
+ alias unsuppress_profiles_with_http_info bulk_unsuppress_profiles_with_http_info
346
+
347
+ # alias of `bulk_unsuppress_profiles_with_http_info`
348
+ alias create_profile_suppression_bulk_delete_job_with_http_info bulk_unsuppress_profiles_with_http_info
349
+
22
350
  # Create or Update Profile
23
351
  # 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. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
24
352
  # @param profile_upsert_query [ProfileUpsertQuery]
@@ -29,6 +357,9 @@ module KlaviyoAPI
29
357
  data
30
358
  end
31
359
 
360
+ # alias of `create_or_update_profile`
361
+ alias create_profile_import create_or_update_profile
362
+
32
363
  # Create or Update Profile
33
364
  # 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. Note that setting a field to &#x60;null&#x60; will clear out the field, whereas not including a field in your request will leave it unchanged.&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
365
  # @param profile_upsert_query [ProfileUpsertQuery]
@@ -43,7 +374,7 @@ module KlaviyoAPI
43
374
  fail ArgumentError, "Missing the required parameter 'profile_upsert_query' when calling ProfilesApi.create_or_update_profile"
44
375
  end
45
376
  # resource path
46
- local_var_path = '/api/profile-import/'
377
+ local_var_path = '/api/profile-import'
47
378
 
48
379
  # query parameters
49
380
  query_params = opts[:query_params] || {}
@@ -51,11 +382,11 @@ module KlaviyoAPI
51
382
  # header parameters
52
383
  header_params = opts[:header_params] || {}
53
384
  # klaviyo api revision
54
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
385
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
55
386
  # HTTP header 'Accept' (if needed)
56
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
387
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
57
388
  # HTTP header 'Content-Type'
58
- content_type = @api_client.select_header_content_type(['application/json'])
389
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
59
390
  if !content_type.nil?
60
391
  header_params['Content-Type'] = content_type
61
392
  end
@@ -89,6 +420,9 @@ module KlaviyoAPI
89
420
  return data, status_code, headers
90
421
  end
91
422
 
423
+ # alias of `create_or_update_profile_with_http_info`
424
+ alias create_profile_import_with_http_info create_or_update_profile_with_http_info
425
+
92
426
  # Create Profile
93
427
  # Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
94
428
  # @param profile_create_query [ProfileCreateQuery]
@@ -113,7 +447,7 @@ module KlaviyoAPI
113
447
  fail ArgumentError, "Missing the required parameter 'profile_create_query' when calling ProfilesApi.create_profile"
114
448
  end
115
449
  # resource path
116
- local_var_path = '/api/profiles/'
450
+ local_var_path = '/api/profiles'
117
451
 
118
452
  # query parameters
119
453
  query_params = opts[:query_params] || {}
@@ -121,11 +455,11 @@ module KlaviyoAPI
121
455
  # header parameters
122
456
  header_params = opts[:header_params] || {}
123
457
  # klaviyo api revision
124
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
458
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
125
459
  # HTTP header 'Accept' (if needed)
126
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
460
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
127
461
  # HTTP header 'Content-Type'
128
- content_type = @api_client.select_header_content_type(['application/json'])
462
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
129
463
  if !content_type.nil?
130
464
  header_params['Content-Type'] = content_type
131
465
  end
@@ -183,7 +517,7 @@ module KlaviyoAPI
183
517
  fail ArgumentError, "Missing the required parameter 'push_token_create_query' when calling ProfilesApi.create_push_token"
184
518
  end
185
519
  # resource path
186
- local_var_path = '/api/push-tokens/'
520
+ local_var_path = '/api/push-tokens'
187
521
 
188
522
  # query parameters
189
523
  query_params = opts[:query_params] || {}
@@ -191,11 +525,11 @@ module KlaviyoAPI
191
525
  # header parameters
192
526
  header_params = opts[:header_params] || {}
193
527
  # klaviyo api revision
194
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
528
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
195
529
  # HTTP header 'Accept' (if needed)
196
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
530
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
197
531
  # HTTP header 'Content-Type'
198
- content_type = @api_client.select_header_content_type(['application/json'])
532
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
199
533
  if !content_type.nil?
200
534
  header_params['Content-Type'] = content_type
201
535
  end
@@ -229,34 +563,40 @@ module KlaviyoAPI
229
563
  return data, status_code, headers
230
564
  end
231
565
 
232
- # Get Bulk Profile Import Job
566
+ # Get Bulk Import Profiles Job
233
567
  # 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`
234
568
  # @param job_id [String] ID of the job to retrieve.
235
569
  # @param [Hash] opts the optional parameters
236
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#sparse-fieldsets
238
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
570
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
571
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
572
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
239
573
  # @return [Hash<String, Object>]
240
- def get_bulk_profile_import_job(job_id, opts = {})
241
- data, _status_code, _headers = get_bulk_profile_import_job_with_http_info(job_id, opts)
574
+ def get_bulk_import_profiles_job(job_id, opts = {})
575
+ data, _status_code, _headers = get_bulk_import_profiles_job_with_http_info(job_id, opts)
242
576
  data
243
577
  end
244
578
 
245
- # Get Bulk Profile Import Job
579
+ # alias of `get_bulk_import_profiles_job`
580
+ alias get_bulk_profile_import_job get_bulk_import_profiles_job
581
+
582
+ # alias of `get_bulk_import_profiles_job`
583
+ alias get_profile_bulk_import_job get_bulk_import_profiles_job
584
+
585
+ # Get Bulk Import Profiles Job
246
586
  # 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;
247
587
  # @param job_id [String] ID of the job to retrieve.
248
588
  # @param [Hash] opts the optional parameters
249
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#sparse-fieldsets
251
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
589
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
590
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
591
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
252
592
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
253
- def get_bulk_profile_import_job_with_http_info(job_id, opts = {})
593
+ def get_bulk_import_profiles_job_with_http_info(job_id, opts = {})
254
594
  if @api_client.config.debugging
255
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job ...'
595
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_import_profiles_job ...'
256
596
  end
257
597
  # verify the required parameter 'job_id' is set
258
598
  if @api_client.config.client_side_validation && job_id.nil?
259
- fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_profile_import_job"
599
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_import_profiles_job"
260
600
  end
261
601
  allowable_values = ["name", "created", "updated", "opt_in_process"]
262
602
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
@@ -266,25 +606,127 @@ module KlaviyoAPI
266
606
  if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
267
607
  fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
268
608
  end
269
- allowable_values = ["lists"]
270
- if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
271
- fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
609
+ allowable_values = ["lists"]
610
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
611
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
612
+ end
613
+ # resource path
614
+ local_var_path = '/api/profile-bulk-import-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
615
+
616
+ # query parameters
617
+ query_params = opts[:query_params] || {}
618
+ query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
619
+ query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
620
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
621
+
622
+ # header parameters
623
+ header_params = opts[:header_params] || {}
624
+ # klaviyo api revision
625
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
626
+ # HTTP header 'Accept' (if needed)
627
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
628
+
629
+ # form parameters
630
+ form_params = opts[:form_params] || {}
631
+
632
+ # http body (model)
633
+ post_body = opts[:debug_body]
634
+
635
+ # return_type
636
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
637
+
638
+ # auth_names
639
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
640
+
641
+ new_options = opts.merge(
642
+ :operation => :"ProfilesApi.get_bulk_import_profiles_job",
643
+ :header_params => header_params,
644
+ :query_params => query_params,
645
+ :form_params => form_params,
646
+ :body => post_body,
647
+ :auth_names => auth_names,
648
+ :return_type => return_type
649
+ )
650
+
651
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
652
+ if @api_client.config.debugging
653
+ @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
654
+ end
655
+ return data, status_code, headers
656
+ end
657
+
658
+ # alias of `get_bulk_import_profiles_job_with_http_info`
659
+ alias get_bulk_profile_import_job_with_http_info get_bulk_import_profiles_job_with_http_info
660
+
661
+ # alias of `get_bulk_import_profiles_job_with_http_info`
662
+ alias get_profile_bulk_import_job_with_http_info get_bulk_import_profiles_job_with_http_info
663
+
664
+ # Get Bulk Import Profiles Jobs
665
+ # 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`
666
+ # @param [Hash] opts the optional parameters
667
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
668
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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;
669
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
670
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
671
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
672
+ # @return [Hash<String, Object>]
673
+ def get_bulk_import_profiles_jobs(opts = {})
674
+ data, _status_code, _headers = get_bulk_import_profiles_jobs_with_http_info(opts)
675
+ data
676
+ end
677
+
678
+ # alias of `get_bulk_import_profiles_jobs`
679
+ alias get_bulk_profile_import_jobs get_bulk_import_profiles_jobs
680
+
681
+ # alias of `get_bulk_import_profiles_jobs`
682
+ alias get_profile_bulk_import_jobs get_bulk_import_profiles_jobs
683
+
684
+ # Get Bulk Import Profiles Jobs
685
+ # 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;
686
+ # @param [Hash] opts the optional parameters
687
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
688
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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;
689
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
690
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
691
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
692
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
693
+ def get_bulk_import_profiles_jobs_with_http_info(opts = {})
694
+ if @api_client.config.debugging
695
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_import_profiles_jobs ...'
696
+ end
697
+ allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "expires_at", "started_at"]
698
+ if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
699
+ fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
700
+ end
701
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
702
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_import_profiles_jobs, must be smaller than or equal to 100.'
703
+ end
704
+
705
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
706
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_import_profiles_jobs, must be greater than or equal to 1.'
707
+ end
708
+
709
+ allowable_values = ["created_at", "-created_at"]
710
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
711
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
272
712
  end
273
713
  # resource path
274
- local_var_path = '/api/profile-bulk-import-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
714
+ local_var_path = '/api/profile-bulk-import-jobs'
275
715
 
276
716
  # query parameters
277
717
  query_params = opts[:query_params] || {}
278
- query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
279
718
  query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
280
- query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
719
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
720
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
721
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
722
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
281
723
 
282
724
  # header parameters
283
725
  header_params = opts[:header_params] || {}
284
726
  # klaviyo api revision
285
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
727
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
286
728
  # HTTP header 'Accept' (if needed)
287
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
729
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
288
730
 
289
731
  # form parameters
290
732
  form_params = opts[:form_params] || {}
@@ -299,7 +741,7 @@ module KlaviyoAPI
299
741
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
300
742
 
301
743
  new_options = opts.merge(
302
- :operation => :"ProfilesApi.get_bulk_profile_import_job",
744
+ :operation => :"ProfilesApi.get_bulk_import_profiles_jobs",
303
745
  :header_params => header_params,
304
746
  :query_params => query_params,
305
747
  :form_params => form_params,
@@ -310,67 +752,62 @@ module KlaviyoAPI
310
752
 
311
753
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
312
754
  if @api_client.config.debugging
313
- @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
755
+ @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_import_profiles_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
314
756
  end
315
757
  return data, status_code, headers
316
758
  end
317
759
 
318
- # Get Bulk Profile Import Job Errors
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`
320
- # @param id [String]
760
+ # alias of `get_bulk_import_profiles_jobs_with_http_info`
761
+ alias get_bulk_profile_import_jobs_with_http_info get_bulk_import_profiles_jobs_with_http_info
762
+
763
+ # alias of `get_bulk_import_profiles_jobs_with_http_info`
764
+ alias get_profile_bulk_import_jobs_with_http_info get_bulk_import_profiles_jobs_with_http_info
765
+
766
+ # Get Bulk Suppress Profiles Job
767
+ # Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
768
+ # @param job_id [String] ID of the job to retrieve.
321
769
  # @param [Hash] opts the optional parameters
322
- # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
323
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
324
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
770
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
325
771
  # @return [Hash<String, Object>]
326
- def get_bulk_profile_import_job_import_errors(id, opts = {})
327
- data, _status_code, _headers = get_bulk_profile_import_job_import_errors_with_http_info(id, opts)
772
+ def get_bulk_suppress_profiles_job(job_id, opts = {})
773
+ data, _status_code, _headers = get_bulk_suppress_profiles_job_with_http_info(job_id, opts)
328
774
  data
329
775
  end
330
776
 
331
- # Get Bulk Profile Import Job Errors
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;
333
- # @param id [String]
777
+ # alias of `get_bulk_suppress_profiles_job`
778
+ alias get_profile_suppression_bulk_create_job get_bulk_suppress_profiles_job
779
+
780
+ # Get Bulk Suppress Profiles Job
781
+ # Get the bulk suppress profiles job with the given job 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;subscriptions:read&#x60;
782
+ # @param job_id [String] ID of the job to retrieve.
334
783
  # @param [Hash] opts the optional parameters
335
- # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
336
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
337
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
784
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
338
785
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
339
- def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {})
786
+ def get_bulk_suppress_profiles_job_with_http_info(job_id, opts = {})
340
787
  if @api_client.config.debugging
341
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_import_errors ...'
342
- end
343
- # verify the required parameter 'id' is set
344
- if @api_client.config.client_side_validation && id.nil?
345
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_import_errors"
346
- end
347
- allowable_values = ["code", "title", "detail", "source", "source.pointer", "original_payload"]
348
- if @api_client.config.client_side_validation && opts[:'fields_import_error'] && !opts[:'fields_import_error'].all? { |item| allowable_values.include?(item) }
349
- fail ArgumentError, "invalid value for \"fields_import_error\", must include one of #{allowable_values}"
788
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_suppress_profiles_job ...'
350
789
  end
351
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
352
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_import_errors, must be smaller than or equal to 100.'
790
+ # verify the required parameter 'job_id' is set
791
+ if @api_client.config.client_side_validation && job_id.nil?
792
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_suppress_profiles_job"
353
793
  end
354
-
355
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
356
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_import_errors, must be greater than or equal to 1.'
794
+ allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
795
+ if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_create_job'] && !opts[:'fields_profile_suppression_bulk_create_job'].all? { |item| allowable_values.include?(item) }
796
+ fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_create_job\", must include one of #{allowable_values}"
357
797
  end
358
-
359
798
  # resource path
360
- local_var_path = '/api/profile-bulk-import-jobs/{id}/import-errors/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
799
+ local_var_path = '/api/profile-suppression-bulk-create-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
361
800
 
362
801
  # query parameters
363
802
  query_params = opts[:query_params] || {}
364
- query_params[:'fields[import-error]'] = @api_client.build_collection_param(opts[:'fields_import_error'], :csv) if !opts[:'fields_import_error'].nil?
365
- query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
366
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
803
+ query_params[:'fields[profile-suppression-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_create_job'], :csv) if !opts[:'fields_profile_suppression_bulk_create_job'].nil?
367
804
 
368
805
  # header parameters
369
806
  header_params = opts[:header_params] || {}
370
807
  # klaviyo api revision
371
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
808
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
372
809
  # HTTP header 'Accept' (if needed)
373
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
810
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
374
811
 
375
812
  # form parameters
376
813
  form_params = opts[:form_params] || {}
@@ -385,7 +822,7 @@ module KlaviyoAPI
385
822
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
386
823
 
387
824
  new_options = opts.merge(
388
- :operation => :"ProfilesApi.get_bulk_profile_import_job_import_errors",
825
+ :operation => :"ProfilesApi.get_bulk_suppress_profiles_job",
389
826
  :header_params => header_params,
390
827
  :query_params => query_params,
391
828
  :form_params => form_params,
@@ -396,53 +833,66 @@ module KlaviyoAPI
396
833
 
397
834
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
398
835
  if @api_client.config.debugging
399
- @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_import_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
836
+ @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_suppress_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
400
837
  end
401
838
  return data, status_code, headers
402
839
  end
403
840
 
404
- # Get Bulk Profile Import Job Lists
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`
406
- # @param id [String]
841
+ # alias of `get_bulk_suppress_profiles_job_with_http_info`
842
+ alias get_profile_suppression_bulk_create_job_with_http_info get_bulk_suppress_profiles_job_with_http_info
843
+
844
+ # Get Bulk Suppress Profiles Jobs
845
+ # Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
407
846
  # @param [Hash] opts the optional parameters
408
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
847
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
848
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;list_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;segment_id&#x60;: &#x60;equals&#x60;
849
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
850
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
409
851
  # @return [Hash<String, Object>]
410
- def get_bulk_profile_import_job_lists(id, opts = {})
411
- data, _status_code, _headers = get_bulk_profile_import_job_lists_with_http_info(id, opts)
852
+ def get_bulk_suppress_profiles_jobs(opts = {})
853
+ data, _status_code, _headers = get_bulk_suppress_profiles_jobs_with_http_info(opts)
412
854
  data
413
855
  end
414
856
 
415
- # Get Bulk Profile Import Job Lists
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;
417
- # @param id [String]
857
+ # alias of `get_bulk_suppress_profiles_jobs`
858
+ alias get_profile_suppression_bulk_create_jobs get_bulk_suppress_profiles_jobs
859
+
860
+ # Get Bulk Suppress Profiles Jobs
861
+ # Get the status of all bulk profile suppression jobs.&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:read&#x60;
418
862
  # @param [Hash] opts the optional parameters
419
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
863
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
864
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;list_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;segment_id&#x60;: &#x60;equals&#x60;
865
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
866
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
420
867
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
421
- def get_bulk_profile_import_job_lists_with_http_info(id, opts = {})
868
+ def get_bulk_suppress_profiles_jobs_with_http_info(opts = {})
422
869
  if @api_client.config.debugging
423
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_lists ...'
870
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_suppress_profiles_jobs ...'
424
871
  end
425
- # verify the required parameter 'id' is set
426
- if @api_client.config.client_side_validation && id.nil?
427
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_lists"
872
+ allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
873
+ if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_create_job'] && !opts[:'fields_profile_suppression_bulk_create_job'].all? { |item| allowable_values.include?(item) }
874
+ fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_create_job\", must include one of #{allowable_values}"
428
875
  end
429
- allowable_values = ["name", "created", "updated", "opt_in_process"]
430
- if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
431
- fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
876
+ allowable_values = ["created", "-created"]
877
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
878
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
432
879
  end
433
880
  # resource path
434
- local_var_path = '/api/profile-bulk-import-jobs/{id}/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
881
+ local_var_path = '/api/profile-suppression-bulk-create-jobs'
435
882
 
436
883
  # query parameters
437
884
  query_params = opts[:query_params] || {}
438
- query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
885
+ query_params[:'fields[profile-suppression-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_create_job'], :csv) if !opts[:'fields_profile_suppression_bulk_create_job'].nil?
886
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
887
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
888
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
439
889
 
440
890
  # header parameters
441
891
  header_params = opts[:header_params] || {}
442
892
  # klaviyo api revision
443
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
893
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
444
894
  # HTTP header 'Accept' (if needed)
445
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
895
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
446
896
 
447
897
  # form parameters
448
898
  form_params = opts[:form_params] || {}
@@ -457,7 +907,7 @@ module KlaviyoAPI
457
907
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
458
908
 
459
909
  new_options = opts.merge(
460
- :operation => :"ProfilesApi.get_bulk_profile_import_job_lists",
910
+ :operation => :"ProfilesApi.get_bulk_suppress_profiles_jobs",
461
911
  :header_params => header_params,
462
912
  :query_params => query_params,
463
913
  :form_params => form_params,
@@ -468,74 +918,59 @@ module KlaviyoAPI
468
918
 
469
919
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
470
920
  if @api_client.config.debugging
471
- @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
921
+ @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_suppress_profiles_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
472
922
  end
473
923
  return data, status_code, headers
474
924
  end
475
925
 
476
- # Get Bulk Profile Import Job Profiles
477
- # Get profiles 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`
478
- # @param id [String]
926
+ # alias of `get_bulk_suppress_profiles_jobs_with_http_info`
927
+ alias get_profile_suppression_bulk_create_jobs_with_http_info get_bulk_suppress_profiles_jobs_with_http_info
928
+
929
+ # Get Bulk Unsuppress Profiles Job
930
+ # Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
931
+ # @param job_id [String] ID of the job to retrieve.
479
932
  # @param [Hash] opts the optional parameters
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;
481
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
482
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
483
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
933
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
484
934
  # @return [Hash<String, Object>]
485
- def get_bulk_profile_import_job_profiles(id, opts = {})
486
- data, _status_code, _headers = get_bulk_profile_import_job_profiles_with_http_info(id, opts)
935
+ def get_bulk_unsuppress_profiles_job(job_id, opts = {})
936
+ data, _status_code, _headers = get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts)
487
937
  data
488
938
  end
489
939
 
490
- # Get Bulk Profile Import Job Profiles
491
- # Get profiles 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;
492
- # @param id [String]
940
+ # alias of `get_bulk_unsuppress_profiles_job`
941
+ alias get_profile_suppression_bulk_delete_job get_bulk_unsuppress_profiles_job
942
+
943
+ # Get Bulk Unsuppress Profiles Job
944
+ # Get the bulk unsuppress profiles job with the given job 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;subscriptions:read&#x60;
945
+ # @param job_id [String] ID of the job to retrieve.
493
946
  # @param [Hash] opts the optional parameters
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;
495
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
496
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
497
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
947
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
498
948
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
499
- def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {})
949
+ def get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts = {})
500
950
  if @api_client.config.debugging
501
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_profiles ...'
502
- end
503
- # verify the required parameter 'id' is set
504
- if @api_client.config.client_side_validation && id.nil?
505
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_profiles"
506
- end
507
- allowable_values = ["subscriptions", "predictive_analytics"]
508
- if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
509
- fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
510
- end
511
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
512
- if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
513
- fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
951
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_unsuppress_profiles_job ...'
514
952
  end
515
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
516
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_profiles, must be smaller than or equal to 100.'
953
+ # verify the required parameter 'job_id' is set
954
+ if @api_client.config.client_side_validation && job_id.nil?
955
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_unsuppress_profiles_job"
517
956
  end
518
-
519
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
520
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_profiles, must be greater than or equal to 1.'
957
+ allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
958
+ if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_delete_job'] && !opts[:'fields_profile_suppression_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
959
+ fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_delete_job\", must include one of #{allowable_values}"
521
960
  end
522
-
523
961
  # resource path
524
- local_var_path = '/api/profile-bulk-import-jobs/{id}/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
962
+ local_var_path = '/api/profile-suppression-bulk-delete-jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
525
963
 
526
964
  # query parameters
527
965
  query_params = opts[:query_params] || {}
528
- query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
529
- query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
530
- query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
531
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
966
+ query_params[:'fields[profile-suppression-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_delete_job'], :csv) if !opts[:'fields_profile_suppression_bulk_delete_job'].nil?
532
967
 
533
968
  # header parameters
534
969
  header_params = opts[:header_params] || {}
535
970
  # klaviyo api revision
536
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
971
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
537
972
  # HTTP header 'Accept' (if needed)
538
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
973
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
539
974
 
540
975
  # form parameters
541
976
  form_params = opts[:form_params] || {}
@@ -550,7 +985,7 @@ module KlaviyoAPI
550
985
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
551
986
 
552
987
  new_options = opts.merge(
553
- :operation => :"ProfilesApi.get_bulk_profile_import_job_profiles",
988
+ :operation => :"ProfilesApi.get_bulk_unsuppress_profiles_job",
554
989
  :header_params => header_params,
555
990
  :query_params => query_params,
556
991
  :form_params => form_params,
@@ -561,46 +996,66 @@ module KlaviyoAPI
561
996
 
562
997
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
563
998
  if @api_client.config.debugging
564
- @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
999
+ @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_unsuppress_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
565
1000
  end
566
1001
  return data, status_code, headers
567
1002
  end
568
1003
 
569
- # Get Bulk Profile Import Job Relationships Lists
570
- # Get list relationship 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`
571
- # @param id [String]
1004
+ # alias of `get_bulk_unsuppress_profiles_job_with_http_info`
1005
+ alias get_profile_suppression_bulk_delete_job_with_http_info get_bulk_unsuppress_profiles_job_with_http_info
1006
+
1007
+ # Get Bulk Unsuppress Profiles Jobs
1008
+ # Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
572
1009
  # @param [Hash] opts the optional parameters
1010
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1011
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;list_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;segment_id&#x60;: &#x60;equals&#x60;
1012
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1013
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
573
1014
  # @return [Hash<String, Object>]
574
- def get_bulk_profile_import_job_relationships_lists(id, opts = {})
575
- data, _status_code, _headers = get_bulk_profile_import_job_relationships_lists_with_http_info(id, opts)
1015
+ def get_bulk_unsuppress_profiles_jobs(opts = {})
1016
+ data, _status_code, _headers = get_bulk_unsuppress_profiles_jobs_with_http_info(opts)
576
1017
  data
577
1018
  end
578
1019
 
579
- # Get Bulk Profile Import Job Relationships Lists
580
- # Get list relationship 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;
581
- # @param id [String]
1020
+ # alias of `get_bulk_unsuppress_profiles_jobs`
1021
+ alias get_profile_suppression_bulk_delete_jobs get_bulk_unsuppress_profiles_jobs
1022
+
1023
+ # Get Bulk Unsuppress Profiles Jobs
1024
+ # Get all bulk unsuppress profiles jobs.&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:read&#x60;
582
1025
  # @param [Hash] opts the optional parameters
1026
+ # @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1027
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;list_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;segment_id&#x60;: &#x60;equals&#x60;
1028
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1029
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
583
1030
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
584
- def get_bulk_profile_import_job_relationships_lists_with_http_info(id, opts = {})
1031
+ def get_bulk_unsuppress_profiles_jobs_with_http_info(opts = {})
585
1032
  if @api_client.config.debugging
586
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_relationships_lists ...'
1033
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_unsuppress_profiles_jobs ...'
587
1034
  end
588
- # verify the required parameter 'id' is set
589
- if @api_client.config.client_side_validation && id.nil?
590
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_relationships_lists"
1035
+ allowable_values = ["status", "created_at", "total_count", "completed_count", "completed_at", "skipped_count"]
1036
+ if @api_client.config.client_side_validation && opts[:'fields_profile_suppression_bulk_delete_job'] && !opts[:'fields_profile_suppression_bulk_delete_job'].all? { |item| allowable_values.include?(item) }
1037
+ fail ArgumentError, "invalid value for \"fields_profile_suppression_bulk_delete_job\", must include one of #{allowable_values}"
1038
+ end
1039
+ allowable_values = ["created", "-created"]
1040
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1041
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
591
1042
  end
592
1043
  # resource path
593
- local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1044
+ local_var_path = '/api/profile-suppression-bulk-delete-jobs'
594
1045
 
595
1046
  # query parameters
596
1047
  query_params = opts[:query_params] || {}
1048
+ query_params[:'fields[profile-suppression-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_profile_suppression_bulk_delete_job'], :csv) if !opts[:'fields_profile_suppression_bulk_delete_job'].nil?
1049
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1050
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1051
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
597
1052
 
598
1053
  # header parameters
599
1054
  header_params = opts[:header_params] || {}
600
1055
  # klaviyo api revision
601
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1056
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
602
1057
  # HTTP header 'Accept' (if needed)
603
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1058
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
604
1059
 
605
1060
  # form parameters
606
1061
  form_params = opts[:form_params] || {}
@@ -615,7 +1070,7 @@ module KlaviyoAPI
615
1070
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
616
1071
 
617
1072
  new_options = opts.merge(
618
- :operation => :"ProfilesApi.get_bulk_profile_import_job_relationships_lists",
1073
+ :operation => :"ProfilesApi.get_bulk_unsuppress_profiles_jobs",
619
1074
  :header_params => header_params,
620
1075
  :query_params => query_params,
621
1076
  :form_params => form_params,
@@ -626,60 +1081,76 @@ module KlaviyoAPI
626
1081
 
627
1082
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
628
1083
  if @api_client.config.debugging
629
- @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1084
+ @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_unsuppress_profiles_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
630
1085
  end
631
1086
  return data, status_code, headers
632
1087
  end
633
1088
 
634
- # Get Bulk Profile Import Job Relationships Profiles
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`
1089
+ # alias of `get_bulk_unsuppress_profiles_jobs_with_http_info`
1090
+ alias get_profile_suppression_bulk_delete_jobs_with_http_info get_bulk_unsuppress_profiles_jobs_with_http_info
1091
+
1092
+ # Get Errors for Bulk Import Profiles Job
1093
+ # 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`
636
1094
  # @param id [String]
637
1095
  # @param [Hash] opts the optional parameters
638
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
1096
+ # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1097
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
639
1098
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
640
1099
  # @return [Hash<String, Object>]
641
- def get_bulk_profile_import_job_relationships_profiles(id, opts = {})
642
- data, _status_code, _headers = get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts)
1100
+ def get_errors_for_bulk_import_profiles_job(id, opts = {})
1101
+ data, _status_code, _headers = get_errors_for_bulk_import_profiles_job_with_http_info(id, opts)
643
1102
  data
644
1103
  end
645
1104
 
646
- # Get Bulk Profile Import Job Relationships Profiles
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;
1105
+ # alias of `get_errors_for_bulk_import_profiles_job`
1106
+ alias get_bulk_profile_import_job_import_errors get_errors_for_bulk_import_profiles_job
1107
+
1108
+ # alias of `get_errors_for_bulk_import_profiles_job`
1109
+ alias get_profile_bulk_import_job_import_errors get_errors_for_bulk_import_profiles_job
1110
+
1111
+ # Get Errors for Bulk Import Profiles Job
1112
+ # 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;
648
1113
  # @param id [String]
649
1114
  # @param [Hash] opts the optional parameters
650
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
1115
+ # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1116
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
651
1117
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
652
1118
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
653
- def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = {})
1119
+ def get_errors_for_bulk_import_profiles_job_with_http_info(id, opts = {})
654
1120
  if @api_client.config.debugging
655
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_job_relationships_profiles ...'
1121
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_errors_for_bulk_import_profiles_job ...'
656
1122
  end
657
1123
  # verify the required parameter 'id' is set
658
1124
  if @api_client.config.client_side_validation && id.nil?
659
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_relationships_profiles"
1125
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_errors_for_bulk_import_profiles_job"
1126
+ end
1127
+ allowable_values = ["code", "title", "detail", "source", "source.pointer", "original_payload"]
1128
+ if @api_client.config.client_side_validation && opts[:'fields_import_error'] && !opts[:'fields_import_error'].all? { |item| allowable_values.include?(item) }
1129
+ fail ArgumentError, "invalid value for \"fields_import_error\", must include one of #{allowable_values}"
660
1130
  end
661
1131
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
662
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_relationships_profiles, must be smaller than or equal to 100.'
1132
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_errors_for_bulk_import_profiles_job, must be smaller than or equal to 100.'
663
1133
  end
664
1134
 
665
1135
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
666
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_job_relationships_profiles, must be greater than or equal to 1.'
1136
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_errors_for_bulk_import_profiles_job, must be greater than or equal to 1.'
667
1137
  end
668
1138
 
669
1139
  # resource path
670
- local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1140
+ local_var_path = '/api/profile-bulk-import-jobs/{id}/import-errors'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
671
1141
 
672
1142
  # query parameters
673
1143
  query_params = opts[:query_params] || {}
1144
+ query_params[:'fields[import-error]'] = @api_client.build_collection_param(opts[:'fields_import_error'], :csv) if !opts[:'fields_import_error'].nil?
674
1145
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
675
1146
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
676
1147
 
677
1148
  # header parameters
678
1149
  header_params = opts[:header_params] || {}
679
1150
  # klaviyo api revision
680
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1151
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
681
1152
  # HTTP header 'Accept' (if needed)
682
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1153
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
683
1154
 
684
1155
  # form parameters
685
1156
  form_params = opts[:form_params] || {}
@@ -694,7 +1165,7 @@ module KlaviyoAPI
694
1165
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
695
1166
 
696
1167
  new_options = opts.merge(
697
- :operation => :"ProfilesApi.get_bulk_profile_import_job_relationships_profiles",
1168
+ :operation => :"ProfilesApi.get_errors_for_bulk_import_profiles_job",
698
1169
  :header_params => header_params,
699
1170
  :query_params => query_params,
700
1171
  :form_params => form_params,
@@ -705,71 +1176,65 @@ module KlaviyoAPI
705
1176
 
706
1177
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
707
1178
  if @api_client.config.debugging
708
- @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_job_relationships_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1179
+ @api_client.config.logger.debug "API called: ProfilesApi#get_errors_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
709
1180
  end
710
1181
  return data, status_code, headers
711
1182
  end
712
1183
 
713
- # Get Bulk Profile Import Jobs
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`
1184
+ # alias of `get_errors_for_bulk_import_profiles_job_with_http_info`
1185
+ alias get_bulk_profile_import_job_import_errors_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
1186
+
1187
+ # alias of `get_errors_for_bulk_import_profiles_job_with_http_info`
1188
+ alias get_profile_bulk_import_job_import_errors_with_http_info get_errors_for_bulk_import_profiles_job_with_http_info
1189
+
1190
+ # Get List for Bulk Import Profiles Job
1191
+ # 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`
1192
+ # @param id [String]
715
1193
  # @param [Hash] opts the optional parameters
716
- # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
717
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
719
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
720
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
1194
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
721
1195
  # @return [Hash<String, Object>]
722
- def get_bulk_profile_import_jobs(opts = {})
723
- data, _status_code, _headers = get_bulk_profile_import_jobs_with_http_info(opts)
1196
+ def get_list_for_bulk_import_profiles_job(id, opts = {})
1197
+ data, _status_code, _headers = get_list_for_bulk_import_profiles_job_with_http_info(id, opts)
724
1198
  data
725
1199
  end
726
1200
 
727
- # Get Bulk Profile Import Jobs
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;
1201
+ # alias of `get_list_for_bulk_import_profiles_job`
1202
+ alias get_bulk_profile_import_job_lists get_list_for_bulk_import_profiles_job
1203
+
1204
+ # alias of `get_list_for_bulk_import_profiles_job`
1205
+ alias get_profile_bulk_import_job_lists get_list_for_bulk_import_profiles_job
1206
+
1207
+ # Get List for Bulk Import Profiles Job
1208
+ # 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;
1209
+ # @param id [String]
729
1210
  # @param [Hash] opts the optional parameters
730
- # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
731
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
733
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
734
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
1211
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
735
1212
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
736
- def get_bulk_profile_import_jobs_with_http_info(opts = {})
1213
+ def get_list_for_bulk_import_profiles_job_with_http_info(id, opts = {})
737
1214
  if @api_client.config.debugging
738
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_bulk_profile_import_jobs ...'
739
- end
740
- allowable_values = ["status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "expires_at", "started_at"]
741
- if @api_client.config.client_side_validation && opts[:'fields_profile_bulk_import_job'] && !opts[:'fields_profile_bulk_import_job'].all? { |item| allowable_values.include?(item) }
742
- fail ArgumentError, "invalid value for \"fields_profile_bulk_import_job\", must include one of #{allowable_values}"
743
- end
744
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
745
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_jobs, must be smaller than or equal to 100.'
1215
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_list_for_bulk_import_profiles_job ...'
746
1216
  end
747
-
748
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
749
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_bulk_profile_import_jobs, must be greater than or equal to 1.'
1217
+ # verify the required parameter 'id' is set
1218
+ if @api_client.config.client_side_validation && id.nil?
1219
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_list_for_bulk_import_profiles_job"
750
1220
  end
751
-
752
- allowable_values = ["created_at", "-created_at"]
753
- if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
754
- fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1221
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
1222
+ if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
1223
+ fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
755
1224
  end
756
1225
  # resource path
757
- local_var_path = '/api/profile-bulk-import-jobs/'
1226
+ local_var_path = '/api/profile-bulk-import-jobs/{id}/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
758
1227
 
759
1228
  # query parameters
760
1229
  query_params = opts[:query_params] || {}
761
- query_params[:'fields[profile-bulk-import-job]'] = @api_client.build_collection_param(opts[:'fields_profile_bulk_import_job'], :csv) if !opts[:'fields_profile_bulk_import_job'].nil?
762
- query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
763
- query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
764
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
765
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1230
+ query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
766
1231
 
767
1232
  # header parameters
768
1233
  header_params = opts[:header_params] || {}
769
1234
  # klaviyo api revision
770
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1235
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
771
1236
  # HTTP header 'Accept' (if needed)
772
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1237
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
773
1238
 
774
1239
  # form parameters
775
1240
  form_params = opts[:form_params] || {}
@@ -784,7 +1249,7 @@ module KlaviyoAPI
784
1249
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
785
1250
 
786
1251
  new_options = opts.merge(
787
- :operation => :"ProfilesApi.get_bulk_profile_import_jobs",
1252
+ :operation => :"ProfilesApi.get_list_for_bulk_import_profiles_job",
788
1253
  :header_params => header_params,
789
1254
  :query_params => query_params,
790
1255
  :form_params => form_params,
@@ -795,81 +1260,58 @@ module KlaviyoAPI
795
1260
 
796
1261
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
797
1262
  if @api_client.config.debugging
798
- @api_client.config.logger.debug "API called: ProfilesApi#get_bulk_profile_import_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1263
+ @api_client.config.logger.debug "API called: ProfilesApi#get_list_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
799
1264
  end
800
1265
  return data, status_code, headers
801
1266
  end
802
1267
 
803
- # Get Profile
804
- # Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
1268
+ # alias of `get_list_for_bulk_import_profiles_job_with_http_info`
1269
+ alias get_bulk_profile_import_job_lists_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
1270
+
1271
+ # alias of `get_list_for_bulk_import_profiles_job_with_http_info`
1272
+ alias get_profile_bulk_import_job_lists_with_http_info get_list_for_bulk_import_profiles_job_with_http_info
1273
+
1274
+ # Get List IDs for Bulk Import Profiles Job
1275
+ # Get list relationship 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`
805
1276
  # @param id [String]
806
1277
  # @param [Hash] opts the optional parameters
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;
808
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
809
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
810
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
811
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
812
1278
  # @return [Hash<String, Object>]
813
- def get_profile(id, opts = {})
814
- data, _status_code, _headers = get_profile_with_http_info(id, opts)
1279
+ def get_list_ids_for_bulk_import_profiles_job(id, opts = {})
1280
+ data, _status_code, _headers = get_list_ids_for_bulk_import_profiles_job_with_http_info(id, opts)
815
1281
  data
816
1282
  end
817
1283
 
818
- # Get Profile
819
- # Get 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:read&#x60;
1284
+ # alias of `get_list_ids_for_bulk_import_profiles_job`
1285
+ alias get_bulk_profile_import_job_relationships_lists get_list_ids_for_bulk_import_profiles_job
1286
+
1287
+ # alias of `get_list_ids_for_bulk_import_profiles_job`
1288
+ alias get_profile_bulk_import_job_relationships_lists get_list_ids_for_bulk_import_profiles_job
1289
+
1290
+ # Get List IDs for Bulk Import Profiles Job
1291
+ # Get list relationship 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;
820
1292
  # @param id [String]
821
1293
  # @param [Hash] opts the optional parameters
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;
823
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
824
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
825
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
826
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
827
1294
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
828
- def get_profile_with_http_info(id, opts = {})
1295
+ def get_list_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
829
1296
  if @api_client.config.debugging
830
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile ...'
1297
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_list_ids_for_bulk_import_profiles_job ...'
831
1298
  end
832
1299
  # verify the required parameter 'id' is set
833
1300
  if @api_client.config.client_side_validation && id.nil?
834
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile"
835
- end
836
- allowable_values = ["subscriptions", "predictive_analytics"]
837
- if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
838
- fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
839
- end
840
- allowable_values = ["name", "created", "updated", "opt_in_process"]
841
- if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
842
- fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
843
- end
844
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
845
- if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
846
- fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
847
- end
848
- allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
849
- if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
850
- fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
851
- end
852
- allowable_values = ["lists", "segments"]
853
- if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
854
- fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1301
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_list_ids_for_bulk_import_profiles_job"
855
1302
  end
856
1303
  # resource path
857
- local_var_path = '/api/profiles/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1304
+ local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
858
1305
 
859
1306
  # query parameters
860
1307
  query_params = opts[:query_params] || {}
861
- query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
862
- query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
863
- query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
864
- query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
865
- query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
866
1308
 
867
1309
  # header parameters
868
1310
  header_params = opts[:header_params] || {}
869
1311
  # klaviyo api revision
870
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1312
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
871
1313
  # HTTP header 'Accept' (if needed)
872
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1314
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
873
1315
 
874
1316
  # form parameters
875
1317
  form_params = opts[:form_params] || {}
@@ -884,7 +1326,7 @@ module KlaviyoAPI
884
1326
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
885
1327
 
886
1328
  new_options = opts.merge(
887
- :operation => :"ProfilesApi.get_profile",
1329
+ :operation => :"ProfilesApi.get_list_ids_for_bulk_import_profiles_job",
888
1330
  :header_params => header_params,
889
1331
  :query_params => query_params,
890
1332
  :form_params => form_params,
@@ -895,53 +1337,55 @@ module KlaviyoAPI
895
1337
 
896
1338
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
897
1339
  if @api_client.config.debugging
898
- @api_client.config.logger.debug "API called: ProfilesApi#get_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1340
+ @api_client.config.logger.debug "API called: ProfilesApi#get_list_ids_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
899
1341
  end
900
1342
  return data, status_code, headers
901
1343
  end
902
1344
 
903
- # Get Profile Lists
1345
+ # alias of `get_list_ids_for_bulk_import_profiles_job_with_http_info`
1346
+ alias get_bulk_profile_import_job_relationships_lists_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
1347
+
1348
+ # alias of `get_list_ids_for_bulk_import_profiles_job_with_http_info`
1349
+ alias get_profile_bulk_import_job_relationships_lists_with_http_info get_list_ids_for_bulk_import_profiles_job_with_http_info
1350
+
1351
+ # Get List IDs for Profile
904
1352
  # 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`
905
1353
  # @param id [String]
906
1354
  # @param [Hash] opts the optional parameters
907
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
908
1355
  # @return [Hash<String, Object>]
909
- def get_profile_lists(id, opts = {})
910
- data, _status_code, _headers = get_profile_lists_with_http_info(id, opts)
1356
+ def get_list_ids_for_profile(id, opts = {})
1357
+ data, _status_code, _headers = get_list_ids_for_profile_with_http_info(id, opts)
911
1358
  data
912
1359
  end
913
1360
 
914
- # Get Profile Lists
1361
+ # alias of `get_list_ids_for_profile`
1362
+ alias get_profile_relationships_lists get_list_ids_for_profile
1363
+
1364
+ # Get List IDs for Profile
915
1365
  # 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;
916
1366
  # @param id [String]
917
1367
  # @param [Hash] opts the optional parameters
918
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
919
1368
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
920
- def get_profile_lists_with_http_info(id, opts = {})
1369
+ def get_list_ids_for_profile_with_http_info(id, opts = {})
921
1370
  if @api_client.config.debugging
922
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_lists ...'
1371
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_list_ids_for_profile ...'
923
1372
  end
924
1373
  # verify the required parameter 'id' is set
925
1374
  if @api_client.config.client_side_validation && id.nil?
926
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_lists"
927
- end
928
- allowable_values = ["name", "created", "updated", "opt_in_process"]
929
- if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
930
- fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
1375
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_list_ids_for_profile"
931
1376
  end
932
1377
  # resource path
933
- local_var_path = '/api/profiles/{id}/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1378
+ local_var_path = '/api/profiles/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
934
1379
 
935
1380
  # query parameters
936
1381
  query_params = opts[:query_params] || {}
937
- query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
938
1382
 
939
1383
  # header parameters
940
1384
  header_params = opts[:header_params] || {}
941
1385
  # klaviyo api revision
942
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1386
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
943
1387
  # HTTP header 'Accept' (if needed)
944
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1388
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
945
1389
 
946
1390
  # form parameters
947
1391
  form_params = opts[:form_params] || {}
@@ -956,7 +1400,7 @@ module KlaviyoAPI
956
1400
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
957
1401
 
958
1402
  new_options = opts.merge(
959
- :operation => :"ProfilesApi.get_profile_lists",
1403
+ :operation => :"ProfilesApi.get_list_ids_for_profile",
960
1404
  :header_params => header_params,
961
1405
  :query_params => query_params,
962
1406
  :form_params => form_params,
@@ -967,46 +1411,59 @@ module KlaviyoAPI
967
1411
 
968
1412
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
969
1413
  if @api_client.config.debugging
970
- @api_client.config.logger.debug "API called: ProfilesApi#get_profile_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1414
+ @api_client.config.logger.debug "API called: ProfilesApi#get_list_ids_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
971
1415
  end
972
1416
  return data, status_code, headers
973
1417
  end
974
1418
 
975
- # Get Profile Relationships Lists
1419
+ # alias of `get_list_ids_for_profile_with_http_info`
1420
+ alias get_profile_relationships_lists_with_http_info get_list_ids_for_profile_with_http_info
1421
+
1422
+ # Get Lists for Profile
976
1423
  # 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`
977
1424
  # @param id [String]
978
1425
  # @param [Hash] opts the optional parameters
1426
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
979
1427
  # @return [Hash<String, Object>]
980
- def get_profile_relationships_lists(id, opts = {})
981
- data, _status_code, _headers = get_profile_relationships_lists_with_http_info(id, opts)
1428
+ def get_lists_for_profile(id, opts = {})
1429
+ data, _status_code, _headers = get_lists_for_profile_with_http_info(id, opts)
982
1430
  data
983
1431
  end
984
1432
 
985
- # Get Profile Relationships Lists
1433
+ # alias of `get_lists_for_profile`
1434
+ alias get_profile_lists get_lists_for_profile
1435
+
1436
+ # Get Lists for Profile
986
1437
  # 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;
987
1438
  # @param id [String]
988
1439
  # @param [Hash] opts the optional parameters
1440
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
989
1441
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
990
- def get_profile_relationships_lists_with_http_info(id, opts = {})
1442
+ def get_lists_for_profile_with_http_info(id, opts = {})
991
1443
  if @api_client.config.debugging
992
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_relationships_lists ...'
1444
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_lists_for_profile ...'
993
1445
  end
994
1446
  # verify the required parameter 'id' is set
995
1447
  if @api_client.config.client_side_validation && id.nil?
996
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_relationships_lists"
1448
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_lists_for_profile"
1449
+ end
1450
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
1451
+ if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
1452
+ fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
997
1453
  end
998
1454
  # resource path
999
- local_var_path = '/api/profiles/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1455
+ local_var_path = '/api/profiles/{id}/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1000
1456
 
1001
1457
  # query parameters
1002
1458
  query_params = opts[:query_params] || {}
1459
+ query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
1003
1460
 
1004
1461
  # header parameters
1005
1462
  header_params = opts[:header_params] || {}
1006
1463
  # klaviyo api revision
1007
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1464
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1008
1465
  # HTTP header 'Accept' (if needed)
1009
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1466
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1010
1467
 
1011
1468
  # form parameters
1012
1469
  form_params = opts[:form_params] || {}
@@ -1021,7 +1478,7 @@ module KlaviyoAPI
1021
1478
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1022
1479
 
1023
1480
  new_options = opts.merge(
1024
- :operation => :"ProfilesApi.get_profile_relationships_lists",
1481
+ :operation => :"ProfilesApi.get_lists_for_profile",
1025
1482
  :header_params => header_params,
1026
1483
  :query_params => query_params,
1027
1484
  :form_params => form_params,
@@ -1032,46 +1489,84 @@ module KlaviyoAPI
1032
1489
 
1033
1490
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1034
1491
  if @api_client.config.debugging
1035
- @api_client.config.logger.debug "API called: ProfilesApi#get_profile_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1492
+ @api_client.config.logger.debug "API called: ProfilesApi#get_lists_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1036
1493
  end
1037
1494
  return data, status_code, headers
1038
1495
  end
1039
1496
 
1040
- # Get Profile Relationships Segments
1041
- # Get segment membership relationships 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`
1497
+ # alias of `get_lists_for_profile_with_http_info`
1498
+ alias get_profile_lists_with_http_info get_lists_for_profile_with_http_info
1499
+
1500
+ # Get Profile
1501
+ # Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
1042
1502
  # @param id [String]
1043
1503
  # @param [Hash] opts the optional parameters
1504
+ # @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;
1505
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1506
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1507
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1508
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
1044
1509
  # @return [Hash<String, Object>]
1045
- def get_profile_relationships_segments(id, opts = {})
1046
- data, _status_code, _headers = get_profile_relationships_segments_with_http_info(id, opts)
1510
+ def get_profile(id, opts = {})
1511
+ data, _status_code, _headers = get_profile_with_http_info(id, opts)
1047
1512
  data
1048
1513
  end
1049
1514
 
1050
- # Get Profile Relationships Segments
1051
- # Get segment membership relationships 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;
1515
+ # Get Profile
1516
+ # Get 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:read&#x60;
1052
1517
  # @param id [String]
1053
1518
  # @param [Hash] opts the optional parameters
1519
+ # @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;
1520
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1521
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1522
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1523
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
1054
1524
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1055
- def get_profile_relationships_segments_with_http_info(id, opts = {})
1525
+ def get_profile_with_http_info(id, opts = {})
1056
1526
  if @api_client.config.debugging
1057
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_relationships_segments ...'
1527
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile ...'
1058
1528
  end
1059
1529
  # verify the required parameter 'id' is set
1060
1530
  if @api_client.config.client_side_validation && id.nil?
1061
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_relationships_segments"
1531
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile"
1532
+ end
1533
+ allowable_values = ["subscriptions", "predictive_analytics"]
1534
+ if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
1535
+ fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
1536
+ end
1537
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
1538
+ if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
1539
+ fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
1540
+ end
1541
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
1542
+ if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
1543
+ fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
1544
+ end
1545
+ allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
1546
+ if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
1547
+ fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
1548
+ end
1549
+ allowable_values = ["lists", "segments"]
1550
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1551
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1062
1552
  end
1063
1553
  # resource path
1064
- local_var_path = '/api/profiles/{id}/relationships/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1554
+ local_var_path = '/api/profiles/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1065
1555
 
1066
1556
  # query parameters
1067
1557
  query_params = opts[:query_params] || {}
1558
+ query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
1559
+ query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
1560
+ query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
1561
+ query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
1562
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1068
1563
 
1069
1564
  # header parameters
1070
1565
  header_params = opts[:header_params] || {}
1071
1566
  # klaviyo api revision
1072
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1567
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1073
1568
  # HTTP header 'Accept' (if needed)
1074
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1569
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1075
1570
 
1076
1571
  # form parameters
1077
1572
  form_params = opts[:form_params] || {}
@@ -1086,7 +1581,7 @@ module KlaviyoAPI
1086
1581
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1087
1582
 
1088
1583
  new_options = opts.merge(
1089
- :operation => :"ProfilesApi.get_profile_relationships_segments",
1584
+ :operation => :"ProfilesApi.get_profile",
1090
1585
  :header_params => header_params,
1091
1586
  :query_params => query_params,
1092
1587
  :form_params => form_params,
@@ -1097,53 +1592,66 @@ module KlaviyoAPI
1097
1592
 
1098
1593
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1099
1594
  if @api_client.config.debugging
1100
- @api_client.config.logger.debug "API called: ProfilesApi#get_profile_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1595
+ @api_client.config.logger.debug "API called: ProfilesApi#get_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1101
1596
  end
1102
1597
  return data, status_code, headers
1103
1598
  end
1104
1599
 
1105
- # Get Profile Segments
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`
1600
+ # Get Profile IDs for Bulk Import Profiles Job
1601
+ # 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`
1107
1602
  # @param id [String]
1108
1603
  # @param [Hash] opts the optional parameters
1109
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
1604
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1605
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1110
1606
  # @return [Hash<String, Object>]
1111
- def get_profile_segments(id, opts = {})
1112
- data, _status_code, _headers = get_profile_segments_with_http_info(id, opts)
1607
+ def get_profile_ids_for_bulk_import_profiles_job(id, opts = {})
1608
+ data, _status_code, _headers = get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts)
1113
1609
  data
1114
1610
  end
1115
1611
 
1116
- # Get Profile Segments
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;
1612
+ # alias of `get_profile_ids_for_bulk_import_profiles_job`
1613
+ alias get_bulk_profile_import_job_relationships_profiles get_profile_ids_for_bulk_import_profiles_job
1614
+
1615
+ # alias of `get_profile_ids_for_bulk_import_profiles_job`
1616
+ alias get_profile_bulk_import_job_relationships_profiles get_profile_ids_for_bulk_import_profiles_job
1617
+
1618
+ # Get Profile IDs for Bulk Import Profiles Job
1619
+ # 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;
1118
1620
  # @param id [String]
1119
1621
  # @param [Hash] opts the optional parameters
1120
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
1622
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1623
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1121
1624
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1122
- def get_profile_segments_with_http_info(id, opts = {})
1625
+ def get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
1123
1626
  if @api_client.config.debugging
1124
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_segments ...'
1627
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_ids_for_bulk_import_profiles_job ...'
1125
1628
  end
1126
1629
  # verify the required parameter 'id' is set
1127
1630
  if @api_client.config.client_side_validation && id.nil?
1128
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_segments"
1631
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_ids_for_bulk_import_profiles_job"
1129
1632
  end
1130
- allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
1131
- if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
1132
- fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
1633
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
1634
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profile_ids_for_bulk_import_profiles_job, must be smaller than or equal to 100.'
1635
+ end
1636
+
1637
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
1638
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profile_ids_for_bulk_import_profiles_job, must be greater than or equal to 1.'
1133
1639
  end
1640
+
1134
1641
  # resource path
1135
- local_var_path = '/api/profiles/{id}/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1642
+ local_var_path = '/api/profile-bulk-import-jobs/{id}/relationships/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1136
1643
 
1137
1644
  # query parameters
1138
1645
  query_params = opts[:query_params] || {}
1139
- query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
1646
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1647
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
1140
1648
 
1141
1649
  # header parameters
1142
1650
  header_params = opts[:header_params] || {}
1143
1651
  # klaviyo api revision
1144
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1652
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1145
1653
  # HTTP header 'Accept' (if needed)
1146
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1654
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1147
1655
 
1148
1656
  # form parameters
1149
1657
  form_params = opts[:form_params] || {}
@@ -1158,7 +1666,7 @@ module KlaviyoAPI
1158
1666
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1159
1667
 
1160
1668
  new_options = opts.merge(
1161
- :operation => :"ProfilesApi.get_profile_segments",
1669
+ :operation => :"ProfilesApi.get_profile_ids_for_bulk_import_profiles_job",
1162
1670
  :header_params => header_params,
1163
1671
  :query_params => query_params,
1164
1672
  :form_params => form_params,
@@ -1169,20 +1677,26 @@ module KlaviyoAPI
1169
1677
 
1170
1678
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1171
1679
  if @api_client.config.debugging
1172
- @api_client.config.logger.debug "API called: ProfilesApi#get_profile_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1680
+ @api_client.config.logger.debug "API called: ProfilesApi#get_profile_ids_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1173
1681
  end
1174
1682
  return data, status_code, headers
1175
1683
  end
1176
1684
 
1685
+ # alias of `get_profile_ids_for_bulk_import_profiles_job_with_http_info`
1686
+ alias get_bulk_profile_import_job_relationships_profiles_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
1687
+
1688
+ # alias of `get_profile_ids_for_bulk_import_profiles_job_with_http_info`
1689
+ alias get_profile_bulk_import_job_relationships_profiles_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
1690
+
1177
1691
  # Get Profiles
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-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
1692
+ # 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-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
1179
1693
  # @param [Hash] opts the optional parameters
1180
1694
  # @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;
1181
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
1182
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
1695
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1696
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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.list_suppressions.reason&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.list_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.reason&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
1697
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1184
1698
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1185
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
1699
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
1186
1700
  # @return [Hash<String, Object>]
1187
1701
  def get_profiles(opts = {})
1188
1702
  data, _status_code, _headers = get_profiles_with_http_info(opts)
@@ -1190,14 +1704,14 @@ module KlaviyoAPI
1190
1704
  end
1191
1705
 
1192
1706
  # Get Profiles
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-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;profiles:read&#x60;
1707
+ # 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-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;profiles:read&#x60;
1194
1708
  # @param [Hash] opts the optional parameters
1195
1709
  # @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;
1196
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
1197
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
1710
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1711
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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.list_suppressions.reason&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.list_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.reason&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
1712
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1199
1713
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1200
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
1714
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
1201
1715
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1202
1716
  def get_profiles_with_http_info(opts = {})
1203
1717
  if @api_client.config.debugging
@@ -1207,7 +1721,7 @@ module KlaviyoAPI
1207
1721
  if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
1208
1722
  fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
1209
1723
  end
1210
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
1724
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
1211
1725
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
1212
1726
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
1213
1727
  end
@@ -1224,7 +1738,7 @@ module KlaviyoAPI
1224
1738
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1225
1739
  end
1226
1740
  # resource path
1227
- local_var_path = '/api/profiles/'
1741
+ local_var_path = '/api/profiles'
1228
1742
 
1229
1743
  # query parameters
1230
1744
  query_params = opts[:query_params] || {}
@@ -1238,9 +1752,9 @@ module KlaviyoAPI
1238
1752
  # header parameters
1239
1753
  header_params = opts[:header_params] || {}
1240
1754
  # klaviyo api revision
1241
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1755
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1242
1756
  # HTTP header 'Accept' (if needed)
1243
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1757
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1244
1758
 
1245
1759
  # form parameters
1246
1760
  form_params = opts[:form_params] || {}
@@ -1271,52 +1785,81 @@ module KlaviyoAPI
1271
1785
  return data, status_code, headers
1272
1786
  end
1273
1787
 
1274
- # Merge Profiles
1275
- # Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write`
1276
- # @param profile_merge_query [ProfileMergeQuery]
1788
+ # Get Profiles for Bulk Import Profiles Job
1789
+ # Get profiles 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`
1790
+ # @param id [String]
1277
1791
  # @param [Hash] opts the optional parameters
1792
+ # @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;
1793
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1794
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1795
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1278
1796
  # @return [Hash<String, Object>]
1279
- def merge_profiles(profile_merge_query, opts = {})
1280
- data, _status_code, _headers = merge_profiles_with_http_info(profile_merge_query, opts)
1797
+ def get_profiles_for_bulk_import_profiles_job(id, opts = {})
1798
+ data, _status_code, _headers = get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts)
1281
1799
  data
1282
1800
  end
1283
1801
 
1284
- # Merge Profiles
1285
- # Merge a given related profile into a profile with the given profile ID. The profile provided under &#x60;relationships&#x60; (the \&quot;source\&quot; profile) will be merged into the profile provided by the ID in the base data object (the \&quot;destination\&quot; profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).&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:write&#x60;
1286
- # @param profile_merge_query [ProfileMergeQuery]
1802
+ # alias of `get_profiles_for_bulk_import_profiles_job`
1803
+ alias get_bulk_profile_import_job_profiles get_profiles_for_bulk_import_profiles_job
1804
+
1805
+ # alias of `get_profiles_for_bulk_import_profiles_job`
1806
+ alias get_profile_bulk_import_job_profiles get_profiles_for_bulk_import_profiles_job
1807
+
1808
+ # Get Profiles for Bulk Import Profiles Job
1809
+ # Get profiles 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;
1810
+ # @param id [String]
1287
1811
  # @param [Hash] opts the optional parameters
1812
+ # @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;
1813
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1814
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1815
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1288
1816
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1289
- def merge_profiles_with_http_info(profile_merge_query, opts = {})
1817
+ def get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts = {})
1290
1818
  if @api_client.config.debugging
1291
- @api_client.config.logger.debug 'Calling API: ProfilesApi.merge_profiles ...'
1819
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profiles_for_bulk_import_profiles_job ...'
1292
1820
  end
1293
- # verify the required parameter 'profile_merge_query' is set
1294
- if @api_client.config.client_side_validation && profile_merge_query.nil?
1295
- fail ArgumentError, "Missing the required parameter 'profile_merge_query' when calling ProfilesApi.merge_profiles"
1821
+ # verify the required parameter 'id' is set
1822
+ if @api_client.config.client_side_validation && id.nil?
1823
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profiles_for_bulk_import_profiles_job"
1824
+ end
1825
+ allowable_values = ["subscriptions", "predictive_analytics"]
1826
+ if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
1827
+ fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
1296
1828
  end
1829
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
1830
+ if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
1831
+ fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
1832
+ end
1833
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
1834
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles_for_bulk_import_profiles_job, must be smaller than or equal to 100.'
1835
+ end
1836
+
1837
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
1838
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles_for_bulk_import_profiles_job, must be greater than or equal to 1.'
1839
+ end
1840
+
1297
1841
  # resource path
1298
- local_var_path = '/api/profile-merge/'
1842
+ local_var_path = '/api/profile-bulk-import-jobs/{id}/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1299
1843
 
1300
1844
  # query parameters
1301
1845
  query_params = opts[:query_params] || {}
1846
+ query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
1847
+ query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
1848
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1849
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
1302
1850
 
1303
1851
  # header parameters
1304
1852
  header_params = opts[:header_params] || {}
1305
1853
  # klaviyo api revision
1306
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1854
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1307
1855
  # HTTP header 'Accept' (if needed)
1308
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1309
- # HTTP header 'Content-Type'
1310
- content_type = @api_client.select_header_content_type(['application/json'])
1311
- if !content_type.nil?
1312
- header_params['Content-Type'] = content_type
1313
- end
1856
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1314
1857
 
1315
1858
  # form parameters
1316
1859
  form_params = opts[:form_params] || {}
1317
1860
 
1318
1861
  # http body (model)
1319
- post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_merge_query)
1862
+ post_body = opts[:debug_body]
1320
1863
 
1321
1864
  # return_type
1322
1865
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'
@@ -1325,7 +1868,7 @@ module KlaviyoAPI
1325
1868
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1326
1869
 
1327
1870
  new_options = opts.merge(
1328
- :operation => :"ProfilesApi.merge_profiles",
1871
+ :operation => :"ProfilesApi.get_profiles_for_bulk_import_profiles_job",
1329
1872
  :header_params => header_params,
1330
1873
  :query_params => query_params,
1331
1874
  :form_params => form_params,
@@ -1334,38 +1877,47 @@ module KlaviyoAPI
1334
1877
  :return_type => return_type
1335
1878
  )
1336
1879
 
1337
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1880
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1338
1881
  if @api_client.config.debugging
1339
- @api_client.config.logger.debug "API called: ProfilesApi#merge_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1882
+ @api_client.config.logger.debug "API called: ProfilesApi#get_profiles_for_bulk_import_profiles_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1340
1883
  end
1341
1884
  return data, status_code, headers
1342
1885
  end
1343
1886
 
1344
- # Spawn Bulk Profile Import Job
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`
1346
- # @param profile_import_job_create_query [ProfileImportJobCreateQuery]
1887
+ # alias of `get_profiles_for_bulk_import_profiles_job_with_http_info`
1888
+ alias get_bulk_profile_import_job_profiles_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
1889
+
1890
+ # alias of `get_profiles_for_bulk_import_profiles_job_with_http_info`
1891
+ alias get_profile_bulk_import_job_profiles_with_http_info get_profiles_for_bulk_import_profiles_job_with_http_info
1892
+
1893
+ # Get Segment IDs for Profile
1894
+ # Get segment membership relationships 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`
1895
+ # @param id [String]
1347
1896
  # @param [Hash] opts the optional parameters
1348
1897
  # @return [Hash<String, Object>]
1349
- def spawn_bulk_profile_import_job(profile_import_job_create_query, opts = {})
1350
- data, _status_code, _headers = spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts)
1898
+ def get_segment_ids_for_profile(id, opts = {})
1899
+ data, _status_code, _headers = get_segment_ids_for_profile_with_http_info(id, opts)
1351
1900
  data
1352
1901
  end
1353
1902
 
1354
- # Spawn Bulk Profile Import Job
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;
1356
- # @param profile_import_job_create_query [ProfileImportJobCreateQuery]
1903
+ # alias of `get_segment_ids_for_profile`
1904
+ alias get_profile_relationships_segments get_segment_ids_for_profile
1905
+
1906
+ # Get Segment IDs for Profile
1907
+ # Get segment membership relationships 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;
1908
+ # @param id [String]
1357
1909
  # @param [Hash] opts the optional parameters
1358
1910
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1359
- def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts = {})
1911
+ def get_segment_ids_for_profile_with_http_info(id, opts = {})
1360
1912
  if @api_client.config.debugging
1361
- @api_client.config.logger.debug 'Calling API: ProfilesApi.spawn_bulk_profile_import_job ...'
1913
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_segment_ids_for_profile ...'
1362
1914
  end
1363
- # verify the required parameter 'profile_import_job_create_query' is set
1364
- if @api_client.config.client_side_validation && profile_import_job_create_query.nil?
1365
- fail ArgumentError, "Missing the required parameter 'profile_import_job_create_query' when calling ProfilesApi.spawn_bulk_profile_import_job"
1915
+ # verify the required parameter 'id' is set
1916
+ if @api_client.config.client_side_validation && id.nil?
1917
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_segment_ids_for_profile"
1366
1918
  end
1367
1919
  # resource path
1368
- local_var_path = '/api/profile-bulk-import-jobs/'
1920
+ local_var_path = '/api/profiles/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1369
1921
 
1370
1922
  # query parameters
1371
1923
  query_params = opts[:query_params] || {}
@@ -1373,20 +1925,15 @@ module KlaviyoAPI
1373
1925
  # header parameters
1374
1926
  header_params = opts[:header_params] || {}
1375
1927
  # klaviyo api revision
1376
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1928
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1377
1929
  # HTTP header 'Accept' (if needed)
1378
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1379
- # HTTP header 'Content-Type'
1380
- content_type = @api_client.select_header_content_type(['application/json'])
1381
- if !content_type.nil?
1382
- header_params['Content-Type'] = content_type
1383
- end
1930
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1384
1931
 
1385
1932
  # form parameters
1386
1933
  form_params = opts[:form_params] || {}
1387
1934
 
1388
1935
  # http body (model)
1389
- post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_import_job_create_query)
1936
+ post_body = opts[:debug_body]
1390
1937
 
1391
1938
  # return_type
1392
1939
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'
@@ -1395,7 +1942,7 @@ module KlaviyoAPI
1395
1942
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1396
1943
 
1397
1944
  new_options = opts.merge(
1398
- :operation => :"ProfilesApi.spawn_bulk_profile_import_job",
1945
+ :operation => :"ProfilesApi.get_segment_ids_for_profile",
1399
1946
  :header_params => header_params,
1400
1947
  :query_params => query_params,
1401
1948
  :form_params => form_params,
@@ -1404,138 +1951,76 @@ module KlaviyoAPI
1404
1951
  :return_type => return_type
1405
1952
  )
1406
1953
 
1407
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1954
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1408
1955
  if @api_client.config.debugging
1409
- @api_client.config.logger.debug "API called: ProfilesApi#spawn_bulk_profile_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1956
+ @api_client.config.logger.debug "API called: ProfilesApi#get_segment_ids_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1410
1957
  end
1411
1958
  return data, status_code, headers
1412
1959
  end
1413
1960
 
1414
- # Subscribe Profiles
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: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
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.
1417
- # @param [Hash] opts the optional parameters
1418
- # @return [nil]
1419
- def subscribe_profiles(subscription_create_job_create_query, opts = {})
1420
- subscribe_profiles_with_http_info(subscription_create_job_create_query, opts)
1421
- nil
1422
- end
1961
+ # alias of `get_segment_ids_for_profile_with_http_info`
1962
+ alias get_profile_relationships_segments_with_http_info get_segment_ids_for_profile_with_http_info
1423
1963
 
1424
- # Subscribe Profiles
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: 1000 This endpoint now supports a &#x60;historical_import&#x60; flag. If this flag is set &#x60;true&#x60;, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \&quot;Added to list\&quot; flows. This is useful for importing historical data where you have already collected consent. If &#x60;historical_import&#x60; is set to true, the &#x60;consented_at&#x60; field is required and must be in the past.&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;
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.
1964
+ # Get Segments for Profile
1965
+ # 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`
1966
+ # @param id [String]
1427
1967
  # @param [Hash] opts the optional parameters
1428
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1429
- def subscribe_profiles_with_http_info(subscription_create_job_create_query, opts = {})
1430
- if @api_client.config.debugging
1431
- @api_client.config.logger.debug 'Calling API: ProfilesApi.subscribe_profiles ...'
1432
- end
1433
- # verify the required parameter 'subscription_create_job_create_query' is set
1434
- if @api_client.config.client_side_validation && subscription_create_job_create_query.nil?
1435
- fail ArgumentError, "Missing the required parameter 'subscription_create_job_create_query' when calling ProfilesApi.subscribe_profiles"
1436
- end
1437
- # resource path
1438
- local_var_path = '/api/profile-subscription-bulk-create-jobs/'
1439
-
1440
- # query parameters
1441
- query_params = opts[:query_params] || {}
1442
-
1443
- # header parameters
1444
- header_params = opts[:header_params] || {}
1445
- # klaviyo api revision
1446
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
1447
- # HTTP header 'Accept' (if needed)
1448
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1449
- # HTTP header 'Content-Type'
1450
- content_type = @api_client.select_header_content_type(['application/json'])
1451
- if !content_type.nil?
1452
- header_params['Content-Type'] = content_type
1453
- end
1454
-
1455
- # form parameters
1456
- form_params = opts[:form_params] || {}
1457
-
1458
- # http body (model)
1459
- post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_create_job_create_query)
1460
-
1461
- # return_type
1462
- return_type = opts[:debug_return_type]
1463
-
1464
- # auth_names
1465
- auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1466
-
1467
- new_options = opts.merge(
1468
- :operation => :"ProfilesApi.subscribe_profiles",
1469
- :header_params => header_params,
1470
- :query_params => query_params,
1471
- :form_params => form_params,
1472
- :body => post_body,
1473
- :auth_names => auth_names,
1474
- :return_type => return_type
1475
- )
1476
-
1477
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1478
- if @api_client.config.debugging
1479
- @api_client.config.logger.debug "API called: ProfilesApi#subscribe_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1480
- end
1481
- return data, status_code, headers
1968
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1969
+ # @return [Hash<String, Object>]
1970
+ def get_segments_for_profile(id, opts = {})
1971
+ data, _status_code, _headers = get_segments_for_profile_with_http_info(id, opts)
1972
+ data
1482
1973
  end
1483
1974
 
1484
- # Suppress Profiles
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`
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.
1487
- # @param [Hash] opts the optional parameters
1488
- # @return [nil]
1489
- def suppress_profiles(suppression_create_job_create_query, opts = {})
1490
- suppress_profiles_with_http_info(suppression_create_job_create_query, opts)
1491
- nil
1492
- end
1975
+ # alias of `get_segments_for_profile`
1976
+ alias get_profile_segments get_segments_for_profile
1493
1977
 
1494
- # Suppress Profiles
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;
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.
1978
+ # Get Segments for Profile
1979
+ # 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;
1980
+ # @param id [String]
1497
1981
  # @param [Hash] opts the optional parameters
1498
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1499
- def suppress_profiles_with_http_info(suppression_create_job_create_query, opts = {})
1982
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1983
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1984
+ def get_segments_for_profile_with_http_info(id, opts = {})
1500
1985
  if @api_client.config.debugging
1501
- @api_client.config.logger.debug 'Calling API: ProfilesApi.suppress_profiles ...'
1986
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_segments_for_profile ...'
1502
1987
  end
1503
- # verify the required parameter 'suppression_create_job_create_query' is set
1504
- if @api_client.config.client_side_validation && suppression_create_job_create_query.nil?
1505
- fail ArgumentError, "Missing the required parameter 'suppression_create_job_create_query' when calling ProfilesApi.suppress_profiles"
1988
+ # verify the required parameter 'id' is set
1989
+ if @api_client.config.client_side_validation && id.nil?
1990
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_segments_for_profile"
1991
+ end
1992
+ allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
1993
+ if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
1994
+ fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
1506
1995
  end
1507
1996
  # resource path
1508
- local_var_path = '/api/profile-suppression-bulk-create-jobs/'
1997
+ local_var_path = '/api/profiles/{id}/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1509
1998
 
1510
1999
  # query parameters
1511
2000
  query_params = opts[:query_params] || {}
2001
+ query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
1512
2002
 
1513
2003
  # header parameters
1514
2004
  header_params = opts[:header_params] || {}
1515
2005
  # klaviyo api revision
1516
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
2006
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1517
2007
  # HTTP header 'Accept' (if needed)
1518
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1519
- # HTTP header 'Content-Type'
1520
- content_type = @api_client.select_header_content_type(['application/json'])
1521
- if !content_type.nil?
1522
- header_params['Content-Type'] = content_type
1523
- end
2008
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1524
2009
 
1525
2010
  # form parameters
1526
2011
  form_params = opts[:form_params] || {}
1527
2012
 
1528
2013
  # http body (model)
1529
- post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_create_job_create_query)
2014
+ post_body = opts[:debug_body]
1530
2015
 
1531
2016
  # return_type
1532
- return_type = opts[:debug_return_type]
2017
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1533
2018
 
1534
2019
  # auth_names
1535
2020
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1536
2021
 
1537
2022
  new_options = opts.merge(
1538
- :operation => :"ProfilesApi.suppress_profiles",
2023
+ :operation => :"ProfilesApi.get_segments_for_profile",
1539
2024
  :header_params => header_params,
1540
2025
  :query_params => query_params,
1541
2026
  :form_params => form_params,
@@ -1544,38 +2029,44 @@ module KlaviyoAPI
1544
2029
  :return_type => return_type
1545
2030
  )
1546
2031
 
1547
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2032
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1548
2033
  if @api_client.config.debugging
1549
- @api_client.config.logger.debug "API called: ProfilesApi#suppress_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2034
+ @api_client.config.logger.debug "API called: ProfilesApi#get_segments_for_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1550
2035
  end
1551
2036
  return data, status_code, headers
1552
2037
  end
1553
2038
 
1554
- # Unsubscribe Profiles
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`
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.
2039
+ # alias of `get_segments_for_profile_with_http_info`
2040
+ alias get_profile_segments_with_http_info get_segments_for_profile_with_http_info
2041
+
2042
+ # Merge Profiles
2043
+ # Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write`
2044
+ # @param profile_merge_query [ProfileMergeQuery]
1557
2045
  # @param [Hash] opts the optional parameters
1558
- # @return [nil]
1559
- def unsubscribe_profiles(subscription_delete_job_create_query, opts = {})
1560
- unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts)
1561
- nil
2046
+ # @return [Hash<String, Object>]
2047
+ def merge_profiles(profile_merge_query, opts = {})
2048
+ data, _status_code, _headers = merge_profiles_with_http_info(profile_merge_query, opts)
2049
+ data
1562
2050
  end
1563
2051
 
1564
- # Unsubscribe Profiles
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;
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.
2052
+ # alias of `merge_profiles`
2053
+ alias create_profile_merge merge_profiles
2054
+
2055
+ # Merge Profiles
2056
+ # Merge a given related profile into a profile with the given profile ID. The profile provided under &#x60;relationships&#x60; (the \&quot;source\&quot; profile) will be merged into the profile provided by the ID in the base data object (the \&quot;destination\&quot; profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).&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:write&#x60;
2057
+ # @param profile_merge_query [ProfileMergeQuery]
1567
2058
  # @param [Hash] opts the optional parameters
1568
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1569
- def unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts = {})
2059
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2060
+ def merge_profiles_with_http_info(profile_merge_query, opts = {})
1570
2061
  if @api_client.config.debugging
1571
- @api_client.config.logger.debug 'Calling API: ProfilesApi.unsubscribe_profiles ...'
2062
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.merge_profiles ...'
1572
2063
  end
1573
- # verify the required parameter 'subscription_delete_job_create_query' is set
1574
- if @api_client.config.client_side_validation && subscription_delete_job_create_query.nil?
1575
- fail ArgumentError, "Missing the required parameter 'subscription_delete_job_create_query' when calling ProfilesApi.unsubscribe_profiles"
2064
+ # verify the required parameter 'profile_merge_query' is set
2065
+ if @api_client.config.client_side_validation && profile_merge_query.nil?
2066
+ fail ArgumentError, "Missing the required parameter 'profile_merge_query' when calling ProfilesApi.merge_profiles"
1576
2067
  end
1577
2068
  # resource path
1578
- local_var_path = '/api/profile-subscription-bulk-delete-jobs/'
2069
+ local_var_path = '/api/profile-merge'
1579
2070
 
1580
2071
  # query parameters
1581
2072
  query_params = opts[:query_params] || {}
@@ -1583,11 +2074,11 @@ module KlaviyoAPI
1583
2074
  # header parameters
1584
2075
  header_params = opts[:header_params] || {}
1585
2076
  # klaviyo api revision
1586
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
2077
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1587
2078
  # HTTP header 'Accept' (if needed)
1588
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2079
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1589
2080
  # HTTP header 'Content-Type'
1590
- content_type = @api_client.select_header_content_type(['application/json'])
2081
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1591
2082
  if !content_type.nil?
1592
2083
  header_params['Content-Type'] = content_type
1593
2084
  end
@@ -1596,16 +2087,16 @@ module KlaviyoAPI
1596
2087
  form_params = opts[:form_params] || {}
1597
2088
 
1598
2089
  # http body (model)
1599
- post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_delete_job_create_query)
2090
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_merge_query)
1600
2091
 
1601
2092
  # return_type
1602
- return_type = opts[:debug_return_type]
2093
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1603
2094
 
1604
2095
  # auth_names
1605
2096
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1606
2097
 
1607
2098
  new_options = opts.merge(
1608
- :operation => :"ProfilesApi.unsubscribe_profiles",
2099
+ :operation => :"ProfilesApi.merge_profiles",
1609
2100
  :header_params => header_params,
1610
2101
  :query_params => query_params,
1611
2102
  :form_params => form_params,
@@ -1616,36 +2107,45 @@ module KlaviyoAPI
1616
2107
 
1617
2108
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1618
2109
  if @api_client.config.debugging
1619
- @api_client.config.logger.debug "API called: ProfilesApi#unsubscribe_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2110
+ @api_client.config.logger.debug "API called: ProfilesApi#merge_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1620
2111
  end
1621
2112
  return data, status_code, headers
1622
2113
  end
1623
2114
 
1624
- # Unsuppress Profiles
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`
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.
2115
+ # alias of `merge_profiles_with_http_info`
2116
+ alias create_profile_merge_with_http_info merge_profiles_with_http_info
2117
+
2118
+ # Spawn Bulk Profile Import Job
2119
+ # 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`
2120
+ # @param profile_import_job_create_query [ProfileImportJobCreateQuery]
1627
2121
  # @param [Hash] opts the optional parameters
1628
- # @return [nil]
1629
- def unsuppress_profiles(suppression_delete_job_create_query, opts = {})
1630
- unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts)
1631
- nil
2122
+ # @return [Hash<String, Object>]
2123
+ def spawn_bulk_profile_import_job(profile_import_job_create_query, opts = {})
2124
+ data, _status_code, _headers = spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts)
2125
+ data
1632
2126
  end
1633
2127
 
1634
- # Unsuppress Profiles
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;
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.
2128
+ # alias of `spawn_bulk_profile_import_job`
2129
+ alias bulk_import_profiles spawn_bulk_profile_import_job
2130
+
2131
+ # alias of `spawn_bulk_profile_import_job`
2132
+ alias create_profile_bulk_import_job spawn_bulk_profile_import_job
2133
+
2134
+ # Spawn Bulk Profile Import Job
2135
+ # 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;
2136
+ # @param profile_import_job_create_query [ProfileImportJobCreateQuery]
1637
2137
  # @param [Hash] opts the optional parameters
1638
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1639
- def unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts = {})
2138
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2139
+ def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query, opts = {})
1640
2140
  if @api_client.config.debugging
1641
- @api_client.config.logger.debug 'Calling API: ProfilesApi.unsuppress_profiles ...'
2141
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.spawn_bulk_profile_import_job ...'
1642
2142
  end
1643
- # verify the required parameter 'suppression_delete_job_create_query' is set
1644
- if @api_client.config.client_side_validation && suppression_delete_job_create_query.nil?
1645
- fail ArgumentError, "Missing the required parameter 'suppression_delete_job_create_query' when calling ProfilesApi.unsuppress_profiles"
2143
+ # verify the required parameter 'profile_import_job_create_query' is set
2144
+ if @api_client.config.client_side_validation && profile_import_job_create_query.nil?
2145
+ fail ArgumentError, "Missing the required parameter 'profile_import_job_create_query' when calling ProfilesApi.spawn_bulk_profile_import_job"
1646
2146
  end
1647
2147
  # resource path
1648
- local_var_path = '/api/profile-suppression-bulk-delete-jobs/'
2148
+ local_var_path = '/api/profile-bulk-import-jobs'
1649
2149
 
1650
2150
  # query parameters
1651
2151
  query_params = opts[:query_params] || {}
@@ -1653,11 +2153,11 @@ module KlaviyoAPI
1653
2153
  # header parameters
1654
2154
  header_params = opts[:header_params] || {}
1655
2155
  # klaviyo api revision
1656
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
2156
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1657
2157
  # HTTP header 'Accept' (if needed)
1658
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2158
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1659
2159
  # HTTP header 'Content-Type'
1660
- content_type = @api_client.select_header_content_type(['application/json'])
2160
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1661
2161
  if !content_type.nil?
1662
2162
  header_params['Content-Type'] = content_type
1663
2163
  end
@@ -1666,16 +2166,16 @@ module KlaviyoAPI
1666
2166
  form_params = opts[:form_params] || {}
1667
2167
 
1668
2168
  # http body (model)
1669
- post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_delete_job_create_query)
2169
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_import_job_create_query)
1670
2170
 
1671
2171
  # return_type
1672
- return_type = opts[:debug_return_type]
2172
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1673
2173
 
1674
2174
  # auth_names
1675
2175
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
1676
2176
 
1677
2177
  new_options = opts.merge(
1678
- :operation => :"ProfilesApi.unsuppress_profiles",
2178
+ :operation => :"ProfilesApi.spawn_bulk_profile_import_job",
1679
2179
  :header_params => header_params,
1680
2180
  :query_params => query_params,
1681
2181
  :form_params => form_params,
@@ -1686,11 +2186,17 @@ module KlaviyoAPI
1686
2186
 
1687
2187
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1688
2188
  if @api_client.config.debugging
1689
- @api_client.config.logger.debug "API called: ProfilesApi#unsuppress_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2189
+ @api_client.config.logger.debug "API called: ProfilesApi#spawn_bulk_profile_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1690
2190
  end
1691
2191
  return data, status_code, headers
1692
2192
  end
1693
2193
 
2194
+ # alias of `spawn_bulk_profile_import_job_with_http_info`
2195
+ alias bulk_import_profiles_with_http_info spawn_bulk_profile_import_job_with_http_info
2196
+
2197
+ # alias of `spawn_bulk_profile_import_job_with_http_info`
2198
+ alias create_profile_bulk_import_job_with_http_info spawn_bulk_profile_import_job_with_http_info
2199
+
1694
2200
  # Update Profile
1695
2201
  # Update the profile with the given profile ID. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
1696
2202
  # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
@@ -1721,7 +2227,7 @@ module KlaviyoAPI
1721
2227
  fail ArgumentError, "Missing the required parameter 'profile_partial_update_query' when calling ProfilesApi.update_profile"
1722
2228
  end
1723
2229
  # resource path
1724
- local_var_path = '/api/profiles/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2230
+ local_var_path = '/api/profiles/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1725
2231
 
1726
2232
  # query parameters
1727
2233
  query_params = opts[:query_params] || {}
@@ -1729,11 +2235,11 @@ module KlaviyoAPI
1729
2235
  # header parameters
1730
2236
  header_params = opts[:header_params] || {}
1731
2237
  # klaviyo api revision
1732
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
2238
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1733
2239
  # HTTP header 'Accept' (if needed)
1734
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2240
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1735
2241
  # HTTP header 'Content-Type'
1736
- content_type = @api_client.select_header_content_type(['application/json'])
2242
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
1737
2243
  if !content_type.nil?
1738
2244
  header_params['Content-Type'] = content_type
1739
2245
  end