klaviyo-api-sdk 1.2.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (765) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +654 -238
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +101 -107
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +461 -549
  8. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  9. data/lib/klaviyo-api-sdk/api/events_api.rb +132 -71
  10. data/lib/klaviyo-api-sdk/api/flows_api.rb +368 -206
  11. data/lib/klaviyo-api-sdk/api/lists_api.rb +172 -122
  12. data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
  13. data/lib/klaviyo-api-sdk/api/profiles_api.rb +173 -94
  14. data/lib/klaviyo-api-sdk/api/segments_api.rb +148 -76
  15. data/lib/klaviyo-api-sdk/api/tags_api.rb +932 -260
  16. data/lib/klaviyo-api-sdk/api/templates_api.rb +32 -32
  17. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  18. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  19. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  20. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  21. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +2 -2
  22. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +238 -0
  23. data/lib/klaviyo-api-sdk/models/{campaign_clone_query_as_sub_resource_attributes.rb → campaign_clone_query_resource_object_attributes.rb} +18 -18
  24. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +2 -2
  25. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +238 -0
  26. data/lib/klaviyo-api-sdk/models/{campaign_create_query_as_sub_resource_attributes.rb → campaign_create_query_resource_object_attributes.rb} +38 -38
  27. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +36 -0
  28. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +2 -2
  29. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +238 -0
  30. data/lib/klaviyo-api-sdk/models/{campaign_message_assign_template_query_as_sub_resource_attributes.rb → campaign_message_assign_template_query_resource_object_attributes.rb} +4 -4
  31. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +36 -0
  32. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +2 -2
  33. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +253 -0
  34. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_as_sub_resource_attributes.rb → campaign_message_partial_update_query_resource_object_attributes.rb} +17 -17
  35. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +2 -2
  36. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +253 -0
  37. data/lib/klaviyo-api-sdk/models/{campaign_partial_update_query_as_sub_resource_attributes.rb → campaign_partial_update_query_resource_object_attributes.rb} +30 -30
  38. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +2 -2
  39. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +238 -0
  40. data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb → campaign_recipient_estimation_job_create_query_resource_object_attributes.rb} +4 -4
  41. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +36 -0
  42. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +2 -2
  43. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → campaign_send_job_create_query_resource_object.rb} +27 -17
  44. data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_as_sub_resource_attributes.rb → campaign_send_job_create_query_resource_object_attributes.rb} +4 -4
  45. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +36 -0
  46. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +2 -2
  47. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +253 -0
  48. data/lib/klaviyo-api-sdk/models/{campaign_send_job_partial_update_query_as_sub_resource_attributes.rb → campaign_send_job_partial_update_query_resource_object_attributes.rb} +4 -4
  49. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +36 -0
  50. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +36 -0
  51. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +36 -0
  52. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
  53. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +238 -0
  54. data/lib/klaviyo-api-sdk/models/{catalog_category_create_job_create_query_as_sub_resource_attributes.rb → catalog_category_create_job_create_query_resource_object_attributes.rb} +5 -5
  55. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
  56. data/lib/klaviyo-api-sdk/models/{list_create_query_as_sub_resource.rb → catalog_category_create_query_resource_object.rb} +27 -52
  57. data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_as_sub_resource_attributes.rb → catalog_category_create_query_resource_object_attributes.rb} +20 -20
  58. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
  59. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +238 -0
  60. data/lib/klaviyo-api-sdk/models/{catalog_category_delete_job_create_query_as_sub_resource_attributes.rb → catalog_category_delete_job_create_query_resource_object_attributes.rb} +5 -5
  61. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +239 -0
  62. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +36 -0
  63. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  64. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
  65. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +238 -0
  66. data/lib/klaviyo-api-sdk/models/{catalog_category_update_job_create_query_as_sub_resource_attributes.rb → catalog_category_update_job_create_query_resource_object_attributes.rb} +5 -5
  67. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
  68. data/lib/klaviyo-api-sdk/models/{tag_create_query_as_sub_resource.rb → catalog_category_update_query_resource_object.rb} +37 -47
  69. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_as_sub_resource_attributes.rb → catalog_category_update_query_resource_object_attributes.rb} +4 -4
  70. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships.rb → catalog_category_update_query_resource_object_relationships.rb} +5 -5
  71. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships_categories.rb → catalog_category_update_query_resource_object_relationships_items.rb} +5 -5
  72. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +6 -6
  73. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +36 -0
  74. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +36 -0
  75. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +36 -0
  76. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  77. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb → catalog_item_category_op_data_inner.rb} +6 -6
  78. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
  79. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +238 -0
  80. data/lib/klaviyo-api-sdk/models/{catalog_item_create_job_create_query_as_sub_resource_attributes.rb → catalog_item_create_job_create_query_resource_object_attributes.rb} +5 -5
  81. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
  82. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +247 -0
  83. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_attributes.rb → catalog_item_create_query_resource_object_attributes.rb} +74 -74
  84. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships.rb → catalog_item_create_query_resource_object_relationships.rb} +5 -5
  85. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships_items.rb → catalog_item_create_query_resource_object_relationships_categories.rb} +5 -5
  86. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
  87. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +238 -0
  88. data/lib/klaviyo-api-sdk/models/{catalog_item_delete_job_create_query_as_sub_resource_attributes.rb → catalog_item_delete_job_create_query_resource_object_attributes.rb} +5 -5
  89. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +239 -0
  90. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +36 -0
  91. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
  92. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +238 -0
  93. data/lib/klaviyo-api-sdk/models/{catalog_item_update_job_create_query_as_sub_resource_attributes.rb → catalog_item_update_job_create_query_resource_object_attributes.rb} +5 -5
  94. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
  95. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +262 -0
  96. data/lib/klaviyo-api-sdk/models/{catalog_item_update_query_as_sub_resource_attributes.rb → catalog_item_update_query_resource_object_attributes.rb} +46 -46
  97. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +36 -0
  98. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +36 -0
  99. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +36 -0
  100. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
  101. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +238 -0
  102. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_job_create_query_as_sub_resource_attributes.rb → catalog_variant_create_job_create_query_resource_object_attributes.rb} +5 -5
  103. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
  104. data/lib/klaviyo-api-sdk/models/{event_create_query_as_sub_resource.rb → catalog_variant_create_query_resource_object.rb} +27 -52
  105. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_attributes.rb → catalog_variant_create_query_resource_object_attributes.rb} +117 -117
  106. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
  107. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +238 -0
  108. data/lib/klaviyo-api-sdk/models/{catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb → catalog_variant_delete_job_create_query_resource_object_attributes.rb} +5 -5
  109. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +239 -0
  110. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +36 -0
  111. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
  112. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +238 -0
  113. data/lib/klaviyo-api-sdk/models/{catalog_variant_update_job_create_query_as_sub_resource_attributes.rb → catalog_variant_update_job_create_query_resource_object_attributes.rb} +5 -5
  114. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
  115. data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_as_sub_resource.rb → catalog_variant_update_query_resource_object.rb} +29 -48
  116. data/lib/klaviyo-api-sdk/models/{catalog_variant_update_query_as_sub_resource_attributes.rb → catalog_variant_update_query_resource_object_attributes.rb} +63 -53
  117. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +30 -30
  118. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +2 -2
  119. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +238 -0
  120. data/lib/klaviyo-api-sdk/models/{data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb → data_privacy_create_deletion_job_query_resource_object_attributes.rb} +18 -18
  121. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +36 -0
  122. data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
  123. data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +238 -0
  124. data/lib/klaviyo-api-sdk/models/{event_create_query_as_sub_resource_attributes.rb → event_create_query_resource_object_attributes.rb} +19 -19
  125. data/lib/klaviyo-api-sdk/models/event_enum.rb +36 -0
  126. data/lib/klaviyo-api-sdk/models/flow_enum.rb +36 -0
  127. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
  128. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +253 -0
  129. data/lib/klaviyo-api-sdk/models/{flow_update_query_as_sub_resource_attributes.rb → flow_update_query_resource_object_attributes.rb} +5 -4
  130. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
  131. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
  132. data/lib/klaviyo-api-sdk/models/{get_catalog_items4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
  133. data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
  134. data/lib/klaviyo-api-sdk/models/{sms_message_content.rb → list_create_query_resource_object.rb} +23 -23
  135. data/lib/klaviyo-api-sdk/models/{segment_partial_update_query_as_sub_resource_attributes.rb → list_create_query_resource_object_attributes.rb} +5 -4
  136. data/lib/klaviyo-api-sdk/models/list_enum.rb +36 -0
  137. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
  141. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +253 -0
  142. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +36 -0
  143. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
  144. data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource.rb → metric_aggregate_query_resource_object.rb} +30 -13
  145. data/lib/klaviyo-api-sdk/models/{metric_aggregate_query_as_sub_resource_attributes.rb → metric_aggregate_query_resource_object_attributes.rb} +70 -70
  146. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
  148. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +238 -0
  149. data/lib/klaviyo-api-sdk/models/{included_profiles_attributes.rb → profile_create_query_resource_object_attributes.rb} +36 -75
  150. data/lib/klaviyo-api-sdk/models/profile_enum.rb +36 -0
  151. data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
  152. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
  155. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +253 -0
  156. data/lib/klaviyo-api-sdk/models/{profile_create_query_as_sub_resource_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +48 -48
  157. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +36 -0
  158. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +36 -0
  159. data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +36 -0
  160. data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +36 -0
  161. data/lib/klaviyo-api-sdk/models/segment_enum.rb +36 -0
  162. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
  163. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +252 -0
  164. data/lib/klaviyo-api-sdk/models/{tag_update_query_as_sub_resource_attributes.rb → segment_partial_update_query_resource_object_attributes.rb} +4 -5
  165. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
  167. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
  168. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/subscription.rb +15 -15
  170. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
  171. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +238 -0
  173. data/lib/klaviyo-api-sdk/models/{subscription_create_job_create_query_as_sub_resource_attributes.rb → subscription_create_job_create_query_resource_object_attributes.rb} +26 -26
  174. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
  176. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +238 -0
  177. data/lib/klaviyo-api-sdk/models/{suppression_create_job_create_query_as_sub_resource_attributes.rb → suppression_create_job_create_query_resource_object_attributes.rb} +4 -4
  178. data/lib/klaviyo-api-sdk/models/{campaign_tag_op.rb → tag_campaign_op.rb} +5 -5
  179. data/lib/klaviyo-api-sdk/models/{campaign_tag_op_data_inner.rb → tag_campaign_op_data_inner.rb} +6 -6
  180. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +2 -2
  181. data/lib/klaviyo-api-sdk/models/{utm_param_info.rb → tag_create_query_resource_object.rb} +23 -23
  182. data/lib/klaviyo-api-sdk/models/{tag_create_query_as_sub_resource_attributes.rb → tag_create_query_resource_object_attributes.rb} +18 -18
  183. data/lib/klaviyo-api-sdk/models/tag_enum.rb +36 -0
  184. data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query.rb → tag_flow_op.rb} +8 -6
  185. data/lib/klaviyo-api-sdk/models/{catalog_item_delete_query_as_sub_resource.rb → tag_flow_op_data_inner.rb} +6 -7
  186. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +2 -2
  187. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +238 -0
  188. data/lib/klaviyo-api-sdk/models/{tag_group_create_query_as_sub_resource_attributes.rb → tag_group_create_query_resource_object_attributes.rb} +17 -17
  189. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +36 -0
  190. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +2 -2
  191. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +253 -0
  192. data/lib/klaviyo-api-sdk/models/{tag_group_update_query_as_sub_resource_attributes.rb → tag_group_update_query_resource_object_attributes.rb} +17 -17
  193. data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query.rb → tag_list_op.rb} +8 -6
  194. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +272 -0
  195. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +2 -2
  198. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +253 -0
  199. data/lib/klaviyo-api-sdk/models/{list_create_query_as_sub_resource_attributes.rb → tag_update_query_resource_object_attributes.rb} +5 -5
  200. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
  201. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +238 -0
  202. data/lib/klaviyo-api-sdk/models/{template_clone_query_as_sub_resource_attributes.rb → template_clone_query_resource_object_attributes.rb} +20 -20
  203. data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
  204. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +238 -0
  205. data/lib/klaviyo-api-sdk/models/{template_create_query_as_sub_resource_attributes.rb → template_create_query_resource_object_attributes.rb} +35 -35
  206. data/lib/klaviyo-api-sdk/models/template_enum.rb +36 -0
  207. data/lib/klaviyo-api-sdk/models/template_render_query.rb +2 -2
  208. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +238 -0
  209. data/lib/klaviyo-api-sdk/models/{template_render_query_as_sub_resource_attributes.rb → template_render_query_resource_object_attributes.rb} +20 -20
  210. data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
  211. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +253 -0
  212. data/lib/klaviyo-api-sdk/models/{template_update_query_as_sub_resource_attributes.rb → template_update_query_resource_object_attributes.rb} +19 -19
  213. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
  214. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +15 -15
  215. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
  216. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +238 -0
  217. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_as_sub_resource_attributes.rb → unsubscription_create_job_create_query_resource_object_attributes.rb} +21 -21
  218. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
  219. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +238 -0
  220. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_as_sub_resource_attributes.rb → unsuppression_create_job_create_query_resource_object_attributes.rb} +4 -4
  221. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  222. data/lib/klaviyo-api-sdk/version.rb +1 -1
  223. data/lib/klaviyo-api-sdk.rb +137 -143
  224. metadata +139 -609
  225. data/Gemfile +0 -9
  226. data/Rakefile +0 -10
  227. data/docs/AudiencesSubObject.md +0 -20
  228. data/docs/CampaignCloneQuery.md +0 -18
  229. data/docs/CampaignCloneQueryAsSubResource.md +0 -20
  230. data/docs/CampaignCloneQueryAsSubResourceAttributes.md +0 -20
  231. data/docs/CampaignCreateQuery.md +0 -18
  232. data/docs/CampaignCreateQueryAsSubResource.md +0 -20
  233. data/docs/CampaignCreateQueryAsSubResourceAttributes.md +0 -28
  234. data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
  235. data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +0 -20
  236. data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +0 -20
  237. data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
  238. data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +0 -22
  239. data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +0 -20
  240. data/docs/CampaignPartialUpdateQuery.md +0 -18
  241. data/docs/CampaignPartialUpdateQueryAsSubResource.md +0 -22
  242. data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +0 -26
  243. data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
  244. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +0 -20
  245. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +0 -18
  246. data/docs/CampaignSendJobCreateQuery.md +0 -18
  247. data/docs/CampaignSendJobCreateQueryAsSubResource.md +0 -20
  248. data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +0 -18
  249. data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
  250. data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +0 -22
  251. data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +0 -18
  252. data/docs/CampaignTagOp.md +0 -18
  253. data/docs/CampaignTagOpDataInner.md +0 -20
  254. data/docs/CampaignsApi.md +0 -1277
  255. data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
  256. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +0 -20
  257. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  258. data/docs/CatalogCategoryCreateQuery.md +0 -18
  259. data/docs/CatalogCategoryCreateQueryAsSubResource.md +0 -22
  260. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +0 -24
  261. data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
  262. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +0 -20
  263. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  264. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +0 -20
  265. data/docs/CatalogCategoryItemOp.md +0 -18
  266. data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
  267. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +0 -20
  268. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  269. data/docs/CatalogCategoryUpdateQuery.md +0 -18
  270. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +0 -24
  271. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +0 -18
  272. data/docs/CatalogItemCategoryOp.md +0 -18
  273. data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
  274. data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +0 -20
  275. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  276. data/docs/CatalogItemCreateQuery.md +0 -18
  277. data/docs/CatalogItemCreateQueryAsSubResource.md +0 -22
  278. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +0 -40
  279. data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +0 -18
  280. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +0 -18
  281. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +0 -20
  282. data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
  283. data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +0 -20
  284. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  285. data/docs/CatalogItemDeleteQueryAsSubResource.md +0 -20
  286. data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
  287. data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +0 -20
  288. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  289. data/docs/CatalogItemUpdateQuery.md +0 -18
  290. data/docs/CatalogItemUpdateQueryAsSubResource.md +0 -24
  291. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +0 -34
  292. data/docs/CatalogJobErrorPayload.md +0 -26
  293. data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
  294. data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +0 -20
  295. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  296. data/docs/CatalogVariantCreateQuery.md +0 -18
  297. data/docs/CatalogVariantCreateQueryAsSubResource.md +0 -22
  298. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +0 -46
  299. data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +0 -18
  300. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +0 -18
  301. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +0 -20
  302. data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
  303. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +0 -20
  304. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  305. data/docs/CatalogVariantDeleteQueryAsSubResource.md +0 -20
  306. data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
  307. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +0 -20
  308. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  309. data/docs/CatalogVariantUpdateQuery.md +0 -18
  310. data/docs/CatalogVariantUpdateQueryAsSubResource.md +0 -22
  311. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +0 -38
  312. data/docs/CatalogsApi.md +0 -4048
  313. data/docs/ClientApi.md +0 -205
  314. data/docs/ContentSubObject.md +0 -28
  315. data/docs/DataPrivacyApi.md +0 -78
  316. data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
  317. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +0 -20
  318. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +0 -22
  319. data/docs/EmailMessageContent.md +0 -24
  320. data/docs/EmailTrackingOptions.md +0 -24
  321. data/docs/ErrorSource.md +0 -18
  322. data/docs/EventCreateQuery.md +0 -18
  323. data/docs/EventCreateQueryAsSubResource.md +0 -20
  324. data/docs/EventCreateQueryAsSubResourceAttributes.md +0 -28
  325. data/docs/EventsApi.md +0 -472
  326. data/docs/FlowUpdateQuery.md +0 -18
  327. data/docs/FlowUpdateQueryAsSubResource.md +0 -22
  328. data/docs/FlowUpdateQueryAsSubResourceAttributes.md +0 -18
  329. data/docs/FlowsApi.md +0 -1029
  330. data/docs/GetCampaigns4XXResponse.md +0 -18
  331. data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
  332. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
  333. data/docs/GetCatalogItems4XXResponse.md +0 -18
  334. data/docs/GetCatalogItems4XXResponseErrorsInner.md +0 -26
  335. data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +0 -20
  336. data/docs/IncludedCategories.md +0 -24
  337. data/docs/IncludedCategoriesAttributes.md +0 -22
  338. data/docs/IncludedFlowAction.md +0 -24
  339. data/docs/IncludedFlowActions.md +0 -24
  340. data/docs/IncludedFlowActionsAttributes.md +0 -32
  341. data/docs/IncludedFlowActionsAttributesTrackingOptions.md +0 -49
  342. data/docs/IncludedFlowMessages.md +0 -24
  343. data/docs/IncludedFlowMessagesAttributes.md +0 -26
  344. data/docs/IncludedFlowMessagesAttributesContent.md +0 -49
  345. data/docs/IncludedFlows.md +0 -24
  346. data/docs/IncludedFlowsAttributes.md +0 -28
  347. data/docs/IncludedItems.md +0 -24
  348. data/docs/IncludedItemsAttributes.md +0 -40
  349. data/docs/IncludedLists.md +0 -24
  350. data/docs/IncludedListsAttributes.md +0 -22
  351. data/docs/IncludedMetrics.md +0 -24
  352. data/docs/IncludedMetricsAttributes.md +0 -24
  353. data/docs/IncludedProfiles.md +0 -24
  354. data/docs/IncludedProfilesAttributes.md +0 -44
  355. data/docs/IncludedSegments.md +0 -24
  356. data/docs/IncludedSegmentsAttributes.md +0 -22
  357. data/docs/IncludedTags.md +0 -24
  358. data/docs/IncludedVariants.md +0 -24
  359. data/docs/IncludedVariantsAttributes.md +0 -46
  360. data/docs/IncludedVariantsLinks.md +0 -18
  361. data/docs/ListCreateQuery.md +0 -18
  362. data/docs/ListCreateQueryAsSubResource.md +0 -20
  363. data/docs/ListCreateQueryAsSubResourceAttributes.md +0 -18
  364. data/docs/ListMembersAddQuery.md +0 -18
  365. data/docs/ListMembersAddQueryDataInner.md +0 -20
  366. data/docs/ListMembersDeleteQuery.md +0 -18
  367. data/docs/ListPartialUpdateQuery.md +0 -18
  368. data/docs/ListPartialUpdateQueryAsSubResource.md +0 -22
  369. data/docs/ListsApi.md +0 -762
  370. data/docs/MetricAggregateQuery.md +0 -18
  371. data/docs/MetricAggregateQueryAsSubResource.md +0 -20
  372. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +0 -36
  373. data/docs/MetricAggregateRowDTO.md +0 -20
  374. data/docs/MetricCreateQuery.md +0 -20
  375. data/docs/MetricsApi.md +0 -233
  376. data/docs/OnsiteProfileCreateQuery.md +0 -18
  377. data/docs/OnsiteProfileCreateQueryAsSubResource.md +0 -22
  378. data/docs/OnsiteProfileMeta.md +0 -18
  379. data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
  380. data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
  381. data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +0 -20
  382. data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +0 -26
  383. data/docs/ProfileCreateQuery.md +0 -18
  384. data/docs/ProfileCreateQueryAsSubResource.md +0 -20
  385. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +0 -38
  386. data/docs/ProfileLocation.md +0 -34
  387. data/docs/ProfileLocationLatitude.md +0 -49
  388. data/docs/ProfileLocationLongitude.md +0 -49
  389. data/docs/ProfilePartialUpdateQuery.md +0 -18
  390. data/docs/ProfilePartialUpdateQueryAsSubResource.md +0 -22
  391. data/docs/ProfilesApi.md +0 -825
  392. data/docs/SMSMessageContent.md +0 -20
  393. data/docs/SMSRenderOptions.md +0 -24
  394. data/docs/SMSTrackingOptions.md +0 -20
  395. data/docs/STOScheduleOptions.md +0 -18
  396. data/docs/SegmentPartialUpdateQuery.md +0 -18
  397. data/docs/SegmentPartialUpdateQueryAsSubResource.md +0 -22
  398. data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +0 -18
  399. data/docs/SegmentsApi.md +0 -469
  400. data/docs/SendOptions.md +0 -20
  401. data/docs/SendOptionsSubObject.md +0 -18
  402. data/docs/SendStrategySubObject.md +0 -24
  403. data/docs/SendTimeSubObject.md +0 -20
  404. data/docs/StaticScheduleOptions.md +0 -22
  405. data/docs/Subscription.md +0 -24
  406. data/docs/SubscriptionChannels.md +0 -20
  407. data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
  408. data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
  409. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
  410. data/docs/Suppression.md +0 -18
  411. data/docs/SuppressionCreateJobCreateQuery.md +0 -18
  412. data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +0 -20
  413. data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  414. data/docs/TagCreateQuery.md +0 -18
  415. data/docs/TagCreateQueryAsSubResource.md +0 -20
  416. data/docs/TagCreateQueryAsSubResourceAttributes.md +0 -20
  417. data/docs/TagGroupCreateQuery.md +0 -18
  418. data/docs/TagGroupCreateQueryAsSubResource.md +0 -20
  419. data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +0 -20
  420. data/docs/TagGroupUpdateQuery.md +0 -18
  421. data/docs/TagGroupUpdateQueryAsSubResource.md +0 -22
  422. data/docs/TagGroupUpdateQueryAsSubResourceAttributes.md +0 -20
  423. data/docs/TagSegmentOp.md +0 -18
  424. data/docs/TagSegmentOpDataInner.md +0 -20
  425. data/docs/TagUpdateQuery.md +0 -18
  426. data/docs/TagUpdateQueryAsSubResource.md +0 -22
  427. data/docs/TagUpdateQueryAsSubResourceAttributes.md +0 -18
  428. data/docs/TagsApi.md +0 -1205
  429. data/docs/TemplateCloneQuery.md +0 -18
  430. data/docs/TemplateCloneQueryAsSubResource.md +0 -20
  431. data/docs/TemplateCloneQueryAsSubResourceAttributes.md +0 -22
  432. data/docs/TemplateCreateQuery.md +0 -18
  433. data/docs/TemplateCreateQueryAsSubResource.md +0 -20
  434. data/docs/TemplateCreateQueryAsSubResourceAttributes.md +0 -32
  435. data/docs/TemplateRenderQuery.md +0 -18
  436. data/docs/TemplateRenderQueryAsSubResource.md +0 -20
  437. data/docs/TemplateRenderQueryAsSubResourceAttributes.md +0 -22
  438. data/docs/TemplateUpdateQuery.md +0 -18
  439. data/docs/TemplateUpdateQueryAsSubResource.md +0 -22
  440. data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +0 -30
  441. data/docs/TemplatesApi.md +0 -525
  442. data/docs/ThrottledScheduleOptions.md +0 -20
  443. data/docs/TrackingOptionsSubObject.md +0 -24
  444. data/docs/UTMParamsSubObject.md +0 -20
  445. data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
  446. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
  447. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
  448. data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
  449. data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +0 -20
  450. data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  451. data/docs/UtmParamInfo.md +0 -20
  452. data/docs/V2TemplateRenderQueryAsSubResource.md +0 -18
  453. data/git_push.sh +0 -57
  454. data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
  455. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +0 -272
  456. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +0 -272
  457. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +0 -272
  458. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +0 -287
  459. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +0 -287
  460. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +0 -272
  461. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +0 -287
  462. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +0 -272
  463. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +0 -281
  464. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +0 -272
  465. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +0 -273
  466. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +0 -272
  467. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +0 -296
  468. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +0 -272
  469. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +0 -281
  470. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +0 -272
  471. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +0 -272
  472. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +0 -296
  473. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
  474. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +0 -272
  475. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +0 -281
  476. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +0 -272
  477. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +0 -273
  478. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +0 -272
  479. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +0 -287
  480. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +0 -272
  481. data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
  482. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
  483. data/lib/klaviyo-api-sdk/models/error_source.rb +0 -227
  484. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +0 -286
  485. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +0 -226
  486. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +0 -275
  487. data/lib/klaviyo-api-sdk/models/included_categories.rb +0 -301
  488. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +0 -240
  489. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +0 -300
  490. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +0 -300
  491. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +0 -282
  492. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +0 -105
  493. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +0 -300
  494. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +0 -270
  495. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +0 -105
  496. data/lib/klaviyo-api-sdk/models/included_flows.rb +0 -300
  497. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +0 -264
  498. data/lib/klaviyo-api-sdk/models/included_items.rb +0 -301
  499. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -332
  500. data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -301
  501. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -240
  502. data/lib/klaviyo-api-sdk/models/included_metrics.rb +0 -301
  503. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +0 -250
  504. data/lib/klaviyo-api-sdk/models/included_profiles.rb +0 -301
  505. data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
  506. data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +0 -240
  507. data/lib/klaviyo-api-sdk/models/included_tags.rb +0 -301
  508. data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -301
  509. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -396
  510. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +0 -224
  511. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -287
  512. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +0 -272
  513. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
  514. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +0 -281
  515. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -224
  516. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +0 -269
  517. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +0 -272
  518. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +0 -265
  519. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +0 -272
  520. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -287
  521. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
  522. data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
  523. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
  524. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +0 -266
  525. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +0 -240
  526. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +0 -272
  527. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +0 -272
  528. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +0 -272
  529. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +0 -287
  530. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +0 -287
  531. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +0 -272
  532. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +0 -272
  533. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +0 -272
  534. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +0 -287
  535. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +0 -272
  536. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +0 -272
  537. data/spec/api/campaigns_api_spec.rb +0 -284
  538. data/spec/api/catalogs_api_spec.rb +0 -759
  539. data/spec/api/client_api_spec.rb +0 -74
  540. data/spec/api/data_privacy_api_spec.rb +0 -47
  541. data/spec/api/events_api_spec.rb +0 -120
  542. data/spec/api/flows_api_spec.rb +0 -220
  543. data/spec/api/lists_api_spec.rb +0 -169
  544. data/spec/api/metrics_api_spec.rb +0 -74
  545. data/spec/api/profiles_api_spec.rb +0 -178
  546. data/spec/api/segments_api_spec.rb +0 -117
  547. data/spec/api/tags_api_spec.rb +0 -245
  548. data/spec/api/templates_api_spec.rb +0 -126
  549. data/spec/api_client_spec.rb +0 -226
  550. data/spec/configuration_spec.rb +0 -42
  551. data/spec/models/audiences_sub_object_spec.rb +0 -40
  552. data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +0 -40
  553. data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +0 -44
  554. data/spec/models/campaign_clone_query_spec.rb +0 -34
  555. data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +0 -64
  556. data/spec/models/campaign_create_query_as_sub_resource_spec.rb +0 -44
  557. data/spec/models/campaign_create_query_spec.rb +0 -34
  558. data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +0 -40
  559. data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +0 -44
  560. data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
  561. data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +0 -40
  562. data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +0 -50
  563. data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
  564. data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +0 -58
  565. data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +0 -50
  566. data/spec/models/campaign_partial_update_query_spec.rb +0 -34
  567. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  568. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +0 -44
  569. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
  570. data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  571. data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +0 -44
  572. data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
  573. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
  574. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +0 -50
  575. data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
  576. data/spec/models/campaign_tag_op_data_inner_spec.rb +0 -44
  577. data/spec/models/campaign_tag_op_spec.rb +0 -34
  578. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  579. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +0 -44
  580. data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
  581. data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +0 -56
  582. data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +0 -50
  583. data/spec/models/catalog_category_create_query_spec.rb +0 -34
  584. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  585. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  586. data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
  587. data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +0 -44
  588. data/spec/models/catalog_category_item_op_spec.rb +0 -34
  589. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  590. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +0 -44
  591. data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
  592. data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +0 -34
  593. data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +0 -56
  594. data/spec/models/catalog_category_update_query_spec.rb +0 -34
  595. data/spec/models/catalog_item_category_op_spec.rb +0 -34
  596. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  597. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +0 -44
  598. data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
  599. data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +0 -98
  600. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +0 -44
  601. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +0 -34
  602. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +0 -34
  603. data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +0 -50
  604. data/spec/models/catalog_item_create_query_spec.rb +0 -34
  605. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  606. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  607. data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
  608. data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +0 -44
  609. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  610. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +0 -44
  611. data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
  612. data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +0 -76
  613. data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +0 -56
  614. data/spec/models/catalog_item_update_query_spec.rb +0 -34
  615. data/spec/models/catalog_job_error_payload_spec.rb +0 -58
  616. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  617. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +0 -44
  618. data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
  619. data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +0 -126
  620. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +0 -44
  621. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +0 -34
  622. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +0 -34
  623. data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +0 -50
  624. data/spec/models/catalog_variant_create_query_spec.rb +0 -34
  625. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  626. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  627. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
  628. data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +0 -44
  629. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  630. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +0 -44
  631. data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
  632. data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +0 -98
  633. data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +0 -50
  634. data/spec/models/catalog_variant_update_query_spec.rb +0 -34
  635. data/spec/models/content_sub_object_spec.rb +0 -64
  636. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +0 -46
  637. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +0 -44
  638. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
  639. data/spec/models/email_message_content_spec.rb +0 -52
  640. data/spec/models/email_tracking_options_spec.rb +0 -52
  641. data/spec/models/error_source_spec.rb +0 -34
  642. data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +0 -64
  643. data/spec/models/event_create_query_as_sub_resource_spec.rb +0 -44
  644. data/spec/models/event_create_query_spec.rb +0 -34
  645. data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +0 -34
  646. data/spec/models/flow_update_query_as_sub_resource_spec.rb +0 -50
  647. data/spec/models/flow_update_query_spec.rb +0 -34
  648. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
  649. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
  650. data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
  651. data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +0 -40
  652. data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +0 -58
  653. data/spec/models/get_catalog_items4_xx_response_spec.rb +0 -34
  654. data/spec/models/included_categories_attributes_spec.rb +0 -46
  655. data/spec/models/included_categories_spec.rb +0 -56
  656. data/spec/models/included_flow_action_spec.rb +0 -56
  657. data/spec/models/included_flow_actions_attributes_spec.rb +0 -76
  658. data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +0 -31
  659. data/spec/models/included_flow_actions_spec.rb +0 -56
  660. data/spec/models/included_flow_messages_attributes_content_spec.rb +0 -31
  661. data/spec/models/included_flow_messages_attributes_spec.rb +0 -58
  662. data/spec/models/included_flow_messages_spec.rb +0 -56
  663. data/spec/models/included_flows_attributes_spec.rb +0 -64
  664. data/spec/models/included_flows_spec.rb +0 -56
  665. data/spec/models/included_items_attributes_spec.rb +0 -94
  666. data/spec/models/included_items_spec.rb +0 -56
  667. data/spec/models/included_lists_attributes_spec.rb +0 -46
  668. data/spec/models/included_lists_spec.rb +0 -56
  669. data/spec/models/included_metrics_attributes_spec.rb +0 -52
  670. data/spec/models/included_metrics_spec.rb +0 -56
  671. data/spec/models/included_profiles_attributes_spec.rb +0 -112
  672. data/spec/models/included_profiles_spec.rb +0 -56
  673. data/spec/models/included_segments_attributes_spec.rb +0 -46
  674. data/spec/models/included_segments_spec.rb +0 -56
  675. data/spec/models/included_tags_spec.rb +0 -56
  676. data/spec/models/included_variants_attributes_spec.rb +0 -122
  677. data/spec/models/included_variants_links_spec.rb +0 -34
  678. data/spec/models/included_variants_spec.rb +0 -56
  679. data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +0 -34
  680. data/spec/models/list_create_query_as_sub_resource_spec.rb +0 -44
  681. data/spec/models/list_create_query_spec.rb +0 -34
  682. data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
  683. data/spec/models/list_members_add_query_spec.rb +0 -34
  684. data/spec/models/list_members_delete_query_spec.rb +0 -34
  685. data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +0 -50
  686. data/spec/models/list_partial_update_query_spec.rb +0 -34
  687. data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +0 -104
  688. data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +0 -44
  689. data/spec/models/metric_aggregate_query_spec.rb +0 -34
  690. data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
  691. data/spec/models/metric_create_query_spec.rb +0 -40
  692. data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +0 -50
  693. data/spec/models/onsite_profile_create_query_spec.rb +0 -34
  694. data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
  695. data/spec/models/onsite_profile_meta_spec.rb +0 -34
  696. data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +0 -58
  697. data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +0 -44
  698. data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
  699. data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +0 -94
  700. data/spec/models/profile_create_query_as_sub_resource_spec.rb +0 -44
  701. data/spec/models/profile_create_query_spec.rb +0 -34
  702. data/spec/models/profile_location_latitude_spec.rb +0 -31
  703. data/spec/models/profile_location_longitude_spec.rb +0 -31
  704. data/spec/models/profile_location_spec.rb +0 -82
  705. data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +0 -50
  706. data/spec/models/profile_partial_update_query_spec.rb +0 -34
  707. data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
  708. data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +0 -50
  709. data/spec/models/segment_partial_update_query_spec.rb +0 -34
  710. data/spec/models/send_options_spec.rb +0 -40
  711. data/spec/models/send_options_sub_object_spec.rb +0 -40
  712. data/spec/models/send_strategy_sub_object_spec.rb +0 -46
  713. data/spec/models/send_time_sub_object_spec.rb +0 -40
  714. data/spec/models/sms_message_content_spec.rb +0 -40
  715. data/spec/models/sms_render_options_spec.rb +0 -52
  716. data/spec/models/sms_tracking_options_spec.rb +0 -40
  717. data/spec/models/static_schedule_options_spec.rb +0 -46
  718. data/spec/models/sto_schedule_options_spec.rb +0 -34
  719. data/spec/models/subscription_channels_spec.rb +0 -48
  720. data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
  721. data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
  722. data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
  723. data/spec/models/subscription_spec.rb +0 -40
  724. data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  725. data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
  726. data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
  727. data/spec/models/suppression_spec.rb +0 -34
  728. data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +0 -40
  729. data/spec/models/tag_create_query_as_sub_resource_spec.rb +0 -44
  730. data/spec/models/tag_create_query_spec.rb +0 -34
  731. data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +0 -40
  732. data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +0 -44
  733. data/spec/models/tag_group_create_query_spec.rb +0 -34
  734. data/spec/models/tag_group_update_query_as_sub_resource_attributes_spec.rb +0 -40
  735. data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +0 -50
  736. data/spec/models/tag_group_update_query_spec.rb +0 -34
  737. data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
  738. data/spec/models/tag_segment_op_spec.rb +0 -34
  739. data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +0 -34
  740. data/spec/models/tag_update_query_as_sub_resource_spec.rb +0 -50
  741. data/spec/models/tag_update_query_spec.rb +0 -34
  742. data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +0 -46
  743. data/spec/models/template_clone_query_as_sub_resource_spec.rb +0 -50
  744. data/spec/models/template_clone_query_spec.rb +0 -34
  745. data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +0 -58
  746. data/spec/models/template_create_query_as_sub_resource_spec.rb +0 -44
  747. data/spec/models/template_create_query_spec.rb +0 -34
  748. data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +0 -46
  749. data/spec/models/template_render_query_as_sub_resource_spec.rb +0 -44
  750. data/spec/models/template_render_query_spec.rb +0 -34
  751. data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +0 -52
  752. data/spec/models/template_update_query_as_sub_resource_spec.rb +0 -50
  753. data/spec/models/template_update_query_spec.rb +0 -34
  754. data/spec/models/throttled_schedule_options_spec.rb +0 -40
  755. data/spec/models/tracking_options_sub_object_spec.rb +0 -52
  756. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
  757. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
  758. data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
  759. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  760. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
  761. data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
  762. data/spec/models/utm_param_info_spec.rb +0 -40
  763. data/spec/models/utm_params_sub_object_spec.rb +0 -40
  764. data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +0 -34
  765. data/spec/spec_helper.rb +0 -111
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2023-02-22
6
+ The version of the OpenAPI document: 2023-06-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -20,7 +20,7 @@ module KlaviyoAPI
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create Profile
23
- # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
23
+ # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
24
24
  # @param profile_create_query [ProfileCreateQuery]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [Hash<String, Object>]
@@ -30,7 +30,7 @@ module KlaviyoAPI
30
30
  end
31
31
 
32
32
  # Create Profile
33
- # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you&#39;ll need to include at least one other identifier attribute (&#x60;email&#x60; or &#x60;external_id&#x60;) in addition to the &#x60;phone_number&#x60; attribute for the API call to work.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Write&#x60;
33
+ # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you&#39;ll need to include at least one other identifier attribute (&#x60;email&#x60; or &#x60;external_id&#x60;) in addition to the &#x60;phone_number&#x60; attribute for the API call to work.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60;
34
34
  # @param profile_create_query [ProfileCreateQuery]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -51,7 +51,7 @@ module KlaviyoAPI
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # klaviyo api revision
54
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
54
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
55
55
  # HTTP header 'Accept' (if needed)
56
56
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
57
  # HTTP header 'Content-Type'
@@ -90,13 +90,14 @@ module KlaviyoAPI
90
90
  end
91
91
 
92
92
  # Get Profile
93
- # Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read`
93
+ # Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: `lists` memberships, `segments` memberships\"<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
94
94
  # @param id [String]
95
95
  # @param [Hash] opts the optional parameters
96
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
97
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
98
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
99
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
96
+ # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
97
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
98
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
99
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
100
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
100
101
  # @return [Hash<String, Object>]
101
102
  def get_profile(id, opts = {})
102
103
  data, _status_code, _headers = get_profile_with_http_info(id, opts)
@@ -104,13 +105,14 @@ module KlaviyoAPI
104
105
  end
105
106
 
106
107
  # Get Profile
107
- # Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: &#x60;lists&#x60; memberships, &#x60;segments&#x60; memberships\&quot;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Profiles Read&#x60;
108
+ # Get the profile with the given profile ID. Include parameters can be provided to get the following related resource data: &#x60;lists&#x60; memberships, &#x60;segments&#x60; memberships\&quot;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:read&#x60;
108
109
  # @param id [String]
109
110
  # @param [Hash] opts the optional parameters
110
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
111
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
112
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
113
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
111
+ # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
112
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
113
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
114
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
115
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
114
116
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
115
117
  def get_profile_with_http_info(id, opts = {})
116
118
  if @api_client.config.debugging
@@ -120,11 +122,15 @@ module KlaviyoAPI
120
122
  if @api_client.config.client_side_validation && id.nil?
121
123
  fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile"
122
124
  end
125
+ allowable_values = ["predictive_analytics"]
126
+ if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
127
+ fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
128
+ end
123
129
  allowable_values = ["name", "created", "updated"]
124
130
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
125
131
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
126
132
  end
127
- allowable_values = ["email", "phone_number", "external_id", "anonymous_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties"]
133
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
128
134
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
129
135
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
130
136
  end
@@ -141,6 +147,7 @@ module KlaviyoAPI
141
147
 
142
148
  # query parameters
143
149
  query_params = opts[:query_params] || {}
150
+ query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
144
151
  query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
145
152
  query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
146
153
  query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
@@ -149,7 +156,7 @@ module KlaviyoAPI
149
156
  # header parameters
150
157
  header_params = opts[:header_params] || {}
151
158
  # klaviyo api revision
152
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
159
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
153
160
  # HTTP header 'Accept' (if needed)
154
161
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
155
162
 
@@ -183,36 +190,36 @@ module KlaviyoAPI
183
190
  end
184
191
 
185
192
  # Get Profile Lists
186
- # 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`
187
- # @param profile_id [String]
193
+ # 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`
194
+ # @param id [String]
188
195
  # @param [Hash] opts the optional parameters
189
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
196
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
190
197
  # @return [Hash<String, Object>]
191
- def get_profile_lists(profile_id, opts = {})
192
- data, _status_code, _headers = get_profile_lists_with_http_info(profile_id, opts)
198
+ def get_profile_lists(id, opts = {})
199
+ data, _status_code, _headers = get_profile_lists_with_http_info(id, opts)
193
200
  data
194
201
  end
195
202
 
196
203
  # Get Profile Lists
197
- # Get list memberships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;List Read&#x60; &#x60;Profiles Read&#x60;
198
- # @param profile_id [String]
204
+ # Get list memberships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;list:read&#x60; &#x60;profiles:read&#x60;
205
+ # @param id [String]
199
206
  # @param [Hash] opts the optional parameters
200
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
207
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
201
208
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
202
- def get_profile_lists_with_http_info(profile_id, opts = {})
209
+ def get_profile_lists_with_http_info(id, opts = {})
203
210
  if @api_client.config.debugging
204
211
  @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_lists ...'
205
212
  end
206
- # verify the required parameter 'profile_id' is set
207
- if @api_client.config.client_side_validation && profile_id.nil?
208
- fail ArgumentError, "Missing the required parameter 'profile_id' when calling ProfilesApi.get_profile_lists"
213
+ # verify the required parameter 'id' is set
214
+ if @api_client.config.client_side_validation && id.nil?
215
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_lists"
209
216
  end
210
217
  allowable_values = ["name", "created", "updated"]
211
218
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
212
219
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
213
220
  end
214
221
  # resource path
215
- local_var_path = '/api/profiles/{profile_id}/lists/'.sub('{' + 'profile_id' + '}', CGI.escape(profile_id.to_s))
222
+ local_var_path = '/api/profiles/{id}/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
216
223
 
217
224
  # query parameters
218
225
  query_params = opts[:query_params] || {}
@@ -221,7 +228,7 @@ module KlaviyoAPI
221
228
  # header parameters
222
229
  header_params = opts[:header_params] || {}
223
230
  # klaviyo api revision
224
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
231
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
225
232
  # HTTP header 'Accept' (if needed)
226
233
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
227
234
 
@@ -254,42 +261,96 @@ module KlaviyoAPI
254
261
  return data, status_code, headers
255
262
  end
256
263
 
257
- # Get Profile Relationships
258
- # Get list membership or segment membership relationships 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` `Segments Read`
264
+ # Get Profile Relationships Lists
265
+ # 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`
259
266
  # @param id [String]
260
- # @param related_resource [String]
261
267
  # @param [Hash] opts the optional parameters
262
268
  # @return [Hash<String, Object>]
263
- def get_profile_relationships(id, related_resource, opts = {})
264
- data, _status_code, _headers = get_profile_relationships_with_http_info(id, related_resource, opts)
269
+ def get_profile_relationships_lists(id, opts = {})
270
+ data, _status_code, _headers = get_profile_relationships_lists_with_http_info(id, opts)
265
271
  data
266
272
  end
267
273
 
268
- # Get Profile Relationships
269
- # Get list membership or segment membership relationships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Lists Read&#x60; &#x60;Profiles Read&#x60; &#x60;Segments Read&#x60;
274
+ # Get Profile Relationships Lists
275
+ # Get list memberships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;list:read&#x60; &#x60;profiles:read&#x60;
270
276
  # @param id [String]
271
- # @param related_resource [String]
272
277
  # @param [Hash] opts the optional parameters
273
278
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
274
- def get_profile_relationships_with_http_info(id, related_resource, opts = {})
279
+ def get_profile_relationships_lists_with_http_info(id, opts = {})
275
280
  if @api_client.config.debugging
276
- @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_relationships ...'
281
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_relationships_lists ...'
277
282
  end
278
283
  # verify the required parameter 'id' is set
279
284
  if @api_client.config.client_side_validation && id.nil?
280
- fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_relationships"
285
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_relationships_lists"
281
286
  end
282
- # verify the required parameter 'related_resource' is set
283
- if @api_client.config.client_side_validation && related_resource.nil?
284
- fail ArgumentError, "Missing the required parameter 'related_resource' when calling ProfilesApi.get_profile_relationships"
287
+ # resource path
288
+ local_var_path = '/api/profiles/{id}/relationships/lists/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
289
+
290
+ # query parameters
291
+ query_params = opts[:query_params] || {}
292
+
293
+ # header parameters
294
+ header_params = opts[:header_params] || {}
295
+ # klaviyo api revision
296
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
297
+ # HTTP header 'Accept' (if needed)
298
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
299
+
300
+ # form parameters
301
+ form_params = opts[:form_params] || {}
302
+
303
+ # http body (model)
304
+ post_body = opts[:debug_body]
305
+
306
+ # return_type
307
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
308
+
309
+ # auth_names
310
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
311
+
312
+ new_options = opts.merge(
313
+ :operation => :"ProfilesApi.get_profile_relationships_lists",
314
+ :header_params => header_params,
315
+ :query_params => query_params,
316
+ :form_params => form_params,
317
+ :body => post_body,
318
+ :auth_names => auth_names,
319
+ :return_type => return_type
320
+ )
321
+
322
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
323
+ if @api_client.config.debugging
324
+ @api_client.config.logger.debug "API called: ProfilesApi#get_profile_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
285
325
  end
286
- # verify enum value
287
- allowable_values = ["lists", "segments"]
288
- if @api_client.config.client_side_validation && !allowable_values.include?(related_resource)
289
- fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
326
+ return data, status_code, headers
327
+ end
328
+
329
+ # Get Profile Relationships Segments
330
+ # Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
331
+ # @param id [String]
332
+ # @param [Hash] opts the optional parameters
333
+ # @return [Hash<String, Object>]
334
+ def get_profile_relationships_segments(id, opts = {})
335
+ data, _status_code, _headers = get_profile_relationships_segments_with_http_info(id, opts)
336
+ data
337
+ end
338
+
339
+ # Get Profile Relationships Segments
340
+ # Get segment membership relationships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;profiles:read&#x60; &#x60;segments:read&#x60;
341
+ # @param id [String]
342
+ # @param [Hash] opts the optional parameters
343
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
344
+ def get_profile_relationships_segments_with_http_info(id, opts = {})
345
+ if @api_client.config.debugging
346
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_relationships_segments ...'
347
+ end
348
+ # verify the required parameter 'id' is set
349
+ if @api_client.config.client_side_validation && id.nil?
350
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_relationships_segments"
290
351
  end
291
352
  # resource path
292
- local_var_path = '/api/profiles/{id}/relationships/{related_resource}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'related_resource' + '}', CGI.escape(related_resource.to_s))
353
+ local_var_path = '/api/profiles/{id}/relationships/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
293
354
 
294
355
  # query parameters
295
356
  query_params = opts[:query_params] || {}
@@ -297,7 +358,7 @@ module KlaviyoAPI
297
358
  # header parameters
298
359
  header_params = opts[:header_params] || {}
299
360
  # klaviyo api revision
300
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
361
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
301
362
  # HTTP header 'Accept' (if needed)
302
363
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
303
364
 
@@ -314,7 +375,7 @@ module KlaviyoAPI
314
375
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
315
376
 
316
377
  new_options = opts.merge(
317
- :operation => :"ProfilesApi.get_profile_relationships",
378
+ :operation => :"ProfilesApi.get_profile_relationships_segments",
318
379
  :header_params => header_params,
319
380
  :query_params => query_params,
320
381
  :form_params => form_params,
@@ -325,42 +386,42 @@ module KlaviyoAPI
325
386
 
326
387
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
327
388
  if @api_client.config.debugging
328
- @api_client.config.logger.debug "API called: ProfilesApi#get_profile_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
389
+ @api_client.config.logger.debug "API called: ProfilesApi#get_profile_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
329
390
  end
330
391
  return data, status_code, headers
331
392
  end
332
393
 
333
394
  # Get Profile Segments
334
- # Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read` `Segments Read`
335
- # @param profile_id [String]
395
+ # Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
396
+ # @param id [String]
336
397
  # @param [Hash] opts the optional parameters
337
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
398
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
338
399
  # @return [Hash<String, Object>]
339
- def get_profile_segments(profile_id, opts = {})
340
- data, _status_code, _headers = get_profile_segments_with_http_info(profile_id, opts)
400
+ def get_profile_segments(id, opts = {})
401
+ data, _status_code, _headers = get_profile_segments_with_http_info(id, opts)
341
402
  data
342
403
  end
343
404
 
344
405
  # Get Profile Segments
345
- # Get segment memberships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Profiles Read&#x60; &#x60;Segments Read&#x60;
346
- # @param profile_id [String]
406
+ # Get segment memberships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;profiles:read&#x60; &#x60;segments:read&#x60;
407
+ # @param id [String]
347
408
  # @param [Hash] opts the optional parameters
348
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
409
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
349
410
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
350
- def get_profile_segments_with_http_info(profile_id, opts = {})
411
+ def get_profile_segments_with_http_info(id, opts = {})
351
412
  if @api_client.config.debugging
352
413
  @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_segments ...'
353
414
  end
354
- # verify the required parameter 'profile_id' is set
355
- if @api_client.config.client_side_validation && profile_id.nil?
356
- fail ArgumentError, "Missing the required parameter 'profile_id' when calling ProfilesApi.get_profile_segments"
415
+ # verify the required parameter 'id' is set
416
+ if @api_client.config.client_side_validation && id.nil?
417
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_segments"
357
418
  end
358
419
  allowable_values = ["name", "created", "updated"]
359
420
  if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
360
421
  fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
361
422
  end
362
423
  # resource path
363
- local_var_path = '/api/profiles/{profile_id}/segments/'.sub('{' + 'profile_id' + '}', CGI.escape(profile_id.to_s))
424
+ local_var_path = '/api/profiles/{id}/segments/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
364
425
 
365
426
  # query parameters
366
427
  query_params = opts[:query_params] || {}
@@ -369,7 +430,7 @@ module KlaviyoAPI
369
430
  # header parameters
370
431
  header_params = opts[:header_params] || {}
371
432
  # klaviyo api revision
372
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
433
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
373
434
  # HTTP header 'Accept' (if needed)
374
435
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
375
436
 
@@ -403,12 +464,14 @@ module KlaviyoAPI
403
464
  end
404
465
 
405
466
  # Get Profiles
406
- # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `email` You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Profiles Read`
467
+ # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
407
468
  # @param [Hash] opts the optional parameters
408
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
409
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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;anonymous_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;
410
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
411
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
469
+ # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
470
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
471
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-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;
472
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
473
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
474
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
412
475
  # @return [Hash<String, Object>]
413
476
  def get_profiles(opts = {})
414
477
  data, _status_code, _headers = get_profiles_with_http_info(opts)
@@ -416,22 +479,36 @@ module KlaviyoAPI
416
479
  end
417
480
 
418
481
  # Get Profiles
419
- # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: &#x60;id&#x60;, &#x60;created&#x60;, &#x60;email&#x60; You can adjust the number of results per page via the &#x60;page[size]&#x60; query parameter, e.g. &#x60;?page[size]&#x3D;25&#x60;. **Default**: 20. **Max**: 100.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Profiles Read&#x60;
482
+ # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: &#x60;id&#x60;, &#x60;created&#x60;, &#x60;updated&#x60;, &#x60;email&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;profiles:read&#x60;
420
483
  # @param [Hash] opts the optional parameters
421
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
422
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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;anonymous_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;
423
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
424
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
484
+ # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
485
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
486
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-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;
487
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
488
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
489
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
425
490
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
426
491
  def get_profiles_with_http_info(opts = {})
427
492
  if @api_client.config.debugging
428
493
  @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profiles ...'
429
494
  end
430
- allowable_values = ["email", "phone_number", "external_id", "anonymous_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties"]
495
+ allowable_values = ["predictive_analytics"]
496
+ if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
497
+ fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
498
+ end
499
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
431
500
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
432
501
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
433
502
  end
434
- allowable_values = ["created", "-created", "email", "-email", "id", "-id"]
503
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
504
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles, must be smaller than or equal to 100.'
505
+ end
506
+
507
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
508
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ProfilesApi.get_profiles, must be greater than or equal to 1.'
509
+ end
510
+
511
+ allowable_values = ["created", "-created", "email", "-email", "id", "-id", "updated", "-updated"]
435
512
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
436
513
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
437
514
  end
@@ -440,15 +517,17 @@ module KlaviyoAPI
440
517
 
441
518
  # query parameters
442
519
  query_params = opts[:query_params] || {}
520
+ query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
443
521
  query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
444
522
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
445
523
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
524
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
446
525
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
447
526
 
448
527
  # header parameters
449
528
  header_params = opts[:header_params] || {}
450
529
  # klaviyo api revision
451
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
530
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
452
531
  # HTTP header 'Accept' (if needed)
453
532
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
454
533
 
@@ -482,7 +561,7 @@ module KlaviyoAPI
482
561
  end
483
562
 
484
563
  # Subscribe Profiles
485
- # 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). 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`
564
+ # 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`
486
565
  # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
487
566
  # @param [Hash] opts the optional parameters
488
567
  # @return [nil]
@@ -492,7 +571,7 @@ module KlaviyoAPI
492
571
  end
493
572
 
494
573
  # Subscribe Profiles
495
- # 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). Maximum number of profile can be submitted for subscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
574
+ # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any &#x60;UNSUBSCRIBE&#x60;, &#x60;SPAM_REPORT&#x60; or &#x60;USER_SUPPRESSED&#x60; suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profile can be submitted for subscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;list:write&#x60; &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
496
575
  # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
497
576
  # @param [Hash] opts the optional parameters
498
577
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -513,7 +592,7 @@ module KlaviyoAPI
513
592
  # header parameters
514
593
  header_params = opts[:header_params] || {}
515
594
  # klaviyo api revision
516
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
595
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
517
596
  # HTTP header 'Accept' (if needed)
518
597
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
519
598
  # HTTP header 'Content-Type'
@@ -552,7 +631,7 @@ module KlaviyoAPI
552
631
  end
553
632
 
554
633
  # Suppress Profiles
555
- # Manually suppress one or more profiles. Manually suppressed profiles will not receive email marketing. 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`
634
+ # 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`
556
635
  # @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
557
636
  # @param [Hash] opts the optional parameters
558
637
  # @return [nil]
@@ -562,7 +641,7 @@ module KlaviyoAPI
562
641
  end
563
642
 
564
643
  # Suppress Profiles
565
- # Manually suppress one or more profiles. Manually suppressed profiles will not receive email marketing. Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
644
+ # Manually suppress one or more profiles. Such profiles will have &#x60;USER_SUPPRESSED&#x60; as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about suppressed profiles [in this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
566
645
  # @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
567
646
  # @param [Hash] opts the optional parameters
568
647
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -583,7 +662,7 @@ module KlaviyoAPI
583
662
  # header parameters
584
663
  header_params = opts[:header_params] || {}
585
664
  # klaviyo api revision
586
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
665
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
587
666
  # HTTP header 'Accept' (if needed)
588
667
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
589
668
  # HTTP header 'Content-Type'
@@ -622,7 +701,7 @@ module KlaviyoAPI
622
701
  end
623
702
 
624
703
  # Unsubscribe Profiles
625
- # 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`
704
+ # 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`
626
705
  # @param unsubscription_create_job_create_query [UnsubscriptionCreateJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
627
706
  # @param [Hash] opts the optional parameters
628
707
  # @return [nil]
@@ -632,7 +711,7 @@ module KlaviyoAPI
632
711
  end
633
712
 
634
713
  # Unsubscribe Profiles
635
- # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
714
+ # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;list:write&#x60; &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
636
715
  # @param unsubscription_create_job_create_query [UnsubscriptionCreateJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
637
716
  # @param [Hash] opts the optional parameters
638
717
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -653,7 +732,7 @@ module KlaviyoAPI
653
732
  # header parameters
654
733
  header_params = opts[:header_params] || {}
655
734
  # klaviyo api revision
656
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
735
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
657
736
  # HTTP header 'Accept' (if needed)
658
737
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
659
738
  # HTTP header 'Content-Type'
@@ -692,7 +771,7 @@ module KlaviyoAPI
692
771
  end
693
772
 
694
773
  # Unsuppress Profiles
695
- # Unsuppress one or more profiles. Unsuppressed profiles will receive email marketing. Not supported for SMS marketing. Profiles suppressed due to a hard bounced email will not be unsuppressed. 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`
774
+ # 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`
696
775
  # @param unsuppression_create_job_create_query [UnsuppressionCreateJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
697
776
  # @param [Hash] opts the optional parameters
698
777
  # @return [nil]
@@ -702,7 +781,7 @@ module KlaviyoAPI
702
781
  end
703
782
 
704
783
  # Unsuppress Profiles
705
- # Unsuppress one or more profiles. Unsuppressed profiles will receive email marketing. Not supported for SMS marketing. Profiles suppressed due to a hard bounced email will not be unsuppressed. Maximum number of profile can be submitted for unsuppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Subscriptions Write&#x60;
784
+ # Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked consent, i.e. unsubscribed. Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. &#x60;UNSUBSCRIBE&#x60; and &#x60;SPAM_REPORT&#x60; suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). &#x60;INVALID_EMAIL&#x60; and &#x60;HARD_BOUNCE&#x60; suppressions cannot be removed by the API. Maximum number of profile can be submitted for unsuppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;subscriptions:write&#x60;
706
785
  # @param unsuppression_create_job_create_query [UnsuppressionCreateJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
707
786
  # @param [Hash] opts the optional parameters
708
787
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -723,7 +802,7 @@ module KlaviyoAPI
723
802
  # header parameters
724
803
  header_params = opts[:header_params] || {}
725
804
  # klaviyo api revision
726
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
805
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
727
806
  # HTTP header 'Accept' (if needed)
728
807
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
729
808
  # HTTP header 'Content-Type'
@@ -762,7 +841,7 @@ module KlaviyoAPI
762
841
  end
763
842
 
764
843
  # Update Profile
765
- # Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
844
+ # Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
766
845
  # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
767
846
  # @param profile_partial_update_query [ProfilePartialUpdateQuery]
768
847
  # @param [Hash] opts the optional parameters
@@ -773,7 +852,7 @@ module KlaviyoAPI
773
852
  end
774
853
 
775
854
  # Update Profile
776
- # Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you&#39;ll need to include at least one other identifier attribute (&#x60;email&#x60; or &#x60;external_id&#x60;) in addition to the &#x60;phone_number&#x60; attribute for the API call to work.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Write&#x60;
855
+ # Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you&#39;ll need to include at least one other identifier attribute (&#x60;email&#x60; or &#x60;external_id&#x60;) in addition to the &#x60;phone_number&#x60; attribute for the API call to work.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60;
777
856
  # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
778
857
  # @param profile_partial_update_query [ProfilePartialUpdateQuery]
779
858
  # @param [Hash] opts the optional parameters
@@ -799,7 +878,7 @@ module KlaviyoAPI
799
878
  # header parameters
800
879
  header_params = opts[:header_params] || {}
801
880
  # klaviyo api revision
802
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
881
+ header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
803
882
  # HTTP header 'Accept' (if needed)
804
883
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
805
884
  # HTTP header 'Content-Type'