klaviyo-api-sdk 17.0.0 → 18.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 +22 -0
- data/README.md +932 -414
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +215 -155
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +585 -381
- data/lib/klaviyo-api-sdk/api/client_api.rb +100 -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 +2755 -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 +238 -152
- data/lib/klaviyo-api-sdk/api/forms_api.rb +81 -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 +113 -60
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +24 -17
- 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/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/age_gate_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +301 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +11 -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/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +25 -3
- data/lib/klaviyo-api-sdk/models/{action_output_condition_filter2.rb → button_styles_height.rb} +3 -7
- data/lib/klaviyo-api-sdk/models/cart_content.rb +277 -0
- data/lib/klaviyo-api-sdk/models/cart_content_properties.rb +236 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +11 -1
- 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/constant_property_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_filter2.rb → constant_property_mapping_value.rb} +6 -16
- 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/{low_inventory_condition_filter2.rb → content_experiment_action_data_main_action.rb} +3 -16
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_css.rb +231 -0
- data/lib/klaviyo-api-sdk/models/custom_html.rb +292 -0
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +263 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +450 -0
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_object_relationship_source.rb +328 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/display_options.rb +24 -4
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/email_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -9
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -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/event_create_query_v2_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +14 -1
- 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_push_notification.rb +14 -4
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +15 -2
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen.rb +305 -0
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_block_cropping_properties.rb +0 -35
- data/lib/klaviyo-api-sdk/models/image_properties.rb +11 -1
- 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/{low_inventory_condition_filter.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/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/mobile_push_content_create.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +2 -1
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +5 -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/{flow_push_notification_additional_filters_condition_groups_inner.rb → object_record_delete_job_create_query_resource_object_relationships.rb} +13 -15
- 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/object_record_delete_job_rels_records_data_inner.rb +238 -0
- 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/{metric_property_condition_condition_group.rb → object_schema_relationship_create_query.rb} +14 -14
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters_condition_groups_inner.rb → object_schema_relationship_create_query_data_inner.rb} +37 -15
- 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/object_type_create_query_resource_object_attributes.rb +307 -0
- 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_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/open_tracking_subscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/open_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/patch_identifiers.rb +227 -0
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +11 -1
- 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/{flow_sms_additional_filters.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 +19 -9
- 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_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_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_relationship_source.rb +330 -0
- data/lib/klaviyo-api-sdk/models/property_filter.rb +237 -0
- data/lib/klaviyo-api-sdk/models/property_source.rb +254 -0
- data/lib/klaviyo-api-sdk/models/push_action_button.rb +1 -5
- data/lib/klaviyo-api-sdk/models/push_action_button_definition.rb +261 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_web_url.rb +268 -0
- data/lib/klaviyo-api-sdk/models/quote_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +11 -1
- 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 +11 -1
- data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/simple_property_mapping.rb +287 -0
- 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/sms_consent_checkbox_properties.rb +11 -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 +11 -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/source_mapping_create_query_resource_object_attributes.rb +235 -0
- 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/spin_to_win_properties.rb +11 -1
- 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/template_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +11 -1
- 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.rb +86 -23
- data/lib/klaviyo-api-sdk.rb.bak +87 -24
- metadata +88 -25
- 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/metric_property_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +0 -225
|
@@ -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-07-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-07-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-07-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'
|
|
@@ -96,7 +103,7 @@ module KlaviyoAPI
|
|
|
96
103
|
end
|
|
97
104
|
|
|
98
105
|
# 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`
|
|
106
|
+
# 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
107
|
# @param id [String] ID of the Flow to delete. Ex: XVTP5Q
|
|
101
108
|
# @param [Hash] opts the optional parameters
|
|
102
109
|
# @return [nil]
|
|
@@ -106,7 +113,7 @@ module KlaviyoAPI
|
|
|
106
113
|
end
|
|
107
114
|
|
|
108
115
|
# 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`
|
|
116
|
+
# 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
117
|
# @param id [String] ID of the Flow to delete. Ex: XVTP5Q
|
|
111
118
|
# @param [Hash] opts the optional parameters
|
|
112
119
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -127,7 +134,7 @@ module KlaviyoAPI
|
|
|
127
134
|
# header parameters
|
|
128
135
|
header_params = opts[:header_params] || {}
|
|
129
136
|
# klaviyo api revision
|
|
130
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
137
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
131
138
|
# HTTP header 'Accept' (if needed)
|
|
132
139
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
133
140
|
|
|
@@ -160,11 +167,76 @@ module KlaviyoAPI
|
|
|
160
167
|
return data, status_code, headers
|
|
161
168
|
end
|
|
162
169
|
|
|
170
|
+
# Delete Flow Action
|
|
171
|
+
# 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)
|
|
172
|
+
# @param id [String] ID of the flow action to delete. Ex: 01GDDKASAP8TKDDA2GRZDSVP4H
|
|
173
|
+
# @param [Hash] opts the optional parameters
|
|
174
|
+
# @return [nil]
|
|
175
|
+
def delete_flow_action(id, opts = {})
|
|
176
|
+
delete_flow_action_with_http_info(id, opts)
|
|
177
|
+
nil
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
# Delete Flow Action
|
|
181
|
+
# 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)
|
|
182
|
+
# @param id [String] ID of the flow action to delete. Ex: 01GDDKASAP8TKDDA2GRZDSVP4H
|
|
183
|
+
# @param [Hash] opts the optional parameters
|
|
184
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
185
|
+
def delete_flow_action_with_http_info(id, opts = {})
|
|
186
|
+
if @api_client.config.debugging
|
|
187
|
+
@api_client.config.logger.debug 'Calling API: FlowsApi.delete_flow_action ...'
|
|
188
|
+
end
|
|
189
|
+
# verify the required parameter 'id' is set
|
|
190
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
191
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.delete_flow_action"
|
|
192
|
+
end
|
|
193
|
+
# resource path
|
|
194
|
+
local_var_path = '/api/flow-actions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
195
|
+
|
|
196
|
+
# query parameters
|
|
197
|
+
query_params = opts[:query_params] || {}
|
|
198
|
+
|
|
199
|
+
# header parameters
|
|
200
|
+
header_params = opts[:header_params] || {}
|
|
201
|
+
# klaviyo api revision
|
|
202
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
203
|
+
# HTTP header 'Accept' (if needed)
|
|
204
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
205
|
+
|
|
206
|
+
# form parameters
|
|
207
|
+
form_params = opts[:form_params] || {}
|
|
208
|
+
|
|
209
|
+
# http body (model)
|
|
210
|
+
post_body = opts[:debug_body]
|
|
211
|
+
|
|
212
|
+
# return_type
|
|
213
|
+
return_type = opts[:debug_return_type]
|
|
214
|
+
|
|
215
|
+
# auth_names
|
|
216
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
217
|
+
|
|
218
|
+
new_options = opts.merge(
|
|
219
|
+
:operation => :"FlowsApi.delete_flow_action",
|
|
220
|
+
:header_params => header_params,
|
|
221
|
+
:query_params => query_params,
|
|
222
|
+
:form_params => form_params,
|
|
223
|
+
:body => post_body,
|
|
224
|
+
:auth_names => auth_names,
|
|
225
|
+
:return_type => return_type
|
|
226
|
+
)
|
|
227
|
+
|
|
228
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
229
|
+
if @api_client.config.debugging
|
|
230
|
+
@api_client.config.logger.debug "API called: FlowsApi#delete_flow_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
231
|
+
end
|
|
232
|
+
return data, status_code, headers
|
|
233
|
+
end
|
|
234
|
+
|
|
163
235
|
# 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`
|
|
236
|
+
# 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
237
|
# @param id [String]
|
|
166
238
|
# @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-
|
|
239
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
168
240
|
# @return [Hash<String, Object>]
|
|
169
241
|
def get_action_for_flow_message(id, opts = {})
|
|
170
242
|
data, _status_code, _headers = get_action_for_flow_message_with_http_info(id, opts)
|
|
@@ -175,10 +247,10 @@ module KlaviyoAPI
|
|
|
175
247
|
alias get_flow_message_action get_action_for_flow_message
|
|
176
248
|
|
|
177
249
|
# 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`
|
|
250
|
+
# 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
251
|
# @param id [String]
|
|
180
252
|
# @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-
|
|
253
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
182
254
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
183
255
|
def get_action_for_flow_message_with_http_info(id, opts = {})
|
|
184
256
|
if @api_client.config.debugging
|
|
@@ -188,7 +260,7 @@ module KlaviyoAPI
|
|
|
188
260
|
if @api_client.config.client_side_validation && id.nil?
|
|
189
261
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_action_for_flow_message"
|
|
190
262
|
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"]
|
|
263
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
192
264
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
193
265
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
194
266
|
end
|
|
@@ -202,7 +274,7 @@ module KlaviyoAPI
|
|
|
202
274
|
# header parameters
|
|
203
275
|
header_params = opts[:header_params] || {}
|
|
204
276
|
# klaviyo api revision
|
|
205
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
277
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
206
278
|
# HTTP header 'Accept' (if needed)
|
|
207
279
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
208
280
|
|
|
@@ -239,7 +311,7 @@ module KlaviyoAPI
|
|
|
239
311
|
alias get_flow_message_action_with_http_info get_action_for_flow_message_with_http_info
|
|
240
312
|
|
|
241
313
|
# 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`
|
|
314
|
+
# 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
315
|
# @param id [String]
|
|
244
316
|
# @param [Hash] opts the optional parameters
|
|
245
317
|
# @return [Hash<String, Object>]
|
|
@@ -252,7 +324,7 @@ module KlaviyoAPI
|
|
|
252
324
|
alias get_flow_message_relationships_action get_action_id_for_flow_message
|
|
253
325
|
|
|
254
326
|
# 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`
|
|
327
|
+
# 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
328
|
# @param id [String]
|
|
257
329
|
# @param [Hash] opts the optional parameters
|
|
258
330
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -273,7 +345,7 @@ module KlaviyoAPI
|
|
|
273
345
|
# header parameters
|
|
274
346
|
header_params = opts[:header_params] || {}
|
|
275
347
|
# klaviyo api revision
|
|
276
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
348
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
277
349
|
# HTTP header 'Accept' (if needed)
|
|
278
350
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
279
351
|
|
|
@@ -310,13 +382,13 @@ module KlaviyoAPI
|
|
|
310
382
|
alias get_flow_message_relationships_action_with_http_info get_action_id_for_flow_message_with_http_info
|
|
311
383
|
|
|
312
384
|
# 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`
|
|
385
|
+
# 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
386
|
# @param id [String]
|
|
315
387
|
# @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-
|
|
388
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
389
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
318
390
|
# @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-
|
|
391
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
320
392
|
# @return [Hash<String, Object>]
|
|
321
393
|
def get_action_ids_for_flow(id, opts = {})
|
|
322
394
|
data, _status_code, _headers = get_action_ids_for_flow_with_http_info(id, opts)
|
|
@@ -330,13 +402,13 @@ module KlaviyoAPI
|
|
|
330
402
|
alias get_flow_relationships_actions get_action_ids_for_flow
|
|
331
403
|
|
|
332
404
|
# 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`
|
|
405
|
+
# 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
406
|
# @param id [String]
|
|
335
407
|
# @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-
|
|
408
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
409
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
338
410
|
# @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-
|
|
411
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
340
412
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
341
413
|
def get_action_ids_for_flow_with_http_info(id, opts = {})
|
|
342
414
|
if @api_client.config.debugging
|
|
@@ -371,7 +443,7 @@ module KlaviyoAPI
|
|
|
371
443
|
# header parameters
|
|
372
444
|
header_params = opts[:header_params] || {}
|
|
373
445
|
# klaviyo api revision
|
|
374
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
446
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
375
447
|
# HTTP header 'Accept' (if needed)
|
|
376
448
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
377
449
|
|
|
@@ -411,14 +483,14 @@ module KlaviyoAPI
|
|
|
411
483
|
alias get_flow_relationships_actions_with_http_info get_action_ids_for_flow_with_http_info
|
|
412
484
|
|
|
413
485
|
# 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`
|
|
486
|
+
# 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
487
|
# @param id [String]
|
|
416
488
|
# @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-
|
|
489
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
490
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
491
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
420
492
|
# @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-
|
|
493
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
422
494
|
# @return [Hash<String, Object>]
|
|
423
495
|
def get_actions_for_flow(id, opts = {})
|
|
424
496
|
data, _status_code, _headers = get_actions_for_flow_with_http_info(id, opts)
|
|
@@ -432,14 +504,14 @@ module KlaviyoAPI
|
|
|
432
504
|
alias get_flow_actions get_actions_for_flow
|
|
433
505
|
|
|
434
506
|
# 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`
|
|
507
|
+
# 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
508
|
# @param id [String]
|
|
437
509
|
# @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-
|
|
510
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
511
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
512
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
441
513
|
# @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-
|
|
514
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
443
515
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
444
516
|
def get_actions_for_flow_with_http_info(id, opts = {})
|
|
445
517
|
if @api_client.config.debugging
|
|
@@ -449,7 +521,7 @@ module KlaviyoAPI
|
|
|
449
521
|
if @api_client.config.client_side_validation && id.nil?
|
|
450
522
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_actions_for_flow"
|
|
451
523
|
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"]
|
|
524
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
453
525
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
454
526
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
455
527
|
end
|
|
@@ -479,7 +551,7 @@ module KlaviyoAPI
|
|
|
479
551
|
# header parameters
|
|
480
552
|
header_params = opts[:header_params] || {}
|
|
481
553
|
# klaviyo api revision
|
|
482
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
554
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
483
555
|
# HTTP header 'Accept' (if needed)
|
|
484
556
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
485
557
|
|
|
@@ -519,14 +591,14 @@ module KlaviyoAPI
|
|
|
519
591
|
alias get_flow_actions_with_http_info get_actions_for_flow_with_http_info
|
|
520
592
|
|
|
521
593
|
# 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`
|
|
594
|
+
# 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
595
|
# @param id [String]
|
|
524
596
|
# @param [Hash] opts the optional parameters
|
|
525
597
|
# @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-
|
|
598
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
599
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
600
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
601
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
530
602
|
# @return [Hash<String, Object>]
|
|
531
603
|
def get_flow(id, opts = {})
|
|
532
604
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
|
@@ -534,14 +606,14 @@ module KlaviyoAPI
|
|
|
534
606
|
end
|
|
535
607
|
|
|
536
608
|
# 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`
|
|
609
|
+
# 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
610
|
# @param id [String]
|
|
539
611
|
# @param [Hash] opts the optional parameters
|
|
540
612
|
# @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-
|
|
613
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
614
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
615
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
616
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
545
617
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
546
618
|
def get_flow_with_http_info(id, opts = {})
|
|
547
619
|
if @api_client.config.debugging
|
|
@@ -555,15 +627,15 @@ module KlaviyoAPI
|
|
|
555
627
|
if @api_client.config.client_side_validation && opts[:'additional_fields_flow'] && !opts[:'additional_fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
556
628
|
fail ArgumentError, "invalid value for \"additional_fields_flow\", must include one of #{allowable_values}"
|
|
557
629
|
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"]
|
|
630
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
559
631
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
560
632
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
561
633
|
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"]
|
|
634
|
+
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
635
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
564
636
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
565
637
|
end
|
|
566
|
-
allowable_values = ["name"]
|
|
638
|
+
allowable_values = ["id", "name"]
|
|
567
639
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
568
640
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
569
641
|
end
|
|
@@ -585,7 +657,7 @@ module KlaviyoAPI
|
|
|
585
657
|
# header parameters
|
|
586
658
|
header_params = opts[:header_params] || {}
|
|
587
659
|
# klaviyo api revision
|
|
588
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
660
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
589
661
|
# HTTP header 'Accept' (if needed)
|
|
590
662
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
591
663
|
|
|
@@ -619,13 +691,13 @@ module KlaviyoAPI
|
|
|
619
691
|
end
|
|
620
692
|
|
|
621
693
|
# 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`
|
|
694
|
+
# 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
695
|
# @param id [String]
|
|
624
696
|
# @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-
|
|
697
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
698
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
699
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
700
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
629
701
|
# @return [Hash<String, Object>]
|
|
630
702
|
def get_flow_action(id, opts = {})
|
|
631
703
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
|
@@ -633,13 +705,13 @@ module KlaviyoAPI
|
|
|
633
705
|
end
|
|
634
706
|
|
|
635
707
|
# 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`
|
|
708
|
+
# 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
709
|
# @param id [String]
|
|
638
710
|
# @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-
|
|
711
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
712
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
713
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
714
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
643
715
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
644
716
|
def get_flow_action_with_http_info(id, opts = {})
|
|
645
717
|
if @api_client.config.debugging
|
|
@@ -649,15 +721,15 @@ module KlaviyoAPI
|
|
|
649
721
|
if @api_client.config.client_side_validation && id.nil?
|
|
650
722
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action"
|
|
651
723
|
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"]
|
|
724
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
653
725
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
654
726
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
655
727
|
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"]
|
|
728
|
+
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
657
729
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
658
730
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
659
731
|
end
|
|
660
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
732
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
661
733
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
662
734
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
663
735
|
end
|
|
@@ -678,7 +750,7 @@ module KlaviyoAPI
|
|
|
678
750
|
# header parameters
|
|
679
751
|
header_params = opts[:header_params] || {}
|
|
680
752
|
# klaviyo api revision
|
|
681
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
753
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
682
754
|
# HTTP header 'Accept' (if needed)
|
|
683
755
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
684
756
|
|
|
@@ -712,14 +784,14 @@ module KlaviyoAPI
|
|
|
712
784
|
end
|
|
713
785
|
|
|
714
786
|
# 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`
|
|
787
|
+
# 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
788
|
# @param id [String]
|
|
717
789
|
# @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-
|
|
790
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
791
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
792
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
721
793
|
# @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-
|
|
794
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
723
795
|
# @return [Hash<String, Object>]
|
|
724
796
|
def get_flow_action_messages(id, opts = {})
|
|
725
797
|
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
|
@@ -730,14 +802,14 @@ module KlaviyoAPI
|
|
|
730
802
|
alias get_messages_for_flow_action get_flow_action_messages
|
|
731
803
|
|
|
732
804
|
# 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`
|
|
805
|
+
# 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
806
|
# @param id [String]
|
|
735
807
|
# @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-
|
|
808
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
809
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
810
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
739
811
|
# @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-
|
|
812
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
741
813
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
742
814
|
def get_flow_action_messages_with_http_info(id, opts = {})
|
|
743
815
|
if @api_client.config.debugging
|
|
@@ -747,7 +819,7 @@ module KlaviyoAPI
|
|
|
747
819
|
if @api_client.config.client_side_validation && id.nil?
|
|
748
820
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_action_messages"
|
|
749
821
|
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"]
|
|
822
|
+
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
751
823
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
752
824
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
753
825
|
end
|
|
@@ -777,7 +849,7 @@ module KlaviyoAPI
|
|
|
777
849
|
# header parameters
|
|
778
850
|
header_params = opts[:header_params] || {}
|
|
779
851
|
# klaviyo api revision
|
|
780
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
852
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
781
853
|
# HTTP header 'Accept' (if needed)
|
|
782
854
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
783
855
|
|
|
@@ -814,10 +886,10 @@ module KlaviyoAPI
|
|
|
814
886
|
alias get_messages_for_flow_action_with_http_info get_flow_action_messages_with_http_info
|
|
815
887
|
|
|
816
888
|
# 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`
|
|
889
|
+
# 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
890
|
# @param id [String]
|
|
819
891
|
# @param [Hash] opts the optional parameters
|
|
820
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
892
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
821
893
|
# @return [Hash<String, Object>]
|
|
822
894
|
def get_flow_for_flow_action(id, opts = {})
|
|
823
895
|
data, _status_code, _headers = get_flow_for_flow_action_with_http_info(id, opts)
|
|
@@ -828,10 +900,10 @@ module KlaviyoAPI
|
|
|
828
900
|
alias get_flow_action_flow get_flow_for_flow_action
|
|
829
901
|
|
|
830
902
|
# 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`
|
|
903
|
+
# 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
904
|
# @param id [String]
|
|
833
905
|
# @param [Hash] opts the optional parameters
|
|
834
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
906
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
835
907
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
836
908
|
def get_flow_for_flow_action_with_http_info(id, opts = {})
|
|
837
909
|
if @api_client.config.debugging
|
|
@@ -841,7 +913,7 @@ module KlaviyoAPI
|
|
|
841
913
|
if @api_client.config.client_side_validation && id.nil?
|
|
842
914
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_for_flow_action"
|
|
843
915
|
end
|
|
844
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
916
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
845
917
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
846
918
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
847
919
|
end
|
|
@@ -855,7 +927,7 @@ module KlaviyoAPI
|
|
|
855
927
|
# header parameters
|
|
856
928
|
header_params = opts[:header_params] || {}
|
|
857
929
|
# klaviyo api revision
|
|
858
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
930
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
859
931
|
# HTTP header 'Accept' (if needed)
|
|
860
932
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
861
933
|
|
|
@@ -892,7 +964,7 @@ module KlaviyoAPI
|
|
|
892
964
|
alias get_flow_action_flow_with_http_info get_flow_for_flow_action_with_http_info
|
|
893
965
|
|
|
894
966
|
# 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`
|
|
967
|
+
# 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
968
|
# @param id [String]
|
|
897
969
|
# @param [Hash] opts the optional parameters
|
|
898
970
|
# @return [Hash<String, Object>]
|
|
@@ -905,7 +977,7 @@ module KlaviyoAPI
|
|
|
905
977
|
alias get_flow_action_relationships_flow get_flow_id_for_flow_action
|
|
906
978
|
|
|
907
979
|
# 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`
|
|
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_id_for_flow_action.json)
|
|
909
981
|
# @param id [String]
|
|
910
982
|
# @param [Hash] opts the optional parameters
|
|
911
983
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -926,7 +998,7 @@ module KlaviyoAPI
|
|
|
926
998
|
# header parameters
|
|
927
999
|
header_params = opts[:header_params] || {}
|
|
928
1000
|
# klaviyo api revision
|
|
929
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1001
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
930
1002
|
# HTTP header 'Accept' (if needed)
|
|
931
1003
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
932
1004
|
|
|
@@ -963,13 +1035,13 @@ module KlaviyoAPI
|
|
|
963
1035
|
alias get_flow_action_relationships_flow_with_http_info get_flow_id_for_flow_action_with_http_info
|
|
964
1036
|
|
|
965
1037
|
# 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`
|
|
1038
|
+
# 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
1039
|
# @param id [String]
|
|
968
1040
|
# @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-
|
|
1041
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1042
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1043
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1044
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
973
1045
|
# @return [Hash<String, Object>]
|
|
974
1046
|
def get_flow_message(id, opts = {})
|
|
975
1047
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
|
@@ -977,13 +1049,13 @@ module KlaviyoAPI
|
|
|
977
1049
|
end
|
|
978
1050
|
|
|
979
1051
|
# 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`
|
|
1052
|
+
# 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
1053
|
# @param id [String]
|
|
982
1054
|
# @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-
|
|
1055
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1056
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1057
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1058
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
987
1059
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
988
1060
|
def get_flow_message_with_http_info(id, opts = {})
|
|
989
1061
|
if @api_client.config.debugging
|
|
@@ -993,15 +1065,15 @@ module KlaviyoAPI
|
|
|
993
1065
|
if @api_client.config.client_side_validation && id.nil?
|
|
994
1066
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_flow_message"
|
|
995
1067
|
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"]
|
|
1068
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
997
1069
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
998
1070
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
999
1071
|
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"]
|
|
1072
|
+
allowable_values = ["channel", "created", "definition", "definition.action_buttons", "definition.add_info_link", "definition.add_opt_out_language", "definition.add_org_prefix", "definition.add_tracking_params", "definition.additional_filters", "definition.additional_filters.condition_groups", "definition.android_link", "definition.badge", "definition.badge_options", "definition.badge_options.badge_config", "definition.badge_options.set_from_property", "definition.badge_options.value", "definition.bcc_email", "definition.body", "definition.cc_email", "definition.conversion_metric_id", "definition.custom_tracking_params", "definition.dynamic_image", "definition.from_email", "definition.from_label", "definition.headers", "definition.id", "definition.image_id", "definition.include_contact_card", "definition.ios_link", "definition.kv_pairs", "definition.message_hierarchy", "definition.name", "definition.on_open", "definition.preview_text", "definition.push_type", "definition.reply_to_email", "definition.shorten_links", "definition.smart_sending_enabled", "definition.sms_quiet_hours_enabled", "definition.sound", "definition.subject_line", "definition.template_id", "definition.title", "definition.to_emails", "definition.transactional", "definition.url", "definition.vendor_id", "definition.video_asset_id", "definition.web_url", "id", "updated"]
|
|
1001
1073
|
if @api_client.config.client_side_validation && opts[:'fields_flow_message'] && !opts[:'fields_flow_message'].all? { |item| allowable_values.include?(item) }
|
|
1002
1074
|
fail ArgumentError, "invalid value for \"fields_flow_message\", must include one of #{allowable_values}"
|
|
1003
1075
|
end
|
|
1004
|
-
allowable_values = ["amp", "created", "editor_type", "html", "name", "text", "updated"]
|
|
1076
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "text", "updated"]
|
|
1005
1077
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
1006
1078
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
1007
1079
|
end
|
|
@@ -1022,7 +1094,7 @@ module KlaviyoAPI
|
|
|
1022
1094
|
# header parameters
|
|
1023
1095
|
header_params = opts[:header_params] || {}
|
|
1024
1096
|
# klaviyo api revision
|
|
1025
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1097
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1026
1098
|
# HTTP header 'Accept' (if needed)
|
|
1027
1099
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1028
1100
|
|
|
@@ -1056,16 +1128,16 @@ module KlaviyoAPI
|
|
|
1056
1128
|
end
|
|
1057
1129
|
|
|
1058
1130
|
# 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`
|
|
1131
|
+
# 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
1132
|
# @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-
|
|
1133
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1134
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1135
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1136
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
|
1137
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1138
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1067
1139
|
# @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-
|
|
1140
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1069
1141
|
# @return [Hash<String, Object>]
|
|
1070
1142
|
def get_flows(opts = {})
|
|
1071
1143
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
|
@@ -1073,30 +1145,30 @@ module KlaviyoAPI
|
|
|
1073
1145
|
end
|
|
1074
1146
|
|
|
1075
1147
|
# 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`
|
|
1148
|
+
# 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
1149
|
# @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-
|
|
1150
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1151
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1152
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1153
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
|
1154
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1155
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1084
1156
|
# @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-
|
|
1157
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1086
1158
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1087
1159
|
def get_flows_with_http_info(opts = {})
|
|
1088
1160
|
if @api_client.config.debugging
|
|
1089
1161
|
@api_client.config.logger.debug 'Calling API: FlowsApi.get_flows ...'
|
|
1090
1162
|
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"]
|
|
1163
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1092
1164
|
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
1093
1165
|
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
1094
1166
|
end
|
|
1095
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
1167
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
1096
1168
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
1097
1169
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
1098
1170
|
end
|
|
1099
|
-
allowable_values = ["name"]
|
|
1171
|
+
allowable_values = ["id", "name"]
|
|
1100
1172
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
1101
1173
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
1102
1174
|
end
|
|
@@ -1133,7 +1205,7 @@ module KlaviyoAPI
|
|
|
1133
1205
|
# header parameters
|
|
1134
1206
|
header_params = opts[:header_params] || {}
|
|
1135
1207
|
# klaviyo api revision
|
|
1136
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1208
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1137
1209
|
# HTTP header 'Accept' (if needed)
|
|
1138
1210
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1139
1211
|
|
|
@@ -1167,13 +1239,13 @@ module KlaviyoAPI
|
|
|
1167
1239
|
end
|
|
1168
1240
|
|
|
1169
1241
|
# 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`
|
|
1242
|
+
# 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
1243
|
# @param id [String]
|
|
1172
1244
|
# @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-
|
|
1245
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
1246
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1175
1247
|
# @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-
|
|
1248
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1177
1249
|
# @return [Hash<String, Object>]
|
|
1178
1250
|
def get_message_ids_for_flow_action(id, opts = {})
|
|
1179
1251
|
data, _status_code, _headers = get_message_ids_for_flow_action_with_http_info(id, opts)
|
|
@@ -1184,13 +1256,13 @@ module KlaviyoAPI
|
|
|
1184
1256
|
alias get_flow_action_relationships_messages get_message_ids_for_flow_action
|
|
1185
1257
|
|
|
1186
1258
|
# 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`
|
|
1259
|
+
# 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
1260
|
# @param id [String]
|
|
1189
1261
|
# @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-
|
|
1262
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
1263
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1192
1264
|
# @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-
|
|
1265
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1194
1266
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1195
1267
|
def get_message_ids_for_flow_action_with_http_info(id, opts = {})
|
|
1196
1268
|
if @api_client.config.debugging
|
|
@@ -1225,7 +1297,7 @@ module KlaviyoAPI
|
|
|
1225
1297
|
# header parameters
|
|
1226
1298
|
header_params = opts[:header_params] || {}
|
|
1227
1299
|
# klaviyo api revision
|
|
1228
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1300
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1229
1301
|
# HTTP header 'Accept' (if needed)
|
|
1230
1302
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1231
1303
|
|
|
@@ -1262,7 +1334,7 @@ module KlaviyoAPI
|
|
|
1262
1334
|
alias get_flow_action_relationships_messages_with_http_info get_message_ids_for_flow_action_with_http_info
|
|
1263
1335
|
|
|
1264
1336
|
# 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`
|
|
1337
|
+
# 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
1338
|
# @param id [String]
|
|
1267
1339
|
# @param [Hash] opts the optional parameters
|
|
1268
1340
|
# @return [Hash<String, Object>]
|
|
@@ -1275,7 +1347,7 @@ module KlaviyoAPI
|
|
|
1275
1347
|
alias get_flow_relationships_tags get_tag_ids_for_flow
|
|
1276
1348
|
|
|
1277
1349
|
# 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`
|
|
1350
|
+
# 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
1351
|
# @param id [String]
|
|
1280
1352
|
# @param [Hash] opts the optional parameters
|
|
1281
1353
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1296,7 +1368,7 @@ module KlaviyoAPI
|
|
|
1296
1368
|
# header parameters
|
|
1297
1369
|
header_params = opts[:header_params] || {}
|
|
1298
1370
|
# klaviyo api revision
|
|
1299
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1371
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1300
1372
|
# HTTP header 'Accept' (if needed)
|
|
1301
1373
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1302
1374
|
|
|
@@ -1333,10 +1405,10 @@ module KlaviyoAPI
|
|
|
1333
1405
|
alias get_flow_relationships_tags_with_http_info get_tag_ids_for_flow_with_http_info
|
|
1334
1406
|
|
|
1335
1407
|
# 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`
|
|
1408
|
+
# 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
1409
|
# @param id [String]
|
|
1338
1410
|
# @param [Hash] opts the optional parameters
|
|
1339
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1411
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1340
1412
|
# @return [Hash<String, Object>]
|
|
1341
1413
|
def get_tags_for_flow(id, opts = {})
|
|
1342
1414
|
data, _status_code, _headers = get_tags_for_flow_with_http_info(id, opts)
|
|
@@ -1347,10 +1419,10 @@ module KlaviyoAPI
|
|
|
1347
1419
|
alias get_flow_tags get_tags_for_flow
|
|
1348
1420
|
|
|
1349
1421
|
# 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`
|
|
1422
|
+
# 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
1423
|
# @param id [String]
|
|
1352
1424
|
# @param [Hash] opts the optional parameters
|
|
1353
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1425
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1354
1426
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1355
1427
|
def get_tags_for_flow_with_http_info(id, opts = {})
|
|
1356
1428
|
if @api_client.config.debugging
|
|
@@ -1360,7 +1432,7 @@ module KlaviyoAPI
|
|
|
1360
1432
|
if @api_client.config.client_side_validation && id.nil?
|
|
1361
1433
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_tags_for_flow"
|
|
1362
1434
|
end
|
|
1363
|
-
allowable_values = ["name"]
|
|
1435
|
+
allowable_values = ["id", "name"]
|
|
1364
1436
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
1365
1437
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
1366
1438
|
end
|
|
@@ -1374,7 +1446,7 @@ module KlaviyoAPI
|
|
|
1374
1446
|
# header parameters
|
|
1375
1447
|
header_params = opts[:header_params] || {}
|
|
1376
1448
|
# klaviyo api revision
|
|
1377
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1449
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1378
1450
|
# HTTP header 'Accept' (if needed)
|
|
1379
1451
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1380
1452
|
|
|
@@ -1411,10 +1483,10 @@ module KlaviyoAPI
|
|
|
1411
1483
|
alias get_flow_tags_with_http_info get_tags_for_flow_with_http_info
|
|
1412
1484
|
|
|
1413
1485
|
# 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`
|
|
1486
|
+
# 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
1487
|
# @param id [String]
|
|
1416
1488
|
# @param [Hash] opts the optional parameters
|
|
1417
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1489
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1418
1490
|
# @return [Hash<String, Object>]
|
|
1419
1491
|
def get_template_for_flow_message(id, opts = {})
|
|
1420
1492
|
data, _status_code, _headers = get_template_for_flow_message_with_http_info(id, opts)
|
|
@@ -1425,10 +1497,10 @@ module KlaviyoAPI
|
|
|
1425
1497
|
alias get_flow_message_template get_template_for_flow_message
|
|
1426
1498
|
|
|
1427
1499
|
# 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`
|
|
1500
|
+
# 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
1501
|
# @param id [String]
|
|
1430
1502
|
# @param [Hash] opts the optional parameters
|
|
1431
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1503
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1432
1504
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1433
1505
|
def get_template_for_flow_message_with_http_info(id, opts = {})
|
|
1434
1506
|
if @api_client.config.debugging
|
|
@@ -1438,7 +1510,7 @@ module KlaviyoAPI
|
|
|
1438
1510
|
if @api_client.config.client_side_validation && id.nil?
|
|
1439
1511
|
fail ArgumentError, "Missing the required parameter 'id' when calling FlowsApi.get_template_for_flow_message"
|
|
1440
1512
|
end
|
|
1441
|
-
allowable_values = ["amp", "created", "editor_type", "html", "name", "text", "updated"]
|
|
1513
|
+
allowable_values = ["amp", "created", "editor_type", "html", "id", "name", "text", "updated"]
|
|
1442
1514
|
if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
|
|
1443
1515
|
fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
|
|
1444
1516
|
end
|
|
@@ -1452,7 +1524,7 @@ module KlaviyoAPI
|
|
|
1452
1524
|
# header parameters
|
|
1453
1525
|
header_params = opts[:header_params] || {}
|
|
1454
1526
|
# klaviyo api revision
|
|
1455
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1527
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1456
1528
|
# HTTP header 'Accept' (if needed)
|
|
1457
1529
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1458
1530
|
|
|
@@ -1489,7 +1561,7 @@ module KlaviyoAPI
|
|
|
1489
1561
|
alias get_flow_message_template_with_http_info get_template_for_flow_message_with_http_info
|
|
1490
1562
|
|
|
1491
1563
|
# 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`
|
|
1564
|
+
# 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
1565
|
# @param id [String]
|
|
1494
1566
|
# @param [Hash] opts the optional parameters
|
|
1495
1567
|
# @return [Hash<String, Object>]
|
|
@@ -1502,7 +1574,7 @@ module KlaviyoAPI
|
|
|
1502
1574
|
alias get_flow_message_relationships_template get_template_id_for_flow_message
|
|
1503
1575
|
|
|
1504
1576
|
# 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`
|
|
1577
|
+
# 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
1578
|
# @param id [String]
|
|
1507
1579
|
# @param [Hash] opts the optional parameters
|
|
1508
1580
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1523,7 +1595,7 @@ module KlaviyoAPI
|
|
|
1523
1595
|
# header parameters
|
|
1524
1596
|
header_params = opts[:header_params] || {}
|
|
1525
1597
|
# klaviyo api revision
|
|
1526
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1598
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1527
1599
|
# HTTP header 'Accept' (if needed)
|
|
1528
1600
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1529
1601
|
|
|
@@ -1560,10 +1632,11 @@ module KlaviyoAPI
|
|
|
1560
1632
|
alias get_flow_message_relationships_template_with_http_info get_template_id_for_flow_message_with_http_info
|
|
1561
1633
|
|
|
1562
1634
|
# 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`
|
|
1635
|
+
# 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
1636
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
|
1565
1637
|
# @param flow_update_query [FlowUpdateQuery]
|
|
1566
1638
|
# @param [Hash] opts the optional parameters
|
|
1639
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1567
1640
|
# @return [Hash<String, Object>]
|
|
1568
1641
|
def update_flow(id, flow_update_query, opts = {})
|
|
1569
1642
|
data, _status_code, _headers = update_flow_with_http_info(id, flow_update_query, opts)
|
|
@@ -1571,10 +1644,11 @@ module KlaviyoAPI
|
|
|
1571
1644
|
end
|
|
1572
1645
|
|
|
1573
1646
|
# 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`
|
|
1647
|
+
# 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
1648
|
# @param id [String] ID of the Flow to update. Ex: XVTP5Q
|
|
1576
1649
|
# @param flow_update_query [FlowUpdateQuery]
|
|
1577
1650
|
# @param [Hash] opts the optional parameters
|
|
1651
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1578
1652
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1579
1653
|
def update_flow_with_http_info(id, flow_update_query, opts = {})
|
|
1580
1654
|
if @api_client.config.debugging
|
|
@@ -1588,16 +1662,21 @@ module KlaviyoAPI
|
|
|
1588
1662
|
if @api_client.config.client_side_validation && flow_update_query.nil?
|
|
1589
1663
|
fail ArgumentError, "Missing the required parameter 'flow_update_query' when calling FlowsApi.update_flow"
|
|
1590
1664
|
end
|
|
1665
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
1666
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
1667
|
+
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
1668
|
+
end
|
|
1591
1669
|
# resource path
|
|
1592
1670
|
local_var_path = '/api/flows/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1593
1671
|
|
|
1594
1672
|
# query parameters
|
|
1595
1673
|
query_params = opts[:query_params] || {}
|
|
1674
|
+
query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
|
|
1596
1675
|
|
|
1597
1676
|
# header parameters
|
|
1598
1677
|
header_params = opts[:header_params] || {}
|
|
1599
1678
|
# klaviyo api revision
|
|
1600
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1679
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1601
1680
|
# HTTP header 'Accept' (if needed)
|
|
1602
1681
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1603
1682
|
# HTTP header 'Content-Type'
|
|
@@ -1636,10 +1715,11 @@ module KlaviyoAPI
|
|
|
1636
1715
|
end
|
|
1637
1716
|
|
|
1638
1717
|
# Update Flow Action
|
|
1639
|
-
# Update a flow action.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
1718
|
+
# 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
1719
|
# @param id [String]
|
|
1641
1720
|
# @param flow_action_update_query [FlowActionUpdateQuery]
|
|
1642
1721
|
# @param [Hash] opts the optional parameters
|
|
1722
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1643
1723
|
# @return [Hash<String, Object>]
|
|
1644
1724
|
def update_flow_action(id, flow_action_update_query, opts = {})
|
|
1645
1725
|
data, _status_code, _headers = update_flow_action_with_http_info(id, flow_action_update_query, opts)
|
|
@@ -1647,10 +1727,11 @@ module KlaviyoAPI
|
|
|
1647
1727
|
end
|
|
1648
1728
|
|
|
1649
1729
|
# Update Flow Action
|
|
1650
|
-
# Update a flow action.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
|
|
1730
|
+
# 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
1731
|
# @param id [String]
|
|
1652
1732
|
# @param flow_action_update_query [FlowActionUpdateQuery]
|
|
1653
1733
|
# @param [Hash] opts the optional parameters
|
|
1734
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1654
1735
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1655
1736
|
def update_flow_action_with_http_info(id, flow_action_update_query, opts = {})
|
|
1656
1737
|
if @api_client.config.debugging
|
|
@@ -1664,16 +1745,21 @@ module KlaviyoAPI
|
|
|
1664
1745
|
if @api_client.config.client_side_validation && flow_action_update_query.nil?
|
|
1665
1746
|
fail ArgumentError, "Missing the required parameter 'flow_action_update_query' when calling FlowsApi.update_flow_action"
|
|
1666
1747
|
end
|
|
1748
|
+
allowable_values = ["created", "definition", "definition.data", "definition.data.action_output_filter", "definition.data.action_output_filter.condition_groups", "definition.data.branches", "definition.data.current_experiment", "definition.data.current_experiment.allocations", "definition.data.current_experiment.automatic_winner_selection_settings", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date", "definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty", "definition.data.current_experiment.automatic_winner_selection_settings.enabled", "definition.data.current_experiment.id", "definition.data.current_experiment.name", "definition.data.current_experiment.started", "definition.data.current_experiment.variations", "definition.data.current_experiment.winner_metric", "definition.data.delay_until_time", "definition.data.delay_until_weekdays", "definition.data.experiment_status", "definition.data.list_id", "definition.data.main_action", "definition.data.main_action.data", "definition.data.main_action.data.message", "definition.data.main_action.data.message.action_buttons", "definition.data.main_action.data.message.add_info_link", "definition.data.main_action.data.message.add_opt_out_language", "definition.data.main_action.data.message.add_org_prefix", "definition.data.main_action.data.message.add_tracking_params", "definition.data.main_action.data.message.additional_filters", "definition.data.main_action.data.message.additional_filters.condition_groups", "definition.data.main_action.data.message.android_link", "definition.data.main_action.data.message.badge", "definition.data.main_action.data.message.badge_options", "definition.data.main_action.data.message.badge_options.badge_config", "definition.data.main_action.data.message.badge_options.set_from_property", "definition.data.main_action.data.message.badge_options.value", "definition.data.main_action.data.message.bcc_email", "definition.data.main_action.data.message.body", "definition.data.main_action.data.message.cc_email", "definition.data.main_action.data.message.conversion_metric_id", "definition.data.main_action.data.message.custom_tracking_params", "definition.data.main_action.data.message.dynamic_image", "definition.data.main_action.data.message.from_email", "definition.data.main_action.data.message.from_label", "definition.data.main_action.data.message.id", "definition.data.main_action.data.message.image_id", "definition.data.main_action.data.message.include_contact_card", "definition.data.main_action.data.message.ios_link", "definition.data.main_action.data.message.kv_pairs", "definition.data.main_action.data.message.message_hierarchy", "definition.data.main_action.data.message.name", "definition.data.main_action.data.message.on_open", "definition.data.main_action.data.message.preview_text", "definition.data.main_action.data.message.push_type", "definition.data.main_action.data.message.reply_to_email", "definition.data.main_action.data.message.shorten_links", "definition.data.main_action.data.message.smart_sending_enabled", "definition.data.main_action.data.message.sms_quiet_hours_enabled", "definition.data.main_action.data.message.sound", "definition.data.main_action.data.message.subject_line", "definition.data.main_action.data.message.template_id", "definition.data.main_action.data.message.title", "definition.data.main_action.data.message.transactional", "definition.data.main_action.data.message.vendor_id", "definition.data.main_action.data.message.video_asset_id", "definition.data.main_action.data.message.web_url", "definition.data.main_action.data.status", "definition.data.main_action.id", "definition.data.main_action.links", "definition.data.main_action.links.next", "definition.data.main_action.temporary_id", "definition.data.main_action.type", "definition.data.message", "definition.data.message.action_buttons", "definition.data.message.add_info_link", "definition.data.message.add_opt_out_language", "definition.data.message.add_org_prefix", "definition.data.message.add_tracking_params", "definition.data.message.additional_filters", "definition.data.message.additional_filters.condition_groups", "definition.data.message.android_link", "definition.data.message.badge", "definition.data.message.badge_options", "definition.data.message.badge_options.badge_config", "definition.data.message.badge_options.set_from_property", "definition.data.message.badge_options.value", "definition.data.message.bcc_email", "definition.data.message.body", "definition.data.message.cc_email", "definition.data.message.conversion_metric_id", "definition.data.message.custom_tracking_params", "definition.data.message.dynamic_image", "definition.data.message.from_email", "definition.data.message.from_label", "definition.data.message.headers", "definition.data.message.id", "definition.data.message.image_id", "definition.data.message.include_contact_card", "definition.data.message.ios_link", "definition.data.message.kv_pairs", "definition.data.message.message_hierarchy", "definition.data.message.name", "definition.data.message.on_open", "definition.data.message.preview_text", "definition.data.message.push_type", "definition.data.message.reply_to_email", "definition.data.message.shorten_links", "definition.data.message.smart_sending_enabled", "definition.data.message.sms_quiet_hours_enabled", "definition.data.message.sound", "definition.data.message.subject_line", "definition.data.message.template_id", "definition.data.message.title", "definition.data.message.to_emails", "definition.data.message.transactional", "definition.data.message.url", "definition.data.message.vendor_id", "definition.data.message.video_asset_id", "definition.data.message.web_url", "definition.data.name", "definition.data.on_execution", "definition.data.profile_filter", "definition.data.profile_filter.condition_groups", "definition.data.profile_operations", "definition.data.secondary_value", "definition.data.service_configuration", "definition.data.service_configuration.event_key", "definition.data.service_configuration.event_payload", "definition.data.service_configuration.report_id", "definition.data.service_configuration.service_method_type", "definition.data.service_configuration.tracking_company_id", "definition.data.status", "definition.data.target_days", "definition.data.target_time", "definition.data.timezone", "definition.data.trigger_filter", "definition.data.trigger_filter.condition_groups", "definition.data.trigger_id", "definition.data.trigger_subtype", "definition.data.trigger_type", "definition.data.unit", "definition.data.value", "definition.id", "definition.links", "definition.links.next", "definition.links.next_if_false", "definition.links.next_if_true", "definition.temporary_id", "definition.type", "id", "updated"]
|
|
1749
|
+
if @api_client.config.client_side_validation && opts[:'fields_flow_action'] && !opts[:'fields_flow_action'].all? { |item| allowable_values.include?(item) }
|
|
1750
|
+
fail ArgumentError, "invalid value for \"fields_flow_action\", must include one of #{allowable_values}"
|
|
1751
|
+
end
|
|
1667
1752
|
# resource path
|
|
1668
1753
|
local_var_path = '/api/flow-actions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1669
1754
|
|
|
1670
1755
|
# query parameters
|
|
1671
1756
|
query_params = opts[:query_params] || {}
|
|
1757
|
+
query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
|
|
1672
1758
|
|
|
1673
1759
|
# header parameters
|
|
1674
1760
|
header_params = opts[:header_params] || {}
|
|
1675
1761
|
# klaviyo api revision
|
|
1676
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1762
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1677
1763
|
# HTTP header 'Accept' (if needed)
|
|
1678
1764
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1679
1765
|
# HTTP header 'Content-Type'
|