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
@@ -0,0 +1,524 @@
1
+ # KlaviyoAPI::TemplatesApi
2
+
3
+ All URIs are relative to *https://a.klaviyo.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_template**](TemplatesApi.md#create_template) | **POST** /api/templates/ | Create Template |
8
+ | [**create_template_clone**](TemplatesApi.md#create_template_clone) | **POST** /api/template-clone/ | Create Template Clone |
9
+ | [**create_template_render**](TemplatesApi.md#create_template_render) | **POST** /api/template-render/ | Create Template Render |
10
+ | [**delete_template**](TemplatesApi.md#delete_template) | **DELETE** /api/templates/{id}/ | Delete Template |
11
+ | [**get_template**](TemplatesApi.md#get_template) | **GET** /api/templates/{id}/ | Get Template |
12
+ | [**get_templates**](TemplatesApi.md#get_templates) | **GET** /api/templates/ | Get Templates |
13
+ | [**update_template**](TemplatesApi.md#update_template) | **PATCH** /api/templates/{id}/ | Update Template |
14
+
15
+
16
+ ## create_template
17
+
18
+ > Hash<String, Object> create_template(template_create_query)
19
+
20
+ Create Template
21
+
22
+ Create a new custom HTML template. If there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates that can be created via the API. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `template:write`
23
+
24
+ ### Examples
25
+
26
+ ```ruby
27
+ require 'time'
28
+ require 'klaviyo-api-sdk'
29
+ # setup authorization
30
+ KlaviyoAPI.configure do |config|
31
+ # Configure API key authorization: Klaviyo-API-Key
32
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
33
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
35
+ end
36
+
37
+ api_instance = KlaviyoAPI::TemplatesApi.new
38
+ template_create_query = KlaviyoAPI::TemplateCreateQuery.new({data: KlaviyoAPI::TemplateCreateQueryResourceObject.new({type: KlaviyoAPI::TemplateEnum::TEMPLATE, attributes: KlaviyoAPI::TemplateCreateQueryResourceObjectAttributes.new({name: 'Monthly Newsletter Template', editor_type: 'editor_type_example'})})}) # TemplateCreateQuery |
39
+
40
+ begin
41
+ # Create Template
42
+ result = api_instance.create_template(template_create_query)
43
+ p result
44
+ rescue KlaviyoAPI::ApiError => e
45
+ puts "Error when calling TemplatesApi->create_template: #{e}"
46
+ end
47
+ ```
48
+
49
+ #### Using the create_template_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_template_with_http_info(template_create_query)
54
+
55
+ ```ruby
56
+ begin
57
+ # Create Template
58
+ data, status_code, headers = api_instance.create_template_with_http_info(template_create_query)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => Hash&lt;String, Object&gt;
62
+ rescue KlaviyoAPI::ApiError => e
63
+ puts "Error when calling TemplatesApi->create_template_with_http_info: #{e}"
64
+ end
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **template_create_query** | [**TemplateCreateQuery**](TemplateCreateQuery.md) | | |
72
+
73
+ ### Return type
74
+
75
+ **Hash&lt;String, Object&gt;**
76
+
77
+ ### Authorization
78
+
79
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: application/json
84
+ - **Accept**: application/json
85
+
86
+
87
+ ## create_template_clone
88
+
89
+ > Hash&lt;String, Object&gt; create_template_clone(template_clone_query)
90
+
91
+ Create Template Clone
92
+
93
+ Create a clone of a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `template:write`
94
+
95
+ ### Examples
96
+
97
+ ```ruby
98
+ require 'time'
99
+ require 'klaviyo-api-sdk'
100
+ # setup authorization
101
+ KlaviyoAPI.configure do |config|
102
+ # Configure API key authorization: Klaviyo-API-Key
103
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
104
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
106
+ end
107
+
108
+ api_instance = KlaviyoAPI::TemplatesApi.new
109
+ template_clone_query = KlaviyoAPI::TemplateCloneQuery.new({data: KlaviyoAPI::TemplateCloneQueryResourceObject.new({type: KlaviyoAPI::TemplateEnum::TEMPLATE, attributes: KlaviyoAPI::TemplateCloneQueryResourceObjectAttributes.new({id: 'id_example'})})}) # TemplateCloneQuery |
110
+
111
+ begin
112
+ # Create Template Clone
113
+ result = api_instance.create_template_clone(template_clone_query)
114
+ p result
115
+ rescue KlaviyoAPI::ApiError => e
116
+ puts "Error when calling TemplatesApi->create_template_clone: #{e}"
117
+ end
118
+ ```
119
+
120
+ #### Using the create_template_clone_with_http_info variant
121
+
122
+ This returns an Array which contains the response data, status code and headers.
123
+
124
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_template_clone_with_http_info(template_clone_query)
125
+
126
+ ```ruby
127
+ begin
128
+ # Create Template Clone
129
+ data, status_code, headers = api_instance.create_template_clone_with_http_info(template_clone_query)
130
+ p status_code # => 2xx
131
+ p headers # => { ... }
132
+ p data # => Hash&lt;String, Object&gt;
133
+ rescue KlaviyoAPI::ApiError => e
134
+ puts "Error when calling TemplatesApi->create_template_clone_with_http_info: #{e}"
135
+ end
136
+ ```
137
+
138
+ ### Parameters
139
+
140
+ | Name | Type | Description | Notes |
141
+ | ---- | ---- | ----------- | ----- |
142
+ | **template_clone_query** | [**TemplateCloneQuery**](TemplateCloneQuery.md) | | |
143
+
144
+ ### Return type
145
+
146
+ **Hash&lt;String, Object&gt;**
147
+
148
+ ### Authorization
149
+
150
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: application/json
155
+ - **Accept**: application/json
156
+
157
+
158
+ ## create_template_render
159
+
160
+ > Hash&lt;String, Object&gt; create_template_render(template_render_query)
161
+
162
+ Create Template Render
163
+
164
+ Render a template with the given template ID and context attribute. Returns the HTML and plain text versions of the email template. **Request body parameters** (nested under `attributes`): * `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets). * `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object. Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing. Ex. `{ \"name\" : \"George Washington\", \"state\" : \"VA\" }`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
165
+
166
+ ### Examples
167
+
168
+ ```ruby
169
+ require 'time'
170
+ require 'klaviyo-api-sdk'
171
+ # setup authorization
172
+ KlaviyoAPI.configure do |config|
173
+ # Configure API key authorization: Klaviyo-API-Key
174
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
175
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
176
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
177
+ end
178
+
179
+ api_instance = KlaviyoAPI::TemplatesApi.new
180
+ template_render_query = KlaviyoAPI::TemplateRenderQuery.new({data: KlaviyoAPI::TemplateRenderQueryResourceObject.new({type: KlaviyoAPI::TemplateEnum::TEMPLATE, attributes: KlaviyoAPI::TemplateRenderQueryResourceObjectAttributes.new({id: 'id_example', context: {"first_name":"Jane","last_name":"Smith"}})})}) # TemplateRenderQuery |
181
+
182
+ begin
183
+ # Create Template Render
184
+ result = api_instance.create_template_render(template_render_query)
185
+ p result
186
+ rescue KlaviyoAPI::ApiError => e
187
+ puts "Error when calling TemplatesApi->create_template_render: #{e}"
188
+ end
189
+ ```
190
+
191
+ #### Using the create_template_render_with_http_info variant
192
+
193
+ This returns an Array which contains the response data, status code and headers.
194
+
195
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_template_render_with_http_info(template_render_query)
196
+
197
+ ```ruby
198
+ begin
199
+ # Create Template Render
200
+ data, status_code, headers = api_instance.create_template_render_with_http_info(template_render_query)
201
+ p status_code # => 2xx
202
+ p headers # => { ... }
203
+ p data # => Hash&lt;String, Object&gt;
204
+ rescue KlaviyoAPI::ApiError => e
205
+ puts "Error when calling TemplatesApi->create_template_render_with_http_info: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ | Name | Type | Description | Notes |
212
+ | ---- | ---- | ----------- | ----- |
213
+ | **template_render_query** | [**TemplateRenderQuery**](TemplateRenderQuery.md) | | |
214
+
215
+ ### Return type
216
+
217
+ **Hash&lt;String, Object&gt;**
218
+
219
+ ### Authorization
220
+
221
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: application/json
226
+ - **Accept**: application/json
227
+
228
+
229
+ ## delete_template
230
+
231
+ > delete_template(id)
232
+
233
+ Delete Template
234
+
235
+ Delete a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `template:write`
236
+
237
+ ### Examples
238
+
239
+ ```ruby
240
+ require 'time'
241
+ require 'klaviyo-api-sdk'
242
+ # setup authorization
243
+ KlaviyoAPI.configure do |config|
244
+ # Configure API key authorization: Klaviyo-API-Key
245
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
246
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
247
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
248
+ end
249
+
250
+ api_instance = KlaviyoAPI::TemplatesApi.new
251
+ id = 'id_example' # String | The ID of template
252
+
253
+ begin
254
+ # Delete Template
255
+ api_instance.delete_template(id)
256
+ rescue KlaviyoAPI::ApiError => e
257
+ puts "Error when calling TemplatesApi->delete_template: #{e}"
258
+ end
259
+ ```
260
+
261
+ #### Using the delete_template_with_http_info variant
262
+
263
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
264
+
265
+ > <Array(nil, Integer, Hash)> delete_template_with_http_info(id)
266
+
267
+ ```ruby
268
+ begin
269
+ # Delete Template
270
+ data, status_code, headers = api_instance.delete_template_with_http_info(id)
271
+ p status_code # => 2xx
272
+ p headers # => { ... }
273
+ p data # => nil
274
+ rescue KlaviyoAPI::ApiError => e
275
+ puts "Error when calling TemplatesApi->delete_template_with_http_info: #{e}"
276
+ end
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ | Name | Type | Description | Notes |
282
+ | ---- | ---- | ----------- | ----- |
283
+ | **id** | **String** | The ID of template | |
284
+
285
+ ### Return type
286
+
287
+ nil (empty response body)
288
+
289
+ ### Authorization
290
+
291
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: Not defined
296
+ - **Accept**: application/json
297
+
298
+
299
+ ## get_template
300
+
301
+ > Hash&lt;String, Object&gt; get_template(id, opts)
302
+
303
+ Get Template
304
+
305
+ Get a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`
306
+
307
+ ### Examples
308
+
309
+ ```ruby
310
+ require 'time'
311
+ require 'klaviyo-api-sdk'
312
+ # setup authorization
313
+ KlaviyoAPI.configure do |config|
314
+ # Configure API key authorization: Klaviyo-API-Key
315
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
316
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
317
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
318
+ end
319
+
320
+ api_instance = KlaviyoAPI::TemplatesApi.new
321
+ id = 'id_example' # String | The ID of template
322
+ opts = {
323
+ fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
324
+ }
325
+
326
+ begin
327
+ # Get Template
328
+ result = api_instance.get_template(id, opts)
329
+ p result
330
+ rescue KlaviyoAPI::ApiError => e
331
+ puts "Error when calling TemplatesApi->get_template: #{e}"
332
+ end
333
+ ```
334
+
335
+ #### Using the get_template_with_http_info variant
336
+
337
+ This returns an Array which contains the response data, status code and headers.
338
+
339
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_template_with_http_info(id, opts)
340
+
341
+ ```ruby
342
+ begin
343
+ # Get Template
344
+ data, status_code, headers = api_instance.get_template_with_http_info(id, opts)
345
+ p status_code # => 2xx
346
+ p headers # => { ... }
347
+ p data # => Hash&lt;String, Object&gt;
348
+ rescue KlaviyoAPI::ApiError => e
349
+ puts "Error when calling TemplatesApi->get_template_with_http_info: #{e}"
350
+ end
351
+ ```
352
+
353
+ ### Parameters
354
+
355
+ | Name | Type | Description | Notes |
356
+ | ---- | ---- | ----------- | ----- |
357
+ | **id** | **String** | The ID of template | |
358
+ | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
359
+
360
+ ### Return type
361
+
362
+ **Hash&lt;String, Object&gt;**
363
+
364
+ ### Authorization
365
+
366
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
367
+
368
+ ### HTTP request headers
369
+
370
+ - **Content-Type**: Not defined
371
+ - **Accept**: application/json
372
+
373
+
374
+ ## get_templates
375
+
376
+ > Hash&lt;String, Object&gt; get_templates(opts)
377
+
378
+ Get Templates
379
+
380
+ Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`
381
+
382
+ ### Examples
383
+
384
+ ```ruby
385
+ require 'time'
386
+ require 'klaviyo-api-sdk'
387
+ # setup authorization
388
+ KlaviyoAPI.configure do |config|
389
+ # Configure API key authorization: Klaviyo-API-Key
390
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
392
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
393
+ end
394
+
395
+ api_instance = KlaviyoAPI::TemplatesApi.new
396
+ opts = {
397
+ fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
398
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
399
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
400
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
401
+ }
402
+
403
+ begin
404
+ # Get Templates
405
+ result = api_instance.get_templates(opts)
406
+ p result
407
+ rescue KlaviyoAPI::ApiError => e
408
+ puts "Error when calling TemplatesApi->get_templates: #{e}"
409
+ end
410
+ ```
411
+
412
+ #### Using the get_templates_with_http_info variant
413
+
414
+ This returns an Array which contains the response data, status code and headers.
415
+
416
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_templates_with_http_info(opts)
417
+
418
+ ```ruby
419
+ begin
420
+ # Get Templates
421
+ data, status_code, headers = api_instance.get_templates_with_http_info(opts)
422
+ p status_code # => 2xx
423
+ p headers # => { ... }
424
+ p data # => Hash&lt;String, Object&gt;
425
+ rescue KlaviyoAPI::ApiError => e
426
+ puts "Error when calling TemplatesApi->get_templates_with_http_info: #{e}"
427
+ end
428
+ ```
429
+
430
+ ### Parameters
431
+
432
+ | Name | Type | Description | Notes |
433
+ | ---- | ---- | ----------- | ----- |
434
+ | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
435
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
436
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
437
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting | [optional] |
438
+
439
+ ### Return type
440
+
441
+ **Hash&lt;String, Object&gt;**
442
+
443
+ ### Authorization
444
+
445
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
446
+
447
+ ### HTTP request headers
448
+
449
+ - **Content-Type**: Not defined
450
+ - **Accept**: application/json
451
+
452
+
453
+ ## update_template
454
+
455
+ > Hash&lt;String, Object&gt; update_template(id, template_update_query)
456
+
457
+ Update Template
458
+
459
+ Update a template with the given template ID. Does not currently update drag & drop templates.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `template:write`
460
+
461
+ ### Examples
462
+
463
+ ```ruby
464
+ require 'time'
465
+ require 'klaviyo-api-sdk'
466
+ # setup authorization
467
+ KlaviyoAPI.configure do |config|
468
+ # Configure API key authorization: Klaviyo-API-Key
469
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
470
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
471
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
472
+ end
473
+
474
+ api_instance = KlaviyoAPI::TemplatesApi.new
475
+ id = 'id_example' # String | The ID of template
476
+ template_update_query = KlaviyoAPI::TemplateUpdateQuery.new({data: KlaviyoAPI::TemplateUpdateQueryResourceObject.new({type: KlaviyoAPI::TemplateEnum::TEMPLATE, id: 'id_example', attributes: KlaviyoAPI::TemplateUpdateQueryResourceObjectAttributes.new})}) # TemplateUpdateQuery |
477
+
478
+ begin
479
+ # Update Template
480
+ result = api_instance.update_template(id, template_update_query)
481
+ p result
482
+ rescue KlaviyoAPI::ApiError => e
483
+ puts "Error when calling TemplatesApi->update_template: #{e}"
484
+ end
485
+ ```
486
+
487
+ #### Using the update_template_with_http_info variant
488
+
489
+ This returns an Array which contains the response data, status code and headers.
490
+
491
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_template_with_http_info(id, template_update_query)
492
+
493
+ ```ruby
494
+ begin
495
+ # Update Template
496
+ data, status_code, headers = api_instance.update_template_with_http_info(id, template_update_query)
497
+ p status_code # => 2xx
498
+ p headers # => { ... }
499
+ p data # => Hash&lt;String, Object&gt;
500
+ rescue KlaviyoAPI::ApiError => e
501
+ puts "Error when calling TemplatesApi->update_template_with_http_info: #{e}"
502
+ end
503
+ ```
504
+
505
+ ### Parameters
506
+
507
+ | Name | Type | Description | Notes |
508
+ | ---- | ---- | ----------- | ----- |
509
+ | **id** | **String** | The ID of template | |
510
+ | **template_update_query** | [**TemplateUpdateQuery**](TemplateUpdateQuery.md) | | |
511
+
512
+ ### Return type
513
+
514
+ **Hash&lt;String, Object&gt;**
515
+
516
+ ### Authorization
517
+
518
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
519
+
520
+ ### HTTP request headers
521
+
522
+ - **Content-Type**: application/json
523
+ - **Accept**: application/json
524
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::ThrottledScheduleOptions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **datetime** | **Time** | The time to send at | |
8
+ | **throttle_percentage** | **Integer** | The percentage of recipients per hour to send to. Allowed values: [10, 11, 13, 14, 17, 20, 25, 33, 50] | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::ThrottledScheduleOptions.new(
16
+ datetime: null,
17
+ throttle_percentage: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::UTMParamsSubObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the UTM param | |
8
+ | **value** | **String** | Value of the UTM param. Can be templated data. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::UTMParamsSubObject.new(
16
+ name: utm_medium,
17
+ value: campaign
18
+ )
19
+ ```
20
+
data/git_push.sh ADDED
@@ -0,0 +1,57 @@
1
+ #!/bin/sh
2
+ # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3
+ #
4
+ # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
5
+
6
+ git_user_id=$1
7
+ git_repo_id=$2
8
+ release_note=$3
9
+ git_host=$4
10
+
11
+ if [ "$git_host" = "" ]; then
12
+ git_host="github.com"
13
+ echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14
+ fi
15
+
16
+ if [ "$git_user_id" = "" ]; then
17
+ git_user_id="GIT_USER_ID"
18
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19
+ fi
20
+
21
+ if [ "$git_repo_id" = "" ]; then
22
+ git_repo_id="GIT_REPO_ID"
23
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24
+ fi
25
+
26
+ if [ "$release_note" = "" ]; then
27
+ release_note="Minor update"
28
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
29
+ fi
30
+
31
+ # Initialize the local directory as a Git repository
32
+ git init
33
+
34
+ # Adds the files in the local repository and stages them for commit.
35
+ git add .
36
+
37
+ # Commits the tracked changes and prepares them to be pushed to a remote repository.
38
+ git commit -m "$release_note"
39
+
40
+ # Sets the new remote
41
+ git_remote=$(git remote)
42
+ if [ "$git_remote" = "" ]; then # git remote not defined
43
+
44
+ if [ "$GIT_TOKEN" = "" ]; then
45
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46
+ git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
47
+ else
48
+ git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
49
+ fi
50
+
51
+ fi
52
+
53
+ git pull origin master
54
+
55
+ # Pushes (Forces) the changes in the local repository up to the remote repository
56
+ echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
57
+ git push origin master 2>&1 | grep -v 'To https'
@@ -5,7 +5,7 @@
5
5
 
6
6
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
7
7
 
8
- The version of the OpenAPI document: 2023-06-15
8
+ The version of the OpenAPI document: 2023-08-15
9
9
  Contact: developers@klaviyo.com
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.2.1
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
17
17
 
18
18
  Gem::Specification.new do |s|
19
19
  s.name = "klaviyo-api-sdk"
20
- s.version = "3.0.0"
20
+ s.version = "4.1.0"
21
21
  s.authors = ['Klaviyo Team']
22
22
  s.email = ['libraries@klaviyo.com']
23
23
  s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'