klaviyo-api-sdk 5.0.0 → 6.0.0

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