klaviyo-api-sdk 5.0.0 → 5.1.0

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