klaviyo-api-sdk 17.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 +66 -0
- data/README.md +2261 -677
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +12 -12
- 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 +3334 -629
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +585 -381
- data/lib/klaviyo-api-sdk/api/client_api.rb +96 -0
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +187 -108
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +2758 -83
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +72 -58
- data/lib/klaviyo-api-sdk/api/flows_api.rb +315 -152
- data/lib/klaviyo-api-sdk/api/forms_api.rb +330 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +48 -27
- data/lib/klaviyo-api-sdk/api/lists_api.rb +113 -88
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -156
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +445 -226
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +76 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +38 -31
- data/lib/klaviyo-api-sdk/api/segments_api.rb +107 -82
- data/lib/klaviyo-api-sdk/api/tags_api.rb +164 -128
- data/lib/klaviyo-api-sdk/api/templates_api.rb +291 -78
- data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +24 -17
- data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +41 -27
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +73 -31
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/ab_test_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → ab_test_settings.rb} +39 -34
- data/lib/klaviyo-api-sdk/models/action_output_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter.rb +78 -195
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters.rb → action_output_split_action_data_action_output_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{action_output_condition_condition_group.rb → action_output_split_action_data_action_output_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → action_output_split_action_link_only.rb} +30 -31
- data/lib/klaviyo-api-sdk/models/address.rb +295 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +20 -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/{drop_shadow_block_v0.rb → api_schema_property.rb} +42 -34
- 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/audience_create_query_resource_object_relationships.rb +232 -0
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/base_style_properties.rb +15 -5
- 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/{metric_property_condition_condition_group.rb → brand_color_partial_update_query_resource_object_attributes.rb} +22 -16
- 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/{mobile_push_content_update.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +20 -26
- 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/{sms_message_definition_create.rb → brand_email_footer_patch_attributes.rb} +43 -35
- data/lib/klaviyo-api-sdk/models/brand_email_header_patch_attributes.rb +253 -0
- 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_on_open.rb → brand_library_text_styles_letter_spacing.rb} +3 -3
- 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/brand_social_group_create_query_resource_object_attributes_social_links_inner.rb +104 -0
- 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 +2 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +34 -3
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → button_styles_height.rb} +3 -4
- 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/campaign_definition.rb +273 -0
- 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/{push_on_open_deep_link.rb → cart_content.rb} +23 -25
- data/lib/klaviyo-api-sdk/models/cart_content_properties.rb +236 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_subscription_parameters.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/click_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
- data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → code_action_link_only.rb} +23 -9
- data/lib/klaviyo-api-sdk/models/color.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +5 -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/{static_tracking_param.rb → constant_property_mapping.rb} +25 -26
- data/lib/klaviyo-api-sdk/models/constant_property_mapping_value.rb +107 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_content_experiment_action_data.rb → content_experiment_action_data.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_current_experiment.rb → content_experiment_action_data_current_experiment.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → content_experiment_action_data_main_action.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop.rb +286 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop_autofill.rb +264 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
- data/lib/klaviyo-api-sdk/models/continue_with_shop_properties.rb +327 -0
- 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 +43 -1
- data/lib/klaviyo-api-sdk/models/coupon_assigner_configuration.rb +285 -0
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{push_send_options.rb → custom_css.rb} +22 -13
- data/lib/klaviyo-api-sdk/models/custom_html.rb +292 -0
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +272 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +460 -0
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter.rb → custom_object_date_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters_condition_groups_inner.rb → custom_object_date_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → custom_object_relationship_source.rb} +69 -34
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/display_options.rb +24 -4
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +20 -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/email_header_link.rb +237 -0
- data/lib/klaviyo-api-sdk/models/email_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +22 -9
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +22 -9
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes.rb +292 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes_source_mapping.rb +224 -0
- data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +15 -2
- 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/events_bulk_create_query_resource_object_attributes.rb +14 -1
- data/lib/klaviyo-api-sdk/models/first_party_social_link.rb +271 -0
- 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/flow_action_insert_query_resource_object_attributes_anchor_action.rb +224 -0
- 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_definition_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +15 -5
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +15 -2
- data/lib/klaviyo-api-sdk/models/flow_sms_message_hierarchy_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
- data/lib/klaviyo-api-sdk/models/flow_whats_app_with_ac.rb +303 -0
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +2 -2
- 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/{html_block_data_v0.rb → form_publish_job_create_query_resource_object.rb} +22 -22
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen.rb +305 -0
- data/lib/klaviyo-api-sdk/models/{render_options.rb → iaf_deeplink_to_screen_properties.rb} +32 -37
- data/lib/klaviyo-api-sdk/models/{text_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 +2 -0
- data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
- data/lib/klaviyo-api-sdk/models/image_block_cropping_properties.rb +0 -35
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_properties.rb +20 -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/link_text_styles_letter_spacing.rb +104 -0
- data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters.rb → low_inventory_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_condition_group.rb → low_inventory_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- 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/marketing_tracking_consent_configuration.rb +272 -0
- 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/{flow_push_notification_additional_filters_condition_groups_inner.rb → message_create_query_resource_object_relationships_campaign_data.rb} +28 -15
- data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
- data/lib/klaviyo-api-sdk/models/message_hierarchy_rcs_item.rb +296 -0
- 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/{mobile_push_content_create.rb → message_tracking_options.rb} +25 -32
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +87 -195
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +2 -1
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters.rb → metric_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters_condition_groups_inner.rb → metric_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → multi_branch_split_action_link_only.rb} +7 -33
- 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 +9 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
- data/lib/klaviyo-api-sdk/models/object_record_bulk_delete_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships_object_records.rb +220 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → object_record_delete_job_rels_records_data_inner.rb} +27 -31
- data/lib/klaviyo-api-sdk/models/object_record_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_attributes.rb +322 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_meta.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → object_schema_relationship_create_query.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_update_meta.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → object_type_create_query_resource_object_attributes.rb} +59 -62
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object_attributes_object_schema.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_type_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → open_tracking_subscription_parameters.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/open_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{email_send_options.rb → patch_identifiers.rb} +19 -14
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_filter.rb → price_drop_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_condition_group.rb → price_drop_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +29 -9
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{profile_has_not_received_push_message_condition_timeframe_filter.rb → profile_has_not_received_email_message_condition_timeframe_filter.rb} +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/profile_relationship_source.rb +330 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → property_filter.rb} +29 -14
- data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → property_source.rb} +34 -31
- 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} +29 -13
- 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/quote_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +20 -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/{campaign_create_query_resource_object_attributes_send_options.rb → rcs_card_video.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/rcs_rich_content.rb +244 -0
- data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → rcs_suggestion.rb} +63 -34
- data/lib/klaviyo-api-sdk/models/redirect_properties.rb +2 -5
- data/lib/klaviyo-api-sdk/models/related_id_path.rb +273 -0
- data/lib/klaviyo-api-sdk/models/review_block_styles.rb +13 -13
- data/lib/klaviyo-api-sdk/models/review_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +3 -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 +20 -1
- data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → simple_property_mapping.rb} +28 -34
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping_source.rb +105 -0
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_link_text_style.rb +319 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → source_mapping_create_query_resource_object_attributes.rb} +23 -21
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes_property_mappings_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/spacing_styles.rb +265 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +20 -1
- data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
- data/lib/klaviyo-api-sdk/models/string_phone_operator_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/table_fallback_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/table_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/template_definition.rb +1 -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/{audiences.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +19 -26
- 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 +20 -1
- data/lib/klaviyo-api-sdk/models/text_style_overrides.rb +294 -0
- 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_static_count.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/timezone_options.rb +222 -0
- 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/translation_partial_update_query_resource_object_attributes.rb +257 -0
- 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/{action_output_condition_filter2.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -7
- 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/{mobile_push_badge_badge_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/version.rb +39 -4
- data/lib/klaviyo-api-sdk/models/version_properties.rb +14 -4
- data/lib/klaviyo-api-sdk/models/version_styles.rb +15 -6
- data/lib/klaviyo-api-sdk/models/version_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
- data/lib/klaviyo-api-sdk.rb +389 -99
- data/lib/klaviyo-api-sdk.rb.bak +390 -100
- metadata +399 -103
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_definition.rb +0 -106
- 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/custom_object_property_condition_filter.rb +0 -117
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter2.rb +0 -117
- 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
|
@@ -19,10 +19,11 @@ module KlaviyoAPI
|
|
|
19
19
|
@api_client = api_client
|
|
20
20
|
end
|
|
21
21
|
# Create Flow
|
|
22
|
-
# Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `flows:write`
|
|
22
|
+
# Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow.json)
|
|
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-10-15/reference/api-overview#sparse-fieldsets
|
|
26
27
|
# @return [Hash<String, Object>]
|
|
27
28
|
def create_flow(flow_create_query, opts = {})
|
|
28
29
|
data, _status_code, _headers = create_flow_with_http_info(flow_create_query, opts)
|
|
@@ -30,10 +31,11 @@ module KlaviyoAPI
|
|
|
30
31
|
end
|
|
31
32
|
|
|
32
33
|
# Create Flow
|
|
33
|
-
# Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `flows:write`
|
|
34
|
+
# Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will need to use a `temporary_id` field for identification. These will be replaced with traditional `id` fields after successful creation. A successful request will return the new definition to you.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow.json)
|
|
34
35
|
# @param flow_create_query [FlowCreateQuery] Creates a Flow from parameters
|
|
35
36
|
# @param [Hash] opts the optional parameters
|
|
36
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-10-15/reference/api-overview#sparse-fieldsets
|
|
37
39
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
38
40
|
def create_flow_with_http_info(flow_create_query, opts = {})
|
|
39
41
|
if @api_client.config.debugging
|
|
@@ -47,17 +49,22 @@ module KlaviyoAPI
|
|
|
47
49
|
if @api_client.config.client_side_validation && opts[:'additional_fields_flow'] && !opts[:'additional_fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
48
50
|
fail ArgumentError, "invalid value for \"additional_fields_flow\", must include one of #{allowable_values}"
|
|
49
51
|
end
|
|
52
|
+
allowable_values = ["archived", "created", "definition", "definition.actions", "definition.entry_action_id", "definition.profile_filter", "definition.profile_filter.condition_groups", "definition.reentry_criteria", "definition.reentry_criteria.duration", "definition.reentry_criteria.unit", "definition.triggers", "id", "name", "status", "trigger_type", "updated"]
|
|
53
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
54
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
55
|
+
end
|
|
50
56
|
# resource path
|
|
51
57
|
local_var_path = '/api/flows'
|
|
52
58
|
|
|
53
59
|
# query parameters
|
|
54
60
|
query_params = opts[:query_params] || {}
|
|
55
61
|
query_params[:'additional-fields[flow]'] = @api_client.build_collection_param(opts[:'additional_fields_flow'], :csv) if !opts[:'additional_fields_flow'].nil?
|
|
62
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
|
56
63
|
|
|
57
64
|
# header parameters
|
|
58
65
|
header_params = opts[:header_params] || {}
|
|
59
66
|
# klaviyo api revision
|
|
60
|
-
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"
|
|
61
68
|
# HTTP header 'Accept' (if needed)
|
|
62
69
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
63
70
|
# HTTP header 'Content-Type'
|
|
@@ -95,8 +102,85 @@ module KlaviyoAPI
|
|
|
95
102
|
return data, status_code, headers
|
|
96
103
|
end
|
|
97
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
|
+
|
|
98
182
|
# Delete Flow
|
|
99
|
-
# Delete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
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)
|
|
100
184
|
# @param id [String] ID of the Flow to delete. Ex: XVTP5Q
|
|
101
185
|
# @param [Hash] opts the optional parameters
|
|
102
186
|
# @return [nil]
|
|
@@ -106,7 +190,7 @@ module KlaviyoAPI
|
|
|
106
190
|
end
|
|
107
191
|
|
|
108
192
|
# Delete Flow
|
|
109
|
-
# Delete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
193
|
+
# 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)
|
|
110
194
|
# @param id [String] ID of the Flow to delete. Ex: XVTP5Q
|
|
111
195
|
# @param [Hash] opts the optional parameters
|
|
112
196
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -127,7 +211,7 @@ module KlaviyoAPI
|
|
|
127
211
|
# header parameters
|
|
128
212
|
header_params = opts[:header_params] || {}
|
|
129
213
|
# klaviyo api revision
|
|
130
|
-
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"
|
|
131
215
|
# HTTP header 'Accept' (if needed)
|
|
132
216
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
133
217
|
|
|
@@ -160,11 +244,76 @@ module KlaviyoAPI
|
|
|
160
244
|
return data, status_code, headers
|
|
161
245
|
end
|
|
162
246
|
|
|
247
|
+
# Delete Flow Action
|
|
248
|
+
# Delete a flow action.<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_action.json)
|
|
249
|
+
# @param id [String] ID of the flow action to delete. Ex: 01GDDKASAP8TKDDA2GRZDSVP4H
|
|
250
|
+
# @param [Hash] opts the optional parameters
|
|
251
|
+
# @return [nil]
|
|
252
|
+
def delete_flow_action(id, opts = {})
|
|
253
|
+
delete_flow_action_with_http_info(id, opts)
|
|
254
|
+
nil
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
# Delete Flow Action
|
|
258
|
+
# Delete a flow action.<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_action.json)
|
|
259
|
+
# @param id [String] ID of the flow action to delete. Ex: 01GDDKASAP8TKDDA2GRZDSVP4H
|
|
260
|
+
# @param [Hash] opts the optional parameters
|
|
261
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
262
|
+
def delete_flow_action_with_http_info(id, opts = {})
|
|
263
|
+
if @api_client.config.debugging
|
|
264
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.delete_flow_action ...'
|
|
265
|
+
end
|
|
266
|
+
# verify the required parameter 'id' is set
|
|
267
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
268
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.delete_flow_action"
|
|
269
|
+
end
|
|
270
|
+
# resource path
|
|
271
|
+
local_var_path = '/api/flow-actions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
272
|
+
|
|
273
|
+
# query parameters
|
|
274
|
+
query_params = opts[:query_params] || {}
|
|
275
|
+
|
|
276
|
+
# header parameters
|
|
277
|
+
header_params = opts[:header_params] || {}
|
|
278
|
+
# klaviyo api revision
|
|
279
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
|
|
280
|
+
# HTTP header 'Accept' (if needed)
|
|
281
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
282
|
+
|
|
283
|
+
# form parameters
|
|
284
|
+
form_params = opts[:form_params] || {}
|
|
285
|
+
|
|
286
|
+
# http body (model)
|
|
287
|
+
post_body = opts[:debug_body]
|
|
288
|
+
|
|
289
|
+
# return_type
|
|
290
|
+
return_type = opts[:debug_return_type]
|
|
291
|
+
|
|
292
|
+
# auth_names
|
|
293
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
294
|
+
|
|
295
|
+
new_options = opts.merge(
|
|
296
|
+
:operation => :"FlowsApi.delete_flow_action",
|
|
297
|
+
:header_params => header_params,
|
|
298
|
+
:query_params => query_params,
|
|
299
|
+
:form_params => form_params,
|
|
300
|
+
:body => post_body,
|
|
301
|
+
:auth_names => auth_names,
|
|
302
|
+
:return_type => return_type
|
|
303
|
+
)
|
|
304
|
+
|
|
305
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
306
|
+
if @api_client.config.debugging
|
|
307
|
+
@api_client.config.logger.debug "API called: FlowsApi#delete_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
308
|
+
end
|
|
309
|
+
return data, status_code, headers
|
|
310
|
+
end
|
|
311
|
+
|
|
163
312
|
# Get Action for Flow Message
|
|
164
|
-
# 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`
|
|
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)
|
|
165
314
|
# @param id [String]
|
|
166
315
|
# @param [Hash] opts the optional parameters
|
|
167
|
-
# @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
|
|
168
317
|
# @return [Hash<String, Object>]
|
|
169
318
|
def get_action_for_flow_message(id, opts = {})
|
|
170
319
|
data, _status_code, _headers = get_action_for_flow_message_with_http_info(id, opts)
|
|
@@ -175,10 +324,10 @@ module KlaviyoAPI
|
|
|
175
324
|
alias get_flow_message_action get_action_for_flow_message
|
|
176
325
|
|
|
177
326
|
# Get Action for Flow Message
|
|
178
|
-
# 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`
|
|
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)
|
|
179
328
|
# @param id [String]
|
|
180
329
|
# @param [Hash] opts the optional parameters
|
|
181
|
-
# @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
|
|
182
331
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
183
332
|
def get_action_for_flow_message_with_http_info(id, opts = {})
|
|
184
333
|
if @api_client.config.debugging
|
|
@@ -188,7 +337,7 @@ module KlaviyoAPI
|
|
|
188
337
|
if @api_client.config.client_side_validation && id.nil?
|
|
189
338
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_action_for_flow_message"
|
|
190
339
|
end
|
|
191
|
-
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.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.video_asset_id", "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.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.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", "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"]
|
|
192
341
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
193
342
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
194
343
|
end
|
|
@@ -202,7 +351,7 @@ module KlaviyoAPI
|
|
|
202
351
|
# header parameters
|
|
203
352
|
header_params = opts[:header_params] || {}
|
|
204
353
|
# klaviyo api revision
|
|
205
|
-
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"
|
|
206
355
|
# HTTP header 'Accept' (if needed)
|
|
207
356
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
208
357
|
|
|
@@ -239,7 +388,7 @@ module KlaviyoAPI
|
|
|
239
388
|
alias get_flow_message_action_with_http_info get_action_for_flow_message_with_http_info
|
|
240
389
|
|
|
241
390
|
# Get Action ID for Flow Message
|
|
242
|
-
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
391
|
+
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_id_for_flow_message.json)
|
|
243
392
|
# @param id [String]
|
|
244
393
|
# @param [Hash] opts the optional parameters
|
|
245
394
|
# @return [Hash<String, Object>]
|
|
@@ -252,7 +401,7 @@ module KlaviyoAPI
|
|
|
252
401
|
alias get_flow_message_relationships_action get_action_id_for_flow_message
|
|
253
402
|
|
|
254
403
|
# Get Action ID for Flow Message
|
|
255
|
-
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
404
|
+
# Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_id_for_flow_message.json)
|
|
256
405
|
# @param id [String]
|
|
257
406
|
# @param [Hash] opts the optional parameters
|
|
258
407
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -273,7 +422,7 @@ module KlaviyoAPI
|
|
|
273
422
|
# header parameters
|
|
274
423
|
header_params = opts[:header_params] || {}
|
|
275
424
|
# klaviyo api revision
|
|
276
|
-
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"
|
|
277
426
|
# HTTP header 'Accept' (if needed)
|
|
278
427
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
279
428
|
|
|
@@ -310,13 +459,13 @@ module KlaviyoAPI
|
|
|
310
459
|
alias get_flow_message_relationships_action_with_http_info get_action_id_for_flow_message_with_http_info
|
|
311
460
|
|
|
312
461
|
# Get Action IDs for Flow
|
|
313
|
-
# 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`
|
|
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)
|
|
314
463
|
# @param id [String]
|
|
315
464
|
# @param [Hash] opts the optional parameters
|
|
316
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
317
|
-
# @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
|
|
318
467
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
319
|
-
# @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
|
|
320
469
|
# @return [Hash<String, Object>]
|
|
321
470
|
def get_action_ids_for_flow(id, opts = {})
|
|
322
471
|
data, _status_code, _headers = get_action_ids_for_flow_with_http_info(id, opts)
|
|
@@ -330,13 +479,13 @@ module KlaviyoAPI
|
|
|
330
479
|
alias get_flow_relationships_actions get_action_ids_for_flow
|
|
331
480
|
|
|
332
481
|
# Get Action IDs for Flow
|
|
333
|
-
# 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`
|
|
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)
|
|
334
483
|
# @param id [String]
|
|
335
484
|
# @param [Hash] opts the optional parameters
|
|
336
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
337
|
-
# @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
|
|
338
487
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
339
|
-
# @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
|
|
340
489
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
341
490
|
def get_action_ids_for_flow_with_http_info(id, opts = {})
|
|
342
491
|
if @api_client.config.debugging
|
|
@@ -371,7 +520,7 @@ module KlaviyoAPI
|
|
|
371
520
|
# header parameters
|
|
372
521
|
header_params = opts[:header_params] || {}
|
|
373
522
|
# klaviyo api revision
|
|
374
|
-
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"
|
|
375
524
|
# HTTP header 'Accept' (if needed)
|
|
376
525
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
377
526
|
|
|
@@ -411,14 +560,14 @@ module KlaviyoAPI
|
|
|
411
560
|
alias get_flow_relationships_actions_with_http_info get_action_ids_for_flow_with_http_info
|
|
412
561
|
|
|
413
562
|
# Get Actions for Flow
|
|
414
|
-
# 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`
|
|
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)
|
|
415
564
|
# @param id [String]
|
|
416
565
|
# @param [Hash] opts the optional parameters
|
|
417
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
418
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
419
|
-
# @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
|
|
420
569
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
421
|
-
# @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
|
|
422
571
|
# @return [Hash<String, Object>]
|
|
423
572
|
def get_actions_for_flow(id, opts = {})
|
|
424
573
|
data, _status_code, _headers = get_actions_for_flow_with_http_info(id, opts)
|
|
@@ -432,14 +581,14 @@ module KlaviyoAPI
|
|
|
432
581
|
alias get_flow_actions get_actions_for_flow
|
|
433
582
|
|
|
434
583
|
# Get Actions for Flow
|
|
435
|
-
# 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`
|
|
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)
|
|
436
585
|
# @param id [String]
|
|
437
586
|
# @param [Hash] opts the optional parameters
|
|
438
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
439
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
440
|
-
# @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
|
|
441
590
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
442
|
-
# @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
|
|
443
592
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
444
593
|
def get_actions_for_flow_with_http_info(id, opts = {})
|
|
445
594
|
if @api_client.config.debugging
|
|
@@ -449,7 +598,7 @@ module KlaviyoAPI
|
|
|
449
598
|
if @api_client.config.client_side_validation && id.nil?
|
|
450
599
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_actions_for_flow"
|
|
451
600
|
end
|
|
452
|
-
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.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.video_asset_id", "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.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.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", "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"]
|
|
453
602
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
454
603
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
455
604
|
end
|
|
@@ -479,7 +628,7 @@ module KlaviyoAPI
|
|
|
479
628
|
# header parameters
|
|
480
629
|
header_params = opts[:header_params] || {}
|
|
481
630
|
# klaviyo api revision
|
|
482
|
-
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"
|
|
483
632
|
# HTTP header 'Accept' (if needed)
|
|
484
633
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
485
634
|
|
|
@@ -519,14 +668,14 @@ module KlaviyoAPI
|
|
|
519
668
|
alias get_flow_actions_with_http_info get_actions_for_flow_with_http_info
|
|
520
669
|
|
|
521
670
|
# Get Flow
|
|
522
|
-
# Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
671
|
+
# Get a flow with the given flow 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.json)
|
|
523
672
|
# @param id [String]
|
|
524
673
|
# @param [Hash] opts the optional parameters
|
|
525
674
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
|
526
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
527
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
528
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
529
|
-
# @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
|
|
530
679
|
# @return [Hash<String, Object>]
|
|
531
680
|
def get_flow(id, opts = {})
|
|
532
681
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
|
@@ -534,14 +683,14 @@ module KlaviyoAPI
|
|
|
534
683
|
end
|
|
535
684
|
|
|
536
685
|
# Get Flow
|
|
537
|
-
# Get a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
686
|
+
# Get a flow with the given flow 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.json)
|
|
538
687
|
# @param id [String]
|
|
539
688
|
# @param [Hash] opts the optional parameters
|
|
540
689
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
|
541
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
542
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
543
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
544
|
-
# @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
|
|
545
694
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
546
695
|
def get_flow_with_http_info(id, opts = {})
|
|
547
696
|
if @api_client.config.debugging
|
|
@@ -555,15 +704,15 @@ module KlaviyoAPI
|
|
|
555
704
|
if @api_client.config.client_side_validation && opts[:'additional_fields_flow'] && !opts[:'additional_fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
556
705
|
fail ArgumentError, "invalid value for \"additional_fields_flow\", must include one of #{allowable_values}"
|
|
557
706
|
end
|
|
558
|
-
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.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.video_asset_id", "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.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.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", "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"]
|
|
559
708
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
560
709
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
561
710
|
end
|
|
562
|
-
allowable_values = ["archived", "created", "definition", "definition.actions", "definition.entry_action_id", "definition.profile_filter", "definition.profile_filter.condition_groups", "definition.reentry_criteria", "definition.reentry_criteria.duration", "definition.reentry_criteria.unit", "definition.triggers", "name", "status", "trigger_type", "updated"]
|
|
711
|
+
allowable_values = ["archived", "created", "definition", "definition.actions", "definition.entry_action_id", "definition.profile_filter", "definition.profile_filter.condition_groups", "definition.reentry_criteria", "definition.reentry_criteria.duration", "definition.reentry_criteria.unit", "definition.triggers", "id", "name", "status", "trigger_type", "updated"]
|
|
563
712
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
564
713
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
565
714
|
end
|
|
566
|
-
allowable_values = ["name"]
|
|
715
|
+
allowable_values = ["id", "name"]
|
|
567
716
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
568
717
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
569
718
|
end
|
|
@@ -585,7 +734,7 @@ module KlaviyoAPI
|
|
|
585
734
|
# header parameters
|
|
586
735
|
header_params = opts[:header_params] || {}
|
|
587
736
|
# klaviyo api revision
|
|
588
|
-
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"
|
|
589
738
|
# HTTP header 'Accept' (if needed)
|
|
590
739
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
591
740
|
|
|
@@ -619,13 +768,13 @@ module KlaviyoAPI
|
|
|
619
768
|
end
|
|
620
769
|
|
|
621
770
|
# Get Flow Action
|
|
622
|
-
# 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`
|
|
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)
|
|
623
772
|
# @param id [String]
|
|
624
773
|
# @param [Hash] opts the optional parameters
|
|
625
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
626
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
627
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
628
|
-
# @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
|
|
629
778
|
# @return [Hash<String, Object>]
|
|
630
779
|
def get_flow_action(id, opts = {})
|
|
631
780
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
|
@@ -633,13 +782,13 @@ module KlaviyoAPI
|
|
|
633
782
|
end
|
|
634
783
|
|
|
635
784
|
# Get Flow Action
|
|
636
|
-
# 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`
|
|
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)
|
|
637
786
|
# @param id [String]
|
|
638
787
|
# @param [Hash] opts the optional parameters
|
|
639
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
640
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
641
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
642
|
-
# @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
|
|
643
792
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
644
793
|
def get_flow_action_with_http_info(id, opts = {})
|
|
645
794
|
if @api_client.config.debugging
|
|
@@ -649,15 +798,15 @@ module KlaviyoAPI
|
|
|
649
798
|
if @api_client.config.client_side_validation && id.nil?
|
|
650
799
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action"
|
|
651
800
|
end
|
|
652
|
-
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.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.video_asset_id", "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.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.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", "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"]
|
|
653
802
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
654
803
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
655
804
|
end
|
|
656
|
-
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.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", "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"]
|
|
657
806
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
658
807
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
659
808
|
end
|
|
660
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
809
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
661
810
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
662
811
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
663
812
|
end
|
|
@@ -678,7 +827,7 @@ module KlaviyoAPI
|
|
|
678
827
|
# header parameters
|
|
679
828
|
header_params = opts[:header_params] || {}
|
|
680
829
|
# klaviyo api revision
|
|
681
|
-
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"
|
|
682
831
|
# HTTP header 'Accept' (if needed)
|
|
683
832
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
684
833
|
|
|
@@ -712,14 +861,14 @@ module KlaviyoAPI
|
|
|
712
861
|
end
|
|
713
862
|
|
|
714
863
|
# Get Messages For Flow Action
|
|
715
|
-
# 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`
|
|
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)
|
|
716
865
|
# @param id [String]
|
|
717
866
|
# @param [Hash] opts the optional parameters
|
|
718
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
719
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
720
|
-
# @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
|
|
721
870
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
722
|
-
# @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
|
|
723
872
|
# @return [Hash<String, Object>]
|
|
724
873
|
def get_flow_action_messages(id, opts = {})
|
|
725
874
|
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
|
@@ -730,14 +879,14 @@ module KlaviyoAPI
|
|
|
730
879
|
alias get_messages_for_flow_action get_flow_action_messages
|
|
731
880
|
|
|
732
881
|
# Get Messages For Flow Action
|
|
733
|
-
# 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`
|
|
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)
|
|
734
883
|
# @param id [String]
|
|
735
884
|
# @param [Hash] opts the optional parameters
|
|
736
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
737
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
738
|
-
# @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
|
|
739
888
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
740
|
-
# @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
|
|
741
890
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
742
891
|
def get_flow_action_messages_with_http_info(id, opts = {})
|
|
743
892
|
if @api_client.config.debugging
|
|
@@ -747,7 +896,7 @@ module KlaviyoAPI
|
|
|
747
896
|
if @api_client.config.client_side_validation && id.nil?
|
|
748
897
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_messages"
|
|
749
898
|
end
|
|
750
|
-
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.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", "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"]
|
|
751
900
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
752
901
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
753
902
|
end
|
|
@@ -777,7 +926,7 @@ module KlaviyoAPI
|
|
|
777
926
|
# header parameters
|
|
778
927
|
header_params = opts[:header_params] || {}
|
|
779
928
|
# klaviyo api revision
|
|
780
|
-
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"
|
|
781
930
|
# HTTP header 'Accept' (if needed)
|
|
782
931
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
783
932
|
|
|
@@ -814,10 +963,10 @@ module KlaviyoAPI
|
|
|
814
963
|
alias get_messages_for_flow_action_with_http_info get_flow_action_messages_with_http_info
|
|
815
964
|
|
|
816
965
|
# Get Flow for Flow Action
|
|
817
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
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)
|
|
818
967
|
# @param id [String]
|
|
819
968
|
# @param [Hash] opts the optional parameters
|
|
820
|
-
# @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
|
|
821
970
|
# @return [Hash<String, Object>]
|
|
822
971
|
def get_flow_for_flow_action(id, opts = {})
|
|
823
972
|
data, _status_code, _headers = get_flow_for_flow_action_with_http_info(id, opts)
|
|
@@ -828,10 +977,10 @@ module KlaviyoAPI
|
|
|
828
977
|
alias get_flow_action_flow get_flow_for_flow_action
|
|
829
978
|
|
|
830
979
|
# Get Flow for Flow Action
|
|
831
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
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)
|
|
832
981
|
# @param id [String]
|
|
833
982
|
# @param [Hash] opts the optional parameters
|
|
834
|
-
# @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
|
|
835
984
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
836
985
|
def get_flow_for_flow_action_with_http_info(id, opts = {})
|
|
837
986
|
if @api_client.config.debugging
|
|
@@ -841,7 +990,7 @@ module KlaviyoAPI
|
|
|
841
990
|
if @api_client.config.client_side_validation && id.nil?
|
|
842
991
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_for_flow_action"
|
|
843
992
|
end
|
|
844
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
993
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
845
994
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
846
995
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
847
996
|
end
|
|
@@ -855,7 +1004,7 @@ module KlaviyoAPI
|
|
|
855
1004
|
# header parameters
|
|
856
1005
|
header_params = opts[:header_params] || {}
|
|
857
1006
|
# klaviyo api revision
|
|
858
|
-
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"
|
|
859
1008
|
# HTTP header 'Accept' (if needed)
|
|
860
1009
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
861
1010
|
|
|
@@ -892,7 +1041,7 @@ module KlaviyoAPI
|
|
|
892
1041
|
alias get_flow_action_flow_with_http_info get_flow_for_flow_action_with_http_info
|
|
893
1042
|
|
|
894
1043
|
# Get Flow ID for Flow Action
|
|
895
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
1044
|
+
# 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_id_for_flow_action.json)
|
|
896
1045
|
# @param id [String]
|
|
897
1046
|
# @param [Hash] opts the optional parameters
|
|
898
1047
|
# @return [Hash<String, Object>]
|
|
@@ -905,7 +1054,7 @@ module KlaviyoAPI
|
|
|
905
1054
|
alias get_flow_action_relationships_flow get_flow_id_for_flow_action
|
|
906
1055
|
|
|
907
1056
|
# Get Flow ID for Flow Action
|
|
908
|
-
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
|
1057
|
+
# 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_id_for_flow_action.json)
|
|
909
1058
|
# @param id [String]
|
|
910
1059
|
# @param [Hash] opts the optional parameters
|
|
911
1060
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -926,7 +1075,7 @@ module KlaviyoAPI
|
|
|
926
1075
|
# header parameters
|
|
927
1076
|
header_params = opts[:header_params] || {}
|
|
928
1077
|
# klaviyo api revision
|
|
929
|
-
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"
|
|
930
1079
|
# HTTP header 'Accept' (if needed)
|
|
931
1080
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
932
1081
|
|
|
@@ -963,13 +1112,13 @@ module KlaviyoAPI
|
|
|
963
1112
|
alias get_flow_action_relationships_flow_with_http_info get_flow_id_for_flow_action_with_http_info
|
|
964
1113
|
|
|
965
1114
|
# Get Flow Message
|
|
966
|
-
# 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`
|
|
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)
|
|
967
1116
|
# @param id [String]
|
|
968
1117
|
# @param [Hash] opts the optional parameters
|
|
969
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
970
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
971
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
972
|
-
# @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
|
|
973
1122
|
# @return [Hash<String, Object>]
|
|
974
1123
|
def get_flow_message(id, opts = {})
|
|
975
1124
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
|
@@ -977,13 +1126,13 @@ module KlaviyoAPI
|
|
|
977
1126
|
end
|
|
978
1127
|
|
|
979
1128
|
# Get Flow Message
|
|
980
|
-
# 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`
|
|
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)
|
|
981
1130
|
# @param id [String]
|
|
982
1131
|
# @param [Hash] opts the optional parameters
|
|
983
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
984
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
985
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
986
|
-
# @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
|
|
987
1136
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
988
1137
|
def get_flow_message_with_http_info(id, opts = {})
|
|
989
1138
|
if @api_client.config.debugging
|
|
@@ -993,15 +1142,15 @@ module KlaviyoAPI
|
|
|
993
1142
|
if @api_client.config.client_side_validation && id.nil?
|
|
994
1143
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message"
|
|
995
1144
|
end
|
|
996
|
-
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.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.video_asset_id", "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.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.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", "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"]
|
|
997
1146
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
998
1147
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
999
1148
|
end
|
|
1000
|
-
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.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", "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"]
|
|
1001
1150
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
1002
1151
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
1003
1152
|
end
|
|
1004
|
-
allowable_values = ["amp", "created", "editor_type", "html", "name", "text", "updated"]
|
|
1153
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "screenshot_url", "text", "updated"]
|
|
1005
1154
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
1006
1155
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
1007
1156
|
end
|
|
@@ -1022,7 +1171,7 @@ module KlaviyoAPI
|
|
|
1022
1171
|
# header parameters
|
|
1023
1172
|
header_params = opts[:header_params] || {}
|
|
1024
1173
|
# klaviyo api revision
|
|
1025
|
-
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"
|
|
1026
1175
|
# HTTP header 'Accept' (if needed)
|
|
1027
1176
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1028
1177
|
|
|
@@ -1056,16 +1205,16 @@ module KlaviyoAPI
|
|
|
1056
1205
|
end
|
|
1057
1206
|
|
|
1058
1207
|
# Get Flows
|
|
1059
|
-
# 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`
|
|
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)
|
|
1060
1209
|
# @param [Hash] opts the optional parameters
|
|
1061
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1062
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1063
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1064
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1065
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1066
|
-
# @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
|
|
1067
1216
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1068
|
-
# @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
|
|
1069
1218
|
# @return [Hash<String, Object>]
|
|
1070
1219
|
def get_flows(opts = {})
|
|
1071
1220
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
|
@@ -1073,30 +1222,30 @@ module KlaviyoAPI
|
|
|
1073
1222
|
end
|
|
1074
1223
|
|
|
1075
1224
|
# Get Flows
|
|
1076
|
-
# 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`
|
|
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)
|
|
1077
1226
|
# @param [Hash] opts the optional parameters
|
|
1078
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1079
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1080
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1081
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1082
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1083
|
-
# @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
|
|
1084
1233
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1085
|
-
# @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
|
|
1086
1235
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1087
1236
|
def get_flows_with_http_info(opts = {})
|
|
1088
1237
|
if @api_client.config.debugging
|
|
1089
1238
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flows ...'
|
|
1090
1239
|
end
|
|
1091
|
-
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.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.video_asset_id", "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.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.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", "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"]
|
|
1092
1241
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
1093
1242
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
1094
1243
|
end
|
|
1095
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
1244
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
1096
1245
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
1097
1246
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
1098
1247
|
end
|
|
1099
|
-
allowable_values = ["name"]
|
|
1248
|
+
allowable_values = ["id", "name"]
|
|
1100
1249
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
1101
1250
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
1102
1251
|
end
|
|
@@ -1133,7 +1282,7 @@ module KlaviyoAPI
|
|
|
1133
1282
|
# header parameters
|
|
1134
1283
|
header_params = opts[:header_params] || {}
|
|
1135
1284
|
# klaviyo api revision
|
|
1136
|
-
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"
|
|
1137
1286
|
# HTTP header 'Accept' (if needed)
|
|
1138
1287
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1139
1288
|
|
|
@@ -1167,13 +1316,13 @@ module KlaviyoAPI
|
|
|
1167
1316
|
end
|
|
1168
1317
|
|
|
1169
1318
|
# Get Message IDs for Flow Action
|
|
1170
|
-
# 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`
|
|
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)
|
|
1171
1320
|
# @param id [String]
|
|
1172
1321
|
# @param [Hash] opts the optional parameters
|
|
1173
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1174
|
-
# @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
|
|
1175
1324
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1176
|
-
# @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
|
|
1177
1326
|
# @return [Hash<String, Object>]
|
|
1178
1327
|
def get_message_ids_for_flow_action(id, opts = {})
|
|
1179
1328
|
data, _status_code, _headers = get_message_ids_for_flow_action_with_http_info(id, opts)
|
|
@@ -1184,13 +1333,13 @@ module KlaviyoAPI
|
|
|
1184
1333
|
alias get_flow_action_relationships_messages get_message_ids_for_flow_action
|
|
1185
1334
|
|
|
1186
1335
|
# Get Message IDs for Flow Action
|
|
1187
|
-
# 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`
|
|
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)
|
|
1188
1337
|
# @param id [String]
|
|
1189
1338
|
# @param [Hash] opts the optional parameters
|
|
1190
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1191
|
-
# @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
|
|
1192
1341
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1193
|
-
# @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
|
|
1194
1343
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1195
1344
|
def get_message_ids_for_flow_action_with_http_info(id, opts = {})
|
|
1196
1345
|
if @api_client.config.debugging
|
|
@@ -1225,7 +1374,7 @@ module KlaviyoAPI
|
|
|
1225
1374
|
# header parameters
|
|
1226
1375
|
header_params = opts[:header_params] || {}
|
|
1227
1376
|
# klaviyo api revision
|
|
1228
|
-
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"
|
|
1229
1378
|
# HTTP header 'Accept' (if needed)
|
|
1230
1379
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1231
1380
|
|
|
@@ -1262,7 +1411,7 @@ module KlaviyoAPI
|
|
|
1262
1411
|
alias get_flow_action_relationships_messages_with_http_info get_message_ids_for_flow_action_with_http_info
|
|
1263
1412
|
|
|
1264
1413
|
# Get Tag IDs for Flow
|
|
1265
|
-
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
|
1414
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_flow.json)
|
|
1266
1415
|
# @param id [String]
|
|
1267
1416
|
# @param [Hash] opts the optional parameters
|
|
1268
1417
|
# @return [Hash<String, Object>]
|
|
@@ -1275,7 +1424,7 @@ module KlaviyoAPI
|
|
|
1275
1424
|
alias get_flow_relationships_tags get_tag_ids_for_flow
|
|
1276
1425
|
|
|
1277
1426
|
# Get Tag IDs for Flow
|
|
1278
|
-
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
|
1427
|
+
# Return the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_flow.json)
|
|
1279
1428
|
# @param id [String]
|
|
1280
1429
|
# @param [Hash] opts the optional parameters
|
|
1281
1430
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1296,7 +1445,7 @@ module KlaviyoAPI
|
|
|
1296
1445
|
# header parameters
|
|
1297
1446
|
header_params = opts[:header_params] || {}
|
|
1298
1447
|
# klaviyo api revision
|
|
1299
|
-
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"
|
|
1300
1449
|
# HTTP header 'Accept' (if needed)
|
|
1301
1450
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1302
1451
|
|
|
@@ -1333,10 +1482,10 @@ module KlaviyoAPI
|
|
|
1333
1482
|
alias get_flow_relationships_tags_with_http_info get_tag_ids_for_flow_with_http_info
|
|
1334
1483
|
|
|
1335
1484
|
# Get Tags for Flow
|
|
1336
|
-
# 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`
|
|
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)
|
|
1337
1486
|
# @param id [String]
|
|
1338
1487
|
# @param [Hash] opts the optional parameters
|
|
1339
|
-
# @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
|
|
1340
1489
|
# @return [Hash<String, Object>]
|
|
1341
1490
|
def get_tags_for_flow(id, opts = {})
|
|
1342
1491
|
data, _status_code, _headers = get_tags_for_flow_with_http_info(id, opts)
|
|
@@ -1347,10 +1496,10 @@ module KlaviyoAPI
|
|
|
1347
1496
|
alias get_flow_tags get_tags_for_flow
|
|
1348
1497
|
|
|
1349
1498
|
# Get Tags for Flow
|
|
1350
|
-
# 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`
|
|
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)
|
|
1351
1500
|
# @param id [String]
|
|
1352
1501
|
# @param [Hash] opts the optional parameters
|
|
1353
|
-
# @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
|
|
1354
1503
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1355
1504
|
def get_tags_for_flow_with_http_info(id, opts = {})
|
|
1356
1505
|
if @api_client.config.debugging
|
|
@@ -1360,7 +1509,7 @@ module KlaviyoAPI
|
|
|
1360
1509
|
if @api_client.config.client_side_validation && id.nil?
|
|
1361
1510
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_tags_for_flow"
|
|
1362
1511
|
end
|
|
1363
|
-
allowable_values = ["name"]
|
|
1512
|
+
allowable_values = ["id", "name"]
|
|
1364
1513
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
1365
1514
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
1366
1515
|
end
|
|
@@ -1374,7 +1523,7 @@ module KlaviyoAPI
|
|
|
1374
1523
|
# header parameters
|
|
1375
1524
|
header_params = opts[:header_params] || {}
|
|
1376
1525
|
# klaviyo api revision
|
|
1377
|
-
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"
|
|
1378
1527
|
# HTTP header 'Accept' (if needed)
|
|
1379
1528
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1380
1529
|
|
|
@@ -1411,10 +1560,10 @@ module KlaviyoAPI
|
|
|
1411
1560
|
alias get_flow_tags_with_http_info get_tags_for_flow_with_http_info
|
|
1412
1561
|
|
|
1413
1562
|
# Get Template for Flow Message
|
|
1414
|
-
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
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)
|
|
1415
1564
|
# @param id [String]
|
|
1416
1565
|
# @param [Hash] opts the optional parameters
|
|
1417
|
-
# @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
|
|
1418
1567
|
# @return [Hash<String, Object>]
|
|
1419
1568
|
def get_template_for_flow_message(id, opts = {})
|
|
1420
1569
|
data, _status_code, _headers = get_template_for_flow_message_with_http_info(id, opts)
|
|
@@ -1425,10 +1574,10 @@ module KlaviyoAPI
|
|
|
1425
1574
|
alias get_flow_message_template get_template_for_flow_message
|
|
1426
1575
|
|
|
1427
1576
|
# Get Template for Flow Message
|
|
1428
|
-
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
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)
|
|
1429
1578
|
# @param id [String]
|
|
1430
1579
|
# @param [Hash] opts the optional parameters
|
|
1431
|
-
# @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
|
|
1432
1581
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1433
1582
|
def get_template_for_flow_message_with_http_info(id, opts = {})
|
|
1434
1583
|
if @api_client.config.debugging
|
|
@@ -1438,7 +1587,7 @@ module KlaviyoAPI
|
|
|
1438
1587
|
if @api_client.config.client_side_validation && id.nil?
|
|
1439
1588
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_template_for_flow_message"
|
|
1440
1589
|
end
|
|
1441
|
-
allowable_values = ["amp", "created", "editor_type", "html", "name", "text", "updated"]
|
|
1590
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "screenshot_url", "text", "updated"]
|
|
1442
1591
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
1443
1592
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
1444
1593
|
end
|
|
@@ -1452,7 +1601,7 @@ module KlaviyoAPI
|
|
|
1452
1601
|
# header parameters
|
|
1453
1602
|
header_params = opts[:header_params] || {}
|
|
1454
1603
|
# klaviyo api revision
|
|
1455
|
-
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"
|
|
1456
1605
|
# HTTP header 'Accept' (if needed)
|
|
1457
1606
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1458
1607
|
|
|
@@ -1489,7 +1638,7 @@ module KlaviyoAPI
|
|
|
1489
1638
|
alias get_flow_message_template_with_http_info get_template_for_flow_message_with_http_info
|
|
1490
1639
|
|
|
1491
1640
|
# Get Template ID for Flow Message
|
|
1492
|
-
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
1641
|
+
# Returns the ID of 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_id_for_flow_message.json)
|
|
1493
1642
|
# @param id [String]
|
|
1494
1643
|
# @param [Hash] opts the optional parameters
|
|
1495
1644
|
# @return [Hash<String, Object>]
|
|
@@ -1502,7 +1651,7 @@ module KlaviyoAPI
|
|
|
1502
1651
|
alias get_flow_message_relationships_template get_template_id_for_flow_message
|
|
1503
1652
|
|
|
1504
1653
|
# Get Template ID for Flow Message
|
|
1505
|
-
# Returns the ID of the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
|
1654
|
+
# Returns the ID of 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_id_for_flow_message.json)
|
|
1506
1655
|
# @param id [String]
|
|
1507
1656
|
# @param [Hash] opts the optional parameters
|
|
1508
1657
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1523,7 +1672,7 @@ module KlaviyoAPI
|
|
|
1523
1672
|
# header parameters
|
|
1524
1673
|
header_params = opts[:header_params] || {}
|
|
1525
1674
|
# klaviyo api revision
|
|
1526
|
-
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"
|
|
1527
1676
|
# HTTP header 'Accept' (if needed)
|
|
1528
1677
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1529
1678
|
|
|
@@ -1560,10 +1709,11 @@ module KlaviyoAPI
|
|
|
1560
1709
|
alias get_flow_message_relationships_template_with_http_info get_template_id_for_flow_message_with_http_info
|
|
1561
1710
|
|
|
1562
1711
|
# Update Flow Status
|
|
1563
|
-
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
1712
|
+
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow.json)
|
|
1564
1713
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
|
1565
1714
|
# @param flow_update_query [FlowUpdateQuery]
|
|
1566
1715
|
# @param [Hash] opts the optional parameters
|
|
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
|
|
1567
1717
|
# @return [Hash<String, Object>]
|
|
1568
1718
|
def update_flow(id, flow_update_query, opts = {})
|
|
1569
1719
|
data, _status_code, _headers = update_flow_with_http_info(id, flow_update_query, opts)
|
|
@@ -1571,10 +1721,11 @@ module KlaviyoAPI
|
|
|
1571
1721
|
end
|
|
1572
1722
|
|
|
1573
1723
|
# Update Flow Status
|
|
1574
|
-
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
1724
|
+
# Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow.json)
|
|
1575
1725
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
|
1576
1726
|
# @param flow_update_query [FlowUpdateQuery]
|
|
1577
1727
|
# @param [Hash] opts the optional parameters
|
|
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
|
|
1578
1729
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1579
1730
|
def update_flow_with_http_info(id, flow_update_query, opts = {})
|
|
1580
1731
|
if @api_client.config.debugging
|
|
@@ -1588,16 +1739,21 @@ module KlaviyoAPI
|
|
|
1588
1739
|
if @api_client.config.client_side_validation && flow_update_query.nil?
|
|
1589
1740
|
fail ArgumentError, "Missing the required parameter 'flow_update_query' when calling FlowsApi.update_flow"
|
|
1590
1741
|
end
|
|
1742
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
1743
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
1744
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
1745
|
+
end
|
|
1591
1746
|
# resource path
|
|
1592
1747
|
local_var_path = '/api/flows/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1593
1748
|
|
|
1594
1749
|
# query parameters
|
|
1595
1750
|
query_params = opts[:query_params] || {}
|
|
1751
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
|
1596
1752
|
|
|
1597
1753
|
# header parameters
|
|
1598
1754
|
header_params = opts[:header_params] || {}
|
|
1599
1755
|
# klaviyo api revision
|
|
1600
|
-
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"
|
|
1601
1757
|
# HTTP header 'Accept' (if needed)
|
|
1602
1758
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1603
1759
|
# HTTP header 'Content-Type'
|
|
@@ -1636,10 +1792,11 @@ module KlaviyoAPI
|
|
|
1636
1792
|
end
|
|
1637
1793
|
|
|
1638
1794
|
# Update Flow Action
|
|
1639
|
-
# Update a flow action.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
1795
|
+
# Update a flow action.<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/update_flow_action.json)
|
|
1640
1796
|
# @param id [String]
|
|
1641
1797
|
# @param flow_action_update_query [FlowActionUpdateQuery]
|
|
1642
1798
|
# @param [Hash] opts the optional parameters
|
|
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
|
|
1643
1800
|
# @return [Hash<String, Object>]
|
|
1644
1801
|
def update_flow_action(id, flow_action_update_query, opts = {})
|
|
1645
1802
|
data, _status_code, _headers = update_flow_action_with_http_info(id, flow_action_update_query, opts)
|
|
@@ -1647,10 +1804,11 @@ module KlaviyoAPI
|
|
|
1647
1804
|
end
|
|
1648
1805
|
|
|
1649
1806
|
# Update Flow Action
|
|
1650
|
-
# Update a flow action.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
1807
|
+
# Update a flow action.<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/update_flow_action.json)
|
|
1651
1808
|
# @param id [String]
|
|
1652
1809
|
# @param flow_action_update_query [FlowActionUpdateQuery]
|
|
1653
1810
|
# @param [Hash] opts the optional parameters
|
|
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
|
|
1654
1812
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1655
1813
|
def update_flow_action_with_http_info(id, flow_action_update_query, opts = {})
|
|
1656
1814
|
if @api_client.config.debugging
|
|
@@ -1664,16 +1822,21 @@ module KlaviyoAPI
|
|
|
1664
1822
|
if @api_client.config.client_side_validation && flow_action_update_query.nil?
|
|
1665
1823
|
fail ArgumentError, "Missing the required parameter 'flow_action_update_query' when calling FlowsApi.update_flow_action"
|
|
1666
1824
|
end
|
|
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"]
|
|
1826
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
1827
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
1828
|
+
end
|
|
1667
1829
|
# resource path
|
|
1668
1830
|
local_var_path = '/api/flow-actions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1669
1831
|
|
|
1670
1832
|
# query parameters
|
|
1671
1833
|
query_params = opts[:query_params] || {}
|
|
1834
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
|
1672
1835
|
|
|
1673
1836
|
# header parameters
|
|
1674
1837
|
header_params = opts[:header_params] || {}
|
|
1675
1838
|
# klaviyo api revision
|
|
1676
|
-
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"
|
|
1677
1840
|
# HTTP header 'Accept' (if needed)
|
|
1678
1841
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1679
1842
|
# HTTP header 'Content-Type'
|