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,10 @@ module KlaviyoAPI
|
|
|
19
19
|
@api_client = api_client
|
|
20
20
|
end
|
|
21
21
|
# Get Tracking Setting
|
|
22
|
-
# Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
|
|
22
|
+
# Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_setting.json)
|
|
23
23
|
# @param id [String] The id of the tracking setting (account ID).
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
25
|
+
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
26
26
|
# @return [Hash<String, Object>]
|
|
27
27
|
def get_tracking_setting(id, opts = {})
|
|
28
28
|
data, _status_code, _headers = get_tracking_setting_with_http_info(id, opts)
|
|
@@ -30,10 +30,10 @@ module KlaviyoAPI
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Get Tracking Setting
|
|
33
|
-
# Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
|
|
33
|
+
# Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_setting.json)
|
|
34
34
|
# @param id [String] The id of the tracking setting (account ID).
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
36
|
+
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
37
37
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
38
38
|
def get_tracking_setting_with_http_info(id, opts = {})
|
|
39
39
|
if @api_client.config.debugging
|
|
@@ -43,7 +43,7 @@ module KlaviyoAPI
|
|
|
43
43
|
if @api_client.config.client_side_validation && id.nil?
|
|
44
44
|
fail ArgumentError, "Missing the required parameter 'id' when calling TrackingSettingsApi.get_tracking_setting"
|
|
45
45
|
end
|
|
46
|
-
allowable_values = ["auto_add_parameters", "custom_parameters", "utm_campaign", "utm_campaign.campaign", "utm_campaign.campaign.type", "utm_campaign.campaign.value", "utm_campaign.flow", "utm_campaign.flow.type", "utm_campaign.flow.value", "utm_id", "utm_id.campaign", "utm_id.campaign.type", "utm_id.campaign.value", "utm_id.flow", "utm_id.flow.type", "utm_id.flow.value", "utm_medium", "utm_medium.campaign", "utm_medium.campaign.type", "utm_medium.campaign.value", "utm_medium.flow", "utm_medium.flow.type", "utm_medium.flow.value", "utm_source", "utm_source.campaign", "utm_source.campaign.type", "utm_source.campaign.value", "utm_source.flow", "utm_source.flow.type", "utm_source.flow.value", "utm_term", "utm_term.campaign", "utm_term.campaign.type", "utm_term.campaign.value", "utm_term.flow", "utm_term.flow.type", "utm_term.flow.value"]
|
|
46
|
+
allowable_values = ["auto_add_parameters", "custom_parameters", "id", "utm_campaign", "utm_campaign.campaign", "utm_campaign.campaign.type", "utm_campaign.campaign.value", "utm_campaign.flow", "utm_campaign.flow.type", "utm_campaign.flow.value", "utm_id", "utm_id.campaign", "utm_id.campaign.type", "utm_id.campaign.value", "utm_id.flow", "utm_id.flow.type", "utm_id.flow.value", "utm_medium", "utm_medium.campaign", "utm_medium.campaign.type", "utm_medium.campaign.value", "utm_medium.flow", "utm_medium.flow.type", "utm_medium.flow.value", "utm_source", "utm_source.campaign", "utm_source.campaign.type", "utm_source.campaign.value", "utm_source.flow", "utm_source.flow.type", "utm_source.flow.value", "utm_term", "utm_term.campaign", "utm_term.campaign.type", "utm_term.campaign.value", "utm_term.flow", "utm_term.flow.type", "utm_term.flow.value"]
|
|
47
47
|
if @api_client.config.client_side_validation && opts[:'fields_tracking_setting'] && !opts[:'fields_tracking_setting'].all? { |item| allowable_values.include?(item) }
|
|
48
48
|
fail ArgumentError, "invalid value for \"fields_tracking_setting\", must include one of #{allowable_values}"
|
|
49
49
|
end
|
|
@@ -57,7 +57,7 @@ module KlaviyoAPI
|
|
|
57
57
|
# header parameters
|
|
58
58
|
header_params = opts[:header_params] || {}
|
|
59
59
|
# klaviyo api revision
|
|
60
|
-
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"
|
|
61
61
|
# HTTP header 'Accept' (if needed)
|
|
62
62
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
63
63
|
|
|
@@ -91,10 +91,10 @@ module KlaviyoAPI
|
|
|
91
91
|
end
|
|
92
92
|
|
|
93
93
|
# Get Tracking Settings
|
|
94
|
-
# Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
|
|
94
|
+
# Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_settings.json)
|
|
95
95
|
# @param [Hash] opts the optional parameters
|
|
96
|
-
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
97
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
96
|
+
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
97
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
98
98
|
# @option opts [Integer] :page_size Default: 1. Min: 1. Max: 1. (default to 1)
|
|
99
99
|
# @return [Hash<String, Object>]
|
|
100
100
|
def get_tracking_settings(opts = {})
|
|
@@ -103,17 +103,17 @@ module KlaviyoAPI
|
|
|
103
103
|
end
|
|
104
104
|
|
|
105
105
|
# Get Tracking Settings
|
|
106
|
-
# Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
|
|
106
|
+
# Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_settings.json)
|
|
107
107
|
# @param [Hash] opts the optional parameters
|
|
108
|
-
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
109
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
108
|
+
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
109
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
110
110
|
# @option opts [Integer] :page_size Default: 1. Min: 1. Max: 1. (default to 1)
|
|
111
111
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
112
112
|
def get_tracking_settings_with_http_info(opts = {})
|
|
113
113
|
if @api_client.config.debugging
|
|
114
114
|
@api_client.config.logger.debug 'Calling API: TrackingSettingsApi.get_tracking_settings ...'
|
|
115
115
|
end
|
|
116
|
-
allowable_values = ["auto_add_parameters", "custom_parameters", "utm_campaign", "utm_campaign.campaign", "utm_campaign.campaign.type", "utm_campaign.campaign.value", "utm_campaign.flow", "utm_campaign.flow.type", "utm_campaign.flow.value", "utm_id", "utm_id.campaign", "utm_id.campaign.type", "utm_id.campaign.value", "utm_id.flow", "utm_id.flow.type", "utm_id.flow.value", "utm_medium", "utm_medium.campaign", "utm_medium.campaign.type", "utm_medium.campaign.value", "utm_medium.flow", "utm_medium.flow.type", "utm_medium.flow.value", "utm_source", "utm_source.campaign", "utm_source.campaign.type", "utm_source.campaign.value", "utm_source.flow", "utm_source.flow.type", "utm_source.flow.value", "utm_term", "utm_term.campaign", "utm_term.campaign.type", "utm_term.campaign.value", "utm_term.flow", "utm_term.flow.type", "utm_term.flow.value"]
|
|
116
|
+
allowable_values = ["auto_add_parameters", "custom_parameters", "id", "utm_campaign", "utm_campaign.campaign", "utm_campaign.campaign.type", "utm_campaign.campaign.value", "utm_campaign.flow", "utm_campaign.flow.type", "utm_campaign.flow.value", "utm_id", "utm_id.campaign", "utm_id.campaign.type", "utm_id.campaign.value", "utm_id.flow", "utm_id.flow.type", "utm_id.flow.value", "utm_medium", "utm_medium.campaign", "utm_medium.campaign.type", "utm_medium.campaign.value", "utm_medium.flow", "utm_medium.flow.type", "utm_medium.flow.value", "utm_source", "utm_source.campaign", "utm_source.campaign.type", "utm_source.campaign.value", "utm_source.flow", "utm_source.flow.type", "utm_source.flow.value", "utm_term", "utm_term.campaign", "utm_term.campaign.type", "utm_term.campaign.value", "utm_term.flow", "utm_term.flow.type", "utm_term.flow.value"]
|
|
117
117
|
if @api_client.config.client_side_validation && opts[:'fields_tracking_setting'] && !opts[:'fields_tracking_setting'].all? { |item| allowable_values.include?(item) }
|
|
118
118
|
fail ArgumentError, "invalid value for \"fields_tracking_setting\", must include one of #{allowable_values}"
|
|
119
119
|
end
|
|
@@ -137,7 +137,7 @@ module KlaviyoAPI
|
|
|
137
137
|
# header parameters
|
|
138
138
|
header_params = opts[:header_params] || {}
|
|
139
139
|
# klaviyo api revision
|
|
140
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
140
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
141
141
|
# HTTP header 'Accept' (if needed)
|
|
142
142
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
143
143
|
|
|
@@ -171,10 +171,11 @@ module KlaviyoAPI
|
|
|
171
171
|
end
|
|
172
172
|
|
|
173
173
|
# Update Tracking Setting
|
|
174
|
-
# Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:write`
|
|
174
|
+
# Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tracking_setting.json)
|
|
175
175
|
# @param id [String] The id of the tracking setting (account ID).
|
|
176
176
|
# @param tracking_setting_partial_update_query [TrackingSettingPartialUpdateQuery] DTO for updating tracking settings
|
|
177
177
|
# @param [Hash] opts the optional parameters
|
|
178
|
+
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
178
179
|
# @return [Hash<String, Object>]
|
|
179
180
|
def update_tracking_setting(id, tracking_setting_partial_update_query, opts = {})
|
|
180
181
|
data, _status_code, _headers = update_tracking_setting_with_http_info(id, tracking_setting_partial_update_query, opts)
|
|
@@ -182,10 +183,11 @@ module KlaviyoAPI
|
|
|
182
183
|
end
|
|
183
184
|
|
|
184
185
|
# Update Tracking Setting
|
|
185
|
-
# Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:write`
|
|
186
|
+
# Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tracking_setting.json)
|
|
186
187
|
# @param id [String] The id of the tracking setting (account ID).
|
|
187
188
|
# @param tracking_setting_partial_update_query [TrackingSettingPartialUpdateQuery] DTO for updating tracking settings
|
|
188
189
|
# @param [Hash] opts the optional parameters
|
|
190
|
+
# @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
189
191
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
190
192
|
def update_tracking_setting_with_http_info(id, tracking_setting_partial_update_query, opts = {})
|
|
191
193
|
if @api_client.config.debugging
|
|
@@ -199,16 +201,21 @@ module KlaviyoAPI
|
|
|
199
201
|
if @api_client.config.client_side_validation && tracking_setting_partial_update_query.nil?
|
|
200
202
|
fail ArgumentError, "Missing the required parameter 'tracking_setting_partial_update_query' when calling TrackingSettingsApi.update_tracking_setting"
|
|
201
203
|
end
|
|
204
|
+
allowable_values = ["auto_add_parameters", "custom_parameters", "id", "utm_campaign", "utm_campaign.campaign", "utm_campaign.campaign.type", "utm_campaign.campaign.value", "utm_campaign.flow", "utm_campaign.flow.type", "utm_campaign.flow.value", "utm_id", "utm_id.campaign", "utm_id.campaign.type", "utm_id.campaign.value", "utm_id.flow", "utm_id.flow.type", "utm_id.flow.value", "utm_medium", "utm_medium.campaign", "utm_medium.campaign.type", "utm_medium.campaign.value", "utm_medium.flow", "utm_medium.flow.type", "utm_medium.flow.value", "utm_source", "utm_source.campaign", "utm_source.campaign.type", "utm_source.campaign.value", "utm_source.flow", "utm_source.flow.type", "utm_source.flow.value", "utm_term", "utm_term.campaign", "utm_term.campaign.type", "utm_term.campaign.value", "utm_term.flow", "utm_term.flow.type", "utm_term.flow.value"]
|
|
205
|
+
if @api_client.config.client_side_validation && opts[:'fields_tracking_setting'] && !opts[:'fields_tracking_setting'].all? { |item| allowable_values.include?(item) }
|
|
206
|
+
fail ArgumentError, "invalid value for \"fields_tracking_setting\", must include one of #{allowable_values}"
|
|
207
|
+
end
|
|
202
208
|
# resource path
|
|
203
209
|
local_var_path = '/api/tracking-settings/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
204
210
|
|
|
205
211
|
# query parameters
|
|
206
212
|
query_params = opts[:query_params] || {}
|
|
213
|
+
query_params[:'fields[tracking-setting]'] = @api_client.build_collection_param(opts[:'fields_tracking_setting'], :csv) if !opts[:'fields_tracking_setting'].nil?
|
|
207
214
|
|
|
208
215
|
# header parameters
|
|
209
216
|
header_params = opts[:header_params] || {}
|
|
210
217
|
# klaviyo api revision
|
|
211
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
218
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
212
219
|
# HTTP header 'Accept' (if needed)
|
|
213
220
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
214
221
|
# HTTP header 'Content-Type'
|
|
@@ -19,9 +19,10 @@ module KlaviyoAPI
|
|
|
19
19
|
@api_client = api_client
|
|
20
20
|
end
|
|
21
21
|
# Create Web Feed
|
|
22
|
-
# Create a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write`
|
|
22
|
+
# Create a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)
|
|
23
23
|
# @param web_feed_create_query [WebFeedCreateQuery] Create a web feed
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Array<String>] :fields_web_feed 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_web_feed(web_feed_create_query, opts = {})
|
|
27
28
|
data, _status_code, _headers = create_web_feed_with_http_info(web_feed_create_query, opts)
|
|
@@ -29,9 +30,10 @@ module KlaviyoAPI
|
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# Create Web Feed
|
|
32
|
-
# Create a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write`
|
|
33
|
+
# Create a web feed.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)
|
|
33
34
|
# @param web_feed_create_query [WebFeedCreateQuery] Create a web feed
|
|
34
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @option opts [Array<String>] :fields_web_feed 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_web_feed_with_http_info(web_feed_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 && web_feed_create_query.nil?
|
|
42
44
|
fail ArgumentError, "Missing the required parameter 'web_feed_create_query' when calling WebFeedsApi.create_web_feed"
|
|
43
45
|
end
|
|
46
|
+
allowable_values = ["content_type", "created", "id", "name", "request_method", "status", "updated", "url"]
|
|
47
|
+
if @api_client.config.client_side_validation && opts[:'fields_web_feed'] && !opts[:'fields_web_feed'].all? { |item| allowable_values.include?(item) }
|
|
48
|
+
fail ArgumentError, "invalid value for \"fields_web_feed\", must include one of #{allowable_values}"
|
|
49
|
+
end
|
|
44
50
|
# resource path
|
|
45
51
|
local_var_path = '/api/web-feeds'
|
|
46
52
|
|
|
47
53
|
# query parameters
|
|
48
54
|
query_params = opts[:query_params] || {}
|
|
55
|
+
query_params[:'fields[web-feed]'] = @api_client.build_collection_param(opts[:'fields_web_feed'], :csv) if !opts[:'fields_web_feed'].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 Web Feed
|
|
92
|
-
# Delete the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write`
|
|
99
|
+
# Delete the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_web_feed.json)
|
|
93
100
|
# @param id [String] The ID of the web feed
|
|
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 Web Feed
|
|
102
|
-
# Delete the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write`
|
|
109
|
+
# Delete the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_web_feed.json)
|
|
103
110
|
# @param id [String] The ID of the web feed
|
|
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 Web Feed
|
|
157
|
-
# Get the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read`
|
|
164
|
+
# Get the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)
|
|
158
165
|
# @param id [String] The ID of the web feed
|
|
159
166
|
# @param [Hash] opts the optional parameters
|
|
160
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
167
|
+
# @option opts [Array<String>] :fields_web_feed 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_web_feed(id, opts = {})
|
|
163
170
|
data, _status_code, _headers = get_web_feed_with_http_info(id, opts)
|
|
@@ -165,10 +172,10 @@ module KlaviyoAPI
|
|
|
165
172
|
end
|
|
166
173
|
|
|
167
174
|
# Get Web Feed
|
|
168
|
-
# Get the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read`
|
|
175
|
+
# Get the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)
|
|
169
176
|
# @param id [String] The ID of the web feed
|
|
170
177
|
# @param [Hash] opts the optional parameters
|
|
171
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
178
|
+
# @option opts [Array<String>] :fields_web_feed 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_web_feed_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 WebFeedsApi.get_web_feed"
|
|
180
187
|
end
|
|
181
|
-
allowable_values = ["content_type", "created", "name", "request_method", "status", "updated", "url"]
|
|
188
|
+
allowable_values = ["content_type", "created", "id", "name", "request_method", "status", "updated", "url"]
|
|
182
189
|
if @api_client.config.client_side_validation && opts[:'fields_web_feed'] && !opts[:'fields_web_feed'].all? { |item| allowable_values.include?(item) }
|
|
183
190
|
fail ArgumentError, "invalid value for \"fields_web_feed\", 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,13 +233,13 @@ module KlaviyoAPI
|
|
|
226
233
|
end
|
|
227
234
|
|
|
228
235
|
# Get Web Feeds
|
|
229
|
-
# Get all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read`
|
|
236
|
+
# Get all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)
|
|
230
237
|
# @param [Hash] opts the optional parameters
|
|
231
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
232
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
233
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
238
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
239
|
+
# @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`: `any`, `contains`, `equals`<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
240
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
234
241
|
# @option opts [Integer] :page_size Default: 5. Min: 1. Max: 20. (default to 5)
|
|
235
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
242
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
236
243
|
# @return [Hash<String, Object>]
|
|
237
244
|
def get_web_feeds(opts = {})
|
|
238
245
|
data, _status_code, _headers = get_web_feeds_with_http_info(opts)
|
|
@@ -240,19 +247,19 @@ module KlaviyoAPI
|
|
|
240
247
|
end
|
|
241
248
|
|
|
242
249
|
# Get Web Feeds
|
|
243
|
-
# Get all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read`
|
|
250
|
+
# Get all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)
|
|
244
251
|
# @param [Hash] opts the optional parameters
|
|
245
|
-
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
246
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
247
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
252
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
253
|
+
# @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`: `any`, `contains`, `equals`<br>`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
254
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
248
255
|
# @option opts [Integer] :page_size Default: 5. Min: 1. Max: 20. (default to 5)
|
|
249
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
256
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
250
257
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
251
258
|
def get_web_feeds_with_http_info(opts = {})
|
|
252
259
|
if @api_client.config.debugging
|
|
253
260
|
@api_client.config.logger.debug 'Calling API: WebFeedsApi.get_web_feeds ...'
|
|
254
261
|
end
|
|
255
|
-
allowable_values = ["content_type", "created", "name", "request_method", "status", "updated", "url"]
|
|
262
|
+
allowable_values = ["content_type", "created", "id", "name", "request_method", "status", "updated", "url"]
|
|
256
263
|
if @api_client.config.client_side_validation && opts[:'fields_web_feed'] && !opts[:'fields_web_feed'].all? { |item| allowable_values.include?(item) }
|
|
257
264
|
fail ArgumentError, "invalid value for \"fields_web_feed\", must include one of #{allowable_values}"
|
|
258
265
|
end
|
|
@@ -282,7 +289,7 @@ module KlaviyoAPI
|
|
|
282
289
|
# header parameters
|
|
283
290
|
header_params = opts[:header_params] || {}
|
|
284
291
|
# klaviyo api revision
|
|
285
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
292
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
286
293
|
# HTTP header 'Accept' (if needed)
|
|
287
294
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
288
295
|
|
|
@@ -316,10 +323,11 @@ module KlaviyoAPI
|
|
|
316
323
|
end
|
|
317
324
|
|
|
318
325
|
# Update Web Feed
|
|
319
|
-
# Update the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write`
|
|
326
|
+
# Update the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_web_feed.json)
|
|
320
327
|
# @param id [String] The ID of the web feed
|
|
321
328
|
# @param web_feed_partial_update_query [WebFeedPartialUpdateQuery] Update a web feed by ID
|
|
322
329
|
# @param [Hash] opts the optional parameters
|
|
330
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
323
331
|
# @return [Hash<String, Object>]
|
|
324
332
|
def update_web_feed(id, web_feed_partial_update_query, opts = {})
|
|
325
333
|
data, _status_code, _headers = update_web_feed_with_http_info(id, web_feed_partial_update_query, opts)
|
|
@@ -327,10 +335,11 @@ module KlaviyoAPI
|
|
|
327
335
|
end
|
|
328
336
|
|
|
329
337
|
# Update Web Feed
|
|
330
|
-
# Update the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write`
|
|
338
|
+
# Update the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_web_feed.json)
|
|
331
339
|
# @param id [String] The ID of the web feed
|
|
332
340
|
# @param web_feed_partial_update_query [WebFeedPartialUpdateQuery] Update a web feed by ID
|
|
333
341
|
# @param [Hash] opts the optional parameters
|
|
342
|
+
# @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
334
343
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
335
344
|
def update_web_feed_with_http_info(id, web_feed_partial_update_query, opts = {})
|
|
336
345
|
if @api_client.config.debugging
|
|
@@ -344,16 +353,21 @@ module KlaviyoAPI
|
|
|
344
353
|
if @api_client.config.client_side_validation && web_feed_partial_update_query.nil?
|
|
345
354
|
fail ArgumentError, "Missing the required parameter 'web_feed_partial_update_query' when calling WebFeedsApi.update_web_feed"
|
|
346
355
|
end
|
|
356
|
+
allowable_values = ["content_type", "created", "id", "name", "request_method", "status", "updated", "url"]
|
|
357
|
+
if @api_client.config.client_side_validation && opts[:'fields_web_feed'] && !opts[:'fields_web_feed'].all? { |item| allowable_values.include?(item) }
|
|
358
|
+
fail ArgumentError, "invalid value for \"fields_web_feed\", must include one of #{allowable_values}"
|
|
359
|
+
end
|
|
347
360
|
# resource path
|
|
348
361
|
local_var_path = '/api/web-feeds/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
349
362
|
|
|
350
363
|
# query parameters
|
|
351
364
|
query_params = opts[:query_params] || {}
|
|
365
|
+
query_params[:'fields[web-feed]'] = @api_client.build_collection_param(opts[:'fields_web_feed'], :csv) if !opts[:'fields_web_feed'].nil?
|
|
352
366
|
|
|
353
367
|
# header parameters
|
|
354
368
|
header_params = opts[:header_params] || {}
|
|
355
369
|
# klaviyo api revision
|
|
356
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
370
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
357
371
|
# HTTP header 'Accept' (if needed)
|
|
358
372
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
359
373
|
# HTTP header 'Content-Type'
|