klaviyo-api-sdk 4.0.0 → 4.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (982) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -0
  3. data/README.md +457 -176
  4. data/Rakefile +10 -0
  5. data/docs/AccountsApi.md +157 -0
  6. data/docs/AudiencesSubObject.md +20 -0
  7. data/docs/BackInStockSubscriptionEnum.md +15 -0
  8. data/docs/CampaignCloneQuery.md +18 -0
  9. data/docs/CampaignCloneQueryResourceObject.md +22 -0
  10. data/docs/CampaignCloneQueryResourceObjectAttributes.md +18 -0
  11. data/docs/CampaignCreateQuery.md +18 -0
  12. data/docs/CampaignCreateQueryResourceObject.md +20 -0
  13. data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
  14. data/docs/CampaignCreateQueryResourceObjectAttributesCampaignMessages.md +18 -0
  15. data/docs/CampaignCreateQueryResourceObjectAttributesSendOptions.md +49 -0
  16. data/docs/CampaignCreateQueryResourceObjectAttributesTrackingOptions.md +49 -0
  17. data/docs/CampaignEnum.md +15 -0
  18. data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
  19. data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +22 -0
  20. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +18 -0
  21. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +18 -0
  22. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.md +20 -0
  23. data/docs/CampaignMessageCreateQueryResourceObject.md +20 -0
  24. data/docs/CampaignMessageCreateQueryResourceObjectAttributes.md +24 -0
  25. data/docs/CampaignMessageCreateQueryResourceObjectAttributesContent.md +49 -0
  26. data/docs/CampaignMessageEnum.md +15 -0
  27. data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
  28. data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
  29. data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +22 -0
  30. data/docs/CampaignPartialUpdateQuery.md +18 -0
  31. data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
  32. data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
  33. data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  34. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
  35. data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
  36. data/docs/CampaignSendJobCreateQuery.md +18 -0
  37. data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
  38. data/docs/CampaignSendJobEnum.md +15 -0
  39. data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
  40. data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
  41. data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
  42. data/docs/CampaignsApi.md +1735 -0
  43. data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
  44. data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
  45. data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
  46. data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
  47. data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
  48. data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  49. data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
  50. data/docs/CatalogCategoryCreateQuery.md +18 -0
  51. data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
  52. data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
  53. data/docs/CatalogCategoryCreateQueryResourceObjectRelationships.md +18 -0
  54. data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +18 -0
  55. data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
  56. data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
  57. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
  58. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  59. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributesCategories.md +18 -0
  60. data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
  61. data/docs/CatalogCategoryEnum.md +15 -0
  62. data/docs/CatalogCategoryItemOp.md +18 -0
  63. data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
  64. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
  65. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  66. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
  67. data/docs/CatalogCategoryUpdateQuery.md +18 -0
  68. data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
  69. data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
  70. data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
  71. data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
  72. data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
  73. data/docs/CatalogItemCategoryOp.md +18 -0
  74. data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
  75. data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
  76. data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  77. data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributesItems.md +18 -0
  78. data/docs/CatalogItemCreateQuery.md +18 -0
  79. data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
  80. data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
  81. data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
  82. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
  83. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
  84. data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
  85. data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
  86. data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  87. data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributesItems.md +18 -0
  88. data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
  89. data/docs/CatalogItemEnum.md +15 -0
  90. data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
  91. data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
  92. data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  93. data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributesItems.md +18 -0
  94. data/docs/CatalogItemUpdateQuery.md +18 -0
  95. data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
  96. data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
  97. data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
  98. data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
  99. data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
  100. data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
  101. data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
  102. data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  103. data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
  104. data/docs/CatalogVariantCreateQuery.md +18 -0
  105. data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
  106. data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
  107. data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
  108. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +18 -0
  109. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md +20 -0
  110. data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
  111. data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
  112. data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  113. data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.md +18 -0
  114. data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
  115. data/docs/CatalogVariantEnum.md +15 -0
  116. data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
  117. data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
  118. data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  119. data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
  120. data/docs/CatalogVariantUpdateQuery.md +18 -0
  121. data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
  122. data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
  123. data/docs/CatalogsApi.md +4103 -0
  124. data/docs/CouponCodeBulkCreateJobEnum.md +15 -0
  125. data/docs/CouponCodeCreateJobCreateQuery.md +18 -0
  126. data/docs/CouponCodeCreateJobCreateQueryResourceObject.md +20 -0
  127. data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  128. data/docs/CouponCodeCreateJobCreateQueryResourceObjectAttributesCouponCodes.md +18 -0
  129. data/docs/CouponCodeCreateQuery.md +18 -0
  130. data/docs/CouponCodeCreateQueryResourceObject.md +22 -0
  131. data/docs/CouponCodeCreateQueryResourceObjectAttributes.md +20 -0
  132. data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +18 -0
  133. data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCoupon.md +18 -0
  134. data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCouponData.md +20 -0
  135. data/docs/CouponCodeEnum.md +15 -0
  136. data/docs/CouponCodeUpdateQuery.md +18 -0
  137. data/docs/CouponCodeUpdateQueryResourceObject.md +22 -0
  138. data/docs/CouponCodeUpdateQueryResourceObjectAttributes.md +20 -0
  139. data/docs/CouponCreateQuery.md +18 -0
  140. data/docs/CouponCreateQueryResourceObject.md +20 -0
  141. data/docs/CouponCreateQueryResourceObjectAttributes.md +20 -0
  142. data/docs/CouponEnum.md +15 -0
  143. data/docs/CouponUpdateQuery.md +18 -0
  144. data/docs/CouponUpdateQueryResourceObject.md +22 -0
  145. data/docs/CouponUpdateQueryResourceObjectAttributes.md +18 -0
  146. data/docs/CouponsApi.md +1277 -0
  147. data/docs/DataPrivacyApi.md +78 -0
  148. data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
  149. data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
  150. data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +18 -0
  151. data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.md +18 -0
  152. data/docs/DataPrivacyDeletionJobEnum.md +15 -0
  153. data/docs/DataPrivacyProfileQueryResourceObject.md +22 -0
  154. data/docs/DataPrivacyProfileQueryResourceObjectAttributes.md +20 -0
  155. data/docs/DeviceMetadata.md +40 -0
  156. data/docs/EmailContentSubObject.md +30 -0
  157. data/docs/EmailSendOptionsSubObject.md +18 -0
  158. data/docs/EmailTrackingOptionsSubObject.md +24 -0
  159. data/docs/EventCreateQueryV2.md +18 -0
  160. data/docs/EventCreateQueryV2ResourceObject.md +20 -0
  161. data/docs/EventCreateQueryV2ResourceObjectAttributes.md +28 -0
  162. data/docs/EventCreateQueryV2ResourceObjectAttributesMetric.md +18 -0
  163. data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +18 -0
  164. data/docs/EventEnum.md +15 -0
  165. data/docs/EventsApi.md +544 -0
  166. data/docs/FlowEnum.md +15 -0
  167. data/docs/FlowUpdateQuery.md +18 -0
  168. data/docs/FlowUpdateQueryResourceObject.md +22 -0
  169. data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
  170. data/docs/FlowsApi.md +1335 -0
  171. data/docs/GetAccounts4XXResponse.md +18 -0
  172. data/docs/GetAccounts4XXResponseErrorsInner.md +26 -0
  173. data/docs/GetAccounts4XXResponseErrorsInnerSource.md +20 -0
  174. data/docs/ImageCreateQuery.md +18 -0
  175. data/docs/ImageCreateQueryResourceObject.md +20 -0
  176. data/docs/ImageCreateQueryResourceObjectAttributes.md +22 -0
  177. data/docs/ImageEnum.md +15 -0
  178. data/docs/ImagePartialUpdateQuery.md +18 -0
  179. data/docs/ImagePartialUpdateQueryResourceObject.md +22 -0
  180. data/docs/ImagePartialUpdateQueryResourceObjectAttributes.md +20 -0
  181. data/docs/ImagesApi.md +389 -0
  182. data/docs/ListCreateQuery.md +18 -0
  183. data/docs/ListCreateQueryResourceObject.md +20 -0
  184. data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
  185. data/docs/ListEnum.md +15 -0
  186. data/docs/ListMembersAddQuery.md +18 -0
  187. data/docs/ListMembersAddQueryDataInner.md +20 -0
  188. data/docs/ListMembersDeleteQuery.md +18 -0
  189. data/docs/ListPartialUpdateQuery.md +18 -0
  190. data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
  191. data/docs/ListsApi.md +850 -0
  192. data/docs/MetricAggregateEnum.md +15 -0
  193. data/docs/MetricAggregateQuery.md +18 -0
  194. data/docs/MetricAggregateQueryResourceObject.md +20 -0
  195. data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
  196. data/docs/MetricCreateQueryResourceObject.md +20 -0
  197. data/docs/MetricCreateQueryResourceObjectAttributes.md +20 -0
  198. data/docs/MetricEnum.md +15 -0
  199. data/docs/MetricsApi.md +233 -0
  200. data/docs/OnsiteProfileCreateQueryResourceObject.md +24 -0
  201. data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +40 -0
  202. data/docs/OnsiteProfileMeta.md +18 -0
  203. data/docs/ProfileCreateQuery.md +18 -0
  204. data/docs/ProfileCreateQueryResourceObject.md +20 -0
  205. data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
  206. data/docs/ProfileEnum.md +15 -0
  207. data/docs/ProfileIdentifierDTOResourceObject.md +22 -0
  208. data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +24 -0
  209. data/docs/ProfileLocation.md +34 -0
  210. data/docs/ProfileLocationLatitude.md +49 -0
  211. data/docs/ProfileLocationLongitude.md +49 -0
  212. data/docs/ProfileMergeEnum.md +15 -0
  213. data/docs/ProfileMergeQuery.md +18 -0
  214. data/docs/ProfileMergeQueryResourceObject.md +22 -0
  215. data/docs/ProfileMergeQueryResourceObjectRelationships.md +18 -0
  216. data/docs/ProfileMergeQueryResourceObjectRelationshipsProfiles.md +18 -0
  217. data/docs/ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.md +20 -0
  218. data/docs/ProfileMeta.md +18 -0
  219. data/docs/ProfileMetaPatchProperties.md +22 -0
  220. data/docs/ProfileMetaPatchPropertiesUnset.md +49 -0
  221. data/docs/ProfilePartialUpdateQuery.md +18 -0
  222. data/docs/ProfilePartialUpdateQueryResourceObject.md +24 -0
  223. data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md +38 -0
  224. data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
  225. data/docs/ProfileSubscriptionBulkDeleteJobEnum.md +15 -0
  226. data/docs/ProfileSubscriptionCreateQueryResourceObject.md +22 -0
  227. data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +22 -0
  228. data/docs/ProfileSubscriptionDeleteQueryResourceObject.md +20 -0
  229. data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +20 -0
  230. data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
  231. data/docs/ProfileSuppressionBulkDeleteJobEnum.md +15 -0
  232. data/docs/ProfileSuppressionCreateQueryResourceObject.md +20 -0
  233. data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +18 -0
  234. data/docs/ProfileSuppressionDeleteQueryResourceObject.md +20 -0
  235. data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +18 -0
  236. data/docs/ProfileUpsertQueryResourceObject.md +22 -0
  237. data/docs/ProfileUpsertQueryResourceObjectAttributes.md +40 -0
  238. data/docs/ProfilesApi.md +1044 -0
  239. data/docs/PushTokenCreateQuery.md +18 -0
  240. data/docs/PushTokenCreateQueryResourceObject.md +20 -0
  241. data/docs/PushTokenCreateQueryResourceObjectAttributes.md +30 -0
  242. data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +18 -0
  243. data/docs/PushTokenEnum.md +15 -0
  244. data/docs/RenderOptionsSubObject.md +24 -0
  245. data/docs/SMSContentSubObjectCreate.md +18 -0
  246. data/docs/SMSSendOptionsSubObject.md +18 -0
  247. data/docs/SMSTrackingOptionsSubObject.md +20 -0
  248. data/docs/STOScheduleOptions.md +18 -0
  249. data/docs/SegmentEnum.md +15 -0
  250. data/docs/SegmentPartialUpdateQuery.md +18 -0
  251. data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
  252. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
  253. data/docs/SegmentsApi.md +561 -0
  254. data/docs/SendStrategySubObject.md +24 -0
  255. data/docs/ServerBISSubscriptionCreateQuery.md +18 -0
  256. data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +22 -0
  257. data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributes.md +20 -0
  258. data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md +18 -0
  259. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +18 -0
  260. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +18 -0
  261. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData.md +20 -0
  262. data/docs/StaticScheduleOptions.md +22 -0
  263. data/docs/SubscriptionChannels.md +20 -0
  264. data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
  265. data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +22 -0
  266. data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +20 -0
  267. data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  268. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +18 -0
  269. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +18 -0
  270. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
  271. data/docs/SubscriptionDeleteJobCreateQuery.md +18 -0
  272. data/docs/SubscriptionDeleteJobCreateQueryResourceObject.md +22 -0
  273. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  274. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  275. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationships.md +18 -0
  276. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsList.md +18 -0
  277. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
  278. data/docs/SuppressionCreateJobCreateQuery.md +18 -0
  279. data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
  280. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  281. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  282. data/docs/SuppressionDeleteJobCreateQuery.md +18 -0
  283. data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +20 -0
  284. data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  285. data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  286. data/docs/TagCampaignOp.md +18 -0
  287. data/docs/TagCampaignOpDataInner.md +20 -0
  288. data/docs/TagCreateQuery.md +18 -0
  289. data/docs/TagCreateQueryResourceObject.md +22 -0
  290. data/docs/TagCreateQueryResourceObjectAttributes.md +18 -0
  291. data/docs/TagCreateQueryResourceObjectRelationships.md +18 -0
  292. data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +18 -0
  293. data/docs/TagCreateQueryResourceObjectRelationshipsTagGroupData.md +20 -0
  294. data/docs/TagEnum.md +15 -0
  295. data/docs/TagFlowOp.md +18 -0
  296. data/docs/TagFlowOpDataInner.md +20 -0
  297. data/docs/TagGroupCreateQuery.md +18 -0
  298. data/docs/TagGroupCreateQueryResourceObject.md +20 -0
  299. data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
  300. data/docs/TagGroupEnum.md +15 -0
  301. data/docs/TagGroupUpdateQuery.md +18 -0
  302. data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
  303. data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
  304. data/docs/TagListOp.md +18 -0
  305. data/docs/TagListOpDataInner.md +20 -0
  306. data/docs/TagSegmentOp.md +18 -0
  307. data/docs/TagSegmentOpDataInner.md +20 -0
  308. data/docs/TagUpdateQuery.md +18 -0
  309. data/docs/TagUpdateQueryResourceObject.md +22 -0
  310. data/docs/TagsApi.md +1929 -0
  311. data/docs/TemplateCloneQuery.md +18 -0
  312. data/docs/TemplateCloneQueryResourceObject.md +22 -0
  313. data/docs/TemplateCloneQueryResourceObjectAttributes.md +18 -0
  314. data/docs/TemplateCreateQuery.md +18 -0
  315. data/docs/TemplateCreateQueryResourceObject.md +20 -0
  316. data/docs/TemplateCreateQueryResourceObjectAttributes.md +30 -0
  317. data/docs/TemplateEnum.md +15 -0
  318. data/docs/TemplateRenderQuery.md +18 -0
  319. data/docs/TemplateRenderQueryResourceObject.md +22 -0
  320. data/docs/TemplateRenderQueryResourceObjectAttributes.md +18 -0
  321. data/docs/TemplateUpdateQuery.md +18 -0
  322. data/docs/TemplateUpdateQueryResourceObject.md +22 -0
  323. data/docs/TemplateUpdateQueryResourceObjectAttributes.md +28 -0
  324. data/docs/TemplatesApi.md +524 -0
  325. data/docs/ThrottledScheduleOptions.md +20 -0
  326. data/docs/UTMParamsSubObject.md +20 -0
  327. data/git_push.sh +57 -0
  328. data/klaviyo-api-sdk.gemspec +2 -2
  329. data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
  330. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +85 -85
  331. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +309 -309
  332. data/lib/klaviyo-api-sdk/api/coupons_api.rb +1226 -0
  333. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  334. data/lib/klaviyo-api-sdk/api/events_api.rb +40 -40
  335. data/lib/klaviyo-api-sdk/api/flows_api.rb +235 -91
  336. data/lib/klaviyo-api-sdk/api/images_api.rb +407 -0
  337. data/lib/klaviyo-api-sdk/api/lists_api.rb +77 -49
  338. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  339. data/lib/klaviyo-api-sdk/api/profiles_api.rb +189 -49
  340. data/lib/klaviyo-api-sdk/api/segments_api.rb +69 -41
  341. data/lib/klaviyo-api-sdk/api/tags_api.rb +89 -89
  342. data/lib/klaviyo-api-sdk/api/templates_api.rb +24 -24
  343. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  344. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  345. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  349. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +34 -19
  350. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +5 -20
  351. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
  353. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +28 -28
  354. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  356. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +26 -25
  360. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +3 -36
  363. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +19 -19
  364. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +23 -23
  365. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  367. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
  369. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +15 -15
  370. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  371. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
  372. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
  373. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  374. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +20 -19
  375. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  376. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +20 -19
  378. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  379. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  380. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
  381. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  382. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  383. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  384. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
  387. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  388. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  390. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
  391. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +17 -17
  392. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships.rb → catalog_category_create_query_resource_object_relationships.rb} +5 -5
  393. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items.rb → catalog_category_create_query_resource_object_relationships_items.rb} +5 -5
  394. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items_data_inner.rb → catalog_category_create_query_resource_object_relationships_items_data_inner.rb} +6 -39
  395. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  396. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
  397. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  398. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  399. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  400. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  401. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  402. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  403. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
  404. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  405. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  406. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  407. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
  408. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  409. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  410. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  411. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  412. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  413. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  414. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
  415. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  416. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  417. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  418. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
  419. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -72
  420. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  421. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
  422. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +239 -0
  423. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  424. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
  425. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  426. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  427. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  428. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  429. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  430. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
  431. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  432. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  433. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  434. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
  435. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
  436. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  437. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  438. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  439. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  440. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
  441. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  442. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  443. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  444. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
  445. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +118 -116
  446. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
  447. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +2 -2
  448. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +239 -0
  449. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  450. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
  451. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  452. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  453. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  454. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  455. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  456. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
  457. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  458. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  459. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  460. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
  461. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +58 -58
  462. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +36 -0
  463. data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_resource_object_attributes.rb → coupon_code_create_job_create_query.rb} +14 -15
  464. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +238 -0
  465. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +224 -0
  466. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +227 -0
  467. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +224 -0
  468. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +247 -0
  469. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +235 -0
  470. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +219 -0
  471. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +224 -0
  472. data/lib/klaviyo-api-sdk/models/{campaign_message_assign_template_query_resource_object_attributes.rb → coupon_code_create_query_resource_object_relationships_coupon_data.rb} +19 -6
  473. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +36 -0
  474. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +224 -0
  475. data/lib/klaviyo-api-sdk/models/{catalog_item_category_op_data_inner.rb → coupon_code_update_query_resource_object.rb} +23 -42
  476. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +264 -0
  477. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +224 -0
  478. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +238 -0
  479. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +235 -0
  480. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +36 -0
  481. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +224 -0
  482. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +253 -0
  483. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +220 -0
  484. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  485. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
  486. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  487. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  488. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  489. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +19 -19
  490. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +15 -15
  491. data/lib/klaviyo-api-sdk/models/device_metadata.rb +388 -0
  492. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +39 -9
  493. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
  494. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +22 -22
  495. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  496. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +19 -19
  497. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +41 -41
  498. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  499. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  500. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  501. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  502. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  503. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
  504. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  505. data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response.rb → get_accounts4_xx_response.rb} +5 -5
  506. data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner.rb → get_accounts4_xx_response_errors_inner.rb} +40 -40
  507. data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner_source.rb → get_accounts4_xx_response_errors_inner_source.rb} +17 -17
  508. data/lib/klaviyo-api-sdk/models/image_create_query.rb +224 -0
  509. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +238 -0
  510. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +247 -0
  511. data/lib/klaviyo-api-sdk/models/image_enum.rb +36 -0
  512. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +224 -0
  513. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +253 -0
  514. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +230 -0
  515. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  516. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
  517. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  518. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  519. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  520. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -36
  521. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  522. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  523. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
  524. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  525. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  526. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
  527. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +63 -63
  528. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +19 -19
  529. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  530. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  531. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +28 -28
  532. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +55 -55
  533. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  534. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  535. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
  536. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
  537. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  538. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +19 -19
  539. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +12 -12
  540. data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
  541. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  542. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  543. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +36 -0
  544. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +224 -0
  545. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +248 -0
  546. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +219 -0
  547. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +226 -0
  548. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +239 -0
  549. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  550. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +15 -15
  551. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  552. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  553. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -28
  554. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +45 -45
  555. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  556. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  557. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +19 -19
  558. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +12 -12
  559. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +19 -19
  560. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +15 -15
  561. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  562. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  563. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +19 -19
  564. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  565. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +19 -19
  566. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  567. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +248 -0
  568. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +328 -0
  569. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +224 -0
  570. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +238 -0
  571. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +372 -0
  572. data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_job_create_query_resource_object_attributes.rb → push_token_create_query_resource_object_attributes_profile.rb} +15 -15
  573. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +36 -0
  574. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +17 -24
  575. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  576. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  577. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
  578. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  579. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
  580. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  581. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +19 -19
  582. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  583. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  584. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
  585. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  586. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +3 -36
  587. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
  588. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
  589. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +15 -15
  590. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
  591. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  592. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
  593. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  594. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +19 -19
  595. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -14
  596. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  597. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +219 -0
  598. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +224 -0
  599. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +239 -0
  600. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  601. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +19 -19
  602. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  603. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  604. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  605. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  606. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +3 -36
  607. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  608. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
  609. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  610. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  611. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  612. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +19 -19
  613. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  614. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  615. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  616. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +3 -36
  617. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  618. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +20 -20
  619. data/lib/klaviyo-api-sdk/models/{tag_update_query_resource_object_attributes.rb → tag_create_query_resource_object_attributes.rb} +4 -4
  620. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  621. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  622. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +3 -36
  623. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  624. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  625. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +3 -36
  626. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  627. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
  628. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +16 -14
  629. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  630. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  631. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
  632. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
  633. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  634. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +3 -36
  635. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  636. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +3 -36
  637. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  638. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
  639. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  640. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +34 -19
  641. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -17
  642. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  643. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
  644. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +25 -25
  645. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  646. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  647. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +34 -19
  648. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +3 -18
  649. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  650. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
  651. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -16
  652. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
  653. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  654. data/lib/klaviyo-api-sdk/version.rb +1 -1
  655. data/lib/klaviyo-api-sdk.rb +58 -12
  656. data/spec/api/accounts_api_spec.rb +60 -0
  657. data/spec/api/campaigns_api_spec.rb +338 -0
  658. data/spec/api/catalogs_api_spec.rb +763 -0
  659. data/spec/api/coupons_api_spec.rb +254 -0
  660. data/spec/api/data_privacy_api_spec.rb +47 -0
  661. data/spec/api/events_api_spec.rb +132 -0
  662. data/spec/api/flows_api_spec.rb +279 -0
  663. data/spec/api/images_api_spec.rb +103 -0
  664. data/spec/api/lists_api_spec.rb +189 -0
  665. data/spec/api/metrics_api_spec.rb +74 -0
  666. data/spec/api/profiles_api_spec.rb +216 -0
  667. data/spec/api/segments_api_spec.rb +139 -0
  668. data/spec/api/tags_api_spec.rb +371 -0
  669. data/spec/api/templates_api_spec.rb +124 -0
  670. data/spec/api_client_spec.rb +226 -0
  671. data/spec/configuration_spec.rb +42 -0
  672. data/spec/models/audiences_sub_object_spec.rb +40 -0
  673. data/spec/models/back_in_stock_subscription_enum_spec.rb +28 -0
  674. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +34 -0
  675. data/spec/models/campaign_clone_query_resource_object_spec.rb +46 -0
  676. data/spec/models/campaign_clone_query_spec.rb +34 -0
  677. data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +34 -0
  678. data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +31 -0
  679. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
  680. data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +31 -0
  681. data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
  682. data/spec/models/campaign_create_query_spec.rb +34 -0
  683. data/spec/models/campaign_enum_spec.rb +28 -0
  684. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +34 -0
  685. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +40 -0
  686. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +34 -0
  687. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +46 -0
  688. data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
  689. data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +31 -0
  690. data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +52 -0
  691. data/spec/models/campaign_message_create_query_resource_object_spec.rb +40 -0
  692. data/spec/models/campaign_message_enum_spec.rb +28 -0
  693. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +46 -0
  694. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
  695. data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
  696. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
  697. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
  698. data/spec/models/campaign_partial_update_query_spec.rb +34 -0
  699. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
  700. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  701. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
  702. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
  703. data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
  704. data/spec/models/campaign_send_job_enum_spec.rb +28 -0
  705. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
  706. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
  707. data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
  708. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
  709. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
  710. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
  711. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
  712. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  713. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
  714. data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
  715. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
  716. data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +40 -0
  717. data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +34 -0
  718. data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +34 -0
  719. data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
  720. data/spec/models/catalog_category_create_query_spec.rb +34 -0
  721. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
  722. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  723. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
  724. data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
  725. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
  726. data/spec/models/catalog_category_enum_spec.rb +28 -0
  727. data/spec/models/catalog_category_item_op_spec.rb +34 -0
  728. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
  729. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  730. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
  731. data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
  732. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
  733. data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
  734. data/spec/models/catalog_category_update_query_spec.rb +34 -0
  735. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
  736. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
  737. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
  738. data/spec/models/catalog_item_category_op_spec.rb +34 -0
  739. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +34 -0
  740. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  741. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
  742. data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
  743. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
  744. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +40 -0
  745. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
  746. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
  747. data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
  748. data/spec/models/catalog_item_create_query_spec.rb +34 -0
  749. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +34 -0
  750. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  751. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
  752. data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
  753. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
  754. data/spec/models/catalog_item_enum_spec.rb +28 -0
  755. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +34 -0
  756. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  757. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
  758. data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
  759. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
  760. data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
  761. data/spec/models/catalog_item_update_query_spec.rb +34 -0
  762. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
  763. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
  764. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
  765. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  766. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
  767. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
  768. data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
  769. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
  770. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +40 -0
  771. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +34 -0
  772. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
  773. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
  774. data/spec/models/catalog_variant_create_query_spec.rb +34 -0
  775. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  776. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
  777. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
  778. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
  779. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
  780. data/spec/models/catalog_variant_enum_spec.rb +28 -0
  781. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  782. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
  783. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
  784. data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
  785. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
  786. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
  787. data/spec/models/catalog_variant_update_query_spec.rb +34 -0
  788. data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +28 -0
  789. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +34 -0
  790. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  791. data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +40 -0
  792. data/spec/models/coupon_code_create_job_create_query_spec.rb +34 -0
  793. data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +40 -0
  794. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +40 -0
  795. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +34 -0
  796. data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +34 -0
  797. data/spec/models/coupon_code_create_query_resource_object_spec.rb +46 -0
  798. data/spec/models/coupon_code_create_query_spec.rb +34 -0
  799. data/spec/models/coupon_code_enum_spec.rb +28 -0
  800. data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +44 -0
  801. data/spec/models/coupon_code_update_query_resource_object_spec.rb +46 -0
  802. data/spec/models/coupon_code_update_query_spec.rb +34 -0
  803. data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +40 -0
  804. data/spec/models/coupon_create_query_resource_object_spec.rb +40 -0
  805. data/spec/models/coupon_create_query_spec.rb +34 -0
  806. data/spec/models/coupon_enum_spec.rb +28 -0
  807. data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +34 -0
  808. data/spec/models/coupon_update_query_resource_object_spec.rb +46 -0
  809. data/spec/models/coupon_update_query_spec.rb +34 -0
  810. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +34 -0
  811. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +34 -0
  812. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
  813. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
  814. data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
  815. data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +40 -0
  816. data/spec/models/data_privacy_profile_query_resource_object_spec.rb +46 -0
  817. data/spec/models/device_metadata_spec.rb +112 -0
  818. data/spec/models/email_content_sub_object_spec.rb +70 -0
  819. data/spec/models/email_send_options_sub_object_spec.rb +34 -0
  820. data/spec/models/email_tracking_options_sub_object_spec.rb +52 -0
  821. data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +34 -0
  822. data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +34 -0
  823. data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +64 -0
  824. data/spec/models/event_create_query_v2_resource_object_spec.rb +40 -0
  825. data/spec/models/event_create_query_v2_spec.rb +34 -0
  826. data/spec/models/event_enum_spec.rb +28 -0
  827. data/spec/models/flow_enum_spec.rb +28 -0
  828. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
  829. data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
  830. data/spec/models/flow_update_query_spec.rb +34 -0
  831. data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +40 -0
  832. data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +58 -0
  833. data/spec/models/get_accounts4_xx_response_spec.rb +34 -0
  834. data/spec/models/image_create_query_resource_object_attributes_spec.rb +46 -0
  835. data/spec/models/image_create_query_resource_object_spec.rb +40 -0
  836. data/spec/models/image_create_query_spec.rb +34 -0
  837. data/spec/models/image_enum_spec.rb +28 -0
  838. data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +40 -0
  839. data/spec/models/image_partial_update_query_resource_object_spec.rb +46 -0
  840. data/spec/models/image_partial_update_query_spec.rb +34 -0
  841. data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
  842. data/spec/models/list_create_query_resource_object_spec.rb +40 -0
  843. data/spec/models/list_create_query_spec.rb +34 -0
  844. data/spec/models/list_enum_spec.rb +28 -0
  845. data/spec/models/list_members_add_query_data_inner_spec.rb +40 -0
  846. data/spec/models/list_members_add_query_spec.rb +34 -0
  847. data/spec/models/list_members_delete_query_spec.rb +34 -0
  848. data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
  849. data/spec/models/list_partial_update_query_spec.rb +34 -0
  850. data/spec/models/metric_aggregate_enum_spec.rb +28 -0
  851. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
  852. data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
  853. data/spec/models/metric_aggregate_query_spec.rb +34 -0
  854. data/spec/models/metric_create_query_resource_object_attributes_spec.rb +40 -0
  855. data/spec/models/metric_create_query_resource_object_spec.rb +40 -0
  856. data/spec/models/metric_enum_spec.rb +28 -0
  857. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +100 -0
  858. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +52 -0
  859. data/spec/models/onsite_profile_meta_spec.rb +34 -0
  860. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
  861. data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
  862. data/spec/models/profile_create_query_spec.rb +34 -0
  863. data/spec/models/profile_enum_spec.rb +28 -0
  864. data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +52 -0
  865. data/spec/models/profile_identifier_dto_resource_object_spec.rb +46 -0
  866. data/spec/models/profile_location_latitude_spec.rb +31 -0
  867. data/spec/models/profile_location_longitude_spec.rb +31 -0
  868. data/spec/models/profile_location_spec.rb +82 -0
  869. data/spec/models/profile_merge_enum_spec.rb +28 -0
  870. data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +40 -0
  871. data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +34 -0
  872. data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +34 -0
  873. data/spec/models/profile_merge_query_resource_object_spec.rb +46 -0
  874. data/spec/models/profile_merge_query_spec.rb +34 -0
  875. data/spec/models/profile_meta_patch_properties_spec.rb +46 -0
  876. data/spec/models/profile_meta_patch_properties_unset_spec.rb +31 -0
  877. data/spec/models/profile_meta_spec.rb +34 -0
  878. data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +94 -0
  879. data/spec/models/profile_partial_update_query_resource_object_spec.rb +52 -0
  880. data/spec/models/profile_partial_update_query_spec.rb +34 -0
  881. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
  882. data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +28 -0
  883. data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +46 -0
  884. data/spec/models/profile_subscription_create_query_resource_object_spec.rb +46 -0
  885. data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +40 -0
  886. data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +40 -0
  887. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
  888. data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +28 -0
  889. data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +34 -0
  890. data/spec/models/profile_suppression_create_query_resource_object_spec.rb +40 -0
  891. data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +34 -0
  892. data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +40 -0
  893. data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +100 -0
  894. data/spec/models/profile_upsert_query_resource_object_spec.rb +46 -0
  895. data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +34 -0
  896. data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +86 -0
  897. data/spec/models/push_token_create_query_resource_object_spec.rb +40 -0
  898. data/spec/models/push_token_create_query_spec.rb +34 -0
  899. data/spec/models/push_token_enum_spec.rb +28 -0
  900. data/spec/models/render_options_sub_object_spec.rb +52 -0
  901. data/spec/models/segment_enum_spec.rb +28 -0
  902. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
  903. data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
  904. data/spec/models/segment_partial_update_query_spec.rb +34 -0
  905. data/spec/models/send_strategy_sub_object_spec.rb +52 -0
  906. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +34 -0
  907. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +44 -0
  908. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +34 -0
  909. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +40 -0
  910. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +34 -0
  911. data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +46 -0
  912. data/spec/models/server_bis_subscription_create_query_spec.rb +34 -0
  913. data/spec/models/sms_content_sub_object_create_spec.rb +34 -0
  914. data/spec/models/sms_send_options_sub_object_spec.rb +34 -0
  915. data/spec/models/sms_tracking_options_sub_object_spec.rb +40 -0
  916. data/spec/models/static_schedule_options_spec.rb +46 -0
  917. data/spec/models/sto_schedule_options_spec.rb +34 -0
  918. data/spec/models/subscription_channels_spec.rb +48 -0
  919. data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  920. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +40 -0
  921. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
  922. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +34 -0
  923. data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +34 -0
  924. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +46 -0
  925. data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
  926. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  927. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  928. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
  929. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +34 -0
  930. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +34 -0
  931. data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +46 -0
  932. data/spec/models/subscription_delete_job_create_query_spec.rb +34 -0
  933. data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  934. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  935. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
  936. data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
  937. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  938. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  939. data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +40 -0
  940. data/spec/models/suppression_delete_job_create_query_spec.rb +34 -0
  941. data/spec/models/tag_campaign_op_data_inner_spec.rb +40 -0
  942. data/spec/models/tag_campaign_op_spec.rb +34 -0
  943. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +34 -0
  944. data/spec/models/tag_create_query_resource_object_relationships_spec.rb +34 -0
  945. data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +40 -0
  946. data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +34 -0
  947. data/spec/models/tag_create_query_resource_object_spec.rb +46 -0
  948. data/spec/models/tag_create_query_spec.rb +34 -0
  949. data/spec/models/tag_enum_spec.rb +28 -0
  950. data/spec/models/tag_flow_op_data_inner_spec.rb +40 -0
  951. data/spec/models/tag_flow_op_spec.rb +34 -0
  952. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
  953. data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
  954. data/spec/models/tag_group_create_query_spec.rb +34 -0
  955. data/spec/models/tag_group_enum_spec.rb +28 -0
  956. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
  957. data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
  958. data/spec/models/tag_group_update_query_spec.rb +34 -0
  959. data/spec/models/tag_list_op_data_inner_spec.rb +40 -0
  960. data/spec/models/tag_list_op_spec.rb +34 -0
  961. data/spec/models/tag_segment_op_data_inner_spec.rb +40 -0
  962. data/spec/models/tag_segment_op_spec.rb +34 -0
  963. data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
  964. data/spec/models/tag_update_query_spec.rb +34 -0
  965. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +34 -0
  966. data/spec/models/template_clone_query_resource_object_spec.rb +46 -0
  967. data/spec/models/template_clone_query_spec.rb +34 -0
  968. data/spec/models/template_create_query_resource_object_attributes_spec.rb +52 -0
  969. data/spec/models/template_create_query_resource_object_spec.rb +40 -0
  970. data/spec/models/template_create_query_spec.rb +34 -0
  971. data/spec/models/template_enum_spec.rb +28 -0
  972. data/spec/models/template_render_query_resource_object_attributes_spec.rb +34 -0
  973. data/spec/models/template_render_query_resource_object_spec.rb +46 -0
  974. data/spec/models/template_render_query_spec.rb +34 -0
  975. data/spec/models/template_update_query_resource_object_attributes_spec.rb +46 -0
  976. data/spec/models/template_update_query_resource_object_spec.rb +46 -0
  977. data/spec/models/template_update_query_spec.rb +34 -0
  978. data/spec/models/throttled_schedule_options_spec.rb +40 -0
  979. data/spec/models/utm_params_sub_object_spec.rb +40 -0
  980. data/spec/spec_helper.rb +111 -0
  981. metadata +714 -18
  982. data/CHANGELOG.md +0 -91
data/docs/TagsApi.md ADDED
@@ -0,0 +1,1929 @@
1
+ # KlaviyoAPI::TagsApi
2
+
3
+ All URIs are relative to *https://a.klaviyo.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_tag**](TagsApi.md#create_tag) | **POST** /api/tags/ | Create Tag |
8
+ | [**create_tag_group**](TagsApi.md#create_tag_group) | **POST** /api/tag-groups/ | Create Tag Group |
9
+ | [**create_tag_relationships_campaigns**](TagsApi.md#create_tag_relationships_campaigns) | **POST** /api/tags/{id}/relationships/campaigns/ | Create Tag Relationships Campaigns |
10
+ | [**create_tag_relationships_flows**](TagsApi.md#create_tag_relationships_flows) | **POST** /api/tags/{id}/relationships/flows/ | Create Tag Relationships Flows |
11
+ | [**create_tag_relationships_lists**](TagsApi.md#create_tag_relationships_lists) | **POST** /api/tags/{id}/relationships/lists/ | Create Tag Relationships Lists |
12
+ | [**create_tag_relationships_segments**](TagsApi.md#create_tag_relationships_segments) | **POST** /api/tags/{id}/relationships/segments/ | Create Tag Relationships Segments |
13
+ | [**delete_tag**](TagsApi.md#delete_tag) | **DELETE** /api/tags/{id}/ | Delete Tag |
14
+ | [**delete_tag_group**](TagsApi.md#delete_tag_group) | **DELETE** /api/tag-groups/{id}/ | Delete Tag Group |
15
+ | [**delete_tag_relationships_campaigns**](TagsApi.md#delete_tag_relationships_campaigns) | **DELETE** /api/tags/{id}/relationships/campaigns/ | Delete Tag Relationships Campaigns |
16
+ | [**delete_tag_relationships_flows**](TagsApi.md#delete_tag_relationships_flows) | **DELETE** /api/tags/{id}/relationships/flows/ | Delete Tag Relationships Flows |
17
+ | [**delete_tag_relationships_lists**](TagsApi.md#delete_tag_relationships_lists) | **DELETE** /api/tags/{id}/relationships/lists/ | Delete Tag Relationships Lists |
18
+ | [**delete_tag_relationships_segments**](TagsApi.md#delete_tag_relationships_segments) | **DELETE** /api/tags/{id}/relationships/segments/ | Delete Tag Relationships Segments |
19
+ | [**get_tag**](TagsApi.md#get_tag) | **GET** /api/tags/{id}/ | Get Tag |
20
+ | [**get_tag_group**](TagsApi.md#get_tag_group) | **GET** /api/tag-groups/{id}/ | Get Tag Group |
21
+ | [**get_tag_group_relationships_tags**](TagsApi.md#get_tag_group_relationships_tags) | **GET** /api/tag-groups/{id}/relationships/tags/ | Get Tag Group Relationships Tags |
22
+ | [**get_tag_group_tags**](TagsApi.md#get_tag_group_tags) | **GET** /api/tag-groups/{id}/tags/ | Get Tag Group Tags |
23
+ | [**get_tag_groups**](TagsApi.md#get_tag_groups) | **GET** /api/tag-groups/ | Get Tag Groups |
24
+ | [**get_tag_relationships_campaigns**](TagsApi.md#get_tag_relationships_campaigns) | **GET** /api/tags/{id}/relationships/campaigns/ | Get Tag Relationships Campaigns |
25
+ | [**get_tag_relationships_flows**](TagsApi.md#get_tag_relationships_flows) | **GET** /api/tags/{id}/relationships/flows/ | Get Tag Relationships Flows |
26
+ | [**get_tag_relationships_lists**](TagsApi.md#get_tag_relationships_lists) | **GET** /api/tags/{id}/relationships/lists/ | Get Tag Relationships Lists |
27
+ | [**get_tag_relationships_segments**](TagsApi.md#get_tag_relationships_segments) | **GET** /api/tags/{id}/relationships/segments/ | Get Tag Relationships Segments |
28
+ | [**get_tag_relationships_tag_group**](TagsApi.md#get_tag_relationships_tag_group) | **GET** /api/tags/{id}/relationships/tag-group/ | Get Tag Relationships Tag Group |
29
+ | [**get_tag_tag_group**](TagsApi.md#get_tag_tag_group) | **GET** /api/tags/{id}/tag-group/ | Get Tag Tag Group |
30
+ | [**get_tags**](TagsApi.md#get_tags) | **GET** /api/tags/ | Get Tags |
31
+ | [**update_tag**](TagsApi.md#update_tag) | **PATCH** /api/tags/{id}/ | Update Tag |
32
+ | [**update_tag_group**](TagsApi.md#update_tag_group) | **PATCH** /api/tag-groups/{id}/ | Update Tag Group |
33
+
34
+
35
+ ## create_tag
36
+
37
+ > Hash<String, Object> create_tag(tag_create_query)
38
+
39
+ Create Tag
40
+
41
+ Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
42
+
43
+ ### Examples
44
+
45
+ ```ruby
46
+ require 'time'
47
+ require 'klaviyo-api-sdk'
48
+ # setup authorization
49
+ KlaviyoAPI.configure do |config|
50
+ # Configure API key authorization: Klaviyo-API-Key
51
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
52
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
53
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
54
+ end
55
+
56
+ api_instance = KlaviyoAPI::TagsApi.new
57
+ tag_create_query = KlaviyoAPI::TagCreateQuery.new({data: KlaviyoAPI::TagCreateQueryResourceObject.new({type: KlaviyoAPI::TagEnum::TAG, attributes: KlaviyoAPI::TagCreateQueryResourceObjectAttributes.new({name: 'My Tag'})})}) # TagCreateQuery |
58
+
59
+ begin
60
+ # Create Tag
61
+ result = api_instance.create_tag(tag_create_query)
62
+ p result
63
+ rescue KlaviyoAPI::ApiError => e
64
+ puts "Error when calling TagsApi->create_tag: #{e}"
65
+ end
66
+ ```
67
+
68
+ #### Using the create_tag_with_http_info variant
69
+
70
+ This returns an Array which contains the response data, status code and headers.
71
+
72
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_tag_with_http_info(tag_create_query)
73
+
74
+ ```ruby
75
+ begin
76
+ # Create Tag
77
+ data, status_code, headers = api_instance.create_tag_with_http_info(tag_create_query)
78
+ p status_code # => 2xx
79
+ p headers # => { ... }
80
+ p data # => Hash&lt;String, Object&gt;
81
+ rescue KlaviyoAPI::ApiError => e
82
+ puts "Error when calling TagsApi->create_tag_with_http_info: #{e}"
83
+ end
84
+ ```
85
+
86
+ ### Parameters
87
+
88
+ | Name | Type | Description | Notes |
89
+ | ---- | ---- | ----------- | ----- |
90
+ | **tag_create_query** | [**TagCreateQuery**](TagCreateQuery.md) | | |
91
+
92
+ ### Return type
93
+
94
+ **Hash&lt;String, Object&gt;**
95
+
96
+ ### Authorization
97
+
98
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
99
+
100
+ ### HTTP request headers
101
+
102
+ - **Content-Type**: application/json
103
+ - **Accept**: application/json
104
+
105
+
106
+ ## create_tag_group
107
+
108
+ > Hash&lt;String, Object&gt; create_tag_group(tag_group_create_query)
109
+
110
+ Create Tag Group
111
+
112
+ Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
113
+
114
+ ### Examples
115
+
116
+ ```ruby
117
+ require 'time'
118
+ require 'klaviyo-api-sdk'
119
+ # setup authorization
120
+ KlaviyoAPI.configure do |config|
121
+ # Configure API key authorization: Klaviyo-API-Key
122
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
123
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
124
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
125
+ end
126
+
127
+ api_instance = KlaviyoAPI::TagsApi.new
128
+ tag_group_create_query = KlaviyoAPI::TagGroupCreateQuery.new({data: KlaviyoAPI::TagGroupCreateQueryResourceObject.new({type: KlaviyoAPI::TagGroupEnum::TAG_GROUP, attributes: KlaviyoAPI::TagGroupCreateQueryResourceObjectAttributes.new({name: 'My Tag Group'})})}) # TagGroupCreateQuery |
129
+
130
+ begin
131
+ # Create Tag Group
132
+ result = api_instance.create_tag_group(tag_group_create_query)
133
+ p result
134
+ rescue KlaviyoAPI::ApiError => e
135
+ puts "Error when calling TagsApi->create_tag_group: #{e}"
136
+ end
137
+ ```
138
+
139
+ #### Using the create_tag_group_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_tag_group_with_http_info(tag_group_create_query)
144
+
145
+ ```ruby
146
+ begin
147
+ # Create Tag Group
148
+ data, status_code, headers = api_instance.create_tag_group_with_http_info(tag_group_create_query)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => Hash&lt;String, Object&gt;
152
+ rescue KlaviyoAPI::ApiError => e
153
+ puts "Error when calling TagsApi->create_tag_group_with_http_info: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Name | Type | Description | Notes |
160
+ | ---- | ---- | ----------- | ----- |
161
+ | **tag_group_create_query** | [**TagGroupCreateQuery**](TagGroupCreateQuery.md) | | |
162
+
163
+ ### Return type
164
+
165
+ **Hash&lt;String, Object&gt;**
166
+
167
+ ### Authorization
168
+
169
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
170
+
171
+ ### HTTP request headers
172
+
173
+ - **Content-Type**: application/json
174
+ - **Accept**: application/json
175
+
176
+
177
+ ## create_tag_relationships_campaigns
178
+
179
+ > create_tag_relationships_campaigns(id, tag_campaign_op)
180
+
181
+ Create Tag Relationships Campaigns
182
+
183
+ Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
184
+
185
+ ### Examples
186
+
187
+ ```ruby
188
+ require 'time'
189
+ require 'klaviyo-api-sdk'
190
+ # setup authorization
191
+ KlaviyoAPI.configure do |config|
192
+ # Configure API key authorization: Klaviyo-API-Key
193
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
194
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
195
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
196
+ end
197
+
198
+ api_instance = KlaviyoAPI::TagsApi.new
199
+ id = 'id_example' # String |
200
+ tag_campaign_op = KlaviyoAPI::TagCampaignOp.new({data: [KlaviyoAPI::TagCampaignOpDataInner.new({type: KlaviyoAPI::CampaignEnum::CAMPAIGN, id: 'id_example'})]}) # TagCampaignOp |
201
+
202
+ begin
203
+ # Create Tag Relationships Campaigns
204
+ api_instance.create_tag_relationships_campaigns(id, tag_campaign_op)
205
+ rescue KlaviyoAPI::ApiError => e
206
+ puts "Error when calling TagsApi->create_tag_relationships_campaigns: #{e}"
207
+ end
208
+ ```
209
+
210
+ #### Using the create_tag_relationships_campaigns_with_http_info variant
211
+
212
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
213
+
214
+ > <Array(nil, Integer, Hash)> create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
215
+
216
+ ```ruby
217
+ begin
218
+ # Create Tag Relationships Campaigns
219
+ data, status_code, headers = api_instance.create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
220
+ p status_code # => 2xx
221
+ p headers # => { ... }
222
+ p data # => nil
223
+ rescue KlaviyoAPI::ApiError => e
224
+ puts "Error when calling TagsApi->create_tag_relationships_campaigns_with_http_info: #{e}"
225
+ end
226
+ ```
227
+
228
+ ### Parameters
229
+
230
+ | Name | Type | Description | Notes |
231
+ | ---- | ---- | ----------- | ----- |
232
+ | **id** | **String** | | |
233
+ | **tag_campaign_op** | [**TagCampaignOp**](TagCampaignOp.md) | | |
234
+
235
+ ### Return type
236
+
237
+ nil (empty response body)
238
+
239
+ ### Authorization
240
+
241
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
242
+
243
+ ### HTTP request headers
244
+
245
+ - **Content-Type**: application/json
246
+ - **Accept**: application/json
247
+
248
+
249
+ ## create_tag_relationships_flows
250
+
251
+ > create_tag_relationships_flows(id, tag_flow_op)
252
+
253
+ Create Tag Relationships Flows
254
+
255
+ Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
256
+
257
+ ### Examples
258
+
259
+ ```ruby
260
+ require 'time'
261
+ require 'klaviyo-api-sdk'
262
+ # setup authorization
263
+ KlaviyoAPI.configure do |config|
264
+ # Configure API key authorization: Klaviyo-API-Key
265
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
266
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
267
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
268
+ end
269
+
270
+ api_instance = KlaviyoAPI::TagsApi.new
271
+ id = 'id_example' # String |
272
+ tag_flow_op = KlaviyoAPI::TagFlowOp.new({data: [KlaviyoAPI::TagFlowOpDataInner.new({type: KlaviyoAPI::FlowEnum::FLOW, id: 'id_example'})]}) # TagFlowOp |
273
+
274
+ begin
275
+ # Create Tag Relationships Flows
276
+ api_instance.create_tag_relationships_flows(id, tag_flow_op)
277
+ rescue KlaviyoAPI::ApiError => e
278
+ puts "Error when calling TagsApi->create_tag_relationships_flows: #{e}"
279
+ end
280
+ ```
281
+
282
+ #### Using the create_tag_relationships_flows_with_http_info variant
283
+
284
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
285
+
286
+ > <Array(nil, Integer, Hash)> create_tag_relationships_flows_with_http_info(id, tag_flow_op)
287
+
288
+ ```ruby
289
+ begin
290
+ # Create Tag Relationships Flows
291
+ data, status_code, headers = api_instance.create_tag_relationships_flows_with_http_info(id, tag_flow_op)
292
+ p status_code # => 2xx
293
+ p headers # => { ... }
294
+ p data # => nil
295
+ rescue KlaviyoAPI::ApiError => e
296
+ puts "Error when calling TagsApi->create_tag_relationships_flows_with_http_info: #{e}"
297
+ end
298
+ ```
299
+
300
+ ### Parameters
301
+
302
+ | Name | Type | Description | Notes |
303
+ | ---- | ---- | ----------- | ----- |
304
+ | **id** | **String** | | |
305
+ | **tag_flow_op** | [**TagFlowOp**](TagFlowOp.md) | | |
306
+
307
+ ### Return type
308
+
309
+ nil (empty response body)
310
+
311
+ ### Authorization
312
+
313
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
314
+
315
+ ### HTTP request headers
316
+
317
+ - **Content-Type**: application/json
318
+ - **Accept**: application/json
319
+
320
+
321
+ ## create_tag_relationships_lists
322
+
323
+ > create_tag_relationships_lists(id, tag_list_op)
324
+
325
+ Create Tag Relationships Lists
326
+
327
+ Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:write` `tags:write`
328
+
329
+ ### Examples
330
+
331
+ ```ruby
332
+ require 'time'
333
+ require 'klaviyo-api-sdk'
334
+ # setup authorization
335
+ KlaviyoAPI.configure do |config|
336
+ # Configure API key authorization: Klaviyo-API-Key
337
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
338
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
339
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
340
+ end
341
+
342
+ api_instance = KlaviyoAPI::TagsApi.new
343
+ id = 'id_example' # String |
344
+ tag_list_op = KlaviyoAPI::TagListOp.new({data: [KlaviyoAPI::TagListOpDataInner.new({type: KlaviyoAPI::ListEnum::LIST, id: 'id_example'})]}) # TagListOp |
345
+
346
+ begin
347
+ # Create Tag Relationships Lists
348
+ api_instance.create_tag_relationships_lists(id, tag_list_op)
349
+ rescue KlaviyoAPI::ApiError => e
350
+ puts "Error when calling TagsApi->create_tag_relationships_lists: #{e}"
351
+ end
352
+ ```
353
+
354
+ #### Using the create_tag_relationships_lists_with_http_info variant
355
+
356
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
357
+
358
+ > <Array(nil, Integer, Hash)> create_tag_relationships_lists_with_http_info(id, tag_list_op)
359
+
360
+ ```ruby
361
+ begin
362
+ # Create Tag Relationships Lists
363
+ data, status_code, headers = api_instance.create_tag_relationships_lists_with_http_info(id, tag_list_op)
364
+ p status_code # => 2xx
365
+ p headers # => { ... }
366
+ p data # => nil
367
+ rescue KlaviyoAPI::ApiError => e
368
+ puts "Error when calling TagsApi->create_tag_relationships_lists_with_http_info: #{e}"
369
+ end
370
+ ```
371
+
372
+ ### Parameters
373
+
374
+ | Name | Type | Description | Notes |
375
+ | ---- | ---- | ----------- | ----- |
376
+ | **id** | **String** | | |
377
+ | **tag_list_op** | [**TagListOp**](TagListOp.md) | | |
378
+
379
+ ### Return type
380
+
381
+ nil (empty response body)
382
+
383
+ ### Authorization
384
+
385
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
386
+
387
+ ### HTTP request headers
388
+
389
+ - **Content-Type**: application/json
390
+ - **Accept**: application/json
391
+
392
+
393
+ ## create_tag_relationships_segments
394
+
395
+ > create_tag_relationships_segments(id, tag_segment_op)
396
+
397
+ Create Tag Relationships Segments
398
+
399
+ Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
400
+
401
+ ### Examples
402
+
403
+ ```ruby
404
+ require 'time'
405
+ require 'klaviyo-api-sdk'
406
+ # setup authorization
407
+ KlaviyoAPI.configure do |config|
408
+ # Configure API key authorization: Klaviyo-API-Key
409
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
410
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
411
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
412
+ end
413
+
414
+ api_instance = KlaviyoAPI::TagsApi.new
415
+ id = 'id_example' # String |
416
+ tag_segment_op = KlaviyoAPI::TagSegmentOp.new({data: [KlaviyoAPI::TagSegmentOpDataInner.new({type: KlaviyoAPI::SegmentEnum::SEGMENT, id: 'id_example'})]}) # TagSegmentOp |
417
+
418
+ begin
419
+ # Create Tag Relationships Segments
420
+ api_instance.create_tag_relationships_segments(id, tag_segment_op)
421
+ rescue KlaviyoAPI::ApiError => e
422
+ puts "Error when calling TagsApi->create_tag_relationships_segments: #{e}"
423
+ end
424
+ ```
425
+
426
+ #### Using the create_tag_relationships_segments_with_http_info variant
427
+
428
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
429
+
430
+ > <Array(nil, Integer, Hash)> create_tag_relationships_segments_with_http_info(id, tag_segment_op)
431
+
432
+ ```ruby
433
+ begin
434
+ # Create Tag Relationships Segments
435
+ data, status_code, headers = api_instance.create_tag_relationships_segments_with_http_info(id, tag_segment_op)
436
+ p status_code # => 2xx
437
+ p headers # => { ... }
438
+ p data # => nil
439
+ rescue KlaviyoAPI::ApiError => e
440
+ puts "Error when calling TagsApi->create_tag_relationships_segments_with_http_info: #{e}"
441
+ end
442
+ ```
443
+
444
+ ### Parameters
445
+
446
+ | Name | Type | Description | Notes |
447
+ | ---- | ---- | ----------- | ----- |
448
+ | **id** | **String** | | |
449
+ | **tag_segment_op** | [**TagSegmentOp**](TagSegmentOp.md) | | |
450
+
451
+ ### Return type
452
+
453
+ nil (empty response body)
454
+
455
+ ### Authorization
456
+
457
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
458
+
459
+ ### HTTP request headers
460
+
461
+ - **Content-Type**: application/json
462
+ - **Accept**: application/json
463
+
464
+
465
+ ## delete_tag
466
+
467
+ > delete_tag(id)
468
+
469
+ Delete Tag
470
+
471
+ Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
472
+
473
+ ### Examples
474
+
475
+ ```ruby
476
+ require 'time'
477
+ require 'klaviyo-api-sdk'
478
+ # setup authorization
479
+ KlaviyoAPI.configure do |config|
480
+ # Configure API key authorization: Klaviyo-API-Key
481
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
482
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
483
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
484
+ end
485
+
486
+ api_instance = KlaviyoAPI::TagsApi.new
487
+ id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
488
+
489
+ begin
490
+ # Delete Tag
491
+ api_instance.delete_tag(id)
492
+ rescue KlaviyoAPI::ApiError => e
493
+ puts "Error when calling TagsApi->delete_tag: #{e}"
494
+ end
495
+ ```
496
+
497
+ #### Using the delete_tag_with_http_info variant
498
+
499
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
500
+
501
+ > <Array(nil, Integer, Hash)> delete_tag_with_http_info(id)
502
+
503
+ ```ruby
504
+ begin
505
+ # Delete Tag
506
+ data, status_code, headers = api_instance.delete_tag_with_http_info(id)
507
+ p status_code # => 2xx
508
+ p headers # => { ... }
509
+ p data # => nil
510
+ rescue KlaviyoAPI::ApiError => e
511
+ puts "Error when calling TagsApi->delete_tag_with_http_info: #{e}"
512
+ end
513
+ ```
514
+
515
+ ### Parameters
516
+
517
+ | Name | Type | Description | Notes |
518
+ | ---- | ---- | ----------- | ----- |
519
+ | **id** | **String** | The Tag ID | |
520
+
521
+ ### Return type
522
+
523
+ nil (empty response body)
524
+
525
+ ### Authorization
526
+
527
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
528
+
529
+ ### HTTP request headers
530
+
531
+ - **Content-Type**: Not defined
532
+ - **Accept**: application/json
533
+
534
+
535
+ ## delete_tag_group
536
+
537
+ > Hash&lt;String, Object&gt; delete_tag_group(id)
538
+
539
+ Delete Tag Group
540
+
541
+ Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
542
+
543
+ ### Examples
544
+
545
+ ```ruby
546
+ require 'time'
547
+ require 'klaviyo-api-sdk'
548
+ # setup authorization
549
+ KlaviyoAPI.configure do |config|
550
+ # Configure API key authorization: Klaviyo-API-Key
551
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
552
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
553
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
554
+ end
555
+
556
+ api_instance = KlaviyoAPI::TagsApi.new
557
+ id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
558
+
559
+ begin
560
+ # Delete Tag Group
561
+ result = api_instance.delete_tag_group(id)
562
+ p result
563
+ rescue KlaviyoAPI::ApiError => e
564
+ puts "Error when calling TagsApi->delete_tag_group: #{e}"
565
+ end
566
+ ```
567
+
568
+ #### Using the delete_tag_group_with_http_info variant
569
+
570
+ This returns an Array which contains the response data, status code and headers.
571
+
572
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> delete_tag_group_with_http_info(id)
573
+
574
+ ```ruby
575
+ begin
576
+ # Delete Tag Group
577
+ data, status_code, headers = api_instance.delete_tag_group_with_http_info(id)
578
+ p status_code # => 2xx
579
+ p headers # => { ... }
580
+ p data # => Hash&lt;String, Object&gt;
581
+ rescue KlaviyoAPI::ApiError => e
582
+ puts "Error when calling TagsApi->delete_tag_group_with_http_info: #{e}"
583
+ end
584
+ ```
585
+
586
+ ### Parameters
587
+
588
+ | Name | Type | Description | Notes |
589
+ | ---- | ---- | ----------- | ----- |
590
+ | **id** | **String** | The Tag Group ID | |
591
+
592
+ ### Return type
593
+
594
+ **Hash&lt;String, Object&gt;**
595
+
596
+ ### Authorization
597
+
598
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
599
+
600
+ ### HTTP request headers
601
+
602
+ - **Content-Type**: Not defined
603
+ - **Accept**: application/json
604
+
605
+
606
+ ## delete_tag_relationships_campaigns
607
+
608
+ > delete_tag_relationships_campaigns(id, tag_campaign_op)
609
+
610
+ Delete Tag Relationships Campaigns
611
+
612
+ Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
613
+
614
+ ### Examples
615
+
616
+ ```ruby
617
+ require 'time'
618
+ require 'klaviyo-api-sdk'
619
+ # setup authorization
620
+ KlaviyoAPI.configure do |config|
621
+ # Configure API key authorization: Klaviyo-API-Key
622
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
623
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
624
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
625
+ end
626
+
627
+ api_instance = KlaviyoAPI::TagsApi.new
628
+ id = 'id_example' # String |
629
+ tag_campaign_op = KlaviyoAPI::TagCampaignOp.new({data: [KlaviyoAPI::TagCampaignOpDataInner.new({type: KlaviyoAPI::CampaignEnum::CAMPAIGN, id: 'id_example'})]}) # TagCampaignOp |
630
+
631
+ begin
632
+ # Delete Tag Relationships Campaigns
633
+ api_instance.delete_tag_relationships_campaigns(id, tag_campaign_op)
634
+ rescue KlaviyoAPI::ApiError => e
635
+ puts "Error when calling TagsApi->delete_tag_relationships_campaigns: #{e}"
636
+ end
637
+ ```
638
+
639
+ #### Using the delete_tag_relationships_campaigns_with_http_info variant
640
+
641
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
642
+
643
+ > <Array(nil, Integer, Hash)> delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
644
+
645
+ ```ruby
646
+ begin
647
+ # Delete Tag Relationships Campaigns
648
+ data, status_code, headers = api_instance.delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op)
649
+ p status_code # => 2xx
650
+ p headers # => { ... }
651
+ p data # => nil
652
+ rescue KlaviyoAPI::ApiError => e
653
+ puts "Error when calling TagsApi->delete_tag_relationships_campaigns_with_http_info: #{e}"
654
+ end
655
+ ```
656
+
657
+ ### Parameters
658
+
659
+ | Name | Type | Description | Notes |
660
+ | ---- | ---- | ----------- | ----- |
661
+ | **id** | **String** | | |
662
+ | **tag_campaign_op** | [**TagCampaignOp**](TagCampaignOp.md) | | |
663
+
664
+ ### Return type
665
+
666
+ nil (empty response body)
667
+
668
+ ### Authorization
669
+
670
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
671
+
672
+ ### HTTP request headers
673
+
674
+ - **Content-Type**: application/json
675
+ - **Accept**: application/json
676
+
677
+
678
+ ## delete_tag_relationships_flows
679
+
680
+ > delete_tag_relationships_flows(id, tag_flow_op)
681
+
682
+ Delete Tag Relationships Flows
683
+
684
+ Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
685
+
686
+ ### Examples
687
+
688
+ ```ruby
689
+ require 'time'
690
+ require 'klaviyo-api-sdk'
691
+ # setup authorization
692
+ KlaviyoAPI.configure do |config|
693
+ # Configure API key authorization: Klaviyo-API-Key
694
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
695
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
696
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
697
+ end
698
+
699
+ api_instance = KlaviyoAPI::TagsApi.new
700
+ id = 'id_example' # String |
701
+ tag_flow_op = KlaviyoAPI::TagFlowOp.new({data: [KlaviyoAPI::TagFlowOpDataInner.new({type: KlaviyoAPI::FlowEnum::FLOW, id: 'id_example'})]}) # TagFlowOp |
702
+
703
+ begin
704
+ # Delete Tag Relationships Flows
705
+ api_instance.delete_tag_relationships_flows(id, tag_flow_op)
706
+ rescue KlaviyoAPI::ApiError => e
707
+ puts "Error when calling TagsApi->delete_tag_relationships_flows: #{e}"
708
+ end
709
+ ```
710
+
711
+ #### Using the delete_tag_relationships_flows_with_http_info variant
712
+
713
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
714
+
715
+ > <Array(nil, Integer, Hash)> delete_tag_relationships_flows_with_http_info(id, tag_flow_op)
716
+
717
+ ```ruby
718
+ begin
719
+ # Delete Tag Relationships Flows
720
+ data, status_code, headers = api_instance.delete_tag_relationships_flows_with_http_info(id, tag_flow_op)
721
+ p status_code # => 2xx
722
+ p headers # => { ... }
723
+ p data # => nil
724
+ rescue KlaviyoAPI::ApiError => e
725
+ puts "Error when calling TagsApi->delete_tag_relationships_flows_with_http_info: #{e}"
726
+ end
727
+ ```
728
+
729
+ ### Parameters
730
+
731
+ | Name | Type | Description | Notes |
732
+ | ---- | ---- | ----------- | ----- |
733
+ | **id** | **String** | | |
734
+ | **tag_flow_op** | [**TagFlowOp**](TagFlowOp.md) | | |
735
+
736
+ ### Return type
737
+
738
+ nil (empty response body)
739
+
740
+ ### Authorization
741
+
742
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
743
+
744
+ ### HTTP request headers
745
+
746
+ - **Content-Type**: application/json
747
+ - **Accept**: application/json
748
+
749
+
750
+ ## delete_tag_relationships_lists
751
+
752
+ > delete_tag_relationships_lists(id, tag_list_op)
753
+
754
+ Delete Tag Relationships Lists
755
+
756
+ Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:write` `tags:write`
757
+
758
+ ### Examples
759
+
760
+ ```ruby
761
+ require 'time'
762
+ require 'klaviyo-api-sdk'
763
+ # setup authorization
764
+ KlaviyoAPI.configure do |config|
765
+ # Configure API key authorization: Klaviyo-API-Key
766
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
767
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
768
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
769
+ end
770
+
771
+ api_instance = KlaviyoAPI::TagsApi.new
772
+ id = 'id_example' # String |
773
+ tag_list_op = KlaviyoAPI::TagListOp.new({data: [KlaviyoAPI::TagListOpDataInner.new({type: KlaviyoAPI::ListEnum::LIST, id: 'id_example'})]}) # TagListOp |
774
+
775
+ begin
776
+ # Delete Tag Relationships Lists
777
+ api_instance.delete_tag_relationships_lists(id, tag_list_op)
778
+ rescue KlaviyoAPI::ApiError => e
779
+ puts "Error when calling TagsApi->delete_tag_relationships_lists: #{e}"
780
+ end
781
+ ```
782
+
783
+ #### Using the delete_tag_relationships_lists_with_http_info variant
784
+
785
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
786
+
787
+ > <Array(nil, Integer, Hash)> delete_tag_relationships_lists_with_http_info(id, tag_list_op)
788
+
789
+ ```ruby
790
+ begin
791
+ # Delete Tag Relationships Lists
792
+ data, status_code, headers = api_instance.delete_tag_relationships_lists_with_http_info(id, tag_list_op)
793
+ p status_code # => 2xx
794
+ p headers # => { ... }
795
+ p data # => nil
796
+ rescue KlaviyoAPI::ApiError => e
797
+ puts "Error when calling TagsApi->delete_tag_relationships_lists_with_http_info: #{e}"
798
+ end
799
+ ```
800
+
801
+ ### Parameters
802
+
803
+ | Name | Type | Description | Notes |
804
+ | ---- | ---- | ----------- | ----- |
805
+ | **id** | **String** | | |
806
+ | **tag_list_op** | [**TagListOp**](TagListOp.md) | | |
807
+
808
+ ### Return type
809
+
810
+ nil (empty response body)
811
+
812
+ ### Authorization
813
+
814
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
815
+
816
+ ### HTTP request headers
817
+
818
+ - **Content-Type**: application/json
819
+ - **Accept**: application/json
820
+
821
+
822
+ ## delete_tag_relationships_segments
823
+
824
+ > delete_tag_relationships_segments(id, tag_segment_op)
825
+
826
+ Delete Tag Relationships Segments
827
+
828
+ Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
829
+
830
+ ### Examples
831
+
832
+ ```ruby
833
+ require 'time'
834
+ require 'klaviyo-api-sdk'
835
+ # setup authorization
836
+ KlaviyoAPI.configure do |config|
837
+ # Configure API key authorization: Klaviyo-API-Key
838
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
839
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
840
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
841
+ end
842
+
843
+ api_instance = KlaviyoAPI::TagsApi.new
844
+ id = 'id_example' # String |
845
+ tag_segment_op = KlaviyoAPI::TagSegmentOp.new({data: [KlaviyoAPI::TagSegmentOpDataInner.new({type: KlaviyoAPI::SegmentEnum::SEGMENT, id: 'id_example'})]}) # TagSegmentOp |
846
+
847
+ begin
848
+ # Delete Tag Relationships Segments
849
+ api_instance.delete_tag_relationships_segments(id, tag_segment_op)
850
+ rescue KlaviyoAPI::ApiError => e
851
+ puts "Error when calling TagsApi->delete_tag_relationships_segments: #{e}"
852
+ end
853
+ ```
854
+
855
+ #### Using the delete_tag_relationships_segments_with_http_info variant
856
+
857
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
858
+
859
+ > <Array(nil, Integer, Hash)> delete_tag_relationships_segments_with_http_info(id, tag_segment_op)
860
+
861
+ ```ruby
862
+ begin
863
+ # Delete Tag Relationships Segments
864
+ data, status_code, headers = api_instance.delete_tag_relationships_segments_with_http_info(id, tag_segment_op)
865
+ p status_code # => 2xx
866
+ p headers # => { ... }
867
+ p data # => nil
868
+ rescue KlaviyoAPI::ApiError => e
869
+ puts "Error when calling TagsApi->delete_tag_relationships_segments_with_http_info: #{e}"
870
+ end
871
+ ```
872
+
873
+ ### Parameters
874
+
875
+ | Name | Type | Description | Notes |
876
+ | ---- | ---- | ----------- | ----- |
877
+ | **id** | **String** | | |
878
+ | **tag_segment_op** | [**TagSegmentOp**](TagSegmentOp.md) | | |
879
+
880
+ ### Return type
881
+
882
+ nil (empty response body)
883
+
884
+ ### Authorization
885
+
886
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
887
+
888
+ ### HTTP request headers
889
+
890
+ - **Content-Type**: application/json
891
+ - **Accept**: application/json
892
+
893
+
894
+ ## get_tag
895
+
896
+ > Hash&lt;String, Object&gt; get_tag(id, opts)
897
+
898
+ Get Tag
899
+
900
+ Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
901
+
902
+ ### Examples
903
+
904
+ ```ruby
905
+ require 'time'
906
+ require 'klaviyo-api-sdk'
907
+ # setup authorization
908
+ KlaviyoAPI.configure do |config|
909
+ # Configure API key authorization: Klaviyo-API-Key
910
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
911
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
912
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
913
+ end
914
+
915
+ api_instance = KlaviyoAPI::TagsApi.new
916
+ id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
917
+ opts = {
918
+ fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
919
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
920
+ include: ['tag-group'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
921
+ }
922
+
923
+ begin
924
+ # Get Tag
925
+ result = api_instance.get_tag(id, opts)
926
+ p result
927
+ rescue KlaviyoAPI::ApiError => e
928
+ puts "Error when calling TagsApi->get_tag: #{e}"
929
+ end
930
+ ```
931
+
932
+ #### Using the get_tag_with_http_info variant
933
+
934
+ This returns an Array which contains the response data, status code and headers.
935
+
936
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_with_http_info(id, opts)
937
+
938
+ ```ruby
939
+ begin
940
+ # Get Tag
941
+ data, status_code, headers = api_instance.get_tag_with_http_info(id, opts)
942
+ p status_code # => 2xx
943
+ p headers # => { ... }
944
+ p data # => Hash&lt;String, Object&gt;
945
+ rescue KlaviyoAPI::ApiError => e
946
+ puts "Error when calling TagsApi->get_tag_with_http_info: #{e}"
947
+ end
948
+ ```
949
+
950
+ ### Parameters
951
+
952
+ | Name | Type | Description | Notes |
953
+ | ---- | ---- | ----------- | ----- |
954
+ | **id** | **String** | The Tag ID | |
955
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
956
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
957
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
958
+
959
+ ### Return type
960
+
961
+ **Hash&lt;String, Object&gt;**
962
+
963
+ ### Authorization
964
+
965
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
966
+
967
+ ### HTTP request headers
968
+
969
+ - **Content-Type**: Not defined
970
+ - **Accept**: application/json
971
+
972
+
973
+ ## get_tag_group
974
+
975
+ > Hash&lt;String, Object&gt; get_tag_group(id, opts)
976
+
977
+ Get Tag Group
978
+
979
+ Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
980
+
981
+ ### Examples
982
+
983
+ ```ruby
984
+ require 'time'
985
+ require 'klaviyo-api-sdk'
986
+ # setup authorization
987
+ KlaviyoAPI.configure do |config|
988
+ # Configure API key authorization: Klaviyo-API-Key
989
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
990
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
991
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
992
+ end
993
+
994
+ api_instance = KlaviyoAPI::TagsApi.new
995
+ id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
996
+ opts = {
997
+ fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
998
+ }
999
+
1000
+ begin
1001
+ # Get Tag Group
1002
+ result = api_instance.get_tag_group(id, opts)
1003
+ p result
1004
+ rescue KlaviyoAPI::ApiError => e
1005
+ puts "Error when calling TagsApi->get_tag_group: #{e}"
1006
+ end
1007
+ ```
1008
+
1009
+ #### Using the get_tag_group_with_http_info variant
1010
+
1011
+ This returns an Array which contains the response data, status code and headers.
1012
+
1013
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_group_with_http_info(id, opts)
1014
+
1015
+ ```ruby
1016
+ begin
1017
+ # Get Tag Group
1018
+ data, status_code, headers = api_instance.get_tag_group_with_http_info(id, opts)
1019
+ p status_code # => 2xx
1020
+ p headers # => { ... }
1021
+ p data # => Hash&lt;String, Object&gt;
1022
+ rescue KlaviyoAPI::ApiError => e
1023
+ puts "Error when calling TagsApi->get_tag_group_with_http_info: #{e}"
1024
+ end
1025
+ ```
1026
+
1027
+ ### Parameters
1028
+
1029
+ | Name | Type | Description | Notes |
1030
+ | ---- | ---- | ----------- | ----- |
1031
+ | **id** | **String** | The Tag Group ID | |
1032
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1033
+
1034
+ ### Return type
1035
+
1036
+ **Hash&lt;String, Object&gt;**
1037
+
1038
+ ### Authorization
1039
+
1040
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1041
+
1042
+ ### HTTP request headers
1043
+
1044
+ - **Content-Type**: Not defined
1045
+ - **Accept**: application/json
1046
+
1047
+
1048
+ ## get_tag_group_relationships_tags
1049
+
1050
+ > Hash&lt;String, Object&gt; get_tag_group_relationships_tags(id)
1051
+
1052
+ Get Tag Group Relationships Tags
1053
+
1054
+ Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1055
+
1056
+ ### Examples
1057
+
1058
+ ```ruby
1059
+ require 'time'
1060
+ require 'klaviyo-api-sdk'
1061
+ # setup authorization
1062
+ KlaviyoAPI.configure do |config|
1063
+ # Configure API key authorization: Klaviyo-API-Key
1064
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1065
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1066
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1067
+ end
1068
+
1069
+ api_instance = KlaviyoAPI::TagsApi.new
1070
+ id = 'id_example' # String |
1071
+
1072
+ begin
1073
+ # Get Tag Group Relationships Tags
1074
+ result = api_instance.get_tag_group_relationships_tags(id)
1075
+ p result
1076
+ rescue KlaviyoAPI::ApiError => e
1077
+ puts "Error when calling TagsApi->get_tag_group_relationships_tags: #{e}"
1078
+ end
1079
+ ```
1080
+
1081
+ #### Using the get_tag_group_relationships_tags_with_http_info variant
1082
+
1083
+ This returns an Array which contains the response data, status code and headers.
1084
+
1085
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_group_relationships_tags_with_http_info(id)
1086
+
1087
+ ```ruby
1088
+ begin
1089
+ # Get Tag Group Relationships Tags
1090
+ data, status_code, headers = api_instance.get_tag_group_relationships_tags_with_http_info(id)
1091
+ p status_code # => 2xx
1092
+ p headers # => { ... }
1093
+ p data # => Hash&lt;String, Object&gt;
1094
+ rescue KlaviyoAPI::ApiError => e
1095
+ puts "Error when calling TagsApi->get_tag_group_relationships_tags_with_http_info: #{e}"
1096
+ end
1097
+ ```
1098
+
1099
+ ### Parameters
1100
+
1101
+ | Name | Type | Description | Notes |
1102
+ | ---- | ---- | ----------- | ----- |
1103
+ | **id** | **String** | | |
1104
+
1105
+ ### Return type
1106
+
1107
+ **Hash&lt;String, Object&gt;**
1108
+
1109
+ ### Authorization
1110
+
1111
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1112
+
1113
+ ### HTTP request headers
1114
+
1115
+ - **Content-Type**: Not defined
1116
+ - **Accept**: application/json
1117
+
1118
+
1119
+ ## get_tag_group_tags
1120
+
1121
+ > Hash&lt;String, Object&gt; get_tag_group_tags(id, opts)
1122
+
1123
+ Get Tag Group Tags
1124
+
1125
+ Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1126
+
1127
+ ### Examples
1128
+
1129
+ ```ruby
1130
+ require 'time'
1131
+ require 'klaviyo-api-sdk'
1132
+ # setup authorization
1133
+ KlaviyoAPI.configure do |config|
1134
+ # Configure API key authorization: Klaviyo-API-Key
1135
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1136
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1137
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1138
+ end
1139
+
1140
+ api_instance = KlaviyoAPI::TagsApi.new
1141
+ id = 'id_example' # String |
1142
+ opts = {
1143
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1144
+ }
1145
+
1146
+ begin
1147
+ # Get Tag Group Tags
1148
+ result = api_instance.get_tag_group_tags(id, opts)
1149
+ p result
1150
+ rescue KlaviyoAPI::ApiError => e
1151
+ puts "Error when calling TagsApi->get_tag_group_tags: #{e}"
1152
+ end
1153
+ ```
1154
+
1155
+ #### Using the get_tag_group_tags_with_http_info variant
1156
+
1157
+ This returns an Array which contains the response data, status code and headers.
1158
+
1159
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_group_tags_with_http_info(id, opts)
1160
+
1161
+ ```ruby
1162
+ begin
1163
+ # Get Tag Group Tags
1164
+ data, status_code, headers = api_instance.get_tag_group_tags_with_http_info(id, opts)
1165
+ p status_code # => 2xx
1166
+ p headers # => { ... }
1167
+ p data # => Hash&lt;String, Object&gt;
1168
+ rescue KlaviyoAPI::ApiError => e
1169
+ puts "Error when calling TagsApi->get_tag_group_tags_with_http_info: #{e}"
1170
+ end
1171
+ ```
1172
+
1173
+ ### Parameters
1174
+
1175
+ | Name | Type | Description | Notes |
1176
+ | ---- | ---- | ----------- | ----- |
1177
+ | **id** | **String** | | |
1178
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1179
+
1180
+ ### Return type
1181
+
1182
+ **Hash&lt;String, Object&gt;**
1183
+
1184
+ ### Authorization
1185
+
1186
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1187
+
1188
+ ### HTTP request headers
1189
+
1190
+ - **Content-Type**: Not defined
1191
+ - **Accept**: application/json
1192
+
1193
+
1194
+ ## get_tag_groups
1195
+
1196
+ > Hash&lt;String, Object&gt; get_tag_groups(opts)
1197
+
1198
+ Get Tag Groups
1199
+
1200
+ List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups 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: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1201
+
1202
+ ### Examples
1203
+
1204
+ ```ruby
1205
+ require 'time'
1206
+ require 'klaviyo-api-sdk'
1207
+ # setup authorization
1208
+ KlaviyoAPI.configure do |config|
1209
+ # Configure API key authorization: Klaviyo-API-Key
1210
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1211
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1212
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1213
+ end
1214
+
1215
+ api_instance = KlaviyoAPI::TagsApi.new
1216
+ opts = {
1217
+ fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1218
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
1219
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
1220
+ sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
1221
+ }
1222
+
1223
+ begin
1224
+ # Get Tag Groups
1225
+ result = api_instance.get_tag_groups(opts)
1226
+ p result
1227
+ rescue KlaviyoAPI::ApiError => e
1228
+ puts "Error when calling TagsApi->get_tag_groups: #{e}"
1229
+ end
1230
+ ```
1231
+
1232
+ #### Using the get_tag_groups_with_http_info variant
1233
+
1234
+ This returns an Array which contains the response data, status code and headers.
1235
+
1236
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_groups_with_http_info(opts)
1237
+
1238
+ ```ruby
1239
+ begin
1240
+ # Get Tag Groups
1241
+ data, status_code, headers = api_instance.get_tag_groups_with_http_info(opts)
1242
+ p status_code # => 2xx
1243
+ p headers # => { ... }
1244
+ p data # => Hash&lt;String, Object&gt;
1245
+ rescue KlaviyoAPI::ApiError => e
1246
+ puts "Error when calling TagsApi->get_tag_groups_with_http_info: #{e}"
1247
+ end
1248
+ ```
1249
+
1250
+ ### Parameters
1251
+
1252
+ | Name | Type | Description | Notes |
1253
+ | ---- | ---- | ----------- | ----- |
1254
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1255
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60; | [optional] |
1256
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
1257
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
1258
+
1259
+ ### Return type
1260
+
1261
+ **Hash&lt;String, Object&gt;**
1262
+
1263
+ ### Authorization
1264
+
1265
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1266
+
1267
+ ### HTTP request headers
1268
+
1269
+ - **Content-Type**: Not defined
1270
+ - **Accept**: application/json
1271
+
1272
+
1273
+ ## get_tag_relationships_campaigns
1274
+
1275
+ > Hash&lt;String, Object&gt; get_tag_relationships_campaigns(id)
1276
+
1277
+ Get Tag Relationships Campaigns
1278
+
1279
+ Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
1280
+
1281
+ ### Examples
1282
+
1283
+ ```ruby
1284
+ require 'time'
1285
+ require 'klaviyo-api-sdk'
1286
+ # setup authorization
1287
+ KlaviyoAPI.configure do |config|
1288
+ # Configure API key authorization: Klaviyo-API-Key
1289
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1290
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1291
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1292
+ end
1293
+
1294
+ api_instance = KlaviyoAPI::TagsApi.new
1295
+ id = 'id_example' # String |
1296
+
1297
+ begin
1298
+ # Get Tag Relationships Campaigns
1299
+ result = api_instance.get_tag_relationships_campaigns(id)
1300
+ p result
1301
+ rescue KlaviyoAPI::ApiError => e
1302
+ puts "Error when calling TagsApi->get_tag_relationships_campaigns: #{e}"
1303
+ end
1304
+ ```
1305
+
1306
+ #### Using the get_tag_relationships_campaigns_with_http_info variant
1307
+
1308
+ This returns an Array which contains the response data, status code and headers.
1309
+
1310
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_relationships_campaigns_with_http_info(id)
1311
+
1312
+ ```ruby
1313
+ begin
1314
+ # Get Tag Relationships Campaigns
1315
+ data, status_code, headers = api_instance.get_tag_relationships_campaigns_with_http_info(id)
1316
+ p status_code # => 2xx
1317
+ p headers # => { ... }
1318
+ p data # => Hash&lt;String, Object&gt;
1319
+ rescue KlaviyoAPI::ApiError => e
1320
+ puts "Error when calling TagsApi->get_tag_relationships_campaigns_with_http_info: #{e}"
1321
+ end
1322
+ ```
1323
+
1324
+ ### Parameters
1325
+
1326
+ | Name | Type | Description | Notes |
1327
+ | ---- | ---- | ----------- | ----- |
1328
+ | **id** | **String** | | |
1329
+
1330
+ ### Return type
1331
+
1332
+ **Hash&lt;String, Object&gt;**
1333
+
1334
+ ### Authorization
1335
+
1336
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1337
+
1338
+ ### HTTP request headers
1339
+
1340
+ - **Content-Type**: Not defined
1341
+ - **Accept**: application/json
1342
+
1343
+
1344
+ ## get_tag_relationships_flows
1345
+
1346
+ > Hash&lt;String, Object&gt; get_tag_relationships_flows(id)
1347
+
1348
+ Get Tag Relationships Flows
1349
+
1350
+ Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
1351
+
1352
+ ### Examples
1353
+
1354
+ ```ruby
1355
+ require 'time'
1356
+ require 'klaviyo-api-sdk'
1357
+ # setup authorization
1358
+ KlaviyoAPI.configure do |config|
1359
+ # Configure API key authorization: Klaviyo-API-Key
1360
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1361
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1362
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1363
+ end
1364
+
1365
+ api_instance = KlaviyoAPI::TagsApi.new
1366
+ id = 'id_example' # String |
1367
+
1368
+ begin
1369
+ # Get Tag Relationships Flows
1370
+ result = api_instance.get_tag_relationships_flows(id)
1371
+ p result
1372
+ rescue KlaviyoAPI::ApiError => e
1373
+ puts "Error when calling TagsApi->get_tag_relationships_flows: #{e}"
1374
+ end
1375
+ ```
1376
+
1377
+ #### Using the get_tag_relationships_flows_with_http_info variant
1378
+
1379
+ This returns an Array which contains the response data, status code and headers.
1380
+
1381
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_relationships_flows_with_http_info(id)
1382
+
1383
+ ```ruby
1384
+ begin
1385
+ # Get Tag Relationships Flows
1386
+ data, status_code, headers = api_instance.get_tag_relationships_flows_with_http_info(id)
1387
+ p status_code # => 2xx
1388
+ p headers # => { ... }
1389
+ p data # => Hash&lt;String, Object&gt;
1390
+ rescue KlaviyoAPI::ApiError => e
1391
+ puts "Error when calling TagsApi->get_tag_relationships_flows_with_http_info: #{e}"
1392
+ end
1393
+ ```
1394
+
1395
+ ### Parameters
1396
+
1397
+ | Name | Type | Description | Notes |
1398
+ | ---- | ---- | ----------- | ----- |
1399
+ | **id** | **String** | | |
1400
+
1401
+ ### Return type
1402
+
1403
+ **Hash&lt;String, Object&gt;**
1404
+
1405
+ ### Authorization
1406
+
1407
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1408
+
1409
+ ### HTTP request headers
1410
+
1411
+ - **Content-Type**: Not defined
1412
+ - **Accept**: application/json
1413
+
1414
+
1415
+ ## get_tag_relationships_lists
1416
+
1417
+ > Hash&lt;String, Object&gt; get_tag_relationships_lists(id)
1418
+
1419
+ Get Tag Relationships Lists
1420
+
1421
+ Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
1422
+
1423
+ ### Examples
1424
+
1425
+ ```ruby
1426
+ require 'time'
1427
+ require 'klaviyo-api-sdk'
1428
+ # setup authorization
1429
+ KlaviyoAPI.configure do |config|
1430
+ # Configure API key authorization: Klaviyo-API-Key
1431
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1432
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1433
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1434
+ end
1435
+
1436
+ api_instance = KlaviyoAPI::TagsApi.new
1437
+ id = 'id_example' # String |
1438
+
1439
+ begin
1440
+ # Get Tag Relationships Lists
1441
+ result = api_instance.get_tag_relationships_lists(id)
1442
+ p result
1443
+ rescue KlaviyoAPI::ApiError => e
1444
+ puts "Error when calling TagsApi->get_tag_relationships_lists: #{e}"
1445
+ end
1446
+ ```
1447
+
1448
+ #### Using the get_tag_relationships_lists_with_http_info variant
1449
+
1450
+ This returns an Array which contains the response data, status code and headers.
1451
+
1452
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_relationships_lists_with_http_info(id)
1453
+
1454
+ ```ruby
1455
+ begin
1456
+ # Get Tag Relationships Lists
1457
+ data, status_code, headers = api_instance.get_tag_relationships_lists_with_http_info(id)
1458
+ p status_code # => 2xx
1459
+ p headers # => { ... }
1460
+ p data # => Hash&lt;String, Object&gt;
1461
+ rescue KlaviyoAPI::ApiError => e
1462
+ puts "Error when calling TagsApi->get_tag_relationships_lists_with_http_info: #{e}"
1463
+ end
1464
+ ```
1465
+
1466
+ ### Parameters
1467
+
1468
+ | Name | Type | Description | Notes |
1469
+ | ---- | ---- | ----------- | ----- |
1470
+ | **id** | **String** | | |
1471
+
1472
+ ### Return type
1473
+
1474
+ **Hash&lt;String, Object&gt;**
1475
+
1476
+ ### Authorization
1477
+
1478
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1479
+
1480
+ ### HTTP request headers
1481
+
1482
+ - **Content-Type**: Not defined
1483
+ - **Accept**: application/json
1484
+
1485
+
1486
+ ## get_tag_relationships_segments
1487
+
1488
+ > Hash&lt;String, Object&gt; get_tag_relationships_segments(id)
1489
+
1490
+ Get Tag Relationships Segments
1491
+
1492
+ Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
1493
+
1494
+ ### Examples
1495
+
1496
+ ```ruby
1497
+ require 'time'
1498
+ require 'klaviyo-api-sdk'
1499
+ # setup authorization
1500
+ KlaviyoAPI.configure do |config|
1501
+ # Configure API key authorization: Klaviyo-API-Key
1502
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1503
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1504
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1505
+ end
1506
+
1507
+ api_instance = KlaviyoAPI::TagsApi.new
1508
+ id = 'id_example' # String |
1509
+
1510
+ begin
1511
+ # Get Tag Relationships Segments
1512
+ result = api_instance.get_tag_relationships_segments(id)
1513
+ p result
1514
+ rescue KlaviyoAPI::ApiError => e
1515
+ puts "Error when calling TagsApi->get_tag_relationships_segments: #{e}"
1516
+ end
1517
+ ```
1518
+
1519
+ #### Using the get_tag_relationships_segments_with_http_info variant
1520
+
1521
+ This returns an Array which contains the response data, status code and headers.
1522
+
1523
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_relationships_segments_with_http_info(id)
1524
+
1525
+ ```ruby
1526
+ begin
1527
+ # Get Tag Relationships Segments
1528
+ data, status_code, headers = api_instance.get_tag_relationships_segments_with_http_info(id)
1529
+ p status_code # => 2xx
1530
+ p headers # => { ... }
1531
+ p data # => Hash&lt;String, Object&gt;
1532
+ rescue KlaviyoAPI::ApiError => e
1533
+ puts "Error when calling TagsApi->get_tag_relationships_segments_with_http_info: #{e}"
1534
+ end
1535
+ ```
1536
+
1537
+ ### Parameters
1538
+
1539
+ | Name | Type | Description | Notes |
1540
+ | ---- | ---- | ----------- | ----- |
1541
+ | **id** | **String** | | |
1542
+
1543
+ ### Return type
1544
+
1545
+ **Hash&lt;String, Object&gt;**
1546
+
1547
+ ### Authorization
1548
+
1549
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1550
+
1551
+ ### HTTP request headers
1552
+
1553
+ - **Content-Type**: Not defined
1554
+ - **Accept**: application/json
1555
+
1556
+
1557
+ ## get_tag_relationships_tag_group
1558
+
1559
+ > Hash&lt;String, Object&gt; get_tag_relationships_tag_group(id)
1560
+
1561
+ Get Tag Relationships Tag Group
1562
+
1563
+ Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1564
+
1565
+ ### Examples
1566
+
1567
+ ```ruby
1568
+ require 'time'
1569
+ require 'klaviyo-api-sdk'
1570
+ # setup authorization
1571
+ KlaviyoAPI.configure do |config|
1572
+ # Configure API key authorization: Klaviyo-API-Key
1573
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1574
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1575
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1576
+ end
1577
+
1578
+ api_instance = KlaviyoAPI::TagsApi.new
1579
+ id = 'id_example' # String |
1580
+
1581
+ begin
1582
+ # Get Tag Relationships Tag Group
1583
+ result = api_instance.get_tag_relationships_tag_group(id)
1584
+ p result
1585
+ rescue KlaviyoAPI::ApiError => e
1586
+ puts "Error when calling TagsApi->get_tag_relationships_tag_group: #{e}"
1587
+ end
1588
+ ```
1589
+
1590
+ #### Using the get_tag_relationships_tag_group_with_http_info variant
1591
+
1592
+ This returns an Array which contains the response data, status code and headers.
1593
+
1594
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_relationships_tag_group_with_http_info(id)
1595
+
1596
+ ```ruby
1597
+ begin
1598
+ # Get Tag Relationships Tag Group
1599
+ data, status_code, headers = api_instance.get_tag_relationships_tag_group_with_http_info(id)
1600
+ p status_code # => 2xx
1601
+ p headers # => { ... }
1602
+ p data # => Hash&lt;String, Object&gt;
1603
+ rescue KlaviyoAPI::ApiError => e
1604
+ puts "Error when calling TagsApi->get_tag_relationships_tag_group_with_http_info: #{e}"
1605
+ end
1606
+ ```
1607
+
1608
+ ### Parameters
1609
+
1610
+ | Name | Type | Description | Notes |
1611
+ | ---- | ---- | ----------- | ----- |
1612
+ | **id** | **String** | | |
1613
+
1614
+ ### Return type
1615
+
1616
+ **Hash&lt;String, Object&gt;**
1617
+
1618
+ ### Authorization
1619
+
1620
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1621
+
1622
+ ### HTTP request headers
1623
+
1624
+ - **Content-Type**: Not defined
1625
+ - **Accept**: application/json
1626
+
1627
+
1628
+ ## get_tag_tag_group
1629
+
1630
+ > Hash&lt;String, Object&gt; get_tag_tag_group(id, opts)
1631
+
1632
+ Get Tag Tag Group
1633
+
1634
+ Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1635
+
1636
+ ### Examples
1637
+
1638
+ ```ruby
1639
+ require 'time'
1640
+ require 'klaviyo-api-sdk'
1641
+ # setup authorization
1642
+ KlaviyoAPI.configure do |config|
1643
+ # Configure API key authorization: Klaviyo-API-Key
1644
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1645
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1646
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1647
+ end
1648
+
1649
+ api_instance = KlaviyoAPI::TagsApi.new
1650
+ id = 'id_example' # String |
1651
+ opts = {
1652
+ fields_tag_group: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1653
+ }
1654
+
1655
+ begin
1656
+ # Get Tag Tag Group
1657
+ result = api_instance.get_tag_tag_group(id, opts)
1658
+ p result
1659
+ rescue KlaviyoAPI::ApiError => e
1660
+ puts "Error when calling TagsApi->get_tag_tag_group: #{e}"
1661
+ end
1662
+ ```
1663
+
1664
+ #### Using the get_tag_tag_group_with_http_info variant
1665
+
1666
+ This returns an Array which contains the response data, status code and headers.
1667
+
1668
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tag_tag_group_with_http_info(id, opts)
1669
+
1670
+ ```ruby
1671
+ begin
1672
+ # Get Tag Tag Group
1673
+ data, status_code, headers = api_instance.get_tag_tag_group_with_http_info(id, opts)
1674
+ p status_code # => 2xx
1675
+ p headers # => { ... }
1676
+ p data # => Hash&lt;String, Object&gt;
1677
+ rescue KlaviyoAPI::ApiError => e
1678
+ puts "Error when calling TagsApi->get_tag_tag_group_with_http_info: #{e}"
1679
+ end
1680
+ ```
1681
+
1682
+ ### Parameters
1683
+
1684
+ | Name | Type | Description | Notes |
1685
+ | ---- | ---- | ----------- | ----- |
1686
+ | **id** | **String** | | |
1687
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1688
+
1689
+ ### Return type
1690
+
1691
+ **Hash&lt;String, Object&gt;**
1692
+
1693
+ ### Authorization
1694
+
1695
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1696
+
1697
+ ### HTTP request headers
1698
+
1699
+ - **Content-Type**: Not defined
1700
+ - **Accept**: application/json
1701
+
1702
+
1703
+ ## get_tags
1704
+
1705
+ > Hash&lt;String, Object&gt; get_tags(opts)
1706
+
1707
+ Get Tags
1708
+
1709
+ List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags 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: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1710
+
1711
+ ### Examples
1712
+
1713
+ ```ruby
1714
+ require 'time'
1715
+ require 'klaviyo-api-sdk'
1716
+ # setup authorization
1717
+ KlaviyoAPI.configure do |config|
1718
+ # Configure API key authorization: Klaviyo-API-Key
1719
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1720
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1721
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1722
+ end
1723
+
1724
+ api_instance = KlaviyoAPI::TagsApi.new
1725
+ opts = {
1726
+ fields_tag_group: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1727
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets
1728
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
1729
+ include: ['tag-group'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships
1730
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination
1731
+ sort: 'id' # String | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting
1732
+ }
1733
+
1734
+ begin
1735
+ # Get Tags
1736
+ result = api_instance.get_tags(opts)
1737
+ p result
1738
+ rescue KlaviyoAPI::ApiError => e
1739
+ puts "Error when calling TagsApi->get_tags: #{e}"
1740
+ end
1741
+ ```
1742
+
1743
+ #### Using the get_tags_with_http_info variant
1744
+
1745
+ This returns an Array which contains the response data, status code and headers.
1746
+
1747
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_tags_with_http_info(opts)
1748
+
1749
+ ```ruby
1750
+ begin
1751
+ # Get Tags
1752
+ data, status_code, headers = api_instance.get_tags_with_http_info(opts)
1753
+ p status_code # => 2xx
1754
+ p headers # => { ... }
1755
+ p data # => Hash&lt;String, Object&gt;
1756
+ rescue KlaviyoAPI::ApiError => e
1757
+ puts "Error when calling TagsApi->get_tags_with_http_info: #{e}"
1758
+ end
1759
+ ```
1760
+
1761
+ ### Parameters
1762
+
1763
+ | Name | Type | Description | Notes |
1764
+ | ---- | ---- | ----------- | ----- |
1765
+ | **fields_tag_group** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1766
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | [optional] |
1767
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60; | [optional] |
1768
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships | [optional] |
1769
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#pagination | [optional] |
1770
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sorting | [optional] |
1771
+
1772
+ ### Return type
1773
+
1774
+ **Hash&lt;String, Object&gt;**
1775
+
1776
+ ### Authorization
1777
+
1778
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1779
+
1780
+ ### HTTP request headers
1781
+
1782
+ - **Content-Type**: Not defined
1783
+ - **Accept**: application/json
1784
+
1785
+
1786
+ ## update_tag
1787
+
1788
+ > update_tag(id, tag_update_query)
1789
+
1790
+ Update Tag
1791
+
1792
+ Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
1793
+
1794
+ ### Examples
1795
+
1796
+ ```ruby
1797
+ require 'time'
1798
+ require 'klaviyo-api-sdk'
1799
+ # setup authorization
1800
+ KlaviyoAPI.configure do |config|
1801
+ # Configure API key authorization: Klaviyo-API-Key
1802
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1803
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1804
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1805
+ end
1806
+
1807
+ api_instance = KlaviyoAPI::TagsApi.new
1808
+ id = 'abcd1234-ef56-gh78-ij90-abcdef123456' # String | The Tag ID
1809
+ tag_update_query = KlaviyoAPI::TagUpdateQuery.new({data: KlaviyoAPI::TagUpdateQueryResourceObject.new({type: KlaviyoAPI::TagEnum::TAG, id: 'abcd1234-ef56-gh78-ij90-abcdef123456', attributes: KlaviyoAPI::TagCreateQueryResourceObjectAttributes.new({name: 'My Tag'})})}) # TagUpdateQuery |
1810
+
1811
+ begin
1812
+ # Update Tag
1813
+ api_instance.update_tag(id, tag_update_query)
1814
+ rescue KlaviyoAPI::ApiError => e
1815
+ puts "Error when calling TagsApi->update_tag: #{e}"
1816
+ end
1817
+ ```
1818
+
1819
+ #### Using the update_tag_with_http_info variant
1820
+
1821
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1822
+
1823
+ > <Array(nil, Integer, Hash)> update_tag_with_http_info(id, tag_update_query)
1824
+
1825
+ ```ruby
1826
+ begin
1827
+ # Update Tag
1828
+ data, status_code, headers = api_instance.update_tag_with_http_info(id, tag_update_query)
1829
+ p status_code # => 2xx
1830
+ p headers # => { ... }
1831
+ p data # => nil
1832
+ rescue KlaviyoAPI::ApiError => e
1833
+ puts "Error when calling TagsApi->update_tag_with_http_info: #{e}"
1834
+ end
1835
+ ```
1836
+
1837
+ ### Parameters
1838
+
1839
+ | Name | Type | Description | Notes |
1840
+ | ---- | ---- | ----------- | ----- |
1841
+ | **id** | **String** | The Tag ID | |
1842
+ | **tag_update_query** | [**TagUpdateQuery**](TagUpdateQuery.md) | | |
1843
+
1844
+ ### Return type
1845
+
1846
+ nil (empty response body)
1847
+
1848
+ ### Authorization
1849
+
1850
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1851
+
1852
+ ### HTTP request headers
1853
+
1854
+ - **Content-Type**: application/json
1855
+ - **Accept**: application/json
1856
+
1857
+
1858
+ ## update_tag_group
1859
+
1860
+ > Hash&lt;String, Object&gt; update_tag_group(id, tag_group_update_query)
1861
+
1862
+ Update Tag Group
1863
+
1864
+ Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
1865
+
1866
+ ### Examples
1867
+
1868
+ ```ruby
1869
+ require 'time'
1870
+ require 'klaviyo-api-sdk'
1871
+ # setup authorization
1872
+ KlaviyoAPI.configure do |config|
1873
+ # Configure API key authorization: Klaviyo-API-Key
1874
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1875
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1876
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1877
+ end
1878
+
1879
+ api_instance = KlaviyoAPI::TagsApi.new
1880
+ id = 'zyxw9876-vu54-ts32-rq10-zyxwvu654321' # String | The Tag Group ID
1881
+ tag_group_update_query = KlaviyoAPI::TagGroupUpdateQuery.new({data: KlaviyoAPI::TagGroupUpdateQueryResourceObject.new({type: KlaviyoAPI::TagGroupEnum::TAG_GROUP, id: 'zyxw9876-vu54-ts32-rq10-zyxwvu654321', attributes: KlaviyoAPI::TagGroupUpdateQueryResourceObjectAttributes.new({name: 'My Tag Group'})})}) # TagGroupUpdateQuery |
1882
+
1883
+ begin
1884
+ # Update Tag Group
1885
+ result = api_instance.update_tag_group(id, tag_group_update_query)
1886
+ p result
1887
+ rescue KlaviyoAPI::ApiError => e
1888
+ puts "Error when calling TagsApi->update_tag_group: #{e}"
1889
+ end
1890
+ ```
1891
+
1892
+ #### Using the update_tag_group_with_http_info variant
1893
+
1894
+ This returns an Array which contains the response data, status code and headers.
1895
+
1896
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_tag_group_with_http_info(id, tag_group_update_query)
1897
+
1898
+ ```ruby
1899
+ begin
1900
+ # Update Tag Group
1901
+ data, status_code, headers = api_instance.update_tag_group_with_http_info(id, tag_group_update_query)
1902
+ p status_code # => 2xx
1903
+ p headers # => { ... }
1904
+ p data # => Hash&lt;String, Object&gt;
1905
+ rescue KlaviyoAPI::ApiError => e
1906
+ puts "Error when calling TagsApi->update_tag_group_with_http_info: #{e}"
1907
+ end
1908
+ ```
1909
+
1910
+ ### Parameters
1911
+
1912
+ | Name | Type | Description | Notes |
1913
+ | ---- | ---- | ----------- | ----- |
1914
+ | **id** | **String** | The Tag Group ID | |
1915
+ | **tag_group_update_query** | [**TagGroupUpdateQuery**](TagGroupUpdateQuery.md) | | |
1916
+
1917
+ ### Return type
1918
+
1919
+ **Hash&lt;String, Object&gt;**
1920
+
1921
+ ### Authorization
1922
+
1923
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1924
+
1925
+ ### HTTP request headers
1926
+
1927
+ - **Content-Type**: application/json
1928
+ - **Accept**: application/json
1929
+