klaviyo-api-sdk 1.0.1 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (530) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/README.md +335 -119
  4. data/docs/AudiencesSubObject.md +20 -0
  5. data/docs/CampaignCloneQuery.md +18 -0
  6. data/docs/CampaignCloneQueryAsSubResource.md +20 -0
  7. data/docs/CampaignCloneQueryAsSubResourceAttributes.md +20 -0
  8. data/docs/CampaignCreateQuery.md +18 -0
  9. data/docs/CampaignCreateQueryAsSubResource.md +20 -0
  10. data/docs/CampaignCreateQueryAsSubResourceAttributes.md +28 -0
  11. data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
  12. data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +20 -0
  13. data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +20 -0
  14. data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
  15. data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +22 -0
  16. data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +20 -0
  17. data/docs/CampaignPartialUpdateQuery.md +18 -0
  18. data/docs/CampaignPartialUpdateQueryAsSubResource.md +22 -0
  19. data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +26 -0
  20. data/docs/CampaignSendJobCreateQuery.md +18 -0
  21. data/docs/CampaignSendJobCreateQueryAsSubResource.md +20 -0
  22. data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +18 -0
  23. data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
  24. data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +22 -0
  25. data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  26. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +2 -2
  27. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +1 -1
  28. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +1 -1
  29. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +4 -4
  30. data/docs/CatalogItemDeleteQueryAsSubResource.md +1 -1
  31. data/docs/CatalogItemUpdateQueryAsSubResource.md +1 -1
  32. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +4 -4
  33. data/docs/CatalogVariantDeleteQueryAsSubResource.md +1 -1
  34. data/docs/CatalogVariantUpdateQueryAsSubResource.md +1 -1
  35. data/docs/CatalogsApi.md +202 -202
  36. data/docs/ClientApi.md +11 -11
  37. data/docs/ContentSubObject.md +28 -0
  38. data/docs/DataPrivacyApi.md +78 -0
  39. data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
  40. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +20 -0
  41. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +22 -0
  42. data/docs/ErrorSource.md +2 -2
  43. data/docs/EventCreateQueryAsSubResourceAttributes.md +8 -8
  44. data/docs/EventsApi.md +36 -36
  45. data/docs/FlowsApi.md +139 -69
  46. data/docs/IncludedCategories.md +1 -1
  47. data/docs/IncludedMetrics.md +1 -1
  48. data/docs/IncludedMetricsAttributes.md +4 -4
  49. data/docs/ListsApi.md +101 -25
  50. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +15 -15
  51. data/docs/MetricAggregateRowDTO.md +2 -2
  52. data/docs/MetricCreateQuery.md +3 -3
  53. data/docs/MetricsApi.md +14 -14
  54. data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +10 -10
  55. data/docs/ProfilesApi.md +31 -31
  56. data/docs/SegmentsApi.md +102 -23
  57. data/docs/SendOptionsSubObject.md +20 -0
  58. data/docs/SendStrategySubObject.md +22 -0
  59. data/docs/SendTimeSubObject.md +20 -0
  60. data/docs/StaticScheduleOptions.md +22 -0
  61. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  62. data/docs/Suppression.md +1 -1
  63. data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  64. data/docs/TagCreateQuery.md +18 -0
  65. data/docs/TagCreateQueryAsSubResource.md +20 -0
  66. data/docs/TagCreateQueryAsSubResourceAttributes.md +20 -0
  67. data/docs/TagGroupCreateQuery.md +18 -0
  68. data/docs/TagGroupCreateQueryAsSubResource.md +20 -0
  69. data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +20 -0
  70. data/docs/TagGroupUpdateQuery.md +18 -0
  71. data/docs/TagGroupUpdateQueryAsSubResource.md +22 -0
  72. data/docs/{V2TemplateRenderQueryAsSubResourceAttributes.md → TagGroupUpdateQueryAsSubResourceAttributes.md} +4 -4
  73. data/docs/TagSegmentOp.md +18 -0
  74. data/docs/{ListDeleteQueryAsSubResource.md → TagSegmentOpDataInner.md} +2 -2
  75. data/docs/TagUpdateQuery.md +18 -0
  76. data/docs/TagUpdateQueryAsSubResource.md +22 -0
  77. data/docs/TagUpdateQueryAsSubResourceAttributes.md +18 -0
  78. data/docs/TagsApi.md +1205 -0
  79. data/docs/TemplateCloneQueryAsSubResource.md +2 -0
  80. data/docs/TemplateCloneQueryAsSubResourceAttributes.md +5 -3
  81. data/docs/TemplateCreateQueryAsSubResourceAttributes.md +14 -8
  82. data/docs/TemplateRenderQuery.md +18 -0
  83. data/docs/TemplateRenderQueryAsSubResource.md +20 -0
  84. data/docs/TemplateRenderQueryAsSubResourceAttributes.md +22 -0
  85. data/docs/TemplateUpdateQueryAsSubResource.md +1 -1
  86. data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +13 -7
  87. data/docs/TemplatesApi.md +40 -44
  88. data/docs/ThrottledScheduleOptions.md +20 -0
  89. data/docs/TrackingOptionsSubObject.md +24 -0
  90. data/docs/UTMParamsSubObject.md +20 -0
  91. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  92. data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +1 -1
  93. data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
  94. data/docs/V2TemplateRenderQueryAsSubResource.md +2 -4
  95. data/klaviyo-api-sdk.gemspec +3 -3
  96. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +277 -277
  97. data/lib/klaviyo-api-sdk/api/client_api.rb +12 -12
  98. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +92 -0
  99. data/lib/klaviyo-api-sdk/api/events_api.rb +46 -46
  100. data/lib/klaviyo-api-sdk/api/flows_api.rb +155 -93
  101. data/lib/klaviyo-api-sdk/api/lists_api.rb +114 -42
  102. data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
  103. data/lib/klaviyo-api-sdk/api/profiles_api.rb +51 -51
  104. data/lib/klaviyo-api-sdk/api/segments_api.rb +112 -33
  105. data/lib/klaviyo-api-sdk/api/tags_api.rb +1216 -0
  106. data/lib/klaviyo-api-sdk/api/templates_api.rb +57 -69
  107. data/lib/klaviyo-api-sdk/api_client.rb +3 -3
  108. data/lib/klaviyo-api-sdk/api_error.rb +2 -2
  109. data/lib/klaviyo-api-sdk/configuration.rb +2 -2
  110. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +234 -0
  111. data/lib/klaviyo-api-sdk/models/{v2_template_render_query.rb → campaign_clone_query.rb} +6 -6
  112. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +272 -0
  113. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +235 -0
  114. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +224 -0
  115. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +272 -0
  116. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +291 -0
  117. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +224 -0
  118. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +272 -0
  119. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +240 -0
  120. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +224 -0
  121. data/lib/klaviyo-api-sdk/models/{included_profile.rb → campaign_message_partial_update_query_as_sub_resource.rb} +12 -25
  122. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +229 -0
  123. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +224 -0
  124. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +287 -0
  125. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +256 -0
  126. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +224 -0
  127. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +272 -0
  128. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +225 -0
  129. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +224 -0
  130. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +287 -0
  131. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +225 -0
  132. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
  133. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +2 -2
  134. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -2
  135. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
  136. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +2 -2
  137. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +4 -2
  138. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
  139. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +2 -2
  140. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
  141. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +3 -2
  142. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  143. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
  144. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +2 -2
  145. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -2
  146. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
  147. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +3 -2
  148. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -2
  149. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  150. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
  151. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +2 -2
  152. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -2
  153. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
  154. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +2 -2
  155. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +6 -2
  156. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +2 -2
  157. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +2 -2
  158. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +2 -2
  159. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
  160. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +2 -2
  161. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
  162. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +3 -2
  163. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
  164. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +2 -2
  165. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -2
  166. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
  167. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +3 -2
  168. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +2 -2
  169. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +2 -2
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -2
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +2 -2
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +6 -2
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +2 -2
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +2 -2
  178. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +2 -2
  179. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
  180. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +2 -2
  181. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
  182. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +3 -2
  183. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
  184. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +2 -2
  185. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -2
  186. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
  187. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +3 -2
  188. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +2 -2
  189. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +270 -0
  190. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +224 -0
  191. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +272 -0
  192. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +240 -0
  193. data/lib/klaviyo-api-sdk/models/email_message_content.rb +2 -2
  194. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +2 -2
  195. data/lib/klaviyo-api-sdk/models/error_source.rb +4 -2
  196. data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
  197. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +2 -2
  198. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +7 -2
  199. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
  200. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +2 -2
  201. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +2 -2
  202. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +2 -2
  203. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +2 -2
  204. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +2 -2
  205. data/lib/klaviyo-api-sdk/models/included_categories.rb +3 -2
  206. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +2 -2
  207. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +2 -2
  208. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +2 -2
  209. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +2 -2
  210. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +2 -2
  211. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +2 -2
  212. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +2 -2
  213. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +2 -2
  214. data/lib/klaviyo-api-sdk/models/included_flows.rb +2 -2
  215. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +2 -2
  216. data/lib/klaviyo-api-sdk/models/included_items.rb +2 -2
  217. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +2 -2
  218. data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -2
  219. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +2 -2
  220. data/lib/klaviyo-api-sdk/models/included_metrics.rb +3 -2
  221. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +6 -2
  222. data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -2
  223. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +2 -2
  224. data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
  225. data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -2
  226. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +2 -2
  227. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +2 -2
  228. data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
  229. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +2 -2
  230. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -2
  231. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +2 -2
  232. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -2
  233. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +2 -2
  234. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
  235. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -2
  236. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
  237. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +2 -2
  238. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +14 -8
  239. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +4 -2
  240. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +4 -2
  241. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
  242. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +2 -2
  243. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +2 -2
  244. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +2 -2
  245. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
  246. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +2 -2
  247. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +7 -2
  248. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +2 -2
  250. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +2 -2
  251. data/lib/klaviyo-api-sdk/models/profile_location.rb +2 -2
  252. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -2
  253. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
  254. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -2
  255. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
  256. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
  257. data/lib/klaviyo-api-sdk/models/send_options.rb +2 -2
  258. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +230 -0
  259. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +243 -0
  260. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +240 -0
  261. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +2 -2
  262. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +2 -2
  263. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +2 -2
  264. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +245 -0
  265. data/lib/klaviyo-api-sdk/models/subscription.rb +2 -2
  266. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
  267. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +2 -2
  268. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +5 -2
  269. data/lib/klaviyo-api-sdk/models/suppression.rb +3 -2
  270. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
  271. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +2 -2
  272. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +3 -2
  273. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +224 -0
  274. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +272 -0
  275. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +235 -0
  276. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +224 -0
  277. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +272 -0
  278. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +234 -0
  279. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +224 -0
  280. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +287 -0
  281. data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource_attributes.rb → tag_group_update_query_as_sub_resource_attributes.rb} +16 -15
  282. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +226 -0
  283. data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → tag_segment_op_data_inner.rb} +7 -7
  284. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +224 -0
  285. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +287 -0
  286. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +225 -0
  287. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
  288. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +14 -3
  289. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +20 -3
  290. data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
  291. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +2 -2
  292. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +7 -2
  293. data/lib/klaviyo-api-sdk/models/template_render_query.rb +224 -0
  294. data/lib/klaviyo-api-sdk/models/{template_delete_query_as_sub_resource.rb → template_render_query_as_sub_resource.rb} +15 -15
  295. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +252 -0
  296. data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
  297. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +3 -2
  298. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +6 -2
  299. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +240 -0
  300. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +252 -0
  301. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
  302. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +2 -2
  303. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +5 -7
  304. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
  305. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +3 -3
  306. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +227 -0
  307. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +2 -2
  308. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +240 -0
  309. data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +11 -62
  310. data/lib/klaviyo-api-sdk/version.rb +2 -2
  311. data/lib/klaviyo-api-sdk.rb +55 -7
  312. data/spec/api/catalogs_api_spec.rb +94 -94
  313. data/spec/api/client_api_spec.rb +5 -5
  314. data/spec/api/data_privacy_api_spec.rb +47 -0
  315. data/spec/api/events_api_spec.rb +19 -19
  316. data/spec/api/flows_api_spec.rb +44 -33
  317. data/spec/api/lists_api_spec.rb +28 -15
  318. data/spec/api/metrics_api_spec.rb +8 -8
  319. data/spec/api/profiles_api_spec.rb +21 -21
  320. data/spec/api/segments_api_spec.rb +24 -10
  321. data/spec/api/tags_api_spec.rb +245 -0
  322. data/spec/api/templates_api_spec.rb +18 -18
  323. data/spec/api_client_spec.rb +2 -2
  324. data/spec/configuration_spec.rb +2 -2
  325. data/spec/models/audiences_sub_object_spec.rb +40 -0
  326. data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +40 -0
  327. data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +44 -0
  328. data/spec/models/{v2_template_render_query_spec.rb → campaign_clone_query_spec.rb} +8 -8
  329. data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +64 -0
  330. data/spec/models/campaign_create_query_as_sub_resource_spec.rb +44 -0
  331. data/spec/models/campaign_create_query_spec.rb +34 -0
  332. data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +40 -0
  333. data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +44 -0
  334. data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
  335. data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +40 -0
  336. data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +50 -0
  337. data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
  338. data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +58 -0
  339. data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +50 -0
  340. data/spec/models/campaign_partial_update_query_spec.rb +34 -0
  341. data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  342. data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +44 -0
  343. data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
  344. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  345. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +50 -0
  346. data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
  347. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  348. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +2 -2
  349. data/spec/models/catalog_category_create_job_create_query_spec.rb +2 -2
  350. data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +2 -2
  351. data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +2 -2
  352. data/spec/models/catalog_category_create_query_spec.rb +2 -2
  353. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  354. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  355. data/spec/models/catalog_category_delete_job_create_query_spec.rb +2 -2
  356. data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +2 -2
  357. data/spec/models/catalog_category_item_op_spec.rb +2 -2
  358. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  359. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +2 -2
  360. data/spec/models/catalog_category_update_job_create_query_spec.rb +2 -2
  361. data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +2 -2
  362. data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +2 -2
  363. data/spec/models/catalog_category_update_query_spec.rb +2 -2
  364. data/spec/models/catalog_item_category_op_spec.rb +2 -2
  365. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  366. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +2 -2
  367. data/spec/models/catalog_item_create_job_create_query_spec.rb +2 -2
  368. data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +2 -2
  369. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +2 -2
  370. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +2 -2
  371. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +2 -2
  372. data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +2 -2
  373. data/spec/models/catalog_item_create_query_spec.rb +2 -2
  374. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  375. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  376. data/spec/models/catalog_item_delete_job_create_query_spec.rb +2 -2
  377. data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +2 -2
  378. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  379. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +2 -2
  380. data/spec/models/catalog_item_update_job_create_query_spec.rb +2 -2
  381. data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +2 -2
  382. data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +2 -2
  383. data/spec/models/catalog_item_update_query_spec.rb +2 -2
  384. data/spec/models/catalog_job_error_payload_spec.rb +2 -2
  385. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  386. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +2 -2
  387. data/spec/models/catalog_variant_create_job_create_query_spec.rb +2 -2
  388. data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +2 -2
  389. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +2 -2
  390. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +2 -2
  391. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +2 -2
  392. data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +2 -2
  393. data/spec/models/catalog_variant_create_query_spec.rb +2 -2
  394. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  395. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  396. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +2 -2
  397. data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +2 -2
  398. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  399. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +2 -2
  400. data/spec/models/catalog_variant_update_job_create_query_spec.rb +2 -2
  401. data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +2 -2
  402. data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +2 -2
  403. data/spec/models/catalog_variant_update_query_spec.rb +2 -2
  404. data/spec/models/content_sub_object_spec.rb +64 -0
  405. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +46 -0
  406. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +44 -0
  407. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
  408. data/spec/models/email_message_content_spec.rb +2 -2
  409. data/spec/models/email_tracking_options_spec.rb +2 -2
  410. data/spec/models/error_source_spec.rb +2 -2
  411. data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +2 -2
  412. data/spec/models/event_create_query_as_sub_resource_spec.rb +2 -2
  413. data/spec/models/event_create_query_spec.rb +2 -2
  414. data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +2 -2
  415. data/spec/models/flow_update_query_as_sub_resource_spec.rb +2 -2
  416. data/spec/models/flow_update_query_spec.rb +2 -2
  417. data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +2 -2
  418. data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +2 -2
  419. data/spec/models/get_catalog_items4_xx_response_spec.rb +2 -2
  420. data/spec/models/included_categories_attributes_spec.rb +2 -2
  421. data/spec/models/included_categories_spec.rb +2 -2
  422. data/spec/models/included_flow_action_spec.rb +2 -2
  423. data/spec/models/included_flow_actions_attributes_spec.rb +2 -2
  424. data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +2 -2
  425. data/spec/models/included_flow_actions_spec.rb +2 -2
  426. data/spec/models/included_flow_messages_attributes_content_spec.rb +2 -2
  427. data/spec/models/included_flow_messages_attributes_spec.rb +2 -2
  428. data/spec/models/included_flow_messages_spec.rb +2 -2
  429. data/spec/models/included_flows_attributes_spec.rb +2 -2
  430. data/spec/models/included_flows_spec.rb +2 -2
  431. data/spec/models/included_items_attributes_spec.rb +2 -2
  432. data/spec/models/included_items_spec.rb +2 -2
  433. data/spec/models/included_lists_attributes_spec.rb +2 -2
  434. data/spec/models/included_lists_spec.rb +2 -2
  435. data/spec/models/included_metrics_attributes_spec.rb +2 -2
  436. data/spec/models/included_metrics_spec.rb +2 -2
  437. data/spec/models/included_profiles_attributes_spec.rb +2 -2
  438. data/spec/models/included_profiles_spec.rb +2 -2
  439. data/spec/models/included_segments_spec.rb +2 -2
  440. data/spec/models/included_variants_attributes_spec.rb +2 -2
  441. data/spec/models/included_variants_links_spec.rb +2 -2
  442. data/spec/models/included_variants_spec.rb +2 -2
  443. data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +2 -2
  444. data/spec/models/list_create_query_as_sub_resource_spec.rb +2 -2
  445. data/spec/models/list_create_query_spec.rb +2 -2
  446. data/spec/models/list_members_add_query_data_inner_spec.rb +2 -2
  447. data/spec/models/list_members_add_query_spec.rb +2 -2
  448. data/spec/models/list_members_delete_query_spec.rb +2 -2
  449. data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +2 -2
  450. data/spec/models/list_partial_update_query_spec.rb +2 -2
  451. data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +2 -2
  452. data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +2 -2
  453. data/spec/models/metric_aggregate_query_spec.rb +2 -2
  454. data/spec/models/metric_aggregate_row_dto_spec.rb +2 -2
  455. data/spec/models/metric_create_query_spec.rb +2 -2
  456. data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +2 -2
  457. data/spec/models/onsite_profile_create_query_spec.rb +2 -2
  458. data/spec/models/onsite_profile_meta_identifiers_spec.rb +2 -2
  459. data/spec/models/onsite_profile_meta_spec.rb +2 -2
  460. data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +2 -2
  461. data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +2 -2
  462. data/spec/models/onsite_subscription_create_query_spec.rb +2 -2
  463. data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +2 -2
  464. data/spec/models/profile_create_query_as_sub_resource_spec.rb +2 -2
  465. data/spec/models/profile_create_query_spec.rb +2 -2
  466. data/spec/models/profile_location_latitude_spec.rb +2 -2
  467. data/spec/models/profile_location_spec.rb +2 -2
  468. data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +2 -2
  469. data/spec/models/profile_partial_update_query_spec.rb +2 -2
  470. data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +2 -2
  471. data/spec/models/segment_partial_update_query_spec.rb +2 -2
  472. data/spec/models/send_options_spec.rb +2 -2
  473. data/spec/models/send_options_sub_object_spec.rb +40 -0
  474. data/spec/models/send_strategy_sub_object_spec.rb +46 -0
  475. data/spec/models/send_time_sub_object_spec.rb +40 -0
  476. data/spec/models/sms_message_content_spec.rb +2 -2
  477. data/spec/models/sms_render_options_spec.rb +2 -2
  478. data/spec/models/sms_tracking_options_spec.rb +2 -2
  479. data/spec/models/static_schedule_options_spec.rb +46 -0
  480. data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  481. data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
  482. data/spec/models/subscription_create_job_create_query_spec.rb +2 -2
  483. data/spec/models/subscription_spec.rb +2 -2
  484. data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  485. data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
  486. data/spec/models/suppression_create_job_create_query_spec.rb +2 -2
  487. data/spec/models/suppression_spec.rb +2 -2
  488. data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +40 -0
  489. data/spec/models/tag_create_query_as_sub_resource_spec.rb +44 -0
  490. data/spec/models/tag_create_query_spec.rb +34 -0
  491. data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +40 -0
  492. data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +44 -0
  493. data/spec/models/tag_group_create_query_spec.rb +34 -0
  494. data/spec/models/{v2_template_render_query_as_sub_resource_attributes_spec.rb → tag_group_update_query_as_sub_resource_attributes_spec.rb} +9 -9
  495. data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +50 -0
  496. data/spec/models/tag_group_update_query_spec.rb +34 -0
  497. data/spec/models/{list_delete_query_as_sub_resource_spec.rb → tag_segment_op_data_inner_spec.rb} +9 -9
  498. data/spec/models/tag_segment_op_spec.rb +34 -0
  499. data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +34 -0
  500. data/spec/models/{included_profile_spec.rb → tag_update_query_as_sub_resource_spec.rb} +9 -15
  501. data/spec/models/tag_update_query_spec.rb +34 -0
  502. data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +8 -2
  503. data/spec/models/template_clone_query_as_sub_resource_spec.rb +8 -2
  504. data/spec/models/template_clone_query_spec.rb +2 -2
  505. data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +2 -2
  506. data/spec/models/template_create_query_as_sub_resource_spec.rb +2 -2
  507. data/spec/models/template_create_query_spec.rb +2 -2
  508. data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +46 -0
  509. data/spec/models/{template_delete_query_as_sub_resource_spec.rb → template_render_query_as_sub_resource_spec.rb} +9 -9
  510. data/spec/models/template_render_query_spec.rb +34 -0
  511. data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +2 -2
  512. data/spec/models/template_update_query_as_sub_resource_spec.rb +2 -2
  513. data/spec/models/template_update_query_spec.rb +2 -2
  514. data/spec/models/throttled_schedule_options_spec.rb +40 -0
  515. data/spec/models/tracking_options_sub_object_spec.rb +52 -0
  516. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  517. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
  518. data/spec/models/unsubscription_create_job_create_query_spec.rb +2 -2
  519. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  520. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
  521. data/spec/models/unsuppression_create_job_create_query_spec.rb +2 -2
  522. data/spec/models/utm_param_info_spec.rb +2 -2
  523. data/spec/models/utm_params_sub_object_spec.rb +40 -0
  524. data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +3 -13
  525. data/spec/spec_helper.rb +2 -2
  526. metadata +165 -22
  527. data/docs/IncludedProfile.md +0 -24
  528. data/docs/TemplateDeleteQueryAsSubResource.md +0 -20
  529. data/docs/V2TemplateRenderQuery.md +0 -18
  530. data/test.rb +0 -50
@@ -3,10 +3,10 @@
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: 2022-10-17
6
+ The version of the OpenAPI document: 2023-01-24
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.1
9
+ OpenAPI Generator version: 6.2.1
10
10
 
11
11
  =end
12
12
 
@@ -99,7 +99,7 @@ describe 'CatalogsApi' do
99
99
  # unit tests for delete_catalog_category
100
100
  # Delete Catalog Category
101
101
  # Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
102
- # @param id
102
+ # @param id The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
103
103
  # @param [Hash] opts the optional parameters
104
104
  # @return [nil]
105
105
  describe 'delete_catalog_category test' do
@@ -125,7 +125,7 @@ describe 'CatalogsApi' do
125
125
  # unit tests for delete_catalog_item
126
126
  # Delete Catalog Item
127
127
  # Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
128
- # @param id
128
+ # @param id The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
129
129
  # @param [Hash] opts the optional parameters
130
130
  # @return [nil]
131
131
  describe 'delete_catalog_item test' do
@@ -151,7 +151,7 @@ describe 'CatalogsApi' do
151
151
  # unit tests for delete_catalog_variant
152
152
  # Delete Catalog Variant
153
153
  # Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
154
- # @param id
154
+ # @param id The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
155
155
  # @param [Hash] opts the optional parameters
156
156
  # @return [nil]
157
157
  describe 'delete_catalog_variant test' do
@@ -164,10 +164,10 @@ describe 'CatalogsApi' do
164
164
  # Get Catalog Categories
165
165
  # Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 100 categories per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
166
166
  # @param [Hash] opts the optional parameters
167
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
168
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
169
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
170
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
167
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
168
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
169
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
170
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
171
171
  # @return [Hash<String, Object>]
172
172
  describe 'get_catalog_categories test' do
173
173
  it 'should work' do
@@ -178,9 +178,9 @@ describe 'CatalogsApi' do
178
178
  # unit tests for get_catalog_category
179
179
  # Get Catalog Category
180
180
  # Get a catalog category with the given category ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
181
- # @param id
181
+ # @param id The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
182
182
  # @param [Hash] opts the optional parameters
183
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
183
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
184
184
  # @return [Hash<String, Object>]
185
185
  describe 'get_catalog_category test' do
186
186
  it 'should work' do
@@ -193,12 +193,12 @@ describe 'CatalogsApi' do
193
193
  # Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Use filters to return specific fields and any variants. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: &#x60;variants&#x60; Returns a maximum of 100 items per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
194
194
  # @param category_id
195
195
  # @param [Hash] opts the optional parameters
196
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
197
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
198
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
199
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
200
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
201
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
196
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
197
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
198
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
199
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
200
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
201
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
202
202
  # @return [Hash<String, Object>]
203
203
  describe 'get_catalog_category_items test' do
204
204
  it 'should work' do
@@ -212,7 +212,7 @@ describe 'CatalogsApi' do
212
212
  # @param id
213
213
  # @param related_resource
214
214
  # @param [Hash] opts the optional parameters
215
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
215
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
216
216
  # @return [Hash<String, Object>]
217
217
  describe 'get_catalog_category_relationships test' do
218
218
  it 'should work' do
@@ -225,9 +225,9 @@ describe 'CatalogsApi' do
225
225
  # Get a specific catalog item with the given item ID. Request specific fields and variants using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: &#x60;variants&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
226
226
  # @param id
227
227
  # @param [Hash] opts the optional parameters
228
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
229
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
230
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
228
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
229
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
230
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
231
231
  # @return [Hash<String, Object>]
232
232
  describe 'get_catalog_item test' do
233
233
  it 'should work' do
@@ -240,10 +240,10 @@ describe 'CatalogsApi' do
240
240
  # Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 100 categories per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
241
241
  # @param item_id
242
242
  # @param [Hash] opts the optional parameters
243
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
244
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
245
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
246
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
243
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
244
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
245
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
246
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
247
247
  # @return [Hash<String, Object>]
248
248
  describe 'get_catalog_item_categories test' do
249
249
  it 'should work' do
@@ -257,7 +257,7 @@ describe 'CatalogsApi' do
257
257
  # @param id
258
258
  # @param related_resource
259
259
  # @param [Hash] opts the optional parameters
260
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
260
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
261
261
  # @return [Hash<String, Object>]
262
262
  describe 'get_catalog_item_relationships test' do
263
263
  it 'should work' do
@@ -268,12 +268,12 @@ describe 'CatalogsApi' do
268
268
  # unit tests for get_catalog_item_variants
269
269
  # Get Catalog Item Variants
270
270
  # Get all variants related to the given item ID. Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Variants can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 variants per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
271
- # @param item_id
271
+ # @param item_id The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
272
272
  # @param [Hash] opts the optional parameters
273
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
274
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
275
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
276
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
273
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
274
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
275
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
276
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
277
277
  # @return [Hash<String, Object>]
278
278
  describe 'get_catalog_item_variants test' do
279
279
  it 'should work' do
@@ -285,12 +285,12 @@ describe 'CatalogsApi' do
285
285
  # Get Catalog Items
286
286
  # Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Use filters to return specific fields and any variants. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Include parameters can be provided to get the following related resource data: &#x60;variants&#x60; Returns a maximum of 100 items per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
287
287
  # @param [Hash] opts the optional parameters
288
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
289
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
290
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
291
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
292
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
293
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
288
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
289
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
290
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
291
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
292
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
293
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
294
294
  # @return [Hash<String, Object>]
295
295
  describe 'get_catalog_items test' do
296
296
  it 'should work' do
@@ -301,9 +301,9 @@ describe 'CatalogsApi' do
301
301
  # unit tests for get_catalog_variant
302
302
  # Get Catalog Variant
303
303
  # Get a catalog item variant with the given variant ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
304
- # @param id
304
+ # @param id The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
305
305
  # @param [Hash] opts the optional parameters
306
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
306
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
307
307
  # @return [Hash<String, Object>]
308
308
  describe 'get_catalog_variant test' do
309
309
  it 'should work' do
@@ -315,10 +315,10 @@ describe 'CatalogsApi' do
315
315
  # Get Catalog Variants
316
316
  # Get all variants in an account. Use filters to return specific fields. Request specific fields [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Variants can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 variants per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
317
317
  # @param [Hash] opts the optional parameters
318
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
319
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
320
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
321
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
318
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
319
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
320
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
321
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
322
322
  # @return [Hash<String, Object>]
323
323
  describe 'get_catalog_variants test' do
324
324
  it 'should work' do
@@ -331,9 +331,9 @@ describe 'CatalogsApi' do
331
331
  # Get a catalog category bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;categories&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
332
332
  # @param job_id
333
333
  # @param [Hash] opts the optional parameters
334
- # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
335
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
336
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
334
+ # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
335
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
336
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
337
337
  # @return [Hash<String, Object>]
338
338
  describe 'get_create_categories_job test' do
339
339
  it 'should work' do
@@ -345,9 +345,9 @@ describe 'CatalogsApi' do
345
345
  # Get Create Categories Jobs
346
346
  # Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
347
347
  # @param [Hash] opts the optional parameters
348
- # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
349
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
350
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
348
+ # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
349
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
350
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
351
351
  # @return [Hash<String, Object>]
352
352
  describe 'get_create_categories_jobs test' do
353
353
  it 'should work' do
@@ -360,9 +360,9 @@ describe 'CatalogsApi' do
360
360
  # Get a catalog item bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;items&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
361
361
  # @param job_id
362
362
  # @param [Hash] opts the optional parameters
363
- # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
364
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
365
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
363
+ # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
364
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
365
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
366
366
  # @return [Hash<String, Object>]
367
367
  describe 'get_create_items_job test' do
368
368
  it 'should work' do
@@ -374,9 +374,9 @@ describe 'CatalogsApi' do
374
374
  # Get Create Items Jobs
375
375
  # Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
376
376
  # @param [Hash] opts the optional parameters
377
- # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
378
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
379
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
377
+ # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
378
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
379
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
380
380
  # @return [Hash<String, Object>]
381
381
  describe 'get_create_items_jobs test' do
382
382
  it 'should work' do
@@ -389,9 +389,9 @@ describe 'CatalogsApi' do
389
389
  # Get a catalog variant bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;variants&#x60;.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
390
390
  # @param job_id
391
391
  # @param [Hash] opts the optional parameters
392
- # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
393
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
394
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
392
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
393
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
394
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
395
395
  # @return [Hash<String, Object>]
396
396
  describe 'get_create_variants_job test' do
397
397
  it 'should work' do
@@ -403,9 +403,9 @@ describe 'CatalogsApi' do
403
403
  # Get Create Variants Jobs
404
404
  # Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
405
405
  # @param [Hash] opts the optional parameters
406
- # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
407
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
408
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
406
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
407
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
408
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
409
409
  # @return [Hash<String, Object>]
410
410
  describe 'get_create_variants_jobs test' do
411
411
  it 'should work' do
@@ -418,7 +418,7 @@ describe 'CatalogsApi' do
418
418
  # Get a catalog category bulk delete job with the given job ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
419
419
  # @param job_id
420
420
  # @param [Hash] opts the optional parameters
421
- # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
421
+ # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
422
422
  # @return [Hash<String, Object>]
423
423
  describe 'get_delete_categories_job test' do
424
424
  it 'should work' do
@@ -430,9 +430,9 @@ describe 'CatalogsApi' do
430
430
  # Get Delete Categories Jobs
431
431
  # Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
432
432
  # @param [Hash] opts the optional parameters
433
- # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
434
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
435
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
433
+ # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
434
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
435
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
436
436
  # @return [Hash<String, Object>]
437
437
  describe 'get_delete_categories_jobs test' do
438
438
  it 'should work' do
@@ -445,7 +445,7 @@ describe 'CatalogsApi' do
445
445
  # Get a catalog item bulk delete job with the given job ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
446
446
  # @param job_id
447
447
  # @param [Hash] opts the optional parameters
448
- # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
448
+ # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
449
449
  # @return [Hash<String, Object>]
450
450
  describe 'get_delete_items_job test' do
451
451
  it 'should work' do
@@ -457,9 +457,9 @@ describe 'CatalogsApi' do
457
457
  # Get Delete Items Jobs
458
458
  # Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
459
459
  # @param [Hash] opts the optional parameters
460
- # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
461
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
462
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
460
+ # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
461
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
462
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
463
463
  # @return [Hash<String, Object>]
464
464
  describe 'get_delete_items_jobs test' do
465
465
  it 'should work' do
@@ -472,7 +472,7 @@ describe 'CatalogsApi' do
472
472
  # Get a catalog variant bulk delete job with the given job ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
473
473
  # @param job_id
474
474
  # @param [Hash] opts the optional parameters
475
- # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
475
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
476
476
  # @return [Hash<String, Object>]
477
477
  describe 'get_delete_variants_job test' do
478
478
  it 'should work' do
@@ -484,9 +484,9 @@ describe 'CatalogsApi' do
484
484
  # Get Delete Variants Jobs
485
485
  # Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
486
486
  # @param [Hash] opts the optional parameters
487
- # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
488
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
489
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
487
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
488
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
489
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
490
490
  # @return [Hash<String, Object>]
491
491
  describe 'get_delete_variants_jobs test' do
492
492
  it 'should work' do
@@ -499,9 +499,9 @@ describe 'CatalogsApi' do
499
499
  # Get a catalog category bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;categories&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
500
500
  # @param job_id
501
501
  # @param [Hash] opts the optional parameters
502
- # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
503
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
504
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
502
+ # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
503
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
504
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
505
505
  # @return [Hash<String, Object>]
506
506
  describe 'get_update_categories_job test' do
507
507
  it 'should work' do
@@ -513,9 +513,9 @@ describe 'CatalogsApi' do
513
513
  # Get Update Categories Jobs
514
514
  # Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
515
515
  # @param [Hash] opts the optional parameters
516
- # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
517
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
518
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
516
+ # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
517
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
518
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
519
519
  # @return [Hash<String, Object>]
520
520
  describe 'get_update_categories_jobs test' do
521
521
  it 'should work' do
@@ -528,9 +528,9 @@ describe 'CatalogsApi' do
528
528
  # Get a catalog item bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;items&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
529
529
  # @param job_id
530
530
  # @param [Hash] opts the optional parameters
531
- # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
532
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
533
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
531
+ # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
532
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
533
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
534
534
  # @return [Hash<String, Object>]
535
535
  describe 'get_update_items_job test' do
536
536
  it 'should work' do
@@ -542,9 +542,9 @@ describe 'CatalogsApi' do
542
542
  # Get Update Items Jobs
543
543
  # Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
544
544
  # @param [Hash] opts the optional parameters
545
- # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
546
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
547
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
545
+ # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
546
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
547
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
548
548
  # @return [Hash<String, Object>]
549
549
  describe 'get_update_items_jobs test' do
550
550
  it 'should work' do
@@ -557,9 +557,9 @@ describe 'CatalogsApi' do
557
557
  # Get a catalog variate bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;variants&#x60;.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
558
558
  # @param job_id
559
559
  # @param [Hash] opts the optional parameters
560
- # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
561
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
562
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
560
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
561
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
562
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
563
563
  # @return [Hash<String, Object>]
564
564
  describe 'get_update_variants_job test' do
565
565
  it 'should work' do
@@ -571,9 +571,9 @@ describe 'CatalogsApi' do
571
571
  # Get Update Variants Jobs
572
572
  # Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Catalogs Read&#x60;
573
573
  # @param [Hash] opts the optional parameters
574
- # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
575
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
576
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
574
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
575
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
576
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
577
577
  # @return [Hash<String, Object>]
578
578
  describe 'get_update_variants_jobs test' do
579
579
  it 'should work' do
@@ -692,7 +692,7 @@ describe 'CatalogsApi' do
692
692
  # unit tests for update_catalog_category
693
693
  # Update Catalog Category
694
694
  # Update a catalog category with the given category ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Catalogs Write&#x60;
695
- # @param id
695
+ # @param id The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
696
696
  # @param catalog_category_update_query
697
697
  # @param [Hash] opts the optional parameters
698
698
  # @return [Hash<String, Object>]
@@ -719,7 +719,7 @@ describe 'CatalogsApi' do
719
719
  # unit tests for update_catalog_item
720
720
  # Update Catalog Item
721
721
  # Update a catalog item with the given item ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Catalogs Write&#x60;
722
- # @param id
722
+ # @param id The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
723
723
  # @param catalog_item_update_query
724
724
  # @param [Hash] opts the optional parameters
725
725
  # @return [Hash<String, Object>]
@@ -746,7 +746,7 @@ describe 'CatalogsApi' do
746
746
  # unit tests for update_catalog_variant
747
747
  # Update Catalog Variant
748
748
  # Update a catalog item variant with the given variant ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Catalogs Write&#x60;
749
- # @param id
749
+ # @param id The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
750
750
  # @param catalog_variant_update_query
751
751
  # @param [Hash] opts the optional parameters
752
752
  # @return [Hash<String, Object>]
@@ -3,10 +3,10 @@
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: 2022-10-17
6
+ The version of the OpenAPI document: 2023-01-24
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.1
9
+ OpenAPI Generator version: 6.2.1
10
10
 
11
11
  =end
12
12
 
@@ -35,7 +35,7 @@ describe 'ClientApi' do
35
35
  # unit tests for create_client_event
36
36
  # Create Client Event
37
37
  # Create a new event to track a profile&#39;s activity. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create [events] from server-based applications, please use [POST /api/events](https://developers.klaviyo.com/en/v2022-10-17/reference/create_event)&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Events Write&#x60;
38
- # @param company_id
38
+ # @param company_id ID of the Company to create event
39
39
  # @param event_create_query Event to create.
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @return [nil]
@@ -60,8 +60,8 @@ describe 'ClientApi' do
60
60
 
61
61
  # unit tests for create_client_subscription
62
62
  # Create Client Subscription
63
- # Create a new subscription for the given list ID and channel: * Email &#x60;email&#x60; * SMS &#x60;phone_number&#x60; This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create subscriptions from server-based applications, please use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles)&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;100/s&#x60;&lt;br&gt;Steady: &#x60;100/m&#x60; **Scopes:** &#x60;Subscriptions Write&#x60;
64
- # @param company_id
63
+ # Create a new subscription for the given list ID and channel: * Email &#x60;email&#x60; * SMS &#x60;phone_number&#x60; This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create subscriptions from server-based applications, please use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles)&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;100/s&#x60;&lt;br&gt;Steady: &#x60;100/m&#x60; **Scopes:** &#x60;Subscriptions Write&#x60;
64
+ # @param company_id Your company ID.
65
65
  # @param onsite_subscription_create_query Creates a subscription and consent records for Email and or SMS channels based on the provided email and phone_number attributes respectively. One of either email or phone_number must be provided. To create a subscription and consent record for only one channel but still include the other channel as a profile property the consent channel can be provided as a top level attribute and the other channel can be included in the properties object.
66
66
  # @param [Hash] opts the optional parameters
67
67
  # @return [nil]
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #Klaviyo API
3
+
4
+ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
+
6
+ The version of the OpenAPI document: 2023-01-24
7
+ Contact: developers@klaviyo.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.2.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for KlaviyoAPI::DataPrivacyApi
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'DataPrivacyApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = KlaviyoAPI::DataPrivacyApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of DataPrivacyApi' do
30
+ it 'should create an instance of DataPrivacyApi' do
31
+ expect(@api_instance).to be_instance_of(KlaviyoAPI::DataPrivacyApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for request_profile_deletion
36
+ # Request Profile Deletion
37
+ # Request a deletion for the profiles corresponding to one of the following identifiers: &#x60;email&#x60;, &#x60;phone_number&#x60;, or &#x60;profile_id&#x60;. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted). For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Data Privacy Write&#x60;
38
+ # @param data_privacy_create_deletion_job_query
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [nil]
41
+ describe 'request_profile_deletion test' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ end