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 Tag
|
|
22
|
-
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
22
|
+
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag.json)
|
|
23
23
|
# @param tag_create_query [TagCreateQuery]
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Array<String>] :fields_tag 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_tag(tag_create_query, opts = {})
|
|
27
28
|
data, _status_code, _headers = create_tag_with_http_info(tag_create_query, opts)
|
|
@@ -29,9 +30,10 @@ module KlaviyoAPI
|
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# Create Tag
|
|
32
|
-
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
33
|
+
# Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag.json)
|
|
33
34
|
# @param tag_create_query [TagCreateQuery]
|
|
34
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @option opts [Array<String>] :fields_tag 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_tag_with_http_info(tag_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 && tag_create_query.nil?
|
|
42
44
|
fail ArgumentError, "Missing the required parameter 'tag_create_query' when calling TagsApi.create_tag"
|
|
43
45
|
end
|
|
46
|
+
allowable_values = ["id", "name"]
|
|
47
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
48
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
49
|
+
end
|
|
44
50
|
# resource path
|
|
45
51
|
local_var_path = '/api/tags'
|
|
46
52
|
|
|
47
53
|
# query parameters
|
|
48
54
|
query_params = opts[:query_params] || {}
|
|
55
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].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,9 +96,10 @@ module KlaviyoAPI
|
|
|
89
96
|
end
|
|
90
97
|
|
|
91
98
|
# Create Tag Group
|
|
92
|
-
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
99
|
+
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag_group.json)
|
|
93
100
|
# @param tag_group_create_query [TagGroupCreateQuery]
|
|
94
101
|
# @param [Hash] opts the optional parameters
|
|
102
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
95
103
|
# @return [Hash<String, Object>]
|
|
96
104
|
def create_tag_group(tag_group_create_query, opts = {})
|
|
97
105
|
data, _status_code, _headers = create_tag_group_with_http_info(tag_group_create_query, opts)
|
|
@@ -99,9 +107,10 @@ module KlaviyoAPI
|
|
|
99
107
|
end
|
|
100
108
|
|
|
101
109
|
# Create Tag Group
|
|
102
|
-
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
110
|
+
# Create a tag group. An account cannot have more than **50** unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag_group.json)
|
|
103
111
|
# @param tag_group_create_query [TagGroupCreateQuery]
|
|
104
112
|
# @param [Hash] opts the optional parameters
|
|
113
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
105
114
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
106
115
|
def create_tag_group_with_http_info(tag_group_create_query, opts = {})
|
|
107
116
|
if @api_client.config.debugging
|
|
@@ -111,16 +120,21 @@ module KlaviyoAPI
|
|
|
111
120
|
if @api_client.config.client_side_validation && tag_group_create_query.nil?
|
|
112
121
|
fail ArgumentError, "Missing the required parameter 'tag_group_create_query' when calling TagsApi.create_tag_group"
|
|
113
122
|
end
|
|
123
|
+
allowable_values = ["default", "exclusive", "id", "name"]
|
|
124
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
|
125
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
|
126
|
+
end
|
|
114
127
|
# resource path
|
|
115
128
|
local_var_path = '/api/tag-groups'
|
|
116
129
|
|
|
117
130
|
# query parameters
|
|
118
131
|
query_params = opts[:query_params] || {}
|
|
132
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
|
119
133
|
|
|
120
134
|
# header parameters
|
|
121
135
|
header_params = opts[:header_params] || {}
|
|
122
136
|
# klaviyo api revision
|
|
123
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
137
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
124
138
|
# HTTP header 'Accept' (if needed)
|
|
125
139
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
126
140
|
# HTTP header 'Content-Type'
|
|
@@ -159,7 +173,7 @@ module KlaviyoAPI
|
|
|
159
173
|
end
|
|
160
174
|
|
|
161
175
|
# Delete Tag
|
|
162
|
-
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
176
|
+
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag.json)
|
|
163
177
|
# @param id [String] The Tag ID
|
|
164
178
|
# @param [Hash] opts the optional parameters
|
|
165
179
|
# @return [nil]
|
|
@@ -169,7 +183,7 @@ module KlaviyoAPI
|
|
|
169
183
|
end
|
|
170
184
|
|
|
171
185
|
# Delete Tag
|
|
172
|
-
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
186
|
+
# Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag.json)
|
|
173
187
|
# @param id [String] The Tag ID
|
|
174
188
|
# @param [Hash] opts the optional parameters
|
|
175
189
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -190,7 +204,7 @@ module KlaviyoAPI
|
|
|
190
204
|
# header parameters
|
|
191
205
|
header_params = opts[:header_params] || {}
|
|
192
206
|
# klaviyo api revision
|
|
193
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
207
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
194
208
|
# HTTP header 'Accept' (if needed)
|
|
195
209
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
196
210
|
|
|
@@ -224,20 +238,20 @@ module KlaviyoAPI
|
|
|
224
238
|
end
|
|
225
239
|
|
|
226
240
|
# Delete Tag Group
|
|
227
|
-
# Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
241
|
+
# Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag_group.json)
|
|
228
242
|
# @param id [String] The Tag Group ID
|
|
229
243
|
# @param [Hash] opts the optional parameters
|
|
230
|
-
# @return [
|
|
244
|
+
# @return [nil]
|
|
231
245
|
def delete_tag_group(id, opts = {})
|
|
232
|
-
|
|
233
|
-
|
|
246
|
+
delete_tag_group_with_http_info(id, opts)
|
|
247
|
+
nil
|
|
234
248
|
end
|
|
235
249
|
|
|
236
250
|
# Delete Tag Group
|
|
237
|
-
# Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
251
|
+
# Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag_group.json)
|
|
238
252
|
# @param id [String] The Tag Group ID
|
|
239
253
|
# @param [Hash] opts the optional parameters
|
|
240
|
-
# @return [Array<(
|
|
254
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
241
255
|
def delete_tag_group_with_http_info(id, opts = {})
|
|
242
256
|
if @api_client.config.debugging
|
|
243
257
|
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_group ...'
|
|
@@ -255,7 +269,7 @@ module KlaviyoAPI
|
|
|
255
269
|
# header parameters
|
|
256
270
|
header_params = opts[:header_params] || {}
|
|
257
271
|
# klaviyo api revision
|
|
258
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
272
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
259
273
|
# HTTP header 'Accept' (if needed)
|
|
260
274
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
261
275
|
|
|
@@ -266,7 +280,7 @@ module KlaviyoAPI
|
|
|
266
280
|
post_body = opts[:debug_body]
|
|
267
281
|
|
|
268
282
|
# return_type
|
|
269
|
-
return_type = opts[:debug_return_type]
|
|
283
|
+
return_type = opts[:debug_return_type]
|
|
270
284
|
|
|
271
285
|
# auth_names
|
|
272
286
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
|
@@ -289,7 +303,7 @@ module KlaviyoAPI
|
|
|
289
303
|
end
|
|
290
304
|
|
|
291
305
|
# Get Campaign IDs for Tag
|
|
292
|
-
# Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
|
306
|
+
# Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_ids_for_tag.json)
|
|
293
307
|
# @param id [String] The Tag ID
|
|
294
308
|
# @param [Hash] opts the optional parameters
|
|
295
309
|
# @return [Hash<String, Object>]
|
|
@@ -302,7 +316,7 @@ module KlaviyoAPI
|
|
|
302
316
|
alias get_tag_relationships_campaigns get_campaign_ids_for_tag
|
|
303
317
|
|
|
304
318
|
# Get Campaign IDs for Tag
|
|
305
|
-
# Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
|
319
|
+
# Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_ids_for_tag.json)
|
|
306
320
|
# @param id [String] The Tag ID
|
|
307
321
|
# @param [Hash] opts the optional parameters
|
|
308
322
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -323,7 +337,7 @@ module KlaviyoAPI
|
|
|
323
337
|
# header parameters
|
|
324
338
|
header_params = opts[:header_params] || {}
|
|
325
339
|
# klaviyo api revision
|
|
326
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
340
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
327
341
|
# HTTP header 'Accept' (if needed)
|
|
328
342
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
329
343
|
|
|
@@ -360,7 +374,7 @@ module KlaviyoAPI
|
|
|
360
374
|
alias get_tag_relationships_campaigns_with_http_info get_campaign_ids_for_tag_with_http_info
|
|
361
375
|
|
|
362
376
|
# Get Flow IDs for Tag
|
|
363
|
-
# Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
|
377
|
+
# Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_ids_for_tag.json)
|
|
364
378
|
# @param id [String] The Tag ID
|
|
365
379
|
# @param [Hash] opts the optional parameters
|
|
366
380
|
# @return [Hash<String, Object>]
|
|
@@ -373,7 +387,7 @@ module KlaviyoAPI
|
|
|
373
387
|
alias get_tag_relationships_flows get_flow_ids_for_tag
|
|
374
388
|
|
|
375
389
|
# Get Flow IDs for Tag
|
|
376
|
-
# Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
|
390
|
+
# Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_ids_for_tag.json)
|
|
377
391
|
# @param id [String] The Tag ID
|
|
378
392
|
# @param [Hash] opts the optional parameters
|
|
379
393
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -394,7 +408,7 @@ module KlaviyoAPI
|
|
|
394
408
|
# header parameters
|
|
395
409
|
header_params = opts[:header_params] || {}
|
|
396
410
|
# klaviyo api revision
|
|
397
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
411
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
398
412
|
# HTTP header 'Accept' (if needed)
|
|
399
413
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
400
414
|
|
|
@@ -431,7 +445,7 @@ module KlaviyoAPI
|
|
|
431
445
|
alias get_tag_relationships_flows_with_http_info get_flow_ids_for_tag_with_http_info
|
|
432
446
|
|
|
433
447
|
# Get List IDs for Tag
|
|
434
|
-
# Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
|
448
|
+
# Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_tag.json)
|
|
435
449
|
# @param id [String] The Tag ID
|
|
436
450
|
# @param [Hash] opts the optional parameters
|
|
437
451
|
# @return [Hash<String, Object>]
|
|
@@ -444,7 +458,7 @@ module KlaviyoAPI
|
|
|
444
458
|
alias get_tag_relationships_lists get_list_ids_for_tag
|
|
445
459
|
|
|
446
460
|
# Get List IDs for Tag
|
|
447
|
-
# Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
|
461
|
+
# Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_tag.json)
|
|
448
462
|
# @param id [String] The Tag ID
|
|
449
463
|
# @param [Hash] opts the optional parameters
|
|
450
464
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -465,7 +479,7 @@ module KlaviyoAPI
|
|
|
465
479
|
# header parameters
|
|
466
480
|
header_params = opts[:header_params] || {}
|
|
467
481
|
# klaviyo api revision
|
|
468
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
482
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
469
483
|
# HTTP header 'Accept' (if needed)
|
|
470
484
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
471
485
|
|
|
@@ -502,7 +516,7 @@ module KlaviyoAPI
|
|
|
502
516
|
alias get_tag_relationships_lists_with_http_info get_list_ids_for_tag_with_http_info
|
|
503
517
|
|
|
504
518
|
# Get Segment IDs for Tag
|
|
505
|
-
# Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
|
519
|
+
# Returns the IDs of all segments associated with the given tag.<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_segment_ids_for_tag.json)
|
|
506
520
|
# @param id [String] The Tag ID
|
|
507
521
|
# @param [Hash] opts the optional parameters
|
|
508
522
|
# @return [Hash<String, Object>]
|
|
@@ -515,7 +529,7 @@ module KlaviyoAPI
|
|
|
515
529
|
alias get_tag_relationships_segments get_segment_ids_for_tag
|
|
516
530
|
|
|
517
531
|
# Get Segment IDs for Tag
|
|
518
|
-
# Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
|
|
532
|
+
# Returns the IDs of all segments associated with the given tag.<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_segment_ids_for_tag.json)
|
|
519
533
|
# @param id [String] The Tag ID
|
|
520
534
|
# @param [Hash] opts the optional parameters
|
|
521
535
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -536,7 +550,7 @@ module KlaviyoAPI
|
|
|
536
550
|
# header parameters
|
|
537
551
|
header_params = opts[:header_params] || {}
|
|
538
552
|
# klaviyo api revision
|
|
539
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
553
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
540
554
|
# HTTP header 'Accept' (if needed)
|
|
541
555
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
542
556
|
|
|
@@ -573,12 +587,12 @@ module KlaviyoAPI
|
|
|
573
587
|
alias get_tag_relationships_segments_with_http_info get_segment_ids_for_tag_with_http_info
|
|
574
588
|
|
|
575
589
|
# Get Tag
|
|
576
|
-
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
590
|
+
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag.json)
|
|
577
591
|
# @param id [String] The Tag ID
|
|
578
592
|
# @param [Hash] opts the optional parameters
|
|
579
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
580
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
581
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
593
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
594
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
595
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
582
596
|
# @return [Hash<String, Object>]
|
|
583
597
|
def get_tag(id, opts = {})
|
|
584
598
|
data, _status_code, _headers = get_tag_with_http_info(id, opts)
|
|
@@ -586,12 +600,12 @@ module KlaviyoAPI
|
|
|
586
600
|
end
|
|
587
601
|
|
|
588
602
|
# Get Tag
|
|
589
|
-
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
603
|
+
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag.json)
|
|
590
604
|
# @param id [String] The Tag ID
|
|
591
605
|
# @param [Hash] opts the optional parameters
|
|
592
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
593
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
594
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
606
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
607
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
608
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
595
609
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
596
610
|
def get_tag_with_http_info(id, opts = {})
|
|
597
611
|
if @api_client.config.debugging
|
|
@@ -601,11 +615,11 @@ module KlaviyoAPI
|
|
|
601
615
|
if @api_client.config.client_side_validation && id.nil?
|
|
602
616
|
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
|
603
617
|
end
|
|
604
|
-
allowable_values = ["default", "exclusive", "name"]
|
|
618
|
+
allowable_values = ["default", "exclusive", "id", "name"]
|
|
605
619
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
|
606
620
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
|
607
621
|
end
|
|
608
|
-
allowable_values = ["name"]
|
|
622
|
+
allowable_values = ["id", "name"]
|
|
609
623
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
610
624
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
611
625
|
end
|
|
@@ -625,7 +639,7 @@ module KlaviyoAPI
|
|
|
625
639
|
# header parameters
|
|
626
640
|
header_params = opts[:header_params] || {}
|
|
627
641
|
# klaviyo api revision
|
|
628
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
642
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
629
643
|
# HTTP header 'Accept' (if needed)
|
|
630
644
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
631
645
|
|
|
@@ -659,10 +673,10 @@ module KlaviyoAPI
|
|
|
659
673
|
end
|
|
660
674
|
|
|
661
675
|
# Get Tag Group
|
|
662
|
-
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
676
|
+
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group.json)
|
|
663
677
|
# @param id [String] The Tag Group ID
|
|
664
678
|
# @param [Hash] opts the optional parameters
|
|
665
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
679
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
666
680
|
# @return [Hash<String, Object>]
|
|
667
681
|
def get_tag_group(id, opts = {})
|
|
668
682
|
data, _status_code, _headers = get_tag_group_with_http_info(id, opts)
|
|
@@ -670,10 +684,10 @@ module KlaviyoAPI
|
|
|
670
684
|
end
|
|
671
685
|
|
|
672
686
|
# Get Tag Group
|
|
673
|
-
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
687
|
+
# Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group.json)
|
|
674
688
|
# @param id [String] The Tag Group ID
|
|
675
689
|
# @param [Hash] opts the optional parameters
|
|
676
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
690
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
677
691
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
678
692
|
def get_tag_group_with_http_info(id, opts = {})
|
|
679
693
|
if @api_client.config.debugging
|
|
@@ -683,7 +697,7 @@ module KlaviyoAPI
|
|
|
683
697
|
if @api_client.config.client_side_validation && id.nil?
|
|
684
698
|
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group"
|
|
685
699
|
end
|
|
686
|
-
allowable_values = ["default", "exclusive", "name"]
|
|
700
|
+
allowable_values = ["default", "exclusive", "id", "name"]
|
|
687
701
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
|
688
702
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
|
689
703
|
end
|
|
@@ -697,7 +711,7 @@ module KlaviyoAPI
|
|
|
697
711
|
# header parameters
|
|
698
712
|
header_params = opts[:header_params] || {}
|
|
699
713
|
# klaviyo api revision
|
|
700
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
714
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
701
715
|
# HTTP header 'Accept' (if needed)
|
|
702
716
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
703
717
|
|
|
@@ -731,10 +745,10 @@ module KlaviyoAPI
|
|
|
731
745
|
end
|
|
732
746
|
|
|
733
747
|
# Get Tag Group for Tag
|
|
734
|
-
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
748
|
+
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_for_tag.json)
|
|
735
749
|
# @param id [String] The Tag ID
|
|
736
750
|
# @param [Hash] opts the optional parameters
|
|
737
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
751
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
738
752
|
# @return [Hash<String, Object>]
|
|
739
753
|
def get_tag_group_for_tag(id, opts = {})
|
|
740
754
|
data, _status_code, _headers = get_tag_group_for_tag_with_http_info(id, opts)
|
|
@@ -748,10 +762,10 @@ module KlaviyoAPI
|
|
|
748
762
|
alias get_group_for_tag get_tag_group_for_tag
|
|
749
763
|
|
|
750
764
|
# Get Tag Group for Tag
|
|
751
|
-
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
765
|
+
# Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_for_tag.json)
|
|
752
766
|
# @param id [String] The Tag ID
|
|
753
767
|
# @param [Hash] opts the optional parameters
|
|
754
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
768
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
755
769
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
756
770
|
def get_tag_group_for_tag_with_http_info(id, opts = {})
|
|
757
771
|
if @api_client.config.debugging
|
|
@@ -761,7 +775,7 @@ module KlaviyoAPI
|
|
|
761
775
|
if @api_client.config.client_side_validation && id.nil?
|
|
762
776
|
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group_for_tag"
|
|
763
777
|
end
|
|
764
|
-
allowable_values = ["default", "exclusive", "name"]
|
|
778
|
+
allowable_values = ["default", "exclusive", "id", "name"]
|
|
765
779
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
|
766
780
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
|
767
781
|
end
|
|
@@ -775,7 +789,7 @@ module KlaviyoAPI
|
|
|
775
789
|
# header parameters
|
|
776
790
|
header_params = opts[:header_params] || {}
|
|
777
791
|
# klaviyo api revision
|
|
778
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
792
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
779
793
|
# HTTP header 'Accept' (if needed)
|
|
780
794
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
781
795
|
|
|
@@ -815,7 +829,7 @@ module KlaviyoAPI
|
|
|
815
829
|
alias get_group_for_tag_with_http_info get_tag_group_for_tag_with_http_info
|
|
816
830
|
|
|
817
831
|
# Get Tag Group ID for Tag
|
|
818
|
-
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
832
|
+
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_id_for_tag.json)
|
|
819
833
|
# @param id [String] The Tag ID
|
|
820
834
|
# @param [Hash] opts the optional parameters
|
|
821
835
|
# @return [Hash<String, Object>]
|
|
@@ -834,7 +848,7 @@ module KlaviyoAPI
|
|
|
834
848
|
alias get_tag_relationships_group get_tag_group_id_for_tag
|
|
835
849
|
|
|
836
850
|
# Get Tag Group ID for Tag
|
|
837
|
-
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
851
|
+
# Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_id_for_tag.json)
|
|
838
852
|
# @param id [String] The Tag ID
|
|
839
853
|
# @param [Hash] opts the optional parameters
|
|
840
854
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -855,7 +869,7 @@ module KlaviyoAPI
|
|
|
855
869
|
# header parameters
|
|
856
870
|
header_params = opts[:header_params] || {}
|
|
857
871
|
# klaviyo api revision
|
|
858
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
872
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
859
873
|
# HTTP header 'Accept' (if needed)
|
|
860
874
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
861
875
|
|
|
@@ -898,12 +912,13 @@ module KlaviyoAPI
|
|
|
898
912
|
alias get_tag_relationships_group_with_http_info get_tag_group_id_for_tag_with_http_info
|
|
899
913
|
|
|
900
914
|
# Get Tag Groups
|
|
901
|
-
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
915
|
+
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_groups.json)
|
|
902
916
|
# @param [Hash] opts the optional parameters
|
|
903
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
904
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
905
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
906
|
-
# @option opts [
|
|
917
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
918
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
|
919
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
920
|
+
# @option opts [Integer] :page_size Default: 25. Min: 1. Max: 25. (default to 25)
|
|
921
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
907
922
|
# @return [Hash<String, Object>]
|
|
908
923
|
def get_tag_groups(opts = {})
|
|
909
924
|
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
|
@@ -911,21 +926,30 @@ module KlaviyoAPI
|
|
|
911
926
|
end
|
|
912
927
|
|
|
913
928
|
# Get Tag Groups
|
|
914
|
-
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
929
|
+
# List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_groups.json)
|
|
915
930
|
# @param [Hash] opts the optional parameters
|
|
916
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
917
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
918
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
919
|
-
# @option opts [
|
|
931
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
932
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
|
|
933
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
934
|
+
# @option opts [Integer] :page_size Default: 25. Min: 1. Max: 25. (default to 25)
|
|
935
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
920
936
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
921
937
|
def get_tag_groups_with_http_info(opts = {})
|
|
922
938
|
if @api_client.config.debugging
|
|
923
939
|
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_groups ...'
|
|
924
940
|
end
|
|
925
|
-
allowable_values = ["default", "exclusive", "name"]
|
|
941
|
+
allowable_values = ["default", "exclusive", "id", "name"]
|
|
926
942
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
|
927
943
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
|
928
944
|
end
|
|
945
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 25
|
|
946
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TagsApi.get_tag_groups, must be smaller than or equal to 25.'
|
|
947
|
+
end
|
|
948
|
+
|
|
949
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
950
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TagsApi.get_tag_groups, must be greater than or equal to 1.'
|
|
951
|
+
end
|
|
952
|
+
|
|
929
953
|
allowable_values = ["id", "-id", "name", "-name"]
|
|
930
954
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
931
955
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -938,12 +962,13 @@ module KlaviyoAPI
|
|
|
938
962
|
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
|
939
963
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
940
964
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
965
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
941
966
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
942
967
|
|
|
943
968
|
# header parameters
|
|
944
969
|
header_params = opts[:header_params] || {}
|
|
945
970
|
# klaviyo api revision
|
|
946
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
971
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
947
972
|
# HTTP header 'Accept' (if needed)
|
|
948
973
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
949
974
|
|
|
@@ -977,7 +1002,7 @@ module KlaviyoAPI
|
|
|
977
1002
|
end
|
|
978
1003
|
|
|
979
1004
|
# Get Tag IDs for Tag Group
|
|
980
|
-
# Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
1005
|
+
# Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_tag_group.json)
|
|
981
1006
|
# @param id [String] The Tag Group ID
|
|
982
1007
|
# @param [Hash] opts the optional parameters
|
|
983
1008
|
# @return [Hash<String, Object>]
|
|
@@ -990,7 +1015,7 @@ module KlaviyoAPI
|
|
|
990
1015
|
alias get_tag_group_relationships_tags get_tag_ids_for_tag_group
|
|
991
1016
|
|
|
992
1017
|
# Get Tag IDs for Tag Group
|
|
993
|
-
# Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
1018
|
+
# Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_tag_group.json)
|
|
994
1019
|
# @param id [String] The Tag Group ID
|
|
995
1020
|
# @param [Hash] opts the optional parameters
|
|
996
1021
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -1011,7 +1036,7 @@ module KlaviyoAPI
|
|
|
1011
1036
|
# header parameters
|
|
1012
1037
|
header_params = opts[:header_params] || {}
|
|
1013
1038
|
# klaviyo api revision
|
|
1014
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1039
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1015
1040
|
# HTTP header 'Accept' (if needed)
|
|
1016
1041
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1017
1042
|
|
|
@@ -1048,14 +1073,15 @@ module KlaviyoAPI
|
|
|
1048
1073
|
alias get_tag_group_relationships_tags_with_http_info get_tag_ids_for_tag_group_with_http_info
|
|
1049
1074
|
|
|
1050
1075
|
# Get Tags
|
|
1051
|
-
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
1076
|
+
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags.json)
|
|
1052
1077
|
# @param [Hash] opts the optional parameters
|
|
1053
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1054
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1055
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1056
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1057
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1058
|
-
# @option opts [
|
|
1078
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1079
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1080
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
|
1081
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1082
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1083
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1084
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1059
1085
|
# @return [Hash<String, Object>]
|
|
1060
1086
|
def get_tags(opts = {})
|
|
1061
1087
|
data, _status_code, _headers = get_tags_with_http_info(opts)
|
|
@@ -1063,24 +1089,25 @@ module KlaviyoAPI
|
|
|
1063
1089
|
end
|
|
1064
1090
|
|
|
1065
1091
|
# Get Tags
|
|
1066
|
-
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
1092
|
+
# List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags.json)
|
|
1067
1093
|
# @param [Hash] opts the optional parameters
|
|
1068
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1069
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1070
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1071
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1072
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1073
|
-
# @option opts [
|
|
1094
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1095
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1096
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
|
1097
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
|
|
1098
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
|
|
1099
|
+
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
|
1100
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sorting
|
|
1074
1101
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1075
1102
|
def get_tags_with_http_info(opts = {})
|
|
1076
1103
|
if @api_client.config.debugging
|
|
1077
1104
|
@api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...'
|
|
1078
1105
|
end
|
|
1079
|
-
allowable_values = ["default", "exclusive", "name"]
|
|
1106
|
+
allowable_values = ["default", "exclusive", "id", "name"]
|
|
1080
1107
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
|
1081
1108
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
|
1082
1109
|
end
|
|
1083
|
-
allowable_values = ["name"]
|
|
1110
|
+
allowable_values = ["id", "name"]
|
|
1084
1111
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
1085
1112
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
1086
1113
|
end
|
|
@@ -1088,6 +1115,14 @@ module KlaviyoAPI
|
|
|
1088
1115
|
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
|
1089
1116
|
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
|
1090
1117
|
end
|
|
1118
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50
|
|
1119
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TagsApi.get_tags, must be smaller than or equal to 50.'
|
|
1120
|
+
end
|
|
1121
|
+
|
|
1122
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
|
1123
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TagsApi.get_tags, must be greater than or equal to 1.'
|
|
1124
|
+
end
|
|
1125
|
+
|
|
1091
1126
|
allowable_values = ["id", "-id", "name", "-name"]
|
|
1092
1127
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
1093
1128
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
@@ -1102,12 +1137,13 @@ module KlaviyoAPI
|
|
|
1102
1137
|
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
1103
1138
|
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
1104
1139
|
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
|
1140
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
1105
1141
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
1106
1142
|
|
|
1107
1143
|
# header parameters
|
|
1108
1144
|
header_params = opts[:header_params] || {}
|
|
1109
1145
|
# klaviyo api revision
|
|
1110
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1146
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1111
1147
|
# HTTP header 'Accept' (if needed)
|
|
1112
1148
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1113
1149
|
|
|
@@ -1141,10 +1177,10 @@ module KlaviyoAPI
|
|
|
1141
1177
|
end
|
|
1142
1178
|
|
|
1143
1179
|
# Get Tags for Tag Group
|
|
1144
|
-
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
1180
|
+
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_tag_group.json)
|
|
1145
1181
|
# @param id [String] The Tag Group ID
|
|
1146
1182
|
# @param [Hash] opts the optional parameters
|
|
1147
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1183
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1148
1184
|
# @return [Hash<String, Object>]
|
|
1149
1185
|
def get_tags_for_tag_group(id, opts = {})
|
|
1150
1186
|
data, _status_code, _headers = get_tags_for_tag_group_with_http_info(id, opts)
|
|
@@ -1155,10 +1191,10 @@ module KlaviyoAPI
|
|
|
1155
1191
|
alias get_tag_group_tags get_tags_for_tag_group
|
|
1156
1192
|
|
|
1157
1193
|
# Get Tags for Tag Group
|
|
1158
|
-
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
|
1194
|
+
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_tag_group.json)
|
|
1159
1195
|
# @param id [String] The Tag Group ID
|
|
1160
1196
|
# @param [Hash] opts the optional parameters
|
|
1161
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-
|
|
1197
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
|
|
1162
1198
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
1163
1199
|
def get_tags_for_tag_group_with_http_info(id, opts = {})
|
|
1164
1200
|
if @api_client.config.debugging
|
|
@@ -1168,7 +1204,7 @@ module KlaviyoAPI
|
|
|
1168
1204
|
if @api_client.config.client_side_validation && id.nil?
|
|
1169
1205
|
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tags_for_tag_group"
|
|
1170
1206
|
end
|
|
1171
|
-
allowable_values = ["name"]
|
|
1207
|
+
allowable_values = ["id", "name"]
|
|
1172
1208
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
|
1173
1209
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
|
1174
1210
|
end
|
|
@@ -1182,7 +1218,7 @@ module KlaviyoAPI
|
|
|
1182
1218
|
# header parameters
|
|
1183
1219
|
header_params = opts[:header_params] || {}
|
|
1184
1220
|
# klaviyo api revision
|
|
1185
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1221
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1186
1222
|
# HTTP header 'Accept' (if needed)
|
|
1187
1223
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1188
1224
|
|
|
@@ -1219,7 +1255,7 @@ module KlaviyoAPI
|
|
|
1219
1255
|
alias get_tag_group_tags_with_http_info get_tags_for_tag_group_with_http_info
|
|
1220
1256
|
|
|
1221
1257
|
# Remove Tag from Campaigns
|
|
1222
|
-
# Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
|
1258
|
+
# Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_campaigns.json)
|
|
1223
1259
|
# @param id [String] The Tag ID
|
|
1224
1260
|
# @param tag_campaign_op [TagCampaignOp]
|
|
1225
1261
|
# @param [Hash] opts the optional parameters
|
|
@@ -1236,7 +1272,7 @@ module KlaviyoAPI
|
|
|
1236
1272
|
alias remove_campaigns_from_tag remove_tag_from_campaigns
|
|
1237
1273
|
|
|
1238
1274
|
# Remove Tag from Campaigns
|
|
1239
|
-
# Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
|
1275
|
+
# Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_campaigns.json)
|
|
1240
1276
|
# @param id [String] The Tag ID
|
|
1241
1277
|
# @param tag_campaign_op [TagCampaignOp]
|
|
1242
1278
|
# @param [Hash] opts the optional parameters
|
|
@@ -1262,7 +1298,7 @@ module KlaviyoAPI
|
|
|
1262
1298
|
# header parameters
|
|
1263
1299
|
header_params = opts[:header_params] || {}
|
|
1264
1300
|
# klaviyo api revision
|
|
1265
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1301
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1266
1302
|
# HTTP header 'Accept' (if needed)
|
|
1267
1303
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1268
1304
|
# HTTP header 'Content-Type'
|
|
@@ -1307,7 +1343,7 @@ module KlaviyoAPI
|
|
|
1307
1343
|
alias remove_campaigns_from_tag_with_http_info remove_tag_from_campaigns_with_http_info
|
|
1308
1344
|
|
|
1309
1345
|
# Remove Tag from Flows
|
|
1310
|
-
# Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
|
1346
|
+
# Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_flows.json)
|
|
1311
1347
|
# @param id [String] The Tag ID
|
|
1312
1348
|
# @param tag_flow_op [TagFlowOp]
|
|
1313
1349
|
# @param [Hash] opts the optional parameters
|
|
@@ -1324,7 +1360,7 @@ module KlaviyoAPI
|
|
|
1324
1360
|
alias remove_flows_from_tag remove_tag_from_flows
|
|
1325
1361
|
|
|
1326
1362
|
# Remove Tag from Flows
|
|
1327
|
-
# Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
|
1363
|
+
# Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_flows.json)
|
|
1328
1364
|
# @param id [String] The Tag ID
|
|
1329
1365
|
# @param tag_flow_op [TagFlowOp]
|
|
1330
1366
|
# @param [Hash] opts the optional parameters
|
|
@@ -1350,7 +1386,7 @@ module KlaviyoAPI
|
|
|
1350
1386
|
# header parameters
|
|
1351
1387
|
header_params = opts[:header_params] || {}
|
|
1352
1388
|
# klaviyo api revision
|
|
1353
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1389
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1354
1390
|
# HTTP header 'Accept' (if needed)
|
|
1355
1391
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1356
1392
|
# HTTP header 'Content-Type'
|
|
@@ -1395,7 +1431,7 @@ module KlaviyoAPI
|
|
|
1395
1431
|
alias remove_flows_from_tag_with_http_info remove_tag_from_flows_with_http_info
|
|
1396
1432
|
|
|
1397
1433
|
# Remove Tag from Lists
|
|
1398
|
-
# Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write`
|
|
1434
|
+
# Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_lists.json)
|
|
1399
1435
|
# @param id [String] The Tag ID
|
|
1400
1436
|
# @param tag_list_op [TagListOp]
|
|
1401
1437
|
# @param [Hash] opts the optional parameters
|
|
@@ -1412,7 +1448,7 @@ module KlaviyoAPI
|
|
|
1412
1448
|
alias remove_lists_from_tag remove_tag_from_lists
|
|
1413
1449
|
|
|
1414
1450
|
# Remove Tag from Lists
|
|
1415
|
-
# Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write`
|
|
1451
|
+
# Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_lists.json)
|
|
1416
1452
|
# @param id [String] The Tag ID
|
|
1417
1453
|
# @param tag_list_op [TagListOp]
|
|
1418
1454
|
# @param [Hash] opts the optional parameters
|
|
@@ -1438,7 +1474,7 @@ module KlaviyoAPI
|
|
|
1438
1474
|
# header parameters
|
|
1439
1475
|
header_params = opts[:header_params] || {}
|
|
1440
1476
|
# klaviyo api revision
|
|
1441
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1477
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1442
1478
|
# HTTP header 'Accept' (if needed)
|
|
1443
1479
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1444
1480
|
# HTTP header 'Content-Type'
|
|
@@ -1483,7 +1519,7 @@ module KlaviyoAPI
|
|
|
1483
1519
|
alias remove_lists_from_tag_with_http_info remove_tag_from_lists_with_http_info
|
|
1484
1520
|
|
|
1485
1521
|
# Remove Tag from Segments
|
|
1486
|
-
# Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
|
1522
|
+
# Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_segments.json)
|
|
1487
1523
|
# @param id [String] The Tag ID
|
|
1488
1524
|
# @param tag_segment_op [TagSegmentOp]
|
|
1489
1525
|
# @param [Hash] opts the optional parameters
|
|
@@ -1500,7 +1536,7 @@ module KlaviyoAPI
|
|
|
1500
1536
|
alias remove_segments_from_tag remove_tag_from_segments
|
|
1501
1537
|
|
|
1502
1538
|
# Remove Tag from Segments
|
|
1503
|
-
# Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
|
1539
|
+
# Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_segments.json)
|
|
1504
1540
|
# @param id [String] The Tag ID
|
|
1505
1541
|
# @param tag_segment_op [TagSegmentOp]
|
|
1506
1542
|
# @param [Hash] opts the optional parameters
|
|
@@ -1526,7 +1562,7 @@ module KlaviyoAPI
|
|
|
1526
1562
|
# header parameters
|
|
1527
1563
|
header_params = opts[:header_params] || {}
|
|
1528
1564
|
# klaviyo api revision
|
|
1529
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1565
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1530
1566
|
# HTTP header 'Accept' (if needed)
|
|
1531
1567
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1532
1568
|
# HTTP header 'Content-Type'
|
|
@@ -1571,7 +1607,7 @@ module KlaviyoAPI
|
|
|
1571
1607
|
alias remove_segments_from_tag_with_http_info remove_tag_from_segments_with_http_info
|
|
1572
1608
|
|
|
1573
1609
|
# Tag Campaigns
|
|
1574
|
-
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
|
1610
|
+
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_campaigns.json)
|
|
1575
1611
|
# @param id [String] The Tag ID
|
|
1576
1612
|
# @param tag_campaign_op [TagCampaignOp]
|
|
1577
1613
|
# @param [Hash] opts the optional parameters
|
|
@@ -1591,7 +1627,7 @@ module KlaviyoAPI
|
|
|
1591
1627
|
alias create_tag_relationships_campaigns tag_campaigns
|
|
1592
1628
|
|
|
1593
1629
|
# Tag Campaigns
|
|
1594
|
-
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write`
|
|
1630
|
+
# Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_campaigns.json)
|
|
1595
1631
|
# @param id [String] The Tag ID
|
|
1596
1632
|
# @param tag_campaign_op [TagCampaignOp]
|
|
1597
1633
|
# @param [Hash] opts the optional parameters
|
|
@@ -1617,7 +1653,7 @@ module KlaviyoAPI
|
|
|
1617
1653
|
# header parameters
|
|
1618
1654
|
header_params = opts[:header_params] || {}
|
|
1619
1655
|
# klaviyo api revision
|
|
1620
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1656
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1621
1657
|
# HTTP header 'Accept' (if needed)
|
|
1622
1658
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1623
1659
|
# HTTP header 'Content-Type'
|
|
@@ -1665,7 +1701,7 @@ module KlaviyoAPI
|
|
|
1665
1701
|
alias create_tag_relationships_campaigns_with_http_info tag_campaigns_with_http_info
|
|
1666
1702
|
|
|
1667
1703
|
# Tag Flows
|
|
1668
|
-
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
|
1704
|
+
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_flows.json)
|
|
1669
1705
|
# @param id [String] The Tag ID
|
|
1670
1706
|
# @param tag_flow_op [TagFlowOp]
|
|
1671
1707
|
# @param [Hash] opts the optional parameters
|
|
@@ -1685,7 +1721,7 @@ module KlaviyoAPI
|
|
|
1685
1721
|
alias create_tag_relationships_flows tag_flows
|
|
1686
1722
|
|
|
1687
1723
|
# Tag Flows
|
|
1688
|
-
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write`
|
|
1724
|
+
# Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_flows.json)
|
|
1689
1725
|
# @param id [String] The Tag ID
|
|
1690
1726
|
# @param tag_flow_op [TagFlowOp]
|
|
1691
1727
|
# @param [Hash] opts the optional parameters
|
|
@@ -1711,7 +1747,7 @@ module KlaviyoAPI
|
|
|
1711
1747
|
# header parameters
|
|
1712
1748
|
header_params = opts[:header_params] || {}
|
|
1713
1749
|
# klaviyo api revision
|
|
1714
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1750
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1715
1751
|
# HTTP header 'Accept' (if needed)
|
|
1716
1752
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1717
1753
|
# HTTP header 'Content-Type'
|
|
@@ -1759,7 +1795,7 @@ module KlaviyoAPI
|
|
|
1759
1795
|
alias create_tag_relationships_flows_with_http_info tag_flows_with_http_info
|
|
1760
1796
|
|
|
1761
1797
|
# Tag Lists
|
|
1762
|
-
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write`
|
|
1798
|
+
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_lists.json)
|
|
1763
1799
|
# @param id [String] The Tag ID
|
|
1764
1800
|
# @param tag_list_op [TagListOp]
|
|
1765
1801
|
# @param [Hash] opts the optional parameters
|
|
@@ -1779,7 +1815,7 @@ module KlaviyoAPI
|
|
|
1779
1815
|
alias create_tag_relationships_lists tag_lists
|
|
1780
1816
|
|
|
1781
1817
|
# Tag Lists
|
|
1782
|
-
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write`
|
|
1818
|
+
# Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_lists.json)
|
|
1783
1819
|
# @param id [String] The Tag ID
|
|
1784
1820
|
# @param tag_list_op [TagListOp]
|
|
1785
1821
|
# @param [Hash] opts the optional parameters
|
|
@@ -1805,7 +1841,7 @@ module KlaviyoAPI
|
|
|
1805
1841
|
# header parameters
|
|
1806
1842
|
header_params = opts[:header_params] || {}
|
|
1807
1843
|
# klaviyo api revision
|
|
1808
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1844
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1809
1845
|
# HTTP header 'Accept' (if needed)
|
|
1810
1846
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1811
1847
|
# HTTP header 'Content-Type'
|
|
@@ -1853,7 +1889,7 @@ module KlaviyoAPI
|
|
|
1853
1889
|
alias create_tag_relationships_lists_with_http_info tag_lists_with_http_info
|
|
1854
1890
|
|
|
1855
1891
|
# Tag Segments
|
|
1856
|
-
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
|
1892
|
+
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_segments.json)
|
|
1857
1893
|
# @param id [String] The Tag ID
|
|
1858
1894
|
# @param tag_segment_op [TagSegmentOp]
|
|
1859
1895
|
# @param [Hash] opts the optional parameters
|
|
@@ -1873,7 +1909,7 @@ module KlaviyoAPI
|
|
|
1873
1909
|
alias create_tag_relationships_segments tag_segments
|
|
1874
1910
|
|
|
1875
1911
|
# Tag Segments
|
|
1876
|
-
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write`
|
|
1912
|
+
# Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_segments.json)
|
|
1877
1913
|
# @param id [String] The Tag ID
|
|
1878
1914
|
# @param tag_segment_op [TagSegmentOp]
|
|
1879
1915
|
# @param [Hash] opts the optional parameters
|
|
@@ -1899,7 +1935,7 @@ module KlaviyoAPI
|
|
|
1899
1935
|
# header parameters
|
|
1900
1936
|
header_params = opts[:header_params] || {}
|
|
1901
1937
|
# klaviyo api revision
|
|
1902
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
1938
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1903
1939
|
# HTTP header 'Accept' (if needed)
|
|
1904
1940
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1905
1941
|
# HTTP header 'Content-Type'
|
|
@@ -1947,7 +1983,7 @@ module KlaviyoAPI
|
|
|
1947
1983
|
alias create_tag_relationships_segments_with_http_info tag_segments_with_http_info
|
|
1948
1984
|
|
|
1949
1985
|
# Update Tag
|
|
1950
|
-
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
1986
|
+
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag.json)
|
|
1951
1987
|
# @param id [String] The Tag ID
|
|
1952
1988
|
# @param tag_update_query [TagUpdateQuery]
|
|
1953
1989
|
# @param [Hash] opts the optional parameters
|
|
@@ -1958,7 +1994,7 @@ module KlaviyoAPI
|
|
|
1958
1994
|
end
|
|
1959
1995
|
|
|
1960
1996
|
# Update Tag
|
|
1961
|
-
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
1997
|
+
# Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag.json)
|
|
1962
1998
|
# @param id [String] The Tag ID
|
|
1963
1999
|
# @param tag_update_query [TagUpdateQuery]
|
|
1964
2000
|
# @param [Hash] opts the optional parameters
|
|
@@ -1984,7 +2020,7 @@ module KlaviyoAPI
|
|
|
1984
2020
|
# header parameters
|
|
1985
2021
|
header_params = opts[:header_params] || {}
|
|
1986
2022
|
# klaviyo api revision
|
|
1987
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2023
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
1988
2024
|
# HTTP header 'Accept' (if needed)
|
|
1989
2025
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
1990
2026
|
# HTTP header 'Content-Type'
|
|
@@ -2023,22 +2059,22 @@ module KlaviyoAPI
|
|
|
2023
2059
|
end
|
|
2024
2060
|
|
|
2025
2061
|
# Update Tag Group
|
|
2026
|
-
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
2062
|
+
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag_group.json)
|
|
2027
2063
|
# @param id [String] The Tag Group ID
|
|
2028
2064
|
# @param tag_group_update_query [TagGroupUpdateQuery]
|
|
2029
2065
|
# @param [Hash] opts the optional parameters
|
|
2030
|
-
# @return [
|
|
2066
|
+
# @return [nil]
|
|
2031
2067
|
def update_tag_group(id, tag_group_update_query, opts = {})
|
|
2032
|
-
|
|
2033
|
-
|
|
2068
|
+
update_tag_group_with_http_info(id, tag_group_update_query, opts)
|
|
2069
|
+
nil
|
|
2034
2070
|
end
|
|
2035
2071
|
|
|
2036
2072
|
# Update Tag Group
|
|
2037
|
-
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
|
|
2073
|
+
# Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag_group.json)
|
|
2038
2074
|
# @param id [String] The Tag Group ID
|
|
2039
2075
|
# @param tag_group_update_query [TagGroupUpdateQuery]
|
|
2040
2076
|
# @param [Hash] opts the optional parameters
|
|
2041
|
-
# @return [Array<(
|
|
2077
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2042
2078
|
def update_tag_group_with_http_info(id, tag_group_update_query, opts = {})
|
|
2043
2079
|
if @api_client.config.debugging
|
|
2044
2080
|
@api_client.config.logger.debug 'Calling API: TagsApi.update_tag_group ...'
|
|
@@ -2060,7 +2096,7 @@ module KlaviyoAPI
|
|
|
2060
2096
|
# header parameters
|
|
2061
2097
|
header_params = opts[:header_params] || {}
|
|
2062
2098
|
# klaviyo api revision
|
|
2063
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-
|
|
2099
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
|
|
2064
2100
|
# HTTP header 'Accept' (if needed)
|
|
2065
2101
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
|
2066
2102
|
# HTTP header 'Content-Type'
|
|
@@ -2076,7 +2112,7 @@ module KlaviyoAPI
|
|
|
2076
2112
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_group_update_query)
|
|
2077
2113
|
|
|
2078
2114
|
# return_type
|
|
2079
|
-
return_type = opts[:debug_return_type]
|
|
2115
|
+
return_type = opts[:debug_return_type]
|
|
2080
2116
|
|
|
2081
2117
|
# auth_names
|
|
2082
2118
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|