klaviyo-api-sdk 4.0.0 → 4.1.0

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