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,9 +19,10 @@ module KlaviyoAPI
|
|
|
19
19
|
@api_client = api_client
|
|
20
20
|
end
|
|
21
21
|
# Create Form
|
|
22
|
-
# Create a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write`
|
|
22
|
+
# Create a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)
|
|
23
23
|
# @param form_create_query [FormCreateQuery] Creates a Form from parameters
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
25
26
|
# @return [Hash<String, Object>]
|
|
26
27
|
def create_form(form_create_query, opts = {})
|
|
27
28
|
data, _status_code, _headers = create_form_with_http_info(form_create_query, opts)
|
|
@@ -29,9 +30,10 @@ module KlaviyoAPI
|
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# Create Form
|
|
32
|
-
# Create a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write`
|
|
33
|
+
# Create a new form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)
|
|
33
34
|
# @param form_create_query [FormCreateQuery] Creates a Form from parameters
|
|
34
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
35
37
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
36
38
|
def create_form_with_http_info(form_create_query, opts = {})
|
|
37
39
|
if @api_client.config.debugging
|
|
@@ -41,16 +43,21 @@ module KlaviyoAPI
|
|
|
41
43
|
if @api_client.config.client_side_validation && form_create_query.nil?
|
|
42
44
|
fail ArgumentError, "Missing the required parameter 'form_create_query' when calling FormsApi.create_form"
|
|
43
45
|
end
|
|
46
|
+
allowable_values = ["ab_test", "created_at", "definition", "definition.versions", "id", "name", "status", "updated_at"]
|
|
47
|
+
if @api_client.config.client_side_validation && opts[:'fields_form'] && !opts[:'fields_form'].all? { |item| allowable_values.include?(item) }
|
|
48
|
+
fail ArgumentError, "invalid value for \"fields_form\", must include one of #{allowable_values}"
|
|
49
|
+
end
|
|
44
50
|
# resource path
|
|
45
51
|
local_var_path = '/api/forms'
|
|
46
52
|
|
|
47
53
|
# query parameters
|
|
48
54
|
query_params = opts[:query_params] || {}
|
|
55
|
+
query_params[:'fields[form]'] = @api_client.build_collection_param(opts[:'fields_form'], :csv) if !opts[:'fields_form'].nil?
|
|
49
56
|
|
|
50
57
|
# header parameters
|
|
51
58
|
header_params = opts[:header_params] || {}
|
|
52
59
|
# klaviyo api revision
|
|
53
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
54
61
|
# HTTP header 'Accept' (if needed)
|
|
55
62
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
56
63
|
# HTTP header 'Content-Type'
|
|
@@ -89,7 +96,7 @@ module KlaviyoAPI
|
|
|
89
96
|
end
|
|
90
97
|
|
|
91
98
|
# Delete Form
|
|
92
|
-
# Delete a given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write`
|
|
99
|
+
# Delete a given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_form.json)
|
|
93
100
|
# @param id [String] The ID of the form
|
|
94
101
|
# @param [Hash] opts the optional parameters
|
|
95
102
|
# @return [nil]
|
|
@@ -99,7 +106,7 @@ module KlaviyoAPI
|
|
|
99
106
|
end
|
|
100
107
|
|
|
101
108
|
# Delete Form
|
|
102
|
-
# Delete a given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write`
|
|
109
|
+
# Delete a given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_form.json)
|
|
103
110
|
# @param id [String] The ID of the form
|
|
104
111
|
# @param [Hash] opts the optional parameters
|
|
105
112
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -120,7 +127,7 @@ module KlaviyoAPI
|
|
|
120
127
|
# header parameters
|
|
121
128
|
header_params = opts[:header_params] || {}
|
|
122
129
|
# klaviyo api revision
|
|
123
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
130
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
124
131
|
# HTTP header 'Accept' (if needed)
|
|
125
132
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
126
133
|
|
|
@@ -154,10 +161,10 @@ module KlaviyoAPI
|
|
|
154
161
|
end
|
|
155
162
|
|
|
156
163
|
# Get Form
|
|
157
|
-
# Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
164
|
+
# Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)
|
|
158
165
|
# @param id [String] The ID of the form
|
|
159
166
|
# @param [Hash] opts the optional parameters
|
|
160
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
167
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
161
168
|
# @return [Hash<String, Object>]
|
|
162
169
|
def get_form(id, opts = {})
|
|
163
170
|
data, _status_code, _headers = get_form_with_http_info(id, opts)
|
|
@@ -165,10 +172,10 @@ module KlaviyoAPI
|
|
|
165
172
|
end
|
|
166
173
|
|
|
167
174
|
# Get Form
|
|
168
|
-
# Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
175
|
+
# Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)
|
|
169
176
|
# @param id [String] The ID of the form
|
|
170
177
|
# @param [Hash] opts the optional parameters
|
|
171
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
178
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
172
179
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
173
180
|
def get_form_with_http_info(id, opts = {})
|
|
174
181
|
if @api_client.config.debugging
|
|
@@ -178,7 +185,7 @@ module KlaviyoAPI
|
|
|
178
185
|
if @api_client.config.client_side_validation && id.nil?
|
|
179
186
|
fail ArgumentError, "Missing the required parameter 'id' when calling FormsApi.get_form"
|
|
180
187
|
end
|
|
181
|
-
allowable_values = ["ab_test", "created_at", "definition", "definition.versions", "name", "status", "updated_at"]
|
|
188
|
+
allowable_values = ["ab_test", "created_at", "definition", "definition.versions", "id", "name", "status", "updated_at"]
|
|
182
189
|
if @api_client.config.client_side_validation && opts[:'fields_form'] && !opts[:'fields_form'].all? { |item| allowable_values.include?(item) }
|
|
183
190
|
fail ArgumentError, "invalid value for \"fields_form\", must include one of #{allowable_values}"
|
|
184
191
|
end
|
|
@@ -192,7 +199,7 @@ module KlaviyoAPI
|
|
|
192
199
|
# header parameters
|
|
193
200
|
header_params = opts[:header_params] || {}
|
|
194
201
|
# klaviyo api revision
|
|
195
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
202
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
196
203
|
# HTTP header 'Accept' (if needed)
|
|
197
204
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
198
205
|
|
|
@@ -226,10 +233,10 @@ module KlaviyoAPI
|
|
|
226
233
|
end
|
|
227
234
|
|
|
228
235
|
# Get Form for Form Version
|
|
229
|
-
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
236
|
+
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)
|
|
230
237
|
# @param id [String] The ID of the form version
|
|
231
238
|
# @param [Hash] opts the optional parameters
|
|
232
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
239
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
233
240
|
# @return [Hash<String, Object>]
|
|
234
241
|
def get_form_for_form_version(id, opts = {})
|
|
235
242
|
data, _status_code, _headers = get_form_for_form_version_with_http_info(id, opts)
|
|
@@ -240,10 +247,10 @@ module KlaviyoAPI
|
|
|
240
247
|
alias get_form_version_form get_form_for_form_version
|
|
241
248
|
|
|
242
249
|
# Get Form for Form Version
|
|
243
|
-
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
250
|
+
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)
|
|
244
251
|
# @param id [String] The ID of the form version
|
|
245
252
|
# @param [Hash] opts the optional parameters
|
|
246
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
253
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
247
254
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
248
255
|
def get_form_for_form_version_with_http_info(id, opts = {})
|
|
249
256
|
if @api_client.config.debugging
|
|
@@ -253,7 +260,7 @@ module KlaviyoAPI
|
|
|
253
260
|
if @api_client.config.client_side_validation && id.nil?
|
|
254
261
|
fail ArgumentError, "Missing the required parameter 'id' when calling FormsApi.get_form_for_form_version"
|
|
255
262
|
end
|
|
256
|
-
allowable_values = ["ab_test", "created_at", "name", "status", "updated_at"]
|
|
263
|
+
allowable_values = ["ab_test", "created_at", "id", "name", "status", "updated_at"]
|
|
257
264
|
if @api_client.config.client_side_validation && opts[:'fields_form'] && !opts[:'fields_form'].all? { |item| allowable_values.include?(item) }
|
|
258
265
|
fail ArgumentError, "invalid value for \"fields_form\", must include one of #{allowable_values}"
|
|
259
266
|
end
|
|
@@ -267,7 +274,7 @@ module KlaviyoAPI
|
|
|
267
274
|
# header parameters
|
|
268
275
|
header_params = opts[:header_params] || {}
|
|
269
276
|
# klaviyo api revision
|
|
270
|
-
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"
|
|
271
278
|
# HTTP header 'Accept' (if needed)
|
|
272
279
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
273
280
|
|
|
@@ -304,7 +311,7 @@ module KlaviyoAPI
|
|
|
304
311
|
alias get_form_version_form_with_http_info get_form_for_form_version_with_http_info
|
|
305
312
|
|
|
306
313
|
# Get Form ID for Form Version
|
|
307
|
-
# Get the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
314
|
+
# Get the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_id_for_form_version.json)
|
|
308
315
|
# @param id [String] The ID of the form version
|
|
309
316
|
# @param [Hash] opts the optional parameters
|
|
310
317
|
# @return [Hash<String, Object>]
|
|
@@ -317,7 +324,7 @@ module KlaviyoAPI
|
|
|
317
324
|
alias get_form_version_relationships_form get_form_id_for_form_version
|
|
318
325
|
|
|
319
326
|
# Get Form ID for Form Version
|
|
320
|
-
# Get the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
327
|
+
# Get the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_id_for_form_version.json)
|
|
321
328
|
# @param id [String] The ID of the form version
|
|
322
329
|
# @param [Hash] opts the optional parameters
|
|
323
330
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -338,7 +345,7 @@ module KlaviyoAPI
|
|
|
338
345
|
# header parameters
|
|
339
346
|
header_params = opts[:header_params] || {}
|
|
340
347
|
# klaviyo api revision
|
|
341
|
-
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"
|
|
342
349
|
# HTTP header 'Accept' (if needed)
|
|
343
350
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
344
351
|
|
|
@@ -375,10 +382,12 @@ module KlaviyoAPI
|
|
|
375
382
|
alias get_form_version_relationships_form_with_http_info get_form_id_for_form_version_with_http_info
|
|
376
383
|
|
|
377
384
|
# Get Form Version
|
|
378
|
-
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
385
|
+
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)
|
|
379
386
|
# @param id [String] The ID of the form version
|
|
380
387
|
# @param [Hash] opts the optional parameters
|
|
381
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
388
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
389
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
390
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
382
391
|
# @return [Hash<String, Object>]
|
|
383
392
|
def get_form_version(id, opts = {})
|
|
384
393
|
data, _status_code, _headers = get_form_version_with_http_info(id, opts)
|
|
@@ -386,10 +395,12 @@ module KlaviyoAPI
|
|
|
386
395
|
end
|
|
387
396
|
|
|
388
397
|
# Get Form Version
|
|
389
|
-
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
398
|
+
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)
|
|
390
399
|
# @param id [String] The ID of the form version
|
|
391
400
|
# @param [Hash] opts the optional parameters
|
|
392
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
401
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
402
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
403
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
393
404
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
394
405
|
def get_form_version_with_http_info(id, opts = {})
|
|
395
406
|
if @api_client.config.debugging
|
|
@@ -399,21 +410,31 @@ module KlaviyoAPI
|
|
|
399
410
|
if @api_client.config.client_side_validation && id.nil?
|
|
400
411
|
fail ArgumentError, "Missing the required parameter 'id' when calling FormsApi.get_form_version"
|
|
401
412
|
end
|
|
402
|
-
allowable_values = ["ab_test", "ab_test.variation_name", "created_at", "form_type", "status", "updated_at", "variation_name"]
|
|
413
|
+
allowable_values = ["ab_test", "ab_test.variation_name", "created_at", "form_type", "id", "status", "updated_at", "variation_name"]
|
|
403
414
|
if @api_client.config.client_side_validation && opts[:'fields_form_version'] && !opts[:'fields_form_version'].all? { |item| allowable_values.include?(item) }
|
|
404
415
|
fail ArgumentError, "invalid value for \"fields_form_version\", must include one of #{allowable_values}"
|
|
405
416
|
end
|
|
417
|
+
allowable_values = ["ab_test", "created_at", "id", "name", "status", "updated_at"]
|
|
418
|
+
if @api_client.config.client_side_validation && opts[:'fields_form'] && !opts[:'fields_form'].all? { |item| allowable_values.include?(item) }
|
|
419
|
+
fail ArgumentError, "invalid value for \"fields_form\", must include one of #{allowable_values}"
|
|
420
|
+
end
|
|
421
|
+
allowable_values = ["form"]
|
|
422
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
423
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
424
|
+
end
|
|
406
425
|
# resource path
|
|
407
426
|
local_var_path = '/api/form-versions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
408
427
|
|
|
409
428
|
# query parameters
|
|
410
429
|
query_params = opts[:query_params] || {}
|
|
411
430
|
query_params[:'fields[form-version]'] = @api_client.build_collection_param(opts[:'fields_form_version'], :csv) if !opts[:'fields_form_version'].nil?
|
|
431
|
+
query_params[:'fields[form]'] = @api_client.build_collection_param(opts[:'fields_form'], :csv) if !opts[:'fields_form'].nil?
|
|
432
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
412
433
|
|
|
413
434
|
# header parameters
|
|
414
435
|
header_params = opts[:header_params] || {}
|
|
415
436
|
# klaviyo api revision
|
|
416
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
437
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
417
438
|
# HTTP header 'Accept' (if needed)
|
|
418
439
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
419
440
|
|
|
@@ -447,13 +468,13 @@ module KlaviyoAPI
|
|
|
447
468
|
end
|
|
448
469
|
|
|
449
470
|
# Get Forms
|
|
450
|
-
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
471
|
+
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)
|
|
451
472
|
# @param [Hash] opts the optional parameters
|
|
452
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
453
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
454
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
473
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
474
|
+
# @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`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`
|
|
475
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
455
476
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
456
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
477
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
457
478
|
# @return [Hash<String, Object>]
|
|
458
479
|
def get_forms(opts = {})
|
|
459
480
|
data, _status_code, _headers = get_forms_with_http_info(opts)
|
|
@@ -461,19 +482,19 @@ module KlaviyoAPI
|
|
|
461
482
|
end
|
|
462
483
|
|
|
463
484
|
# Get Forms
|
|
464
|
-
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
485
|
+
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)
|
|
465
486
|
# @param [Hash] opts the optional parameters
|
|
466
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
467
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
468
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
487
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
488
|
+
# @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`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`
|
|
489
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
469
490
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
470
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
491
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
471
492
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
472
493
|
def get_forms_with_http_info(opts = {})
|
|
473
494
|
if @api_client.config.debugging
|
|
474
495
|
@api_client.config.logger.debug 'Calling API: FormsApi.get_forms ...'
|
|
475
496
|
end
|
|
476
|
-
allowable_values = ["ab_test", "created_at", "name", "status", "updated_at"]
|
|
497
|
+
allowable_values = ["ab_test", "created_at", "id", "name", "status", "updated_at"]
|
|
477
498
|
if @api_client.config.client_side_validation && opts[:'fields_form'] && !opts[:'fields_form'].all? { |item| allowable_values.include?(item) }
|
|
478
499
|
fail ArgumentError, "invalid value for \"fields_form\", must include one of #{allowable_values}"
|
|
479
500
|
end
|
|
@@ -503,7 +524,7 @@ module KlaviyoAPI
|
|
|
503
524
|
# header parameters
|
|
504
525
|
header_params = opts[:header_params] || {}
|
|
505
526
|
# klaviyo api revision
|
|
506
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
527
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
507
528
|
# HTTP header 'Accept' (if needed)
|
|
508
529
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
509
530
|
|
|
@@ -537,13 +558,13 @@ module KlaviyoAPI
|
|
|
537
558
|
end
|
|
538
559
|
|
|
539
560
|
# Get Version IDs for Form
|
|
540
|
-
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
561
|
+
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)
|
|
541
562
|
# @param id [String] The ID of the form
|
|
542
563
|
# @param [Hash] opts the optional parameters
|
|
543
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
544
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
564
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
565
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
545
566
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
546
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
567
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
547
568
|
# @return [Hash<String, Object>]
|
|
548
569
|
def get_version_ids_for_form(id, opts = {})
|
|
549
570
|
data, _status_code, _headers = get_version_ids_for_form_with_http_info(id, opts)
|
|
@@ -557,13 +578,13 @@ module KlaviyoAPI
|
|
|
557
578
|
alias get_form_relationships_versions get_version_ids_for_form
|
|
558
579
|
|
|
559
580
|
# Get Version IDs for Form
|
|
560
|
-
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
581
|
+
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)
|
|
561
582
|
# @param id [String] The ID of the form
|
|
562
583
|
# @param [Hash] opts the optional parameters
|
|
563
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
564
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
584
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
585
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
565
586
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
566
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
587
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
567
588
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
568
589
|
def get_version_ids_for_form_with_http_info(id, opts = {})
|
|
569
590
|
if @api_client.config.debugging
|
|
@@ -594,7 +615,7 @@ module KlaviyoAPI
|
|
|
594
615
|
# header parameters
|
|
595
616
|
header_params = opts[:header_params] || {}
|
|
596
617
|
# klaviyo api revision
|
|
597
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
618
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
598
619
|
# HTTP header 'Accept' (if needed)
|
|
599
620
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
600
621
|
|
|
@@ -634,14 +655,14 @@ module KlaviyoAPI
|
|
|
634
655
|
alias get_form_relationships_versions_with_http_info get_version_ids_for_form_with_http_info
|
|
635
656
|
|
|
636
657
|
# Get Versions for Form
|
|
637
|
-
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
658
|
+
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)
|
|
638
659
|
# @param id [String] The ID of the form
|
|
639
660
|
# @param [Hash] opts the optional parameters
|
|
640
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
641
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
642
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
661
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
662
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
663
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
643
664
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
644
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
665
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
645
666
|
# @return [Hash<String, Object>]
|
|
646
667
|
def get_versions_for_form(id, opts = {})
|
|
647
668
|
data, _status_code, _headers = get_versions_for_form_with_http_info(id, opts)
|
|
@@ -655,20 +676,20 @@ module KlaviyoAPI
|
|
|
655
676
|
alias get_form_versions get_versions_for_form
|
|
656
677
|
|
|
657
678
|
# Get Versions for Form
|
|
658
|
-
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
|
679
|
+
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)
|
|
659
680
|
# @param id [String] The ID of the form
|
|
660
681
|
# @param [Hash] opts the optional parameters
|
|
661
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
662
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
663
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
682
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
683
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
684
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
664
685
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
665
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
686
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
666
687
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
667
688
|
def get_versions_for_form_with_http_info(id, opts = {})
|
|
668
689
|
if @api_client.config.debugging
|
|
669
690
|
@api_client.config.logger.debug 'Calling API: FormsApi.get_versions_for_form ...'
|
|
670
691
|
end
|
|
671
|
-
allowable_values = ["ab_test", "ab_test.variation_name", "created_at", "form_type", "status", "updated_at", "variation_name"]
|
|
692
|
+
allowable_values = ["ab_test", "ab_test.variation_name", "created_at", "form_type", "id", "status", "updated_at", "variation_name"]
|
|
672
693
|
if @api_client.config.client_side_validation && opts[:'fields_form_version'] && !opts[:'fields_form_version'].all? { |item| allowable_values.include?(item) }
|
|
673
694
|
fail ArgumentError, "invalid value for \"fields_form_version\", must include one of #{allowable_values}"
|
|
674
695
|
end
|
|
@@ -698,7 +719,7 @@ module KlaviyoAPI
|
|
|
698
719
|
# header parameters
|
|
699
720
|
header_params = opts[:header_params] || {}
|
|
700
721
|
# klaviyo api revision
|
|
701
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
722
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
702
723
|
# HTTP header 'Accept' (if needed)
|
|
703
724
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
704
725
|
|