klaviyo-api-sdk 3.0.0 → 4.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (866) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -0
  3. data/README.md +273 -173
  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 +528 -57
  292. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +376 -306
  293. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  294. data/lib/klaviyo-api-sdk/api/events_api.rb +96 -96
  295. data/lib/klaviyo-api-sdk/api/flows_api.rb +258 -103
  296. data/lib/klaviyo-api-sdk/api/lists_api.rb +79 -44
  297. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  298. data/lib/klaviyo-api-sdk/api/profiles_api.rb +141 -71
  299. data/lib/klaviyo-api-sdk/api/segments_api.rb +71 -36
  300. data/lib/klaviyo-api-sdk/api/tags_api.rb +121 -93
  301. data/lib/klaviyo-api-sdk/api/templates_api.rb +31 -31
  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/{profile_unsuppression_bulk_create_job_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
  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 +32 -38
  313. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
  314. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
  315. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
  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 +22 -13
  319. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
  320. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
  321. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
  322. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +238 -0
  323. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +22 -22
  324. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +253 -0
  325. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
  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 +19 -10
  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 +3 -6
  350. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
  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 +19 -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 +3 -6
  359. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
  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 +3 -6
  366. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
  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 +3 -6
  377. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
  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 +73 -71
  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 +3 -6
  387. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
  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 +3 -6
  393. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
  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 +3 -6
  403. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
  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 +117 -115
  407. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
  408. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +224 -0
  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 +3 -6
  413. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
  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 +3 -6
  419. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
  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 +13 -29
  426. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
  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 +248 -0
  429. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
  430. data/lib/klaviyo-api-sdk/models/device_metadata.rb +388 -0
  431. data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +50 -40
  432. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
  433. data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +15 -15
  434. data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
  435. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +22 -22
  436. data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +44 -45
  437. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +224 -0
  438. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +224 -0
  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 +65 -68
  460. data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → metric_create_query_resource_object.rb} +22 -22
  461. data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
  462. data/lib/klaviyo-api-sdk/models/{profile_unsubscription_bulk_create_job_enum.rb → metric_enum.rb} +5 -5
  463. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +257 -0
  464. data/lib/klaviyo-api-sdk/models/{profile_partial_update_query_resource_object_attributes.rb → onsite_profile_create_query_resource_object_attributes.rb} +48 -48
  465. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +219 -0
  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 +248 -0
  471. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +249 -0
  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 +219 -0
  476. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +239 -0
  477. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -0
  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 -19
  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 +36 -0
  482. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
  483. data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +18 -28
  484. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
  485. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
  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 +36 -0
  488. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +238 -0
  489. data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
  490. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
  491. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +220 -0
  492. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +248 -0
  493. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +328 -0
  494. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → push_token_create_query.rb} +5 -5
  495. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +238 -0
  496. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items_data_inner.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 +252 -0
  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/{unsubscription_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
  506. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
  507. data/lib/klaviyo-api-sdk/models/{catalog_item_category_op_data_inner.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +23 -37
  508. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
  509. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
  510. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
  511. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +238 -0
  512. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +220 -0
  513. data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
  514. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object_attributes.rb → sms_tracking_options_sub_object.rb} +23 -18
  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 +22 -13
  520. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +11 -29
  521. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
  522. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +219 -0
  523. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +224 -0
  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 +224 -0
  526. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
  527. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
  528. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
  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 +11 -14
  532. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
  533. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +224 -0
  534. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
  535. data/lib/klaviyo-api-sdk/models/{tag_update_query_resource_object_attributes.rb → suppression_delete_job_create_query_resource_object_attributes.rb} +14 -15
  536. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
  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 +22 -13
  541. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +2 -12
  542. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +219 -0
  543. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
  544. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +238 -0
  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 +2 -14
  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 -37
  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 +3 -15
  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 -28
  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 +96 -27
  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 +674 -33
  865. data/CHANGELOG.md +0 -65
  866. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +0 -244
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2023-06-15
6
+ The version of the OpenAPI document: 2023-08-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -51,7 +51,7 @@ module KlaviyoAPI
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # klaviyo api revision
54
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
54
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
55
55
  # HTTP header 'Accept' (if needed)
56
56
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
57
  # HTTP header 'Content-Type'
@@ -90,7 +90,7 @@ module KlaviyoAPI
90
90
  end
91
91
 
92
92
  # Add Profile To List
93
- # Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
93
+ # Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
94
94
  # @param id [String]
95
95
  # @param list_members_add_query [ListMembersAddQuery]
96
96
  # @param [Hash] opts the optional parameters
@@ -101,7 +101,7 @@ module KlaviyoAPI
101
101
  end
102
102
 
103
103
  # Add Profile To List
104
- # Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you&#39;re trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:write&#x60; &#x60;profiles:write&#x60;
104
+ # Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you&#39;re trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:write&#x60; &#x60;profiles:write&#x60;
105
105
  # @param id [String]
106
106
  # @param list_members_add_query [ListMembersAddQuery]
107
107
  # @param [Hash] opts the optional parameters
@@ -127,7 +127,7 @@ module KlaviyoAPI
127
127
  # header parameters
128
128
  header_params = opts[:header_params] || {}
129
129
  # klaviyo api revision
130
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
130
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
131
131
  # HTTP header 'Accept' (if needed)
132
132
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
133
133
  # HTTP header 'Content-Type'
@@ -197,7 +197,7 @@ module KlaviyoAPI
197
197
  # header parameters
198
198
  header_params = opts[:header_params] || {}
199
199
  # klaviyo api revision
200
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
200
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
201
201
  # HTTP header 'Accept' (if needed)
202
202
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
203
203
 
@@ -231,7 +231,7 @@ module KlaviyoAPI
231
231
  end
232
232
 
233
233
  # Remove Profile From List
234
- # Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
234
+ # Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write` `profiles:write`
235
235
  # @param id [String]
236
236
  # @param list_members_delete_query [ListMembersDeleteQuery]
237
237
  # @param [Hash] opts the optional parameters
@@ -242,7 +242,7 @@ module KlaviyoAPI
242
242
  end
243
243
 
244
244
  # Remove Profile From List
245
- # Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile&#39;s consent status or subscription status in general. To update a profile&#39;s subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:write&#x60; &#x60;profiles:write&#x60;
245
+ # Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile&#39;s consent status or subscription status in general. To update a profile&#39;s subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:write&#x60; &#x60;profiles:write&#x60;
246
246
  # @param id [String]
247
247
  # @param list_members_delete_query [ListMembersDeleteQuery]
248
248
  # @param [Hash] opts the optional parameters
@@ -268,7 +268,7 @@ module KlaviyoAPI
268
268
  # header parameters
269
269
  header_params = opts[:header_params] || {}
270
270
  # klaviyo api revision
271
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
271
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
272
272
  # HTTP header 'Accept' (if needed)
273
273
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
274
274
  # HTTP header 'Content-Type'
@@ -307,10 +307,13 @@ module KlaviyoAPI
307
307
  end
308
308
 
309
309
  # Get List
310
- # Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:write`
310
+ # Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-08-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `list:read`
311
311
  # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
312
312
  # @param [Hash] opts the optional parameters
313
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
313
+ # @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
314
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
315
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
316
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
314
317
  # @return [Hash<String, Object>]
315
318
  def get_list(id, opts = {})
316
319
  data, _status_code, _headers = get_list_with_http_info(id, opts)
@@ -318,10 +321,13 @@ module KlaviyoAPI
318
321
  end
319
322
 
320
323
  # Get List
321
- # Get a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:write&#x60;
324
+ # Get a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[list]&#x3D;profile_count&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-08-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;list:read&#x60;
322
325
  # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
323
326
  # @param [Hash] opts the optional parameters
324
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
327
+ # @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
328
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
329
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
330
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
325
331
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
326
332
  def get_list_with_http_info(id, opts = {})
327
333
  if @api_client.config.debugging
@@ -331,21 +337,36 @@ module KlaviyoAPI
331
337
  if @api_client.config.client_side_validation && id.nil?
332
338
  fail ArgumentError, "Missing the required parameter 'id' when calling ListsApi.get_list"
333
339
  end
334
- allowable_values = ["name", "created", "updated"]
340
+ allowable_values = ["profile_count"]
341
+ if @api_client.config.client_side_validation && opts[:'additional_fields_list'] && !opts[:'additional_fields_list'].all? { |item| allowable_values.include?(item) }
342
+ fail ArgumentError, "invalid value for \"additional_fields_list\", must include one of #{allowable_values}"
343
+ end
344
+ allowable_values = ["name", "created", "updated", "profile_count"]
335
345
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
336
346
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
337
347
  end
348
+ allowable_values = ["name"]
349
+ if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
350
+ fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
351
+ end
352
+ allowable_values = ["tags"]
353
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
354
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
355
+ end
338
356
  # resource path
339
357
  local_var_path = '/api/lists/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
340
358
 
341
359
  # query parameters
342
360
  query_params = opts[:query_params] || {}
361
+ query_params[:'additional-fields[list]'] = @api_client.build_collection_param(opts[:'additional_fields_list'], :csv) if !opts[:'additional_fields_list'].nil?
343
362
  query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
363
+ query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
364
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
344
365
 
345
366
  # header parameters
346
367
  header_params = opts[:header_params] || {}
347
368
  # klaviyo api revision
348
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
369
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
349
370
  # HTTP header 'Accept' (if needed)
350
371
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
351
372
 
@@ -379,13 +400,13 @@ module KlaviyoAPI
379
400
  end
380
401
 
381
402
  # Get List Profiles
382
- # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
403
+ # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-08-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `list:read` `profiles:read`
383
404
  # @param id [String]
384
405
  # @param [Hash] opts the optional parameters
385
406
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
386
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
387
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;
388
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
407
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
408
+ # @option opts [String] :filter 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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;
409
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
389
410
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
390
411
  # @return [Hash<String, Object>]
391
412
  def get_list_profiles(id, opts = {})
@@ -394,13 +415,13 @@ module KlaviyoAPI
394
415
  end
395
416
 
396
417
  # Get List Profiles
397
- # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by &#x60;email&#x60;, &#x60;phone_number&#x60;, and &#x60;push_token&#x60; fields.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:read&#x60; &#x60;profiles:read&#x60;
418
+ # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by &#x60;email&#x60;, &#x60;phone_number&#x60;, and &#x60;push_token&#x60; fields.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[profile]&#x3D;predictive_analytics&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-08-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;list:read&#x60; &#x60;profiles:read&#x60;
398
419
  # @param id [String]
399
420
  # @param [Hash] opts the optional parameters
400
421
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
401
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
402
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;
403
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
422
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
423
+ # @option opts [String] :filter 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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;
424
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
404
425
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
405
426
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
406
427
  def get_list_profiles_with_http_info(id, opts = {})
@@ -415,7 +436,7 @@ module KlaviyoAPI
415
436
  if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
416
437
  fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
417
438
  end
418
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
439
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
419
440
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
420
441
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
421
442
  end
@@ -441,7 +462,7 @@ module KlaviyoAPI
441
462
  # header parameters
442
463
  header_params = opts[:header_params] || {}
443
464
  # klaviyo api revision
444
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
465
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
445
466
  # HTTP header 'Accept' (if needed)
446
467
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
447
468
 
@@ -475,10 +496,10 @@ module KlaviyoAPI
475
496
  end
476
497
 
477
498
  # Get List Relationships Profiles
478
- # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read` `profiles:read`
499
+ # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `list:read` `profiles:read`
479
500
  # @param id [String]
480
501
  # @param [Hash] opts the optional parameters
481
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
502
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
482
503
  # @return [Hash<String, Object>]
483
504
  def get_list_relationships_profiles(id, opts = {})
484
505
  data, _status_code, _headers = get_list_relationships_profiles_with_http_info(id, opts)
@@ -486,10 +507,10 @@ module KlaviyoAPI
486
507
  end
487
508
 
488
509
  # Get List Relationships Profiles
489
- # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:read&#x60; &#x60;profiles:read&#x60;
510
+ # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;list:read&#x60; &#x60;profiles:read&#x60;
490
511
  # @param id [String]
491
512
  # @param [Hash] opts the optional parameters
492
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
513
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
493
514
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
494
515
  def get_list_relationships_profiles_with_http_info(id, opts = {})
495
516
  if @api_client.config.debugging
@@ -509,7 +530,7 @@ module KlaviyoAPI
509
530
  # header parameters
510
531
  header_params = opts[:header_params] || {}
511
532
  # klaviyo api revision
512
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
533
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
513
534
  # HTTP header 'Accept' (if needed)
514
535
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
515
536
 
@@ -574,7 +595,7 @@ module KlaviyoAPI
574
595
  # header parameters
575
596
  header_params = opts[:header_params] || {}
576
597
  # klaviyo api revision
577
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
598
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
578
599
  # HTTP header 'Accept' (if needed)
579
600
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
580
601
 
@@ -611,7 +632,7 @@ module KlaviyoAPI
611
632
  # Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `list:read` `tags:read`
612
633
  # @param id [String]
613
634
  # @param [Hash] opts the optional parameters
614
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
635
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
615
636
  # @return [Hash<String, Object>]
616
637
  def get_list_tags(id, opts = {})
617
638
  data, _status_code, _headers = get_list_tags_with_http_info(id, opts)
@@ -622,7 +643,7 @@ module KlaviyoAPI
622
643
  # Return all tags associated with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;list:read&#x60; &#x60;tags:read&#x60;
623
644
  # @param id [String]
624
645
  # @param [Hash] opts the optional parameters
625
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
646
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
626
647
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
627
648
  def get_list_tags_with_http_info(id, opts = {})
628
649
  if @api_client.config.debugging
@@ -646,7 +667,7 @@ module KlaviyoAPI
646
667
  # header parameters
647
668
  header_params = opts[:header_params] || {}
648
669
  # klaviyo api revision
649
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
670
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
650
671
  # HTTP header 'Accept' (if needed)
651
672
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
652
673
 
@@ -680,11 +701,13 @@ module KlaviyoAPI
680
701
  end
681
702
 
682
703
  # Get Lists
683
- # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `list:read`
704
+ # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `list:read`
684
705
  # @param [Hash] opts the optional parameters
685
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
686
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
687
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
706
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
707
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
708
+ # @option opts [String] :filter 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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
709
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
710
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
688
711
  # @return [Hash<String, Object>]
689
712
  def get_lists(opts = {})
690
713
  data, _status_code, _headers = get_lists_with_http_info(opts)
@@ -692,11 +715,13 @@ module KlaviyoAPI
692
715
  end
693
716
 
694
717
  # Get Lists
695
- # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, and &#x60;updated&#x60; fields. Returns a maximum of 10 results per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;list:read&#x60;
718
+ # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, and &#x60;updated&#x60; fields. Returns a maximum of 10 results per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;list:read&#x60;
696
719
  # @param [Hash] opts the optional parameters
697
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
698
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
699
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
720
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
721
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
722
+ # @option opts [String] :filter 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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
723
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
724
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
700
725
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
701
726
  def get_lists_with_http_info(opts = {})
702
727
  if @api_client.config.debugging
@@ -706,19 +731,29 @@ module KlaviyoAPI
706
731
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
707
732
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
708
733
  end
734
+ allowable_values = ["name"]
735
+ if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
736
+ fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
737
+ end
738
+ allowable_values = ["tags"]
739
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
740
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
741
+ end
709
742
  # resource path
710
743
  local_var_path = '/api/lists/'
711
744
 
712
745
  # query parameters
713
746
  query_params = opts[:query_params] || {}
714
747
  query_params[:'fields[list]'] = @api_client.build_collection_param(opts[:'fields_list'], :csv) if !opts[:'fields_list'].nil?
748
+ query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
715
749
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
750
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
716
751
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
717
752
 
718
753
  # header parameters
719
754
  header_params = opts[:header_params] || {}
720
755
  # klaviyo api revision
721
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
756
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
722
757
  # HTTP header 'Accept' (if needed)
723
758
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
724
759
 
@@ -789,7 +824,7 @@ module KlaviyoAPI
789
824
  # header parameters
790
825
  header_params = opts[:header_params] || {}
791
826
  # klaviyo api revision
792
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
827
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
793
828
  # HTTP header 'Accept' (if needed)
794
829
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
795
830
  # HTTP header 'Content-Type'
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2023-06-15
6
+ The version of the OpenAPI document: 2023-08-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -23,7 +23,7 @@ module KlaviyoAPI
23
23
  # Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
24
24
  # @param id [String] Metric ID
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
26
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
27
27
  # @return [Hash<String, Object>]
28
28
  def get_metric(id, opts = {})
29
29
  data, _status_code, _headers = get_metric_with_http_info(id, opts)
@@ -34,7 +34,7 @@ module KlaviyoAPI
34
34
  # Get a metric with the given metric ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;metrics:read&#x60;
35
35
  # @param id [String] Metric ID
36
36
  # @param [Hash] opts the optional parameters
37
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
37
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
38
38
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
39
39
  def get_metric_with_http_info(id, opts = {})
40
40
  if @api_client.config.debugging
@@ -58,7 +58,7 @@ module KlaviyoAPI
58
58
  # header parameters
59
59
  header_params = opts[:header_params] || {}
60
60
  # klaviyo api revision
61
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
61
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
62
62
  # HTTP header 'Accept' (if needed)
63
63
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
64
 
@@ -92,11 +92,11 @@ module KlaviyoAPI
92
92
  end
93
93
 
94
94
  # Get Metrics
95
- # Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
95
+ # Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
96
96
  # @param [Hash] opts the optional parameters
97
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
98
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
99
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
97
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
98
+ # @option opts [String] :filter 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;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
99
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
100
100
  # @return [Hash<String, Object>]
101
101
  def get_metrics(opts = {})
102
102
  data, _status_code, _headers = get_metrics_with_http_info(opts)
@@ -104,11 +104,11 @@ module KlaviyoAPI
104
104
  end
105
105
 
106
106
  # Get Metrics
107
- # Get all metrics in an account. Requests can be filtered by the following fields: integration &#x60;name&#x60;, integration &#x60;category&#x60; Returns a maximum of 200 results per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;metrics:read&#x60;
107
+ # Get all metrics in an account. Requests can be filtered by the following fields: integration &#x60;name&#x60;, integration &#x60;category&#x60; Returns a maximum of 200 results per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;metrics:read&#x60;
108
108
  # @param [Hash] opts the optional parameters
109
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
110
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
111
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
109
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
110
+ # @option opts [String] :filter 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;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
111
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
112
112
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
113
113
  def get_metrics_with_http_info(opts = {})
114
114
  if @api_client.config.debugging
@@ -130,7 +130,7 @@ module KlaviyoAPI
130
130
  # header parameters
131
131
  header_params = opts[:header_params] || {}
132
132
  # klaviyo api revision
133
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
133
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
134
134
  # HTTP header 'Accept' (if needed)
135
135
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
136
136
 
@@ -195,7 +195,7 @@ module KlaviyoAPI
195
195
  # header parameters
196
196
  header_params = opts[:header_params] || {}
197
197
  # klaviyo api revision
198
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
198
+ header_params['revision'] = ENV['API_REVISION'] || "2023-08-15"
199
199
  # HTTP header 'Accept' (if needed)
200
200
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
201
201
  # HTTP header 'Content-Type'