klaviyo-api-sdk 1.0.1 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (603) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +513 -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/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  21. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
  22. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
  23. data/docs/CampaignSendJobCreateQuery.md +18 -0
  24. data/docs/CampaignSendJobCreateQueryAsSubResource.md +20 -0
  25. data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +18 -0
  26. data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
  27. data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +22 -0
  28. data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  29. data/docs/CampaignTagOp.md +18 -0
  30. data/docs/{ListDeleteQueryAsSubResource.md → CampaignTagOpDataInner.md} +2 -2
  31. data/docs/CampaignsApi.md +1277 -0
  32. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  33. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +7 -7
  34. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  35. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
  36. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  37. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
  38. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
  39. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  40. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +23 -21
  41. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  42. data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
  43. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  44. data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
  45. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
  46. data/docs/CatalogJobErrorPayload.md +8 -8
  47. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  48. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +29 -29
  49. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  50. data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
  51. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  52. data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
  53. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
  54. data/docs/CatalogsApi.md +256 -256
  55. data/docs/ClientApi.md +11 -11
  56. data/docs/ContentSubObject.md +28 -0
  57. data/docs/DataPrivacyApi.md +78 -0
  58. data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
  59. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +20 -0
  60. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +22 -0
  61. data/docs/ErrorSource.md +2 -2
  62. data/docs/EventCreateQueryAsSubResourceAttributes.md +8 -8
  63. data/docs/EventsApi.md +36 -36
  64. data/docs/FlowsApi.md +147 -69
  65. data/docs/GetCampaigns4XXResponse.md +18 -0
  66. data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
  67. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
  68. data/docs/IncludedCategories.md +2 -2
  69. data/docs/IncludedCategoriesAttributes.md +5 -5
  70. data/docs/IncludedItems.md +2 -2
  71. data/docs/IncludedItemsAttributes.md +22 -20
  72. data/docs/IncludedLists.md +2 -2
  73. data/docs/IncludedListsAttributes.md +4 -4
  74. data/docs/IncludedMetrics.md +1 -1
  75. data/docs/IncludedMetricsAttributes.md +4 -4
  76. data/docs/IncludedProfiles.md +2 -2
  77. data/docs/IncludedProfilesAttributes.md +21 -21
  78. data/docs/IncludedSegments.md +1 -1
  79. data/docs/IncludedSegmentsAttributes.md +22 -0
  80. data/docs/{IncludedProfile.md → IncludedTags.md} +5 -5
  81. data/docs/IncludedVariants.md +2 -2
  82. data/docs/IncludedVariantsAttributes.md +28 -28
  83. data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
  84. data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
  85. data/docs/ListsApi.md +111 -35
  86. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +19 -19
  87. data/docs/MetricAggregateRowDTO.md +2 -2
  88. data/docs/MetricCreateQuery.md +3 -3
  89. data/docs/MetricsApi.md +14 -14
  90. data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
  91. data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +10 -10
  92. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
  93. data/docs/ProfileLocation.md +15 -15
  94. data/docs/ProfileLocationLongitude.md +49 -0
  95. data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
  96. data/docs/ProfilesApi.md +36 -36
  97. data/docs/STOScheduleOptions.md +18 -0
  98. data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
  99. data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  100. data/docs/SegmentsApi.md +103 -24
  101. data/docs/SendOptionsSubObject.md +18 -0
  102. data/docs/SendStrategySubObject.md +24 -0
  103. data/docs/SendTimeSubObject.md +20 -0
  104. data/docs/StaticScheduleOptions.md +22 -0
  105. data/docs/Subscription.md +8 -4
  106. data/docs/SubscriptionChannels.md +20 -0
  107. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +5 -5
  108. data/docs/Suppression.md +2 -2
  109. data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  110. data/docs/TagCreateQuery.md +18 -0
  111. data/docs/TagCreateQueryAsSubResource.md +20 -0
  112. data/docs/TagCreateQueryAsSubResourceAttributes.md +20 -0
  113. data/docs/TagGroupCreateQuery.md +18 -0
  114. data/docs/TagGroupCreateQueryAsSubResource.md +20 -0
  115. data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +20 -0
  116. data/docs/TagGroupUpdateQuery.md +18 -0
  117. data/docs/TagGroupUpdateQueryAsSubResource.md +22 -0
  118. data/docs/{V2TemplateRenderQueryAsSubResourceAttributes.md → TagGroupUpdateQueryAsSubResourceAttributes.md} +4 -4
  119. data/docs/TagSegmentOp.md +18 -0
  120. data/docs/{TemplateDeleteQueryAsSubResource.md → TagSegmentOpDataInner.md} +2 -2
  121. data/docs/TagUpdateQuery.md +18 -0
  122. data/docs/TagUpdateQueryAsSubResource.md +22 -0
  123. data/docs/TagUpdateQueryAsSubResourceAttributes.md +18 -0
  124. data/docs/TagsApi.md +1205 -0
  125. data/docs/TemplateCloneQueryAsSubResourceAttributes.md +5 -3
  126. data/docs/TemplateCreateQueryAsSubResourceAttributes.md +14 -8
  127. data/docs/TemplateRenderQuery.md +18 -0
  128. data/docs/TemplateRenderQueryAsSubResource.md +20 -0
  129. data/docs/TemplateRenderQueryAsSubResourceAttributes.md +22 -0
  130. data/docs/TemplateUpdateQueryAsSubResource.md +1 -1
  131. data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +13 -7
  132. data/docs/TemplatesApi.md +40 -44
  133. data/docs/ThrottledScheduleOptions.md +20 -0
  134. data/docs/TrackingOptionsSubObject.md +24 -0
  135. data/docs/UTMParamsSubObject.md +20 -0
  136. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +6 -6
  137. data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +1 -1
  138. data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
  139. data/docs/V2TemplateRenderQueryAsSubResource.md +2 -4
  140. data/klaviyo-api-sdk.gemspec +3 -3
  141. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
  142. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +338 -338
  143. data/lib/klaviyo-api-sdk/api/client_api.rb +12 -12
  144. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +92 -0
  145. data/lib/klaviyo-api-sdk/api/events_api.rb +46 -46
  146. data/lib/klaviyo-api-sdk/api/flows_api.rb +167 -93
  147. data/lib/klaviyo-api-sdk/api/lists_api.rb +122 -50
  148. data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
  149. data/lib/klaviyo-api-sdk/api/profiles_api.rb +53 -53
  150. data/lib/klaviyo-api-sdk/api/segments_api.rb +112 -33
  151. data/lib/klaviyo-api-sdk/api/tags_api.rb +1216 -0
  152. data/lib/klaviyo-api-sdk/api/templates_api.rb +57 -69
  153. data/lib/klaviyo-api-sdk/api_client.rb +3 -3
  154. data/lib/klaviyo-api-sdk/api_error.rb +2 -2
  155. data/lib/klaviyo-api-sdk/configuration.rb +2 -2
  156. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +234 -0
  157. data/lib/klaviyo-api-sdk/models/{v2_template_render_query.rb → campaign_clone_query.rb} +6 -6
  158. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +272 -0
  159. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +235 -0
  160. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +224 -0
  161. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +272 -0
  162. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +291 -0
  163. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +224 -0
  164. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +272 -0
  165. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +240 -0
  166. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +224 -0
  167. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +287 -0
  168. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +229 -0
  169. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +224 -0
  170. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +287 -0
  171. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +256 -0
  172. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
  173. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
  174. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
  175. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +224 -0
  176. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +272 -0
  177. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +225 -0
  178. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +224 -0
  179. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +287 -0
  180. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +225 -0
  181. data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
  182. data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → campaign_tag_op_data_inner.rb} +7 -7
  183. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
  184. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +2 -2
  185. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +3 -2
  186. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
  187. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +2 -2
  188. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +8 -3
  189. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
  190. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +2 -2
  191. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +3 -2
  192. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +3 -2
  193. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  194. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
  195. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +2 -2
  196. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +3 -2
  197. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
  198. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +3 -2
  199. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +3 -2
  200. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  201. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
  202. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +2 -2
  203. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +3 -2
  204. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
  205. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +2 -2
  206. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +28 -4
  207. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +2 -2
  208. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +2 -2
  209. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +2 -2
  210. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
  211. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +2 -2
  212. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +3 -2
  213. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +3 -2
  214. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
  215. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +2 -2
  216. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +3 -2
  217. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
  218. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +3 -2
  219. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +21 -3
  220. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +6 -2
  221. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
  222. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +2 -2
  223. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +3 -2
  224. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
  225. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +2 -2
  226. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +21 -9
  227. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +2 -2
  228. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +2 -2
  229. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +2 -2
  230. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
  231. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +2 -2
  232. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +3 -2
  233. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +3 -2
  234. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
  235. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +2 -2
  236. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +3 -2
  237. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
  238. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +3 -2
  239. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +13 -3
  240. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +270 -0
  241. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +224 -0
  242. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +272 -0
  243. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +240 -0
  244. data/lib/klaviyo-api-sdk/models/email_message_content.rb +2 -2
  245. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +2 -2
  246. data/lib/klaviyo-api-sdk/models/error_source.rb +5 -2
  247. data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
  248. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +7 -2
  250. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
  251. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +2 -2
  252. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +2 -2
  253. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
  254. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
  255. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
  256. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +2 -2
  257. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +2 -2
  258. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +2 -2
  259. data/lib/klaviyo-api-sdk/models/included_categories.rb +3 -2
  260. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +5 -2
  261. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +2 -2
  262. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +2 -2
  263. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +2 -2
  264. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +2 -2
  265. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +2 -2
  266. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +2 -2
  267. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +2 -2
  268. data/lib/klaviyo-api-sdk/models/included_flows.rb +2 -2
  269. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +2 -2
  270. data/lib/klaviyo-api-sdk/models/included_items.rb +3 -2
  271. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +24 -3
  272. data/lib/klaviyo-api-sdk/models/included_lists.rb +3 -2
  273. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +5 -2
  274. data/lib/klaviyo-api-sdk/models/included_metrics.rb +3 -2
  275. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +6 -2
  276. data/lib/klaviyo-api-sdk/models/included_profiles.rb +3 -2
  277. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +14 -2
  278. data/lib/klaviyo-api-sdk/models/included_segments.rb +3 -3
  279. data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
  280. data/lib/klaviyo-api-sdk/models/{included_profile.rb → included_tags.rb} +9 -8
  281. data/lib/klaviyo-api-sdk/models/included_variants.rb +3 -2
  282. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +17 -3
  283. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +2 -2
  284. data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
  285. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +2 -2
  286. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +3 -2
  287. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +2 -2
  288. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -2
  289. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +2 -2
  290. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
  291. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +3 -2
  292. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
  293. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +2 -2
  294. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +29 -21
  295. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +4 -2
  296. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +4 -2
  297. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
  298. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +2 -2
  299. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +2 -2
  300. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +17 -12
  301. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
  302. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +2 -2
  303. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +7 -2
  304. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
  305. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +2 -2
  306. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +11 -2
  307. data/lib/klaviyo-api-sdk/models/profile_location.rb +10 -3
  308. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +3 -2
  309. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
  310. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
  311. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +3 -2
  312. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
  313. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +3 -3
  314. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
  315. data/lib/klaviyo-api-sdk/models/send_options.rb +2 -2
  316. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +220 -0
  317. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +252 -0
  318. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +240 -0
  319. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +2 -2
  320. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +2 -2
  321. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +2 -2
  322. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +245 -0
  323. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
  324. data/lib/klaviyo-api-sdk/models/subscription.rb +27 -6
  325. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
  326. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
  327. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +2 -2
  328. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +5 -2
  329. data/lib/klaviyo-api-sdk/models/suppression.rb +3 -2
  330. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
  331. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +2 -2
  332. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +3 -2
  333. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +224 -0
  334. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +272 -0
  335. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +235 -0
  336. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +224 -0
  337. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +272 -0
  338. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +234 -0
  339. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +224 -0
  340. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +287 -0
  341. 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
  342. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +226 -0
  343. data/lib/klaviyo-api-sdk/models/{template_delete_query_as_sub_resource.rb → tag_segment_op_data_inner.rb} +7 -7
  344. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +224 -0
  345. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +287 -0
  346. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +225 -0
  347. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
  348. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +2 -2
  349. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +20 -3
  350. data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
  351. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +2 -2
  352. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +7 -2
  353. data/lib/klaviyo-api-sdk/models/template_render_query.rb +224 -0
  354. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +272 -0
  355. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +252 -0
  356. data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
  357. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +3 -2
  358. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +6 -2
  359. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +240 -0
  360. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +252 -0
  361. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
  362. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +2 -2
  363. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +5 -7
  364. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
  365. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +3 -3
  366. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +227 -0
  367. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +2 -2
  368. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +240 -0
  369. data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +11 -62
  370. data/lib/klaviyo-api-sdk/version.rb +2 -2
  371. data/lib/klaviyo-api-sdk.rb +68 -11
  372. data/spec/api/campaigns_api_spec.rb +284 -0
  373. data/spec/api/catalogs_api_spec.rb +94 -94
  374. data/spec/api/client_api_spec.rb +5 -5
  375. data/spec/api/data_privacy_api_spec.rb +47 -0
  376. data/spec/api/events_api_spec.rb +19 -19
  377. data/spec/api/flows_api_spec.rb +44 -33
  378. data/spec/api/lists_api_spec.rb +28 -15
  379. data/spec/api/metrics_api_spec.rb +8 -8
  380. data/spec/api/profiles_api_spec.rb +21 -21
  381. data/spec/api/segments_api_spec.rb +24 -10
  382. data/spec/api/tags_api_spec.rb +245 -0
  383. data/spec/api/templates_api_spec.rb +18 -18
  384. data/spec/api_client_spec.rb +2 -2
  385. data/spec/configuration_spec.rb +2 -2
  386. data/spec/models/audiences_sub_object_spec.rb +40 -0
  387. data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +40 -0
  388. data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +44 -0
  389. data/spec/models/{v2_template_render_query_spec.rb → campaign_clone_query_spec.rb} +8 -8
  390. data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +64 -0
  391. data/spec/models/campaign_create_query_as_sub_resource_spec.rb +44 -0
  392. data/spec/models/campaign_create_query_spec.rb +34 -0
  393. data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +40 -0
  394. data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +44 -0
  395. data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
  396. data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +40 -0
  397. data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +50 -0
  398. data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
  399. data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +58 -0
  400. data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +50 -0
  401. data/spec/models/campaign_partial_update_query_spec.rb +34 -0
  402. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  403. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
  404. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  405. data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  406. data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +44 -0
  407. data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
  408. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  409. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +50 -0
  410. data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
  411. data/spec/models/{list_delete_query_as_sub_resource_spec.rb → campaign_tag_op_data_inner_spec.rb} +9 -9
  412. data/spec/models/campaign_tag_op_spec.rb +34 -0
  413. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  414. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +2 -2
  415. data/spec/models/catalog_category_create_job_create_query_spec.rb +2 -2
  416. data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +2 -2
  417. data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +2 -2
  418. data/spec/models/catalog_category_create_query_spec.rb +2 -2
  419. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  420. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  421. data/spec/models/catalog_category_delete_job_create_query_spec.rb +2 -2
  422. data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +2 -2
  423. data/spec/models/catalog_category_item_op_spec.rb +2 -2
  424. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  425. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +2 -2
  426. data/spec/models/catalog_category_update_job_create_query_spec.rb +2 -2
  427. data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +2 -2
  428. data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +2 -2
  429. data/spec/models/catalog_category_update_query_spec.rb +2 -2
  430. data/spec/models/catalog_item_category_op_spec.rb +2 -2
  431. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  432. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +2 -2
  433. data/spec/models/catalog_item_create_job_create_query_spec.rb +2 -2
  434. data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +2 -2
  435. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +2 -2
  436. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +2 -2
  437. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +2 -2
  438. data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +2 -2
  439. data/spec/models/catalog_item_create_query_spec.rb +2 -2
  440. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  441. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  442. data/spec/models/catalog_item_delete_job_create_query_spec.rb +2 -2
  443. data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +2 -2
  444. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  445. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +2 -2
  446. data/spec/models/catalog_item_update_job_create_query_spec.rb +2 -2
  447. data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +2 -2
  448. data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +2 -2
  449. data/spec/models/catalog_item_update_query_spec.rb +2 -2
  450. data/spec/models/catalog_job_error_payload_spec.rb +2 -2
  451. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  452. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +2 -2
  453. data/spec/models/catalog_variant_create_job_create_query_spec.rb +2 -2
  454. data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +2 -2
  455. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +2 -2
  456. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +2 -2
  457. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +2 -2
  458. data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +2 -2
  459. data/spec/models/catalog_variant_create_query_spec.rb +2 -2
  460. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  461. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  462. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +2 -2
  463. data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +2 -2
  464. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  465. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +2 -2
  466. data/spec/models/catalog_variant_update_job_create_query_spec.rb +2 -2
  467. data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +2 -2
  468. data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +2 -2
  469. data/spec/models/catalog_variant_update_query_spec.rb +2 -2
  470. data/spec/models/content_sub_object_spec.rb +64 -0
  471. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +46 -0
  472. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +44 -0
  473. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
  474. data/spec/models/email_message_content_spec.rb +2 -2
  475. data/spec/models/email_tracking_options_spec.rb +2 -2
  476. data/spec/models/error_source_spec.rb +2 -2
  477. data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +2 -2
  478. data/spec/models/event_create_query_as_sub_resource_spec.rb +2 -2
  479. data/spec/models/event_create_query_spec.rb +2 -2
  480. data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +2 -2
  481. data/spec/models/flow_update_query_as_sub_resource_spec.rb +2 -2
  482. data/spec/models/flow_update_query_spec.rb +2 -2
  483. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
  484. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
  485. data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
  486. data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +2 -2
  487. data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +2 -2
  488. data/spec/models/get_catalog_items4_xx_response_spec.rb +2 -2
  489. data/spec/models/included_categories_attributes_spec.rb +2 -2
  490. data/spec/models/included_categories_spec.rb +2 -2
  491. data/spec/models/included_flow_action_spec.rb +2 -2
  492. data/spec/models/included_flow_actions_attributes_spec.rb +2 -2
  493. data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +2 -2
  494. data/spec/models/included_flow_actions_spec.rb +2 -2
  495. data/spec/models/included_flow_messages_attributes_content_spec.rb +2 -2
  496. data/spec/models/included_flow_messages_attributes_spec.rb +2 -2
  497. data/spec/models/included_flow_messages_spec.rb +2 -2
  498. data/spec/models/included_flows_attributes_spec.rb +2 -2
  499. data/spec/models/included_flows_spec.rb +2 -2
  500. data/spec/models/included_items_attributes_spec.rb +2 -2
  501. data/spec/models/included_items_spec.rb +2 -2
  502. data/spec/models/included_lists_attributes_spec.rb +2 -2
  503. data/spec/models/included_lists_spec.rb +2 -2
  504. data/spec/models/included_metrics_attributes_spec.rb +2 -2
  505. data/spec/models/included_metrics_spec.rb +2 -2
  506. data/spec/models/included_profiles_attributes_spec.rb +2 -2
  507. data/spec/models/included_profiles_spec.rb +2 -2
  508. data/spec/models/included_segments_attributes_spec.rb +46 -0
  509. data/spec/models/included_segments_spec.rb +2 -2
  510. data/spec/models/{included_profile_spec.rb → included_tags_spec.rb} +9 -9
  511. data/spec/models/included_variants_attributes_spec.rb +2 -2
  512. data/spec/models/included_variants_links_spec.rb +2 -2
  513. data/spec/models/included_variants_spec.rb +2 -2
  514. data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +2 -2
  515. data/spec/models/list_create_query_as_sub_resource_spec.rb +2 -2
  516. data/spec/models/list_create_query_spec.rb +2 -2
  517. data/spec/models/list_members_add_query_data_inner_spec.rb +2 -2
  518. data/spec/models/list_members_add_query_spec.rb +2 -2
  519. data/spec/models/list_members_delete_query_spec.rb +2 -2
  520. data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +2 -2
  521. data/spec/models/list_partial_update_query_spec.rb +2 -2
  522. data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +2 -2
  523. data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +2 -2
  524. data/spec/models/metric_aggregate_query_spec.rb +2 -2
  525. data/spec/models/metric_aggregate_row_dto_spec.rb +2 -2
  526. data/spec/models/metric_create_query_spec.rb +2 -2
  527. data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +2 -2
  528. data/spec/models/onsite_profile_create_query_spec.rb +2 -2
  529. data/spec/models/onsite_profile_meta_identifiers_spec.rb +2 -2
  530. data/spec/models/onsite_profile_meta_spec.rb +2 -2
  531. data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +2 -2
  532. data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +2 -2
  533. data/spec/models/onsite_subscription_create_query_spec.rb +2 -2
  534. data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +2 -2
  535. data/spec/models/profile_create_query_as_sub_resource_spec.rb +2 -2
  536. data/spec/models/profile_create_query_spec.rb +2 -2
  537. data/spec/models/profile_location_latitude_spec.rb +2 -2
  538. data/spec/models/profile_location_longitude_spec.rb +31 -0
  539. data/spec/models/profile_location_spec.rb +2 -2
  540. data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +2 -2
  541. data/spec/models/profile_partial_update_query_spec.rb +2 -2
  542. data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  543. data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +2 -2
  544. data/spec/models/segment_partial_update_query_spec.rb +2 -2
  545. data/spec/models/send_options_spec.rb +2 -2
  546. data/spec/models/send_options_sub_object_spec.rb +40 -0
  547. data/spec/models/send_strategy_sub_object_spec.rb +46 -0
  548. data/spec/models/send_time_sub_object_spec.rb +40 -0
  549. data/spec/models/sms_message_content_spec.rb +2 -2
  550. data/spec/models/sms_render_options_spec.rb +2 -2
  551. data/spec/models/sms_tracking_options_spec.rb +2 -2
  552. data/spec/models/static_schedule_options_spec.rb +46 -0
  553. data/spec/models/sto_schedule_options_spec.rb +34 -0
  554. data/spec/models/subscription_channels_spec.rb +48 -0
  555. data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  556. data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
  557. data/spec/models/subscription_create_job_create_query_spec.rb +2 -2
  558. data/spec/models/subscription_spec.rb +2 -2
  559. data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  560. data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
  561. data/spec/models/suppression_create_job_create_query_spec.rb +2 -2
  562. data/spec/models/suppression_spec.rb +2 -2
  563. data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +40 -0
  564. data/spec/models/tag_create_query_as_sub_resource_spec.rb +44 -0
  565. data/spec/models/tag_create_query_spec.rb +34 -0
  566. data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +40 -0
  567. data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +44 -0
  568. data/spec/models/tag_group_create_query_spec.rb +34 -0
  569. 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
  570. data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +50 -0
  571. data/spec/models/tag_group_update_query_spec.rb +34 -0
  572. data/spec/models/tag_segment_op_data_inner_spec.rb +44 -0
  573. data/spec/models/tag_segment_op_spec.rb +34 -0
  574. data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +34 -0
  575. data/spec/models/tag_update_query_as_sub_resource_spec.rb +50 -0
  576. data/spec/models/tag_update_query_spec.rb +34 -0
  577. data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +8 -2
  578. data/spec/models/template_clone_query_as_sub_resource_spec.rb +8 -2
  579. data/spec/models/template_clone_query_spec.rb +2 -2
  580. data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +2 -2
  581. data/spec/models/template_create_query_as_sub_resource_spec.rb +2 -2
  582. data/spec/models/template_create_query_spec.rb +2 -2
  583. data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +46 -0
  584. data/spec/models/{template_delete_query_as_sub_resource_spec.rb → template_render_query_as_sub_resource_spec.rb} +9 -9
  585. data/spec/models/template_render_query_spec.rb +34 -0
  586. data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +2 -2
  587. data/spec/models/template_update_query_as_sub_resource_spec.rb +2 -2
  588. data/spec/models/template_update_query_spec.rb +2 -2
  589. data/spec/models/throttled_schedule_options_spec.rb +40 -0
  590. data/spec/models/tracking_options_sub_object_spec.rb +52 -0
  591. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  592. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
  593. data/spec/models/unsubscription_create_job_create_query_spec.rb +2 -2
  594. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  595. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
  596. data/spec/models/unsuppression_create_job_create_query_spec.rb +2 -2
  597. data/spec/models/utm_param_info_spec.rb +2 -2
  598. data/spec/models/utm_params_sub_object_spec.rb +40 -0
  599. data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +3 -13
  600. data/spec/spec_helper.rb +2 -2
  601. metadata +207 -19
  602. data/docs/V2TemplateRenderQuery.md +0 -18
  603. data/test.rb +0 -50
data/docs/SegmentsApi.md CHANGED
@@ -7,6 +7,7 @@ All URIs are relative to *https://a.klaviyo.com*
7
7
  | [**get_segment**](SegmentsApi.md#get_segment) | **GET** /api/segments/{id}/ | Get Segment |
8
8
  | [**get_segment_profiles**](SegmentsApi.md#get_segment_profiles) | **GET** /api/segments/{segment_id}/profiles/ | Get Segment Profiles |
9
9
  | [**get_segment_relationships**](SegmentsApi.md#get_segment_relationships) | **GET** /api/segments/{id}/relationships/{related_resource}/ | Get Segment Relationships |
10
+ | [**get_segment_tags**](SegmentsApi.md#get_segment_tags) | **GET** /api/segments/{segment_id}/tags/ | Get Segment Tags |
10
11
  | [**get_segments**](SegmentsApi.md#get_segments) | **GET** /api/segments/ | Get Segments |
11
12
  | [**update_segment**](SegmentsApi.md#update_segment) | **PATCH** /api/segments/{id}/ | Update Segment |
12
13
 
@@ -35,7 +36,7 @@ end
35
36
  api_instance = KlaviyoAPI::SegmentsApi.new
36
37
  id = 'id_example' # String |
37
38
  opts = {
38
- fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
39
+ fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
39
40
  }
40
41
 
41
42
  begin
@@ -70,7 +71,7 @@ end
70
71
  | Name | Type | Description | Notes |
71
72
  | ---- | ---- | ----------- | ----- |
72
73
  | **id** | **String** | | |
73
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
74
+ | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
74
75
 
75
76
  ### Return type
76
77
 
@@ -88,11 +89,11 @@ end
88
89
 
89
90
  ## get_segment_profiles
90
91
 
91
- > get_segment_profiles(segment_id, opts)
92
+ > Hash&lt;String, Object&gt; get_segment_profiles(segment_id, opts)
92
93
 
93
94
  Get Segment Profiles
94
95
 
95
- Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. Returns a maximum of 10 results per page, 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: `10/s`<br>Steady: `150/m` **Scopes:** `Profiles Read` `Segments Read`
96
+ Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Profiles Read` `Segments Read`
96
97
 
97
98
  ### Examples
98
99
 
@@ -110,13 +111,15 @@ end
110
111
  api_instance = KlaviyoAPI::SegmentsApi.new
111
112
  segment_id = 'segment_id_example' # String |
112
113
  opts = {
113
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
114
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
114
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
115
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
116
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
115
117
  }
116
118
 
117
119
  begin
118
120
  # Get Segment Profiles
119
- api_instance.get_segment_profiles(segment_id, opts)
121
+ result = api_instance.get_segment_profiles(segment_id, opts)
122
+ p result
120
123
  rescue KlaviyoAPI::ApiError => e
121
124
  puts "Error when calling SegmentsApi->get_segment_profiles: #{e}"
122
125
  end
@@ -124,9 +127,9 @@ end
124
127
 
125
128
  #### Using the get_segment_profiles_with_http_info variant
126
129
 
127
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
130
+ This returns an Array which contains the response data, status code and headers.
128
131
 
129
- > <Array(nil, Integer, Hash)> get_segment_profiles_with_http_info(segment_id, opts)
132
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segment_profiles_with_http_info(segment_id, opts)
130
133
 
131
134
  ```ruby
132
135
  begin
@@ -134,7 +137,7 @@ begin
134
137
  data, status_code, headers = api_instance.get_segment_profiles_with_http_info(segment_id, opts)
135
138
  p status_code # => 2xx
136
139
  p headers # => { ... }
137
- p data # => nil
140
+ p data # => Hash&lt;String, Object&gt;
138
141
  rescue KlaviyoAPI::ApiError => e
139
142
  puts "Error when calling SegmentsApi->get_segment_profiles_with_http_info: #{e}"
140
143
  end
@@ -145,12 +148,13 @@ end
145
148
  | Name | Type | Description | Notes |
146
149
  | ---- | ---- | ----------- | ----- |
147
150
  | **segment_id** | **String** | | |
148
- | **filter** | **String** | 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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
149
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
151
+ | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
152
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
153
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
150
154
 
151
155
  ### Return type
152
156
 
153
- nil (empty response body)
157
+ **Hash&lt;String, Object&gt;**
154
158
 
155
159
  ### Authorization
156
160
 
@@ -168,7 +172,7 @@ nil (empty response body)
168
172
 
169
173
  Get Segment Relationships
170
174
 
171
- Get all profile membership [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for the given segment ID. Returns a maximum of 10 results per page, 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: `10/s`<br>Steady: `150/m` **Scopes:** `Profiles Read` `Segments Read`
175
+ Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Profiles Read` `Segments Read`
172
176
 
173
177
  ### Examples
174
178
 
@@ -187,7 +191,7 @@ api_instance = KlaviyoAPI::SegmentsApi.new
187
191
  id = 'id_example' # String |
188
192
  related_resource = 'profiles' # String |
189
193
  opts = {
190
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
194
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
191
195
  }
192
196
 
193
197
  begin
@@ -223,7 +227,82 @@ end
223
227
  | ---- | ---- | ----------- | ----- |
224
228
  | **id** | **String** | | |
225
229
  | **related_resource** | **String** | | |
226
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
230
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
231
+
232
+ ### Return type
233
+
234
+ **Hash&lt;String, Object&gt;**
235
+
236
+ ### Authorization
237
+
238
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
239
+
240
+ ### HTTP request headers
241
+
242
+ - **Content-Type**: Not defined
243
+ - **Accept**: application/json
244
+
245
+
246
+ ## get_segment_tags
247
+
248
+ > Hash&lt;String, Object&gt; get_segment_tags(segment_id, opts)
249
+
250
+ Get Segment Tags
251
+
252
+ Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Segments Read` `Tags Read`
253
+
254
+ ### Examples
255
+
256
+ ```ruby
257
+ require 'time'
258
+ require 'klaviyo-api-sdk'
259
+ # setup authorization
260
+ KlaviyoAPI.configure do |config|
261
+ # Configure API key authorization: Klaviyo-API-Key
262
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
263
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
264
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
265
+ end
266
+
267
+ api_instance = KlaviyoAPI::SegmentsApi.new
268
+ segment_id = 'segment_id_example' # String |
269
+ opts = {
270
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
271
+ }
272
+
273
+ begin
274
+ # Get Segment Tags
275
+ result = api_instance.get_segment_tags(segment_id, opts)
276
+ p result
277
+ rescue KlaviyoAPI::ApiError => e
278
+ puts "Error when calling SegmentsApi->get_segment_tags: #{e}"
279
+ end
280
+ ```
281
+
282
+ #### Using the get_segment_tags_with_http_info variant
283
+
284
+ This returns an Array which contains the response data, status code and headers.
285
+
286
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segment_tags_with_http_info(segment_id, opts)
287
+
288
+ ```ruby
289
+ begin
290
+ # Get Segment Tags
291
+ data, status_code, headers = api_instance.get_segment_tags_with_http_info(segment_id, opts)
292
+ p status_code # => 2xx
293
+ p headers # => { ... }
294
+ p data # => Hash&lt;String, Object&gt;
295
+ rescue KlaviyoAPI::ApiError => e
296
+ puts "Error when calling SegmentsApi->get_segment_tags_with_http_info: #{e}"
297
+ end
298
+ ```
299
+
300
+ ### Parameters
301
+
302
+ | Name | Type | Description | Notes |
303
+ | ---- | ---- | ----------- | ----- |
304
+ | **segment_id** | **String** | | |
305
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
227
306
 
228
307
  ### Return type
229
308
 
@@ -245,7 +324,7 @@ end
245
324
 
246
325
  Get Segments
247
326
 
248
- Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page, 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: `10/s`<br>Steady: `150/m` **Scopes:** `Segments Read`
327
+ Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Segments Read`
249
328
 
250
329
  ### Examples
251
330
 
@@ -262,9 +341,9 @@ end
262
341
 
263
342
  api_instance = KlaviyoAPI::SegmentsApi.new
264
343
  opts = {
265
- fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
266
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
267
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
344
+ fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
345
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
346
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
268
347
  }
269
348
 
270
349
  begin
@@ -298,9 +377,9 @@ end
298
377
 
299
378
  | Name | Type | Description | Notes |
300
379
  | ---- | ---- | ----------- | ----- |
301
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
302
- | **filter** | **String** | 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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
303
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
380
+ | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
381
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
382
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
304
383
 
305
384
  ### Return type
306
385
 
@@ -339,7 +418,7 @@ end
339
418
 
340
419
  api_instance = KlaviyoAPI::SegmentsApi.new
341
420
  id = 'id_example' # String |
342
- segment_partial_update_query = KlaviyoAPI::SegmentPartialUpdateQuery.new({data: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResource.new({type: 'segment', id: 'id_example', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # SegmentPartialUpdateQuery |
421
+ segment_partial_update_query = KlaviyoAPI::SegmentPartialUpdateQuery.new({data: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResource.new({type: 'segment', id: 'id_example', attributes: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # SegmentPartialUpdateQuery |
343
422
 
344
423
  begin
345
424
  # Update Segment
@@ -0,0 +1,18 @@
1
+ # KlaviyoAPI::SendOptionsSubObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **use_smart_sending** | **Boolean** | Use smart sending. Defaults to True | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ instance = KlaviyoAPI::SendOptionsSubObject.new(
15
+ use_smart_sending: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # KlaviyoAPI::SendStrategySubObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **method** | **String** | Describes the shape of the options object. Allowed values: [&#39;static&#39;, &#39;throttled&#39;, &#39;immediate&#39;, &#39;smart_send_time&#39;] | |
8
+ | **options_static** | [**StaticScheduleOptions**](StaticScheduleOptions.md) | | [optional] |
9
+ | **options_throttled** | [**ThrottledScheduleOptions**](ThrottledScheduleOptions.md) | | [optional] |
10
+ | **options_sto** | [**STOScheduleOptions**](STOScheduleOptions.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'klaviyo-api-sdk'
16
+
17
+ instance = KlaviyoAPI::SendStrategySubObject.new(
18
+ method: static,
19
+ options_static: null,
20
+ options_throttled: null,
21
+ options_sto: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::SendTimeSubObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **datetime** | **Time** | The datetime that the message is to be sent | |
8
+ | **is_local** | **Boolean** | Whether that datetime is to be a local datetime for the recipient | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::SendTimeSubObject.new(
16
+ datetime: null,
17
+ is_local: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # KlaviyoAPI::StaticScheduleOptions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **datetime** | **Time** | The time to send at | |
8
+ | **is_local** | **Boolean** | If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False. | [optional] |
9
+ | **send_past_recipients_immediately** | **Boolean** | Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'klaviyo-api-sdk'
15
+
16
+ instance = KlaviyoAPI::StaticScheduleOptions.new(
17
+ datetime: null,
18
+ is_local: null,
19
+ send_past_recipients_immediately: null
20
+ )
21
+ ```
22
+
data/docs/Subscription.md CHANGED
@@ -4,8 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | [optional] |
8
- | **phone_number** | **String** | | [optional] |
7
+ | **channels** | [**SubscriptionChannels**](SubscriptionChannels.md) | | [optional] |
8
+ | **email** | **String** | The email address to subscribe or to set on the profile if &#x60;channels&#x60; is specified and the email channel is omitted. | [optional] |
9
+ | **phone_number** | **String** | The phone number to subscribe or to set on the profile if &#x60;channels&#x60; is specified and the SMS channel is omitted. | [optional] |
10
+ | **profile_id** | **String** | The ID of the profile to subscribe. If provided, this will be used to perform the lookup. | [optional] |
9
11
 
10
12
  ## Example
11
13
 
@@ -13,8 +15,10 @@
13
15
  require 'klaviyo-api-sdk'
14
16
 
15
17
  instance = KlaviyoAPI::Subscription.new(
16
- email: null,
17
- phone_number: null
18
+ channels: null,
19
+ email: matt-kemp@klaviyo-demo.com,
20
+ phone_number: +15005550006,
21
+ profile_id: 01GDDKASAP8TKDDA2GRZDSVP4H
18
22
  )
19
23
  ```
20
24
 
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::SubscriptionChannels
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **Array&lt;String&gt;** | The communication types to subscribe to on the \&quot;EMAIL\&quot; Channel. Currently supports \&quot;MARKETING\&quot;. | [optional] |
8
+ | **sms** | **Array&lt;String&gt;** | The communication types to subscribe to on the \&quot;SMS\&quot; Channel. Currently supports \&quot;MARKETING\&quot;. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::SubscriptionChannels.new(
16
+ email: [&quot;MARKETING&quot;],
17
+ sms: [&quot;MARKETING&quot;]
18
+ )
19
+ ```
20
+
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **list_id** | **String** | | |
8
- | **custom_source** | **String** | | [optional] |
9
- | **subscriptions** | [**Array&lt;Subscription&gt;**](Subscription.md) | | |
7
+ | **list_id** | **String** | The list to add the newly subscribed profiles to | |
8
+ | **custom_source** | **String** | A custom method detail or source to store on the consent records. | [optional] |
9
+ | **subscriptions** | [**Array&lt;Subscription&gt;**](Subscription.md) | One or more subscriptions to be created. | |
10
10
 
11
11
  ## Example
12
12
 
@@ -14,8 +14,8 @@
14
14
  require 'klaviyo-api-sdk'
15
15
 
16
16
  instance = KlaviyoAPI::SubscriptionCreateJobCreateQueryAsSubResourceAttributes.new(
17
- list_id: null,
18
- custom_source: null,
17
+ list_id: Y6nRLr,
18
+ custom_source: Marketing Event,
19
19
  subscriptions: null
20
20
  )
21
21
  ```
data/docs/Suppression.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | |
7
+ | **email** | **String** | The email of the profile to suppress / unsuppress. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -12,7 +12,7 @@
12
12
  require 'klaviyo-api-sdk'
13
13
 
14
14
  instance = KlaviyoAPI::Suppression.new(
15
- email: null
15
+ email: matt-kemp@klaviyo-demo.com
16
16
  )
17
17
  ```
18
18
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **suppressions** | [**Array&lt;Suppression&gt;**](Suppression.md) | | |
7
+ | **suppressions** | [**Array&lt;Suppression&gt;**](Suppression.md) | One or more suppressions to be created. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -0,0 +1,18 @@
1
+ # KlaviyoAPI::TagCreateQuery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**TagCreateQueryAsSubResource**](TagCreateQueryAsSubResource.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ instance = KlaviyoAPI::TagCreateQuery.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::TagCreateQueryAsSubResource
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | |
8
+ | **attributes** | [**TagCreateQueryAsSubResourceAttributes**](TagCreateQueryAsSubResourceAttributes.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::TagCreateQueryAsSubResource.new(
16
+ type: null,
17
+ attributes: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::TagCreateQueryAsSubResourceAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The Tag name | |
8
+ | **tag_group_id** | **String** | The ID of the Tag Group to associate the Tag with. If this field is not specified, the Tag will be associated with the company&#39;s Default Tag Group. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::TagCreateQueryAsSubResourceAttributes.new(
16
+ name: My Tag,
17
+ tag_group_id: zyxw9876-vu54-ts32-rq10-zyxwvu654321
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # KlaviyoAPI::TagGroupCreateQuery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**TagGroupCreateQueryAsSubResource**](TagGroupCreateQueryAsSubResource.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ instance = KlaviyoAPI::TagGroupCreateQuery.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::TagGroupCreateQueryAsSubResource
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | |
8
+ | **attributes** | [**TagGroupCreateQueryAsSubResourceAttributes**](TagGroupCreateQueryAsSubResourceAttributes.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::TagGroupCreateQueryAsSubResource.new(
16
+ type: null,
17
+ attributes: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::TagGroupCreateQueryAsSubResourceAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The Tag Group name | |
8
+ | **exclusive** | **Boolean** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::TagGroupCreateQueryAsSubResourceAttributes.new(
16
+ name: My Tag Group,
17
+ exclusive: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # KlaviyoAPI::TagGroupUpdateQuery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**TagGroupUpdateQueryAsSubResource**](TagGroupUpdateQueryAsSubResource.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ instance = KlaviyoAPI::TagGroupUpdateQuery.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # KlaviyoAPI::TagGroupUpdateQueryAsSubResource
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | |
8
+ | **id** | **String** | The Tag Group ID | |
9
+ | **attributes** | [**TagGroupUpdateQueryAsSubResourceAttributes**](TagGroupUpdateQueryAsSubResourceAttributes.md) | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'klaviyo-api-sdk'
15
+
16
+ instance = KlaviyoAPI::TagGroupUpdateQueryAsSubResource.new(
17
+ type: null,
18
+ id: zyxw9876-vu54-ts32-rq10-zyxwvu654321,
19
+ attributes: null
20
+ )
21
+ ```
22
+
@@ -1,10 +1,10 @@
1
- # KlaviyoAPI::V2TemplateRenderQueryAsSubResourceAttributes
1
+ # KlaviyoAPI::TagGroupUpdateQueryAsSubResourceAttributes
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **context** | **Object** | | |
7
+ | **name** | **String** | The Tag Group name | |
8
8
  | **return_fields** | **Array&lt;String&gt;** | | [optional] |
9
9
 
10
10
  ## Example
@@ -12,8 +12,8 @@
12
12
  ```ruby
13
13
  require 'klaviyo-api-sdk'
14
14
 
15
- instance = KlaviyoAPI::V2TemplateRenderQueryAsSubResourceAttributes.new(
16
- context: null,
15
+ instance = KlaviyoAPI::TagGroupUpdateQueryAsSubResourceAttributes.new(
16
+ name: My Tag Group,
17
17
  return_fields: null
18
18
  )
19
19
  ```
@@ -0,0 +1,18 @@
1
+ # KlaviyoAPI::TagSegmentOp
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;TagSegmentOpDataInner&gt;**](TagSegmentOpDataInner.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ instance = KlaviyoAPI::TagSegmentOp.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -1,4 +1,4 @@
1
- # KlaviyoAPI::TemplateDeleteQueryAsSubResource
1
+ # KlaviyoAPI::TagSegmentOpDataInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -12,7 +12,7 @@
12
12
  ```ruby
13
13
  require 'klaviyo-api-sdk'
14
14
 
15
- instance = KlaviyoAPI::TemplateDeleteQueryAsSubResource.new(
15
+ instance = KlaviyoAPI::TagSegmentOpDataInner.new(
16
16
  type: null,
17
17
  id: null
18
18
  )