klaviyo-api-sdk 4.2.0 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (694) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +201 -201
  3. data/docs/AccountsApi.md +4 -4
  4. data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +1 -1
  5. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +1 -1
  6. data/docs/CampaignsApi.md +51 -51
  7. data/docs/CatalogVariantCreateQueryResourceObject.md +1 -1
  8. data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +1 -1
  9. data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +1 -1
  10. data/docs/CatalogsApi.md +172 -172
  11. data/docs/CouponCodeCreateQueryResourceObject.md +1 -1
  12. data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +1 -1
  13. data/docs/CouponsApi.md +46 -34
  14. data/docs/EmailSubscriptionParameters.md +18 -0
  15. data/docs/EventsApi.md +30 -30
  16. data/docs/FlowsApi.md +73 -73
  17. data/docs/ImagesApi.md +12 -12
  18. data/docs/ListsApi.md +37 -37
  19. data/docs/MarketingSubscriptionParameters.md +18 -0
  20. data/docs/MetricsApi.md +8 -8
  21. data/docs/ProfileLocation.md +3 -1
  22. data/docs/ProfileMergeQueryResourceObject.md +1 -1
  23. data/docs/ProfileMergeQueryResourceObjectRelationships.md +1 -1
  24. data/docs/ProfileUpsertQueryResourceObjectAttributes.md +2 -0
  25. data/docs/ProfilesApi.md +28 -28
  26. data/docs/SMSSubscriptionParameters.md +18 -0
  27. data/docs/SegmentsApi.md +35 -35
  28. data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +1 -1
  29. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +1 -1
  30. data/docs/SubscriptionChannels.md +4 -4
  31. data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +1 -1
  32. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +1 -1
  33. data/docs/TagsApi.md +32 -32
  34. data/docs/TemplatesApi.md +10 -10
  35. data/klaviyo-api-sdk.gemspec +2 -2
  36. data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
  37. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +74 -74
  38. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +229 -229
  39. data/lib/klaviyo-api-sdk/api/coupons_api.rb +92 -50
  40. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  41. data/lib/klaviyo-api-sdk/api/events_api.rb +44 -44
  42. data/lib/klaviyo-api-sdk/api/flows_api.rb +94 -94
  43. data/lib/klaviyo-api-sdk/api/images_api.rb +20 -20
  44. data/lib/klaviyo-api-sdk/api/lists_api.rb +54 -54
  45. data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
  46. data/lib/klaviyo-api-sdk/api/profiles_api.rb +48 -48
  47. data/lib/klaviyo-api-sdk/api/segments_api.rb +46 -46
  48. data/lib/klaviyo-api-sdk/api/tags_api.rb +59 -59
  49. data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
  50. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  51. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  52. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  53. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  54. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  56. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  57. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
  58. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  60. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  62. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  64. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  65. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  66. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +6 -1
  67. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -1
  68. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  69. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
  71. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
  72. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  73. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
  76. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
  77. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  78. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  79. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
  80. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  83. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  84. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  85. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  86. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  88. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  93. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  113. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  120. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
  127. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +6 -1
  152. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +6 -1
  176. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +6 -1
  178. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  192. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  194. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +224 -0
  202. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  206. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
  214. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
  215. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
  216. data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
  217. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
  222. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  227. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  230. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +259 -0
  233. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  236. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
  242. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  243. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  244. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  245. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
  249. data/lib/klaviyo-api-sdk/models/profile_location.rb +15 -5
  250. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  252. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
  253. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +6 -1
  255. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +6 -1
  256. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  261. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +12 -2
  278. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
  284. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  287. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  288. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +6 -1
  291. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +6 -1
  294. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +224 -0
  299. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +5 -33
  303. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  304. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +6 -1
  305. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
  306. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  307. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +6 -1
  308. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
  309. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  310. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
  312. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  313. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  314. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  316. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  317. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  318. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  320. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  321. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
  323. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  324. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  325. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  328. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
  329. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
  330. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  332. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
  333. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  334. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  335. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  336. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  337. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
  339. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  340. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  342. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
  343. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  344. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  345. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  349. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  351. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  353. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  354. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  356. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  360. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  363. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  364. data/lib/klaviyo-api-sdk/version.rb +1 -1
  365. data/lib/klaviyo-api-sdk.rb +4 -1
  366. data/spec/api/accounts_api_spec.rb +3 -3
  367. data/spec/api/campaigns_api_spec.rb +26 -26
  368. data/spec/api/catalogs_api_spec.rb +87 -87
  369. data/spec/api/coupons_api_spec.rb +23 -17
  370. data/spec/api/data_privacy_api_spec.rb +1 -1
  371. data/spec/api/events_api_spec.rb +17 -17
  372. data/spec/api/flows_api_spec.rb +39 -39
  373. data/spec/api/images_api_spec.rb +8 -8
  374. data/spec/api/lists_api_spec.rb +21 -21
  375. data/spec/api/metrics_api_spec.rb +5 -5
  376. data/spec/api/profiles_api_spec.rb +15 -15
  377. data/spec/api/segments_api_spec.rb +19 -19
  378. data/spec/api/tags_api_spec.rb +17 -17
  379. data/spec/api/templates_api_spec.rb +6 -6
  380. data/spec/api_client_spec.rb +1 -1
  381. data/spec/configuration_spec.rb +1 -1
  382. data/spec/models/audiences_sub_object_spec.rb +1 -1
  383. data/spec/models/back_in_stock_subscription_enum_spec.rb +1 -1
  384. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +1 -1
  385. data/spec/models/campaign_clone_query_resource_object_spec.rb +1 -1
  386. data/spec/models/campaign_clone_query_spec.rb +1 -1
  387. data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +1 -1
  388. data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +1 -1
  389. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +1 -1
  390. data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +1 -1
  391. data/spec/models/campaign_create_query_resource_object_spec.rb +1 -1
  392. data/spec/models/campaign_create_query_spec.rb +1 -1
  393. data/spec/models/campaign_enum_spec.rb +1 -1
  394. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +1 -1
  395. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +1 -1
  396. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +1 -1
  397. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +1 -1
  398. data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
  399. data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +1 -1
  400. data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +1 -1
  401. data/spec/models/campaign_message_create_query_resource_object_spec.rb +1 -1
  402. data/spec/models/campaign_message_enum_spec.rb +1 -1
  403. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +1 -1
  404. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +1 -1
  405. data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
  406. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +1 -1
  407. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +1 -1
  408. data/spec/models/campaign_partial_update_query_spec.rb +1 -1
  409. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +1 -1
  410. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +1 -1
  411. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +1 -1
  412. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +1 -1
  413. data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
  414. data/spec/models/campaign_send_job_enum_spec.rb +1 -1
  415. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +1 -1
  416. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +1 -1
  417. data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
  418. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
  419. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
  420. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
  421. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  422. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  423. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
  424. data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
  425. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +1 -1
  426. data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +1 -1
  427. data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +1 -1
  428. data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
  429. data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
  430. data/spec/models/catalog_category_create_query_spec.rb +1 -1
  431. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  432. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  433. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
  434. data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
  435. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
  436. data/spec/models/catalog_category_enum_spec.rb +1 -1
  437. data/spec/models/catalog_category_item_op_spec.rb +1 -1
  438. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  439. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  440. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
  441. data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
  442. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +1 -1
  443. data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
  444. data/spec/models/catalog_category_update_query_spec.rb +1 -1
  445. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
  446. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
  447. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
  448. data/spec/models/catalog_item_category_op_spec.rb +1 -1
  449. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  450. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  451. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
  452. data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
  453. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +1 -1
  454. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
  455. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
  456. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
  457. data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
  458. data/spec/models/catalog_item_create_query_spec.rb +1 -1
  459. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  460. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  461. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
  462. data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
  463. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
  464. data/spec/models/catalog_item_enum_spec.rb +1 -1
  465. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  466. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  467. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
  468. data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
  469. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +1 -1
  470. data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
  471. data/spec/models/catalog_item_update_query_spec.rb +1 -1
  472. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
  473. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
  474. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
  475. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  476. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  477. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
  478. data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
  479. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +1 -1
  480. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
  481. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
  482. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
  483. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
  484. data/spec/models/catalog_variant_create_query_spec.rb +1 -1
  485. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  486. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  487. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
  488. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
  489. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
  490. data/spec/models/catalog_variant_enum_spec.rb +1 -1
  491. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  492. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  493. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
  494. data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
  495. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +1 -1
  496. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
  497. data/spec/models/catalog_variant_update_query_spec.rb +1 -1
  498. data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +1 -1
  499. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +1 -1
  500. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  501. data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +1 -1
  502. data/spec/models/coupon_code_create_job_create_query_spec.rb +1 -1
  503. data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +1 -1
  504. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +1 -1
  505. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +1 -1
  506. data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +1 -1
  507. data/spec/models/coupon_code_create_query_resource_object_spec.rb +1 -1
  508. data/spec/models/coupon_code_create_query_spec.rb +1 -1
  509. data/spec/models/coupon_code_enum_spec.rb +1 -1
  510. data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +1 -1
  511. data/spec/models/coupon_code_update_query_resource_object_spec.rb +1 -1
  512. data/spec/models/coupon_code_update_query_spec.rb +1 -1
  513. data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +1 -1
  514. data/spec/models/coupon_create_query_resource_object_spec.rb +1 -1
  515. data/spec/models/coupon_create_query_spec.rb +1 -1
  516. data/spec/models/coupon_enum_spec.rb +1 -1
  517. data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +1 -1
  518. data/spec/models/coupon_update_query_resource_object_spec.rb +1 -1
  519. data/spec/models/coupon_update_query_spec.rb +1 -1
  520. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +1 -1
  521. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
  522. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
  523. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
  524. data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
  525. data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
  526. data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
  527. data/spec/models/device_metadata_spec.rb +1 -1
  528. data/spec/models/email_content_sub_object_spec.rb +1 -1
  529. data/spec/models/email_send_options_sub_object_spec.rb +1 -1
  530. data/spec/models/email_subscription_parameters_spec.rb +34 -0
  531. data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
  532. data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +1 -1
  533. data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +1 -1
  534. data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +1 -1
  535. data/spec/models/event_create_query_v2_resource_object_spec.rb +1 -1
  536. data/spec/models/event_create_query_v2_spec.rb +1 -1
  537. data/spec/models/event_enum_spec.rb +1 -1
  538. data/spec/models/flow_enum_spec.rb +1 -1
  539. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +1 -1
  540. data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
  541. data/spec/models/flow_update_query_spec.rb +1 -1
  542. data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
  543. data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
  544. data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
  545. data/spec/models/image_create_query_resource_object_attributes_spec.rb +1 -1
  546. data/spec/models/image_create_query_resource_object_spec.rb +1 -1
  547. data/spec/models/image_create_query_spec.rb +1 -1
  548. data/spec/models/image_enum_spec.rb +1 -1
  549. data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +1 -1
  550. data/spec/models/image_partial_update_query_resource_object_spec.rb +1 -1
  551. data/spec/models/image_partial_update_query_spec.rb +1 -1
  552. data/spec/models/list_create_query_resource_object_attributes_spec.rb +1 -1
  553. data/spec/models/list_create_query_resource_object_spec.rb +1 -1
  554. data/spec/models/list_create_query_spec.rb +1 -1
  555. data/spec/models/list_enum_spec.rb +1 -1
  556. data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
  557. data/spec/models/list_members_add_query_spec.rb +1 -1
  558. data/spec/models/list_members_delete_query_spec.rb +1 -1
  559. data/spec/models/list_partial_update_query_resource_object_spec.rb +1 -1
  560. data/spec/models/list_partial_update_query_spec.rb +1 -1
  561. data/spec/models/marketing_subscription_parameters_spec.rb +38 -0
  562. data/spec/models/metric_aggregate_enum_spec.rb +1 -1
  563. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +1 -1
  564. data/spec/models/metric_aggregate_query_resource_object_spec.rb +1 -1
  565. data/spec/models/metric_aggregate_query_spec.rb +1 -1
  566. data/spec/models/metric_create_query_resource_object_attributes_spec.rb +1 -1
  567. data/spec/models/metric_create_query_resource_object_spec.rb +1 -1
  568. data/spec/models/metric_enum_spec.rb +1 -1
  569. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +1 -1
  570. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +1 -1
  571. data/spec/models/onsite_profile_meta_spec.rb +1 -1
  572. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +1 -1
  573. data/spec/models/profile_create_query_resource_object_spec.rb +1 -1
  574. data/spec/models/profile_create_query_spec.rb +1 -1
  575. data/spec/models/profile_enum_spec.rb +1 -1
  576. data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +1 -1
  577. data/spec/models/profile_identifier_dto_resource_object_spec.rb +1 -1
  578. data/spec/models/profile_location_latitude_spec.rb +1 -1
  579. data/spec/models/profile_location_longitude_spec.rb +1 -1
  580. data/spec/models/profile_location_spec.rb +7 -1
  581. data/spec/models/profile_merge_enum_spec.rb +1 -1
  582. data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +1 -1
  583. data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +1 -1
  584. data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +1 -1
  585. data/spec/models/profile_merge_query_resource_object_spec.rb +1 -1
  586. data/spec/models/profile_merge_query_spec.rb +1 -1
  587. data/spec/models/profile_meta_patch_properties_spec.rb +1 -1
  588. data/spec/models/profile_meta_patch_properties_unset_spec.rb +1 -1
  589. data/spec/models/profile_meta_spec.rb +1 -1
  590. data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +1 -1
  591. data/spec/models/profile_partial_update_query_resource_object_spec.rb +1 -1
  592. data/spec/models/profile_partial_update_query_spec.rb +1 -1
  593. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +1 -1
  594. data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +1 -1
  595. data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +1 -1
  596. data/spec/models/profile_subscription_create_query_resource_object_spec.rb +1 -1
  597. data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +1 -1
  598. data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +1 -1
  599. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +1 -1
  600. data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +1 -1
  601. data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +1 -1
  602. data/spec/models/profile_suppression_create_query_resource_object_spec.rb +1 -1
  603. data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +1 -1
  604. data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +1 -1
  605. data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +7 -1
  606. data/spec/models/profile_upsert_query_resource_object_spec.rb +1 -1
  607. data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +1 -1
  608. data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +1 -1
  609. data/spec/models/push_token_create_query_resource_object_spec.rb +1 -1
  610. data/spec/models/push_token_create_query_spec.rb +1 -1
  611. data/spec/models/push_token_enum_spec.rb +1 -1
  612. data/spec/models/render_options_sub_object_spec.rb +1 -1
  613. data/spec/models/segment_enum_spec.rb +1 -1
  614. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +1 -1
  615. data/spec/models/segment_partial_update_query_resource_object_spec.rb +1 -1
  616. data/spec/models/segment_partial_update_query_spec.rb +1 -1
  617. data/spec/models/send_strategy_sub_object_spec.rb +1 -1
  618. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +1 -1
  619. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +1 -1
  620. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +1 -1
  621. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +1 -1
  622. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +1 -1
  623. data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +1 -1
  624. data/spec/models/server_bis_subscription_create_query_spec.rb +1 -1
  625. data/spec/models/sms_content_sub_object_create_spec.rb +1 -1
  626. data/spec/models/sms_send_options_sub_object_spec.rb +1 -1
  627. data/spec/models/sms_subscription_parameters_spec.rb +34 -0
  628. data/spec/models/sms_tracking_options_sub_object_spec.rb +1 -1
  629. data/spec/models/static_schedule_options_spec.rb +1 -1
  630. data/spec/models/sto_schedule_options_spec.rb +1 -1
  631. data/spec/models/subscription_channels_spec.rb +1 -9
  632. data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  633. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  634. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  635. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  636. data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +1 -1
  637. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +1 -1
  638. data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
  639. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  640. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  641. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  642. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  643. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +1 -1
  644. data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +1 -1
  645. data/spec/models/subscription_delete_job_create_query_spec.rb +1 -1
  646. data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  647. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  648. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +1 -1
  649. data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
  650. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  651. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  652. data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +1 -1
  653. data/spec/models/suppression_delete_job_create_query_spec.rb +1 -1
  654. data/spec/models/tag_campaign_op_data_inner_spec.rb +1 -1
  655. data/spec/models/tag_campaign_op_spec.rb +1 -1
  656. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +1 -1
  657. data/spec/models/tag_create_query_resource_object_relationships_spec.rb +1 -1
  658. data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +1 -1
  659. data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +1 -1
  660. data/spec/models/tag_create_query_resource_object_spec.rb +1 -1
  661. data/spec/models/tag_create_query_spec.rb +1 -1
  662. data/spec/models/tag_enum_spec.rb +1 -1
  663. data/spec/models/tag_flow_op_data_inner_spec.rb +1 -1
  664. data/spec/models/tag_flow_op_spec.rb +1 -1
  665. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +1 -1
  666. data/spec/models/tag_group_create_query_resource_object_spec.rb +1 -1
  667. data/spec/models/tag_group_create_query_spec.rb +1 -1
  668. data/spec/models/tag_group_enum_spec.rb +1 -1
  669. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +1 -1
  670. data/spec/models/tag_group_update_query_resource_object_spec.rb +1 -1
  671. data/spec/models/tag_group_update_query_spec.rb +1 -1
  672. data/spec/models/tag_list_op_data_inner_spec.rb +1 -1
  673. data/spec/models/tag_list_op_spec.rb +1 -1
  674. data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
  675. data/spec/models/tag_segment_op_spec.rb +1 -1
  676. data/spec/models/tag_update_query_resource_object_spec.rb +1 -1
  677. data/spec/models/tag_update_query_spec.rb +1 -1
  678. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +1 -1
  679. data/spec/models/template_clone_query_resource_object_spec.rb +1 -1
  680. data/spec/models/template_clone_query_spec.rb +1 -1
  681. data/spec/models/template_create_query_resource_object_attributes_spec.rb +1 -1
  682. data/spec/models/template_create_query_resource_object_spec.rb +1 -1
  683. data/spec/models/template_create_query_spec.rb +1 -1
  684. data/spec/models/template_enum_spec.rb +1 -1
  685. data/spec/models/template_render_query_resource_object_attributes_spec.rb +1 -1
  686. data/spec/models/template_render_query_resource_object_spec.rb +1 -1
  687. data/spec/models/template_render_query_spec.rb +1 -1
  688. data/spec/models/template_update_query_resource_object_attributes_spec.rb +1 -1
  689. data/spec/models/template_update_query_resource_object_spec.rb +1 -1
  690. data/spec/models/template_update_query_spec.rb +1 -1
  691. data/spec/models/throttled_schedule_options_spec.rb +1 -1
  692. data/spec/models/utm_params_sub_object_spec.rb +1 -1
  693. data/spec/spec_helper.rb +1 -1
  694. metadata +11 -2
data/docs/SegmentsApi.md CHANGED
@@ -19,7 +19,7 @@ All URIs are relative to *https://a.klaviyo.com*
19
19
 
20
20
  Get Segment
21
21
 
22
- Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/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-09-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read`
22
+ Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read`
23
23
 
24
24
  ### Examples
25
25
 
@@ -38,9 +38,9 @@ api_instance = KlaviyoAPI::SegmentsApi.new
38
38
  id = 'id_example' # String |
39
39
  opts = {
40
40
  additional_fields_segment: ['profile_count'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'profile_count'
41
- fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
42
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
43
- include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
41
+ fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
42
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
43
+ include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
44
44
  }
45
45
 
46
46
  begin
@@ -76,9 +76,9 @@ end
76
76
  | ---- | ---- | ----------- | ----- |
77
77
  | **id** | **String** | | |
78
78
  | **additional_fields_segment** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39; | [optional] |
79
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
80
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
81
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
79
+ | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
80
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
81
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
82
82
 
83
83
  ### Return type
84
84
 
@@ -118,12 +118,12 @@ end
118
118
  api_instance = KlaviyoAPI::SegmentsApi.new
119
119
  id = 'id_example' # String |
120
120
  opts = {
121
- additional_fields_profile: ['predictive_analytics'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
122
- fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
123
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
124
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
121
+ additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
122
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
123
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
124
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
125
125
  page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
126
- sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
126
+ sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
127
127
  }
128
128
 
129
129
  begin
@@ -158,12 +158,12 @@ end
158
158
  | Name | Type | Description | Notes |
159
159
  | ---- | ---- | ----------- | ----- |
160
160
  | **id** | **String** | | |
161
- | **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39; | [optional] |
162
- | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
163
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&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;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
164
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
161
+ | **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39; | [optional] |
162
+ | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
163
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;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;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
164
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
165
165
  | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
166
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
166
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
167
167
 
168
168
  ### Return type
169
169
 
@@ -203,10 +203,10 @@ end
203
203
  api_instance = KlaviyoAPI::SegmentsApi.new
204
204
  id = 'id_example' # String |
205
205
  opts = {
206
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
207
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
206
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
207
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
208
208
  page_size: 56, # Integer | Default: 20. Min: 1. Max: 1000.
209
- sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
209
+ sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
210
210
  }
211
211
 
212
212
  begin
@@ -241,10 +241,10 @@ end
241
241
  | Name | Type | Description | Notes |
242
242
  | ---- | ---- | ----------- | ----- |
243
243
  | **id** | **String** | | |
244
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&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;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
245
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
244
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;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;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
245
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
246
246
  | **page_size** | **Integer** | Default: 20. Min: 1. Max: 1000. | [optional][default to 20] |
247
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
247
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
248
248
 
249
249
  ### Return type
250
250
 
@@ -355,7 +355,7 @@ end
355
355
  api_instance = KlaviyoAPI::SegmentsApi.new
356
356
  id = 'id_example' # String |
357
357
  opts = {
358
- fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
358
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
359
359
  }
360
360
 
361
361
  begin
@@ -390,7 +390,7 @@ end
390
390
  | Name | Type | Description | Notes |
391
391
  | ---- | ---- | ----------- | ----- |
392
392
  | **id** | **String** | | |
393
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
393
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
394
394
 
395
395
  ### Return type
396
396
 
@@ -429,11 +429,11 @@ end
429
429
 
430
430
  api_instance = KlaviyoAPI::SegmentsApi.new
431
431
  opts = {
432
- fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
433
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
434
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
435
- include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
436
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
432
+ fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
433
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
434
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
435
+ include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
436
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
437
437
  }
438
438
 
439
439
  begin
@@ -467,11 +467,11 @@ end
467
467
 
468
468
  | Name | Type | Description | Notes |
469
469
  | ---- | ---- | ----------- | ----- |
470
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
471
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
472
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
473
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
474
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
470
+ | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
471
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
472
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
473
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
474
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
475
475
 
476
476
  ### Return type
477
477
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**BackInStockSubscriptionEnum**](BackInStockSubscriptionEnum.md) | | |
8
8
  | **attributes** | [**ServerBISSubscriptionCreateQueryResourceObjectAttributes**](ServerBISSubscriptionCreateQueryResourceObjectAttributes.md) | | |
9
- | **relationships** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationships**](ServerBISSubscriptionCreateQueryResourceObjectRelationships.md) | | [optional] |
9
+ | **relationships** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationships**](ServerBISSubscriptionCreateQueryResourceObjectRelationships.md) | | |
10
10
 
11
11
  ## Example
12
12
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **variant** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant**](ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md) | | [optional] |
7
+ | **variant** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant**](ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md) | | |
8
8
 
9
9
  ## Example
10
10
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **Array&lt;String&gt;** | The communication types to subscribe to on the \&quot;EMAIL\&quot; Channel. Currently supports \&quot;MARKETING\&quot;. | [optional] |
8
- | **sms** | **Array&lt;String&gt;** | The communication types to subscribe to on the \&quot;SMS\&quot; Channel. Currently supports \&quot;MARKETING\&quot;. | [optional] |
7
+ | **email** | [**EmailSubscriptionParameters**](EmailSubscriptionParameters.md) | | [optional] |
8
+ | **sms** | [**SMSSubscriptionParameters**](SMSSubscriptionParameters.md) | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,8 +13,8 @@
13
13
  require 'klaviyo-api-sdk'
14
14
 
15
15
  instance = KlaviyoAPI::SubscriptionChannels.new(
16
- email: [&quot;MARKETING&quot;],
17
- sms: [&quot;MARKETING&quot;]
16
+ email: null,
17
+ sms: null
18
18
  )
19
19
  ```
20
20
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**ProfileSubscriptionBulkCreateJobEnum**](ProfileSubscriptionBulkCreateJobEnum.md) | | |
8
8
  | **attributes** | [**SubscriptionCreateJobCreateQueryResourceObjectAttributes**](SubscriptionCreateJobCreateQueryResourceObjectAttributes.md) | | |
9
- | **relationships** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationships**](SubscriptionCreateJobCreateQueryResourceObjectRelationships.md) | | [optional] |
9
+ | **relationships** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationships**](SubscriptionCreateJobCreateQueryResourceObjectRelationships.md) | | |
10
10
 
11
11
  ## Example
12
12
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **list** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList**](SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md) | | [optional] |
7
+ | **list** | [**SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList**](SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md) | | |
8
8
 
9
9
  ## Example
10
10
 
data/docs/TagsApi.md CHANGED
@@ -915,9 +915,9 @@ end
915
915
  api_instance = KlaviyoAPI::TagsApi.new
916
916
  id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
917
917
  opts = {
918
- fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
919
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
920
- include: ['tag-group'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
918
+ fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
919
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
920
+ include: ['tag-group'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
921
921
  }
922
922
 
923
923
  begin
@@ -952,9 +952,9 @@ end
952
952
  | Name | Type | Description | Notes |
953
953
  | ---- | ---- | ----------- | ----- |
954
954
  | **id** | **String** | The Tag ID | |
955
- | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
956
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
957
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
955
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
956
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
957
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
958
958
 
959
959
  ### Return type
960
960
 
@@ -994,7 +994,7 @@ end
994
994
  api_instance = KlaviyoAPI::TagsApi.new
995
995
  id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
996
996
  opts = {
997
- fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
997
+ fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
998
998
  }
999
999
 
1000
1000
  begin
@@ -1029,7 +1029,7 @@ end
1029
1029
  | Name | Type | Description | Notes |
1030
1030
  | ---- | ---- | ----------- | ----- |
1031
1031
  | **id** | **String** | The Tag Group ID | |
1032
- | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1032
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
1033
1033
 
1034
1034
  ### Return type
1035
1035
 
@@ -1140,7 +1140,7 @@ end
1140
1140
  api_instance = KlaviyoAPI::TagsApi.new
1141
1141
  id = 'id_example' # String |
1142
1142
  opts = {
1143
- fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1143
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
1144
1144
  }
1145
1145
 
1146
1146
  begin
@@ -1175,7 +1175,7 @@ end
1175
1175
  | Name | Type | Description | Notes |
1176
1176
  | ---- | ---- | ----------- | ----- |
1177
1177
  | **id** | **String** | | |
1178
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1178
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
1179
1179
 
1180
1180
  ### Return type
1181
1181
 
@@ -1214,10 +1214,10 @@ end
1214
1214
 
1215
1215
  api_instance = KlaviyoAPI::TagsApi.new
1216
1216
  opts = {
1217
- fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1218
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
1219
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
1220
- sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
1217
+ fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
1218
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
1219
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
1220
+ sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
1221
1221
  }
1222
1222
 
1223
1223
  begin
@@ -1251,10 +1251,10 @@ end
1251
1251
 
1252
1252
  | Name | Type | Description | Notes |
1253
1253
  | ---- | ---- | ----------- | ----- |
1254
- | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1255
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60; | [optional] |
1256
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
1257
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
1254
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
1255
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60; | [optional] |
1256
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
1257
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
1258
1258
 
1259
1259
  ### Return type
1260
1260
 
@@ -1649,7 +1649,7 @@ end
1649
1649
  api_instance = KlaviyoAPI::TagsApi.new
1650
1650
  id = 'id_example' # String |
1651
1651
  opts = {
1652
- fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1652
+ fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
1653
1653
  }
1654
1654
 
1655
1655
  begin
@@ -1684,7 +1684,7 @@ end
1684
1684
  | Name | Type | Description | Notes |
1685
1685
  | ---- | ---- | ----------- | ----- |
1686
1686
  | **id** | **String** | | |
1687
- | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1687
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
1688
1688
 
1689
1689
  ### Return type
1690
1690
 
@@ -1723,12 +1723,12 @@ end
1723
1723
 
1724
1724
  api_instance = KlaviyoAPI::TagsApi.new
1725
1725
  opts = {
1726
- fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1727
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1728
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
1729
- include: ['tag-group'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
1730
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
1731
- sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
1726
+ fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
1727
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
1728
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
1729
+ include: ['tag-group'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
1730
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
1731
+ sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
1732
1732
  }
1733
1733
 
1734
1734
  begin
@@ -1762,12 +1762,12 @@ end
1762
1762
 
1763
1763
  | Name | Type | Description | Notes |
1764
1764
  | ---- | ---- | ----------- | ----- |
1765
- | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1766
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1767
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60; | [optional] |
1768
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
1769
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
1770
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
1765
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
1766
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
1767
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60; | [optional] |
1768
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
1769
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
1770
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
1771
1771
 
1772
1772
  ### Return type
1773
1773
 
data/docs/TemplatesApi.md CHANGED
@@ -320,7 +320,7 @@ end
320
320
  api_instance = KlaviyoAPI::TemplatesApi.new
321
321
  id = 'id_example' # String | The ID of template
322
322
  opts = {
323
- fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
323
+ fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
324
324
  }
325
325
 
326
326
  begin
@@ -355,7 +355,7 @@ end
355
355
  | Name | Type | Description | Notes |
356
356
  | ---- | ---- | ----------- | ----- |
357
357
  | **id** | **String** | The ID of template | |
358
- | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
358
+ | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
359
359
 
360
360
  ### Return type
361
361
 
@@ -394,10 +394,10 @@ end
394
394
 
395
395
  api_instance = KlaviyoAPI::TemplatesApi.new
396
396
  opts = {
397
- fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
398
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
399
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
400
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
397
+ fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
398
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
399
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
400
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
401
401
  }
402
402
 
403
403
  begin
@@ -431,10 +431,10 @@ end
431
431
 
432
432
  | Name | Type | Description | Notes |
433
433
  | ---- | ---- | ----------- | ----- |
434
- | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
435
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
436
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
437
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
434
+ | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
435
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
436
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
437
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
438
438
 
439
439
  ### Return type
440
440
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
7
7
 
8
- The version of the OpenAPI document: 2023-09-15
8
+ The version of the OpenAPI document: 2023-10-15
9
9
  Contact: developers@klaviyo.com
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.2.1
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
17
17
 
18
18
  Gem::Specification.new do |s|
19
19
  s.name = "klaviyo-api-sdk"
20
- s.version = "4.2.0"
20
+ s.version = "5.0.0"
21
21
  s.authors = ['Klaviyo Team']
22
22
  s.email = ['libraries@klaviyo.com']
23
23
  s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
@@ -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-09-15
6
+ The version of the OpenAPI document: 2023-10-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -23,7 +23,7 @@ module KlaviyoAPI
23
23
  # Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
24
24
  # @param id [String] The ID of the account
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
26
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
27
27
  # @return [Hash<String, Object>]
28
28
  def get_account(id, opts = {})
29
29
  data, _status_code, _headers = get_account_with_http_info(id, opts)
@@ -34,7 +34,7 @@ module KlaviyoAPI
34
34
  # Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;accounts:read&#x60;
35
35
  # @param id [String] The ID of the account
36
36
  # @param [Hash] opts the optional parameters
37
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
37
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
38
38
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
39
39
  def get_account_with_http_info(id, opts = {})
40
40
  if @api_client.config.debugging
@@ -58,7 +58,7 @@ module KlaviyoAPI
58
58
  # header parameters
59
59
  header_params = opts[:header_params] || {}
60
60
  # klaviyo api revision
61
- header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
61
+ header_params['revision'] = ENV['API_REVISION'] || "2023-10-15"
62
62
  # HTTP header 'Accept' (if needed)
63
63
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
64
 
@@ -94,7 +94,7 @@ module KlaviyoAPI
94
94
  # Get Accounts
95
95
  # Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
96
96
  # @param [Hash] opts the optional parameters
97
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
97
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
98
98
  # @return [Hash<String, Object>]
99
99
  def get_accounts(opts = {})
100
100
  data, _status_code, _headers = get_accounts_with_http_info(opts)
@@ -104,7 +104,7 @@ module KlaviyoAPI
104
104
  # Get Accounts
105
105
  # Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;accounts:read&#x60;
106
106
  # @param [Hash] opts the optional parameters
107
- # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
107
+ # @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
108
108
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
109
109
  def get_accounts_with_http_info(opts = {})
110
110
  if @api_client.config.debugging
@@ -124,7 +124,7 @@ module KlaviyoAPI
124
124
  # header parameters
125
125
  header_params = opts[:header_params] || {}
126
126
  # klaviyo api revision
127
- header_params['revision'] = ENV['API_REVISION'] || "2023-09-15"
127
+ header_params['revision'] = ENV['API_REVISION'] || "2023-10-15"
128
128
  # HTTP header 'Accept' (if needed)
129
129
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
130
130