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 Segment
|
|
22
|
-
# Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`
|
|
22
|
+
# Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)
|
|
23
23
|
# @param segment_create_query [SegmentCreateQuery]
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Array<String>] :fields_segment 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_segment(segment_create_query, opts = {})
|
|
27
28
|
data, _status_code, _headers = create_segment_with_http_info(segment_create_query, opts)
|
|
@@ -29,9 +30,10 @@ module KlaviyoAPI
|
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# Create Segment
|
|
32
|
-
# Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`
|
|
33
|
+
# Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)
|
|
33
34
|
# @param segment_create_query [SegmentCreateQuery]
|
|
34
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @option opts [Array<String>] :fields_segment 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_segment_with_http_info(segment_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 && segment_create_query.nil?
|
|
42
44
|
fail ArgumentError, "Missing the required parameter 'segment_create_query' when calling SegmentsApi.create_segment"
|
|
43
45
|
end
|
|
46
|
+
allowable_values = ["created", "definition", "definition.condition_groups", "id", "is_active", "is_processing", "is_starred", "name", "updated"]
|
|
47
|
+
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
|
48
|
+
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
|
49
|
+
end
|
|
44
50
|
# resource path
|
|
45
51
|
local_var_path = '/api/segments'
|
|
46
52
|
|
|
47
53
|
# query parameters
|
|
48
54
|
query_params = opts[:query_params] || {}
|
|
55
|
+
query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].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 Segment
|
|
92
|
-
# Delete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write`
|
|
99
|
+
# Delete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_segment.json)
|
|
93
100
|
# @param id [String]
|
|
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 Segment
|
|
102
|
-
# Delete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write`
|
|
109
|
+
# Delete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_segment.json)
|
|
103
110
|
# @param id [String]
|
|
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 Flows Triggered by Segment
|
|
157
|
-
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
|
164
|
+
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_segment.json)
|
|
158
165
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
159
166
|
# @param [Hash] opts the optional parameters
|
|
160
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
167
|
+
# @option opts [Array<String>] :fields_flow 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_flows_triggered_by_segment(id, opts = {})
|
|
163
170
|
data, _status_code, _headers = get_flows_triggered_by_segment_with_http_info(id, opts)
|
|
@@ -171,10 +178,10 @@ module KlaviyoAPI
|
|
|
171
178
|
alias get_segment_flow_triggers get_flows_triggered_by_segment
|
|
172
179
|
|
|
173
180
|
# Get Flows Triggered by Segment
|
|
174
|
-
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
|
181
|
+
# Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_segment.json)
|
|
175
182
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
176
183
|
# @param [Hash] opts the optional parameters
|
|
177
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
184
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
178
185
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
179
186
|
def get_flows_triggered_by_segment_with_http_info(id, opts = {})
|
|
180
187
|
if @api_client.config.debugging
|
|
@@ -184,7 +191,7 @@ module KlaviyoAPI
|
|
|
184
191
|
if @api_client.config.client_side_validation && id.nil?
|
|
185
192
|
fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_flows_triggered_by_segment"
|
|
186
193
|
end
|
|
187
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
194
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
188
195
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
189
196
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
190
197
|
end
|
|
@@ -198,7 +205,7 @@ module KlaviyoAPI
|
|
|
198
205
|
# header parameters
|
|
199
206
|
header_params = opts[:header_params] || {}
|
|
200
207
|
# klaviyo api revision
|
|
201
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
208
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
202
209
|
# HTTP header 'Accept' (if needed)
|
|
203
210
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
204
211
|
|
|
@@ -238,7 +245,7 @@ module KlaviyoAPI
|
|
|
238
245
|
alias get_segment_flow_triggers_with_http_info get_flows_triggered_by_segment_with_http_info
|
|
239
246
|
|
|
240
247
|
# Get IDs for Flows Triggered by Segment
|
|
241
|
-
# Get the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
|
248
|
+
# Get the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_segment.json)
|
|
242
249
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
243
250
|
# @param [Hash] opts the optional parameters
|
|
244
251
|
# @return [Hash<String, Object>]
|
|
@@ -254,7 +261,7 @@ module KlaviyoAPI
|
|
|
254
261
|
alias get_segment_relationships_flow_triggers get_ids_for_flows_triggered_by_segment
|
|
255
262
|
|
|
256
263
|
# Get IDs for Flows Triggered by Segment
|
|
257
|
-
# Get the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
|
|
264
|
+
# Get the IDs of all flows where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_segment.json)
|
|
258
265
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
259
266
|
# @param [Hash] opts the optional parameters
|
|
260
267
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -275,7 +282,7 @@ module KlaviyoAPI
|
|
|
275
282
|
# header parameters
|
|
276
283
|
header_params = opts[:header_params] || {}
|
|
277
284
|
# klaviyo api revision
|
|
278
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
285
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
279
286
|
# HTTP header 'Accept' (if needed)
|
|
280
287
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
281
288
|
|
|
@@ -315,13 +322,13 @@ module KlaviyoAPI
|
|
|
315
322
|
alias get_segment_relationships_flow_triggers_with_http_info get_ids_for_flows_triggered_by_segment_with_http_info
|
|
316
323
|
|
|
317
324
|
# Get Profile IDs for Segment
|
|
318
|
-
# Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read`
|
|
325
|
+
# Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_segment.json)
|
|
319
326
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
320
327
|
# @param [Hash] opts the optional parameters
|
|
321
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
322
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
328
|
+
# @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>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
329
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
323
330
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
324
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
331
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
325
332
|
# @return [Hash<String, Object>]
|
|
326
333
|
def get_profile_ids_for_segment(id, opts = {})
|
|
327
334
|
data, _status_code, _headers = get_profile_ids_for_segment_with_http_info(id, opts)
|
|
@@ -332,13 +339,13 @@ module KlaviyoAPI
|
|
|
332
339
|
alias get_segment_relationships_profiles get_profile_ids_for_segment
|
|
333
340
|
|
|
334
341
|
# Get Profile IDs for Segment
|
|
335
|
-
# Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read`
|
|
342
|
+
# Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_segment.json)
|
|
336
343
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
337
344
|
# @param [Hash] opts the optional parameters
|
|
338
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
339
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
345
|
+
# @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>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
346
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
340
347
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
341
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
348
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
342
349
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
343
350
|
def get_profile_ids_for_segment_with_http_info(id, opts = {})
|
|
344
351
|
if @api_client.config.debugging
|
|
@@ -373,7 +380,7 @@ module KlaviyoAPI
|
|
|
373
380
|
# header parameters
|
|
374
381
|
header_params = opts[:header_params] || {}
|
|
375
382
|
# klaviyo api revision
|
|
376
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
383
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
377
384
|
# HTTP header 'Accept' (if needed)
|
|
378
385
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
379
386
|
|
|
@@ -410,15 +417,15 @@ module KlaviyoAPI
|
|
|
410
417
|
alias get_segment_relationships_profiles_with_http_info get_profile_ids_for_segment_with_http_info
|
|
411
418
|
|
|
412
419
|
# Get Profiles for Segment
|
|
413
|
-
# Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read`
|
|
420
|
+
# Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_segment.json)
|
|
414
421
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
415
422
|
# @param [Hash] opts the optional parameters
|
|
416
423
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
417
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
418
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
419
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
424
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
425
|
+
# @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>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
426
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
420
427
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
421
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
428
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
422
429
|
# @return [Hash<String, Object>]
|
|
423
430
|
def get_profiles_for_segment(id, opts = {})
|
|
424
431
|
data, _status_code, _headers = get_profiles_for_segment_with_http_info(id, opts)
|
|
@@ -429,15 +436,15 @@ module KlaviyoAPI
|
|
|
429
436
|
alias get_segment_profiles get_profiles_for_segment
|
|
430
437
|
|
|
431
438
|
# Get Profiles for Segment
|
|
432
|
-
# Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read`
|
|
439
|
+
# Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `profiles:read` `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_segment.json)
|
|
433
440
|
# @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
|
|
434
441
|
# @param [Hash] opts the optional parameters
|
|
435
442
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
|
436
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
437
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
438
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
443
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
444
|
+
# @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>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
|
445
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
439
446
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
|
440
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
447
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
441
448
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
442
449
|
def get_profiles_for_segment_with_http_info(id, opts = {})
|
|
443
450
|
if @api_client.config.debugging
|
|
@@ -451,7 +458,7 @@ module KlaviyoAPI
|
|
|
451
458
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
452
459
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
|
453
460
|
end
|
|
454
|
-
allowable_values = ["created", "email", "external_id", "first_name", "image", "joined_group_at", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
461
|
+
allowable_values = ["created", "email", "external_id", "first_name", "id", "image", "joined_group_at", "last_event_date", "last_name", "locale", "location", "location.address1", "location.address2", "location.city", "location.country", "location.ip", "location.latitude", "location.longitude", "location.region", "location.timezone", "location.zip", "organization", "phone_number", "predictive_analytics", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.historic_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_clv", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.ranked_channel_affinity", "predictive_analytics.total_clv", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.suppression", "subscriptions.email.open_tracking", "subscriptions.email.open_tracking.can_receive", "subscriptions.email.open_tracking.consent", "subscriptions.email.open_tracking.consent_timestamp", "subscriptions.email.open_tracking.created_timestamp", "subscriptions.email.open_tracking.last_updated", "subscriptions.email.open_tracking.metadata", "subscriptions.email.open_tracking.valid_until", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.last_updated", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.whatsapp", "subscriptions.whatsapp.conversational", "subscriptions.whatsapp.conversational.can_receive", "subscriptions.whatsapp.conversational.consent", "subscriptions.whatsapp.conversational.consent_timestamp", "subscriptions.whatsapp.conversational.created_timestamp", "subscriptions.whatsapp.conversational.last_updated", "subscriptions.whatsapp.conversational.metadata", "subscriptions.whatsapp.conversational.phone_number", "subscriptions.whatsapp.conversational.valid_until", "subscriptions.whatsapp.marketing", "subscriptions.whatsapp.marketing.can_receive", "subscriptions.whatsapp.marketing.consent", "subscriptions.whatsapp.marketing.consent_timestamp", "subscriptions.whatsapp.marketing.created_timestamp", "subscriptions.whatsapp.marketing.last_updated", "subscriptions.whatsapp.marketing.metadata", "subscriptions.whatsapp.marketing.phone_number", "subscriptions.whatsapp.marketing.valid_until", "subscriptions.whatsapp.transactional", "subscriptions.whatsapp.transactional.can_receive", "subscriptions.whatsapp.transactional.consent", "subscriptions.whatsapp.transactional.consent_timestamp", "subscriptions.whatsapp.transactional.created_timestamp", "subscriptions.whatsapp.transactional.last_updated", "subscriptions.whatsapp.transactional.metadata", "subscriptions.whatsapp.transactional.phone_number", "subscriptions.whatsapp.transactional.valid_until", "title", "updated"]
|
|
455
462
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
|
456
463
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
|
457
464
|
end
|
|
@@ -482,7 +489,7 @@ module KlaviyoAPI
|
|
|
482
489
|
# header parameters
|
|
483
490
|
header_params = opts[:header_params] || {}
|
|
484
491
|
# klaviyo api revision
|
|
485
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
492
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
486
493
|
# HTTP header 'Accept' (if needed)
|
|
487
494
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
488
495
|
|
|
@@ -519,14 +526,14 @@ module KlaviyoAPI
|
|
|
519
526
|
alias get_segment_profiles_with_http_info get_profiles_for_segment_with_http_info
|
|
520
527
|
|
|
521
528
|
# Get Segment
|
|
522
|
-
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-
|
|
529
|
+
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment.json)
|
|
523
530
|
# @param id [String]
|
|
524
531
|
# @param [Hash] opts the optional parameters
|
|
525
532
|
# @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: 'profile_count'
|
|
526
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
527
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
528
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
529
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
533
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
534
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
535
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
536
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
530
537
|
# @return [Hash<String, Object>]
|
|
531
538
|
def get_segment(id, opts = {})
|
|
532
539
|
data, _status_code, _headers = get_segment_with_http_info(id, opts)
|
|
@@ -534,14 +541,14 @@ module KlaviyoAPI
|
|
|
534
541
|
end
|
|
535
542
|
|
|
536
543
|
# Get Segment
|
|
537
|
-
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-
|
|
544
|
+
# Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment.json)
|
|
538
545
|
# @param id [String]
|
|
539
546
|
# @param [Hash] opts the optional parameters
|
|
540
547
|
# @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: 'profile_count'
|
|
541
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
542
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
543
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
544
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
548
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
549
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
550
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
551
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
545
552
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
546
553
|
def get_segment_with_http_info(id, opts = {})
|
|
547
554
|
if @api_client.config.debugging
|
|
@@ -555,15 +562,15 @@ module KlaviyoAPI
|
|
|
555
562
|
if @api_client.config.client_side_validation && opts[:'additional_fields_segment'] && !opts[:'additional_fields_segment'].all? { |item| allowable_values.include?(item) }
|
|
556
563
|
fail ArgumentError, "invalid value for \"additional_fields_segment\", must include one of #{allowable_values}"
|
|
557
564
|
end
|
|
558
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
565
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
559
566
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
560
567
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
561
568
|
end
|
|
562
|
-
allowable_values = ["created", "definition", "definition.condition_groups", "is_active", "is_processing", "is_starred", "name", "profile_count", "updated"]
|
|
569
|
+
allowable_values = ["created", "definition", "definition.condition_groups", "id", "is_active", "is_processing", "is_starred", "name", "profile_count", "updated"]
|
|
563
570
|
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
|
564
571
|
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
|
565
572
|
end
|
|
566
|
-
allowable_values = ["name"]
|
|
573
|
+
allowable_values = ["id", "name"]
|
|
567
574
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
568
575
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
569
576
|
end
|
|
@@ -585,7 +592,7 @@ module KlaviyoAPI
|
|
|
585
592
|
# header parameters
|
|
586
593
|
header_params = opts[:header_params] || {}
|
|
587
594
|
# klaviyo api revision
|
|
588
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
595
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
589
596
|
# HTTP header 'Accept' (if needed)
|
|
590
597
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
591
598
|
|
|
@@ -619,15 +626,16 @@ module KlaviyoAPI
|
|
|
619
626
|
end
|
|
620
627
|
|
|
621
628
|
# Get Segments
|
|
622
|
-
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `segments:read`
|
|
629
|
+
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments.json)
|
|
623
630
|
# @param [Hash] opts the optional parameters
|
|
624
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
625
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
626
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
627
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
628
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
629
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
630
|
-
# @option opts [
|
|
631
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
632
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
633
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
634
|
+
# @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`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`
|
|
635
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
636
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
637
|
+
# @option opts [Integer] :page_size Default: 10. Min: 1. Max: 10. (default to 10)
|
|
638
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
631
639
|
# @return [Hash<String, Object>]
|
|
632
640
|
def get_segments(opts = {})
|
|
633
641
|
data, _status_code, _headers = get_segments_with_http_info(opts)
|
|
@@ -635,29 +643,30 @@ module KlaviyoAPI
|
|
|
635
643
|
end
|
|
636
644
|
|
|
637
645
|
# Get Segments
|
|
638
|
-
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `segments:read`
|
|
646
|
+
# Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m` **Scopes:** `segments:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments.json)
|
|
639
647
|
# @param [Hash] opts the optional parameters
|
|
640
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
641
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
642
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
643
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
644
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
645
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
646
|
-
# @option opts [
|
|
648
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
649
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
650
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
651
|
+
# @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`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`
|
|
652
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
653
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
654
|
+
# @option opts [Integer] :page_size Default: 10. Min: 1. Max: 10. (default to 10)
|
|
655
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
647
656
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
648
657
|
def get_segments_with_http_info(opts = {})
|
|
649
658
|
if @api_client.config.debugging
|
|
650
659
|
@api_client.config.logger.debug 'Calling API: SegmentsApi.get_segments ...'
|
|
651
660
|
end
|
|
652
|
-
allowable_values = ["archived", "created", "name", "status", "trigger_type", "updated"]
|
|
661
|
+
allowable_values = ["archived", "created", "id", "name", "status", "trigger_type", "updated"]
|
|
653
662
|
if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
|
|
654
663
|
fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
|
|
655
664
|
end
|
|
656
|
-
allowable_values = ["created", "definition", "definition.condition_groups", "is_active", "is_processing", "is_starred", "name", "updated"]
|
|
665
|
+
allowable_values = ["created", "definition", "definition.condition_groups", "id", "is_active", "is_processing", "is_starred", "name", "updated"]
|
|
657
666
|
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
|
658
667
|
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
|
659
668
|
end
|
|
660
|
-
allowable_values = ["name"]
|
|
669
|
+
allowable_values = ["id", "name"]
|
|
661
670
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
662
671
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
663
672
|
end
|
|
@@ -665,6 +674,14 @@ module KlaviyoAPI
|
|
|
665
674
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
666
675
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
667
676
|
end
|
|
677
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10
|
|
678
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_segments, must be smaller than or equal to 10.'
|
|
679
|
+
end
|
|
680
|
+
|
|
681
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
682
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_segments, must be greater than or equal to 1.'
|
|
683
|
+
end
|
|
684
|
+
|
|
668
685
|
allowable_values = ["created", "-created", "id", "-id", "name", "-name", "updated", "-updated"]
|
|
669
686
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
670
687
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -680,12 +697,13 @@ module KlaviyoAPI
|
|
|
680
697
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
681
698
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
682
699
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
700
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
683
701
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
684
702
|
|
|
685
703
|
# header parameters
|
|
686
704
|
header_params = opts[:header_params] || {}
|
|
687
705
|
# klaviyo api revision
|
|
688
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
706
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
689
707
|
# HTTP header 'Accept' (if needed)
|
|
690
708
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
691
709
|
|
|
@@ -719,7 +737,7 @@ module KlaviyoAPI
|
|
|
719
737
|
end
|
|
720
738
|
|
|
721
739
|
# Get Tag IDs for Segment
|
|
722
|
-
# If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
|
740
|
+
# If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_segment.json)
|
|
723
741
|
# @param id [String]
|
|
724
742
|
# @param [Hash] opts the optional parameters
|
|
725
743
|
# @return [Hash<String, Object>]
|
|
@@ -732,7 +750,7 @@ module KlaviyoAPI
|
|
|
732
750
|
alias get_segment_relationships_tags get_tag_ids_for_segment
|
|
733
751
|
|
|
734
752
|
# Get Tag IDs for Segment
|
|
735
|
-
# If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
|
753
|
+
# If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_segment.json)
|
|
736
754
|
# @param id [String]
|
|
737
755
|
# @param [Hash] opts the optional parameters
|
|
738
756
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -753,7 +771,7 @@ module KlaviyoAPI
|
|
|
753
771
|
# header parameters
|
|
754
772
|
header_params = opts[:header_params] || {}
|
|
755
773
|
# klaviyo api revision
|
|
756
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
774
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
757
775
|
# HTTP header 'Accept' (if needed)
|
|
758
776
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
759
777
|
|
|
@@ -790,10 +808,10 @@ module KlaviyoAPI
|
|
|
790
808
|
alias get_segment_relationships_tags_with_http_info get_tag_ids_for_segment_with_http_info
|
|
791
809
|
|
|
792
810
|
# Get Tags for Segment
|
|
793
|
-
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
|
811
|
+
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_segment.json)
|
|
794
812
|
# @param id [String]
|
|
795
813
|
# @param [Hash] opts the optional parameters
|
|
796
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
814
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
797
815
|
# @return [Hash<String, Object>]
|
|
798
816
|
def get_tags_for_segment(id, opts = {})
|
|
799
817
|
data, _status_code, _headers = get_tags_for_segment_with_http_info(id, opts)
|
|
@@ -804,10 +822,10 @@ module KlaviyoAPI
|
|
|
804
822
|
alias get_segment_tags get_tags_for_segment
|
|
805
823
|
|
|
806
824
|
# Get Tags for Segment
|
|
807
|
-
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
|
825
|
+
# Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_segment.json)
|
|
808
826
|
# @param id [String]
|
|
809
827
|
# @param [Hash] opts the optional parameters
|
|
810
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
828
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
811
829
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
812
830
|
def get_tags_for_segment_with_http_info(id, opts = {})
|
|
813
831
|
if @api_client.config.debugging
|
|
@@ -817,7 +835,7 @@ module KlaviyoAPI
|
|
|
817
835
|
if @api_client.config.client_side_validation && id.nil?
|
|
818
836
|
fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_tags_for_segment"
|
|
819
837
|
end
|
|
820
|
-
allowable_values = ["name"]
|
|
838
|
+
allowable_values = ["id", "name"]
|
|
821
839
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
822
840
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
823
841
|
end
|
|
@@ -831,7 +849,7 @@ module KlaviyoAPI
|
|
|
831
849
|
# header parameters
|
|
832
850
|
header_params = opts[:header_params] || {}
|
|
833
851
|
# klaviyo api revision
|
|
834
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
852
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
835
853
|
# HTTP header 'Accept' (if needed)
|
|
836
854
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
837
855
|
|
|
@@ -868,10 +886,11 @@ module KlaviyoAPI
|
|
|
868
886
|
alias get_segment_tags_with_http_info get_tags_for_segment_with_http_info
|
|
869
887
|
|
|
870
888
|
# Update Segment
|
|
871
|
-
# Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`
|
|
889
|
+
# Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_segment.json)
|
|
872
890
|
# @param id [String]
|
|
873
891
|
# @param segment_partial_update_query [SegmentPartialUpdateQuery]
|
|
874
892
|
# @param [Hash] opts the optional parameters
|
|
893
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
875
894
|
# @return [Hash<String, Object>]
|
|
876
895
|
def update_segment(id, segment_partial_update_query, opts = {})
|
|
877
896
|
data, _status_code, _headers = update_segment_with_http_info(id, segment_partial_update_query, opts)
|
|
@@ -879,10 +898,11 @@ module KlaviyoAPI
|
|
|
879
898
|
end
|
|
880
899
|
|
|
881
900
|
# Update Segment
|
|
882
|
-
# Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`
|
|
901
|
+
# Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_segment.json)
|
|
883
902
|
# @param id [String]
|
|
884
903
|
# @param segment_partial_update_query [SegmentPartialUpdateQuery]
|
|
885
904
|
# @param [Hash] opts the optional parameters
|
|
905
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
886
906
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
887
907
|
def update_segment_with_http_info(id, segment_partial_update_query, opts = {})
|
|
888
908
|
if @api_client.config.debugging
|
|
@@ -896,16 +916,21 @@ module KlaviyoAPI
|
|
|
896
916
|
if @api_client.config.client_side_validation && segment_partial_update_query.nil?
|
|
897
917
|
fail ArgumentError, "Missing the required parameter 'segment_partial_update_query' when calling SegmentsApi.update_segment"
|
|
898
918
|
end
|
|
919
|
+
allowable_values = ["created", "definition", "definition.condition_groups", "id", "is_active", "is_processing", "is_starred", "name", "updated"]
|
|
920
|
+
if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
|
|
921
|
+
fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
|
|
922
|
+
end
|
|
899
923
|
# resource path
|
|
900
924
|
local_var_path = '/api/segments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
901
925
|
|
|
902
926
|
# query parameters
|
|
903
927
|
query_params = opts[:query_params] || {}
|
|
928
|
+
query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
|
|
904
929
|
|
|
905
930
|
# header parameters
|
|
906
931
|
header_params = opts[:header_params] || {}
|
|
907
932
|
# klaviyo api revision
|
|
908
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
933
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
909
934
|
# HTTP header 'Accept' (if needed)
|
|
910
935
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
911
936
|
# HTTP header 'Content-Type'
|