klaviyo-api-sdk 5.0.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (760) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +329 -201
  3. data/docs/AccountsApi.md +4 -4
  4. data/docs/CampaignCreateQueryResourceObjectAttributes.md +1 -1
  5. data/docs/CampaignValuesReportEnum.md +15 -0
  6. data/docs/CampaignValuesRequestDTO.md +18 -0
  7. data/docs/CampaignValuesRequestDTOResourceObject.md +20 -0
  8. data/docs/CampaignValuesRequestDTOResourceObjectAttributes.md +24 -0
  9. data/docs/CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md +49 -0
  10. data/docs/CampaignsApi.md +51 -51
  11. data/docs/CatalogsApi.md +175 -175
  12. data/docs/CouponsApi.md +44 -44
  13. data/docs/CustomTimeframe.md +20 -0
  14. data/docs/EventsApi.md +26 -26
  15. data/docs/FlowSeriesReportEnum.md +15 -0
  16. data/docs/FlowSeriesRequestDTO.md +18 -0
  17. data/docs/FlowSeriesRequestDTOResourceObject.md +20 -0
  18. data/docs/FlowSeriesRequestDTOResourceObjectAttributes.md +26 -0
  19. data/docs/FlowValuesReportEnum.md +15 -0
  20. data/docs/FlowValuesRequestDTO.md +18 -0
  21. data/docs/FlowValuesRequestDTOResourceObject.md +20 -0
  22. data/docs/FlowValuesRequestDTOResourceObjectAttributes.md +24 -0
  23. data/docs/FlowsApi.md +70 -70
  24. data/docs/ImagesApi.md +12 -12
  25. data/docs/ListsApi.md +43 -43
  26. data/docs/MarketingSubscriptionParameters.md +3 -1
  27. data/docs/MetricsApi.md +8 -8
  28. data/docs/ProfileBulkImportJobEnum.md +15 -0
  29. data/docs/ProfileImportJobCreateQuery.md +18 -0
  30. data/docs/ProfileImportJobCreateQueryResourceObject.md +22 -0
  31. data/docs/ProfileImportJobCreateQueryResourceObjectAttributes.md +18 -0
  32. data/docs/ProfileImportJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  33. data/docs/ProfileImportJobCreateQueryResourceObjectRelationships.md +18 -0
  34. data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsLists.md +18 -0
  35. data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsListsDataInner.md +20 -0
  36. data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +1 -1
  37. data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +1 -1
  38. data/docs/ProfileUpsertQuery.md +18 -0
  39. data/docs/ProfileUpsertQueryResourceObject.md +3 -1
  40. data/docs/ProfileUpsertQueryResourceObjectAttributes.md +1 -3
  41. data/docs/ProfilesApi.md +754 -60
  42. data/docs/ReportingApi.md +235 -0
  43. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +1 -1
  44. data/docs/SegmentsApi.md +35 -35
  45. data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +1 -1
  46. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +1 -1
  47. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +1 -1
  48. data/docs/TagsApi.md +35 -35
  49. data/docs/TemplatesApi.md +14 -14
  50. data/docs/Timeframe.md +18 -0
  51. data/klaviyo-api-sdk.gemspec +2 -2
  52. data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
  53. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +78 -78
  54. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +257 -257
  55. data/lib/klaviyo-api-sdk/api/coupons_api.rb +64 -64
  56. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  57. data/lib/klaviyo-api-sdk/api/events_api.rb +36 -36
  58. data/lib/klaviyo-api-sdk/api/flows_api.rb +88 -88
  59. data/lib/klaviyo-api-sdk/api/images_api.rb +20 -20
  60. data/lib/klaviyo-api-sdk/api/lists_api.rb +68 -68
  61. data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
  62. data/lib/klaviyo-api-sdk/api/profiles_api.rb +808 -97
  63. data/lib/klaviyo-api-sdk/api/reporting_api.rb +241 -0
  64. data/lib/klaviyo-api-sdk/api/segments_api.rb +44 -44
  65. data/lib/klaviyo-api-sdk/api/tags_api.rb +65 -65
  66. data/lib/klaviyo-api-sdk/api/templates_api.rb +26 -26
  67. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  68. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  69. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  71. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  72. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  73. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  76. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  77. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -6
  78. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  79. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  80. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  83. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
  84. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
  85. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  86. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
  88. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
  93. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +36 -0
  107. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +224 -0
  108. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +238 -0
  109. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +288 -0
  110. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
  111. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  113. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  120. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  127. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
  152. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
  192. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
  194. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
  206. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +238 -0
  214. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  215. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  216. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  217. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
  222. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  227. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  230. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +36 -0
  234. data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +224 -0
  235. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +238 -0
  236. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +315 -0
  237. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +36 -0
  241. data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +224 -0
  242. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +238 -0
  243. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +288 -0
  244. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
  245. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
  249. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
  250. data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
  252. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
  253. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  261. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +15 -5
  264. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +36 -0
  275. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +224 -0
  282. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +247 -0
  283. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +224 -0
  284. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +227 -0
  285. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +219 -0
  286. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +226 -0
  287. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +239 -0
  288. data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  304. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  305. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
  306. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +2 -2
  307. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
  308. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +2 -2
  309. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  310. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
  312. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  313. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
  314. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +224 -0
  316. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +14 -5
  317. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +5 -14
  318. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
  320. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
  321. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
  323. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
  324. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  325. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -6
  328. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
  329. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  330. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  332. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  333. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
  334. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  335. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
  336. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
  337. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
  339. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +1 -1
  340. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  342. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
  343. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  344. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -6
  345. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -6
  348. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
  349. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  351. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  353. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  354. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  356. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +2 -2
  357. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  360. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
  363. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  364. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  365. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  367. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
  369. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
  370. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  371. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  372. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
  373. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  374. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  375. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  376. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  378. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
  379. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  380. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  381. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  382. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
  383. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  384. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  387. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  388. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  390. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  391. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
  392. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  393. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  394. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
  395. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  396. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  397. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  398. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
  399. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  400. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  401. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
  402. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  403. data/lib/klaviyo-api-sdk/models/timeframe.rb +259 -0
  404. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  405. data/lib/klaviyo-api-sdk/version.rb +1 -1
  406. data/lib/klaviyo-api-sdk.rb +26 -1
  407. data/spec/api/accounts_api_spec.rb +3 -3
  408. data/spec/api/campaigns_api_spec.rb +26 -26
  409. data/spec/api/catalogs_api_spec.rb +93 -93
  410. data/spec/api/coupons_api_spec.rb +23 -23
  411. data/spec/api/data_privacy_api_spec.rb +1 -1
  412. data/spec/api/events_api_spec.rb +14 -14
  413. data/spec/api/flows_api_spec.rb +36 -36
  414. data/spec/api/images_api_spec.rb +8 -8
  415. data/spec/api/lists_api_spec.rb +28 -28
  416. data/spec/api/metrics_api_spec.rb +5 -5
  417. data/spec/api/profiles_api_spec.rb +143 -18
  418. data/spec/api/reporting_api_spec.rb +74 -0
  419. data/spec/api/segments_api_spec.rb +19 -19
  420. data/spec/api/tags_api_spec.rb +20 -20
  421. data/spec/api/templates_api_spec.rb +10 -10
  422. data/spec/api_client_spec.rb +1 -1
  423. data/spec/configuration_spec.rb +1 -1
  424. data/spec/models/audiences_sub_object_spec.rb +1 -1
  425. data/spec/models/back_in_stock_subscription_enum_spec.rb +1 -1
  426. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +1 -1
  427. data/spec/models/campaign_clone_query_resource_object_spec.rb +1 -1
  428. data/spec/models/campaign_clone_query_spec.rb +1 -1
  429. data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +1 -1
  430. data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +1 -1
  431. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +1 -1
  432. data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +1 -1
  433. data/spec/models/campaign_create_query_resource_object_spec.rb +1 -1
  434. data/spec/models/campaign_create_query_spec.rb +1 -1
  435. data/spec/models/campaign_enum_spec.rb +1 -1
  436. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +1 -1
  437. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +1 -1
  438. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +1 -1
  439. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +1 -1
  440. data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
  441. data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +1 -1
  442. data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +1 -1
  443. data/spec/models/campaign_message_create_query_resource_object_spec.rb +1 -1
  444. data/spec/models/campaign_message_enum_spec.rb +1 -1
  445. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +1 -1
  446. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +1 -1
  447. data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
  448. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +1 -1
  449. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +1 -1
  450. data/spec/models/campaign_partial_update_query_spec.rb +1 -1
  451. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +1 -1
  452. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +1 -1
  453. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +1 -1
  454. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +1 -1
  455. data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
  456. data/spec/models/campaign_send_job_enum_spec.rb +1 -1
  457. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +1 -1
  458. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +1 -1
  459. data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
  460. data/spec/models/campaign_values_report_enum_spec.rb +28 -0
  461. data/spec/models/campaign_values_request_dto_resource_object_attributes_spec.rb +56 -0
  462. data/spec/models/campaign_values_request_dto_resource_object_attributes_timeframe_spec.rb +31 -0
  463. data/spec/models/campaign_values_request_dto_resource_object_spec.rb +40 -0
  464. data/spec/models/campaign_values_request_dto_spec.rb +34 -0
  465. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
  466. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
  467. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
  468. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  469. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  470. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
  471. data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
  472. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +1 -1
  473. data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +1 -1
  474. data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +1 -1
  475. data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
  476. data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
  477. data/spec/models/catalog_category_create_query_spec.rb +1 -1
  478. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  479. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  480. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
  481. data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
  482. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
  483. data/spec/models/catalog_category_enum_spec.rb +1 -1
  484. data/spec/models/catalog_category_item_op_spec.rb +1 -1
  485. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  486. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  487. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
  488. data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
  489. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +1 -1
  490. data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
  491. data/spec/models/catalog_category_update_query_spec.rb +1 -1
  492. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
  493. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
  494. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
  495. data/spec/models/catalog_item_category_op_spec.rb +1 -1
  496. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  497. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  498. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
  499. data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
  500. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +1 -1
  501. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
  502. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
  503. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
  504. data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
  505. data/spec/models/catalog_item_create_query_spec.rb +1 -1
  506. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  507. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  508. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
  509. data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
  510. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
  511. data/spec/models/catalog_item_enum_spec.rb +1 -1
  512. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  513. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  514. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
  515. data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
  516. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +1 -1
  517. data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
  518. data/spec/models/catalog_item_update_query_spec.rb +1 -1
  519. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
  520. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
  521. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
  522. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  523. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  524. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
  525. data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
  526. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +1 -1
  527. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
  528. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
  529. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
  530. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
  531. data/spec/models/catalog_variant_create_query_spec.rb +1 -1
  532. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  533. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  534. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
  535. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
  536. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
  537. data/spec/models/catalog_variant_enum_spec.rb +1 -1
  538. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  539. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  540. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
  541. data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
  542. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +1 -1
  543. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
  544. data/spec/models/catalog_variant_update_query_spec.rb +1 -1
  545. data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +1 -1
  546. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +1 -1
  547. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  548. data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +1 -1
  549. data/spec/models/coupon_code_create_job_create_query_spec.rb +1 -1
  550. data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +1 -1
  551. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +1 -1
  552. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +1 -1
  553. data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +1 -1
  554. data/spec/models/coupon_code_create_query_resource_object_spec.rb +1 -1
  555. data/spec/models/coupon_code_create_query_spec.rb +1 -1
  556. data/spec/models/coupon_code_enum_spec.rb +1 -1
  557. data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +1 -1
  558. data/spec/models/coupon_code_update_query_resource_object_spec.rb +1 -1
  559. data/spec/models/coupon_code_update_query_spec.rb +1 -1
  560. data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +1 -1
  561. data/spec/models/coupon_create_query_resource_object_spec.rb +1 -1
  562. data/spec/models/coupon_create_query_spec.rb +1 -1
  563. data/spec/models/coupon_enum_spec.rb +1 -1
  564. data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +1 -1
  565. data/spec/models/coupon_update_query_resource_object_spec.rb +1 -1
  566. data/spec/models/coupon_update_query_spec.rb +1 -1
  567. data/spec/models/custom_timeframe_spec.rb +40 -0
  568. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +1 -1
  569. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
  570. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
  571. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
  572. data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
  573. data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
  574. data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
  575. data/spec/models/device_metadata_spec.rb +1 -1
  576. data/spec/models/email_content_sub_object_spec.rb +1 -1
  577. data/spec/models/email_send_options_sub_object_spec.rb +1 -1
  578. data/spec/models/email_subscription_parameters_spec.rb +1 -1
  579. data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
  580. data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +1 -1
  581. data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +1 -1
  582. data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +1 -1
  583. data/spec/models/event_create_query_v2_resource_object_spec.rb +1 -1
  584. data/spec/models/event_create_query_v2_spec.rb +1 -1
  585. data/spec/models/event_enum_spec.rb +1 -1
  586. data/spec/models/flow_enum_spec.rb +1 -1
  587. data/spec/models/flow_series_report_enum_spec.rb +28 -0
  588. data/spec/models/flow_series_request_dto_resource_object_attributes_spec.rb +66 -0
  589. data/spec/models/flow_series_request_dto_resource_object_spec.rb +40 -0
  590. data/spec/models/flow_series_request_dto_spec.rb +34 -0
  591. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +1 -1
  592. data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
  593. data/spec/models/flow_update_query_spec.rb +1 -1
  594. data/spec/models/flow_values_report_enum_spec.rb +28 -0
  595. data/spec/models/flow_values_request_dto_resource_object_attributes_spec.rb +56 -0
  596. data/spec/models/flow_values_request_dto_resource_object_spec.rb +40 -0
  597. data/spec/models/flow_values_request_dto_spec.rb +34 -0
  598. data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
  599. data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
  600. data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
  601. data/spec/models/image_create_query_resource_object_attributes_spec.rb +1 -1
  602. data/spec/models/image_create_query_resource_object_spec.rb +1 -1
  603. data/spec/models/image_create_query_spec.rb +1 -1
  604. data/spec/models/image_enum_spec.rb +1 -1
  605. data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +1 -1
  606. data/spec/models/image_partial_update_query_resource_object_spec.rb +1 -1
  607. data/spec/models/image_partial_update_query_spec.rb +1 -1
  608. data/spec/models/list_create_query_resource_object_attributes_spec.rb +1 -1
  609. data/spec/models/list_create_query_resource_object_spec.rb +1 -1
  610. data/spec/models/list_create_query_spec.rb +1 -1
  611. data/spec/models/list_enum_spec.rb +1 -1
  612. data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
  613. data/spec/models/list_members_add_query_spec.rb +1 -1
  614. data/spec/models/list_members_delete_query_spec.rb +1 -1
  615. data/spec/models/list_partial_update_query_resource_object_spec.rb +1 -1
  616. data/spec/models/list_partial_update_query_spec.rb +1 -1
  617. data/spec/models/marketing_subscription_parameters_spec.rb +7 -1
  618. data/spec/models/metric_aggregate_enum_spec.rb +1 -1
  619. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +1 -1
  620. data/spec/models/metric_aggregate_query_resource_object_spec.rb +1 -1
  621. data/spec/models/metric_aggregate_query_spec.rb +1 -1
  622. data/spec/models/metric_create_query_resource_object_attributes_spec.rb +1 -1
  623. data/spec/models/metric_create_query_resource_object_spec.rb +1 -1
  624. data/spec/models/metric_enum_spec.rb +1 -1
  625. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +1 -1
  626. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +1 -1
  627. data/spec/models/onsite_profile_meta_spec.rb +1 -1
  628. data/spec/models/profile_bulk_import_job_enum_spec.rb +28 -0
  629. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +1 -1
  630. data/spec/models/profile_create_query_resource_object_spec.rb +1 -1
  631. data/spec/models/profile_create_query_spec.rb +1 -1
  632. data/spec/models/profile_enum_spec.rb +1 -1
  633. data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +1 -1
  634. data/spec/models/profile_identifier_dto_resource_object_spec.rb +1 -1
  635. data/spec/models/profile_import_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  636. data/spec/models/profile_import_job_create_query_resource_object_attributes_spec.rb +34 -0
  637. data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner_spec.rb +40 -0
  638. data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_spec.rb +34 -0
  639. data/spec/models/profile_import_job_create_query_resource_object_relationships_spec.rb +34 -0
  640. data/spec/models/profile_import_job_create_query_resource_object_spec.rb +46 -0
  641. data/spec/models/profile_import_job_create_query_spec.rb +34 -0
  642. data/spec/models/profile_location_latitude_spec.rb +1 -1
  643. data/spec/models/profile_location_longitude_spec.rb +1 -1
  644. data/spec/models/profile_location_spec.rb +1 -1
  645. data/spec/models/profile_merge_enum_spec.rb +1 -1
  646. data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +1 -1
  647. data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +1 -1
  648. data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +1 -1
  649. data/spec/models/profile_merge_query_resource_object_spec.rb +1 -1
  650. data/spec/models/profile_merge_query_spec.rb +1 -1
  651. data/spec/models/profile_meta_patch_properties_spec.rb +1 -1
  652. data/spec/models/profile_meta_patch_properties_unset_spec.rb +1 -1
  653. data/spec/models/profile_meta_spec.rb +1 -1
  654. data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +1 -1
  655. data/spec/models/profile_partial_update_query_resource_object_spec.rb +1 -1
  656. data/spec/models/profile_partial_update_query_spec.rb +1 -1
  657. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +1 -1
  658. data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +1 -1
  659. data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +1 -1
  660. data/spec/models/profile_subscription_create_query_resource_object_spec.rb +1 -1
  661. data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +1 -1
  662. data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +1 -1
  663. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +1 -1
  664. data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +1 -1
  665. data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +1 -1
  666. data/spec/models/profile_suppression_create_query_resource_object_spec.rb +1 -1
  667. data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +1 -1
  668. data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +1 -1
  669. data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +1 -7
  670. data/spec/models/profile_upsert_query_resource_object_spec.rb +7 -1
  671. data/spec/models/profile_upsert_query_spec.rb +34 -0
  672. data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +1 -1
  673. data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +1 -1
  674. data/spec/models/push_token_create_query_resource_object_spec.rb +1 -1
  675. data/spec/models/push_token_create_query_spec.rb +1 -1
  676. data/spec/models/push_token_enum_spec.rb +1 -1
  677. data/spec/models/render_options_sub_object_spec.rb +1 -1
  678. data/spec/models/segment_enum_spec.rb +1 -1
  679. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +1 -1
  680. data/spec/models/segment_partial_update_query_resource_object_spec.rb +1 -1
  681. data/spec/models/segment_partial_update_query_spec.rb +1 -1
  682. data/spec/models/send_strategy_sub_object_spec.rb +1 -1
  683. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +1 -1
  684. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +1 -1
  685. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +1 -1
  686. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +1 -1
  687. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +1 -1
  688. data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +1 -1
  689. data/spec/models/server_bis_subscription_create_query_spec.rb +1 -1
  690. data/spec/models/sms_content_sub_object_create_spec.rb +1 -1
  691. data/spec/models/sms_send_options_sub_object_spec.rb +1 -1
  692. data/spec/models/sms_subscription_parameters_spec.rb +1 -1
  693. data/spec/models/sms_tracking_options_sub_object_spec.rb +1 -1
  694. data/spec/models/static_schedule_options_spec.rb +1 -1
  695. data/spec/models/sto_schedule_options_spec.rb +1 -1
  696. data/spec/models/subscription_channels_spec.rb +1 -1
  697. data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  698. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  699. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  700. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  701. data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +1 -1
  702. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +1 -1
  703. data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
  704. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  705. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  706. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  707. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  708. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +1 -1
  709. data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +1 -1
  710. data/spec/models/subscription_delete_job_create_query_spec.rb +1 -1
  711. data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  712. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  713. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +1 -1
  714. data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
  715. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  716. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  717. data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +1 -1
  718. data/spec/models/suppression_delete_job_create_query_spec.rb +1 -1
  719. data/spec/models/tag_campaign_op_data_inner_spec.rb +1 -1
  720. data/spec/models/tag_campaign_op_spec.rb +1 -1
  721. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +1 -1
  722. data/spec/models/tag_create_query_resource_object_relationships_spec.rb +1 -1
  723. data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +1 -1
  724. data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +1 -1
  725. data/spec/models/tag_create_query_resource_object_spec.rb +1 -1
  726. data/spec/models/tag_create_query_spec.rb +1 -1
  727. data/spec/models/tag_enum_spec.rb +1 -1
  728. data/spec/models/tag_flow_op_data_inner_spec.rb +1 -1
  729. data/spec/models/tag_flow_op_spec.rb +1 -1
  730. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +1 -1
  731. data/spec/models/tag_group_create_query_resource_object_spec.rb +1 -1
  732. data/spec/models/tag_group_create_query_spec.rb +1 -1
  733. data/spec/models/tag_group_enum_spec.rb +1 -1
  734. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +1 -1
  735. data/spec/models/tag_group_update_query_resource_object_spec.rb +1 -1
  736. data/spec/models/tag_group_update_query_spec.rb +1 -1
  737. data/spec/models/tag_list_op_data_inner_spec.rb +1 -1
  738. data/spec/models/tag_list_op_spec.rb +1 -1
  739. data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
  740. data/spec/models/tag_segment_op_spec.rb +1 -1
  741. data/spec/models/tag_update_query_resource_object_spec.rb +1 -1
  742. data/spec/models/tag_update_query_spec.rb +1 -1
  743. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +1 -1
  744. data/spec/models/template_clone_query_resource_object_spec.rb +1 -1
  745. data/spec/models/template_clone_query_spec.rb +1 -1
  746. data/spec/models/template_create_query_resource_object_attributes_spec.rb +1 -1
  747. data/spec/models/template_create_query_resource_object_spec.rb +1 -1
  748. data/spec/models/template_create_query_spec.rb +1 -1
  749. data/spec/models/template_enum_spec.rb +1 -1
  750. data/spec/models/template_render_query_resource_object_attributes_spec.rb +1 -1
  751. data/spec/models/template_render_query_resource_object_spec.rb +1 -1
  752. data/spec/models/template_render_query_spec.rb +1 -1
  753. data/spec/models/template_update_query_resource_object_attributes_spec.rb +1 -1
  754. data/spec/models/template_update_query_resource_object_spec.rb +1 -1
  755. data/spec/models/template_update_query_spec.rb +1 -1
  756. data/spec/models/throttled_schedule_options_spec.rb +1 -1
  757. data/spec/models/timeframe_spec.rb +38 -0
  758. data/spec/models/utm_params_sub_object_spec.rb +1 -1
  759. data/spec/spec_helper.rb +1 -1
  760. metadata +77 -2
data/docs/ProfilesApi.md CHANGED
@@ -4,8 +4,16 @@ All URIs are relative to *https://a.klaviyo.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**create_or_update_profile**](ProfilesApi.md#create_or_update_profile) | **POST** /api/profile-import/ | Create or Update Profile |
7
8
  | [**create_profile**](ProfilesApi.md#create_profile) | **POST** /api/profiles/ | Create Profile |
8
9
  | [**create_push_token**](ProfilesApi.md#create_push_token) | **POST** /api/push-tokens/ | Create or Update Push Token |
10
+ | [**get_bulk_profile_import_job**](ProfilesApi.md#get_bulk_profile_import_job) | **GET** /api/profile-bulk-import-jobs/{job_id}/ | Get Bulk Profile Import Job |
11
+ | [**get_bulk_profile_import_job_import_errors**](ProfilesApi.md#get_bulk_profile_import_job_import_errors) | **GET** /api/profile-bulk-import-jobs/{id}/import-errors/ | Get Bulk Profile Import Job Errors |
12
+ | [**get_bulk_profile_import_job_lists**](ProfilesApi.md#get_bulk_profile_import_job_lists) | **GET** /api/profile-bulk-import-jobs/{id}/lists/ | Get Bulk Profile Import Job Lists |
13
+ | [**get_bulk_profile_import_job_profiles**](ProfilesApi.md#get_bulk_profile_import_job_profiles) | **GET** /api/profile-bulk-import-jobs/{id}/profiles/ | Get Bulk Profile Import Job Profiles |
14
+ | [**get_bulk_profile_import_job_relationships_lists**](ProfilesApi.md#get_bulk_profile_import_job_relationships_lists) | **GET** /api/profile-bulk-import-jobs/{id}/relationships/lists/ | Get Bulk Profile Import Job Relationships Lists |
15
+ | [**get_bulk_profile_import_job_relationships_profiles**](ProfilesApi.md#get_bulk_profile_import_job_relationships_profiles) | **GET** /api/profile-bulk-import-jobs/{id}/relationships/profiles/ | Get Bulk Profile Import Job Relationships Profiles |
16
+ | [**get_bulk_profile_import_jobs**](ProfilesApi.md#get_bulk_profile_import_jobs) | **GET** /api/profile-bulk-import-jobs/ | Get Bulk Profile Import Jobs |
9
17
  | [**get_profile**](ProfilesApi.md#get_profile) | **GET** /api/profiles/{id}/ | Get Profile |
10
18
  | [**get_profile_lists**](ProfilesApi.md#get_profile_lists) | **GET** /api/profiles/{id}/lists/ | Get Profile Lists |
11
19
  | [**get_profile_relationships_lists**](ProfilesApi.md#get_profile_relationships_lists) | **GET** /api/profiles/{id}/relationships/lists/ | Get Profile Relationships Lists |
@@ -13,6 +21,7 @@ All URIs are relative to *https://a.klaviyo.com*
13
21
  | [**get_profile_segments**](ProfilesApi.md#get_profile_segments) | **GET** /api/profiles/{id}/segments/ | Get Profile Segments |
14
22
  | [**get_profiles**](ProfilesApi.md#get_profiles) | **GET** /api/profiles/ | Get Profiles |
15
23
  | [**merge_profiles**](ProfilesApi.md#merge_profiles) | **POST** /api/profile-merge/ | Merge Profiles |
24
+ | [**spawn_bulk_profile_import_job**](ProfilesApi.md#spawn_bulk_profile_import_job) | **POST** /api/profile-bulk-import-jobs/ | Spawn Bulk Profile Import Job |
16
25
  | [**subscribe_profiles**](ProfilesApi.md#subscribe_profiles) | **POST** /api/profile-subscription-bulk-create-jobs/ | Subscribe Profiles |
17
26
  | [**suppress_profiles**](ProfilesApi.md#suppress_profiles) | **POST** /api/profile-suppression-bulk-create-jobs/ | Suppress Profiles |
18
27
  | [**unsubscribe_profiles**](ProfilesApi.md#unsubscribe_profiles) | **POST** /api/profile-subscription-bulk-delete-jobs/ | Unsubscribe Profiles |
@@ -20,13 +29,458 @@ All URIs are relative to *https://a.klaviyo.com*
20
29
  | [**update_profile**](ProfilesApi.md#update_profile) | **PATCH** /api/profiles/{id}/ | Update Profile |
21
30
 
22
31
 
32
+ ## create_or_update_profile
33
+
34
+ > Hash<String, Object> create_or_update_profile(profile_upsert_query)
35
+
36
+ Create or Update Profile
37
+
38
+ Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
39
+
40
+ ### Examples
41
+
42
+ ```ruby
43
+ require 'time'
44
+ require 'klaviyo-api-sdk'
45
+ # setup authorization
46
+ KlaviyoAPI.configure do |config|
47
+ # Configure API key authorization: Klaviyo-API-Key
48
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
49
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
50
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
51
+ end
52
+
53
+ api_instance = KlaviyoAPI::ProfilesApi.new
54
+ profile_upsert_query = KlaviyoAPI::ProfileUpsertQuery.new({data: KlaviyoAPI::ProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new})}) # ProfileUpsertQuery |
55
+
56
+ begin
57
+ # Create or Update Profile
58
+ result = api_instance.create_or_update_profile(profile_upsert_query)
59
+ p result
60
+ rescue KlaviyoAPI::ApiError => e
61
+ puts "Error when calling ProfilesApi->create_or_update_profile: #{e}"
62
+ end
63
+ ```
64
+
65
+ #### Using the create_or_update_profile_with_http_info variant
66
+
67
+ This returns an Array which contains the response data, status code and headers.
68
+
69
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_or_update_profile_with_http_info(profile_upsert_query)
70
+
71
+ ```ruby
72
+ begin
73
+ # Create or Update Profile
74
+ data, status_code, headers = api_instance.create_or_update_profile_with_http_info(profile_upsert_query)
75
+ p status_code # => 2xx
76
+ p headers # => { ... }
77
+ p data # => Hash&lt;String, Object&gt;
78
+ rescue KlaviyoAPI::ApiError => e
79
+ puts "Error when calling ProfilesApi->create_or_update_profile_with_http_info: #{e}"
80
+ end
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ | Name | Type | Description | Notes |
86
+ | ---- | ---- | ----------- | ----- |
87
+ | **profile_upsert_query** | [**ProfileUpsertQuery**](ProfileUpsertQuery.md) | | |
88
+
89
+ ### Return type
90
+
91
+ **Hash&lt;String, Object&gt;**
92
+
93
+ ### Authorization
94
+
95
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
96
+
97
+ ### HTTP request headers
98
+
99
+ - **Content-Type**: application/json
100
+ - **Accept**: application/json
101
+
102
+
23
103
  ## create_profile
24
104
 
25
- > Hash&lt;String, Object&gt; create_profile(profile_create_query)
105
+ > Hash&lt;String, Object&gt; create_profile(profile_create_query)
106
+
107
+ Create Profile
108
+
109
+ Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
110
+
111
+ ### Examples
112
+
113
+ ```ruby
114
+ require 'time'
115
+ require 'klaviyo-api-sdk'
116
+ # setup authorization
117
+ KlaviyoAPI.configure do |config|
118
+ # Configure API key authorization: Klaviyo-API-Key
119
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
120
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
121
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
122
+ end
123
+
124
+ api_instance = KlaviyoAPI::ProfilesApi.new
125
+ profile_create_query = KlaviyoAPI::ProfileCreateQuery.new({data: KlaviyoAPI::ProfileCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileCreateQueryResourceObjectAttributes.new})}) # ProfileCreateQuery |
126
+
127
+ begin
128
+ # Create Profile
129
+ result = api_instance.create_profile(profile_create_query)
130
+ p result
131
+ rescue KlaviyoAPI::ApiError => e
132
+ puts "Error when calling ProfilesApi->create_profile: #{e}"
133
+ end
134
+ ```
135
+
136
+ #### Using the create_profile_with_http_info variant
137
+
138
+ This returns an Array which contains the response data, status code and headers.
139
+
140
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_profile_with_http_info(profile_create_query)
141
+
142
+ ```ruby
143
+ begin
144
+ # Create Profile
145
+ data, status_code, headers = api_instance.create_profile_with_http_info(profile_create_query)
146
+ p status_code # => 2xx
147
+ p headers # => { ... }
148
+ p data # => Hash&lt;String, Object&gt;
149
+ rescue KlaviyoAPI::ApiError => e
150
+ puts "Error when calling ProfilesApi->create_profile_with_http_info: #{e}"
151
+ end
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Name | Type | Description | Notes |
157
+ | ---- | ---- | ----------- | ----- |
158
+ | **profile_create_query** | [**ProfileCreateQuery**](ProfileCreateQuery.md) | | |
159
+
160
+ ### Return type
161
+
162
+ **Hash&lt;String, Object&gt;**
163
+
164
+ ### Authorization
165
+
166
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
167
+
168
+ ### HTTP request headers
169
+
170
+ - **Content-Type**: application/json
171
+ - **Accept**: application/json
172
+
173
+
174
+ ## create_push_token
175
+
176
+ > create_push_token(push_token_create_query)
177
+
178
+ Create or Update Push Token
179
+
180
+ Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `push-tokens:write`
181
+
182
+ ### Examples
183
+
184
+ ```ruby
185
+ require 'time'
186
+ require 'klaviyo-api-sdk'
187
+ # setup authorization
188
+ KlaviyoAPI.configure do |config|
189
+ # Configure API key authorization: Klaviyo-API-Key
190
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
191
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
192
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
193
+ end
194
+
195
+ api_instance = KlaviyoAPI::ProfilesApi.new
196
+ push_token_create_query = KlaviyoAPI::PushTokenCreateQuery.new({data: KlaviyoAPI::PushTokenCreateQueryResourceObject.new({type: KlaviyoAPI::PushTokenEnum::PUSH_TOKEN, attributes: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributes.new({token: '1234567890', platform: 'android', vendor: 'apns', profile: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributesProfile.new({data: KlaviyoAPI::ProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new})})})})}) # PushTokenCreateQuery |
197
+
198
+ begin
199
+ # Create or Update Push Token
200
+ api_instance.create_push_token(push_token_create_query)
201
+ rescue KlaviyoAPI::ApiError => e
202
+ puts "Error when calling ProfilesApi->create_push_token: #{e}"
203
+ end
204
+ ```
205
+
206
+ #### Using the create_push_token_with_http_info variant
207
+
208
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
209
+
210
+ > <Array(nil, Integer, Hash)> create_push_token_with_http_info(push_token_create_query)
211
+
212
+ ```ruby
213
+ begin
214
+ # Create or Update Push Token
215
+ data, status_code, headers = api_instance.create_push_token_with_http_info(push_token_create_query)
216
+ p status_code # => 2xx
217
+ p headers # => { ... }
218
+ p data # => nil
219
+ rescue KlaviyoAPI::ApiError => e
220
+ puts "Error when calling ProfilesApi->create_push_token_with_http_info: #{e}"
221
+ end
222
+ ```
223
+
224
+ ### Parameters
225
+
226
+ | Name | Type | Description | Notes |
227
+ | ---- | ---- | ----------- | ----- |
228
+ | **push_token_create_query** | [**PushTokenCreateQuery**](PushTokenCreateQuery.md) | | |
229
+
230
+ ### Return type
231
+
232
+ nil (empty response body)
233
+
234
+ ### Authorization
235
+
236
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
237
+
238
+ ### HTTP request headers
239
+
240
+ - **Content-Type**: application/json
241
+ - **Accept**: application/json
242
+
243
+
244
+ ## get_bulk_profile_import_job
245
+
246
+ > Hash&lt;String, Object&gt; get_bulk_profile_import_job(job_id, opts)
247
+
248
+ Get Bulk Profile Import Job
249
+
250
+ 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`
251
+
252
+ ### Examples
253
+
254
+ ```ruby
255
+ require 'time'
256
+ require 'klaviyo-api-sdk'
257
+ # setup authorization
258
+ KlaviyoAPI.configure do |config|
259
+ # Configure API key authorization: Klaviyo-API-Key
260
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
261
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
262
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
263
+ end
264
+
265
+ api_instance = KlaviyoAPI::ProfilesApi.new
266
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
267
+ opts = {
268
+ fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
269
+ fields_profile_bulk_import_job: ['status'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
270
+ include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
271
+ }
272
+
273
+ begin
274
+ # Get Bulk Profile Import Job
275
+ result = api_instance.get_bulk_profile_import_job(job_id, opts)
276
+ p result
277
+ rescue KlaviyoAPI::ApiError => e
278
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job: #{e}"
279
+ end
280
+ ```
281
+
282
+ #### Using the get_bulk_profile_import_job_with_http_info variant
283
+
284
+ This returns an Array which contains the response data, status code and headers.
285
+
286
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_bulk_profile_import_job_with_http_info(job_id, opts)
287
+
288
+ ```ruby
289
+ begin
290
+ # Get Bulk Profile Import Job
291
+ data, status_code, headers = api_instance.get_bulk_profile_import_job_with_http_info(job_id, opts)
292
+ p status_code # => 2xx
293
+ p headers # => { ... }
294
+ p data # => Hash&lt;String, Object&gt;
295
+ rescue KlaviyoAPI::ApiError => e
296
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_with_http_info: #{e}"
297
+ end
298
+ ```
299
+
300
+ ### Parameters
301
+
302
+ | Name | Type | Description | Notes |
303
+ | ---- | ---- | ----------- | ----- |
304
+ | **job_id** | **String** | ID of the job to retrieve. | |
305
+ | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
306
+ | **fields_profile_bulk_import_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
307
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
308
+
309
+ ### Return type
310
+
311
+ **Hash&lt;String, Object&gt;**
312
+
313
+ ### Authorization
314
+
315
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
316
+
317
+ ### HTTP request headers
318
+
319
+ - **Content-Type**: Not defined
320
+ - **Accept**: application/json
321
+
322
+
323
+ ## get_bulk_profile_import_job_import_errors
324
+
325
+ > Hash&lt;String, Object&gt; get_bulk_profile_import_job_import_errors(id, opts)
326
+
327
+ Get Bulk Profile Import Job Errors
328
+
329
+ 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`
330
+
331
+ ### Examples
332
+
333
+ ```ruby
334
+ require 'time'
335
+ require 'klaviyo-api-sdk'
336
+ # setup authorization
337
+ KlaviyoAPI.configure do |config|
338
+ # Configure API key authorization: Klaviyo-API-Key
339
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
340
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
341
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
342
+ end
343
+
344
+ api_instance = KlaviyoAPI::ProfilesApi.new
345
+ id = 'id_example' # String |
346
+ opts = {
347
+ fields_import_error: ['code'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
348
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
349
+ page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
350
+ }
351
+
352
+ begin
353
+ # Get Bulk Profile Import Job Errors
354
+ result = api_instance.get_bulk_profile_import_job_import_errors(id, opts)
355
+ p result
356
+ rescue KlaviyoAPI::ApiError => e
357
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_import_errors: #{e}"
358
+ end
359
+ ```
360
+
361
+ #### Using the get_bulk_profile_import_job_import_errors_with_http_info variant
362
+
363
+ This returns an Array which contains the response data, status code and headers.
364
+
365
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_bulk_profile_import_job_import_errors_with_http_info(id, opts)
366
+
367
+ ```ruby
368
+ begin
369
+ # Get Bulk Profile Import Job Errors
370
+ data, status_code, headers = api_instance.get_bulk_profile_import_job_import_errors_with_http_info(id, opts)
371
+ p status_code # => 2xx
372
+ p headers # => { ... }
373
+ p data # => Hash&lt;String, Object&gt;
374
+ rescue KlaviyoAPI::ApiError => e
375
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_import_errors_with_http_info: #{e}"
376
+ end
377
+ ```
378
+
379
+ ### Parameters
380
+
381
+ | Name | Type | Description | Notes |
382
+ | ---- | ---- | ----------- | ----- |
383
+ | **id** | **String** | | |
384
+ | **fields_import_error** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
385
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
386
+ | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
387
+
388
+ ### Return type
389
+
390
+ **Hash&lt;String, Object&gt;**
391
+
392
+ ### Authorization
393
+
394
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
395
+
396
+ ### HTTP request headers
397
+
398
+ - **Content-Type**: Not defined
399
+ - **Accept**: application/json
400
+
401
+
402
+ ## get_bulk_profile_import_job_lists
403
+
404
+ > Hash&lt;String, Object&gt; get_bulk_profile_import_job_lists(id, opts)
405
+
406
+ Get Bulk Profile Import Job Lists
407
+
408
+ 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`
409
+
410
+ ### Examples
411
+
412
+ ```ruby
413
+ require 'time'
414
+ require 'klaviyo-api-sdk'
415
+ # setup authorization
416
+ KlaviyoAPI.configure do |config|
417
+ # Configure API key authorization: Klaviyo-API-Key
418
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
419
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
420
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
421
+ end
422
+
423
+ api_instance = KlaviyoAPI::ProfilesApi.new
424
+ id = 'id_example' # String |
425
+ opts = {
426
+ fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
427
+ }
428
+
429
+ begin
430
+ # Get Bulk Profile Import Job Lists
431
+ result = api_instance.get_bulk_profile_import_job_lists(id, opts)
432
+ p result
433
+ rescue KlaviyoAPI::ApiError => e
434
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_lists: #{e}"
435
+ end
436
+ ```
437
+
438
+ #### Using the get_bulk_profile_import_job_lists_with_http_info variant
439
+
440
+ This returns an Array which contains the response data, status code and headers.
441
+
442
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_bulk_profile_import_job_lists_with_http_info(id, opts)
443
+
444
+ ```ruby
445
+ begin
446
+ # Get Bulk Profile Import Job Lists
447
+ data, status_code, headers = api_instance.get_bulk_profile_import_job_lists_with_http_info(id, opts)
448
+ p status_code # => 2xx
449
+ p headers # => { ... }
450
+ p data # => Hash&lt;String, Object&gt;
451
+ rescue KlaviyoAPI::ApiError => e
452
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_lists_with_http_info: #{e}"
453
+ end
454
+ ```
455
+
456
+ ### Parameters
26
457
 
27
- Create Profile
458
+ | Name | Type | Description | Notes |
459
+ | ---- | ---- | ----------- | ----- |
460
+ | **id** | **String** | | |
461
+ | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
28
462
 
29
- Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
463
+ ### Return type
464
+
465
+ **Hash&lt;String, Object&gt;**
466
+
467
+ ### Authorization
468
+
469
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
470
+
471
+ ### HTTP request headers
472
+
473
+ - **Content-Type**: Not defined
474
+ - **Accept**: application/json
475
+
476
+
477
+ ## get_bulk_profile_import_job_profiles
478
+
479
+ > Hash&lt;String, Object&gt; get_bulk_profile_import_job_profiles(id, opts)
480
+
481
+ Get Bulk Profile Import Job Profiles
482
+
483
+ 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`
30
484
 
31
485
  ### Examples
32
486
 
@@ -42,32 +496,38 @@ KlaviyoAPI.configure do |config|
42
496
  end
43
497
 
44
498
  api_instance = KlaviyoAPI::ProfilesApi.new
45
- profile_create_query = KlaviyoAPI::ProfileCreateQuery.new({data: KlaviyoAPI::ProfileCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileCreateQueryResourceObjectAttributes.new})}) # ProfileCreateQuery |
499
+ id = 'id_example' # String |
500
+ opts = {
501
+ additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
502
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
503
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
504
+ page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
505
+ }
46
506
 
47
507
  begin
48
- # Create Profile
49
- result = api_instance.create_profile(profile_create_query)
508
+ # Get Bulk Profile Import Job Profiles
509
+ result = api_instance.get_bulk_profile_import_job_profiles(id, opts)
50
510
  p result
51
511
  rescue KlaviyoAPI::ApiError => e
52
- puts "Error when calling ProfilesApi->create_profile: #{e}"
512
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_profiles: #{e}"
53
513
  end
54
514
  ```
55
515
 
56
- #### Using the create_profile_with_http_info variant
516
+ #### Using the get_bulk_profile_import_job_profiles_with_http_info variant
57
517
 
58
518
  This returns an Array which contains the response data, status code and headers.
59
519
 
60
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_profile_with_http_info(profile_create_query)
520
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_bulk_profile_import_job_profiles_with_http_info(id, opts)
61
521
 
62
522
  ```ruby
63
523
  begin
64
- # Create Profile
65
- data, status_code, headers = api_instance.create_profile_with_http_info(profile_create_query)
524
+ # Get Bulk Profile Import Job Profiles
525
+ data, status_code, headers = api_instance.get_bulk_profile_import_job_profiles_with_http_info(id, opts)
66
526
  p status_code # => 2xx
67
527
  p headers # => { ... }
68
528
  p data # => Hash&lt;String, Object&gt;
69
529
  rescue KlaviyoAPI::ApiError => e
70
- puts "Error when calling ProfilesApi->create_profile_with_http_info: #{e}"
530
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_profiles_with_http_info: #{e}"
71
531
  end
72
532
  ```
73
533
 
@@ -75,7 +535,11 @@ end
75
535
 
76
536
  | Name | Type | Description | Notes |
77
537
  | ---- | ---- | ----------- | ----- |
78
- | **profile_create_query** | [**ProfileCreateQuery**](ProfileCreateQuery.md) | | |
538
+ | **id** | **String** | | |
539
+ | **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39; | [optional] |
540
+ | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
541
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
542
+ | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
79
543
 
80
544
  ### Return type
81
545
 
@@ -87,17 +551,17 @@ end
87
551
 
88
552
  ### HTTP request headers
89
553
 
90
- - **Content-Type**: application/json
554
+ - **Content-Type**: Not defined
91
555
  - **Accept**: application/json
92
556
 
93
557
 
94
- ## create_push_token
558
+ ## get_bulk_profile_import_job_relationships_lists
95
559
 
96
- > create_push_token(push_token_create_query)
560
+ > Hash&lt;String, Object&gt; get_bulk_profile_import_job_relationships_lists(id)
97
561
 
98
- Create or Update Push Token
562
+ Get Bulk Profile Import Job Relationships Lists
99
563
 
100
- Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `push-tokens:write`
564
+ 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`
101
565
 
102
566
  ### Examples
103
567
 
@@ -113,31 +577,32 @@ KlaviyoAPI.configure do |config|
113
577
  end
114
578
 
115
579
  api_instance = KlaviyoAPI::ProfilesApi.new
116
- push_token_create_query = KlaviyoAPI::PushTokenCreateQuery.new({data: KlaviyoAPI::PushTokenCreateQueryResourceObject.new({type: KlaviyoAPI::PushTokenEnum::PUSH_TOKEN, attributes: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributes.new({token: '1234567890', platform: 'android', vendor: 'apns', profile: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributesProfile.new({data: KlaviyoAPI::ProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new})})})})}) # PushTokenCreateQuery |
580
+ id = 'id_example' # String |
117
581
 
118
582
  begin
119
- # Create or Update Push Token
120
- api_instance.create_push_token(push_token_create_query)
583
+ # Get Bulk Profile Import Job Relationships Lists
584
+ result = api_instance.get_bulk_profile_import_job_relationships_lists(id)
585
+ p result
121
586
  rescue KlaviyoAPI::ApiError => e
122
- puts "Error when calling ProfilesApi->create_push_token: #{e}"
587
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_lists: #{e}"
123
588
  end
124
589
  ```
125
590
 
126
- #### Using the create_push_token_with_http_info variant
591
+ #### Using the get_bulk_profile_import_job_relationships_lists_with_http_info variant
127
592
 
128
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
593
+ This returns an Array which contains the response data, status code and headers.
129
594
 
130
- > <Array(nil, Integer, Hash)> create_push_token_with_http_info(push_token_create_query)
595
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_bulk_profile_import_job_relationships_lists_with_http_info(id)
131
596
 
132
597
  ```ruby
133
598
  begin
134
- # Create or Update Push Token
135
- data, status_code, headers = api_instance.create_push_token_with_http_info(push_token_create_query)
599
+ # Get Bulk Profile Import Job Relationships Lists
600
+ data, status_code, headers = api_instance.get_bulk_profile_import_job_relationships_lists_with_http_info(id)
136
601
  p status_code # => 2xx
137
602
  p headers # => { ... }
138
- p data # => nil
603
+ p data # => Hash&lt;String, Object&gt;
139
604
  rescue KlaviyoAPI::ApiError => e
140
- puts "Error when calling ProfilesApi->create_push_token_with_http_info: #{e}"
605
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_lists_with_http_info: #{e}"
141
606
  end
142
607
  ```
143
608
 
@@ -145,11 +610,11 @@ end
145
610
 
146
611
  | Name | Type | Description | Notes |
147
612
  | ---- | ---- | ----------- | ----- |
148
- | **push_token_create_query** | [**PushTokenCreateQuery**](PushTokenCreateQuery.md) | | |
613
+ | **id** | **String** | | |
149
614
 
150
615
  ### Return type
151
616
 
152
- nil (empty response body)
617
+ **Hash&lt;String, Object&gt;**
153
618
 
154
619
  ### Authorization
155
620
 
@@ -157,7 +622,165 @@ nil (empty response body)
157
622
 
158
623
  ### HTTP request headers
159
624
 
160
- - **Content-Type**: application/json
625
+ - **Content-Type**: Not defined
626
+ - **Accept**: application/json
627
+
628
+
629
+ ## get_bulk_profile_import_job_relationships_profiles
630
+
631
+ > Hash&lt;String, Object&gt; get_bulk_profile_import_job_relationships_profiles(id, opts)
632
+
633
+ Get Bulk Profile Import Job Relationships Profiles
634
+
635
+ Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
636
+
637
+ ### Examples
638
+
639
+ ```ruby
640
+ require 'time'
641
+ require 'klaviyo-api-sdk'
642
+ # setup authorization
643
+ KlaviyoAPI.configure do |config|
644
+ # Configure API key authorization: Klaviyo-API-Key
645
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
646
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
647
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
648
+ end
649
+
650
+ api_instance = KlaviyoAPI::ProfilesApi.new
651
+ id = 'id_example' # String |
652
+ opts = {
653
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
654
+ page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
655
+ }
656
+
657
+ begin
658
+ # Get Bulk Profile Import Job Relationships Profiles
659
+ result = api_instance.get_bulk_profile_import_job_relationships_profiles(id, opts)
660
+ p result
661
+ rescue KlaviyoAPI::ApiError => e
662
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_profiles: #{e}"
663
+ end
664
+ ```
665
+
666
+ #### Using the get_bulk_profile_import_job_relationships_profiles_with_http_info variant
667
+
668
+ This returns an Array which contains the response data, status code and headers.
669
+
670
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts)
671
+
672
+ ```ruby
673
+ begin
674
+ # Get Bulk Profile Import Job Relationships Profiles
675
+ data, status_code, headers = api_instance.get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts)
676
+ p status_code # => 2xx
677
+ p headers # => { ... }
678
+ p data # => Hash&lt;String, Object&gt;
679
+ rescue KlaviyoAPI::ApiError => e
680
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_job_relationships_profiles_with_http_info: #{e}"
681
+ end
682
+ ```
683
+
684
+ ### Parameters
685
+
686
+ | Name | Type | Description | Notes |
687
+ | ---- | ---- | ----------- | ----- |
688
+ | **id** | **String** | | |
689
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
690
+ | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
691
+
692
+ ### Return type
693
+
694
+ **Hash&lt;String, Object&gt;**
695
+
696
+ ### Authorization
697
+
698
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
699
+
700
+ ### HTTP request headers
701
+
702
+ - **Content-Type**: Not defined
703
+ - **Accept**: application/json
704
+
705
+
706
+ ## get_bulk_profile_import_jobs
707
+
708
+ > Hash&lt;String, Object&gt; get_bulk_profile_import_jobs(opts)
709
+
710
+ Get Bulk Profile Import Jobs
711
+
712
+ 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`
713
+
714
+ ### Examples
715
+
716
+ ```ruby
717
+ require 'time'
718
+ require 'klaviyo-api-sdk'
719
+ # setup authorization
720
+ KlaviyoAPI.configure do |config|
721
+ # Configure API key authorization: Klaviyo-API-Key
722
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
723
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
724
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
725
+ end
726
+
727
+ api_instance = KlaviyoAPI::ProfilesApi.new
728
+ opts = {
729
+ fields_profile_bulk_import_job: ['status'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
730
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
731
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
732
+ page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
733
+ sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
734
+ }
735
+
736
+ begin
737
+ # Get Bulk Profile Import Jobs
738
+ result = api_instance.get_bulk_profile_import_jobs(opts)
739
+ p result
740
+ rescue KlaviyoAPI::ApiError => e
741
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_jobs: #{e}"
742
+ end
743
+ ```
744
+
745
+ #### Using the get_bulk_profile_import_jobs_with_http_info variant
746
+
747
+ This returns an Array which contains the response data, status code and headers.
748
+
749
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_bulk_profile_import_jobs_with_http_info(opts)
750
+
751
+ ```ruby
752
+ begin
753
+ # Get Bulk Profile Import Jobs
754
+ data, status_code, headers = api_instance.get_bulk_profile_import_jobs_with_http_info(opts)
755
+ p status_code # => 2xx
756
+ p headers # => { ... }
757
+ p data # => Hash&lt;String, Object&gt;
758
+ rescue KlaviyoAPI::ApiError => e
759
+ puts "Error when calling ProfilesApi->get_bulk_profile_import_jobs_with_http_info: #{e}"
760
+ end
761
+ ```
762
+
763
+ ### Parameters
764
+
765
+ | Name | Type | Description | Notes |
766
+ | ---- | ---- | ----------- | ----- |
767
+ | **fields_profile_bulk_import_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
768
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; | [optional] |
769
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
770
+ | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
771
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting | [optional] |
772
+
773
+ ### Return type
774
+
775
+ **Hash&lt;String, Object&gt;**
776
+
777
+ ### Authorization
778
+
779
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
780
+
781
+ ### HTTP request headers
782
+
783
+ - **Content-Type**: Not defined
161
784
  - **Accept**: application/json
162
785
 
163
786
 
@@ -186,10 +809,10 @@ api_instance = KlaviyoAPI::ProfilesApi.new
186
809
  id = 'id_example' # String |
187
810
  opts = {
188
811
  additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
189
- fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
190
- fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
191
- fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
192
- include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
812
+ fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
813
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
814
+ fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
815
+ include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
193
816
  }
194
817
 
195
818
  begin
@@ -225,10 +848,10 @@ end
225
848
  | ---- | ---- | ----------- | ----- |
226
849
  | **id** | **String** | | |
227
850
  | **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39; | [optional] |
228
- | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
229
- | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
230
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
231
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
851
+ | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
852
+ | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
853
+ | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
854
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
232
855
 
233
856
  ### Return type
234
857
 
@@ -250,7 +873,7 @@ end
250
873
 
251
874
  Get Profile Lists
252
875
 
253
- 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`
876
+ 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`
254
877
 
255
878
  ### Examples
256
879
 
@@ -268,7 +891,7 @@ end
268
891
  api_instance = KlaviyoAPI::ProfilesApi.new
269
892
  id = 'id_example' # String |
270
893
  opts = {
271
- fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
894
+ fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
272
895
  }
273
896
 
274
897
  begin
@@ -303,7 +926,7 @@ end
303
926
  | Name | Type | Description | Notes |
304
927
  | ---- | ---- | ----------- | ----- |
305
928
  | **id** | **String** | | |
306
- | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
929
+ | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
307
930
 
308
931
  ### Return type
309
932
 
@@ -325,7 +948,7 @@ end
325
948
 
326
949
  Get Profile Relationships Lists
327
950
 
328
- 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`
951
+ 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`
329
952
 
330
953
  ### Examples
331
954
 
@@ -485,7 +1108,7 @@ end
485
1108
  api_instance = KlaviyoAPI::ProfilesApi.new
486
1109
  id = 'id_example' # String |
487
1110
  opts = {
488
- fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
1111
+ fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
489
1112
  }
490
1113
 
491
1114
  begin
@@ -520,7 +1143,7 @@ end
520
1143
  | Name | Type | Description | Notes |
521
1144
  | ---- | ---- | ----------- | ----- |
522
1145
  | **id** | **String** | | |
523
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
1146
+ | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
524
1147
 
525
1148
  ### Return type
526
1149
 
@@ -542,7 +1165,7 @@ end
542
1165
 
543
1166
  Get Profiles
544
1167
 
545
- 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`
1168
+ Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
546
1169
 
547
1170
  ### Examples
548
1171
 
@@ -560,11 +1183,11 @@ end
560
1183
  api_instance = KlaviyoAPI::ProfilesApi.new
561
1184
  opts = {
562
1185
  additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
563
- fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
564
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`
565
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
1186
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1187
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`
1188
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
566
1189
  page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
567
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
1190
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
568
1191
  }
569
1192
 
570
1193
  begin
@@ -599,11 +1222,11 @@ end
599
1222
  | Name | Type | Description | Notes |
600
1223
  | ---- | ---- | ----------- | ----- |
601
1224
  | **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39; | [optional] |
602
- | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
603
- | **filter** | **String** | 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; | [optional] |
604
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
1225
+ | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1226
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;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; | [optional] |
1227
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
605
1228
  | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
606
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
1229
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting | [optional] |
607
1230
 
608
1231
  ### Return type
609
1232
 
@@ -690,13 +1313,84 @@ end
690
1313
  - **Accept**: application/json
691
1314
 
692
1315
 
1316
+ ## spawn_bulk_profile_import_job
1317
+
1318
+ > Hash&lt;String, Object&gt; spawn_bulk_profile_import_job(profile_import_job_create_query)
1319
+
1320
+ Spawn Bulk Profile Import Job
1321
+
1322
+ Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
1323
+
1324
+ ### Examples
1325
+
1326
+ ```ruby
1327
+ require 'time'
1328
+ require 'klaviyo-api-sdk'
1329
+ # setup authorization
1330
+ KlaviyoAPI.configure do |config|
1331
+ # Configure API key authorization: Klaviyo-API-Key
1332
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1333
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1334
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1335
+ end
1336
+
1337
+ api_instance = KlaviyoAPI::ProfilesApi.new
1338
+ profile_import_job_create_query = KlaviyoAPI::ProfileImportJobCreateQuery.new({data: KlaviyoAPI::ProfileImportJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileBulkImportJobEnum::PROFILE_BULK_IMPORT_JOB, attributes: KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::ProfileImportJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new})]})})})}) # ProfileImportJobCreateQuery |
1339
+
1340
+ begin
1341
+ # Spawn Bulk Profile Import Job
1342
+ result = api_instance.spawn_bulk_profile_import_job(profile_import_job_create_query)
1343
+ p result
1344
+ rescue KlaviyoAPI::ApiError => e
1345
+ puts "Error when calling ProfilesApi->spawn_bulk_profile_import_job: #{e}"
1346
+ end
1347
+ ```
1348
+
1349
+ #### Using the spawn_bulk_profile_import_job_with_http_info variant
1350
+
1351
+ This returns an Array which contains the response data, status code and headers.
1352
+
1353
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query)
1354
+
1355
+ ```ruby
1356
+ begin
1357
+ # Spawn Bulk Profile Import Job
1358
+ data, status_code, headers = api_instance.spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query)
1359
+ p status_code # => 2xx
1360
+ p headers # => { ... }
1361
+ p data # => Hash&lt;String, Object&gt;
1362
+ rescue KlaviyoAPI::ApiError => e
1363
+ puts "Error when calling ProfilesApi->spawn_bulk_profile_import_job_with_http_info: #{e}"
1364
+ end
1365
+ ```
1366
+
1367
+ ### Parameters
1368
+
1369
+ | Name | Type | Description | Notes |
1370
+ | ---- | ---- | ----------- | ----- |
1371
+ | **profile_import_job_create_query** | [**ProfileImportJobCreateQuery**](ProfileImportJobCreateQuery.md) | | |
1372
+
1373
+ ### Return type
1374
+
1375
+ **Hash&lt;String, Object&gt;**
1376
+
1377
+ ### Authorization
1378
+
1379
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1380
+
1381
+ ### HTTP request headers
1382
+
1383
+ - **Content-Type**: application/json
1384
+ - **Accept**: application/json
1385
+
1386
+
693
1387
  ## subscribe_profiles
694
1388
 
695
1389
  > subscribe_profiles(subscription_create_job_create_query)
696
1390
 
697
1391
  Subscribe Profiles
698
1392
 
699
- 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`
1393
+ Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
700
1394
 
701
1395
  ### Examples
702
1396
 
@@ -712,7 +1406,7 @@ KlaviyoAPI.configure do |config|
712
1406
  end
713
1407
 
714
1408
  api_instance = KlaviyoAPI::ProfilesApi.new
715
- subscription_create_job_create_query = KlaviyoAPI::SubscriptionCreateJobCreateQuery.new({data: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSubscriptionBulkCreateJobEnum::PROFILE_SUBSCRIPTION_BULK_CREATE_JOB, attributes: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObjectAttributes.new})]})}), relationships: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectRelationships.new({list: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.new({data: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.new({type: KlaviyoAPI::ListEnum::LIST, id: 'Y6nRLr'})})})})}) # 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.
1409
+ subscription_create_job_create_query = KlaviyoAPI::SubscriptionCreateJobCreateQuery.new({data: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSubscriptionBulkCreateJobEnum::PROFILE_SUBSCRIPTION_BULK_CREATE_JOB, attributes: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObjectAttributes.new})]})})})}) # 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
1410
 
717
1411
  begin
718
1412
  # Subscribe Profiles
@@ -766,7 +1460,7 @@ nil (empty response body)
766
1460
 
767
1461
  Suppress Profiles
768
1462
 
769
- 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`
1463
+ 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`
770
1464
 
771
1465
  ### Examples
772
1466
 
@@ -836,7 +1530,7 @@ nil (empty response body)
836
1530
 
837
1531
  Unsubscribe Profiles
838
1532
 
839
- 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`
1533
+ Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
840
1534
 
841
1535
  ### Examples
842
1536
 
@@ -906,7 +1600,7 @@ nil (empty response body)
906
1600
 
907
1601
  Unsuppress Profiles
908
1602
 
909
- 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`
1603
+ 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`
910
1604
 
911
1605
  ### Examples
912
1606