klaviyo-api-sdk 2.0.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (813) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +91 -0
  3. data/README.md +562 -235
  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 +569 -98
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +427 -357
  8. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  9. data/lib/klaviyo-api-sdk/api/events_api.rb +108 -108
  10. data/lib/klaviyo-api-sdk/api/flows_api.rb +229 -163
  11. data/lib/klaviyo-api-sdk/api/lists_api.rb +117 -74
  12. data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
  13. data/lib/klaviyo-api-sdk/api/profiles_api.rb +108 -114
  14. data/lib/klaviyo-api-sdk/api/segments_api.rb +105 -62
  15. data/lib/klaviyo-api-sdk/api/tags_api.rb +145 -117
  16. data/lib/klaviyo-api-sdk/api/templates_api.rb +39 -39
  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/{subscription_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
  22. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  23. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
  24. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
  25. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  26. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
  27. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +32 -38
  28. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
  29. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
  30. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
  31. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  32. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +25 -16
  34. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
  35. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
  36. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
  37. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +272 -0
  38. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +22 -22
  39. data/lib/klaviyo-api-sdk/models/{collection_links.rb → campaign_message_create_query_resource_object_attributes.rb} +34 -41
  40. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
  41. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  42. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  43. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
  44. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +23 -14
  45. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  46. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
  47. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
  48. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  49. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
  50. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
  51. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  52. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  53. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
  54. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  56. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  57. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
  58. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  60. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  62. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
  64. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +3 -6
  65. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
  66. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  67. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
  68. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +18 -16
  69. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
  71. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +3 -6
  72. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
  73. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  76. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  77. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
  78. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +3 -6
  79. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
  80. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
  82. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  83. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships.rb +219 -0
  84. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items.rb +226 -0
  85. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
  86. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  88. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  90. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
  91. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
  93. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +3 -6
  94. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
  95. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
  97. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -70
  98. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
  100. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
  102. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +3 -6
  103. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
  104. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
  108. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +3 -6
  109. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
  110. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
  112. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
  113. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
  118. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +3 -6
  119. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
  120. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
  122. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +115 -113
  123. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +8 -8
  124. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_variant_create_query_resource_object_relationships_item.rb} +6 -8
  125. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
  127. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +3 -6
  128. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
  129. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
  133. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +3 -6
  134. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
  135. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
  137. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
  138. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
  140. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +13 -29
  141. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
  142. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +248 -0
  144. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
  145. data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +12 -32
  146. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
  147. data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +28 -28
  148. data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
  149. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +22 -22
  150. data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +21 -22
  151. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query.rb → event_create_query_v2_resource_object_attributes_metric.rb} +5 -5
  152. data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query.rb → event_create_query_v2_resource_object_attributes_profile.rb} +4 -4
  153. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
  157. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
  159. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
  160. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
  161. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
  163. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
  170. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
  173. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +64 -67
  174. data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → metric_create_query_resource_object.rb} +22 -22
  175. data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
  176. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +29 -19
  178. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +55 -45
  179. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +8 -13
  180. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
  182. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
  183. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +248 -0
  185. data/lib/klaviyo-api-sdk/models/{onsite_profile_meta_identifiers.rb → profile_identifier_dto_resource_object_attributes.rb} +18 -38
  186. data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
  187. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/{object_links.rb → profile_meta.rb} +11 -16
  190. data/lib/klaviyo-api-sdk/models/{sms_message_content.rb → profile_meta_patch_properties.rb} +28 -27
  191. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -0
  192. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -19
  194. data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +92 -39
  195. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/{flow_action_enum.rb → profile_subscription_bulk_delete_job_enum.rb} +5 -5
  197. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
  198. data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +18 -28
  199. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
  200. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
  201. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_enum.rb → profile_suppression_bulk_delete_job_enum.rb} +5 -5
  203. data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query_resource_object.rb → profile_suppression_create_query_resource_object.rb} +22 -22
  204. data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
  205. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
  206. data/lib/klaviyo-api-sdk/models/{subscriptions.rb → profile_suppression_delete_query_resource_object_attributes.rb} +9 -17
  207. data/lib/klaviyo-api-sdk/models/{sms_render_options.rb → render_options_sub_object.rb} +32 -37
  208. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
  211. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
  213. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
  214. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
  215. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object_attributes.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +46 -32
  216. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
  217. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
  218. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
  219. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +272 -0
  220. data/lib/klaviyo-api-sdk/models/{sms_channel.rb → sms_content_sub_object_create.rb} +12 -11
  221. data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
  222. data/lib/klaviyo-api-sdk/models/{sms_tracking_options.rb → sms_tracking_options_sub_object.rb} +19 -27
  223. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
  224. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
  226. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  227. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +25 -16
  228. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -32
  229. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
  230. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +224 -0
  231. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
  232. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
  233. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
  234. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +219 -0
  235. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +224 -0
  236. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +272 -0
  237. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
  239. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +11 -14
  240. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
  241. data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query.rb → suppression_delete_job_create_query.rb} +5 -5
  242. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
  243. data/lib/klaviyo-api-sdk/models/{error_source.rb → suppression_delete_job_create_query_resource_object_attributes.rb} +14 -17
  244. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
  245. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +25 -16
  249. data/lib/klaviyo-api-sdk/models/{email_channel.rb → tag_create_query_resource_object_relationships.rb} +11 -11
  250. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
  251. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +272 -0
  252. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  253. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
  257. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
  258. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
  261. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
  262. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
  268. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
  271. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +5 -17
  272. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
  274. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +23 -35
  275. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
  278. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +5 -17
  279. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
  281. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -28
  282. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
  283. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  284. data/lib/klaviyo-api-sdk/version.rb +1 -1
  285. data/lib/klaviyo-api-sdk.rb +85 -59
  286. metadata +91 -571
  287. data/Gemfile +0 -9
  288. data/Rakefile +0 -10
  289. data/docs/AudiencesSubObject.md +0 -20
  290. data/docs/CampaignCloneQuery.md +0 -18
  291. data/docs/CampaignCloneQueryResourceObject.md +0 -20
  292. data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
  293. data/docs/CampaignCreateQuery.md +0 -18
  294. data/docs/CampaignCreateQueryResourceObject.md +0 -20
  295. data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
  296. data/docs/CampaignEnum.md +0 -15
  297. data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
  298. data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
  299. data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
  300. data/docs/CampaignMessageEnum.md +0 -15
  301. data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
  302. data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
  303. data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
  304. data/docs/CampaignPartialUpdateQuery.md +0 -18
  305. data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
  306. data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
  307. data/docs/CampaignRecipientEstimationEnum.md +0 -15
  308. data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
  309. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
  310. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
  311. data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
  312. data/docs/CampaignSendJobCreateQuery.md +0 -18
  313. data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
  314. data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
  315. data/docs/CampaignSendJobEnum.md +0 -15
  316. data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
  317. data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
  318. data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
  319. data/docs/CampaignsApi.md +0 -1275
  320. data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
  321. data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
  322. data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
  323. data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
  324. data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
  325. data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  326. data/docs/CatalogCategoryCreateQuery.md +0 -18
  327. data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
  328. data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
  329. data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
  330. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
  331. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
  332. data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
  333. data/docs/CatalogCategoryEnum.md +0 -15
  334. data/docs/CatalogCategoryItemOp.md +0 -18
  335. data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
  336. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
  337. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
  338. data/docs/CatalogCategoryUpdateQuery.md +0 -18
  339. data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
  340. data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
  341. data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
  342. data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
  343. data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
  344. data/docs/CatalogItemCategoryOp.md +0 -18
  345. data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
  346. data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
  347. data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  348. data/docs/CatalogItemCreateQuery.md +0 -18
  349. data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
  350. data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
  351. data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
  352. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
  353. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
  354. data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
  355. data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
  356. data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
  357. data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
  358. data/docs/CatalogItemEnum.md +0 -15
  359. data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
  360. data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
  361. data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
  362. data/docs/CatalogItemUpdateQuery.md +0 -18
  363. data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
  364. data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
  365. data/docs/CatalogJobErrorPayload.md +0 -26
  366. data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
  367. data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
  368. data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
  369. data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
  370. data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
  371. data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  372. data/docs/CatalogVariantCreateQuery.md +0 -18
  373. data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
  374. data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
  375. data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
  376. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
  377. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
  378. data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
  379. data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
  380. data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
  381. data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
  382. data/docs/CatalogVariantEnum.md +0 -15
  383. data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
  384. data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
  385. data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
  386. data/docs/CatalogVariantUpdateQuery.md +0 -18
  387. data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
  388. data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
  389. data/docs/CatalogsApi.md +0 -4032
  390. data/docs/ClientApi.md +0 -205
  391. data/docs/CollectionLinks.md +0 -26
  392. data/docs/ContentSubObject.md +0 -28
  393. data/docs/DataPrivacyApi.md +0 -78
  394. data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
  395. data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
  396. data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
  397. data/docs/DataPrivacyDeletionJobEnum.md +0 -15
  398. data/docs/EmailChannel.md +0 -18
  399. data/docs/EmailMarketing.md +0 -32
  400. data/docs/EmailMarketingListSuppression.md +0 -22
  401. data/docs/EmailMarketingSuppression.md +0 -20
  402. data/docs/EmailMessageContent.md +0 -24
  403. data/docs/EmailTrackingOptions.md +0 -24
  404. data/docs/ErrorSource.md +0 -18
  405. data/docs/EventCreateQuery.md +0 -18
  406. data/docs/EventCreateQueryResourceObject.md +0 -20
  407. data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
  408. data/docs/EventEnum.md +0 -15
  409. data/docs/EventsApi.md +0 -544
  410. data/docs/FlowActionEnum.md +0 -15
  411. data/docs/FlowEnum.md +0 -15
  412. data/docs/FlowMessageEnum.md +0 -15
  413. data/docs/FlowUpdateQuery.md +0 -18
  414. data/docs/FlowUpdateQueryResourceObject.md +0 -22
  415. data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
  416. data/docs/FlowsApi.md +0 -1173
  417. data/docs/GetCampaigns4XXResponse.md +0 -18
  418. data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
  419. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
  420. data/docs/ListCreateQuery.md +0 -18
  421. data/docs/ListCreateQueryResourceObject.md +0 -20
  422. data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
  423. data/docs/ListEnum.md +0 -15
  424. data/docs/ListMembersAddQuery.md +0 -18
  425. data/docs/ListMembersAddQueryDataInner.md +0 -20
  426. data/docs/ListMembersDeleteQuery.md +0 -18
  427. data/docs/ListPartialUpdateQuery.md +0 -18
  428. data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
  429. data/docs/ListsApi.md +0 -832
  430. data/docs/MetricAggregateEnum.md +0 -15
  431. data/docs/MetricAggregateQuery.md +0 -18
  432. data/docs/MetricAggregateQueryResourceObject.md +0 -20
  433. data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
  434. data/docs/MetricAggregateRowDTO.md +0 -20
  435. data/docs/MetricCreateQuery.md +0 -20
  436. data/docs/MetricEnum.md +0 -15
  437. data/docs/MetricsApi.md +0 -233
  438. data/docs/ObjectLinks.md +0 -18
  439. data/docs/OnsiteProfileCreateQuery.md +0 -18
  440. data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
  441. data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
  442. data/docs/OnsiteProfileMeta.md +0 -18
  443. data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
  444. data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
  445. data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
  446. data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
  447. data/docs/PredictiveAnalytics.md +0 -34
  448. data/docs/ProfileAggregateEnum.md +0 -15
  449. data/docs/ProfileCreateQuery.md +0 -18
  450. data/docs/ProfileCreateQueryResourceObject.md +0 -20
  451. data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
  452. data/docs/ProfileEnum.md +0 -15
  453. data/docs/ProfileLocation.md +0 -34
  454. data/docs/ProfileLocationLatitude.md +0 -49
  455. data/docs/ProfileLocationLongitude.md +0 -49
  456. data/docs/ProfilePartialUpdateQuery.md +0 -18
  457. data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -22
  458. data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
  459. data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
  460. data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
  461. data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
  462. data/docs/ProfilesApi.md +0 -909
  463. data/docs/SMSChannel.md +0 -18
  464. data/docs/SMSMarketing.md +0 -24
  465. data/docs/SMSMessageContent.md +0 -20
  466. data/docs/SMSRenderOptions.md +0 -24
  467. data/docs/SMSTrackingOptions.md +0 -20
  468. data/docs/STOScheduleOptions.md +0 -18
  469. data/docs/SegmentEnum.md +0 -15
  470. data/docs/SegmentPartialUpdateQuery.md +0 -18
  471. data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
  472. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
  473. data/docs/SegmentsApi.md +0 -543
  474. data/docs/SendOptions.md +0 -20
  475. data/docs/SendOptionsSubObject.md +0 -18
  476. data/docs/SendStrategySubObject.md +0 -24
  477. data/docs/SendTimeSubObject.md +0 -20
  478. data/docs/StaticScheduleOptions.md +0 -22
  479. data/docs/Subscription.md +0 -24
  480. data/docs/SubscriptionChannels.md +0 -20
  481. data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
  482. data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
  483. data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
  484. data/docs/SubscriptionEnum.md +0 -15
  485. data/docs/Subscriptions.md +0 -20
  486. data/docs/Suppression.md +0 -18
  487. data/docs/SuppressionCreateJobCreateQuery.md +0 -18
  488. data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
  489. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  490. data/docs/TagCampaignOp.md +0 -18
  491. data/docs/TagCampaignOpDataInner.md +0 -20
  492. data/docs/TagCreateQuery.md +0 -18
  493. data/docs/TagCreateQueryResourceObject.md +0 -20
  494. data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
  495. data/docs/TagEnum.md +0 -15
  496. data/docs/TagFlowOp.md +0 -18
  497. data/docs/TagFlowOpDataInner.md +0 -20
  498. data/docs/TagGroupCreateQuery.md +0 -18
  499. data/docs/TagGroupCreateQueryResourceObject.md +0 -20
  500. data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
  501. data/docs/TagGroupEnum.md +0 -15
  502. data/docs/TagGroupUpdateQuery.md +0 -18
  503. data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
  504. data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
  505. data/docs/TagListOp.md +0 -18
  506. data/docs/TagListOpDataInner.md +0 -20
  507. data/docs/TagSegmentOp.md +0 -18
  508. data/docs/TagSegmentOpDataInner.md +0 -20
  509. data/docs/TagUpdateQuery.md +0 -18
  510. data/docs/TagUpdateQueryResourceObject.md +0 -22
  511. data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
  512. data/docs/TagsApi.md +0 -1923
  513. data/docs/TemplateCloneQuery.md +0 -18
  514. data/docs/TemplateCloneQueryResourceObject.md +0 -20
  515. data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
  516. data/docs/TemplateCreateQuery.md +0 -18
  517. data/docs/TemplateCreateQueryResourceObject.md +0 -20
  518. data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
  519. data/docs/TemplateEnum.md +0 -15
  520. data/docs/TemplateRenderQuery.md +0 -18
  521. data/docs/TemplateRenderQueryResourceObject.md +0 -20
  522. data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
  523. data/docs/TemplateUpdateQuery.md +0 -18
  524. data/docs/TemplateUpdateQueryResourceObject.md +0 -22
  525. data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
  526. data/docs/TemplatesApi.md +0 -525
  527. data/docs/TestApiAnalyticsSampleEnum.md +0 -15
  528. data/docs/TestListEnum.md +0 -15
  529. data/docs/ThrottledScheduleOptions.md +0 -20
  530. data/docs/TrackingOptionsSubObject.md +0 -24
  531. data/docs/UTMParamsSubObject.md +0 -20
  532. data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
  533. data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
  534. data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
  535. data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
  536. data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
  537. data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  538. data/docs/UtmParamInfo.md +0 -20
  539. data/git_push.sh +0 -57
  540. data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
  541. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
  542. data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
  543. data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
  544. data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
  545. data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
  546. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
  547. data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +0 -36
  548. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
  549. data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
  550. data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
  551. data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +0 -36
  552. data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +0 -36
  553. data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
  554. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
  555. data/lib/klaviyo-api-sdk/models/sms_marketing.rb +0 -270
  556. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +0 -235
  557. data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
  558. data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
  559. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +0 -227
  560. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
  561. data/spec/api/campaigns_api_spec.rb +0 -255
  562. data/spec/api/catalogs_api_spec.rb +0 -751
  563. data/spec/api/client_api_spec.rb +0 -74
  564. data/spec/api/data_privacy_api_spec.rb +0 -47
  565. data/spec/api/events_api_spec.rb +0 -132
  566. data/spec/api/flows_api_spec.rb +0 -247
  567. data/spec/api/lists_api_spec.rb +0 -180
  568. data/spec/api/metrics_api_spec.rb +0 -74
  569. data/spec/api/profiles_api_spec.rb +0 -194
  570. data/spec/api/segments_api_spec.rb +0 -130
  571. data/spec/api/tags_api_spec.rb +0 -367
  572. data/spec/api/templates_api_spec.rb +0 -124
  573. data/spec/api_client_spec.rb +0 -226
  574. data/spec/configuration_spec.rb +0 -42
  575. data/spec/models/audiences_sub_object_spec.rb +0 -40
  576. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -40
  577. data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
  578. data/spec/models/campaign_clone_query_spec.rb +0 -34
  579. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
  580. data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
  581. data/spec/models/campaign_create_query_spec.rb +0 -34
  582. data/spec/models/campaign_enum_spec.rb +0 -28
  583. data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
  584. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
  585. data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
  586. data/spec/models/campaign_message_enum_spec.rb +0 -28
  587. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
  588. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
  589. data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
  590. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
  591. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
  592. data/spec/models/campaign_partial_update_query_spec.rb +0 -34
  593. data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
  594. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
  595. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
  596. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
  597. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
  598. data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
  599. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
  600. data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
  601. data/spec/models/campaign_send_job_enum_spec.rb +0 -28
  602. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
  603. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
  604. data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
  605. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
  606. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
  607. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
  608. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  609. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
  610. data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
  611. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
  612. data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
  613. data/spec/models/catalog_category_create_query_spec.rb +0 -34
  614. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
  615. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
  616. data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
  617. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
  618. data/spec/models/catalog_category_enum_spec.rb +0 -28
  619. data/spec/models/catalog_category_item_op_spec.rb +0 -34
  620. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
  621. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
  622. data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
  623. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
  624. data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
  625. data/spec/models/catalog_category_update_query_spec.rb +0 -34
  626. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
  627. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
  628. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
  629. data/spec/models/catalog_item_category_op_spec.rb +0 -34
  630. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  631. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
  632. data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
  633. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
  634. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
  635. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
  636. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
  637. data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
  638. data/spec/models/catalog_item_create_query_spec.rb +0 -34
  639. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
  640. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
  641. data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
  642. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
  643. data/spec/models/catalog_item_enum_spec.rb +0 -28
  644. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
  645. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
  646. data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
  647. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
  648. data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
  649. data/spec/models/catalog_item_update_query_spec.rb +0 -34
  650. data/spec/models/catalog_job_error_payload_spec.rb +0 -58
  651. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
  652. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
  653. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
  654. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  655. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
  656. data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
  657. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
  658. data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
  659. data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
  660. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
  661. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
  662. data/spec/models/catalog_variant_create_query_spec.rb +0 -34
  663. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
  664. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
  665. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
  666. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
  667. data/spec/models/catalog_variant_enum_spec.rb +0 -28
  668. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
  669. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
  670. data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
  671. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
  672. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
  673. data/spec/models/catalog_variant_update_query_spec.rb +0 -34
  674. data/spec/models/collection_links_spec.rb +0 -58
  675. data/spec/models/content_sub_object_spec.rb +0 -64
  676. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
  677. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
  678. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
  679. data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
  680. data/spec/models/email_channel_spec.rb +0 -34
  681. data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
  682. data/spec/models/email_marketing_spec.rb +0 -76
  683. data/spec/models/email_marketing_suppression_spec.rb +0 -40
  684. data/spec/models/email_message_content_spec.rb +0 -52
  685. data/spec/models/email_tracking_options_spec.rb +0 -52
  686. data/spec/models/error_source_spec.rb +0 -34
  687. data/spec/models/event_create_query_resource_object_attributes_spec.rb +0 -64
  688. data/spec/models/event_create_query_resource_object_spec.rb +0 -40
  689. data/spec/models/event_create_query_spec.rb +0 -34
  690. data/spec/models/event_enum_spec.rb +0 -28
  691. data/spec/models/flow_action_enum_spec.rb +0 -28
  692. data/spec/models/flow_enum_spec.rb +0 -28
  693. data/spec/models/flow_message_enum_spec.rb +0 -28
  694. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
  695. data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
  696. data/spec/models/flow_update_query_spec.rb +0 -34
  697. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
  698. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
  699. data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
  700. data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
  701. data/spec/models/list_create_query_resource_object_spec.rb +0 -40
  702. data/spec/models/list_create_query_spec.rb +0 -34
  703. data/spec/models/list_enum_spec.rb +0 -28
  704. data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
  705. data/spec/models/list_members_add_query_spec.rb +0 -34
  706. data/spec/models/list_members_delete_query_spec.rb +0 -34
  707. data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
  708. data/spec/models/list_partial_update_query_spec.rb +0 -34
  709. data/spec/models/metric_aggregate_enum_spec.rb +0 -28
  710. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
  711. data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
  712. data/spec/models/metric_aggregate_query_spec.rb +0 -34
  713. data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
  714. data/spec/models/metric_create_query_spec.rb +0 -40
  715. data/spec/models/metric_enum_spec.rb +0 -28
  716. data/spec/models/object_links_spec.rb +0 -34
  717. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
  718. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
  719. data/spec/models/onsite_profile_create_query_spec.rb +0 -34
  720. data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
  721. data/spec/models/onsite_profile_meta_spec.rb +0 -34
  722. data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +0 -58
  723. data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
  724. data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
  725. data/spec/models/predictive_analytics_spec.rb +0 -82
  726. data/spec/models/profile_aggregate_enum_spec.rb +0 -28
  727. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
  728. data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
  729. data/spec/models/profile_create_query_spec.rb +0 -34
  730. data/spec/models/profile_enum_spec.rb +0 -28
  731. data/spec/models/profile_location_latitude_spec.rb +0 -31
  732. data/spec/models/profile_location_longitude_spec.rb +0 -31
  733. data/spec/models/profile_location_spec.rb +0 -82
  734. data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -46
  735. data/spec/models/profile_partial_update_query_spec.rb +0 -34
  736. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
  737. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
  738. data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
  739. data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
  740. data/spec/models/segment_enum_spec.rb +0 -28
  741. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
  742. data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
  743. data/spec/models/segment_partial_update_query_spec.rb +0 -34
  744. data/spec/models/send_options_spec.rb +0 -40
  745. data/spec/models/send_options_sub_object_spec.rb +0 -34
  746. data/spec/models/send_strategy_sub_object_spec.rb +0 -52
  747. data/spec/models/send_time_sub_object_spec.rb +0 -40
  748. data/spec/models/sms_channel_spec.rb +0 -34
  749. data/spec/models/sms_marketing_spec.rb +0 -52
  750. data/spec/models/sms_message_content_spec.rb +0 -40
  751. data/spec/models/sms_render_options_spec.rb +0 -52
  752. data/spec/models/sms_tracking_options_spec.rb +0 -40
  753. data/spec/models/static_schedule_options_spec.rb +0 -46
  754. data/spec/models/sto_schedule_options_spec.rb +0 -34
  755. data/spec/models/subscription_channels_spec.rb +0 -48
  756. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
  757. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
  758. data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
  759. data/spec/models/subscription_enum_spec.rb +0 -28
  760. data/spec/models/subscription_spec.rb +0 -52
  761. data/spec/models/subscriptions_spec.rb +0 -40
  762. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  763. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
  764. data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
  765. data/spec/models/suppression_spec.rb +0 -34
  766. data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
  767. data/spec/models/tag_campaign_op_spec.rb +0 -34
  768. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
  769. data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
  770. data/spec/models/tag_create_query_spec.rb +0 -34
  771. data/spec/models/tag_enum_spec.rb +0 -28
  772. data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
  773. data/spec/models/tag_flow_op_spec.rb +0 -34
  774. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
  775. data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
  776. data/spec/models/tag_group_create_query_spec.rb +0 -34
  777. data/spec/models/tag_group_enum_spec.rb +0 -28
  778. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
  779. data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
  780. data/spec/models/tag_group_update_query_spec.rb +0 -34
  781. data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
  782. data/spec/models/tag_list_op_spec.rb +0 -34
  783. data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
  784. data/spec/models/tag_segment_op_spec.rb +0 -34
  785. data/spec/models/tag_update_query_resource_object_attributes_spec.rb +0 -34
  786. data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
  787. data/spec/models/tag_update_query_spec.rb +0 -34
  788. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
  789. data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
  790. data/spec/models/template_clone_query_spec.rb +0 -34
  791. data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
  792. data/spec/models/template_create_query_resource_object_spec.rb +0 -40
  793. data/spec/models/template_create_query_spec.rb +0 -34
  794. data/spec/models/template_enum_spec.rb +0 -28
  795. data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
  796. data/spec/models/template_render_query_resource_object_spec.rb +0 -40
  797. data/spec/models/template_render_query_spec.rb +0 -34
  798. data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
  799. data/spec/models/template_update_query_resource_object_spec.rb +0 -46
  800. data/spec/models/template_update_query_spec.rb +0 -34
  801. data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
  802. data/spec/models/test_list_enum_spec.rb +0 -28
  803. data/spec/models/throttled_schedule_options_spec.rb +0 -40
  804. data/spec/models/tracking_options_sub_object_spec.rb +0 -52
  805. data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
  806. data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
  807. data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
  808. data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  809. data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
  810. data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
  811. data/spec/models/utm_param_info_spec.rb +0 -40
  812. data/spec/models/utm_params_sub_object_spec.rb +0 -40
  813. 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-07-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -20,10 +20,9 @@ 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
- # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
27
26
  # @return [Hash<String, Object>]
28
27
  def create_profile(profile_create_query, opts = {})
29
28
  data, _status_code, _headers = create_profile_with_http_info(profile_create_query, opts)
@@ -31,10 +30,9 @@ module KlaviyoAPI
31
30
  end
32
31
 
33
32
  # Create Profile
34
- # 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;
35
34
  # @param profile_create_query [ProfileCreateQuery]
36
35
  # @param [Hash] opts the optional parameters
37
- # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
38
36
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
39
37
  def create_profile_with_http_info(profile_create_query, opts = {})
40
38
  if @api_client.config.debugging
@@ -44,21 +42,16 @@ module KlaviyoAPI
44
42
  if @api_client.config.client_side_validation && profile_create_query.nil?
45
43
  fail ArgumentError, "Missing the required parameter 'profile_create_query' when calling ProfilesApi.create_profile"
46
44
  end
47
- allowable_values = ["predictive_analytics"]
48
- if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
49
- fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
50
- end
51
45
  # resource path
52
46
  local_var_path = '/api/profiles/'
53
47
 
54
48
  # query parameters
55
49
  query_params = opts[:query_params] || {}
56
- query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
57
50
 
58
51
  # header parameters
59
52
  header_params = opts[:header_params] || {}
60
53
  # klaviyo api revision
61
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
54
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
62
55
  # HTTP header 'Accept' (if needed)
63
56
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
57
  # HTTP header 'Content-Type'
@@ -97,14 +90,14 @@ module KlaviyoAPI
97
90
  end
98
91
 
99
92
  # Get Profile
100
- # 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`
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`
101
94
  # @param id [String]
102
95
  # @param [Hash] opts the optional parameters
103
96
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
104
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
105
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
106
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
107
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
97
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
98
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
99
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
100
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
108
101
  # @return [Hash<String, Object>]
109
102
  def get_profile(id, opts = {})
110
103
  data, _status_code, _headers = get_profile_with_http_info(id, opts)
@@ -112,14 +105,14 @@ module KlaviyoAPI
112
105
  end
113
106
 
114
107
  # Get Profile
115
- # 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
+ # 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;
116
109
  # @param id [String]
117
110
  # @param [Hash] opts the optional parameters
118
111
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
119
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
120
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
121
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
122
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
112
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
113
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
114
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
115
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
123
116
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
124
117
  def get_profile_with_http_info(id, opts = {})
125
118
  if @api_client.config.debugging
@@ -137,7 +130,7 @@ module KlaviyoAPI
137
130
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
138
131
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
139
132
  end
140
- 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"]
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.list_suppressions", "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"]
141
134
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
142
135
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
143
136
  end
@@ -163,7 +156,7 @@ module KlaviyoAPI
163
156
  # header parameters
164
157
  header_params = opts[:header_params] || {}
165
158
  # klaviyo api revision
166
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
159
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
167
160
  # HTTP header 'Accept' (if needed)
168
161
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
169
162
 
@@ -197,36 +190,36 @@ module KlaviyoAPI
197
190
  end
198
191
 
199
192
  # Get Profile Lists
200
- # 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`
201
- # @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]
202
195
  # @param [Hash] opts the optional parameters
203
- # @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-07-15/reference/api-overview#sparse-fieldsets
204
197
  # @return [Hash<String, Object>]
205
- def get_profile_lists(profile_id, opts = {})
206
- 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)
207
200
  data
208
201
  end
209
202
 
210
203
  # Get Profile Lists
211
- # 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;
212
- # @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]
213
206
  # @param [Hash] opts the optional parameters
214
- # @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-07-15/reference/api-overview#sparse-fieldsets
215
208
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
216
- def get_profile_lists_with_http_info(profile_id, opts = {})
209
+ def get_profile_lists_with_http_info(id, opts = {})
217
210
  if @api_client.config.debugging
218
211
  @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_lists ...'
219
212
  end
220
- # verify the required parameter 'profile_id' is set
221
- if @api_client.config.client_side_validation && profile_id.nil?
222
- 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"
223
216
  end
224
217
  allowable_values = ["name", "created", "updated"]
225
218
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
226
219
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
227
220
  end
228
221
  # resource path
229
- 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))
230
223
 
231
224
  # query parameters
232
225
  query_params = opts[:query_params] || {}
@@ -235,7 +228,7 @@ module KlaviyoAPI
235
228
  # header parameters
236
229
  header_params = opts[:header_params] || {}
237
230
  # klaviyo api revision
238
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
231
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
239
232
  # HTTP header 'Accept' (if needed)
240
233
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
241
234
 
@@ -269,7 +262,7 @@ module KlaviyoAPI
269
262
  end
270
263
 
271
264
  # Get Profile Relationships Lists
272
- # 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`
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`
273
266
  # @param id [String]
274
267
  # @param [Hash] opts the optional parameters
275
268
  # @return [Hash<String, Object>]
@@ -279,7 +272,7 @@ module KlaviyoAPI
279
272
  end
280
273
 
281
274
  # Get Profile Relationships Lists
282
- # 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;
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;
283
276
  # @param id [String]
284
277
  # @param [Hash] opts the optional parameters
285
278
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -300,7 +293,7 @@ module KlaviyoAPI
300
293
  # header parameters
301
294
  header_params = opts[:header_params] || {}
302
295
  # klaviyo api revision
303
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
296
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
304
297
  # HTTP header 'Accept' (if needed)
305
298
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
306
299
 
@@ -334,7 +327,7 @@ module KlaviyoAPI
334
327
  end
335
328
 
336
329
  # Get Profile Relationships Segments
337
- # 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`
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`
338
331
  # @param id [String]
339
332
  # @param [Hash] opts the optional parameters
340
333
  # @return [Hash<String, Object>]
@@ -344,7 +337,7 @@ module KlaviyoAPI
344
337
  end
345
338
 
346
339
  # Get Profile Relationships Segments
347
- # 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;
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;
348
341
  # @param id [String]
349
342
  # @param [Hash] opts the optional parameters
350
343
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -365,7 +358,7 @@ module KlaviyoAPI
365
358
  # header parameters
366
359
  header_params = opts[:header_params] || {}
367
360
  # klaviyo api revision
368
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
361
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
369
362
  # HTTP header 'Accept' (if needed)
370
363
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
371
364
 
@@ -399,36 +392,36 @@ module KlaviyoAPI
399
392
  end
400
393
 
401
394
  # Get Profile Segments
402
- # 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`
403
- # @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]
404
397
  # @param [Hash] opts the optional parameters
405
- # @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-07-15/reference/api-overview#sparse-fieldsets
406
399
  # @return [Hash<String, Object>]
407
- def get_profile_segments(profile_id, opts = {})
408
- 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)
409
402
  data
410
403
  end
411
404
 
412
405
  # Get Profile Segments
413
- # 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;
414
- # @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]
415
408
  # @param [Hash] opts the optional parameters
416
- # @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-07-15/reference/api-overview#sparse-fieldsets
417
410
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
418
- def get_profile_segments_with_http_info(profile_id, opts = {})
411
+ def get_profile_segments_with_http_info(id, opts = {})
419
412
  if @api_client.config.debugging
420
413
  @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_segments ...'
421
414
  end
422
- # verify the required parameter 'profile_id' is set
423
- if @api_client.config.client_side_validation && profile_id.nil?
424
- 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"
425
418
  end
426
419
  allowable_values = ["name", "created", "updated"]
427
420
  if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
428
421
  fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
429
422
  end
430
423
  # resource path
431
- 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))
432
425
 
433
426
  # query parameters
434
427
  query_params = opts[:query_params] || {}
@@ -437,7 +430,7 @@ module KlaviyoAPI
437
430
  # header parameters
438
431
  header_params = opts[:header_params] || {}
439
432
  # klaviyo api revision
440
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
433
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
441
434
  # HTTP header 'Accept' (if needed)
442
435
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
443
436
 
@@ -471,14 +464,14 @@ module KlaviyoAPI
471
464
  end
472
465
 
473
466
  # Get Profiles
474
- # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `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: `10/s`<br>Steady: `150/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: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
475
468
  # @param [Hash] opts the optional parameters
476
469
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
477
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
478
- # @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;_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;
479
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
480
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
481
- # @option opts [Integer] :page_size The number of results to return per page. Default &#x3D; 20. Max &#x3D; 100
470
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
471
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;
472
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-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-07-15/reference/api-overview#sorting
482
475
  # @return [Hash<String, Object>]
483
476
  def get_profiles(opts = {})
484
477
  data, _status_code, _headers = get_profiles_with_http_info(opts)
@@ -486,14 +479,14 @@ module KlaviyoAPI
486
479
  end
487
480
 
488
481
  # Get Profiles
489
- # 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; 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/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;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[profile]&#x3D;predictive_analytics&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;profiles:read&#x60;
490
483
  # @param [Hash] opts the optional parameters
491
484
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
492
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
493
- # @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;_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;
494
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
495
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
496
- # @option opts [Integer] :page_size The number of results to return per page. Default &#x3D; 20. Max &#x3D; 100
485
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
486
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;
487
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-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-07-15/reference/api-overview#sorting
497
490
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
498
491
  def get_profiles_with_http_info(opts = {})
499
492
  if @api_client.config.debugging
@@ -503,10 +496,18 @@ module KlaviyoAPI
503
496
  if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
504
497
  fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
505
498
  end
506
- 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"]
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.list_suppressions", "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"]
507
500
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
508
501
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
509
502
  end
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
+
510
511
  allowable_values = ["created", "-created", "email", "-email", "id", "-id", "updated", "-updated"]
511
512
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
512
513
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
@@ -520,13 +521,13 @@ module KlaviyoAPI
520
521
  query_params[:'fields[profile]'] = @api_client.build_collection_param(opts[:'fields_profile'], :csv) if !opts[:'fields_profile'].nil?
521
522
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
522
523
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
523
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
524
524
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
525
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
525
526
 
526
527
  # header parameters
527
528
  header_params = opts[:header_params] || {}
528
529
  # klaviyo api revision
529
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
530
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
530
531
  # HTTP header 'Accept' (if needed)
531
532
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
532
533
 
@@ -560,7 +561,7 @@ module KlaviyoAPI
560
561
  end
561
562
 
562
563
  # Subscribe Profiles
563
- # 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`
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`
564
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.
565
566
  # @param [Hash] opts the optional parameters
566
567
  # @return [nil]
@@ -570,7 +571,7 @@ module KlaviyoAPI
570
571
  end
571
572
 
572
573
  # Subscribe Profiles
573
- # 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;
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;
574
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.
575
576
  # @param [Hash] opts the optional parameters
576
577
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -591,7 +592,7 @@ module KlaviyoAPI
591
592
  # header parameters
592
593
  header_params = opts[:header_params] || {}
593
594
  # klaviyo api revision
594
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
595
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
595
596
  # HTTP header 'Accept' (if needed)
596
597
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
597
598
  # HTTP header 'Content-Type'
@@ -630,7 +631,7 @@ module KlaviyoAPI
630
631
  end
631
632
 
632
633
  # Suppress Profiles
633
- # 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`
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`
634
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.
635
636
  # @param [Hash] opts the optional parameters
636
637
  # @return [nil]
@@ -640,7 +641,7 @@ module KlaviyoAPI
640
641
  end
641
642
 
642
643
  # Suppress Profiles
643
- # 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;
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;
644
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.
645
646
  # @param [Hash] opts the optional parameters
646
647
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -661,7 +662,7 @@ module KlaviyoAPI
661
662
  # header parameters
662
663
  header_params = opts[:header_params] || {}
663
664
  # klaviyo api revision
664
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
665
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
665
666
  # HTTP header 'Accept' (if needed)
666
667
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
667
668
  # HTTP header 'Content-Type'
@@ -700,30 +701,30 @@ module KlaviyoAPI
700
701
  end
701
702
 
702
703
  # Unsubscribe Profiles
703
- # 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
- # @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.
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`
705
+ # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
705
706
  # @param [Hash] opts the optional parameters
706
707
  # @return [nil]
707
- def unsubscribe_profiles(unsubscription_create_job_create_query, opts = {})
708
- unsubscribe_profiles_with_http_info(unsubscription_create_job_create_query, opts)
708
+ def unsubscribe_profiles(subscription_delete_job_create_query, opts = {})
709
+ unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts)
709
710
  nil
710
711
  end
711
712
 
712
713
  # Unsubscribe Profiles
713
- # 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
- # @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.
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;
715
+ # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
715
716
  # @param [Hash] opts the optional parameters
716
717
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
717
- def unsubscribe_profiles_with_http_info(unsubscription_create_job_create_query, opts = {})
718
+ def unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, opts = {})
718
719
  if @api_client.config.debugging
719
720
  @api_client.config.logger.debug 'Calling API: ProfilesApi.unsubscribe_profiles ...'
720
721
  end
721
- # verify the required parameter 'unsubscription_create_job_create_query' is set
722
- if @api_client.config.client_side_validation && unsubscription_create_job_create_query.nil?
723
- fail ArgumentError, "Missing the required parameter 'unsubscription_create_job_create_query' when calling ProfilesApi.unsubscribe_profiles"
722
+ # verify the required parameter 'subscription_delete_job_create_query' is set
723
+ if @api_client.config.client_side_validation && subscription_delete_job_create_query.nil?
724
+ fail ArgumentError, "Missing the required parameter 'subscription_delete_job_create_query' when calling ProfilesApi.unsubscribe_profiles"
724
725
  end
725
726
  # resource path
726
- local_var_path = '/api/profile-unsubscription-bulk-create-jobs/'
727
+ local_var_path = '/api/profile-subscription-bulk-delete-jobs/'
727
728
 
728
729
  # query parameters
729
730
  query_params = opts[:query_params] || {}
@@ -731,7 +732,7 @@ module KlaviyoAPI
731
732
  # header parameters
732
733
  header_params = opts[:header_params] || {}
733
734
  # klaviyo api revision
734
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
735
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
735
736
  # HTTP header 'Accept' (if needed)
736
737
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
737
738
  # HTTP header 'Content-Type'
@@ -744,7 +745,7 @@ module KlaviyoAPI
744
745
  form_params = opts[:form_params] || {}
745
746
 
746
747
  # http body (model)
747
- post_body = opts[:debug_body] || @api_client.object_to_http_body(unsubscription_create_job_create_query)
748
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(subscription_delete_job_create_query)
748
749
 
749
750
  # return_type
750
751
  return_type = opts[:debug_return_type]
@@ -770,30 +771,30 @@ module KlaviyoAPI
770
771
  end
771
772
 
772
773
  # Unsuppress Profiles
773
- # 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`
774
- # @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.
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`
775
+ # @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
775
776
  # @param [Hash] opts the optional parameters
776
777
  # @return [nil]
777
- def unsuppress_profiles(unsuppression_create_job_create_query, opts = {})
778
- unsuppress_profiles_with_http_info(unsuppression_create_job_create_query, opts)
778
+ def unsuppress_profiles(suppression_delete_job_create_query, opts = {})
779
+ unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts)
779
780
  nil
780
781
  end
781
782
 
782
783
  # Unsuppress Profiles
783
- # 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;
784
- # @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.
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;
785
+ # @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
785
786
  # @param [Hash] opts the optional parameters
786
787
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
787
- def unsuppress_profiles_with_http_info(unsuppression_create_job_create_query, opts = {})
788
+ def unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts = {})
788
789
  if @api_client.config.debugging
789
790
  @api_client.config.logger.debug 'Calling API: ProfilesApi.unsuppress_profiles ...'
790
791
  end
791
- # verify the required parameter 'unsuppression_create_job_create_query' is set
792
- if @api_client.config.client_side_validation && unsuppression_create_job_create_query.nil?
793
- fail ArgumentError, "Missing the required parameter 'unsuppression_create_job_create_query' when calling ProfilesApi.unsuppress_profiles"
792
+ # verify the required parameter 'suppression_delete_job_create_query' is set
793
+ if @api_client.config.client_side_validation && suppression_delete_job_create_query.nil?
794
+ fail ArgumentError, "Missing the required parameter 'suppression_delete_job_create_query' when calling ProfilesApi.unsuppress_profiles"
794
795
  end
795
796
  # resource path
796
- local_var_path = '/api/profile-unsuppression-bulk-create-jobs/'
797
+ local_var_path = '/api/profile-suppression-bulk-delete-jobs/'
797
798
 
798
799
  # query parameters
799
800
  query_params = opts[:query_params] || {}
@@ -801,7 +802,7 @@ module KlaviyoAPI
801
802
  # header parameters
802
803
  header_params = opts[:header_params] || {}
803
804
  # klaviyo api revision
804
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
805
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
805
806
  # HTTP header 'Accept' (if needed)
806
807
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
807
808
  # HTTP header 'Content-Type'
@@ -814,7 +815,7 @@ module KlaviyoAPI
814
815
  form_params = opts[:form_params] || {}
815
816
 
816
817
  # http body (model)
817
- post_body = opts[:debug_body] || @api_client.object_to_http_body(unsuppression_create_job_create_query)
818
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_delete_job_create_query)
818
819
 
819
820
  # return_type
820
821
  return_type = opts[:debug_return_type]
@@ -840,11 +841,10 @@ module KlaviyoAPI
840
841
  end
841
842
 
842
843
  # Update Profile
843
- # 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`
844
845
  # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
845
846
  # @param profile_partial_update_query [ProfilePartialUpdateQuery]
846
847
  # @param [Hash] opts the optional parameters
847
- # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
848
848
  # @return [Hash<String, Object>]
849
849
  def update_profile(id, profile_partial_update_query, opts = {})
850
850
  data, _status_code, _headers = update_profile_with_http_info(id, profile_partial_update_query, opts)
@@ -852,11 +852,10 @@ module KlaviyoAPI
852
852
  end
853
853
 
854
854
  # Update Profile
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;
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;
856
856
  # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
857
857
  # @param profile_partial_update_query [ProfilePartialUpdateQuery]
858
858
  # @param [Hash] opts the optional parameters
859
- # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
860
859
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
861
860
  def update_profile_with_http_info(id, profile_partial_update_query, opts = {})
862
861
  if @api_client.config.debugging
@@ -870,21 +869,16 @@ module KlaviyoAPI
870
869
  if @api_client.config.client_side_validation && profile_partial_update_query.nil?
871
870
  fail ArgumentError, "Missing the required parameter 'profile_partial_update_query' when calling ProfilesApi.update_profile"
872
871
  end
873
- allowable_values = ["predictive_analytics"]
874
- if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
875
- fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
876
- end
877
872
  # resource path
878
873
  local_var_path = '/api/profiles/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
879
874
 
880
875
  # query parameters
881
876
  query_params = opts[:query_params] || {}
882
- query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
883
877
 
884
878
  # header parameters
885
879
  header_params = opts[:header_params] || {}
886
880
  # klaviyo api revision
887
- header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
881
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
888
882
  # HTTP header 'Accept' (if needed)
889
883
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
890
884
  # HTTP header 'Content-Type'