klaviyo-api-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (506) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +17 -0
  3. data/Gemfile +9 -0
  4. data/LICENSE.md +21 -0
  5. data/README.md +1316 -0
  6. data/Rakefile +10 -0
  7. data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
  8. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +20 -0
  9. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
  10. data/docs/CatalogCategoryCreateQuery.md +18 -0
  11. data/docs/CatalogCategoryCreateQueryAsSubResource.md +22 -0
  12. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +24 -0
  13. data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
  14. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +20 -0
  15. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
  16. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +20 -0
  17. data/docs/CatalogCategoryItemOp.md +18 -0
  18. data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
  19. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +20 -0
  20. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
  21. data/docs/CatalogCategoryUpdateQuery.md +18 -0
  22. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +24 -0
  23. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +18 -0
  24. data/docs/CatalogItemCategoryOp.md +18 -0
  25. data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
  26. data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +20 -0
  27. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
  28. data/docs/CatalogItemCreateQuery.md +18 -0
  29. data/docs/CatalogItemCreateQueryAsSubResource.md +22 -0
  30. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +38 -0
  31. data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +18 -0
  32. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +18 -0
  33. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +20 -0
  34. data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
  35. data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +20 -0
  36. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
  37. data/docs/CatalogItemDeleteQueryAsSubResource.md +20 -0
  38. data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
  39. data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +20 -0
  40. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
  41. data/docs/CatalogItemUpdateQuery.md +18 -0
  42. data/docs/CatalogItemUpdateQueryAsSubResource.md +24 -0
  43. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +32 -0
  44. data/docs/CatalogJobErrorPayload.md +26 -0
  45. data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
  46. data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +20 -0
  47. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
  48. data/docs/CatalogVariantCreateQuery.md +18 -0
  49. data/docs/CatalogVariantCreateQueryAsSubResource.md +22 -0
  50. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +46 -0
  51. data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +18 -0
  52. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +18 -0
  53. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +20 -0
  54. data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
  55. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +20 -0
  56. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +18 -0
  57. data/docs/CatalogVariantDeleteQueryAsSubResource.md +20 -0
  58. data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
  59. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +20 -0
  60. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +18 -0
  61. data/docs/CatalogVariantUpdateQuery.md +18 -0
  62. data/docs/CatalogVariantUpdateQueryAsSubResource.md +22 -0
  63. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +38 -0
  64. data/docs/CatalogsApi.md +4048 -0
  65. data/docs/ClientApi.md +205 -0
  66. data/docs/EmailMessageContent.md +24 -0
  67. data/docs/EmailTrackingOptions.md +24 -0
  68. data/docs/ErrorSource.md +18 -0
  69. data/docs/EventCreateQuery.md +18 -0
  70. data/docs/EventCreateQueryAsSubResource.md +20 -0
  71. data/docs/EventCreateQueryAsSubResourceAttributes.md +28 -0
  72. data/docs/EventsApi.md +472 -0
  73. data/docs/FlowUpdateQuery.md +18 -0
  74. data/docs/FlowUpdateQueryAsSubResource.md +22 -0
  75. data/docs/FlowUpdateQueryAsSubResourceAttributes.md +18 -0
  76. data/docs/FlowsApi.md +951 -0
  77. data/docs/GetCatalogItems4XXResponse.md +18 -0
  78. data/docs/GetCatalogItems4XXResponseErrorsInner.md +26 -0
  79. data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +20 -0
  80. data/docs/IncludedCategories.md +24 -0
  81. data/docs/IncludedCategoriesAttributes.md +22 -0
  82. data/docs/IncludedFlowAction.md +24 -0
  83. data/docs/IncludedFlowActions.md +24 -0
  84. data/docs/IncludedFlowActionsAttributes.md +32 -0
  85. data/docs/IncludedFlowActionsAttributesTrackingOptions.md +49 -0
  86. data/docs/IncludedFlowMessages.md +24 -0
  87. data/docs/IncludedFlowMessagesAttributes.md +26 -0
  88. data/docs/IncludedFlowMessagesAttributesContent.md +49 -0
  89. data/docs/IncludedFlows.md +24 -0
  90. data/docs/IncludedFlowsAttributes.md +28 -0
  91. data/docs/IncludedItems.md +24 -0
  92. data/docs/IncludedItemsAttributes.md +38 -0
  93. data/docs/IncludedLists.md +24 -0
  94. data/docs/IncludedListsAttributes.md +22 -0
  95. data/docs/IncludedMetrics.md +24 -0
  96. data/docs/IncludedMetricsAttributes.md +24 -0
  97. data/docs/IncludedProfile.md +24 -0
  98. data/docs/IncludedProfiles.md +24 -0
  99. data/docs/IncludedProfilesAttributes.md +44 -0
  100. data/docs/IncludedSegments.md +24 -0
  101. data/docs/IncludedVariants.md +24 -0
  102. data/docs/IncludedVariantsAttributes.md +46 -0
  103. data/docs/IncludedVariantsLinks.md +18 -0
  104. data/docs/ListCreateQuery.md +18 -0
  105. data/docs/ListCreateQueryAsSubResource.md +20 -0
  106. data/docs/ListCreateQueryAsSubResourceAttributes.md +18 -0
  107. data/docs/ListDeleteQueryAsSubResource.md +20 -0
  108. data/docs/ListMembersAddQuery.md +18 -0
  109. data/docs/ListMembersAddQueryDataInner.md +20 -0
  110. data/docs/ListMembersDeleteQuery.md +18 -0
  111. data/docs/ListPartialUpdateQuery.md +18 -0
  112. data/docs/ListPartialUpdateQueryAsSubResource.md +22 -0
  113. data/docs/ListsApi.md +686 -0
  114. data/docs/MetricAggregateQuery.md +18 -0
  115. data/docs/MetricAggregateQueryAsSubResource.md +20 -0
  116. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +36 -0
  117. data/docs/MetricAggregateRowDTO.md +20 -0
  118. data/docs/MetricCreateQuery.md +20 -0
  119. data/docs/MetricsApi.md +233 -0
  120. data/docs/OnsiteProfileCreateQuery.md +18 -0
  121. data/docs/OnsiteProfileCreateQueryAsSubResource.md +22 -0
  122. data/docs/OnsiteProfileMeta.md +18 -0
  123. data/docs/OnsiteProfileMetaIdentifiers.md +28 -0
  124. data/docs/OnsiteSubscriptionCreateQuery.md +18 -0
  125. data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +20 -0
  126. data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +26 -0
  127. data/docs/ProfileCreateQuery.md +18 -0
  128. data/docs/ProfileCreateQueryAsSubResource.md +20 -0
  129. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +38 -0
  130. data/docs/ProfileLocation.md +34 -0
  131. data/docs/ProfileLocationLatitude.md +49 -0
  132. data/docs/ProfilePartialUpdateQuery.md +18 -0
  133. data/docs/ProfilePartialUpdateQueryAsSubResource.md +22 -0
  134. data/docs/ProfilesApi.md +825 -0
  135. data/docs/SMSMessageContent.md +20 -0
  136. data/docs/SMSRenderOptions.md +24 -0
  137. data/docs/SMSTrackingOptions.md +20 -0
  138. data/docs/SegmentPartialUpdateQuery.md +18 -0
  139. data/docs/SegmentPartialUpdateQueryAsSubResource.md +22 -0
  140. data/docs/SegmentsApi.md +390 -0
  141. data/docs/SendOptions.md +20 -0
  142. data/docs/Subscription.md +20 -0
  143. data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
  144. data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
  145. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
  146. data/docs/Suppression.md +18 -0
  147. data/docs/SuppressionCreateJobCreateQuery.md +18 -0
  148. data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +20 -0
  149. data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
  150. data/docs/TemplateCloneQuery.md +18 -0
  151. data/docs/TemplateCloneQueryAsSubResource.md +20 -0
  152. data/docs/TemplateCloneQueryAsSubResourceAttributes.md +20 -0
  153. data/docs/TemplateCreateQuery.md +18 -0
  154. data/docs/TemplateCreateQueryAsSubResource.md +20 -0
  155. data/docs/TemplateCreateQueryAsSubResourceAttributes.md +26 -0
  156. data/docs/TemplateDeleteQueryAsSubResource.md +20 -0
  157. data/docs/TemplateUpdateQuery.md +18 -0
  158. data/docs/TemplateUpdateQueryAsSubResource.md +22 -0
  159. data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +24 -0
  160. data/docs/TemplatesApi.md +529 -0
  161. data/docs/UnsubscriptionCreateJobCreateQuery.md +18 -0
  162. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +20 -0
  163. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +22 -0
  164. data/docs/UnsuppressionCreateJobCreateQuery.md +18 -0
  165. data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +20 -0
  166. data/docs/UtmParamInfo.md +20 -0
  167. data/docs/V2TemplateRenderQuery.md +18 -0
  168. data/docs/V2TemplateRenderQueryAsSubResource.md +20 -0
  169. data/docs/V2TemplateRenderQueryAsSubResourceAttributes.md +20 -0
  170. data/git_push.sh +57 -0
  171. data/klaviyo-api-sdk.gemspec +40 -0
  172. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +4095 -0
  173. data/lib/klaviyo-api-sdk/api/client_api.rb +249 -0
  174. data/lib/klaviyo-api-sdk/api/events_api.rb +505 -0
  175. data/lib/klaviyo-api-sdk/api/flows_api.rb +1009 -0
  176. data/lib/klaviyo-api-sdk/api/lists_api.rb +708 -0
  177. data/lib/klaviyo-api-sdk/api/metrics_api.rb +236 -0
  178. data/lib/klaviyo-api-sdk/api/profiles_api.rb +840 -0
  179. data/lib/klaviyo-api-sdk/api/segments_api.rb +392 -0
  180. data/lib/klaviyo-api-sdk/api/templates_api.rb +536 -0
  181. data/lib/klaviyo-api-sdk/api_client.rb +390 -0
  182. data/lib/klaviyo-api-sdk/api_error.rb +57 -0
  183. data/lib/klaviyo-api-sdk/configuration.rb +283 -0
  184. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +224 -0
  185. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +272 -0
  186. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +226 -0
  187. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +224 -0
  188. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +281 -0
  189. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +291 -0
  190. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +224 -0
  191. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +272 -0
  192. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
  193. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +272 -0
  194. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +226 -0
  195. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +224 -0
  196. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +272 -0
  197. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +226 -0
  198. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +224 -0
  199. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +295 -0
  200. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +219 -0
  201. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +226 -0
  202. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +224 -0
  203. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +272 -0
  204. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +226 -0
  205. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +224 -0
  206. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +281 -0
  207. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +366 -0
  208. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +219 -0
  209. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +226 -0
  210. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +272 -0
  211. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +224 -0
  212. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +272 -0
  213. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
  214. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +272 -0
  215. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +224 -0
  216. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +272 -0
  217. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +226 -0
  218. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +224 -0
  219. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +295 -0
  220. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +284 -0
  221. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +280 -0
  222. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +224 -0
  223. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +272 -0
  224. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +226 -0
  225. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +224 -0
  226. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +281 -0
  227. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +435 -0
  228. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +219 -0
  229. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +226 -0
  230. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +272 -0
  231. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +224 -0
  232. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +272 -0
  233. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +226 -0
  234. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +272 -0
  235. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +224 -0
  236. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +272 -0
  237. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +226 -0
  238. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +224 -0
  239. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +286 -0
  240. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +346 -0
  241. data/lib/klaviyo-api-sdk/models/email_message_content.rb +266 -0
  242. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +268 -0
  243. data/lib/klaviyo-api-sdk/models/error_source.rb +224 -0
  244. data/lib/klaviyo-api-sdk/models/event_create_query.rb +224 -0
  245. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +272 -0
  246. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +279 -0
  247. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +224 -0
  248. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +286 -0
  249. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +224 -0
  250. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +226 -0
  251. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +275 -0
  252. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +228 -0
  253. data/lib/klaviyo-api-sdk/models/included_categories.rb +300 -0
  254. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +237 -0
  255. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +300 -0
  256. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +300 -0
  257. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +282 -0
  258. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +105 -0
  259. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +300 -0
  260. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +270 -0
  261. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +105 -0
  262. data/lib/klaviyo-api-sdk/models/included_flows.rb +300 -0
  263. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +264 -0
  264. data/lib/klaviyo-api-sdk/models/included_items.rb +300 -0
  265. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +311 -0
  266. data/lib/klaviyo-api-sdk/models/included_lists.rb +300 -0
  267. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +237 -0
  268. data/lib/klaviyo-api-sdk/models/included_metrics.rb +300 -0
  269. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +246 -0
  270. data/lib/klaviyo-api-sdk/models/included_profile.rb +300 -0
  271. data/lib/klaviyo-api-sdk/models/included_profiles.rb +300 -0
  272. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +336 -0
  273. data/lib/klaviyo-api-sdk/models/included_segments.rb +300 -0
  274. data/lib/klaviyo-api-sdk/models/included_variants.rb +300 -0
  275. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +382 -0
  276. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +224 -0
  277. data/lib/klaviyo-api-sdk/models/list_create_query.rb +224 -0
  278. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +272 -0
  279. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +224 -0
  280. data/lib/klaviyo-api-sdk/models/list_delete_query_as_sub_resource.rb +272 -0
  281. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +226 -0
  282. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +272 -0
  283. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +226 -0
  284. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +224 -0
  285. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +286 -0
  286. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +224 -0
  287. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +272 -0
  288. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +380 -0
  289. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +240 -0
  290. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +233 -0
  291. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +224 -0
  292. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +281 -0
  293. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +224 -0
  294. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +264 -0
  295. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +224 -0
  296. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +272 -0
  297. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +260 -0
  298. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +224 -0
  299. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +272 -0
  300. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +309 -0
  301. data/lib/klaviyo-api-sdk/models/profile_location.rb +291 -0
  302. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +105 -0
  303. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +224 -0
  304. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +286 -0
  305. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +224 -0
  306. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +286 -0
  307. data/lib/klaviyo-api-sdk/models/send_options.rb +238 -0
  308. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +238 -0
  309. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +266 -0
  310. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
  311. data/lib/klaviyo-api-sdk/models/subscription.rb +228 -0
  312. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +224 -0
  313. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +272 -0
  314. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +249 -0
  315. data/lib/klaviyo-api-sdk/models/suppression.rb +224 -0
  316. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +224 -0
  317. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +272 -0
  318. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +226 -0
  319. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +224 -0
  320. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +272 -0
  321. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +230 -0
  322. data/lib/klaviyo-api-sdk/models/template_create_query.rb +224 -0
  323. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +272 -0
  324. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +267 -0
  325. data/lib/klaviyo-api-sdk/models/template_delete_query_as_sub_resource.rb +272 -0
  326. data/lib/klaviyo-api-sdk/models/template_update_query.rb +224 -0
  327. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +286 -0
  328. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +248 -0
  329. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +224 -0
  330. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +272 -0
  331. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +246 -0
  332. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +224 -0
  333. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +272 -0
  334. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +238 -0
  335. data/lib/klaviyo-api-sdk/models/v2_template_render_query.rb +224 -0
  336. data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +272 -0
  337. data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource_attributes.rb +235 -0
  338. data/lib/klaviyo-api-sdk/version.rb +15 -0
  339. data/lib/klaviyo-api-sdk.rb +253 -0
  340. data/spec/api/catalogs_api_spec.rb +759 -0
  341. data/spec/api/client_api_spec.rb +74 -0
  342. data/spec/api/events_api_spec.rb +120 -0
  343. data/spec/api/flows_api_spec.rb +209 -0
  344. data/spec/api/lists_api_spec.rb +156 -0
  345. data/spec/api/metrics_api_spec.rb +74 -0
  346. data/spec/api/profiles_api_spec.rb +178 -0
  347. data/spec/api/segments_api_spec.rb +103 -0
  348. data/spec/api/templates_api_spec.rb +126 -0
  349. data/spec/api_client_spec.rb +226 -0
  350. data/spec/configuration_spec.rb +42 -0
  351. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  352. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +44 -0
  353. data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
  354. data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +56 -0
  355. data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +50 -0
  356. data/spec/models/catalog_category_create_query_spec.rb +34 -0
  357. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  358. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +44 -0
  359. data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
  360. data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +44 -0
  361. data/spec/models/catalog_category_item_op_spec.rb +34 -0
  362. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  363. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +44 -0
  364. data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
  365. data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +34 -0
  366. data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +56 -0
  367. data/spec/models/catalog_category_update_query_spec.rb +34 -0
  368. data/spec/models/catalog_item_category_op_spec.rb +34 -0
  369. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  370. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +44 -0
  371. data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
  372. data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +98 -0
  373. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +44 -0
  374. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +34 -0
  375. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +34 -0
  376. data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +50 -0
  377. data/spec/models/catalog_item_create_query_spec.rb +34 -0
  378. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  379. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +44 -0
  380. data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
  381. data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +44 -0
  382. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  383. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +44 -0
  384. data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
  385. data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +76 -0
  386. data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +56 -0
  387. data/spec/models/catalog_item_update_query_spec.rb +34 -0
  388. data/spec/models/catalog_job_error_payload_spec.rb +58 -0
  389. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  390. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +44 -0
  391. data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
  392. data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +126 -0
  393. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +44 -0
  394. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +34 -0
  395. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +34 -0
  396. data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +50 -0
  397. data/spec/models/catalog_variant_create_query_spec.rb +34 -0
  398. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  399. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +44 -0
  400. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
  401. data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +44 -0
  402. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  403. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +44 -0
  404. data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
  405. data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +98 -0
  406. data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +50 -0
  407. data/spec/models/catalog_variant_update_query_spec.rb +34 -0
  408. data/spec/models/email_message_content_spec.rb +52 -0
  409. data/spec/models/email_tracking_options_spec.rb +52 -0
  410. data/spec/models/error_source_spec.rb +34 -0
  411. data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +64 -0
  412. data/spec/models/event_create_query_as_sub_resource_spec.rb +44 -0
  413. data/spec/models/event_create_query_spec.rb +34 -0
  414. data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +34 -0
  415. data/spec/models/flow_update_query_as_sub_resource_spec.rb +50 -0
  416. data/spec/models/flow_update_query_spec.rb +34 -0
  417. data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +40 -0
  418. data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +58 -0
  419. data/spec/models/get_catalog_items4_xx_response_spec.rb +34 -0
  420. data/spec/models/included_categories_attributes_spec.rb +46 -0
  421. data/spec/models/included_categories_spec.rb +56 -0
  422. data/spec/models/included_flow_action_spec.rb +56 -0
  423. data/spec/models/included_flow_actions_attributes_spec.rb +76 -0
  424. data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +31 -0
  425. data/spec/models/included_flow_actions_spec.rb +56 -0
  426. data/spec/models/included_flow_messages_attributes_content_spec.rb +31 -0
  427. data/spec/models/included_flow_messages_attributes_spec.rb +58 -0
  428. data/spec/models/included_flow_messages_spec.rb +56 -0
  429. data/spec/models/included_flows_attributes_spec.rb +64 -0
  430. data/spec/models/included_flows_spec.rb +56 -0
  431. data/spec/models/included_items_attributes_spec.rb +94 -0
  432. data/spec/models/included_items_spec.rb +56 -0
  433. data/spec/models/included_lists_attributes_spec.rb +46 -0
  434. data/spec/models/included_lists_spec.rb +56 -0
  435. data/spec/models/included_metrics_attributes_spec.rb +52 -0
  436. data/spec/models/included_metrics_spec.rb +56 -0
  437. data/spec/models/included_profile_spec.rb +56 -0
  438. data/spec/models/included_profiles_attributes_spec.rb +112 -0
  439. data/spec/models/included_profiles_spec.rb +56 -0
  440. data/spec/models/included_segments_spec.rb +56 -0
  441. data/spec/models/included_variants_attributes_spec.rb +122 -0
  442. data/spec/models/included_variants_links_spec.rb +34 -0
  443. data/spec/models/included_variants_spec.rb +56 -0
  444. data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +34 -0
  445. data/spec/models/list_create_query_as_sub_resource_spec.rb +44 -0
  446. data/spec/models/list_create_query_spec.rb +34 -0
  447. data/spec/models/list_delete_query_as_sub_resource_spec.rb +44 -0
  448. data/spec/models/list_members_add_query_data_inner_spec.rb +44 -0
  449. data/spec/models/list_members_add_query_spec.rb +34 -0
  450. data/spec/models/list_members_delete_query_spec.rb +34 -0
  451. data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +50 -0
  452. data/spec/models/list_partial_update_query_spec.rb +34 -0
  453. data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +104 -0
  454. data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +44 -0
  455. data/spec/models/metric_aggregate_query_spec.rb +34 -0
  456. data/spec/models/metric_aggregate_row_dto_spec.rb +40 -0
  457. data/spec/models/metric_create_query_spec.rb +40 -0
  458. data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +50 -0
  459. data/spec/models/onsite_profile_create_query_spec.rb +34 -0
  460. data/spec/models/onsite_profile_meta_identifiers_spec.rb +64 -0
  461. data/spec/models/onsite_profile_meta_spec.rb +34 -0
  462. data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +58 -0
  463. data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +44 -0
  464. data/spec/models/onsite_subscription_create_query_spec.rb +34 -0
  465. data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +94 -0
  466. data/spec/models/profile_create_query_as_sub_resource_spec.rb +44 -0
  467. data/spec/models/profile_create_query_spec.rb +34 -0
  468. data/spec/models/profile_location_latitude_spec.rb +31 -0
  469. data/spec/models/profile_location_spec.rb +82 -0
  470. data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +50 -0
  471. data/spec/models/profile_partial_update_query_spec.rb +34 -0
  472. data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +50 -0
  473. data/spec/models/segment_partial_update_query_spec.rb +34 -0
  474. data/spec/models/send_options_spec.rb +40 -0
  475. data/spec/models/sms_message_content_spec.rb +40 -0
  476. data/spec/models/sms_render_options_spec.rb +52 -0
  477. data/spec/models/sms_tracking_options_spec.rb +40 -0
  478. data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
  479. data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
  480. data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
  481. data/spec/models/subscription_spec.rb +40 -0
  482. data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  483. data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
  484. data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
  485. data/spec/models/suppression_spec.rb +34 -0
  486. data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +40 -0
  487. data/spec/models/template_clone_query_as_sub_resource_spec.rb +44 -0
  488. data/spec/models/template_clone_query_spec.rb +34 -0
  489. data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +58 -0
  490. data/spec/models/template_create_query_as_sub_resource_spec.rb +44 -0
  491. data/spec/models/template_create_query_spec.rb +34 -0
  492. data/spec/models/template_delete_query_as_sub_resource_spec.rb +44 -0
  493. data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +52 -0
  494. data/spec/models/template_update_query_as_sub_resource_spec.rb +50 -0
  495. data/spec/models/template_update_query_spec.rb +34 -0
  496. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +46 -0
  497. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +44 -0
  498. data/spec/models/unsubscription_create_job_create_query_spec.rb +34 -0
  499. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +44 -0
  500. data/spec/models/unsuppression_create_job_create_query_spec.rb +34 -0
  501. data/spec/models/utm_param_info_spec.rb +40 -0
  502. data/spec/models/v2_template_render_query_as_sub_resource_attributes_spec.rb +40 -0
  503. data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +44 -0
  504. data/spec/models/v2_template_render_query_spec.rb +34 -0
  505. data/spec/spec_helper.rb +111 -0
  506. metadata +583 -0
data/docs/ListsApi.md ADDED
@@ -0,0 +1,686 @@
1
+ # KlaviyoAPI::ListsApi
2
+
3
+ All URIs are relative to *https://a.klaviyo.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_list**](ListsApi.md#create_list) | **POST** /api/lists/ | Create List |
8
+ | [**create_list_relationships**](ListsApi.md#create_list_relationships) | **POST** /api/lists/{id}/relationships/{related_resource}/ | Add Profile to List |
9
+ | [**delete_list**](ListsApi.md#delete_list) | **DELETE** /api/lists/{id}/ | Delete List |
10
+ | [**delete_list_relationships**](ListsApi.md#delete_list_relationships) | **DELETE** /api/lists/{id}/relationships/{related_resource}/ | Remove Profile from List |
11
+ | [**get_list**](ListsApi.md#get_list) | **GET** /api/lists/{id}/ | Get List |
12
+ | [**get_list_profiles**](ListsApi.md#get_list_profiles) | **GET** /api/lists/{list_id}/profiles/ | Get List Profiles |
13
+ | [**get_list_relationships**](ListsApi.md#get_list_relationships) | **GET** /api/lists/{id}/relationships/{related_resource}/ | Get List Profile Relationships |
14
+ | [**get_lists**](ListsApi.md#get_lists) | **GET** /api/lists/ | Get Lists |
15
+ | [**update_list**](ListsApi.md#update_list) | **PATCH** /api/lists/{id}/ | Update List |
16
+
17
+
18
+ ## create_list
19
+
20
+ > Hash<String, Object> create_list(list_create_query)
21
+
22
+ Create List
23
+
24
+ Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ require 'time'
30
+ require 'klaviyo-api-sdk'
31
+ # setup authorization
32
+ KlaviyoAPI.configure do |config|
33
+ # Configure API key authorization: Klaviyo-API-Key
34
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
35
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
36
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
37
+ end
38
+
39
+ api_instance = KlaviyoAPI::ListsApi.new
40
+ list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryAsSubResource.new({type: 'list', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # ListCreateQuery |
41
+
42
+ begin
43
+ # Create List
44
+ result = api_instance.create_list(list_create_query)
45
+ p result
46
+ rescue KlaviyoAPI::ApiError => e
47
+ puts "Error when calling ListsApi->create_list: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the create_list_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_list_with_http_info(list_create_query)
56
+
57
+ ```ruby
58
+ begin
59
+ # Create List
60
+ data, status_code, headers = api_instance.create_list_with_http_info(list_create_query)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => Hash&lt;String, Object&gt;
64
+ rescue KlaviyoAPI::ApiError => e
65
+ puts "Error when calling ListsApi->create_list_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **list_create_query** | [**ListCreateQuery**](ListCreateQuery.md) | | |
74
+
75
+ ### Return type
76
+
77
+ **Hash&lt;String, Object&gt;**
78
+
79
+ ### Authorization
80
+
81
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
82
+
83
+ ### HTTP request headers
84
+
85
+ - **Content-Type**: application/json
86
+ - **Accept**: application/json
87
+
88
+
89
+ ## create_list_relationships
90
+
91
+ > create_list_relationships(id, related_resource, list_members_add_query)
92
+
93
+ Add Profile to List
94
+
95
+ Add a profile to a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
96
+
97
+ ### Examples
98
+
99
+ ```ruby
100
+ require 'time'
101
+ require 'klaviyo-api-sdk'
102
+ # setup authorization
103
+ KlaviyoAPI.configure do |config|
104
+ # Configure API key authorization: Klaviyo-API-Key
105
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
107
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
108
+ end
109
+
110
+ api_instance = KlaviyoAPI::ListsApi.new
111
+ id = 'id_example' # String |
112
+ related_resource = 'profiles' # String |
113
+ list_members_add_query = KlaviyoAPI::ListMembersAddQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersAddQuery |
114
+
115
+ begin
116
+ # Add Profile to List
117
+ api_instance.create_list_relationships(id, related_resource, list_members_add_query)
118
+ rescue KlaviyoAPI::ApiError => e
119
+ puts "Error when calling ListsApi->create_list_relationships: #{e}"
120
+ end
121
+ ```
122
+
123
+ #### Using the create_list_relationships_with_http_info variant
124
+
125
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
126
+
127
+ > <Array(nil, Integer, Hash)> create_list_relationships_with_http_info(id, related_resource, list_members_add_query)
128
+
129
+ ```ruby
130
+ begin
131
+ # Add Profile to List
132
+ data, status_code, headers = api_instance.create_list_relationships_with_http_info(id, related_resource, list_members_add_query)
133
+ p status_code # => 2xx
134
+ p headers # => { ... }
135
+ p data # => nil
136
+ rescue KlaviyoAPI::ApiError => e
137
+ puts "Error when calling ListsApi->create_list_relationships_with_http_info: #{e}"
138
+ end
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ | Name | Type | Description | Notes |
144
+ | ---- | ---- | ----------- | ----- |
145
+ | **id** | **String** | | |
146
+ | **related_resource** | **String** | | |
147
+ | **list_members_add_query** | [**ListMembersAddQuery**](ListMembersAddQuery.md) | | |
148
+
149
+ ### Return type
150
+
151
+ nil (empty response body)
152
+
153
+ ### Authorization
154
+
155
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: application/json
160
+ - **Accept**: application/json
161
+
162
+
163
+ ## delete_list
164
+
165
+ > delete_list(id)
166
+
167
+ Delete List
168
+
169
+ Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
170
+
171
+ ### Examples
172
+
173
+ ```ruby
174
+ require 'time'
175
+ require 'klaviyo-api-sdk'
176
+ # setup authorization
177
+ KlaviyoAPI.configure do |config|
178
+ # Configure API key authorization: Klaviyo-API-Key
179
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
180
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
181
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
182
+ end
183
+
184
+ api_instance = KlaviyoAPI::ListsApi.new
185
+ id = 'id_example' # String |
186
+
187
+ begin
188
+ # Delete List
189
+ api_instance.delete_list(id)
190
+ rescue KlaviyoAPI::ApiError => e
191
+ puts "Error when calling ListsApi->delete_list: #{e}"
192
+ end
193
+ ```
194
+
195
+ #### Using the delete_list_with_http_info variant
196
+
197
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
198
+
199
+ > <Array(nil, Integer, Hash)> delete_list_with_http_info(id)
200
+
201
+ ```ruby
202
+ begin
203
+ # Delete List
204
+ data, status_code, headers = api_instance.delete_list_with_http_info(id)
205
+ p status_code # => 2xx
206
+ p headers # => { ... }
207
+ p data # => nil
208
+ rescue KlaviyoAPI::ApiError => e
209
+ puts "Error when calling ListsApi->delete_list_with_http_info: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
214
+
215
+ | Name | Type | Description | Notes |
216
+ | ---- | ---- | ----------- | ----- |
217
+ | **id** | **String** | | |
218
+
219
+ ### Return type
220
+
221
+ nil (empty response body)
222
+
223
+ ### Authorization
224
+
225
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
226
+
227
+ ### HTTP request headers
228
+
229
+ - **Content-Type**: Not defined
230
+ - **Accept**: application/json
231
+
232
+
233
+ ## delete_list_relationships
234
+
235
+ > delete_list_relationships(id, related_resource, list_members_delete_query)
236
+
237
+ Remove Profile from List
238
+
239
+ Remove a profile from a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write` `Profiles Write`
240
+
241
+ ### Examples
242
+
243
+ ```ruby
244
+ require 'time'
245
+ require 'klaviyo-api-sdk'
246
+ # setup authorization
247
+ KlaviyoAPI.configure do |config|
248
+ # Configure API key authorization: Klaviyo-API-Key
249
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
250
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
251
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
252
+ end
253
+
254
+ api_instance = KlaviyoAPI::ListsApi.new
255
+ id = 'id_example' # String |
256
+ related_resource = 'profiles' # String |
257
+ list_members_delete_query = KlaviyoAPI::ListMembersDeleteQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersDeleteQuery |
258
+
259
+ begin
260
+ # Remove Profile from List
261
+ api_instance.delete_list_relationships(id, related_resource, list_members_delete_query)
262
+ rescue KlaviyoAPI::ApiError => e
263
+ puts "Error when calling ListsApi->delete_list_relationships: #{e}"
264
+ end
265
+ ```
266
+
267
+ #### Using the delete_list_relationships_with_http_info variant
268
+
269
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
270
+
271
+ > <Array(nil, Integer, Hash)> delete_list_relationships_with_http_info(id, related_resource, list_members_delete_query)
272
+
273
+ ```ruby
274
+ begin
275
+ # Remove Profile from List
276
+ data, status_code, headers = api_instance.delete_list_relationships_with_http_info(id, related_resource, list_members_delete_query)
277
+ p status_code # => 2xx
278
+ p headers # => { ... }
279
+ p data # => nil
280
+ rescue KlaviyoAPI::ApiError => e
281
+ puts "Error when calling ListsApi->delete_list_relationships_with_http_info: #{e}"
282
+ end
283
+ ```
284
+
285
+ ### Parameters
286
+
287
+ | Name | Type | Description | Notes |
288
+ | ---- | ---- | ----------- | ----- |
289
+ | **id** | **String** | | |
290
+ | **related_resource** | **String** | | |
291
+ | **list_members_delete_query** | [**ListMembersDeleteQuery**](ListMembersDeleteQuery.md) | | |
292
+
293
+ ### Return type
294
+
295
+ nil (empty response body)
296
+
297
+ ### Authorization
298
+
299
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: application/json
304
+ - **Accept**: application/json
305
+
306
+
307
+ ## get_list
308
+
309
+ > Hash&lt;String, Object&gt; get_list(id, opts)
310
+
311
+ Get List
312
+
313
+ Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
314
+
315
+ ### Examples
316
+
317
+ ```ruby
318
+ require 'time'
319
+ require 'klaviyo-api-sdk'
320
+ # setup authorization
321
+ KlaviyoAPI.configure do |config|
322
+ # Configure API key authorization: Klaviyo-API-Key
323
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
324
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
325
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
326
+ end
327
+
328
+ api_instance = KlaviyoAPI::ListsApi.new
329
+ id = 'id_example' # String |
330
+ opts = {
331
+ fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
332
+ }
333
+
334
+ begin
335
+ # Get List
336
+ result = api_instance.get_list(id, opts)
337
+ p result
338
+ rescue KlaviyoAPI::ApiError => e
339
+ puts "Error when calling ListsApi->get_list: #{e}"
340
+ end
341
+ ```
342
+
343
+ #### Using the get_list_with_http_info variant
344
+
345
+ This returns an Array which contains the response data, status code and headers.
346
+
347
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_list_with_http_info(id, opts)
348
+
349
+ ```ruby
350
+ begin
351
+ # Get List
352
+ data, status_code, headers = api_instance.get_list_with_http_info(id, opts)
353
+ p status_code # => 2xx
354
+ p headers # => { ... }
355
+ p data # => Hash&lt;String, Object&gt;
356
+ rescue KlaviyoAPI::ApiError => e
357
+ puts "Error when calling ListsApi->get_list_with_http_info: #{e}"
358
+ end
359
+ ```
360
+
361
+ ### Parameters
362
+
363
+ | Name | Type | Description | Notes |
364
+ | ---- | ---- | ----------- | ----- |
365
+ | **id** | **String** | | |
366
+ | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
367
+
368
+ ### Return type
369
+
370
+ **Hash&lt;String, Object&gt;**
371
+
372
+ ### Authorization
373
+
374
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
375
+
376
+ ### HTTP request headers
377
+
378
+ - **Content-Type**: Not defined
379
+ - **Accept**: application/json
380
+
381
+
382
+ ## get_list_profiles
383
+
384
+ > Hash&lt;String, Object&gt; get_list_profiles(list_id, opts)
385
+
386
+ Get List Profiles
387
+
388
+ Get all profiles within a list with the given list ID. Use filters to narrow your results. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
389
+
390
+ ### Examples
391
+
392
+ ```ruby
393
+ require 'time'
394
+ require 'klaviyo-api-sdk'
395
+ # setup authorization
396
+ KlaviyoAPI.configure do |config|
397
+ # Configure API key authorization: Klaviyo-API-Key
398
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
399
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
400
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
401
+ end
402
+
403
+ api_instance = KlaviyoAPI::ListsApi.new
404
+ list_id = 'list_id_example' # String |
405
+ opts = {
406
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
407
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
408
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
409
+ }
410
+
411
+ begin
412
+ # Get List Profiles
413
+ result = api_instance.get_list_profiles(list_id, opts)
414
+ p result
415
+ rescue KlaviyoAPI::ApiError => e
416
+ puts "Error when calling ListsApi->get_list_profiles: #{e}"
417
+ end
418
+ ```
419
+
420
+ #### Using the get_list_profiles_with_http_info variant
421
+
422
+ This returns an Array which contains the response data, status code and headers.
423
+
424
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_list_profiles_with_http_info(list_id, opts)
425
+
426
+ ```ruby
427
+ begin
428
+ # Get List Profiles
429
+ data, status_code, headers = api_instance.get_list_profiles_with_http_info(list_id, opts)
430
+ p status_code # => 2xx
431
+ p headers # => { ... }
432
+ p data # => Hash&lt;String, Object&gt;
433
+ rescue KlaviyoAPI::ApiError => e
434
+ puts "Error when calling ListsApi->get_list_profiles_with_http_info: #{e}"
435
+ end
436
+ ```
437
+
438
+ ### Parameters
439
+
440
+ | Name | Type | Description | Notes |
441
+ | ---- | ---- | ----------- | ----- |
442
+ | **list_id** | **String** | | |
443
+ | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
444
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
445
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
446
+
447
+ ### Return type
448
+
449
+ **Hash&lt;String, Object&gt;**
450
+
451
+ ### Authorization
452
+
453
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
454
+
455
+ ### HTTP request headers
456
+
457
+ - **Content-Type**: Not defined
458
+ - **Accept**: application/json
459
+
460
+
461
+ ## get_list_relationships
462
+
463
+ > Hash&lt;String, Object&gt; get_list_relationships(id, related_resource, opts)
464
+
465
+ Get List Profile Relationships
466
+
467
+ Get profile membership [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a list with the given list ID. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read` `Profiles Read`
468
+
469
+ ### Examples
470
+
471
+ ```ruby
472
+ require 'time'
473
+ require 'klaviyo-api-sdk'
474
+ # setup authorization
475
+ KlaviyoAPI.configure do |config|
476
+ # Configure API key authorization: Klaviyo-API-Key
477
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
478
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
479
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
480
+ end
481
+
482
+ api_instance = KlaviyoAPI::ListsApi.new
483
+ id = 'id_example' # String |
484
+ related_resource = 'profiles' # String |
485
+ opts = {
486
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
487
+ }
488
+
489
+ begin
490
+ # Get List Profile Relationships
491
+ result = api_instance.get_list_relationships(id, related_resource, opts)
492
+ p result
493
+ rescue KlaviyoAPI::ApiError => e
494
+ puts "Error when calling ListsApi->get_list_relationships: #{e}"
495
+ end
496
+ ```
497
+
498
+ #### Using the get_list_relationships_with_http_info variant
499
+
500
+ This returns an Array which contains the response data, status code and headers.
501
+
502
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_list_relationships_with_http_info(id, related_resource, opts)
503
+
504
+ ```ruby
505
+ begin
506
+ # Get List Profile Relationships
507
+ data, status_code, headers = api_instance.get_list_relationships_with_http_info(id, related_resource, opts)
508
+ p status_code # => 2xx
509
+ p headers # => { ... }
510
+ p data # => Hash&lt;String, Object&gt;
511
+ rescue KlaviyoAPI::ApiError => e
512
+ puts "Error when calling ListsApi->get_list_relationships_with_http_info: #{e}"
513
+ end
514
+ ```
515
+
516
+ ### Parameters
517
+
518
+ | Name | Type | Description | Notes |
519
+ | ---- | ---- | ----------- | ----- |
520
+ | **id** | **String** | | |
521
+ | **related_resource** | **String** | | |
522
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
523
+
524
+ ### Return type
525
+
526
+ **Hash&lt;String, Object&gt;**
527
+
528
+ ### Authorization
529
+
530
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
531
+
532
+ ### HTTP request headers
533
+
534
+ - **Content-Type**: Not defined
535
+ - **Accept**: application/json
536
+
537
+
538
+ ## get_lists
539
+
540
+ > Hash&lt;String, Object&gt; get_lists(opts)
541
+
542
+ Get Lists
543
+
544
+ Get all lists in an account. Use filters to narrow your results. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Read`
545
+
546
+ ### Examples
547
+
548
+ ```ruby
549
+ require 'time'
550
+ require 'klaviyo-api-sdk'
551
+ # setup authorization
552
+ KlaviyoAPI.configure do |config|
553
+ # Configure API key authorization: Klaviyo-API-Key
554
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
555
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
556
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
557
+ end
558
+
559
+ api_instance = KlaviyoAPI::ListsApi.new
560
+ opts = {
561
+ fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
562
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
563
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
564
+ }
565
+
566
+ begin
567
+ # Get Lists
568
+ result = api_instance.get_lists(opts)
569
+ p result
570
+ rescue KlaviyoAPI::ApiError => e
571
+ puts "Error when calling ListsApi->get_lists: #{e}"
572
+ end
573
+ ```
574
+
575
+ #### Using the get_lists_with_http_info variant
576
+
577
+ This returns an Array which contains the response data, status code and headers.
578
+
579
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_lists_with_http_info(opts)
580
+
581
+ ```ruby
582
+ begin
583
+ # Get Lists
584
+ data, status_code, headers = api_instance.get_lists_with_http_info(opts)
585
+ p status_code # => 2xx
586
+ p headers # => { ... }
587
+ p data # => Hash&lt;String, Object&gt;
588
+ rescue KlaviyoAPI::ApiError => e
589
+ puts "Error when calling ListsApi->get_lists_with_http_info: #{e}"
590
+ end
591
+ ```
592
+
593
+ ### Parameters
594
+
595
+ | Name | Type | Description | Notes |
596
+ | ---- | ---- | ----------- | ----- |
597
+ | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
598
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
599
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
600
+
601
+ ### Return type
602
+
603
+ **Hash&lt;String, Object&gt;**
604
+
605
+ ### Authorization
606
+
607
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
608
+
609
+ ### HTTP request headers
610
+
611
+ - **Content-Type**: Not defined
612
+ - **Accept**: application/json
613
+
614
+
615
+ ## update_list
616
+
617
+ > Hash&lt;String, Object&gt; update_list(id, list_partial_update_query)
618
+
619
+ Update List
620
+
621
+ Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `List Write`
622
+
623
+ ### Examples
624
+
625
+ ```ruby
626
+ require 'time'
627
+ require 'klaviyo-api-sdk'
628
+ # setup authorization
629
+ KlaviyoAPI.configure do |config|
630
+ # Configure API key authorization: Klaviyo-API-Key
631
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
632
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
633
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
634
+ end
635
+
636
+ api_instance = KlaviyoAPI::ListsApi.new
637
+ id = 'id_example' # String |
638
+ list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new({type: 'list', id: 'id_example', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # ListPartialUpdateQuery |
639
+
640
+ begin
641
+ # Update List
642
+ result = api_instance.update_list(id, list_partial_update_query)
643
+ p result
644
+ rescue KlaviyoAPI::ApiError => e
645
+ puts "Error when calling ListsApi->update_list: #{e}"
646
+ end
647
+ ```
648
+
649
+ #### Using the update_list_with_http_info variant
650
+
651
+ This returns an Array which contains the response data, status code and headers.
652
+
653
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_list_with_http_info(id, list_partial_update_query)
654
+
655
+ ```ruby
656
+ begin
657
+ # Update List
658
+ data, status_code, headers = api_instance.update_list_with_http_info(id, list_partial_update_query)
659
+ p status_code # => 2xx
660
+ p headers # => { ... }
661
+ p data # => Hash&lt;String, Object&gt;
662
+ rescue KlaviyoAPI::ApiError => e
663
+ puts "Error when calling ListsApi->update_list_with_http_info: #{e}"
664
+ end
665
+ ```
666
+
667
+ ### Parameters
668
+
669
+ | Name | Type | Description | Notes |
670
+ | ---- | ---- | ----------- | ----- |
671
+ | **id** | **String** | | |
672
+ | **list_partial_update_query** | [**ListPartialUpdateQuery**](ListPartialUpdateQuery.md) | | |
673
+
674
+ ### Return type
675
+
676
+ **Hash&lt;String, Object&gt;**
677
+
678
+ ### Authorization
679
+
680
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
681
+
682
+ ### HTTP request headers
683
+
684
+ - **Content-Type**: application/json
685
+ - **Accept**: application/json
686
+
@@ -0,0 +1,18 @@
1
+ # KlaviyoAPI::MetricAggregateQuery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**MetricAggregateQueryAsSubResource**](MetricAggregateQueryAsSubResource.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ instance = KlaviyoAPI::MetricAggregateQuery.new(
15
+ data: null
16
+ )
17
+ ```
18
+