klaviyo-api-sdk 2.0.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (767) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +65 -0
  3. data/README.md +487 -230
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +89 -89
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +357 -357
  8. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  9. data/lib/klaviyo-api-sdk/api/events_api.rb +52 -52
  10. data/lib/klaviyo-api-sdk/api/flows_api.rb +210 -155
  11. data/lib/klaviyo-api-sdk/api/lists_api.rb +80 -72
  12. data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
  13. data/lib/klaviyo-api-sdk/api/profiles_api.rb +86 -92
  14. data/lib/klaviyo-api-sdk/api/segments_api.rb +68 -60
  15. data/lib/klaviyo-api-sdk/api/tags_api.rb +107 -107
  16. data/lib/klaviyo-api-sdk/api/templates_api.rb +32 -32
  17. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  18. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  19. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  20. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  21. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  22. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
  23. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
  24. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  25. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
  26. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +35 -35
  27. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  28. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  29. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +19 -19
  30. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +1 -1
  31. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  32. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
  34. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +14 -14
  35. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  36. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
  37. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
  38. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  39. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
  40. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
  41. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  42. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  43. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
  44. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
  45. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  46. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  47. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
  48. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  49. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  50. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  51. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  52. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  53. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
  54. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  56. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
  57. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +17 -17
  58. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
  60. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  62. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  64. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  65. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
  66. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  67. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  68. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
  69. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships.rb → catalog_category_update_query_resource_object_relationships.rb} +5 -5
  71. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items.rb → catalog_category_update_query_resource_object_relationships_items.rb} +5 -5
  72. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +4 -4
  73. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  76. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  77. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_resource_object_relationships_categories_data_inner.rb → catalog_item_category_op_data_inner.rb} +4 -4
  78. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  79. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
  80. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
  83. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +71 -71
  84. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  85. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
  86. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
  88. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
  93. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
  96. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
  97. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
  102. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
  105. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +114 -114
  106. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
  108. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
  113. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
  116. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +57 -57
  117. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +30 -30
  118. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
  120. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +15 -15
  121. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +19 -19
  124. data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +16 -16
  125. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  127. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
  129. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
  131. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
  132. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
  133. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
  135. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
  142. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
  145. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +67 -67
  146. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
  149. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
  150. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
  152. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +19 -19
  156. data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query_resource_object_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +48 -48
  157. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
  164. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
  167. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
  168. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/subscription.rb +15 -15
  170. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
  171. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +19 -19
  173. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +23 -23
  174. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
  177. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +19 -19
  182. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +15 -15
  183. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
  188. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
  189. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
  192. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
  193. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  194. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
  199. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
  202. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +17 -17
  203. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
  205. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +32 -32
  206. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
  209. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +17 -17
  210. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
  212. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -16
  213. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
  214. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +15 -15
  215. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
  216. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +19 -19
  217. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +18 -18
  218. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +19 -19
  220. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  222. data/lib/klaviyo-api-sdk/version.rb +1 -1
  223. data/lib/klaviyo-api-sdk.rb +10 -46
  224. metadata +16 -558
  225. data/Gemfile +0 -9
  226. data/Rakefile +0 -10
  227. data/docs/AudiencesSubObject.md +0 -20
  228. data/docs/CampaignCloneQuery.md +0 -18
  229. data/docs/CampaignCloneQueryResourceObject.md +0 -20
  230. data/docs/CampaignCloneQueryResourceObjectAttributes.md +0 -20
  231. data/docs/CampaignCreateQuery.md +0 -18
  232. data/docs/CampaignCreateQueryResourceObject.md +0 -20
  233. data/docs/CampaignCreateQueryResourceObjectAttributes.md +0 -28
  234. data/docs/CampaignEnum.md +0 -15
  235. data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
  236. data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +0 -20
  237. data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +0 -20
  238. data/docs/CampaignMessageEnum.md +0 -15
  239. data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
  240. data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +0 -22
  241. data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +0 -20
  242. data/docs/CampaignPartialUpdateQuery.md +0 -18
  243. data/docs/CampaignPartialUpdateQueryResourceObject.md +0 -22
  244. data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +0 -26
  245. data/docs/CampaignRecipientEstimationEnum.md +0 -15
  246. data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
  247. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +0 -20
  248. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +0 -18
  249. data/docs/CampaignRecipientEstimationJobEnum.md +0 -15
  250. data/docs/CampaignSendJobCreateQuery.md +0 -18
  251. data/docs/CampaignSendJobCreateQueryResourceObject.md +0 -20
  252. data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +0 -18
  253. data/docs/CampaignSendJobEnum.md +0 -15
  254. data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
  255. data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +0 -22
  256. data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +0 -18
  257. data/docs/CampaignsApi.md +0 -1275
  258. data/docs/CatalogCategoryBulkCreateJobEnum.md +0 -15
  259. data/docs/CatalogCategoryBulkDeleteJobEnum.md +0 -15
  260. data/docs/CatalogCategoryBulkUpdateJobEnum.md +0 -15
  261. data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
  262. data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +0 -20
  263. data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  264. data/docs/CatalogCategoryCreateQuery.md +0 -18
  265. data/docs/CatalogCategoryCreateQueryResourceObject.md +0 -22
  266. data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +0 -24
  267. data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
  268. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +0 -20
  269. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
  270. data/docs/CatalogCategoryDeleteQueryResourceObject.md +0 -20
  271. data/docs/CatalogCategoryEnum.md +0 -15
  272. data/docs/CatalogCategoryItemOp.md +0 -18
  273. data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
  274. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +0 -20
  275. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
  276. data/docs/CatalogCategoryUpdateQuery.md +0 -18
  277. data/docs/CatalogCategoryUpdateQueryResourceObject.md +0 -24
  278. data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +0 -18
  279. data/docs/CatalogItemBulkCreateJobEnum.md +0 -15
  280. data/docs/CatalogItemBulkDeleteJobEnum.md +0 -15
  281. data/docs/CatalogItemBulkUpdateJobEnum.md +0 -15
  282. data/docs/CatalogItemCategoryOp.md +0 -18
  283. data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
  284. data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +0 -20
  285. data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  286. data/docs/CatalogItemCreateQuery.md +0 -18
  287. data/docs/CatalogItemCreateQueryResourceObject.md +0 -22
  288. data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +0 -40
  289. data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +0 -18
  290. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +0 -18
  291. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +0 -20
  292. data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
  293. data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +0 -20
  294. data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
  295. data/docs/CatalogItemDeleteQueryResourceObject.md +0 -20
  296. data/docs/CatalogItemEnum.md +0 -15
  297. data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
  298. data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +0 -20
  299. data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
  300. data/docs/CatalogItemUpdateQuery.md +0 -18
  301. data/docs/CatalogItemUpdateQueryResourceObject.md +0 -24
  302. data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +0 -34
  303. data/docs/CatalogJobErrorPayload.md +0 -26
  304. data/docs/CatalogVariantBulkCreateJobEnum.md +0 -15
  305. data/docs/CatalogVariantBulkDeleteJobEnum.md +0 -15
  306. data/docs/CatalogVariantBulkUpdateJobEnum.md +0 -15
  307. data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
  308. data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +0 -20
  309. data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  310. data/docs/CatalogVariantCreateQuery.md +0 -18
  311. data/docs/CatalogVariantCreateQueryResourceObject.md +0 -22
  312. data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +0 -46
  313. data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +0 -18
  314. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +0 -18
  315. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +0 -20
  316. data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
  317. data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +0 -20
  318. data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +0 -18
  319. data/docs/CatalogVariantDeleteQueryResourceObject.md +0 -20
  320. data/docs/CatalogVariantEnum.md +0 -15
  321. data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
  322. data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +0 -20
  323. data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +0 -18
  324. data/docs/CatalogVariantUpdateQuery.md +0 -18
  325. data/docs/CatalogVariantUpdateQueryResourceObject.md +0 -22
  326. data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +0 -40
  327. data/docs/CatalogsApi.md +0 -4032
  328. data/docs/ClientApi.md +0 -205
  329. data/docs/CollectionLinks.md +0 -26
  330. data/docs/ContentSubObject.md +0 -28
  331. data/docs/DataPrivacyApi.md +0 -78
  332. data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
  333. data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +0 -20
  334. data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +0 -22
  335. data/docs/DataPrivacyDeletionJobEnum.md +0 -15
  336. data/docs/EmailChannel.md +0 -18
  337. data/docs/EmailMarketing.md +0 -32
  338. data/docs/EmailMarketingListSuppression.md +0 -22
  339. data/docs/EmailMarketingSuppression.md +0 -20
  340. data/docs/EmailMessageContent.md +0 -24
  341. data/docs/EmailTrackingOptions.md +0 -24
  342. data/docs/ErrorSource.md +0 -18
  343. data/docs/EventCreateQuery.md +0 -18
  344. data/docs/EventCreateQueryResourceObject.md +0 -20
  345. data/docs/EventCreateQueryResourceObjectAttributes.md +0 -28
  346. data/docs/EventEnum.md +0 -15
  347. data/docs/EventsApi.md +0 -544
  348. data/docs/FlowActionEnum.md +0 -15
  349. data/docs/FlowEnum.md +0 -15
  350. data/docs/FlowMessageEnum.md +0 -15
  351. data/docs/FlowUpdateQuery.md +0 -18
  352. data/docs/FlowUpdateQueryResourceObject.md +0 -22
  353. data/docs/FlowUpdateQueryResourceObjectAttributes.md +0 -18
  354. data/docs/FlowsApi.md +0 -1173
  355. data/docs/GetCampaigns4XXResponse.md +0 -18
  356. data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
  357. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
  358. data/docs/ListCreateQuery.md +0 -18
  359. data/docs/ListCreateQueryResourceObject.md +0 -20
  360. data/docs/ListCreateQueryResourceObjectAttributes.md +0 -18
  361. data/docs/ListEnum.md +0 -15
  362. data/docs/ListMembersAddQuery.md +0 -18
  363. data/docs/ListMembersAddQueryDataInner.md +0 -20
  364. data/docs/ListMembersDeleteQuery.md +0 -18
  365. data/docs/ListPartialUpdateQuery.md +0 -18
  366. data/docs/ListPartialUpdateQueryResourceObject.md +0 -22
  367. data/docs/ListsApi.md +0 -832
  368. data/docs/MetricAggregateEnum.md +0 -15
  369. data/docs/MetricAggregateQuery.md +0 -18
  370. data/docs/MetricAggregateQueryResourceObject.md +0 -20
  371. data/docs/MetricAggregateQueryResourceObjectAttributes.md +0 -36
  372. data/docs/MetricAggregateRowDTO.md +0 -20
  373. data/docs/MetricCreateQuery.md +0 -20
  374. data/docs/MetricEnum.md +0 -15
  375. data/docs/MetricsApi.md +0 -233
  376. data/docs/ObjectLinks.md +0 -18
  377. data/docs/OnsiteProfileCreateQuery.md +0 -18
  378. data/docs/OnsiteProfileCreateQueryResourceObject.md +0 -22
  379. data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +0 -38
  380. data/docs/OnsiteProfileMeta.md +0 -18
  381. data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
  382. data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
  383. data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +0 -20
  384. data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +0 -26
  385. data/docs/PredictiveAnalytics.md +0 -34
  386. data/docs/ProfileAggregateEnum.md +0 -15
  387. data/docs/ProfileCreateQuery.md +0 -18
  388. data/docs/ProfileCreateQueryResourceObject.md +0 -20
  389. data/docs/ProfileCreateQueryResourceObjectAttributes.md +0 -36
  390. data/docs/ProfileEnum.md +0 -15
  391. data/docs/ProfileLocation.md +0 -34
  392. data/docs/ProfileLocationLatitude.md +0 -49
  393. data/docs/ProfileLocationLongitude.md +0 -49
  394. data/docs/ProfilePartialUpdateQuery.md +0 -18
  395. data/docs/ProfilePartialUpdateQueryResourceObject.md +0 -22
  396. data/docs/ProfileSubscriptionBulkCreateJobEnum.md +0 -15
  397. data/docs/ProfileSuppressionBulkCreateJobEnum.md +0 -15
  398. data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +0 -15
  399. data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +0 -15
  400. data/docs/ProfilesApi.md +0 -909
  401. data/docs/SMSChannel.md +0 -18
  402. data/docs/SMSMarketing.md +0 -24
  403. data/docs/SMSMessageContent.md +0 -20
  404. data/docs/SMSRenderOptions.md +0 -24
  405. data/docs/SMSTrackingOptions.md +0 -20
  406. data/docs/STOScheduleOptions.md +0 -18
  407. data/docs/SegmentEnum.md +0 -15
  408. data/docs/SegmentPartialUpdateQuery.md +0 -18
  409. data/docs/SegmentPartialUpdateQueryResourceObject.md +0 -22
  410. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +0 -18
  411. data/docs/SegmentsApi.md +0 -543
  412. data/docs/SendOptions.md +0 -20
  413. data/docs/SendOptionsSubObject.md +0 -18
  414. data/docs/SendStrategySubObject.md +0 -24
  415. data/docs/SendTimeSubObject.md +0 -20
  416. data/docs/StaticScheduleOptions.md +0 -22
  417. data/docs/Subscription.md +0 -24
  418. data/docs/SubscriptionChannels.md +0 -20
  419. data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
  420. data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +0 -20
  421. data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
  422. data/docs/SubscriptionEnum.md +0 -15
  423. data/docs/Subscriptions.md +0 -20
  424. data/docs/Suppression.md +0 -18
  425. data/docs/SuppressionCreateJobCreateQuery.md +0 -18
  426. data/docs/SuppressionCreateJobCreateQueryResourceObject.md +0 -20
  427. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  428. data/docs/TagCampaignOp.md +0 -18
  429. data/docs/TagCampaignOpDataInner.md +0 -20
  430. data/docs/TagCreateQuery.md +0 -18
  431. data/docs/TagCreateQueryResourceObject.md +0 -20
  432. data/docs/TagCreateQueryResourceObjectAttributes.md +0 -20
  433. data/docs/TagEnum.md +0 -15
  434. data/docs/TagFlowOp.md +0 -18
  435. data/docs/TagFlowOpDataInner.md +0 -20
  436. data/docs/TagGroupCreateQuery.md +0 -18
  437. data/docs/TagGroupCreateQueryResourceObject.md +0 -20
  438. data/docs/TagGroupCreateQueryResourceObjectAttributes.md +0 -20
  439. data/docs/TagGroupEnum.md +0 -15
  440. data/docs/TagGroupUpdateQuery.md +0 -18
  441. data/docs/TagGroupUpdateQueryResourceObject.md +0 -22
  442. data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +0 -20
  443. data/docs/TagListOp.md +0 -18
  444. data/docs/TagListOpDataInner.md +0 -20
  445. data/docs/TagSegmentOp.md +0 -18
  446. data/docs/TagSegmentOpDataInner.md +0 -20
  447. data/docs/TagUpdateQuery.md +0 -18
  448. data/docs/TagUpdateQueryResourceObject.md +0 -22
  449. data/docs/TagUpdateQueryResourceObjectAttributes.md +0 -18
  450. data/docs/TagsApi.md +0 -1923
  451. data/docs/TemplateCloneQuery.md +0 -18
  452. data/docs/TemplateCloneQueryResourceObject.md +0 -20
  453. data/docs/TemplateCloneQueryResourceObjectAttributes.md +0 -22
  454. data/docs/TemplateCreateQuery.md +0 -18
  455. data/docs/TemplateCreateQueryResourceObject.md +0 -20
  456. data/docs/TemplateCreateQueryResourceObjectAttributes.md +0 -32
  457. data/docs/TemplateEnum.md +0 -15
  458. data/docs/TemplateRenderQuery.md +0 -18
  459. data/docs/TemplateRenderQueryResourceObject.md +0 -20
  460. data/docs/TemplateRenderQueryResourceObjectAttributes.md +0 -22
  461. data/docs/TemplateUpdateQuery.md +0 -18
  462. data/docs/TemplateUpdateQueryResourceObject.md +0 -22
  463. data/docs/TemplateUpdateQueryResourceObjectAttributes.md +0 -30
  464. data/docs/TemplatesApi.md +0 -525
  465. data/docs/TestApiAnalyticsSampleEnum.md +0 -15
  466. data/docs/TestListEnum.md +0 -15
  467. data/docs/ThrottledScheduleOptions.md +0 -20
  468. data/docs/TrackingOptionsSubObject.md +0 -24
  469. data/docs/UTMParamsSubObject.md +0 -20
  470. data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
  471. data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +0 -20
  472. data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +0 -22
  473. data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
  474. data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +0 -20
  475. data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +0 -18
  476. data/docs/UtmParamInfo.md +0 -20
  477. data/git_push.sh +0 -57
  478. data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
  479. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +0 -36
  480. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
  481. data/lib/klaviyo-api-sdk/models/collection_links.rb +0 -260
  482. data/lib/klaviyo-api-sdk/models/email_channel.rb +0 -219
  483. data/lib/klaviyo-api-sdk/models/email_marketing.rb +0 -298
  484. data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +0 -255
  485. data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +0 -240
  486. data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
  487. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
  488. data/lib/klaviyo-api-sdk/models/error_source.rb +0 -227
  489. data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +0 -36
  490. data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +0 -36
  491. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
  492. data/lib/klaviyo-api-sdk/models/metric_enum.rb +0 -36
  493. data/lib/klaviyo-api-sdk/models/object_links.rb +0 -224
  494. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +0 -224
  495. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +0 -247
  496. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -224
  497. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +0 -269
  498. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +0 -224
  499. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +0 -238
  500. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +0 -265
  501. data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +0 -300
  502. data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +0 -36
  503. data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
  504. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
  505. data/lib/klaviyo-api-sdk/models/sms_channel.rb +0 -219
  506. data/lib/klaviyo-api-sdk/models/sms_marketing.rb +0 -270
  507. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +0 -238
  508. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +0 -266
  509. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +0 -240
  510. data/lib/klaviyo-api-sdk/models/subscription_enum.rb +0 -36
  511. data/lib/klaviyo-api-sdk/models/subscriptions.rb +0 -228
  512. data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +0 -36
  513. data/lib/klaviyo-api-sdk/models/test_list_enum.rb +0 -36
  514. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +0 -238
  515. data/spec/api/campaigns_api_spec.rb +0 -255
  516. data/spec/api/catalogs_api_spec.rb +0 -751
  517. data/spec/api/client_api_spec.rb +0 -74
  518. data/spec/api/data_privacy_api_spec.rb +0 -47
  519. data/spec/api/events_api_spec.rb +0 -132
  520. data/spec/api/flows_api_spec.rb +0 -247
  521. data/spec/api/lists_api_spec.rb +0 -180
  522. data/spec/api/metrics_api_spec.rb +0 -74
  523. data/spec/api/profiles_api_spec.rb +0 -194
  524. data/spec/api/segments_api_spec.rb +0 -130
  525. data/spec/api/tags_api_spec.rb +0 -367
  526. data/spec/api/templates_api_spec.rb +0 -124
  527. data/spec/api_client_spec.rb +0 -226
  528. data/spec/configuration_spec.rb +0 -42
  529. data/spec/models/audiences_sub_object_spec.rb +0 -40
  530. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +0 -40
  531. data/spec/models/campaign_clone_query_resource_object_spec.rb +0 -40
  532. data/spec/models/campaign_clone_query_spec.rb +0 -34
  533. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +0 -64
  534. data/spec/models/campaign_create_query_resource_object_spec.rb +0 -40
  535. data/spec/models/campaign_create_query_spec.rb +0 -34
  536. data/spec/models/campaign_enum_spec.rb +0 -28
  537. data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +0 -40
  538. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +0 -40
  539. data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
  540. data/spec/models/campaign_message_enum_spec.rb +0 -28
  541. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +0 -40
  542. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +0 -46
  543. data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
  544. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +0 -58
  545. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +0 -46
  546. data/spec/models/campaign_partial_update_query_spec.rb +0 -34
  547. data/spec/models/campaign_recipient_estimation_enum_spec.rb +0 -28
  548. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +0 -34
  549. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +0 -40
  550. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
  551. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +0 -28
  552. data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +0 -34
  553. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +0 -40
  554. data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
  555. data/spec/models/campaign_send_job_enum_spec.rb +0 -28
  556. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +0 -34
  557. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +0 -46
  558. data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
  559. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +0 -28
  560. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +0 -28
  561. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +0 -28
  562. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  563. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +0 -40
  564. data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
  565. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +0 -56
  566. data/spec/models/catalog_category_create_query_resource_object_spec.rb +0 -46
  567. data/spec/models/catalog_category_create_query_spec.rb +0 -34
  568. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
  569. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +0 -40
  570. data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
  571. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +0 -40
  572. data/spec/models/catalog_category_enum_spec.rb +0 -28
  573. data/spec/models/catalog_category_item_op_spec.rb +0 -34
  574. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +0 -34
  575. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +0 -40
  576. data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
  577. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +0 -34
  578. data/spec/models/catalog_category_update_query_resource_object_spec.rb +0 -52
  579. data/spec/models/catalog_category_update_query_spec.rb +0 -34
  580. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +0 -28
  581. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +0 -28
  582. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +0 -28
  583. data/spec/models/catalog_item_category_op_spec.rb +0 -34
  584. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  585. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +0 -40
  586. data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
  587. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +0 -104
  588. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +0 -44
  589. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +0 -34
  590. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +0 -34
  591. data/spec/models/catalog_item_create_query_resource_object_spec.rb +0 -46
  592. data/spec/models/catalog_item_create_query_spec.rb +0 -34
  593. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
  594. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +0 -40
  595. data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
  596. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +0 -40
  597. data/spec/models/catalog_item_enum_spec.rb +0 -28
  598. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +0 -34
  599. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +0 -40
  600. data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
  601. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +0 -82
  602. data/spec/models/catalog_item_update_query_resource_object_spec.rb +0 -52
  603. data/spec/models/catalog_item_update_query_spec.rb +0 -34
  604. data/spec/models/catalog_job_error_payload_spec.rb +0 -58
  605. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +0 -28
  606. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +0 -28
  607. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +0 -28
  608. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  609. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +0 -40
  610. data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
  611. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +0 -126
  612. data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +0 -44
  613. data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +0 -34
  614. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +0 -34
  615. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +0 -46
  616. data/spec/models/catalog_variant_create_query_spec.rb +0 -34
  617. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +0 -34
  618. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +0 -40
  619. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
  620. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +0 -40
  621. data/spec/models/catalog_variant_enum_spec.rb +0 -28
  622. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +0 -34
  623. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +0 -40
  624. data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
  625. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +0 -104
  626. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +0 -46
  627. data/spec/models/catalog_variant_update_query_spec.rb +0 -34
  628. data/spec/models/collection_links_spec.rb +0 -58
  629. data/spec/models/content_sub_object_spec.rb +0 -64
  630. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +0 -46
  631. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +0 -40
  632. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
  633. data/spec/models/data_privacy_deletion_job_enum_spec.rb +0 -28
  634. data/spec/models/email_channel_spec.rb +0 -34
  635. data/spec/models/email_marketing_list_suppression_spec.rb +0 -46
  636. data/spec/models/email_marketing_spec.rb +0 -76
  637. data/spec/models/email_marketing_suppression_spec.rb +0 -40
  638. data/spec/models/email_message_content_spec.rb +0 -52
  639. data/spec/models/email_tracking_options_spec.rb +0 -52
  640. data/spec/models/error_source_spec.rb +0 -34
  641. data/spec/models/event_create_query_resource_object_attributes_spec.rb +0 -64
  642. data/spec/models/event_create_query_resource_object_spec.rb +0 -40
  643. data/spec/models/event_create_query_spec.rb +0 -34
  644. data/spec/models/event_enum_spec.rb +0 -28
  645. data/spec/models/flow_action_enum_spec.rb +0 -28
  646. data/spec/models/flow_enum_spec.rb +0 -28
  647. data/spec/models/flow_message_enum_spec.rb +0 -28
  648. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +0 -34
  649. data/spec/models/flow_update_query_resource_object_spec.rb +0 -46
  650. data/spec/models/flow_update_query_spec.rb +0 -34
  651. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
  652. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
  653. data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
  654. data/spec/models/list_create_query_resource_object_attributes_spec.rb +0 -34
  655. data/spec/models/list_create_query_resource_object_spec.rb +0 -40
  656. data/spec/models/list_create_query_spec.rb +0 -34
  657. data/spec/models/list_enum_spec.rb +0 -28
  658. data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
  659. data/spec/models/list_members_add_query_spec.rb +0 -34
  660. data/spec/models/list_members_delete_query_spec.rb +0 -34
  661. data/spec/models/list_partial_update_query_resource_object_spec.rb +0 -46
  662. data/spec/models/list_partial_update_query_spec.rb +0 -34
  663. data/spec/models/metric_aggregate_enum_spec.rb +0 -28
  664. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +0 -104
  665. data/spec/models/metric_aggregate_query_resource_object_spec.rb +0 -40
  666. data/spec/models/metric_aggregate_query_spec.rb +0 -34
  667. data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
  668. data/spec/models/metric_create_query_spec.rb +0 -40
  669. data/spec/models/metric_enum_spec.rb +0 -28
  670. data/spec/models/object_links_spec.rb +0 -34
  671. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +0 -94
  672. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +0 -46
  673. data/spec/models/onsite_profile_create_query_spec.rb +0 -34
  674. data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
  675. data/spec/models/onsite_profile_meta_spec.rb +0 -34
  676. data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +0 -58
  677. data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +0 -40
  678. data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
  679. data/spec/models/predictive_analytics_spec.rb +0 -82
  680. data/spec/models/profile_aggregate_enum_spec.rb +0 -28
  681. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +0 -88
  682. data/spec/models/profile_create_query_resource_object_spec.rb +0 -40
  683. data/spec/models/profile_create_query_spec.rb +0 -34
  684. data/spec/models/profile_enum_spec.rb +0 -28
  685. data/spec/models/profile_location_latitude_spec.rb +0 -31
  686. data/spec/models/profile_location_longitude_spec.rb +0 -31
  687. data/spec/models/profile_location_spec.rb +0 -82
  688. data/spec/models/profile_partial_update_query_resource_object_spec.rb +0 -46
  689. data/spec/models/profile_partial_update_query_spec.rb +0 -34
  690. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +0 -28
  691. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +0 -28
  692. data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +0 -28
  693. data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +0 -28
  694. data/spec/models/segment_enum_spec.rb +0 -28
  695. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +0 -34
  696. data/spec/models/segment_partial_update_query_resource_object_spec.rb +0 -46
  697. data/spec/models/segment_partial_update_query_spec.rb +0 -34
  698. data/spec/models/send_options_spec.rb +0 -40
  699. data/spec/models/send_options_sub_object_spec.rb +0 -34
  700. data/spec/models/send_strategy_sub_object_spec.rb +0 -52
  701. data/spec/models/send_time_sub_object_spec.rb +0 -40
  702. data/spec/models/sms_channel_spec.rb +0 -34
  703. data/spec/models/sms_marketing_spec.rb +0 -52
  704. data/spec/models/sms_message_content_spec.rb +0 -40
  705. data/spec/models/sms_render_options_spec.rb +0 -52
  706. data/spec/models/sms_tracking_options_spec.rb +0 -40
  707. data/spec/models/static_schedule_options_spec.rb +0 -46
  708. data/spec/models/sto_schedule_options_spec.rb +0 -34
  709. data/spec/models/subscription_channels_spec.rb +0 -48
  710. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
  711. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +0 -40
  712. data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
  713. data/spec/models/subscription_enum_spec.rb +0 -28
  714. data/spec/models/subscription_spec.rb +0 -52
  715. data/spec/models/subscriptions_spec.rb +0 -40
  716. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  717. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +0 -40
  718. data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
  719. data/spec/models/suppression_spec.rb +0 -34
  720. data/spec/models/tag_campaign_op_data_inner_spec.rb +0 -44
  721. data/spec/models/tag_campaign_op_spec.rb +0 -34
  722. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +0 -40
  723. data/spec/models/tag_create_query_resource_object_spec.rb +0 -40
  724. data/spec/models/tag_create_query_spec.rb +0 -34
  725. data/spec/models/tag_enum_spec.rb +0 -28
  726. data/spec/models/tag_flow_op_data_inner_spec.rb +0 -44
  727. data/spec/models/tag_flow_op_spec.rb +0 -34
  728. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +0 -40
  729. data/spec/models/tag_group_create_query_resource_object_spec.rb +0 -40
  730. data/spec/models/tag_group_create_query_spec.rb +0 -34
  731. data/spec/models/tag_group_enum_spec.rb +0 -28
  732. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +0 -40
  733. data/spec/models/tag_group_update_query_resource_object_spec.rb +0 -46
  734. data/spec/models/tag_group_update_query_spec.rb +0 -34
  735. data/spec/models/tag_list_op_data_inner_spec.rb +0 -44
  736. data/spec/models/tag_list_op_spec.rb +0 -34
  737. data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
  738. data/spec/models/tag_segment_op_spec.rb +0 -34
  739. data/spec/models/tag_update_query_resource_object_attributes_spec.rb +0 -34
  740. data/spec/models/tag_update_query_resource_object_spec.rb +0 -46
  741. data/spec/models/tag_update_query_spec.rb +0 -34
  742. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +0 -46
  743. data/spec/models/template_clone_query_resource_object_spec.rb +0 -40
  744. data/spec/models/template_clone_query_spec.rb +0 -34
  745. data/spec/models/template_create_query_resource_object_attributes_spec.rb +0 -58
  746. data/spec/models/template_create_query_resource_object_spec.rb +0 -40
  747. data/spec/models/template_create_query_spec.rb +0 -34
  748. data/spec/models/template_enum_spec.rb +0 -28
  749. data/spec/models/template_render_query_resource_object_attributes_spec.rb +0 -46
  750. data/spec/models/template_render_query_resource_object_spec.rb +0 -40
  751. data/spec/models/template_render_query_spec.rb +0 -34
  752. data/spec/models/template_update_query_resource_object_attributes_spec.rb +0 -52
  753. data/spec/models/template_update_query_resource_object_spec.rb +0 -46
  754. data/spec/models/template_update_query_spec.rb +0 -34
  755. data/spec/models/test_api_analytics_sample_enum_spec.rb +0 -28
  756. data/spec/models/test_list_enum_spec.rb +0 -28
  757. data/spec/models/throttled_schedule_options_spec.rb +0 -40
  758. data/spec/models/tracking_options_sub_object_spec.rb +0 -52
  759. data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +0 -46
  760. data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +0 -40
  761. data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
  762. data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +0 -34
  763. data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +0 -40
  764. data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
  765. data/spec/models/utm_param_info_spec.rb +0 -40
  766. data/spec/models/utm_params_sub_object_spec.rb +0 -40
  767. data/spec/spec_helper.rb +0 -111
data/docs/FlowsApi.md DELETED
@@ -1,1173 +0,0 @@
1
- # KlaviyoAPI::FlowsApi
2
-
3
- All URIs are relative to *https://a.klaviyo.com*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_flow**](FlowsApi.md#get_flow) | **GET** /api/flows/{id}/ | Get Flow |
8
- | [**get_flow_action**](FlowsApi.md#get_flow_action) | **GET** /api/flow-actions/{id}/ | Get Flow Action |
9
- | [**get_flow_action_flow**](FlowsApi.md#get_flow_action_flow) | **GET** /api/flow-actions/{action_id}/flow/ | Get Flow For Flow Action |
10
- | [**get_flow_action_messages**](FlowsApi.md#get_flow_action_messages) | **GET** /api/flow-actions/{action_id}/flow-messages/ | Get Messages For Flow Action |
11
- | [**get_flow_action_relationships_flow**](FlowsApi.md#get_flow_action_relationships_flow) | **GET** /api/flow-actions/{id}/relationships/flow/ | Get Flow Action Relationships Flow |
12
- | [**get_flow_action_relationships_messages**](FlowsApi.md#get_flow_action_relationships_messages) | **GET** /api/flow-actions/{id}/relationships/flow-messages/ | Get Flow Action Relationships Messages |
13
- | [**get_flow_flow_actions**](FlowsApi.md#get_flow_flow_actions) | **GET** /api/flows/{flow_id}/flow-actions/ | Get Flow Actions For Flow |
14
- | [**get_flow_message**](FlowsApi.md#get_flow_message) | **GET** /api/flow-messages/{id}/ | Get Flow Message |
15
- | [**get_flow_message_action**](FlowsApi.md#get_flow_message_action) | **GET** /api/flow-messages/{message_id}/flow-action/ | Get Flow Action For Message |
16
- | [**get_flow_message_relationships_action**](FlowsApi.md#get_flow_message_relationships_action) | **GET** /api/flow-messages/{id}/relationships/flow-action/ | Get Flow Message Relationships Action |
17
- | [**get_flow_relationships_flow_actions**](FlowsApi.md#get_flow_relationships_flow_actions) | **GET** /api/flows/{id}/relationships/flow-actions/ | Get Flow Relationships Flow Actions |
18
- | [**get_flow_relationships_tags**](FlowsApi.md#get_flow_relationships_tags) | **GET** /api/flows/{id}/relationships/tags/ | Get Flow Relationships Tags |
19
- | [**get_flow_tags**](FlowsApi.md#get_flow_tags) | **GET** /api/flows/{flow_id}/tags/ | Get Flow Tags |
20
- | [**get_flows**](FlowsApi.md#get_flows) | **GET** /api/flows/ | Get Flows |
21
- | [**update_flow**](FlowsApi.md#update_flow) | **PATCH** /api/flows/{id}/ | Update Flow Status |
22
-
23
-
24
- ## get_flow
25
-
26
- > Hash<String, Object> get_flow(id, opts)
27
-
28
- Get Flow
29
-
30
- Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
31
-
32
- ### Examples
33
-
34
- ```ruby
35
- require 'time'
36
- require 'klaviyo-api-sdk'
37
- # setup authorization
38
- KlaviyoAPI.configure do |config|
39
- # Configure API key authorization: Klaviyo-API-Key
40
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
41
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
42
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
43
- end
44
-
45
- api_instance = KlaviyoAPI::FlowsApi.new
46
- id = 'id_example' # String |
47
- opts = {
48
- fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
49
- fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
50
- include: ['flow-actions'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
51
- }
52
-
53
- begin
54
- # Get Flow
55
- result = api_instance.get_flow(id, opts)
56
- p result
57
- rescue KlaviyoAPI::ApiError => e
58
- puts "Error when calling FlowsApi->get_flow: #{e}"
59
- end
60
- ```
61
-
62
- #### Using the get_flow_with_http_info variant
63
-
64
- This returns an Array which contains the response data, status code and headers.
65
-
66
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_with_http_info(id, opts)
67
-
68
- ```ruby
69
- begin
70
- # Get Flow
71
- data, status_code, headers = api_instance.get_flow_with_http_info(id, opts)
72
- p status_code # => 2xx
73
- p headers # => { ... }
74
- p data # => Hash&lt;String, Object&gt;
75
- rescue KlaviyoAPI::ApiError => e
76
- puts "Error when calling FlowsApi->get_flow_with_http_info: #{e}"
77
- end
78
- ```
79
-
80
- ### Parameters
81
-
82
- | Name | Type | Description | Notes |
83
- | ---- | ---- | ----------- | ----- |
84
- | **id** | **String** | | |
85
- | **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
86
- | **fields_flow** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
87
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
88
-
89
- ### Return type
90
-
91
- **Hash&lt;String, Object&gt;**
92
-
93
- ### Authorization
94
-
95
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
96
-
97
- ### HTTP request headers
98
-
99
- - **Content-Type**: Not defined
100
- - **Accept**: application/json
101
-
102
-
103
- ## get_flow_action
104
-
105
- > Hash&lt;String, Object&gt; get_flow_action(id, opts)
106
-
107
- Get Flow Action
108
-
109
- Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
110
-
111
- ### Examples
112
-
113
- ```ruby
114
- require 'time'
115
- require 'klaviyo-api-sdk'
116
- # setup authorization
117
- KlaviyoAPI.configure do |config|
118
- # Configure API key authorization: Klaviyo-API-Key
119
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
120
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
121
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
122
- end
123
-
124
- api_instance = KlaviyoAPI::FlowsApi.new
125
- id = 'id_example' # String |
126
- opts = {
127
- fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
128
- fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
129
- fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
130
- include: ['flow-messages'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
131
- }
132
-
133
- begin
134
- # Get Flow Action
135
- result = api_instance.get_flow_action(id, opts)
136
- p result
137
- rescue KlaviyoAPI::ApiError => e
138
- puts "Error when calling FlowsApi->get_flow_action: #{e}"
139
- end
140
- ```
141
-
142
- #### Using the get_flow_action_with_http_info variant
143
-
144
- This returns an Array which contains the response data, status code and headers.
145
-
146
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_action_with_http_info(id, opts)
147
-
148
- ```ruby
149
- begin
150
- # Get Flow Action
151
- data, status_code, headers = api_instance.get_flow_action_with_http_info(id, opts)
152
- p status_code # => 2xx
153
- p headers # => { ... }
154
- p data # => Hash&lt;String, Object&gt;
155
- rescue KlaviyoAPI::ApiError => e
156
- puts "Error when calling FlowsApi->get_flow_action_with_http_info: #{e}"
157
- end
158
- ```
159
-
160
- ### Parameters
161
-
162
- | Name | Type | Description | Notes |
163
- | ---- | ---- | ----------- | ----- |
164
- | **id** | **String** | | |
165
- | **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
166
- | **fields_flow_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
167
- | **fields_flow** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
168
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
169
-
170
- ### Return type
171
-
172
- **Hash&lt;String, Object&gt;**
173
-
174
- ### Authorization
175
-
176
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
177
-
178
- ### HTTP request headers
179
-
180
- - **Content-Type**: Not defined
181
- - **Accept**: application/json
182
-
183
-
184
- ## get_flow_action_flow
185
-
186
- > Hash&lt;String, Object&gt; get_flow_action_flow(action_id, opts)
187
-
188
- Get Flow For Flow Action
189
-
190
- Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
191
-
192
- ### Examples
193
-
194
- ```ruby
195
- require 'time'
196
- require 'klaviyo-api-sdk'
197
- # setup authorization
198
- KlaviyoAPI.configure do |config|
199
- # Configure API key authorization: Klaviyo-API-Key
200
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
201
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
202
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
203
- end
204
-
205
- api_instance = KlaviyoAPI::FlowsApi.new
206
- action_id = 'action_id_example' # String |
207
- opts = {
208
- fields_flow: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
209
- }
210
-
211
- begin
212
- # Get Flow For Flow Action
213
- result = api_instance.get_flow_action_flow(action_id, opts)
214
- p result
215
- rescue KlaviyoAPI::ApiError => e
216
- puts "Error when calling FlowsApi->get_flow_action_flow: #{e}"
217
- end
218
- ```
219
-
220
- #### Using the get_flow_action_flow_with_http_info variant
221
-
222
- This returns an Array which contains the response data, status code and headers.
223
-
224
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_action_flow_with_http_info(action_id, opts)
225
-
226
- ```ruby
227
- begin
228
- # Get Flow For Flow Action
229
- data, status_code, headers = api_instance.get_flow_action_flow_with_http_info(action_id, opts)
230
- p status_code # => 2xx
231
- p headers # => { ... }
232
- p data # => Hash&lt;String, Object&gt;
233
- rescue KlaviyoAPI::ApiError => e
234
- puts "Error when calling FlowsApi->get_flow_action_flow_with_http_info: #{e}"
235
- end
236
- ```
237
-
238
- ### Parameters
239
-
240
- | Name | Type | Description | Notes |
241
- | ---- | ---- | ----------- | ----- |
242
- | **action_id** | **String** | | |
243
- | **fields_flow** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
244
-
245
- ### Return type
246
-
247
- **Hash&lt;String, Object&gt;**
248
-
249
- ### Authorization
250
-
251
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
252
-
253
- ### HTTP request headers
254
-
255
- - **Content-Type**: Not defined
256
- - **Accept**: application/json
257
-
258
-
259
- ## get_flow_action_messages
260
-
261
- > Hash&lt;String, Object&gt; get_flow_action_messages(action_id, opts)
262
-
263
- Get Messages For Flow Action
264
-
265
- Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
266
-
267
- ### Examples
268
-
269
- ```ruby
270
- require 'time'
271
- require 'klaviyo-api-sdk'
272
- # setup authorization
273
- KlaviyoAPI.configure do |config|
274
- # Configure API key authorization: Klaviyo-API-Key
275
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
276
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
277
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
278
- end
279
-
280
- api_instance = KlaviyoAPI::FlowsApi.new
281
- action_id = 'action_id_example' # String |
282
- opts = {
283
- fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
284
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<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`
285
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
286
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
287
- }
288
-
289
- begin
290
- # Get Messages For Flow Action
291
- result = api_instance.get_flow_action_messages(action_id, opts)
292
- p result
293
- rescue KlaviyoAPI::ApiError => e
294
- puts "Error when calling FlowsApi->get_flow_action_messages: #{e}"
295
- end
296
- ```
297
-
298
- #### Using the get_flow_action_messages_with_http_info variant
299
-
300
- This returns an Array which contains the response data, status code and headers.
301
-
302
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_action_messages_with_http_info(action_id, opts)
303
-
304
- ```ruby
305
- begin
306
- # Get Messages For Flow Action
307
- data, status_code, headers = api_instance.get_flow_action_messages_with_http_info(action_id, opts)
308
- p status_code # => 2xx
309
- p headers # => { ... }
310
- p data # => Hash&lt;String, Object&gt;
311
- rescue KlaviyoAPI::ApiError => e
312
- puts "Error when calling FlowsApi->get_flow_action_messages_with_http_info: #{e}"
313
- end
314
- ```
315
-
316
- ### Parameters
317
-
318
- | Name | Type | Description | Notes |
319
- | ---- | ---- | ----------- | ----- |
320
- | **action_id** | **String** | | |
321
- | **fields_flow_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
322
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#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] |
323
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
324
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
325
-
326
- ### Return type
327
-
328
- **Hash&lt;String, Object&gt;**
329
-
330
- ### Authorization
331
-
332
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
333
-
334
- ### HTTP request headers
335
-
336
- - **Content-Type**: Not defined
337
- - **Accept**: application/json
338
-
339
-
340
- ## get_flow_action_relationships_flow
341
-
342
- > Hash&lt;String, Object&gt; get_flow_action_relationships_flow(id)
343
-
344
- Get Flow Action Relationships Flow
345
-
346
- Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
347
-
348
- ### Examples
349
-
350
- ```ruby
351
- require 'time'
352
- require 'klaviyo-api-sdk'
353
- # setup authorization
354
- KlaviyoAPI.configure do |config|
355
- # Configure API key authorization: Klaviyo-API-Key
356
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
357
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
358
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
359
- end
360
-
361
- api_instance = KlaviyoAPI::FlowsApi.new
362
- id = 'id_example' # String |
363
-
364
- begin
365
- # Get Flow Action Relationships Flow
366
- result = api_instance.get_flow_action_relationships_flow(id)
367
- p result
368
- rescue KlaviyoAPI::ApiError => e
369
- puts "Error when calling FlowsApi->get_flow_action_relationships_flow: #{e}"
370
- end
371
- ```
372
-
373
- #### Using the get_flow_action_relationships_flow_with_http_info variant
374
-
375
- This returns an Array which contains the response data, status code and headers.
376
-
377
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_action_relationships_flow_with_http_info(id)
378
-
379
- ```ruby
380
- begin
381
- # Get Flow Action Relationships Flow
382
- data, status_code, headers = api_instance.get_flow_action_relationships_flow_with_http_info(id)
383
- p status_code # => 2xx
384
- p headers # => { ... }
385
- p data # => Hash&lt;String, Object&gt;
386
- rescue KlaviyoAPI::ApiError => e
387
- puts "Error when calling FlowsApi->get_flow_action_relationships_flow_with_http_info: #{e}"
388
- end
389
- ```
390
-
391
- ### Parameters
392
-
393
- | Name | Type | Description | Notes |
394
- | ---- | ---- | ----------- | ----- |
395
- | **id** | **String** | | |
396
-
397
- ### Return type
398
-
399
- **Hash&lt;String, Object&gt;**
400
-
401
- ### Authorization
402
-
403
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
404
-
405
- ### HTTP request headers
406
-
407
- - **Content-Type**: Not defined
408
- - **Accept**: application/json
409
-
410
-
411
- ## get_flow_action_relationships_messages
412
-
413
- > Hash&lt;String, Object&gt; get_flow_action_relationships_messages(id, opts)
414
-
415
- Get Flow Action Relationships Messages
416
-
417
- Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
418
-
419
- ### Examples
420
-
421
- ```ruby
422
- require 'time'
423
- require 'klaviyo-api-sdk'
424
- # setup authorization
425
- KlaviyoAPI.configure do |config|
426
- # Configure API key authorization: Klaviyo-API-Key
427
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
428
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
429
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
430
- end
431
-
432
- api_instance = KlaviyoAPI::FlowsApi.new
433
- id = 'id_example' # String |
434
- opts = {
435
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<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`
436
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
437
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
438
- }
439
-
440
- begin
441
- # Get Flow Action Relationships Messages
442
- result = api_instance.get_flow_action_relationships_messages(id, opts)
443
- p result
444
- rescue KlaviyoAPI::ApiError => e
445
- puts "Error when calling FlowsApi->get_flow_action_relationships_messages: #{e}"
446
- end
447
- ```
448
-
449
- #### Using the get_flow_action_relationships_messages_with_http_info variant
450
-
451
- This returns an Array which contains the response data, status code and headers.
452
-
453
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_action_relationships_messages_with_http_info(id, opts)
454
-
455
- ```ruby
456
- begin
457
- # Get Flow Action Relationships Messages
458
- data, status_code, headers = api_instance.get_flow_action_relationships_messages_with_http_info(id, opts)
459
- p status_code # => 2xx
460
- p headers # => { ... }
461
- p data # => Hash&lt;String, Object&gt;
462
- rescue KlaviyoAPI::ApiError => e
463
- puts "Error when calling FlowsApi->get_flow_action_relationships_messages_with_http_info: #{e}"
464
- end
465
- ```
466
-
467
- ### Parameters
468
-
469
- | Name | Type | Description | Notes |
470
- | ---- | ---- | ----------- | ----- |
471
- | **id** | **String** | | |
472
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;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] |
473
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
474
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
475
-
476
- ### Return type
477
-
478
- **Hash&lt;String, Object&gt;**
479
-
480
- ### Authorization
481
-
482
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
483
-
484
- ### HTTP request headers
485
-
486
- - **Content-Type**: Not defined
487
- - **Accept**: application/json
488
-
489
-
490
- ## get_flow_flow_actions
491
-
492
- > Hash&lt;String, Object&gt; get_flow_flow_actions(flow_id, opts)
493
-
494
- Get Flow Actions For Flow
495
-
496
- Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
497
-
498
- ### Examples
499
-
500
- ```ruby
501
- require 'time'
502
- require 'klaviyo-api-sdk'
503
- # setup authorization
504
- KlaviyoAPI.configure do |config|
505
- # Configure API key authorization: Klaviyo-API-Key
506
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
507
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
508
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
509
- end
510
-
511
- api_instance = KlaviyoAPI::FlowsApi.new
512
- flow_id = 'flow_id_example' # String |
513
- opts = {
514
- fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
515
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `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`
516
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
517
- sort: 'action_type' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
518
- }
519
-
520
- begin
521
- # Get Flow Actions For Flow
522
- result = api_instance.get_flow_flow_actions(flow_id, opts)
523
- p result
524
- rescue KlaviyoAPI::ApiError => e
525
- puts "Error when calling FlowsApi->get_flow_flow_actions: #{e}"
526
- end
527
- ```
528
-
529
- #### Using the get_flow_flow_actions_with_http_info variant
530
-
531
- This returns an Array which contains the response data, status code and headers.
532
-
533
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_flow_actions_with_http_info(flow_id, opts)
534
-
535
- ```ruby
536
- begin
537
- # Get Flow Actions For Flow
538
- data, status_code, headers = api_instance.get_flow_flow_actions_with_http_info(flow_id, opts)
539
- p status_code # => 2xx
540
- p headers # => { ... }
541
- p data # => Hash&lt;String, Object&gt;
542
- rescue KlaviyoAPI::ApiError => e
543
- puts "Error when calling FlowsApi->get_flow_flow_actions_with_http_info: #{e}"
544
- end
545
- ```
546
-
547
- ### Parameters
548
-
549
- | Name | Type | Description | Notes |
550
- | ---- | ---- | ----------- | ----- |
551
- | **flow_id** | **String** | | |
552
- | **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
553
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;action_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#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] |
554
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
555
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
556
-
557
- ### Return type
558
-
559
- **Hash&lt;String, Object&gt;**
560
-
561
- ### Authorization
562
-
563
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
564
-
565
- ### HTTP request headers
566
-
567
- - **Content-Type**: Not defined
568
- - **Accept**: application/json
569
-
570
-
571
- ## get_flow_message
572
-
573
- > Hash&lt;String, Object&gt; get_flow_message(id, opts)
574
-
575
- Get Flow Message
576
-
577
- Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
578
-
579
- ### Examples
580
-
581
- ```ruby
582
- require 'time'
583
- require 'klaviyo-api-sdk'
584
- # setup authorization
585
- KlaviyoAPI.configure do |config|
586
- # Configure API key authorization: Klaviyo-API-Key
587
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
588
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
589
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
590
- end
591
-
592
- api_instance = KlaviyoAPI::FlowsApi.new
593
- id = 'id_example' # String |
594
- opts = {
595
- fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
596
- fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
597
- include: ['flow-action'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
598
- }
599
-
600
- begin
601
- # Get Flow Message
602
- result = api_instance.get_flow_message(id, opts)
603
- p result
604
- rescue KlaviyoAPI::ApiError => e
605
- puts "Error when calling FlowsApi->get_flow_message: #{e}"
606
- end
607
- ```
608
-
609
- #### Using the get_flow_message_with_http_info variant
610
-
611
- This returns an Array which contains the response data, status code and headers.
612
-
613
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_message_with_http_info(id, opts)
614
-
615
- ```ruby
616
- begin
617
- # Get Flow Message
618
- data, status_code, headers = api_instance.get_flow_message_with_http_info(id, opts)
619
- p status_code # => 2xx
620
- p headers # => { ... }
621
- p data # => Hash&lt;String, Object&gt;
622
- rescue KlaviyoAPI::ApiError => e
623
- puts "Error when calling FlowsApi->get_flow_message_with_http_info: #{e}"
624
- end
625
- ```
626
-
627
- ### Parameters
628
-
629
- | Name | Type | Description | Notes |
630
- | ---- | ---- | ----------- | ----- |
631
- | **id** | **String** | | |
632
- | **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
633
- | **fields_flow_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
634
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
635
-
636
- ### Return type
637
-
638
- **Hash&lt;String, Object&gt;**
639
-
640
- ### Authorization
641
-
642
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
643
-
644
- ### HTTP request headers
645
-
646
- - **Content-Type**: Not defined
647
- - **Accept**: application/json
648
-
649
-
650
- ## get_flow_message_action
651
-
652
- > Hash&lt;String, Object&gt; get_flow_message_action(message_id, opts)
653
-
654
- Get Flow Action For Message
655
-
656
- Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
657
-
658
- ### Examples
659
-
660
- ```ruby
661
- require 'time'
662
- require 'klaviyo-api-sdk'
663
- # setup authorization
664
- KlaviyoAPI.configure do |config|
665
- # Configure API key authorization: Klaviyo-API-Key
666
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
667
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
668
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
669
- end
670
-
671
- api_instance = KlaviyoAPI::FlowsApi.new
672
- message_id = 'message_id_example' # String |
673
- opts = {
674
- fields_flow_action: ['action_type'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
675
- }
676
-
677
- begin
678
- # Get Flow Action For Message
679
- result = api_instance.get_flow_message_action(message_id, opts)
680
- p result
681
- rescue KlaviyoAPI::ApiError => e
682
- puts "Error when calling FlowsApi->get_flow_message_action: #{e}"
683
- end
684
- ```
685
-
686
- #### Using the get_flow_message_action_with_http_info variant
687
-
688
- This returns an Array which contains the response data, status code and headers.
689
-
690
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_message_action_with_http_info(message_id, opts)
691
-
692
- ```ruby
693
- begin
694
- # Get Flow Action For Message
695
- data, status_code, headers = api_instance.get_flow_message_action_with_http_info(message_id, opts)
696
- p status_code # => 2xx
697
- p headers # => { ... }
698
- p data # => Hash&lt;String, Object&gt;
699
- rescue KlaviyoAPI::ApiError => e
700
- puts "Error when calling FlowsApi->get_flow_message_action_with_http_info: #{e}"
701
- end
702
- ```
703
-
704
- ### Parameters
705
-
706
- | Name | Type | Description | Notes |
707
- | ---- | ---- | ----------- | ----- |
708
- | **message_id** | **String** | | |
709
- | **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
710
-
711
- ### Return type
712
-
713
- **Hash&lt;String, Object&gt;**
714
-
715
- ### Authorization
716
-
717
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
718
-
719
- ### HTTP request headers
720
-
721
- - **Content-Type**: Not defined
722
- - **Accept**: application/json
723
-
724
-
725
- ## get_flow_message_relationships_action
726
-
727
- > Hash&lt;String, Object&gt; get_flow_message_relationships_action(id)
728
-
729
- Get Flow Message Relationships Action
730
-
731
- Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
732
-
733
- ### Examples
734
-
735
- ```ruby
736
- require 'time'
737
- require 'klaviyo-api-sdk'
738
- # setup authorization
739
- KlaviyoAPI.configure do |config|
740
- # Configure API key authorization: Klaviyo-API-Key
741
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
742
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
743
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
744
- end
745
-
746
- api_instance = KlaviyoAPI::FlowsApi.new
747
- id = 'id_example' # String |
748
-
749
- begin
750
- # Get Flow Message Relationships Action
751
- result = api_instance.get_flow_message_relationships_action(id)
752
- p result
753
- rescue KlaviyoAPI::ApiError => e
754
- puts "Error when calling FlowsApi->get_flow_message_relationships_action: #{e}"
755
- end
756
- ```
757
-
758
- #### Using the get_flow_message_relationships_action_with_http_info variant
759
-
760
- This returns an Array which contains the response data, status code and headers.
761
-
762
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_message_relationships_action_with_http_info(id)
763
-
764
- ```ruby
765
- begin
766
- # Get Flow Message Relationships Action
767
- data, status_code, headers = api_instance.get_flow_message_relationships_action_with_http_info(id)
768
- p status_code # => 2xx
769
- p headers # => { ... }
770
- p data # => Hash&lt;String, Object&gt;
771
- rescue KlaviyoAPI::ApiError => e
772
- puts "Error when calling FlowsApi->get_flow_message_relationships_action_with_http_info: #{e}"
773
- end
774
- ```
775
-
776
- ### Parameters
777
-
778
- | Name | Type | Description | Notes |
779
- | ---- | ---- | ----------- | ----- |
780
- | **id** | **String** | | |
781
-
782
- ### Return type
783
-
784
- **Hash&lt;String, Object&gt;**
785
-
786
- ### Authorization
787
-
788
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
789
-
790
- ### HTTP request headers
791
-
792
- - **Content-Type**: Not defined
793
- - **Accept**: application/json
794
-
795
-
796
- ## get_flow_relationships_flow_actions
797
-
798
- > Hash&lt;String, Object&gt; get_flow_relationships_flow_actions(id, opts)
799
-
800
- Get Flow Relationships Flow Actions
801
-
802
- Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
803
-
804
- ### Examples
805
-
806
- ```ruby
807
- require 'time'
808
- require 'klaviyo-api-sdk'
809
- # setup authorization
810
- KlaviyoAPI.configure do |config|
811
- # Configure API key authorization: Klaviyo-API-Key
812
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
813
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
814
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
815
- end
816
-
817
- api_instance = KlaviyoAPI::FlowsApi.new
818
- id = 'id_example' # String |
819
- opts = {
820
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `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`
821
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
822
- }
823
-
824
- begin
825
- # Get Flow Relationships Flow Actions
826
- result = api_instance.get_flow_relationships_flow_actions(id, opts)
827
- p result
828
- rescue KlaviyoAPI::ApiError => e
829
- puts "Error when calling FlowsApi->get_flow_relationships_flow_actions: #{e}"
830
- end
831
- ```
832
-
833
- #### Using the get_flow_relationships_flow_actions_with_http_info variant
834
-
835
- This returns an Array which contains the response data, status code and headers.
836
-
837
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_relationships_flow_actions_with_http_info(id, opts)
838
-
839
- ```ruby
840
- begin
841
- # Get Flow Relationships Flow Actions
842
- data, status_code, headers = api_instance.get_flow_relationships_flow_actions_with_http_info(id, opts)
843
- p status_code # => 2xx
844
- p headers # => { ... }
845
- p data # => Hash&lt;String, Object&gt;
846
- rescue KlaviyoAPI::ApiError => e
847
- puts "Error when calling FlowsApi->get_flow_relationships_flow_actions_with_http_info: #{e}"
848
- end
849
- ```
850
-
851
- ### Parameters
852
-
853
- | Name | Type | Description | Notes |
854
- | ---- | ---- | ----------- | ----- |
855
- | **id** | **String** | | |
856
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;action_type&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;status&#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] |
857
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
858
-
859
- ### Return type
860
-
861
- **Hash&lt;String, Object&gt;**
862
-
863
- ### Authorization
864
-
865
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
866
-
867
- ### HTTP request headers
868
-
869
- - **Content-Type**: Not defined
870
- - **Accept**: application/json
871
-
872
-
873
- ## get_flow_relationships_tags
874
-
875
- > Hash&lt;String, Object&gt; get_flow_relationships_tags(id)
876
-
877
- Get Flow Relationships Tags
878
-
879
- Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` `Tags Read`
880
-
881
- ### Examples
882
-
883
- ```ruby
884
- require 'time'
885
- require 'klaviyo-api-sdk'
886
- # setup authorization
887
- KlaviyoAPI.configure do |config|
888
- # Configure API key authorization: Klaviyo-API-Key
889
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
890
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
891
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
892
- end
893
-
894
- api_instance = KlaviyoAPI::FlowsApi.new
895
- id = 'id_example' # String |
896
-
897
- begin
898
- # Get Flow Relationships Tags
899
- result = api_instance.get_flow_relationships_tags(id)
900
- p result
901
- rescue KlaviyoAPI::ApiError => e
902
- puts "Error when calling FlowsApi->get_flow_relationships_tags: #{e}"
903
- end
904
- ```
905
-
906
- #### Using the get_flow_relationships_tags_with_http_info variant
907
-
908
- This returns an Array which contains the response data, status code and headers.
909
-
910
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_relationships_tags_with_http_info(id)
911
-
912
- ```ruby
913
- begin
914
- # Get Flow Relationships Tags
915
- data, status_code, headers = api_instance.get_flow_relationships_tags_with_http_info(id)
916
- p status_code # => 2xx
917
- p headers # => { ... }
918
- p data # => Hash&lt;String, Object&gt;
919
- rescue KlaviyoAPI::ApiError => e
920
- puts "Error when calling FlowsApi->get_flow_relationships_tags_with_http_info: #{e}"
921
- end
922
- ```
923
-
924
- ### Parameters
925
-
926
- | Name | Type | Description | Notes |
927
- | ---- | ---- | ----------- | ----- |
928
- | **id** | **String** | | |
929
-
930
- ### Return type
931
-
932
- **Hash&lt;String, Object&gt;**
933
-
934
- ### Authorization
935
-
936
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
937
-
938
- ### HTTP request headers
939
-
940
- - **Content-Type**: Not defined
941
- - **Accept**: application/json
942
-
943
-
944
- ## get_flow_tags
945
-
946
- > Hash&lt;String, Object&gt; get_flow_tags(flow_id, opts)
947
-
948
- Get Flow Tags
949
-
950
- Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` `Tags Read`
951
-
952
- ### Examples
953
-
954
- ```ruby
955
- require 'time'
956
- require 'klaviyo-api-sdk'
957
- # setup authorization
958
- KlaviyoAPI.configure do |config|
959
- # Configure API key authorization: Klaviyo-API-Key
960
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
961
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
962
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
963
- end
964
-
965
- api_instance = KlaviyoAPI::FlowsApi.new
966
- flow_id = 'flow_id_example' # String |
967
- opts = {
968
- fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
969
- }
970
-
971
- begin
972
- # Get Flow Tags
973
- result = api_instance.get_flow_tags(flow_id, opts)
974
- p result
975
- rescue KlaviyoAPI::ApiError => e
976
- puts "Error when calling FlowsApi->get_flow_tags: #{e}"
977
- end
978
- ```
979
-
980
- #### Using the get_flow_tags_with_http_info variant
981
-
982
- This returns an Array which contains the response data, status code and headers.
983
-
984
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_tags_with_http_info(flow_id, opts)
985
-
986
- ```ruby
987
- begin
988
- # Get Flow Tags
989
- data, status_code, headers = api_instance.get_flow_tags_with_http_info(flow_id, opts)
990
- p status_code # => 2xx
991
- p headers # => { ... }
992
- p data # => Hash&lt;String, Object&gt;
993
- rescue KlaviyoAPI::ApiError => e
994
- puts "Error when calling FlowsApi->get_flow_tags_with_http_info: #{e}"
995
- end
996
- ```
997
-
998
- ### Parameters
999
-
1000
- | Name | Type | Description | Notes |
1001
- | ---- | ---- | ----------- | ----- |
1002
- | **flow_id** | **String** | | |
1003
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1004
-
1005
- ### Return type
1006
-
1007
- **Hash&lt;String, Object&gt;**
1008
-
1009
- ### Authorization
1010
-
1011
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1012
-
1013
- ### HTTP request headers
1014
-
1015
- - **Content-Type**: Not defined
1016
- - **Accept**: application/json
1017
-
1018
-
1019
- ## get_flows
1020
-
1021
- > Hash&lt;String, Object&gt; get_flows(opts)
1022
-
1023
- Get Flows
1024
-
1025
- Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
1026
-
1027
- ### Examples
1028
-
1029
- ```ruby
1030
- require 'time'
1031
- require 'klaviyo-api-sdk'
1032
- # setup authorization
1033
- KlaviyoAPI.configure do |config|
1034
- # Configure API key authorization: Klaviyo-API-Key
1035
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1036
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1037
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1038
- end
1039
-
1040
- api_instance = KlaviyoAPI::FlowsApi.new
1041
- opts = {
1042
- fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1043
- fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1044
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `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`<br>`trigger_type`: `equals`
1045
- include: ['flow-actions'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1046
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1047
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1048
- }
1049
-
1050
- begin
1051
- # Get Flows
1052
- result = api_instance.get_flows(opts)
1053
- p result
1054
- rescue KlaviyoAPI::ApiError => e
1055
- puts "Error when calling FlowsApi->get_flows: #{e}"
1056
- end
1057
- ```
1058
-
1059
- #### Using the get_flows_with_http_info variant
1060
-
1061
- This returns an Array which contains the response data, status code and headers.
1062
-
1063
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flows_with_http_info(opts)
1064
-
1065
- ```ruby
1066
- begin
1067
- # Get Flows
1068
- data, status_code, headers = api_instance.get_flows_with_http_info(opts)
1069
- p status_code # => 2xx
1070
- p headers # => { ... }
1071
- p data # => Hash&lt;String, Object&gt;
1072
- rescue KlaviyoAPI::ApiError => e
1073
- puts "Error when calling FlowsApi->get_flows_with_http_info: #{e}"
1074
- end
1075
- ```
1076
-
1077
- ### Parameters
1078
-
1079
- | Name | Type | Description | Notes |
1080
- | ---- | ---- | ----------- | ----- |
1081
- | **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1082
- | **fields_flow** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1083
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#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;&lt;br&gt;&#x60;trigger_type&#x60;: &#x60;equals&#x60; | [optional] |
1084
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
1085
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1086
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1087
-
1088
- ### Return type
1089
-
1090
- **Hash&lt;String, Object&gt;**
1091
-
1092
- ### Authorization
1093
-
1094
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1095
-
1096
- ### HTTP request headers
1097
-
1098
- - **Content-Type**: Not defined
1099
- - **Accept**: application/json
1100
-
1101
-
1102
- ## update_flow
1103
-
1104
- > Hash&lt;String, Object&gt; update_flow(id, flow_update_query)
1105
-
1106
- Update Flow Status
1107
-
1108
- Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Write`
1109
-
1110
- ### Examples
1111
-
1112
- ```ruby
1113
- require 'time'
1114
- require 'klaviyo-api-sdk'
1115
- # setup authorization
1116
- KlaviyoAPI.configure do |config|
1117
- # Configure API key authorization: Klaviyo-API-Key
1118
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1119
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1120
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1121
- end
1122
-
1123
- api_instance = KlaviyoAPI::FlowsApi.new
1124
- id = 'id_example' # String | ID of the Flow to update. Ex: XVTP5Q
1125
- flow_update_query = KlaviyoAPI::FlowUpdateQuery.new({data: KlaviyoAPI::FlowUpdateQueryResourceObject.new({type: KlaviyoAPI::FlowEnum::FLOW, id: 'id_example', attributes: KlaviyoAPI::FlowUpdateQueryResourceObjectAttributes.new({status: 'status_example'})})}) # FlowUpdateQuery |
1126
-
1127
- begin
1128
- # Update Flow Status
1129
- result = api_instance.update_flow(id, flow_update_query)
1130
- p result
1131
- rescue KlaviyoAPI::ApiError => e
1132
- puts "Error when calling FlowsApi->update_flow: #{e}"
1133
- end
1134
- ```
1135
-
1136
- #### Using the update_flow_with_http_info variant
1137
-
1138
- This returns an Array which contains the response data, status code and headers.
1139
-
1140
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_flow_with_http_info(id, flow_update_query)
1141
-
1142
- ```ruby
1143
- begin
1144
- # Update Flow Status
1145
- data, status_code, headers = api_instance.update_flow_with_http_info(id, flow_update_query)
1146
- p status_code # => 2xx
1147
- p headers # => { ... }
1148
- p data # => Hash&lt;String, Object&gt;
1149
- rescue KlaviyoAPI::ApiError => e
1150
- puts "Error when calling FlowsApi->update_flow_with_http_info: #{e}"
1151
- end
1152
- ```
1153
-
1154
- ### Parameters
1155
-
1156
- | Name | Type | Description | Notes |
1157
- | ---- | ---- | ----------- | ----- |
1158
- | **id** | **String** | ID of the Flow to update. Ex: XVTP5Q | |
1159
- | **flow_update_query** | [**FlowUpdateQuery**](FlowUpdateQuery.md) | | |
1160
-
1161
- ### Return type
1162
-
1163
- **Hash&lt;String, Object&gt;**
1164
-
1165
- ### Authorization
1166
-
1167
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1168
-
1169
- ### HTTP request headers
1170
-
1171
- - **Content-Type**: application/json
1172
- - **Accept**: application/json
1173
-