klaviyo-api-sdk 18.0.0 → 19.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +44 -0
- data/README.md +1525 -459
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/billing_api.rb +162 -0
- data/lib/klaviyo-api-sdk/api/brands_api.rb +1933 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +3298 -653
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +265 -265
- data/lib/klaviyo-api-sdk/api/client_api.rb +9 -13
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +80 -80
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +120 -117
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/flows_api.rb +190 -113
- data/lib/klaviyo-api-sdk/api/forms_api.rb +292 -43
- data/lib/klaviyo-api-sdk/api/images_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/lists_api.rb +64 -64
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +94 -94
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -163
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/segments_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/tags_api.rb +62 -62
- data/lib/klaviyo-api-sdk/api/templates_api.rb +236 -76
- data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +19 -19
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → ab_test_action_link_only.rb} +23 -9
- data/lib/klaviyo-api-sdk/models/{sms_message_definition_create.rb → ab_test_settings.rb} +36 -35
- data/lib/klaviyo-api-sdk/models/action_output_split_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/address.rb +295 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audience_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes.rb → audience_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{html_block_data_v0.rb → audience_create_query_resource_object_relationships.rb} +19 -24
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{audiences_update.rb → audience_definition.rb} +32 -10
- data/lib/klaviyo-api-sdk/models/audience_inline_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object_attributes.rb → audience_update_query_resource_object_attributes.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/border_styles.rb +297 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/brand_button_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object_attributes.rb +275 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object_attributes.rb +233 -0
- data/lib/klaviyo-api-sdk/models/brand_color_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options.rb → brand_email_body_patch_attributes.rb} +68 -38
- data/lib/klaviyo-api-sdk/models/brand_email_default_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{audiences.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +25 -28
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_button.rb +218 -0
- data/lib/klaviyo-api-sdk/models/{content_repeat_v0.rb → brand_email_default_partial_update_query_resource_object_relationships_brand_button_data.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_social_group.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_rels_brand_social_group_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_footer_patch_attributes.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_update.rb → brand_email_header_patch_attributes.rb} +36 -38
- data/lib/klaviyo-api-sdk/models/brand_library_button_styles.rb +262 -0
- data/lib/klaviyo-api-sdk/models/brand_library_text_styles.rb +368 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → brand_library_text_styles_letter_spacing.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object.rb → brand_logo_create_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships.rb → brand_logo_create_query_resource_object_relationships.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query.rb → brand_logo_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object_attributes.rb +259 -0
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object.rb → brand_social_group_create_query_resource_object.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge_badge_options.rb → brand_social_group_create_query_resource_object_attributes_social_links_inner.rb} +3 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query.rb → brand_social_group_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object.rb → brand_social_group_partial_update_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_social_group_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_descriptor.rb +248 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/campaign_audience_clone_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_audience_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +9 -9
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +30 -63
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button_definition.rb → campaign_definition.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +12 -48
- data/lib/klaviyo-api-sdk/models/campaign_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_variation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → click_tracking_subscription_parameters.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_unsubscription_parameters.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
- data/lib/klaviyo-api-sdk/models/{push_on_open_web_url.rb → code_action_link_only.rb} +17 -14
- data/lib/klaviyo-api-sdk/models/color.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/consent_page_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{push_on_open_deep_link.rb → continue_with_shop.rb} +29 -22
- data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → continue_with_shop_autofill.rb} +50 -37
- data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → continue_with_shop_properties.rb} +76 -59
- data/lib/klaviyo-api-sdk/models/continue_with_shop_styles.rb +298 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +17 -4
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +33 -1
- data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → coupon_assigner_configuration.rb} +40 -48
- data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +1 -5
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb} +72 -31
- data/lib/klaviyo-api-sdk/models/customer_hub_block_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +5 -1
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb} +29 -28
- data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb} +97 -42
- data/lib/klaviyo-api-sdk/models/{push_send_options.rb → email_header_link.rb} +29 -14
- data/lib/klaviyo-api-sdk/models/email_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +5 -14
- data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → first_party_social_link.rb} +30 -31
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes_definition.rb +126 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes.rb +245 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → flow_action_insert_query_resource_object_attributes_anchor_action.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_definition.rb +124 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → flow_sms_message_hierarchy_inner.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
- data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → flow_whats_app_with_ac.rb} +86 -16
- data/lib/klaviyo-api-sdk/models/form_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form.rb +218 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image.rb → form_unpublish_job_create_query_resource_object_relationships_form.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image_data.rb → form_unpublish_job_create_query_resource_object_relationships_form_data.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +36 -4
- data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → iaf_open_url.rb} +42 -34
- data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb} +12 -12
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb} +69 -55
- data/lib/klaviyo-api-sdk/models/input_style_overrides.rb +307 -0
- data/lib/klaviyo-api-sdk/models/internal_service_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/link_text_styles.rb +352 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → link_text_styles_letter_spacing.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox.rb +291 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_properties.rb +372 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_styles.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → marketing_tracking_consent_configuration.rb} +31 -30
- data/lib/klaviyo-api-sdk/models/media_asset.rb +318 -0
- data/lib/klaviyo-api-sdk/models/media_asset_reference.rb +240 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object.rb +266 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships.rb +237 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
- data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → message_hierarchy_rcs_item.rb} +56 -57
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item.rb +301 -0
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{block_display_options.rb → message_inline_create.rb} +64 -33
- data/lib/klaviyo-api-sdk/models/message_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object_attributes.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_send_options.rb +344 -0
- data/lib/klaviyo-api-sdk/models/message_tracking_options.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → multi_branch_split_action_link_only.rb} +15 -32
- data/lib/klaviyo-api-sdk/models/multi_branch_split_action_link_only_data.rb +225 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +4 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +15 -5
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/push_action_button_v0.rb +322 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button.rb → push_action_button_v2.rb} +28 -8
- data/lib/klaviyo-api-sdk/models/push_channel_details.rb +512 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -10
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/rcs_card.rb +290 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_video.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → rcs_rich_content.rb} +36 -14
- data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → rcs_suggestion.rb} +63 -34
- data/lib/klaviyo-api-sdk/models/review_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +2 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_settings.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{image_block_v0.rb → send_whats_app_with_ac_action.rb} +35 -31
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_data.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/slim_image_reference.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb} +135 -34
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{render_options.rb → spacing_styles.rb} +48 -40
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query.rb → template_preview_send_job_create_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +21 -31
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_attrs_text_messaging_sender_registration.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_create.rb → text_messaging_sender_create_query_resource_object_attributes.rb} +50 -68
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender.rb +218 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → text_style_overrides.rb} +54 -53
- data/lib/klaviyo-api-sdk/models/text_style_overrides_font_family.rb +103 -0
- data/lib/klaviyo-api-sdk/models/text_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → throttled_options.rb} +31 -32
- data/lib/klaviyo-api-sdk/models/time_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{email_send_options.rb → timezone_options.rb} +13 -13
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/translation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_create.rb → translation_create_query_resource_object_attributes.rb} +54 -41
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships.rb +254 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_create.rb → translation_partial_update_query_resource_object_attributes.rb} +39 -41
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object_attributes.rb → universal_content_create_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_strategy.rb → universal_content_create_query_v1_resource_object_attributes_definition.rb} +17 -6
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object_attributes.rb → universal_content_partial_update_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_definition.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -5
- data/lib/klaviyo-api-sdk/models/update_profile_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/variation_definition.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_options.rb → variation_definition_details.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/variation_inline_create.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/verified_badge_style.rb +266 -0
- data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
- data/lib/klaviyo-api-sdk.rb +305 -78
- data/lib/klaviyo-api-sdk.rb.bak +306 -79
- metadata +315 -82
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +0 -107
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -107
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_v0.rb +0 -293
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +0 -533
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -109
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -109
|
@@ -23,7 +23,7 @@ module KlaviyoAPI
|
|
|
23
23
|
# @param flow_create_query [FlowCreateQuery] Creates a Flow from parameters
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
25
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
|
26
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
26
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
27
27
|
# @return [Hash<String, Object>]
|
|
28
28
|
def create_flow(flow_create_query, opts = {})
|
|
29
29
|
data, _status_code, _headers = create_flow_with_http_info(flow_create_query, opts)
|
|
@@ -35,7 +35,7 @@ module KlaviyoAPI
|
|
|
35
35
|
# @param flow_create_query [FlowCreateQuery] Creates a Flow from parameters
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
37
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
|
38
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
38
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
39
39
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
40
40
|
def create_flow_with_http_info(flow_create_query, opts = {})
|
|
41
41
|
if @api_client.config.debugging
|
|
@@ -64,7 +64,7 @@ module KlaviyoAPI
|
|
|
64
64
|
# header parameters
|
|
65
65
|
header_params = opts[:header_params] || {}
|
|
66
66
|
# klaviyo api revision
|
|
67
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
67
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
68
68
|
# HTTP header 'Accept' (if needed)
|
|
69
69
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
70
70
|
# HTTP header 'Content-Type'
|
|
@@ -102,6 +102,83 @@ module KlaviyoAPI
|
|
|
102
102
|
return data, status_code, headers
|
|
103
103
|
end
|
|
104
104
|
|
|
105
|
+
# Create Flow Action
|
|
106
|
+
# Insert a new action into an existing flow. Choose exactly one placement mechanism: - Use `anchor-action` to insert after an existing action on one of its outgoing links. The selected anchor link must equal the new action's `temporary_id`, and the new action definition must not include links. Use an anchor to append to a path or insert into an empty conditional or multi-branch path. - Use `definition.links.next` to insert before an existing downstream action. The server reconnects that action after the new one. - Use `relationships.flow` only to insert the first action into a trigger-only flow whose initialized start path has no actions. `anchor-action`, links on the new definition, and `relationships.flow` are mutually exclusive. Standard linear actions, standard WhatsApp actions, and multi-branch splits are supported. Conditional splits, trigger splits, action-output splits, A/B tests, content experiments, and Automated Conversations actions cannot be inserted. Communication actions are created in Draft and may need content or template configuration before activation. Always-live timing and logic actions require `allow_live_action: true` when inserted into a live flow and can immediately affect profiles already progressing through that flow. A `201` response confirms that the action was created. The action may take a short time to become available to flow execution. This endpoint is not idempotent: retrying after an unknown result can create a duplicate action, and `temporary_id` is not an idempotency key. Responses use persisted values. These can include server-generated multi-branch branch IDs, omission of the request-only `joined` marker, generated message or webhook defaults, and a cloned email template ID that differs from the supplied template ID. Invalid placement, unavailable anchors, and missing live-action opt-in return standard JSON:API errors with field pointers.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow_action.json)
|
|
107
|
+
# @param flow_action_insert_query [FlowActionInsertQuery] Insert a new action using either an anchor action or a flow relationship. An anchor action identifies one outgoing link on an existing action. The new action is inserted on that link. Links on the new action insert it before the referenced downstream action. A flow relationship is only used to insert the first action into a trigger-only flow with an initialized, empty start path. These three placement mechanisms are mutually exclusive.
|
|
108
|
+
# @param [Hash] opts the optional parameters
|
|
109
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
110
|
+
# @return [Hash<String, Object>]
|
|
111
|
+
def create_flow_action(flow_action_insert_query, opts = {})
|
|
112
|
+
data, _status_code, _headers = create_flow_action_with_http_info(flow_action_insert_query, opts)
|
|
113
|
+
data
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# Create Flow Action
|
|
117
|
+
# Insert a new action into an existing flow. Choose exactly one placement mechanism: - Use `anchor-action` to insert after an existing action on one of its outgoing links. The selected anchor link must equal the new action's `temporary_id`, and the new action definition must not include links. Use an anchor to append to a path or insert into an empty conditional or multi-branch path. - Use `definition.links.next` to insert before an existing downstream action. The server reconnects that action after the new one. - Use `relationships.flow` only to insert the first action into a trigger-only flow whose initialized start path has no actions. `anchor-action`, links on the new definition, and `relationships.flow` are mutually exclusive. Standard linear actions, standard WhatsApp actions, and multi-branch splits are supported. Conditional splits, trigger splits, action-output splits, A/B tests, content experiments, and Automated Conversations actions cannot be inserted. Communication actions are created in Draft and may need content or template configuration before activation. Always-live timing and logic actions require `allow_live_action: true` when inserted into a live flow and can immediately affect profiles already progressing through that flow. A `201` response confirms that the action was created. The action may take a short time to become available to flow execution. This endpoint is not idempotent: retrying after an unknown result can create a duplicate action, and `temporary_id` is not an idempotency key. Responses use persisted values. These can include server-generated multi-branch branch IDs, omission of the request-only `joined` marker, generated message or webhook defaults, and a cloned email template ID that differs from the supplied template ID. Invalid placement, unavailable anchors, and missing live-action opt-in return standard JSON:API errors with field pointers.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow_action.json)
|
|
118
|
+
# @param flow_action_insert_query [FlowActionInsertQuery] Insert a new action using either an anchor action or a flow relationship. An anchor action identifies one outgoing link on an existing action. The new action is inserted on that link. Links on the new action insert it before the referenced downstream action. A flow relationship is only used to insert the first action into a trigger-only flow with an initialized, empty start path. These three placement mechanisms are mutually exclusive.
|
|
119
|
+
# @param [Hash] opts the optional parameters
|
|
120
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
121
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
122
|
+
def create_flow_action_with_http_info(flow_action_insert_query, opts = {})
|
|
123
|
+
if @api_client.config.debugging
|
|
124
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.create_flow_action ...'
|
|
125
|
+
end
|
|
126
|
+
# verify the required parameter 'flow_action_insert_query' is set
|
|
127
|
+
if @api_client.config.client_side_validation && flow_action_insert_query.nil?
|
|
128
|
+
fail ArgumentError, "Missing the required parameter 'flow_action_insert_query' when calling FlowsApi.create_flow_action"
|
|
129
|
+
end
|
|
130
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
131
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
132
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
133
|
+
end
|
|
134
|
+
# resource path
|
|
135
|
+
local_var_path = '/api/flow-actions'
|
|
136
|
+
|
|
137
|
+
# query parameters
|
|
138
|
+
query_params = opts[:query_params] || {}
|
|
139
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
|
140
|
+
|
|
141
|
+
# header parameters
|
|
142
|
+
header_params = opts[:header_params] || {}
|
|
143
|
+
# klaviyo api revision
|
|
144
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
145
|
+
# HTTP header 'Accept' (if needed)
|
|
146
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
147
|
+
# HTTP header 'Content-Type'
|
|
148
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
|
149
|
+
if !content_type.nil?
|
|
150
|
+
header_params['Content-Type'] = content_type
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# form parameters
|
|
154
|
+
form_params = opts[:form_params] || {}
|
|
155
|
+
|
|
156
|
+
# http body (model)
|
|
157
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_action_insert_query)
|
|
158
|
+
|
|
159
|
+
# return_type
|
|
160
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
|
161
|
+
|
|
162
|
+
# auth_names
|
|
163
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
164
|
+
|
|
165
|
+
new_options = opts.merge(
|
|
166
|
+
:operation => :"FlowsApi.create_flow_action",
|
|
167
|
+
:header_params => header_params,
|
|
168
|
+
:query_params => query_params,
|
|
169
|
+
:form_params => form_params,
|
|
170
|
+
:body => post_body,
|
|
171
|
+
:auth_names => auth_names,
|
|
172
|
+
:return_type => return_type
|
|
173
|
+
)
|
|
174
|
+
|
|
175
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
176
|
+
if @api_client.config.debugging
|
|
177
|
+
@api_client.config.logger.debug "API called: FlowsApi#create_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
178
|
+
end
|
|
179
|
+
return data, status_code, headers
|
|
180
|
+
end
|
|
181
|
+
|
|
105
182
|
# Delete Flow
|
|
106
183
|
# Delete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_flow.json)
|
|
107
184
|
# @param id [String] ID of the Flow to delete. Ex: XVTP5Q
|
|
@@ -134,7 +211,7 @@ module KlaviyoAPI
|
|
|
134
211
|
# header parameters
|
|
135
212
|
header_params = opts[:header_params] || {}
|
|
136
213
|
# klaviyo api revision
|
|
137
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
214
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
138
215
|
# HTTP header 'Accept' (if needed)
|
|
139
216
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
140
217
|
|
|
@@ -199,7 +276,7 @@ module KlaviyoAPI
|
|
|
199
276
|
# header parameters
|
|
200
277
|
header_params = opts[:header_params] || {}
|
|
201
278
|
# klaviyo api revision
|
|
202
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
279
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
203
280
|
# HTTP header 'Accept' (if needed)
|
|
204
281
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
205
282
|
|
|
@@ -236,7 +313,7 @@ module KlaviyoAPI
|
|
|
236
313
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_for_flow_message.json)
|
|
237
314
|
# @param id [String]
|
|
238
315
|
# @param [Hash] opts the optional parameters
|
|
239
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
316
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
240
317
|
# @return [Hash<String, Object>]
|
|
241
318
|
def get_action_for_flow_message(id, opts = {})
|
|
242
319
|
data, _status_code, _headers = get_action_for_flow_message_with_http_info(id, opts)
|
|
@@ -250,7 +327,7 @@ module KlaviyoAPI
|
|
|
250
327
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_for_flow_message.json)
|
|
251
328
|
# @param id [String]
|
|
252
329
|
# @param [Hash] opts the optional parameters
|
|
253
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
330
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
254
331
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
255
332
|
def get_action_for_flow_message_with_http_info(id, opts = {})
|
|
256
333
|
if @api_client.config.debugging
|
|
@@ -260,7 +337,7 @@ module KlaviyoAPI
|
|
|
260
337
|
if @api_client.config.client_side_validation && id.nil?
|
|
261
338
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_action_for_flow_message"
|
|
262
339
|
end
|
|
263
|
-
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
340
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
264
341
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
265
342
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
266
343
|
end
|
|
@@ -274,7 +351,7 @@ module KlaviyoAPI
|
|
|
274
351
|
# header parameters
|
|
275
352
|
header_params = opts[:header_params] || {}
|
|
276
353
|
# klaviyo api revision
|
|
277
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
354
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
278
355
|
# HTTP header 'Accept' (if needed)
|
|
279
356
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
280
357
|
|
|
@@ -345,7 +422,7 @@ module KlaviyoAPI
|
|
|
345
422
|
# header parameters
|
|
346
423
|
header_params = opts[:header_params] || {}
|
|
347
424
|
# klaviyo api revision
|
|
348
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
425
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
349
426
|
# HTTP header 'Accept' (if needed)
|
|
350
427
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
351
428
|
|
|
@@ -385,10 +462,10 @@ module KlaviyoAPI
|
|
|
385
462
|
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_ids_for_flow.json)
|
|
386
463
|
# @param id [String]
|
|
387
464
|
# @param [Hash] opts the optional parameters
|
|
388
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
389
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
465
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`action_type`: `any`, `equals` (string)<br>`status`: `equals` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
466
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
390
467
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
391
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
468
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
392
469
|
# @return [Hash<String, Object>]
|
|
393
470
|
def get_action_ids_for_flow(id, opts = {})
|
|
394
471
|
data, _status_code, _headers = get_action_ids_for_flow_with_http_info(id, opts)
|
|
@@ -405,10 +482,10 @@ module KlaviyoAPI
|
|
|
405
482
|
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_ids_for_flow.json)
|
|
406
483
|
# @param id [String]
|
|
407
484
|
# @param [Hash] opts the optional parameters
|
|
408
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
409
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
485
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`action_type`: `any`, `equals` (string)<br>`status`: `equals` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
486
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
410
487
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
411
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
488
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
412
489
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
413
490
|
def get_action_ids_for_flow_with_http_info(id, opts = {})
|
|
414
491
|
if @api_client.config.debugging
|
|
@@ -443,7 +520,7 @@ module KlaviyoAPI
|
|
|
443
520
|
# header parameters
|
|
444
521
|
header_params = opts[:header_params] || {}
|
|
445
522
|
# klaviyo api revision
|
|
446
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
523
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
447
524
|
# HTTP header 'Accept' (if needed)
|
|
448
525
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
449
526
|
|
|
@@ -486,11 +563,11 @@ module KlaviyoAPI
|
|
|
486
563
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_actions_for_flow.json)
|
|
487
564
|
# @param id [String]
|
|
488
565
|
# @param [Hash] opts the optional parameters
|
|
489
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
490
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
491
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
566
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
567
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`action_type`: `any`, `equals` (string)<br>`status`: `equals` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
568
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
492
569
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
493
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
570
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
494
571
|
# @return [Hash<String, Object>]
|
|
495
572
|
def get_actions_for_flow(id, opts = {})
|
|
496
573
|
data, _status_code, _headers = get_actions_for_flow_with_http_info(id, opts)
|
|
@@ -507,11 +584,11 @@ module KlaviyoAPI
|
|
|
507
584
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_actions_for_flow.json)
|
|
508
585
|
# @param id [String]
|
|
509
586
|
# @param [Hash] opts the optional parameters
|
|
510
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
511
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
512
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
587
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
588
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`action_type`: `any`, `equals` (string)<br>`status`: `equals` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
589
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
513
590
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
514
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
591
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
515
592
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
516
593
|
def get_actions_for_flow_with_http_info(id, opts = {})
|
|
517
594
|
if @api_client.config.debugging
|
|
@@ -521,7 +598,7 @@ module KlaviyoAPI
|
|
|
521
598
|
if @api_client.config.client_side_validation && id.nil?
|
|
522
599
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_actions_for_flow"
|
|
523
600
|
end
|
|
524
|
-
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
601
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
525
602
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
526
603
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
527
604
|
end
|
|
@@ -551,7 +628,7 @@ module KlaviyoAPI
|
|
|
551
628
|
# header parameters
|
|
552
629
|
header_params = opts[:header_params] || {}
|
|
553
630
|
# klaviyo api revision
|
|
554
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
631
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
555
632
|
# HTTP header 'Accept' (if needed)
|
|
556
633
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
557
634
|
|
|
@@ -595,10 +672,10 @@ module KlaviyoAPI
|
|
|
595
672
|
# @param id [String]
|
|
596
673
|
# @param [Hash] opts the optional parameters
|
|
597
674
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
|
598
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
599
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
600
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
601
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
675
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
676
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
677
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
678
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
602
679
|
# @return [Hash<String, Object>]
|
|
603
680
|
def get_flow(id, opts = {})
|
|
604
681
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
|
@@ -610,10 +687,10 @@ module KlaviyoAPI
|
|
|
610
687
|
# @param id [String]
|
|
611
688
|
# @param [Hash] opts the optional parameters
|
|
612
689
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
|
613
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
614
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
615
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
616
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
690
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
691
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
692
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
693
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
617
694
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
618
695
|
def get_flow_with_http_info(id, opts = {})
|
|
619
696
|
if @api_client.config.debugging
|
|
@@ -627,7 +704,7 @@ module KlaviyoAPI
|
|
|
627
704
|
if @api_client.config.client_side_validation && opts[:'additional_fields_flow'] && !opts[:'additional_fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
628
705
|
fail ArgumentError, "invalid value for \"additional_fields_flow\", must include one of #{allowable_values}"
|
|
629
706
|
end
|
|
630
|
-
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
707
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
631
708
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
632
709
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
633
710
|
end
|
|
@@ -657,7 +734,7 @@ module KlaviyoAPI
|
|
|
657
734
|
# header parameters
|
|
658
735
|
header_params = opts[:header_params] || {}
|
|
659
736
|
# klaviyo api revision
|
|
660
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
737
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
661
738
|
# HTTP header 'Accept' (if needed)
|
|
662
739
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
663
740
|
|
|
@@ -694,10 +771,10 @@ module KlaviyoAPI
|
|
|
694
771
|
# Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action.json)
|
|
695
772
|
# @param id [String]
|
|
696
773
|
# @param [Hash] opts the optional parameters
|
|
697
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
698
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
699
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
700
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
774
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
775
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
776
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
777
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
701
778
|
# @return [Hash<String, Object>]
|
|
702
779
|
def get_flow_action(id, opts = {})
|
|
703
780
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
|
@@ -708,10 +785,10 @@ module KlaviyoAPI
|
|
|
708
785
|
# Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action.json)
|
|
709
786
|
# @param id [String]
|
|
710
787
|
# @param [Hash] opts the optional parameters
|
|
711
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
712
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
713
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
714
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
788
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
789
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
790
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
791
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
715
792
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
716
793
|
def get_flow_action_with_http_info(id, opts = {})
|
|
717
794
|
if @api_client.config.debugging
|
|
@@ -721,11 +798,11 @@ module KlaviyoAPI
|
|
|
721
798
|
if @api_client.config.client_side_validation && id.nil?
|
|
722
799
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action"
|
|
723
800
|
end
|
|
724
|
-
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
801
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
725
802
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
726
803
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
727
804
|
end
|
|
728
|
-
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
805
|
+
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.automation_id", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.expiry_hours", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
729
806
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
730
807
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
731
808
|
end
|
|
@@ -750,7 +827,7 @@ module KlaviyoAPI
|
|
|
750
827
|
# header parameters
|
|
751
828
|
header_params = opts[:header_params] || {}
|
|
752
829
|
# klaviyo api revision
|
|
753
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
830
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
754
831
|
# HTTP header 'Accept' (if needed)
|
|
755
832
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
756
833
|
|
|
@@ -787,11 +864,11 @@ module KlaviyoAPI
|
|
|
787
864
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action_messages.json)
|
|
788
865
|
# @param id [String]
|
|
789
866
|
# @param [Hash] opts the optional parameters
|
|
790
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
791
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
792
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
867
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
868
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
869
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
793
870
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
794
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
871
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
795
872
|
# @return [Hash<String, Object>]
|
|
796
873
|
def get_flow_action_messages(id, opts = {})
|
|
797
874
|
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
|
@@ -805,11 +882,11 @@ module KlaviyoAPI
|
|
|
805
882
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action_messages.json)
|
|
806
883
|
# @param id [String]
|
|
807
884
|
# @param [Hash] opts the optional parameters
|
|
808
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
809
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
810
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
885
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
886
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
887
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
811
888
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
812
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
889
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
813
890
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
814
891
|
def get_flow_action_messages_with_http_info(id, opts = {})
|
|
815
892
|
if @api_client.config.debugging
|
|
@@ -819,7 +896,7 @@ module KlaviyoAPI
|
|
|
819
896
|
if @api_client.config.client_side_validation && id.nil?
|
|
820
897
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_messages"
|
|
821
898
|
end
|
|
822
|
-
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
899
|
+
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.automation_id", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.expiry_hours", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
823
900
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
824
901
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
825
902
|
end
|
|
@@ -849,7 +926,7 @@ module KlaviyoAPI
|
|
|
849
926
|
# header parameters
|
|
850
927
|
header_params = opts[:header_params] || {}
|
|
851
928
|
# klaviyo api revision
|
|
852
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
929
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
853
930
|
# HTTP header 'Accept' (if needed)
|
|
854
931
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
855
932
|
|
|
@@ -889,7 +966,7 @@ module KlaviyoAPI
|
|
|
889
966
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_for_flow_action.json)
|
|
890
967
|
# @param id [String]
|
|
891
968
|
# @param [Hash] opts the optional parameters
|
|
892
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
969
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
893
970
|
# @return [Hash<String, Object>]
|
|
894
971
|
def get_flow_for_flow_action(id, opts = {})
|
|
895
972
|
data, _status_code, _headers = get_flow_for_flow_action_with_http_info(id, opts)
|
|
@@ -903,7 +980,7 @@ module KlaviyoAPI
|
|
|
903
980
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_for_flow_action.json)
|
|
904
981
|
# @param id [String]
|
|
905
982
|
# @param [Hash] opts the optional parameters
|
|
906
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
983
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
907
984
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
908
985
|
def get_flow_for_flow_action_with_http_info(id, opts = {})
|
|
909
986
|
if @api_client.config.debugging
|
|
@@ -927,7 +1004,7 @@ module KlaviyoAPI
|
|
|
927
1004
|
# header parameters
|
|
928
1005
|
header_params = opts[:header_params] || {}
|
|
929
1006
|
# klaviyo api revision
|
|
930
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1007
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
931
1008
|
# HTTP header 'Accept' (if needed)
|
|
932
1009
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
933
1010
|
|
|
@@ -998,7 +1075,7 @@ module KlaviyoAPI
|
|
|
998
1075
|
# header parameters
|
|
999
1076
|
header_params = opts[:header_params] || {}
|
|
1000
1077
|
# klaviyo api revision
|
|
1001
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1078
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1002
1079
|
# HTTP header 'Accept' (if needed)
|
|
1003
1080
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1004
1081
|
|
|
@@ -1038,10 +1115,10 @@ module KlaviyoAPI
|
|
|
1038
1115
|
# Get a flow message from a flow with the given flow message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message.json)
|
|
1039
1116
|
# @param id [String]
|
|
1040
1117
|
# @param [Hash] opts the optional parameters
|
|
1041
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1042
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1043
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1044
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1118
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1119
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1120
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1121
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1045
1122
|
# @return [Hash<String, Object>]
|
|
1046
1123
|
def get_flow_message(id, opts = {})
|
|
1047
1124
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
|
@@ -1052,10 +1129,10 @@ module KlaviyoAPI
|
|
|
1052
1129
|
# Get a flow message from a flow with the given flow message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message.json)
|
|
1053
1130
|
# @param id [String]
|
|
1054
1131
|
# @param [Hash] opts the optional parameters
|
|
1055
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1056
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1057
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1058
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1132
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1133
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1134
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1135
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1059
1136
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1060
1137
|
def get_flow_message_with_http_info(id, opts = {})
|
|
1061
1138
|
if @api_client.config.debugging
|
|
@@ -1065,15 +1142,15 @@ module KlaviyoAPI
|
|
|
1065
1142
|
if @api_client.config.client_side_validation && id.nil?
|
|
1066
1143
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message"
|
|
1067
1144
|
end
|
|
1068
|
-
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1145
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1069
1146
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
1070
1147
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
1071
1148
|
end
|
|
1072
|
-
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
1149
|
+
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.automation_id", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.expiry_hours", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
1073
1150
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
1074
1151
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
1075
1152
|
end
|
|
1076
|
-
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "text", "updated"]
|
|
1153
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "screenshot_url", "text", "updated"]
|
|
1077
1154
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
1078
1155
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
1079
1156
|
end
|
|
@@ -1094,7 +1171,7 @@ module KlaviyoAPI
|
|
|
1094
1171
|
# header parameters
|
|
1095
1172
|
header_params = opts[:header_params] || {}
|
|
1096
1173
|
# klaviyo api revision
|
|
1097
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1174
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1098
1175
|
# HTTP header 'Accept' (if needed)
|
|
1099
1176
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1100
1177
|
|
|
@@ -1130,14 +1207,14 @@ module KlaviyoAPI
|
|
|
1130
1207
|
# Get Flows
|
|
1131
1208
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows.json)
|
|
1132
1209
|
# @param [Hash] opts the optional parameters
|
|
1133
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1134
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1135
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1136
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1137
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1138
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1210
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1211
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1212
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1213
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` (string)<br>`status`: `equals` (string)<br>`archived`: `equals` (boolean)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`trigger_type`: `equals` (allowed values: `'Metric'`, `'Added to List'`, `'Unconfigured'`, `'Date Based'`, `'Price Drop'`, `'Low Inventory'`)
|
|
1214
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1215
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1139
1216
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1140
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1217
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
1141
1218
|
# @return [Hash<String, Object>]
|
|
1142
1219
|
def get_flows(opts = {})
|
|
1143
1220
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
|
@@ -1147,20 +1224,20 @@ module KlaviyoAPI
|
|
|
1147
1224
|
# Get Flows
|
|
1148
1225
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows.json)
|
|
1149
1226
|
# @param [Hash] opts the optional parameters
|
|
1150
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1151
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1152
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1153
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1154
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1155
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1227
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1228
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1229
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1230
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any` (string)<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` (string)<br>`status`: `equals` (string)<br>`archived`: `equals` (boolean)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`trigger_type`: `equals` (allowed values: `'Metric'`, `'Added to List'`, `'Unconfigured'`, `'Date Based'`, `'Price Drop'`, `'Low Inventory'`)
|
|
1231
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
|
|
1232
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1156
1233
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1157
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1234
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
1158
1235
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1159
1236
|
def get_flows_with_http_info(opts = {})
|
|
1160
1237
|
if @api_client.config.debugging
|
|
1161
1238
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flows ...'
|
|
1162
1239
|
end
|
|
1163
|
-
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1240
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1164
1241
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
1165
1242
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
1166
1243
|
end
|
|
@@ -1205,7 +1282,7 @@ module KlaviyoAPI
|
|
|
1205
1282
|
# header parameters
|
|
1206
1283
|
header_params = opts[:header_params] || {}
|
|
1207
1284
|
# klaviyo api revision
|
|
1208
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1285
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1209
1286
|
# HTTP header 'Accept' (if needed)
|
|
1210
1287
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1211
1288
|
|
|
@@ -1242,10 +1319,10 @@ module KlaviyoAPI
|
|
|
1242
1319
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_flow_action.json)
|
|
1243
1320
|
# @param id [String]
|
|
1244
1321
|
# @param [Hash] opts the optional parameters
|
|
1245
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1246
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1322
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
1323
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1247
1324
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1248
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1325
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
1249
1326
|
# @return [Hash<String, Object>]
|
|
1250
1327
|
def get_message_ids_for_flow_action(id, opts = {})
|
|
1251
1328
|
data, _status_code, _headers = get_message_ids_for_flow_action_with_http_info(id, opts)
|
|
@@ -1259,10 +1336,10 @@ module KlaviyoAPI
|
|
|
1259
1336
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_flow_action.json)
|
|
1260
1337
|
# @param id [String]
|
|
1261
1338
|
# @param [Hash] opts the optional parameters
|
|
1262
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1263
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1339
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with` (string)<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (date-time)
|
|
1340
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
|
|
1264
1341
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1265
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1342
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting
|
|
1266
1343
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1267
1344
|
def get_message_ids_for_flow_action_with_http_info(id, opts = {})
|
|
1268
1345
|
if @api_client.config.debugging
|
|
@@ -1297,7 +1374,7 @@ module KlaviyoAPI
|
|
|
1297
1374
|
# header parameters
|
|
1298
1375
|
header_params = opts[:header_params] || {}
|
|
1299
1376
|
# klaviyo api revision
|
|
1300
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1377
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1301
1378
|
# HTTP header 'Accept' (if needed)
|
|
1302
1379
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1303
1380
|
|
|
@@ -1368,7 +1445,7 @@ module KlaviyoAPI
|
|
|
1368
1445
|
# header parameters
|
|
1369
1446
|
header_params = opts[:header_params] || {}
|
|
1370
1447
|
# klaviyo api revision
|
|
1371
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1448
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1372
1449
|
# HTTP header 'Accept' (if needed)
|
|
1373
1450
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1374
1451
|
|
|
@@ -1408,7 +1485,7 @@ module KlaviyoAPI
|
|
|
1408
1485
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_flow.json)
|
|
1409
1486
|
# @param id [String]
|
|
1410
1487
|
# @param [Hash] opts the optional parameters
|
|
1411
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1488
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1412
1489
|
# @return [Hash<String, Object>]
|
|
1413
1490
|
def get_tags_for_flow(id, opts = {})
|
|
1414
1491
|
data, _status_code, _headers = get_tags_for_flow_with_http_info(id, opts)
|
|
@@ -1422,7 +1499,7 @@ module KlaviyoAPI
|
|
|
1422
1499
|
# 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` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_flow.json)
|
|
1423
1500
|
# @param id [String]
|
|
1424
1501
|
# @param [Hash] opts the optional parameters
|
|
1425
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1502
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1426
1503
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1427
1504
|
def get_tags_for_flow_with_http_info(id, opts = {})
|
|
1428
1505
|
if @api_client.config.debugging
|
|
@@ -1446,7 +1523,7 @@ module KlaviyoAPI
|
|
|
1446
1523
|
# header parameters
|
|
1447
1524
|
header_params = opts[:header_params] || {}
|
|
1448
1525
|
# klaviyo api revision
|
|
1449
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1526
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1450
1527
|
# HTTP header 'Accept' (if needed)
|
|
1451
1528
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1452
1529
|
|
|
@@ -1486,7 +1563,7 @@ module KlaviyoAPI
|
|
|
1486
1563
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_flow_message.json)
|
|
1487
1564
|
# @param id [String]
|
|
1488
1565
|
# @param [Hash] opts the optional parameters
|
|
1489
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1566
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1490
1567
|
# @return [Hash<String, Object>]
|
|
1491
1568
|
def get_template_for_flow_message(id, opts = {})
|
|
1492
1569
|
data, _status_code, _headers = get_template_for_flow_message_with_http_info(id, opts)
|
|
@@ -1500,7 +1577,7 @@ module KlaviyoAPI
|
|
|
1500
1577
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_flow_message.json)
|
|
1501
1578
|
# @param id [String]
|
|
1502
1579
|
# @param [Hash] opts the optional parameters
|
|
1503
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1580
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1504
1581
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1505
1582
|
def get_template_for_flow_message_with_http_info(id, opts = {})
|
|
1506
1583
|
if @api_client.config.debugging
|
|
@@ -1510,7 +1587,7 @@ module KlaviyoAPI
|
|
|
1510
1587
|
if @api_client.config.client_side_validation && id.nil?
|
|
1511
1588
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_template_for_flow_message"
|
|
1512
1589
|
end
|
|
1513
|
-
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "text", "updated"]
|
|
1590
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "screenshot_url", "text", "updated"]
|
|
1514
1591
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
1515
1592
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
1516
1593
|
end
|
|
@@ -1524,7 +1601,7 @@ module KlaviyoAPI
|
|
|
1524
1601
|
# header parameters
|
|
1525
1602
|
header_params = opts[:header_params] || {}
|
|
1526
1603
|
# klaviyo api revision
|
|
1527
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1604
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1528
1605
|
# HTTP header 'Accept' (if needed)
|
|
1529
1606
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1530
1607
|
|
|
@@ -1595,7 +1672,7 @@ module KlaviyoAPI
|
|
|
1595
1672
|
# header parameters
|
|
1596
1673
|
header_params = opts[:header_params] || {}
|
|
1597
1674
|
# klaviyo api revision
|
|
1598
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1675
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1599
1676
|
# HTTP header 'Accept' (if needed)
|
|
1600
1677
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1601
1678
|
|
|
@@ -1636,7 +1713,7 @@ module KlaviyoAPI
|
|
|
1636
1713
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
|
1637
1714
|
# @param flow_update_query [FlowUpdateQuery]
|
|
1638
1715
|
# @param [Hash] opts the optional parameters
|
|
1639
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1716
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1640
1717
|
# @return [Hash<String, Object>]
|
|
1641
1718
|
def update_flow(id, flow_update_query, opts = {})
|
|
1642
1719
|
data, _status_code, _headers = update_flow_with_http_info(id, flow_update_query, opts)
|
|
@@ -1648,7 +1725,7 @@ module KlaviyoAPI
|
|
|
1648
1725
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
|
1649
1726
|
# @param flow_update_query [FlowUpdateQuery]
|
|
1650
1727
|
# @param [Hash] opts the optional parameters
|
|
1651
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1728
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1652
1729
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1653
1730
|
def update_flow_with_http_info(id, flow_update_query, opts = {})
|
|
1654
1731
|
if @api_client.config.debugging
|
|
@@ -1676,7 +1753,7 @@ module KlaviyoAPI
|
|
|
1676
1753
|
# header parameters
|
|
1677
1754
|
header_params = opts[:header_params] || {}
|
|
1678
1755
|
# klaviyo api revision
|
|
1679
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1756
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1680
1757
|
# HTTP header 'Accept' (if needed)
|
|
1681
1758
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1682
1759
|
# HTTP header 'Content-Type'
|
|
@@ -1719,7 +1796,7 @@ module KlaviyoAPI
|
|
|
1719
1796
|
# @param id [String]
|
|
1720
1797
|
# @param flow_action_update_query [FlowActionUpdateQuery]
|
|
1721
1798
|
# @param [Hash] opts the optional parameters
|
|
1722
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1799
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1723
1800
|
# @return [Hash<String, Object>]
|
|
1724
1801
|
def update_flow_action(id, flow_action_update_query, opts = {})
|
|
1725
1802
|
data, _status_code, _headers = update_flow_action_with_http_info(id, flow_action_update_query, opts)
|
|
@@ -1731,7 +1808,7 @@ module KlaviyoAPI
|
|
|
1731
1808
|
# @param id [String]
|
|
1732
1809
|
# @param flow_action_update_query [FlowActionUpdateQuery]
|
|
1733
1810
|
# @param [Hash] opts the optional parameters
|
|
1734
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1811
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
|
|
1735
1812
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1736
1813
|
def update_flow_action_with_http_info(id, flow_action_update_query, opts = {})
|
|
1737
1814
|
if @api_client.config.debugging
|
|
@@ -1745,7 +1822,7 @@ module KlaviyoAPI
|
|
|
1745
1822
|
if @api_client.config.client_side_validation && flow_action_update_query.nil?
|
|
1746
1823
|
fail ArgumentError, "Missing the required parameter 'flow_action_update_query' when calling FlowsApi.update_flow_action"
|
|
1747
1824
|
end
|
|
1748
|
-
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1825
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.automation_id", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.expiry_hours", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.automation_id", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.expiry_hours", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1749
1826
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
1750
1827
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
1751
1828
|
end
|
|
@@ -1759,7 +1836,7 @@ module KlaviyoAPI
|
|
|
1759
1836
|
# header parameters
|
|
1760
1837
|
header_params = opts[:header_params] || {}
|
|
1761
1838
|
# klaviyo api revision
|
|
1762
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1839
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
1763
1840
|
# HTTP header 'Accept' (if needed)
|
|
1764
1841
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1765
1842
|
# HTTP header 'Content-Type'
|