klaviyo-api-sdk 8.0.0 → 10.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 +289 -0
- data/README.md +1414 -402
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +645 -573
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +1764 -1446
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +329 -281
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +11 -5
- data/lib/klaviyo-api-sdk/api/events_api.rb +140 -122
- data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
- data/lib/klaviyo-api-sdk/api/forms_api.rb +80 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +40 -28
- data/lib/klaviyo-api-sdk/api/lists_api.rb +328 -153
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +590 -21
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +1054 -548
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +341 -19
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +212 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +341 -166
- data/lib/klaviyo-api-sdk/api/tags_api.rb +745 -625
- data/lib/klaviyo-api-sdk/api/templates_api.rb +493 -84
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +250 -0
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +32 -32
- data/lib/klaviyo-api-sdk/api_client.rb +2 -2
- data/lib/klaviyo-api-sdk/api_error.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +1 -1
- data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/block_display_options.rb +274 -0
- data/lib/klaviyo-api-sdk/models/block_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +239 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/content_repeat.rb +238 -0
- data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +245 -0
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +3 -3
- data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +288 -0
- data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb +105 -0
- data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +273 -0
- data/lib/klaviyo-api-sdk/models/{utm_params_sub_object.rb → flow_tracking_setting_static_param.rb} +15 -16
- data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +314 -0
- data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +287 -0
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
- data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/html_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +248 -0
- data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +2 -7
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
- data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +58 -3
- metadata +64 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2024-
|
6
|
+
The version of the OpenAPI document: 2024-10-15
|
7
7
|
Contact: developers@klaviyo.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.2.1
|
@@ -43,7 +43,7 @@ module KlaviyoAPI
|
|
43
43
|
fail ArgumentError, "Missing the required parameter 'tag_create_query' when calling TagsApi.create_tag"
|
44
44
|
end
|
45
45
|
# resource path
|
46
|
-
local_var_path = '/api/tags
|
46
|
+
local_var_path = '/api/tags'
|
47
47
|
|
48
48
|
# query parameters
|
49
49
|
query_params = opts[:query_params] || {}
|
@@ -51,11 +51,11 @@ module KlaviyoAPI
|
|
51
51
|
# header parameters
|
52
52
|
header_params = opts[:header_params] || {}
|
53
53
|
# klaviyo api revision
|
54
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
54
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
55
55
|
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
57
57
|
# HTTP header 'Content-Type'
|
58
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
58
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
59
59
|
if !content_type.nil?
|
60
60
|
header_params['Content-Type'] = content_type
|
61
61
|
end
|
@@ -113,7 +113,7 @@ module KlaviyoAPI
|
|
113
113
|
fail ArgumentError, "Missing the required parameter 'tag_group_create_query' when calling TagsApi.create_tag_group"
|
114
114
|
end
|
115
115
|
# resource path
|
116
|
-
local_var_path = '/api/tag-groups
|
116
|
+
local_var_path = '/api/tag-groups'
|
117
117
|
|
118
118
|
# query parameters
|
119
119
|
query_params = opts[:query_params] || {}
|
@@ -121,11 +121,11 @@ module KlaviyoAPI
|
|
121
121
|
# header parameters
|
122
122
|
header_params = opts[:header_params] || {}
|
123
123
|
# klaviyo api revision
|
124
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
124
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
125
125
|
# HTTP header 'Accept' (if needed)
|
126
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
126
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
127
127
|
# HTTP header 'Content-Type'
|
128
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
128
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
129
129
|
if !content_type.nil?
|
130
130
|
header_params['Content-Type'] = content_type
|
131
131
|
end
|
@@ -159,37 +159,31 @@ module KlaviyoAPI
|
|
159
159
|
return data, status_code, headers
|
160
160
|
end
|
161
161
|
|
162
|
-
#
|
163
|
-
#
|
164
|
-
# @param id [String]
|
165
|
-
# @param tag_campaign_op [TagCampaignOp]
|
162
|
+
# Delete Tag
|
163
|
+
# 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`
|
164
|
+
# @param id [String] The Tag ID
|
166
165
|
# @param [Hash] opts the optional parameters
|
167
166
|
# @return [nil]
|
168
|
-
def
|
169
|
-
|
167
|
+
def delete_tag(id, opts = {})
|
168
|
+
delete_tag_with_http_info(id, opts)
|
170
169
|
nil
|
171
170
|
end
|
172
171
|
|
173
|
-
#
|
174
|
-
#
|
175
|
-
# @param id [String]
|
176
|
-
# @param tag_campaign_op [TagCampaignOp]
|
172
|
+
# Delete Tag
|
173
|
+
# 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`
|
174
|
+
# @param id [String] The Tag ID
|
177
175
|
# @param [Hash] opts the optional parameters
|
178
176
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
179
|
-
def
|
177
|
+
def delete_tag_with_http_info(id, opts = {})
|
180
178
|
if @api_client.config.debugging
|
181
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
179
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
|
182
180
|
end
|
183
181
|
# verify the required parameter 'id' is set
|
184
182
|
if @api_client.config.client_side_validation && id.nil?
|
185
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
186
|
-
end
|
187
|
-
# verify the required parameter 'tag_campaign_op' is set
|
188
|
-
if @api_client.config.client_side_validation && tag_campaign_op.nil?
|
189
|
-
fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.create_tag_relationships_campaigns"
|
183
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag"
|
190
184
|
end
|
191
185
|
# resource path
|
192
|
-
local_var_path = '/api/tags/{id}
|
186
|
+
local_var_path = '/api/tags/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
193
187
|
|
194
188
|
# query parameters
|
195
189
|
query_params = opts[:query_params] || {}
|
@@ -197,20 +191,15 @@ module KlaviyoAPI
|
|
197
191
|
# header parameters
|
198
192
|
header_params = opts[:header_params] || {}
|
199
193
|
# klaviyo api revision
|
200
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
194
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
201
195
|
# HTTP header 'Accept' (if needed)
|
202
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
|
-
# HTTP header 'Content-Type'
|
204
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
205
|
-
if !content_type.nil?
|
206
|
-
header_params['Content-Type'] = content_type
|
207
|
-
end
|
196
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
208
197
|
|
209
198
|
# form parameters
|
210
199
|
form_params = opts[:form_params] || {}
|
211
200
|
|
212
201
|
# http body (model)
|
213
|
-
post_body = opts[:debug_body]
|
202
|
+
post_body = opts[:debug_body]
|
214
203
|
|
215
204
|
# return_type
|
216
205
|
return_type = opts[:debug_return_type]
|
@@ -219,7 +208,7 @@ module KlaviyoAPI
|
|
219
208
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
220
209
|
|
221
210
|
new_options = opts.merge(
|
222
|
-
:operation => :"TagsApi.
|
211
|
+
:operation => :"TagsApi.delete_tag",
|
223
212
|
:header_params => header_params,
|
224
213
|
:query_params => query_params,
|
225
214
|
:form_params => form_params,
|
@@ -228,44 +217,38 @@ module KlaviyoAPI
|
|
228
217
|
:return_type => return_type
|
229
218
|
)
|
230
219
|
|
231
|
-
data, status_code, headers = @api_client.call_api(:
|
220
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
232
221
|
if @api_client.config.debugging
|
233
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
222
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
234
223
|
end
|
235
224
|
return data, status_code, headers
|
236
225
|
end
|
237
226
|
|
238
|
-
#
|
239
|
-
#
|
240
|
-
# @param id [String]
|
241
|
-
# @param tag_flow_op [TagFlowOp]
|
227
|
+
# Delete Tag Group
|
228
|
+
# 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`
|
229
|
+
# @param id [String] The Tag Group ID
|
242
230
|
# @param [Hash] opts the optional parameters
|
243
|
-
# @return [
|
244
|
-
def
|
245
|
-
|
246
|
-
|
231
|
+
# @return [Hash<String, Object>]
|
232
|
+
def delete_tag_group(id, opts = {})
|
233
|
+
data, _status_code, _headers = delete_tag_group_with_http_info(id, opts)
|
234
|
+
data
|
247
235
|
end
|
248
236
|
|
249
|
-
#
|
250
|
-
#
|
251
|
-
# @param id [String]
|
252
|
-
# @param tag_flow_op [TagFlowOp]
|
237
|
+
# Delete Tag Group
|
238
|
+
# 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`
|
239
|
+
# @param id [String] The Tag Group ID
|
253
240
|
# @param [Hash] opts the optional parameters
|
254
|
-
# @return [Array<(
|
255
|
-
def
|
241
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
242
|
+
def delete_tag_group_with_http_info(id, opts = {})
|
256
243
|
if @api_client.config.debugging
|
257
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
244
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_group ...'
|
258
245
|
end
|
259
246
|
# verify the required parameter 'id' is set
|
260
247
|
if @api_client.config.client_side_validation && id.nil?
|
261
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
262
|
-
end
|
263
|
-
# verify the required parameter 'tag_flow_op' is set
|
264
|
-
if @api_client.config.client_side_validation && tag_flow_op.nil?
|
265
|
-
fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.create_tag_relationships_flows"
|
248
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.delete_tag_group"
|
266
249
|
end
|
267
250
|
# resource path
|
268
|
-
local_var_path = '/api/
|
251
|
+
local_var_path = '/api/tag-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
269
252
|
|
270
253
|
# query parameters
|
271
254
|
query_params = opts[:query_params] || {}
|
@@ -273,29 +256,24 @@ module KlaviyoAPI
|
|
273
256
|
# header parameters
|
274
257
|
header_params = opts[:header_params] || {}
|
275
258
|
# klaviyo api revision
|
276
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
259
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
277
260
|
# HTTP header 'Accept' (if needed)
|
278
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
|
-
# HTTP header 'Content-Type'
|
280
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
281
|
-
if !content_type.nil?
|
282
|
-
header_params['Content-Type'] = content_type
|
283
|
-
end
|
261
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
284
262
|
|
285
263
|
# form parameters
|
286
264
|
form_params = opts[:form_params] || {}
|
287
265
|
|
288
266
|
# http body (model)
|
289
|
-
post_body = opts[:debug_body]
|
267
|
+
post_body = opts[:debug_body]
|
290
268
|
|
291
269
|
# return_type
|
292
|
-
return_type = opts[:debug_return_type]
|
270
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
293
271
|
|
294
272
|
# auth_names
|
295
273
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
296
274
|
|
297
275
|
new_options = opts.merge(
|
298
|
-
:operation => :"TagsApi.
|
276
|
+
:operation => :"TagsApi.delete_tag_group",
|
299
277
|
:header_params => header_params,
|
300
278
|
:query_params => query_params,
|
301
279
|
:form_params => form_params,
|
@@ -304,44 +282,41 @@ module KlaviyoAPI
|
|
304
282
|
:return_type => return_type
|
305
283
|
)
|
306
284
|
|
307
|
-
data, status_code, headers = @api_client.call_api(:
|
285
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
308
286
|
if @api_client.config.debugging
|
309
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
287
|
+
@api_client.config.logger.debug "API called: TagsApi#delete_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
310
288
|
end
|
311
289
|
return data, status_code, headers
|
312
290
|
end
|
313
291
|
|
314
|
-
#
|
315
|
-
#
|
316
|
-
# @param id [String]
|
317
|
-
# @param tag_list_op [TagListOp]
|
292
|
+
# Get Campaign IDs for Tag
|
293
|
+
# 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`
|
294
|
+
# @param id [String] The Tag ID
|
318
295
|
# @param [Hash] opts the optional parameters
|
319
|
-
# @return [
|
320
|
-
def
|
321
|
-
|
322
|
-
|
296
|
+
# @return [Hash<String, Object>]
|
297
|
+
def get_campaign_ids_for_tag(id, opts = {})
|
298
|
+
data, _status_code, _headers = get_campaign_ids_for_tag_with_http_info(id, opts)
|
299
|
+
data
|
323
300
|
end
|
324
301
|
|
325
|
-
#
|
326
|
-
|
327
|
-
|
328
|
-
#
|
302
|
+
# alias of `get_campaign_ids_for_tag`
|
303
|
+
alias get_tag_relationships_campaigns get_campaign_ids_for_tag
|
304
|
+
|
305
|
+
# Get Campaign IDs for Tag
|
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`
|
307
|
+
# @param id [String] The Tag ID
|
329
308
|
# @param [Hash] opts the optional parameters
|
330
|
-
# @return [Array<(
|
331
|
-
def
|
309
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
310
|
+
def get_campaign_ids_for_tag_with_http_info(id, opts = {})
|
332
311
|
if @api_client.config.debugging
|
333
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
312
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_campaign_ids_for_tag ...'
|
334
313
|
end
|
335
314
|
# verify the required parameter 'id' is set
|
336
315
|
if @api_client.config.client_side_validation && id.nil?
|
337
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
338
|
-
end
|
339
|
-
# verify the required parameter 'tag_list_op' is set
|
340
|
-
if @api_client.config.client_side_validation && tag_list_op.nil?
|
341
|
-
fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.create_tag_relationships_lists"
|
316
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_campaign_ids_for_tag"
|
342
317
|
end
|
343
318
|
# resource path
|
344
|
-
local_var_path = '/api/tags/{id}/relationships/
|
319
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
345
320
|
|
346
321
|
# query parameters
|
347
322
|
query_params = opts[:query_params] || {}
|
@@ -349,29 +324,24 @@ module KlaviyoAPI
|
|
349
324
|
# header parameters
|
350
325
|
header_params = opts[:header_params] || {}
|
351
326
|
# klaviyo api revision
|
352
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
327
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
353
328
|
# HTTP header 'Accept' (if needed)
|
354
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
355
|
-
# HTTP header 'Content-Type'
|
356
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
357
|
-
if !content_type.nil?
|
358
|
-
header_params['Content-Type'] = content_type
|
359
|
-
end
|
329
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
360
330
|
|
361
331
|
# form parameters
|
362
332
|
form_params = opts[:form_params] || {}
|
363
333
|
|
364
334
|
# http body (model)
|
365
|
-
post_body = opts[:debug_body]
|
335
|
+
post_body = opts[:debug_body]
|
366
336
|
|
367
337
|
# return_type
|
368
|
-
return_type = opts[:debug_return_type]
|
338
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
369
339
|
|
370
340
|
# auth_names
|
371
341
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
372
342
|
|
373
343
|
new_options = opts.merge(
|
374
|
-
:operation => :"TagsApi.
|
344
|
+
:operation => :"TagsApi.get_campaign_ids_for_tag",
|
375
345
|
:header_params => header_params,
|
376
346
|
:query_params => query_params,
|
377
347
|
:form_params => form_params,
|
@@ -380,44 +350,44 @@ module KlaviyoAPI
|
|
380
350
|
:return_type => return_type
|
381
351
|
)
|
382
352
|
|
383
|
-
data, status_code, headers = @api_client.call_api(:
|
353
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
384
354
|
if @api_client.config.debugging
|
385
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
355
|
+
@api_client.config.logger.debug "API called: TagsApi#get_campaign_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
386
356
|
end
|
387
357
|
return data, status_code, headers
|
388
358
|
end
|
389
359
|
|
390
|
-
#
|
391
|
-
|
392
|
-
|
393
|
-
#
|
360
|
+
# alias of `get_campaign_ids_for_tag_with_http_info`
|
361
|
+
alias get_tag_relationships_campaigns_with_http_info get_campaign_ids_for_tag_with_http_info
|
362
|
+
|
363
|
+
# Get Flow IDs for Tag
|
364
|
+
# 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`
|
365
|
+
# @param id [String] The Tag ID
|
394
366
|
# @param [Hash] opts the optional parameters
|
395
|
-
# @return [
|
396
|
-
def
|
397
|
-
|
398
|
-
|
367
|
+
# @return [Hash<String, Object>]
|
368
|
+
def get_flow_ids_for_tag(id, opts = {})
|
369
|
+
data, _status_code, _headers = get_flow_ids_for_tag_with_http_info(id, opts)
|
370
|
+
data
|
399
371
|
end
|
400
372
|
|
401
|
-
#
|
402
|
-
|
403
|
-
|
404
|
-
#
|
373
|
+
# alias of `get_flow_ids_for_tag`
|
374
|
+
alias get_tag_relationships_flows get_flow_ids_for_tag
|
375
|
+
|
376
|
+
# Get Flow IDs for Tag
|
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`
|
378
|
+
# @param id [String] The Tag ID
|
405
379
|
# @param [Hash] opts the optional parameters
|
406
|
-
# @return [Array<(
|
407
|
-
def
|
380
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
381
|
+
def get_flow_ids_for_tag_with_http_info(id, opts = {})
|
408
382
|
if @api_client.config.debugging
|
409
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
383
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_flow_ids_for_tag ...'
|
410
384
|
end
|
411
385
|
# verify the required parameter 'id' is set
|
412
386
|
if @api_client.config.client_side_validation && id.nil?
|
413
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
414
|
-
end
|
415
|
-
# verify the required parameter 'tag_segment_op' is set
|
416
|
-
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
417
|
-
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.create_tag_relationships_segments"
|
387
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_flow_ids_for_tag"
|
418
388
|
end
|
419
389
|
# resource path
|
420
|
-
local_var_path = '/api/tags/{id}/relationships/
|
390
|
+
local_var_path = '/api/tags/{id}/relationships/flows'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
421
391
|
|
422
392
|
# query parameters
|
423
393
|
query_params = opts[:query_params] || {}
|
@@ -425,29 +395,24 @@ module KlaviyoAPI
|
|
425
395
|
# header parameters
|
426
396
|
header_params = opts[:header_params] || {}
|
427
397
|
# klaviyo api revision
|
428
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
398
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
429
399
|
# HTTP header 'Accept' (if needed)
|
430
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
431
|
-
# HTTP header 'Content-Type'
|
432
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
433
|
-
if !content_type.nil?
|
434
|
-
header_params['Content-Type'] = content_type
|
435
|
-
end
|
400
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
436
401
|
|
437
402
|
# form parameters
|
438
403
|
form_params = opts[:form_params] || {}
|
439
404
|
|
440
405
|
# http body (model)
|
441
|
-
post_body = opts[:debug_body]
|
406
|
+
post_body = opts[:debug_body]
|
442
407
|
|
443
408
|
# return_type
|
444
|
-
return_type = opts[:debug_return_type]
|
409
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
445
410
|
|
446
411
|
# auth_names
|
447
412
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
448
413
|
|
449
414
|
new_options = opts.merge(
|
450
|
-
:operation => :"TagsApi.
|
415
|
+
:operation => :"TagsApi.get_flow_ids_for_tag",
|
451
416
|
:header_params => header_params,
|
452
417
|
:query_params => query_params,
|
453
418
|
:form_params => form_params,
|
@@ -456,38 +421,44 @@ module KlaviyoAPI
|
|
456
421
|
:return_type => return_type
|
457
422
|
)
|
458
423
|
|
459
|
-
data, status_code, headers = @api_client.call_api(:
|
424
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
460
425
|
if @api_client.config.debugging
|
461
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
426
|
+
@api_client.config.logger.debug "API called: TagsApi#get_flow_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
462
427
|
end
|
463
428
|
return data, status_code, headers
|
464
429
|
end
|
465
430
|
|
466
|
-
#
|
467
|
-
|
431
|
+
# alias of `get_flow_ids_for_tag_with_http_info`
|
432
|
+
alias get_tag_relationships_flows_with_http_info get_flow_ids_for_tag_with_http_info
|
433
|
+
|
434
|
+
# Get List IDs for Tag
|
435
|
+
# 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`
|
468
436
|
# @param id [String] The Tag ID
|
469
437
|
# @param [Hash] opts the optional parameters
|
470
|
-
# @return [
|
471
|
-
def
|
472
|
-
|
473
|
-
|
438
|
+
# @return [Hash<String, Object>]
|
439
|
+
def get_list_ids_for_tag(id, opts = {})
|
440
|
+
data, _status_code, _headers = get_list_ids_for_tag_with_http_info(id, opts)
|
441
|
+
data
|
474
442
|
end
|
475
443
|
|
476
|
-
#
|
477
|
-
|
444
|
+
# alias of `get_list_ids_for_tag`
|
445
|
+
alias get_tag_relationships_lists get_list_ids_for_tag
|
446
|
+
|
447
|
+
# Get List IDs for Tag
|
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`
|
478
449
|
# @param id [String] The Tag ID
|
479
450
|
# @param [Hash] opts the optional parameters
|
480
|
-
# @return [Array<(
|
481
|
-
def
|
451
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
452
|
+
def get_list_ids_for_tag_with_http_info(id, opts = {})
|
482
453
|
if @api_client.config.debugging
|
483
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
454
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_list_ids_for_tag ...'
|
484
455
|
end
|
485
456
|
# verify the required parameter 'id' is set
|
486
457
|
if @api_client.config.client_side_validation && id.nil?
|
487
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
458
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_list_ids_for_tag"
|
488
459
|
end
|
489
460
|
# resource path
|
490
|
-
local_var_path = '/api/tags/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
461
|
+
local_var_path = '/api/tags/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
491
462
|
|
492
463
|
# query parameters
|
493
464
|
query_params = opts[:query_params] || {}
|
@@ -495,9 +466,9 @@ module KlaviyoAPI
|
|
495
466
|
# header parameters
|
496
467
|
header_params = opts[:header_params] || {}
|
497
468
|
# klaviyo api revision
|
498
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
469
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
499
470
|
# HTTP header 'Accept' (if needed)
|
500
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
471
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
501
472
|
|
502
473
|
# form parameters
|
503
474
|
form_params = opts[:form_params] || {}
|
@@ -506,13 +477,13 @@ module KlaviyoAPI
|
|
506
477
|
post_body = opts[:debug_body]
|
507
478
|
|
508
479
|
# return_type
|
509
|
-
return_type = opts[:debug_return_type]
|
480
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
510
481
|
|
511
482
|
# auth_names
|
512
483
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
513
484
|
|
514
485
|
new_options = opts.merge(
|
515
|
-
:operation => :"TagsApi.
|
486
|
+
:operation => :"TagsApi.get_list_ids_for_tag",
|
516
487
|
:header_params => header_params,
|
517
488
|
:query_params => query_params,
|
518
489
|
:form_params => form_params,
|
@@ -521,38 +492,44 @@ module KlaviyoAPI
|
|
521
492
|
:return_type => return_type
|
522
493
|
)
|
523
494
|
|
524
|
-
data, status_code, headers = @api_client.call_api(:
|
495
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
525
496
|
if @api_client.config.debugging
|
526
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
497
|
+
@api_client.config.logger.debug "API called: TagsApi#get_list_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
527
498
|
end
|
528
499
|
return data, status_code, headers
|
529
500
|
end
|
530
501
|
|
531
|
-
#
|
532
|
-
|
533
|
-
|
502
|
+
# alias of `get_list_ids_for_tag_with_http_info`
|
503
|
+
alias get_tag_relationships_lists_with_http_info get_list_ids_for_tag_with_http_info
|
504
|
+
|
505
|
+
# Get Segment IDs for Tag
|
506
|
+
# 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`
|
507
|
+
# @param id [String] The Tag ID
|
534
508
|
# @param [Hash] opts the optional parameters
|
535
509
|
# @return [Hash<String, Object>]
|
536
|
-
def
|
537
|
-
data, _status_code, _headers =
|
510
|
+
def get_segment_ids_for_tag(id, opts = {})
|
511
|
+
data, _status_code, _headers = get_segment_ids_for_tag_with_http_info(id, opts)
|
538
512
|
data
|
539
513
|
end
|
540
514
|
|
541
|
-
#
|
542
|
-
|
543
|
-
|
515
|
+
# alias of `get_segment_ids_for_tag`
|
516
|
+
alias get_tag_relationships_segments get_segment_ids_for_tag
|
517
|
+
|
518
|
+
# Get Segment IDs for Tag
|
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`
|
520
|
+
# @param id [String] The Tag ID
|
544
521
|
# @param [Hash] opts the optional parameters
|
545
522
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
546
|
-
def
|
523
|
+
def get_segment_ids_for_tag_with_http_info(id, opts = {})
|
547
524
|
if @api_client.config.debugging
|
548
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
525
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_segment_ids_for_tag ...'
|
549
526
|
end
|
550
527
|
# verify the required parameter 'id' is set
|
551
528
|
if @api_client.config.client_side_validation && id.nil?
|
552
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
529
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_segment_ids_for_tag"
|
553
530
|
end
|
554
531
|
# resource path
|
555
|
-
local_var_path = '/api/
|
532
|
+
local_var_path = '/api/tags/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
556
533
|
|
557
534
|
# query parameters
|
558
535
|
query_params = opts[:query_params] || {}
|
@@ -560,9 +537,9 @@ module KlaviyoAPI
|
|
560
537
|
# header parameters
|
561
538
|
header_params = opts[:header_params] || {}
|
562
539
|
# klaviyo api revision
|
563
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
540
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
564
541
|
# HTTP header 'Accept' (if needed)
|
565
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
542
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
566
543
|
|
567
544
|
# form parameters
|
568
545
|
form_params = opts[:form_params] || {}
|
@@ -577,7 +554,7 @@ module KlaviyoAPI
|
|
577
554
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
578
555
|
|
579
556
|
new_options = opts.merge(
|
580
|
-
:operation => :"TagsApi.
|
557
|
+
:operation => :"TagsApi.get_segment_ids_for_tag",
|
581
558
|
:header_params => header_params,
|
582
559
|
:query_params => query_params,
|
583
560
|
:form_params => form_params,
|
@@ -586,74 +563,87 @@ module KlaviyoAPI
|
|
586
563
|
:return_type => return_type
|
587
564
|
)
|
588
565
|
|
589
|
-
data, status_code, headers = @api_client.call_api(:
|
566
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
590
567
|
if @api_client.config.debugging
|
591
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
568
|
+
@api_client.config.logger.debug "API called: TagsApi#get_segment_ids_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
592
569
|
end
|
593
570
|
return data, status_code, headers
|
594
571
|
end
|
595
572
|
|
596
|
-
#
|
597
|
-
|
598
|
-
|
599
|
-
#
|
573
|
+
# alias of `get_segment_ids_for_tag_with_http_info`
|
574
|
+
alias get_tag_relationships_segments_with_http_info get_segment_ids_for_tag_with_http_info
|
575
|
+
|
576
|
+
# Get Tag
|
577
|
+
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
578
|
+
# @param id [String] The Tag ID
|
600
579
|
# @param [Hash] opts the optional parameters
|
601
|
-
# @
|
602
|
-
|
603
|
-
|
604
|
-
|
580
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
581
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
582
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
583
|
+
# @return [Hash<String, Object>]
|
584
|
+
def get_tag(id, opts = {})
|
585
|
+
data, _status_code, _headers = get_tag_with_http_info(id, opts)
|
586
|
+
data
|
605
587
|
end
|
606
588
|
|
607
|
-
#
|
608
|
-
#
|
609
|
-
# @param id [String]
|
610
|
-
# @param tag_campaign_op [TagCampaignOp]
|
589
|
+
# Get Tag
|
590
|
+
# Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
591
|
+
# @param id [String] The Tag ID
|
611
592
|
# @param [Hash] opts the optional parameters
|
612
|
-
# @
|
613
|
-
|
593
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
594
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
595
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
596
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
597
|
+
def get_tag_with_http_info(id, opts = {})
|
614
598
|
if @api_client.config.debugging
|
615
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
599
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag ...'
|
616
600
|
end
|
617
601
|
# verify the required parameter 'id' is set
|
618
602
|
if @api_client.config.client_side_validation && id.nil?
|
619
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
603
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
620
604
|
end
|
621
|
-
|
622
|
-
if @api_client.config.client_side_validation &&
|
623
|
-
fail ArgumentError, "
|
605
|
+
allowable_values = ["name", "exclusive", "default"]
|
606
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
607
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
608
|
+
end
|
609
|
+
allowable_values = ["name"]
|
610
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
611
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
612
|
+
end
|
613
|
+
allowable_values = ["tag-group"]
|
614
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
615
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
624
616
|
end
|
625
617
|
# resource path
|
626
|
-
local_var_path = '/api/tags/{id}
|
618
|
+
local_var_path = '/api/tags/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
627
619
|
|
628
620
|
# query parameters
|
629
621
|
query_params = opts[:query_params] || {}
|
622
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
623
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
624
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
630
625
|
|
631
626
|
# header parameters
|
632
627
|
header_params = opts[:header_params] || {}
|
633
628
|
# klaviyo api revision
|
634
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
629
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
635
630
|
# HTTP header 'Accept' (if needed)
|
636
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
637
|
-
# HTTP header 'Content-Type'
|
638
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
639
|
-
if !content_type.nil?
|
640
|
-
header_params['Content-Type'] = content_type
|
641
|
-
end
|
631
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
642
632
|
|
643
633
|
# form parameters
|
644
634
|
form_params = opts[:form_params] || {}
|
645
635
|
|
646
636
|
# http body (model)
|
647
|
-
post_body = opts[:debug_body]
|
637
|
+
post_body = opts[:debug_body]
|
648
638
|
|
649
639
|
# return_type
|
650
|
-
return_type = opts[:debug_return_type]
|
640
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
651
641
|
|
652
642
|
# auth_names
|
653
643
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
654
644
|
|
655
645
|
new_options = opts.merge(
|
656
|
-
:operation => :"TagsApi.
|
646
|
+
:operation => :"TagsApi.get_tag",
|
657
647
|
:header_params => header_params,
|
658
648
|
:query_params => query_params,
|
659
649
|
:form_params => form_params,
|
@@ -662,74 +652,70 @@ module KlaviyoAPI
|
|
662
652
|
:return_type => return_type
|
663
653
|
)
|
664
654
|
|
665
|
-
data, status_code, headers = @api_client.call_api(:
|
655
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
666
656
|
if @api_client.config.debugging
|
667
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
657
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
668
658
|
end
|
669
659
|
return data, status_code, headers
|
670
660
|
end
|
671
661
|
|
672
|
-
#
|
673
|
-
#
|
674
|
-
# @param id [String]
|
675
|
-
# @param tag_flow_op [TagFlowOp]
|
662
|
+
# Get Tag Group
|
663
|
+
# 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`
|
664
|
+
# @param id [String] The Tag Group ID
|
676
665
|
# @param [Hash] opts the optional parameters
|
677
|
-
# @
|
678
|
-
|
679
|
-
|
680
|
-
|
666
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
667
|
+
# @return [Hash<String, Object>]
|
668
|
+
def get_tag_group(id, opts = {})
|
669
|
+
data, _status_code, _headers = get_tag_group_with_http_info(id, opts)
|
670
|
+
data
|
681
671
|
end
|
682
672
|
|
683
|
-
#
|
684
|
-
#
|
685
|
-
# @param id [String]
|
686
|
-
# @param tag_flow_op [TagFlowOp]
|
673
|
+
# Get Tag Group
|
674
|
+
# 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`
|
675
|
+
# @param id [String] The Tag Group ID
|
687
676
|
# @param [Hash] opts the optional parameters
|
688
|
-
# @
|
689
|
-
|
677
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
678
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
679
|
+
def get_tag_group_with_http_info(id, opts = {})
|
690
680
|
if @api_client.config.debugging
|
691
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
681
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group ...'
|
692
682
|
end
|
693
683
|
# verify the required parameter 'id' is set
|
694
684
|
if @api_client.config.client_side_validation && id.nil?
|
695
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
685
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group"
|
696
686
|
end
|
697
|
-
|
698
|
-
if @api_client.config.client_side_validation &&
|
699
|
-
fail ArgumentError, "
|
687
|
+
allowable_values = ["name", "exclusive", "default"]
|
688
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
689
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
700
690
|
end
|
701
691
|
# resource path
|
702
|
-
local_var_path = '/api/
|
692
|
+
local_var_path = '/api/tag-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
703
693
|
|
704
694
|
# query parameters
|
705
695
|
query_params = opts[:query_params] || {}
|
696
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
706
697
|
|
707
698
|
# header parameters
|
708
699
|
header_params = opts[:header_params] || {}
|
709
700
|
# klaviyo api revision
|
710
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
701
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
711
702
|
# HTTP header 'Accept' (if needed)
|
712
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
713
|
-
# HTTP header 'Content-Type'
|
714
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
715
|
-
if !content_type.nil?
|
716
|
-
header_params['Content-Type'] = content_type
|
717
|
-
end
|
703
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
718
704
|
|
719
705
|
# form parameters
|
720
706
|
form_params = opts[:form_params] || {}
|
721
707
|
|
722
708
|
# http body (model)
|
723
|
-
post_body = opts[:debug_body]
|
709
|
+
post_body = opts[:debug_body]
|
724
710
|
|
725
711
|
# return_type
|
726
|
-
return_type = opts[:debug_return_type]
|
712
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
727
713
|
|
728
714
|
# auth_names
|
729
715
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
730
716
|
|
731
717
|
new_options = opts.merge(
|
732
|
-
:operation => :"TagsApi.
|
718
|
+
:operation => :"TagsApi.get_tag_group",
|
733
719
|
:header_params => header_params,
|
734
720
|
:query_params => query_params,
|
735
721
|
:form_params => form_params,
|
@@ -738,74 +724,73 @@ module KlaviyoAPI
|
|
738
724
|
:return_type => return_type
|
739
725
|
)
|
740
726
|
|
741
|
-
data, status_code, headers = @api_client.call_api(:
|
727
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
742
728
|
if @api_client.config.debugging
|
743
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
729
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
744
730
|
end
|
745
731
|
return data, status_code, headers
|
746
732
|
end
|
747
733
|
|
748
|
-
#
|
749
|
-
#
|
750
|
-
# @param id [String]
|
751
|
-
# @param tag_list_op [TagListOp]
|
734
|
+
# Get Tag Group for Tag
|
735
|
+
# 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`
|
736
|
+
# @param id [String] The Tag ID
|
752
737
|
# @param [Hash] opts the optional parameters
|
753
|
-
# @
|
754
|
-
|
755
|
-
|
756
|
-
|
738
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
739
|
+
# @return [Hash<String, Object>]
|
740
|
+
def get_tag_group_for_tag(id, opts = {})
|
741
|
+
data, _status_code, _headers = get_tag_group_for_tag_with_http_info(id, opts)
|
742
|
+
data
|
757
743
|
end
|
758
744
|
|
759
|
-
#
|
760
|
-
|
761
|
-
|
762
|
-
#
|
745
|
+
# alias of `get_tag_group_for_tag`
|
746
|
+
alias get_tag_tag_group get_tag_group_for_tag
|
747
|
+
|
748
|
+
# Get Tag Group for Tag
|
749
|
+
# 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`
|
750
|
+
# @param id [String] The Tag ID
|
763
751
|
# @param [Hash] opts the optional parameters
|
764
|
-
# @
|
765
|
-
|
752
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
753
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
754
|
+
def get_tag_group_for_tag_with_http_info(id, opts = {})
|
766
755
|
if @api_client.config.debugging
|
767
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
756
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_for_tag ...'
|
768
757
|
end
|
769
758
|
# verify the required parameter 'id' is set
|
770
759
|
if @api_client.config.client_side_validation && id.nil?
|
771
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
760
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group_for_tag"
|
772
761
|
end
|
773
|
-
|
774
|
-
if @api_client.config.client_side_validation &&
|
775
|
-
fail ArgumentError, "
|
762
|
+
allowable_values = ["name", "exclusive", "default"]
|
763
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
764
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
776
765
|
end
|
777
766
|
# resource path
|
778
|
-
local_var_path = '/api/tags/{id}/
|
767
|
+
local_var_path = '/api/tags/{id}/tag-group'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
779
768
|
|
780
769
|
# query parameters
|
781
770
|
query_params = opts[:query_params] || {}
|
771
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
782
772
|
|
783
773
|
# header parameters
|
784
774
|
header_params = opts[:header_params] || {}
|
785
775
|
# klaviyo api revision
|
786
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
776
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
787
777
|
# HTTP header 'Accept' (if needed)
|
788
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
789
|
-
# HTTP header 'Content-Type'
|
790
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
791
|
-
if !content_type.nil?
|
792
|
-
header_params['Content-Type'] = content_type
|
793
|
-
end
|
778
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
794
779
|
|
795
780
|
# form parameters
|
796
781
|
form_params = opts[:form_params] || {}
|
797
782
|
|
798
783
|
# http body (model)
|
799
|
-
post_body = opts[:debug_body]
|
784
|
+
post_body = opts[:debug_body]
|
800
785
|
|
801
786
|
# return_type
|
802
|
-
return_type = opts[:debug_return_type]
|
787
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
803
788
|
|
804
789
|
# auth_names
|
805
790
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
806
791
|
|
807
792
|
new_options = opts.merge(
|
808
|
-
:operation => :"TagsApi.
|
793
|
+
:operation => :"TagsApi.get_tag_group_for_tag",
|
809
794
|
:header_params => header_params,
|
810
795
|
:query_params => query_params,
|
811
796
|
:form_params => form_params,
|
@@ -814,44 +799,44 @@ module KlaviyoAPI
|
|
814
799
|
:return_type => return_type
|
815
800
|
)
|
816
801
|
|
817
|
-
data, status_code, headers = @api_client.call_api(:
|
802
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
818
803
|
if @api_client.config.debugging
|
819
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
804
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_group_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
820
805
|
end
|
821
806
|
return data, status_code, headers
|
822
807
|
end
|
823
808
|
|
824
|
-
#
|
825
|
-
|
826
|
-
|
827
|
-
#
|
809
|
+
# alias of `get_tag_group_for_tag_with_http_info`
|
810
|
+
alias get_tag_tag_group_with_http_info get_tag_group_for_tag_with_http_info
|
811
|
+
|
812
|
+
# Get Tag Group ID for Tag
|
813
|
+
# 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`
|
814
|
+
# @param id [String] The Tag ID
|
828
815
|
# @param [Hash] opts the optional parameters
|
829
|
-
# @return [
|
830
|
-
def
|
831
|
-
|
832
|
-
|
816
|
+
# @return [Hash<String, Object>]
|
817
|
+
def get_tag_group_id_for_tag(id, opts = {})
|
818
|
+
data, _status_code, _headers = get_tag_group_id_for_tag_with_http_info(id, opts)
|
819
|
+
data
|
833
820
|
end
|
834
821
|
|
835
|
-
#
|
836
|
-
|
837
|
-
|
838
|
-
#
|
822
|
+
# alias of `get_tag_group_id_for_tag`
|
823
|
+
alias get_tag_relationships_tag_group get_tag_group_id_for_tag
|
824
|
+
|
825
|
+
# Get Tag Group ID for Tag
|
826
|
+
# 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`
|
827
|
+
# @param id [String] The Tag ID
|
839
828
|
# @param [Hash] opts the optional parameters
|
840
|
-
# @return [Array<(
|
841
|
-
def
|
829
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
830
|
+
def get_tag_group_id_for_tag_with_http_info(id, opts = {})
|
842
831
|
if @api_client.config.debugging
|
843
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
832
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_id_for_tag ...'
|
844
833
|
end
|
845
834
|
# verify the required parameter 'id' is set
|
846
835
|
if @api_client.config.client_side_validation && id.nil?
|
847
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
848
|
-
end
|
849
|
-
# verify the required parameter 'tag_segment_op' is set
|
850
|
-
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
851
|
-
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.delete_tag_relationships_segments"
|
836
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group_id_for_tag"
|
852
837
|
end
|
853
838
|
# resource path
|
854
|
-
local_var_path = '/api/tags/{id}/relationships/
|
839
|
+
local_var_path = '/api/tags/{id}/relationships/tag-group'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
855
840
|
|
856
841
|
# query parameters
|
857
842
|
query_params = opts[:query_params] || {}
|
@@ -859,29 +844,24 @@ module KlaviyoAPI
|
|
859
844
|
# header parameters
|
860
845
|
header_params = opts[:header_params] || {}
|
861
846
|
# klaviyo api revision
|
862
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
847
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
863
848
|
# HTTP header 'Accept' (if needed)
|
864
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
865
|
-
# HTTP header 'Content-Type'
|
866
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
867
|
-
if !content_type.nil?
|
868
|
-
header_params['Content-Type'] = content_type
|
869
|
-
end
|
849
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
870
850
|
|
871
851
|
# form parameters
|
872
852
|
form_params = opts[:form_params] || {}
|
873
853
|
|
874
854
|
# http body (model)
|
875
|
-
post_body = opts[:debug_body]
|
855
|
+
post_body = opts[:debug_body]
|
876
856
|
|
877
857
|
# return_type
|
878
|
-
return_type = opts[:debug_return_type]
|
858
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
879
859
|
|
880
860
|
# auth_names
|
881
861
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
882
862
|
|
883
863
|
new_options = opts.merge(
|
884
|
-
:operation => :"TagsApi.
|
864
|
+
:operation => :"TagsApi.get_tag_group_id_for_tag",
|
885
865
|
:header_params => header_params,
|
886
866
|
:query_params => query_params,
|
887
867
|
:form_params => form_params,
|
@@ -890,69 +870,65 @@ module KlaviyoAPI
|
|
890
870
|
:return_type => return_type
|
891
871
|
)
|
892
872
|
|
893
|
-
data, status_code, headers = @api_client.call_api(:
|
873
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
894
874
|
if @api_client.config.debugging
|
895
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
875
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_group_id_for_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
896
876
|
end
|
897
877
|
return data, status_code, headers
|
898
878
|
end
|
899
879
|
|
900
|
-
#
|
901
|
-
|
902
|
-
|
880
|
+
# alias of `get_tag_group_id_for_tag_with_http_info`
|
881
|
+
alias get_tag_relationships_tag_group_with_http_info get_tag_group_id_for_tag_with_http_info
|
882
|
+
|
883
|
+
# Get Tag Groups
|
884
|
+
# 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`
|
903
885
|
# @param [Hash] opts the optional parameters
|
904
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-
|
905
|
-
# @option opts [
|
906
|
-
# @option opts [
|
886
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
887
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
888
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
889
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
907
890
|
# @return [Hash<String, Object>]
|
908
|
-
def
|
909
|
-
data, _status_code, _headers =
|
891
|
+
def get_tag_groups(opts = {})
|
892
|
+
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
910
893
|
data
|
911
894
|
end
|
912
895
|
|
913
|
-
# Get Tag
|
914
|
-
#
|
915
|
-
# @param id [String] The Tag ID
|
896
|
+
# Get Tag Groups
|
897
|
+
# 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`
|
916
898
|
# @param [Hash] opts the optional parameters
|
917
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-
|
918
|
-
# @option opts [
|
919
|
-
# @option opts [
|
899
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
900
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-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`
|
901
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
902
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
920
903
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
921
|
-
def
|
904
|
+
def get_tag_groups_with_http_info(opts = {})
|
922
905
|
if @api_client.config.debugging
|
923
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
924
|
-
end
|
925
|
-
# verify the required parameter 'id' is set
|
926
|
-
if @api_client.config.client_side_validation && id.nil?
|
927
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
906
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_groups ...'
|
928
907
|
end
|
929
908
|
allowable_values = ["name", "exclusive", "default"]
|
930
909
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
931
910
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
932
911
|
end
|
933
|
-
allowable_values = ["name"]
|
934
|
-
if @api_client.config.client_side_validation && opts[:'
|
935
|
-
fail ArgumentError, "invalid value for \"
|
936
|
-
end
|
937
|
-
allowable_values = ["tag-group"]
|
938
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
939
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
912
|
+
allowable_values = ["id", "-id", "name", "-name"]
|
913
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
914
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
940
915
|
end
|
941
916
|
# resource path
|
942
|
-
local_var_path = '/api/
|
917
|
+
local_var_path = '/api/tag-groups'
|
943
918
|
|
944
919
|
# query parameters
|
945
920
|
query_params = opts[:query_params] || {}
|
946
921
|
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
947
|
-
query_params[:'
|
948
|
-
query_params[:'
|
922
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
923
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
924
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
949
925
|
|
950
926
|
# header parameters
|
951
927
|
header_params = opts[:header_params] || {}
|
952
928
|
# klaviyo api revision
|
953
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
929
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
954
930
|
# HTTP header 'Accept' (if needed)
|
955
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
931
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
956
932
|
|
957
933
|
# form parameters
|
958
934
|
form_params = opts[:form_params] || {}
|
@@ -967,7 +943,7 @@ module KlaviyoAPI
|
|
967
943
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
968
944
|
|
969
945
|
new_options = opts.merge(
|
970
|
-
:operation => :"TagsApi.
|
946
|
+
:operation => :"TagsApi.get_tag_groups",
|
971
947
|
:header_params => header_params,
|
972
948
|
:query_params => query_params,
|
973
949
|
:form_params => form_params,
|
@@ -978,53 +954,49 @@ module KlaviyoAPI
|
|
978
954
|
|
979
955
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
980
956
|
if @api_client.config.debugging
|
981
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
957
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
982
958
|
end
|
983
959
|
return data, status_code, headers
|
984
960
|
end
|
985
961
|
|
986
|
-
# Get Tag Group
|
987
|
-
#
|
962
|
+
# Get Tag IDs for Tag Group
|
963
|
+
# 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`
|
988
964
|
# @param id [String] The Tag Group ID
|
989
965
|
# @param [Hash] opts the optional parameters
|
990
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
991
966
|
# @return [Hash<String, Object>]
|
992
|
-
def
|
993
|
-
data, _status_code, _headers =
|
967
|
+
def get_tag_ids_for_tag_group(id, opts = {})
|
968
|
+
data, _status_code, _headers = get_tag_ids_for_tag_group_with_http_info(id, opts)
|
994
969
|
data
|
995
970
|
end
|
996
971
|
|
997
|
-
#
|
998
|
-
|
972
|
+
# alias of `get_tag_ids_for_tag_group`
|
973
|
+
alias get_tag_group_relationships_tags get_tag_ids_for_tag_group
|
974
|
+
|
975
|
+
# Get Tag IDs for Tag Group
|
976
|
+
# 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`
|
999
977
|
# @param id [String] The Tag Group ID
|
1000
978
|
# @param [Hash] opts the optional parameters
|
1001
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
|
1002
979
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1003
|
-
def
|
980
|
+
def get_tag_ids_for_tag_group_with_http_info(id, opts = {})
|
1004
981
|
if @api_client.config.debugging
|
1005
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
982
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_ids_for_tag_group ...'
|
1006
983
|
end
|
1007
984
|
# verify the required parameter 'id' is set
|
1008
985
|
if @api_client.config.client_side_validation && id.nil?
|
1009
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1010
|
-
end
|
1011
|
-
allowable_values = ["name", "exclusive", "default"]
|
1012
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
1013
|
-
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
986
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_ids_for_tag_group"
|
1014
987
|
end
|
1015
988
|
# resource path
|
1016
|
-
local_var_path = '/api/tag-groups/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
989
|
+
local_var_path = '/api/tag-groups/{id}/relationships/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1017
990
|
|
1018
991
|
# query parameters
|
1019
992
|
query_params = opts[:query_params] || {}
|
1020
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1021
993
|
|
1022
994
|
# header parameters
|
1023
995
|
header_params = opts[:header_params] || {}
|
1024
996
|
# klaviyo api revision
|
1025
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
997
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1026
998
|
# HTTP header 'Accept' (if needed)
|
1027
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
999
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1028
1000
|
|
1029
1001
|
# form parameters
|
1030
1002
|
form_params = opts[:form_params] || {}
|
@@ -1039,7 +1011,7 @@ module KlaviyoAPI
|
|
1039
1011
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1040
1012
|
|
1041
1013
|
new_options = opts.merge(
|
1042
|
-
:operation => :"TagsApi.
|
1014
|
+
:operation => :"TagsApi.get_tag_ids_for_tag_group",
|
1043
1015
|
:header_params => header_params,
|
1044
1016
|
:query_params => query_params,
|
1045
1017
|
:form_params => form_params,
|
@@ -1050,46 +1022,77 @@ module KlaviyoAPI
|
|
1050
1022
|
|
1051
1023
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1052
1024
|
if @api_client.config.debugging
|
1053
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1025
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tag_ids_for_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1054
1026
|
end
|
1055
1027
|
return data, status_code, headers
|
1056
1028
|
end
|
1057
1029
|
|
1058
|
-
#
|
1059
|
-
|
1060
|
-
|
1030
|
+
# alias of `get_tag_ids_for_tag_group_with_http_info`
|
1031
|
+
alias get_tag_group_relationships_tags_with_http_info get_tag_ids_for_tag_group_with_http_info
|
1032
|
+
|
1033
|
+
# Get Tags
|
1034
|
+
# 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`
|
1061
1035
|
# @param [Hash] opts the optional parameters
|
1036
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1037
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1038
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1039
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1040
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1041
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1062
1042
|
# @return [Hash<String, Object>]
|
1063
|
-
def
|
1064
|
-
data, _status_code, _headers =
|
1043
|
+
def get_tags(opts = {})
|
1044
|
+
data, _status_code, _headers = get_tags_with_http_info(opts)
|
1065
1045
|
data
|
1066
1046
|
end
|
1067
1047
|
|
1068
|
-
# Get
|
1069
|
-
# Returns
|
1070
|
-
# @param id [String]
|
1048
|
+
# Get Tags
|
1049
|
+
# 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`
|
1071
1050
|
# @param [Hash] opts the optional parameters
|
1051
|
+
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1052
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1053
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1054
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
|
1055
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
|
1056
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
|
1072
1057
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1073
|
-
def
|
1058
|
+
def get_tags_with_http_info(opts = {})
|
1074
1059
|
if @api_client.config.debugging
|
1075
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1060
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...'
|
1076
1061
|
end
|
1077
|
-
|
1078
|
-
if @api_client.config.client_side_validation &&
|
1079
|
-
fail ArgumentError, "
|
1062
|
+
allowable_values = ["name", "exclusive", "default"]
|
1063
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
1064
|
+
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
1065
|
+
end
|
1066
|
+
allowable_values = ["name"]
|
1067
|
+
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1068
|
+
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1069
|
+
end
|
1070
|
+
allowable_values = ["tag-group"]
|
1071
|
+
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1072
|
+
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1073
|
+
end
|
1074
|
+
allowable_values = ["id", "-id", "name", "-name"]
|
1075
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1076
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1080
1077
|
end
|
1081
1078
|
# resource path
|
1082
|
-
local_var_path = '/api/
|
1079
|
+
local_var_path = '/api/tags'
|
1083
1080
|
|
1084
1081
|
# query parameters
|
1085
1082
|
query_params = opts[:query_params] || {}
|
1083
|
+
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1084
|
+
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1085
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1086
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1087
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1088
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1086
1089
|
|
1087
1090
|
# header parameters
|
1088
1091
|
header_params = opts[:header_params] || {}
|
1089
1092
|
# klaviyo api revision
|
1090
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1093
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1091
1094
|
# HTTP header 'Accept' (if needed)
|
1092
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1095
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1093
1096
|
|
1094
1097
|
# form parameters
|
1095
1098
|
form_params = opts[:form_params] || {}
|
@@ -1104,7 +1107,7 @@ module KlaviyoAPI
|
|
1104
1107
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1105
1108
|
|
1106
1109
|
new_options = opts.merge(
|
1107
|
-
:operation => :"TagsApi.
|
1110
|
+
:operation => :"TagsApi.get_tags",
|
1108
1111
|
:header_params => header_params,
|
1109
1112
|
:query_params => query_params,
|
1110
1113
|
:form_params => form_params,
|
@@ -1115,42 +1118,45 @@ module KlaviyoAPI
|
|
1115
1118
|
|
1116
1119
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1117
1120
|
if @api_client.config.debugging
|
1118
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1121
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1119
1122
|
end
|
1120
1123
|
return data, status_code, headers
|
1121
1124
|
end
|
1122
1125
|
|
1123
|
-
# Get Tag Group
|
1126
|
+
# Get Tags for Tag Group
|
1124
1127
|
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1125
|
-
# @param id [String]
|
1128
|
+
# @param id [String] The Tag Group ID
|
1126
1129
|
# @param [Hash] opts the optional parameters
|
1127
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-
|
1130
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1128
1131
|
# @return [Hash<String, Object>]
|
1129
|
-
def
|
1130
|
-
data, _status_code, _headers =
|
1132
|
+
def get_tags_for_tag_group(id, opts = {})
|
1133
|
+
data, _status_code, _headers = get_tags_for_tag_group_with_http_info(id, opts)
|
1131
1134
|
data
|
1132
1135
|
end
|
1133
1136
|
|
1134
|
-
#
|
1137
|
+
# alias of `get_tags_for_tag_group`
|
1138
|
+
alias get_tag_group_tags get_tags_for_tag_group
|
1139
|
+
|
1140
|
+
# Get Tags for Tag Group
|
1135
1141
|
# Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
|
1136
|
-
# @param id [String]
|
1142
|
+
# @param id [String] The Tag Group ID
|
1137
1143
|
# @param [Hash] opts the optional parameters
|
1138
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-
|
1144
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
|
1139
1145
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1140
|
-
def
|
1146
|
+
def get_tags_for_tag_group_with_http_info(id, opts = {})
|
1141
1147
|
if @api_client.config.debugging
|
1142
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1148
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tags_for_tag_group ...'
|
1143
1149
|
end
|
1144
1150
|
# verify the required parameter 'id' is set
|
1145
1151
|
if @api_client.config.client_side_validation && id.nil?
|
1146
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1152
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tags_for_tag_group"
|
1147
1153
|
end
|
1148
1154
|
allowable_values = ["name"]
|
1149
1155
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1150
1156
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1151
1157
|
end
|
1152
1158
|
# resource path
|
1153
|
-
local_var_path = '/api/tag-groups/{id}/tags
|
1159
|
+
local_var_path = '/api/tag-groups/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1154
1160
|
|
1155
1161
|
# query parameters
|
1156
1162
|
query_params = opts[:query_params] || {}
|
@@ -1159,9 +1165,9 @@ module KlaviyoAPI
|
|
1159
1165
|
# header parameters
|
1160
1166
|
header_params = opts[:header_params] || {}
|
1161
1167
|
# klaviyo api revision
|
1162
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1168
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1163
1169
|
# HTTP header 'Accept' (if needed)
|
1164
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1170
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1165
1171
|
|
1166
1172
|
# form parameters
|
1167
1173
|
form_params = opts[:form_params] || {}
|
@@ -1176,7 +1182,7 @@ module KlaviyoAPI
|
|
1176
1182
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1177
1183
|
|
1178
1184
|
new_options = opts.merge(
|
1179
|
-
:operation => :"TagsApi.
|
1185
|
+
:operation => :"TagsApi.get_tags_for_tag_group",
|
1180
1186
|
:header_params => header_params,
|
1181
1187
|
:query_params => query_params,
|
1182
1188
|
:form_params => form_params,
|
@@ -1187,75 +1193,78 @@ module KlaviyoAPI
|
|
1187
1193
|
|
1188
1194
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1189
1195
|
if @api_client.config.debugging
|
1190
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1196
|
+
@api_client.config.logger.debug "API called: TagsApi#get_tags_for_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1191
1197
|
end
|
1192
1198
|
return data, status_code, headers
|
1193
1199
|
end
|
1194
1200
|
|
1195
|
-
#
|
1196
|
-
|
1201
|
+
# alias of `get_tags_for_tag_group_with_http_info`
|
1202
|
+
alias get_tag_group_tags_with_http_info get_tags_for_tag_group_with_http_info
|
1203
|
+
|
1204
|
+
# Remove Tag from Campaigns
|
1205
|
+
# 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`
|
1206
|
+
# @param id [String] The Tag ID
|
1207
|
+
# @param tag_campaign_op [TagCampaignOp]
|
1197
1208
|
# @param [Hash] opts the optional parameters
|
1198
|
-
# @
|
1199
|
-
|
1200
|
-
|
1201
|
-
|
1202
|
-
# @return [Hash<String, Object>]
|
1203
|
-
def get_tag_groups(opts = {})
|
1204
|
-
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
1205
|
-
data
|
1209
|
+
# @return [nil]
|
1210
|
+
def remove_tag_from_campaigns(id, tag_campaign_op, opts = {})
|
1211
|
+
remove_tag_from_campaigns_with_http_info(id, tag_campaign_op, opts)
|
1212
|
+
nil
|
1206
1213
|
end
|
1207
1214
|
|
1208
|
-
#
|
1209
|
-
|
1215
|
+
# alias of `remove_tag_from_campaigns`
|
1216
|
+
alias delete_tag_relationships_campaigns remove_tag_from_campaigns
|
1217
|
+
|
1218
|
+
# Remove Tag from Campaigns
|
1219
|
+
# 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`
|
1220
|
+
# @param id [String] The Tag ID
|
1221
|
+
# @param tag_campaign_op [TagCampaignOp]
|
1210
1222
|
# @param [Hash] opts the optional parameters
|
1211
|
-
# @
|
1212
|
-
|
1213
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1214
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1215
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1216
|
-
def get_tag_groups_with_http_info(opts = {})
|
1223
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1224
|
+
def remove_tag_from_campaigns_with_http_info(id, tag_campaign_op, opts = {})
|
1217
1225
|
if @api_client.config.debugging
|
1218
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1226
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_campaigns ...'
|
1219
1227
|
end
|
1220
|
-
|
1221
|
-
if @api_client.config.client_side_validation &&
|
1222
|
-
fail ArgumentError, "
|
1228
|
+
# verify the required parameter 'id' is set
|
1229
|
+
if @api_client.config.client_side_validation && id.nil?
|
1230
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.remove_tag_from_campaigns"
|
1223
1231
|
end
|
1224
|
-
|
1225
|
-
if @api_client.config.client_side_validation &&
|
1226
|
-
fail ArgumentError, "
|
1232
|
+
# verify the required parameter 'tag_campaign_op' is set
|
1233
|
+
if @api_client.config.client_side_validation && tag_campaign_op.nil?
|
1234
|
+
fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.remove_tag_from_campaigns"
|
1227
1235
|
end
|
1228
1236
|
# resource path
|
1229
|
-
local_var_path = '/api/
|
1237
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1230
1238
|
|
1231
1239
|
# query parameters
|
1232
1240
|
query_params = opts[:query_params] || {}
|
1233
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1234
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1235
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1236
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1237
1241
|
|
1238
1242
|
# header parameters
|
1239
1243
|
header_params = opts[:header_params] || {}
|
1240
1244
|
# klaviyo api revision
|
1241
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1245
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1242
1246
|
# HTTP header 'Accept' (if needed)
|
1243
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1247
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1248
|
+
# HTTP header 'Content-Type'
|
1249
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1250
|
+
if !content_type.nil?
|
1251
|
+
header_params['Content-Type'] = content_type
|
1252
|
+
end
|
1244
1253
|
|
1245
1254
|
# form parameters
|
1246
1255
|
form_params = opts[:form_params] || {}
|
1247
1256
|
|
1248
1257
|
# http body (model)
|
1249
|
-
post_body = opts[:debug_body]
|
1258
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_campaign_op)
|
1250
1259
|
|
1251
1260
|
# return_type
|
1252
|
-
return_type = opts[:debug_return_type]
|
1261
|
+
return_type = opts[:debug_return_type]
|
1253
1262
|
|
1254
1263
|
# auth_names
|
1255
1264
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1256
1265
|
|
1257
1266
|
new_options = opts.merge(
|
1258
|
-
:operation => :"TagsApi.
|
1267
|
+
:operation => :"TagsApi.remove_tag_from_campaigns",
|
1259
1268
|
:header_params => header_params,
|
1260
1269
|
:query_params => query_params,
|
1261
1270
|
:form_params => form_params,
|
@@ -1264,38 +1273,50 @@ module KlaviyoAPI
|
|
1264
1273
|
:return_type => return_type
|
1265
1274
|
)
|
1266
1275
|
|
1267
|
-
data, status_code, headers = @api_client.call_api(:
|
1276
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1268
1277
|
if @api_client.config.debugging
|
1269
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1278
|
+
@api_client.config.logger.debug "API called: TagsApi#remove_tag_from_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1270
1279
|
end
|
1271
1280
|
return data, status_code, headers
|
1272
1281
|
end
|
1273
1282
|
|
1274
|
-
#
|
1275
|
-
|
1276
|
-
|
1283
|
+
# alias of `remove_tag_from_campaigns_with_http_info`
|
1284
|
+
alias delete_tag_relationships_campaigns_with_http_info remove_tag_from_campaigns_with_http_info
|
1285
|
+
|
1286
|
+
# Remove Tag from Flows
|
1287
|
+
# 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`
|
1288
|
+
# @param id [String] The Tag ID
|
1289
|
+
# @param tag_flow_op [TagFlowOp]
|
1277
1290
|
# @param [Hash] opts the optional parameters
|
1278
|
-
# @return [
|
1279
|
-
def
|
1280
|
-
|
1281
|
-
|
1291
|
+
# @return [nil]
|
1292
|
+
def remove_tag_from_flows(id, tag_flow_op, opts = {})
|
1293
|
+
remove_tag_from_flows_with_http_info(id, tag_flow_op, opts)
|
1294
|
+
nil
|
1282
1295
|
end
|
1283
1296
|
|
1284
|
-
#
|
1285
|
-
|
1286
|
-
|
1297
|
+
# alias of `remove_tag_from_flows`
|
1298
|
+
alias delete_tag_relationships_flows remove_tag_from_flows
|
1299
|
+
|
1300
|
+
# Remove Tag from Flows
|
1301
|
+
# 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`
|
1302
|
+
# @param id [String] The Tag ID
|
1303
|
+
# @param tag_flow_op [TagFlowOp]
|
1287
1304
|
# @param [Hash] opts the optional parameters
|
1288
|
-
# @return [Array<(
|
1289
|
-
def
|
1305
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1306
|
+
def remove_tag_from_flows_with_http_info(id, tag_flow_op, opts = {})
|
1290
1307
|
if @api_client.config.debugging
|
1291
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1308
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_flows ...'
|
1292
1309
|
end
|
1293
1310
|
# verify the required parameter 'id' is set
|
1294
1311
|
if @api_client.config.client_side_validation && id.nil?
|
1295
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1312
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.remove_tag_from_flows"
|
1313
|
+
end
|
1314
|
+
# verify the required parameter 'tag_flow_op' is set
|
1315
|
+
if @api_client.config.client_side_validation && tag_flow_op.nil?
|
1316
|
+
fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.remove_tag_from_flows"
|
1296
1317
|
end
|
1297
1318
|
# resource path
|
1298
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1319
|
+
local_var_path = '/api/tags/{id}/relationships/flows'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1299
1320
|
|
1300
1321
|
# query parameters
|
1301
1322
|
query_params = opts[:query_params] || {}
|
@@ -1303,24 +1324,29 @@ module KlaviyoAPI
|
|
1303
1324
|
# header parameters
|
1304
1325
|
header_params = opts[:header_params] || {}
|
1305
1326
|
# klaviyo api revision
|
1306
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1327
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1307
1328
|
# HTTP header 'Accept' (if needed)
|
1308
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1329
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1330
|
+
# HTTP header 'Content-Type'
|
1331
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1332
|
+
if !content_type.nil?
|
1333
|
+
header_params['Content-Type'] = content_type
|
1334
|
+
end
|
1309
1335
|
|
1310
1336
|
# form parameters
|
1311
1337
|
form_params = opts[:form_params] || {}
|
1312
1338
|
|
1313
1339
|
# http body (model)
|
1314
|
-
post_body = opts[:debug_body]
|
1340
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_flow_op)
|
1315
1341
|
|
1316
1342
|
# return_type
|
1317
|
-
return_type = opts[:debug_return_type]
|
1343
|
+
return_type = opts[:debug_return_type]
|
1318
1344
|
|
1319
1345
|
# auth_names
|
1320
1346
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1321
1347
|
|
1322
1348
|
new_options = opts.merge(
|
1323
|
-
:operation => :"TagsApi.
|
1349
|
+
:operation => :"TagsApi.remove_tag_from_flows",
|
1324
1350
|
:header_params => header_params,
|
1325
1351
|
:query_params => query_params,
|
1326
1352
|
:form_params => form_params,
|
@@ -1329,38 +1355,50 @@ module KlaviyoAPI
|
|
1329
1355
|
:return_type => return_type
|
1330
1356
|
)
|
1331
1357
|
|
1332
|
-
data, status_code, headers = @api_client.call_api(:
|
1358
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1333
1359
|
if @api_client.config.debugging
|
1334
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1360
|
+
@api_client.config.logger.debug "API called: TagsApi#remove_tag_from_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1335
1361
|
end
|
1336
1362
|
return data, status_code, headers
|
1337
1363
|
end
|
1338
1364
|
|
1339
|
-
#
|
1340
|
-
|
1341
|
-
|
1365
|
+
# alias of `remove_tag_from_flows_with_http_info`
|
1366
|
+
alias delete_tag_relationships_flows_with_http_info remove_tag_from_flows_with_http_info
|
1367
|
+
|
1368
|
+
# Remove Tag from Lists
|
1369
|
+
# 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`
|
1370
|
+
# @param id [String] The Tag ID
|
1371
|
+
# @param tag_list_op [TagListOp]
|
1342
1372
|
# @param [Hash] opts the optional parameters
|
1343
|
-
# @return [
|
1344
|
-
def
|
1345
|
-
|
1346
|
-
|
1373
|
+
# @return [nil]
|
1374
|
+
def remove_tag_from_lists(id, tag_list_op, opts = {})
|
1375
|
+
remove_tag_from_lists_with_http_info(id, tag_list_op, opts)
|
1376
|
+
nil
|
1347
1377
|
end
|
1348
1378
|
|
1349
|
-
#
|
1350
|
-
|
1351
|
-
|
1379
|
+
# alias of `remove_tag_from_lists`
|
1380
|
+
alias delete_tag_relationships_lists remove_tag_from_lists
|
1381
|
+
|
1382
|
+
# Remove Tag from Lists
|
1383
|
+
# 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`
|
1384
|
+
# @param id [String] The Tag ID
|
1385
|
+
# @param tag_list_op [TagListOp]
|
1352
1386
|
# @param [Hash] opts the optional parameters
|
1353
|
-
# @return [Array<(
|
1354
|
-
def
|
1387
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1388
|
+
def remove_tag_from_lists_with_http_info(id, tag_list_op, opts = {})
|
1355
1389
|
if @api_client.config.debugging
|
1356
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1390
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_lists ...'
|
1357
1391
|
end
|
1358
1392
|
# verify the required parameter 'id' is set
|
1359
1393
|
if @api_client.config.client_side_validation && id.nil?
|
1360
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1394
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.remove_tag_from_lists"
|
1395
|
+
end
|
1396
|
+
# verify the required parameter 'tag_list_op' is set
|
1397
|
+
if @api_client.config.client_side_validation && tag_list_op.nil?
|
1398
|
+
fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.remove_tag_from_lists"
|
1361
1399
|
end
|
1362
1400
|
# resource path
|
1363
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1401
|
+
local_var_path = '/api/tags/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1364
1402
|
|
1365
1403
|
# query parameters
|
1366
1404
|
query_params = opts[:query_params] || {}
|
@@ -1368,24 +1406,29 @@ module KlaviyoAPI
|
|
1368
1406
|
# header parameters
|
1369
1407
|
header_params = opts[:header_params] || {}
|
1370
1408
|
# klaviyo api revision
|
1371
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1409
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1372
1410
|
# HTTP header 'Accept' (if needed)
|
1373
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1411
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1412
|
+
# HTTP header 'Content-Type'
|
1413
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1414
|
+
if !content_type.nil?
|
1415
|
+
header_params['Content-Type'] = content_type
|
1416
|
+
end
|
1374
1417
|
|
1375
1418
|
# form parameters
|
1376
1419
|
form_params = opts[:form_params] || {}
|
1377
1420
|
|
1378
1421
|
# http body (model)
|
1379
|
-
post_body = opts[:debug_body]
|
1422
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_list_op)
|
1380
1423
|
|
1381
1424
|
# return_type
|
1382
|
-
return_type = opts[:debug_return_type]
|
1425
|
+
return_type = opts[:debug_return_type]
|
1383
1426
|
|
1384
1427
|
# auth_names
|
1385
1428
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1386
1429
|
|
1387
1430
|
new_options = opts.merge(
|
1388
|
-
:operation => :"TagsApi.
|
1431
|
+
:operation => :"TagsApi.remove_tag_from_lists",
|
1389
1432
|
:header_params => header_params,
|
1390
1433
|
:query_params => query_params,
|
1391
1434
|
:form_params => form_params,
|
@@ -1394,38 +1437,50 @@ module KlaviyoAPI
|
|
1394
1437
|
:return_type => return_type
|
1395
1438
|
)
|
1396
1439
|
|
1397
|
-
data, status_code, headers = @api_client.call_api(:
|
1440
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1398
1441
|
if @api_client.config.debugging
|
1399
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1442
|
+
@api_client.config.logger.debug "API called: TagsApi#remove_tag_from_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1400
1443
|
end
|
1401
1444
|
return data, status_code, headers
|
1402
1445
|
end
|
1403
1446
|
|
1404
|
-
#
|
1405
|
-
|
1406
|
-
|
1447
|
+
# alias of `remove_tag_from_lists_with_http_info`
|
1448
|
+
alias delete_tag_relationships_lists_with_http_info remove_tag_from_lists_with_http_info
|
1449
|
+
|
1450
|
+
# Remove Tag from Segments
|
1451
|
+
# 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`
|
1452
|
+
# @param id [String] The Tag ID
|
1453
|
+
# @param tag_segment_op [TagSegmentOp]
|
1407
1454
|
# @param [Hash] opts the optional parameters
|
1408
|
-
# @return [
|
1409
|
-
def
|
1410
|
-
|
1411
|
-
|
1455
|
+
# @return [nil]
|
1456
|
+
def remove_tag_from_segments(id, tag_segment_op, opts = {})
|
1457
|
+
remove_tag_from_segments_with_http_info(id, tag_segment_op, opts)
|
1458
|
+
nil
|
1412
1459
|
end
|
1413
1460
|
|
1414
|
-
#
|
1415
|
-
|
1416
|
-
|
1461
|
+
# alias of `remove_tag_from_segments`
|
1462
|
+
alias delete_tag_relationships_segments remove_tag_from_segments
|
1463
|
+
|
1464
|
+
# Remove Tag from Segments
|
1465
|
+
# 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`
|
1466
|
+
# @param id [String] The Tag ID
|
1467
|
+
# @param tag_segment_op [TagSegmentOp]
|
1417
1468
|
# @param [Hash] opts the optional parameters
|
1418
|
-
# @return [Array<(
|
1419
|
-
def
|
1469
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1470
|
+
def remove_tag_from_segments_with_http_info(id, tag_segment_op, opts = {})
|
1420
1471
|
if @api_client.config.debugging
|
1421
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1472
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_segments ...'
|
1422
1473
|
end
|
1423
1474
|
# verify the required parameter 'id' is set
|
1424
1475
|
if @api_client.config.client_side_validation && id.nil?
|
1425
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1476
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.remove_tag_from_segments"
|
1477
|
+
end
|
1478
|
+
# verify the required parameter 'tag_segment_op' is set
|
1479
|
+
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
1480
|
+
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.remove_tag_from_segments"
|
1426
1481
|
end
|
1427
1482
|
# resource path
|
1428
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1483
|
+
local_var_path = '/api/tags/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1429
1484
|
|
1430
1485
|
# query parameters
|
1431
1486
|
query_params = opts[:query_params] || {}
|
@@ -1433,24 +1488,29 @@ module KlaviyoAPI
|
|
1433
1488
|
# header parameters
|
1434
1489
|
header_params = opts[:header_params] || {}
|
1435
1490
|
# klaviyo api revision
|
1436
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1491
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1437
1492
|
# HTTP header 'Accept' (if needed)
|
1438
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1493
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1494
|
+
# HTTP header 'Content-Type'
|
1495
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1496
|
+
if !content_type.nil?
|
1497
|
+
header_params['Content-Type'] = content_type
|
1498
|
+
end
|
1439
1499
|
|
1440
1500
|
# form parameters
|
1441
1501
|
form_params = opts[:form_params] || {}
|
1442
1502
|
|
1443
1503
|
# http body (model)
|
1444
|
-
post_body = opts[:debug_body]
|
1504
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_segment_op)
|
1445
1505
|
|
1446
1506
|
# return_type
|
1447
|
-
return_type = opts[:debug_return_type]
|
1507
|
+
return_type = opts[:debug_return_type]
|
1448
1508
|
|
1449
1509
|
# auth_names
|
1450
1510
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1451
1511
|
|
1452
1512
|
new_options = opts.merge(
|
1453
|
-
:operation => :"TagsApi.
|
1513
|
+
:operation => :"TagsApi.remove_tag_from_segments",
|
1454
1514
|
:header_params => header_params,
|
1455
1515
|
:query_params => query_params,
|
1456
1516
|
:form_params => form_params,
|
@@ -1459,38 +1519,53 @@ module KlaviyoAPI
|
|
1459
1519
|
:return_type => return_type
|
1460
1520
|
)
|
1461
1521
|
|
1462
|
-
data, status_code, headers = @api_client.call_api(:
|
1522
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1463
1523
|
if @api_client.config.debugging
|
1464
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1524
|
+
@api_client.config.logger.debug "API called: TagsApi#remove_tag_from_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1465
1525
|
end
|
1466
1526
|
return data, status_code, headers
|
1467
1527
|
end
|
1468
1528
|
|
1469
|
-
#
|
1470
|
-
|
1471
|
-
|
1529
|
+
# alias of `remove_tag_from_segments_with_http_info`
|
1530
|
+
alias delete_tag_relationships_segments_with_http_info remove_tag_from_segments_with_http_info
|
1531
|
+
|
1532
|
+
# Tag Campaigns
|
1533
|
+
# 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`
|
1534
|
+
# @param id [String] The Tag ID
|
1535
|
+
# @param tag_campaign_op [TagCampaignOp]
|
1472
1536
|
# @param [Hash] opts the optional parameters
|
1473
|
-
# @return [
|
1474
|
-
def
|
1475
|
-
|
1476
|
-
|
1537
|
+
# @return [nil]
|
1538
|
+
def tag_campaigns(id, tag_campaign_op, opts = {})
|
1539
|
+
tag_campaigns_with_http_info(id, tag_campaign_op, opts)
|
1540
|
+
nil
|
1477
1541
|
end
|
1478
1542
|
|
1479
|
-
#
|
1480
|
-
|
1481
|
-
|
1543
|
+
# alias of `tag_campaigns`
|
1544
|
+
alias create_tag_relationships_campaigns tag_campaigns
|
1545
|
+
|
1546
|
+
# alias of `tag_campaigns`
|
1547
|
+
alias create_tag_relationships_campaign tag_campaigns
|
1548
|
+
|
1549
|
+
# Tag Campaigns
|
1550
|
+
# 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`
|
1551
|
+
# @param id [String] The Tag ID
|
1552
|
+
# @param tag_campaign_op [TagCampaignOp]
|
1482
1553
|
# @param [Hash] opts the optional parameters
|
1483
|
-
# @return [Array<(
|
1484
|
-
def
|
1554
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1555
|
+
def tag_campaigns_with_http_info(id, tag_campaign_op, opts = {})
|
1485
1556
|
if @api_client.config.debugging
|
1486
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1557
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.tag_campaigns ...'
|
1487
1558
|
end
|
1488
1559
|
# verify the required parameter 'id' is set
|
1489
1560
|
if @api_client.config.client_side_validation && id.nil?
|
1490
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1561
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.tag_campaigns"
|
1562
|
+
end
|
1563
|
+
# verify the required parameter 'tag_campaign_op' is set
|
1564
|
+
if @api_client.config.client_side_validation && tag_campaign_op.nil?
|
1565
|
+
fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.tag_campaigns"
|
1491
1566
|
end
|
1492
1567
|
# resource path
|
1493
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1568
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1494
1569
|
|
1495
1570
|
# query parameters
|
1496
1571
|
query_params = opts[:query_params] || {}
|
@@ -1498,24 +1573,29 @@ module KlaviyoAPI
|
|
1498
1573
|
# header parameters
|
1499
1574
|
header_params = opts[:header_params] || {}
|
1500
1575
|
# klaviyo api revision
|
1501
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1576
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1502
1577
|
# HTTP header 'Accept' (if needed)
|
1503
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1578
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1579
|
+
# HTTP header 'Content-Type'
|
1580
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1581
|
+
if !content_type.nil?
|
1582
|
+
header_params['Content-Type'] = content_type
|
1583
|
+
end
|
1504
1584
|
|
1505
1585
|
# form parameters
|
1506
1586
|
form_params = opts[:form_params] || {}
|
1507
1587
|
|
1508
1588
|
# http body (model)
|
1509
|
-
post_body = opts[:debug_body]
|
1589
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_campaign_op)
|
1510
1590
|
|
1511
1591
|
# return_type
|
1512
|
-
return_type = opts[:debug_return_type]
|
1592
|
+
return_type = opts[:debug_return_type]
|
1513
1593
|
|
1514
1594
|
# auth_names
|
1515
1595
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1516
1596
|
|
1517
1597
|
new_options = opts.merge(
|
1518
|
-
:operation => :"TagsApi.
|
1598
|
+
:operation => :"TagsApi.tag_campaigns",
|
1519
1599
|
:header_params => header_params,
|
1520
1600
|
:query_params => query_params,
|
1521
1601
|
:form_params => form_params,
|
@@ -1524,38 +1604,56 @@ module KlaviyoAPI
|
|
1524
1604
|
:return_type => return_type
|
1525
1605
|
)
|
1526
1606
|
|
1527
|
-
data, status_code, headers = @api_client.call_api(:
|
1607
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1528
1608
|
if @api_client.config.debugging
|
1529
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1609
|
+
@api_client.config.logger.debug "API called: TagsApi#tag_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1530
1610
|
end
|
1531
1611
|
return data, status_code, headers
|
1532
1612
|
end
|
1533
1613
|
|
1534
|
-
#
|
1535
|
-
|
1536
|
-
|
1614
|
+
# alias of `tag_campaigns_with_http_info`
|
1615
|
+
alias create_tag_relationships_campaigns_with_http_info tag_campaigns_with_http_info
|
1616
|
+
|
1617
|
+
# alias of `tag_campaigns_with_http_info`
|
1618
|
+
alias create_tag_relationships_campaign_with_http_info tag_campaigns_with_http_info
|
1619
|
+
|
1620
|
+
# Tag Flows
|
1621
|
+
# 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`
|
1622
|
+
# @param id [String] The Tag ID
|
1623
|
+
# @param tag_flow_op [TagFlowOp]
|
1537
1624
|
# @param [Hash] opts the optional parameters
|
1538
|
-
# @return [
|
1539
|
-
def
|
1540
|
-
|
1541
|
-
|
1625
|
+
# @return [nil]
|
1626
|
+
def tag_flows(id, tag_flow_op, opts = {})
|
1627
|
+
tag_flows_with_http_info(id, tag_flow_op, opts)
|
1628
|
+
nil
|
1542
1629
|
end
|
1543
1630
|
|
1544
|
-
#
|
1545
|
-
|
1546
|
-
|
1631
|
+
# alias of `tag_flows`
|
1632
|
+
alias create_tag_relationships_flows tag_flows
|
1633
|
+
|
1634
|
+
# alias of `tag_flows`
|
1635
|
+
alias create_tag_relationships_flow tag_flows
|
1636
|
+
|
1637
|
+
# Tag Flows
|
1638
|
+
# 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`
|
1639
|
+
# @param id [String] The Tag ID
|
1640
|
+
# @param tag_flow_op [TagFlowOp]
|
1547
1641
|
# @param [Hash] opts the optional parameters
|
1548
|
-
# @return [Array<(
|
1549
|
-
def
|
1642
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1643
|
+
def tag_flows_with_http_info(id, tag_flow_op, opts = {})
|
1550
1644
|
if @api_client.config.debugging
|
1551
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1645
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.tag_flows ...'
|
1552
1646
|
end
|
1553
1647
|
# verify the required parameter 'id' is set
|
1554
1648
|
if @api_client.config.client_side_validation && id.nil?
|
1555
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1649
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.tag_flows"
|
1650
|
+
end
|
1651
|
+
# verify the required parameter 'tag_flow_op' is set
|
1652
|
+
if @api_client.config.client_side_validation && tag_flow_op.nil?
|
1653
|
+
fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.tag_flows"
|
1556
1654
|
end
|
1557
1655
|
# resource path
|
1558
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1656
|
+
local_var_path = '/api/tags/{id}/relationships/flows'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1559
1657
|
|
1560
1658
|
# query parameters
|
1561
1659
|
query_params = opts[:query_params] || {}
|
@@ -1563,24 +1661,29 @@ module KlaviyoAPI
|
|
1563
1661
|
# header parameters
|
1564
1662
|
header_params = opts[:header_params] || {}
|
1565
1663
|
# klaviyo api revision
|
1566
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1664
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1567
1665
|
# HTTP header 'Accept' (if needed)
|
1568
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1666
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1667
|
+
# HTTP header 'Content-Type'
|
1668
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1669
|
+
if !content_type.nil?
|
1670
|
+
header_params['Content-Type'] = content_type
|
1671
|
+
end
|
1569
1672
|
|
1570
1673
|
# form parameters
|
1571
1674
|
form_params = opts[:form_params] || {}
|
1572
1675
|
|
1573
1676
|
# http body (model)
|
1574
|
-
post_body = opts[:debug_body]
|
1677
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_flow_op)
|
1575
1678
|
|
1576
1679
|
# return_type
|
1577
|
-
return_type = opts[:debug_return_type]
|
1680
|
+
return_type = opts[:debug_return_type]
|
1578
1681
|
|
1579
1682
|
# auth_names
|
1580
1683
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1581
1684
|
|
1582
1685
|
new_options = opts.merge(
|
1583
|
-
:operation => :"TagsApi.
|
1686
|
+
:operation => :"TagsApi.tag_flows",
|
1584
1687
|
:header_params => header_params,
|
1585
1688
|
:query_params => query_params,
|
1586
1689
|
:form_params => form_params,
|
@@ -1589,70 +1692,86 @@ module KlaviyoAPI
|
|
1589
1692
|
:return_type => return_type
|
1590
1693
|
)
|
1591
1694
|
|
1592
|
-
data, status_code, headers = @api_client.call_api(:
|
1695
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1593
1696
|
if @api_client.config.debugging
|
1594
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1697
|
+
@api_client.config.logger.debug "API called: TagsApi#tag_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1595
1698
|
end
|
1596
1699
|
return data, status_code, headers
|
1597
1700
|
end
|
1598
1701
|
|
1599
|
-
#
|
1600
|
-
|
1601
|
-
|
1702
|
+
# alias of `tag_flows_with_http_info`
|
1703
|
+
alias create_tag_relationships_flows_with_http_info tag_flows_with_http_info
|
1704
|
+
|
1705
|
+
# alias of `tag_flows_with_http_info`
|
1706
|
+
alias create_tag_relationships_flow_with_http_info tag_flows_with_http_info
|
1707
|
+
|
1708
|
+
# Tag Lists
|
1709
|
+
# 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`
|
1710
|
+
# @param id [String] The Tag ID
|
1711
|
+
# @param tag_list_op [TagListOp]
|
1602
1712
|
# @param [Hash] opts the optional parameters
|
1603
|
-
# @
|
1604
|
-
|
1605
|
-
|
1606
|
-
|
1607
|
-
data
|
1713
|
+
# @return [nil]
|
1714
|
+
def tag_lists(id, tag_list_op, opts = {})
|
1715
|
+
tag_lists_with_http_info(id, tag_list_op, opts)
|
1716
|
+
nil
|
1608
1717
|
end
|
1609
1718
|
|
1610
|
-
#
|
1611
|
-
|
1612
|
-
|
1719
|
+
# alias of `tag_lists`
|
1720
|
+
alias create_tag_relationships_lists tag_lists
|
1721
|
+
|
1722
|
+
# alias of `tag_lists`
|
1723
|
+
alias create_tag_relationships_list tag_lists
|
1724
|
+
|
1725
|
+
# Tag Lists
|
1726
|
+
# 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`
|
1727
|
+
# @param id [String] The Tag ID
|
1728
|
+
# @param tag_list_op [TagListOp]
|
1613
1729
|
# @param [Hash] opts the optional parameters
|
1614
|
-
# @
|
1615
|
-
|
1616
|
-
def get_tag_tag_group_with_http_info(id, opts = {})
|
1730
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1731
|
+
def tag_lists_with_http_info(id, tag_list_op, opts = {})
|
1617
1732
|
if @api_client.config.debugging
|
1618
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1733
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.tag_lists ...'
|
1619
1734
|
end
|
1620
1735
|
# verify the required parameter 'id' is set
|
1621
1736
|
if @api_client.config.client_side_validation && id.nil?
|
1622
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1737
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.tag_lists"
|
1623
1738
|
end
|
1624
|
-
|
1625
|
-
if @api_client.config.client_side_validation &&
|
1626
|
-
fail ArgumentError, "
|
1739
|
+
# verify the required parameter 'tag_list_op' is set
|
1740
|
+
if @api_client.config.client_side_validation && tag_list_op.nil?
|
1741
|
+
fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.tag_lists"
|
1627
1742
|
end
|
1628
1743
|
# resource path
|
1629
|
-
local_var_path = '/api/tags/{id}/
|
1744
|
+
local_var_path = '/api/tags/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1630
1745
|
|
1631
1746
|
# query parameters
|
1632
1747
|
query_params = opts[:query_params] || {}
|
1633
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1634
1748
|
|
1635
1749
|
# header parameters
|
1636
1750
|
header_params = opts[:header_params] || {}
|
1637
1751
|
# klaviyo api revision
|
1638
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1752
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1639
1753
|
# HTTP header 'Accept' (if needed)
|
1640
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1754
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1755
|
+
# HTTP header 'Content-Type'
|
1756
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1757
|
+
if !content_type.nil?
|
1758
|
+
header_params['Content-Type'] = content_type
|
1759
|
+
end
|
1641
1760
|
|
1642
1761
|
# form parameters
|
1643
1762
|
form_params = opts[:form_params] || {}
|
1644
1763
|
|
1645
1764
|
# http body (model)
|
1646
|
-
post_body = opts[:debug_body]
|
1765
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_list_op)
|
1647
1766
|
|
1648
1767
|
# return_type
|
1649
|
-
return_type = opts[:debug_return_type]
|
1768
|
+
return_type = opts[:debug_return_type]
|
1650
1769
|
|
1651
1770
|
# auth_names
|
1652
1771
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1653
1772
|
|
1654
1773
|
new_options = opts.merge(
|
1655
|
-
:operation => :"TagsApi.
|
1774
|
+
:operation => :"TagsApi.tag_lists",
|
1656
1775
|
:header_params => header_params,
|
1657
1776
|
:query_params => query_params,
|
1658
1777
|
:form_params => form_params,
|
@@ -1661,91 +1780,86 @@ module KlaviyoAPI
|
|
1661
1780
|
:return_type => return_type
|
1662
1781
|
)
|
1663
1782
|
|
1664
|
-
data, status_code, headers = @api_client.call_api(:
|
1783
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1665
1784
|
if @api_client.config.debugging
|
1666
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1785
|
+
@api_client.config.logger.debug "API called: TagsApi#tag_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1667
1786
|
end
|
1668
1787
|
return data, status_code, headers
|
1669
1788
|
end
|
1670
1789
|
|
1671
|
-
#
|
1672
|
-
|
1790
|
+
# alias of `tag_lists_with_http_info`
|
1791
|
+
alias create_tag_relationships_lists_with_http_info tag_lists_with_http_info
|
1792
|
+
|
1793
|
+
# alias of `tag_lists_with_http_info`
|
1794
|
+
alias create_tag_relationships_list_with_http_info tag_lists_with_http_info
|
1795
|
+
|
1796
|
+
# Tag Segments
|
1797
|
+
# 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`
|
1798
|
+
# @param id [String] The Tag ID
|
1799
|
+
# @param tag_segment_op [TagSegmentOp]
|
1673
1800
|
# @param [Hash] opts the optional parameters
|
1674
|
-
# @
|
1675
|
-
|
1676
|
-
|
1677
|
-
|
1678
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1679
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1680
|
-
# @return [Hash<String, Object>]
|
1681
|
-
def get_tags(opts = {})
|
1682
|
-
data, _status_code, _headers = get_tags_with_http_info(opts)
|
1683
|
-
data
|
1801
|
+
# @return [nil]
|
1802
|
+
def tag_segments(id, tag_segment_op, opts = {})
|
1803
|
+
tag_segments_with_http_info(id, tag_segment_op, opts)
|
1804
|
+
nil
|
1684
1805
|
end
|
1685
1806
|
|
1686
|
-
#
|
1687
|
-
|
1807
|
+
# alias of `tag_segments`
|
1808
|
+
alias create_tag_relationships_segments tag_segments
|
1809
|
+
|
1810
|
+
# alias of `tag_segments`
|
1811
|
+
alias create_tag_relationships_segment tag_segments
|
1812
|
+
|
1813
|
+
# Tag Segments
|
1814
|
+
# 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`
|
1815
|
+
# @param id [String] The Tag ID
|
1816
|
+
# @param tag_segment_op [TagSegmentOp]
|
1688
1817
|
# @param [Hash] opts the optional parameters
|
1689
|
-
# @
|
1690
|
-
|
1691
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
|
1692
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
1693
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1694
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1695
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1696
|
-
def get_tags_with_http_info(opts = {})
|
1818
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1819
|
+
def tag_segments_with_http_info(id, tag_segment_op, opts = {})
|
1697
1820
|
if @api_client.config.debugging
|
1698
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1699
|
-
end
|
1700
|
-
allowable_values = ["name", "exclusive", "default"]
|
1701
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
1702
|
-
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
1821
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.tag_segments ...'
|
1703
1822
|
end
|
1704
|
-
|
1705
|
-
if @api_client.config.client_side_validation &&
|
1706
|
-
fail ArgumentError, "
|
1707
|
-
end
|
1708
|
-
allowable_values = ["tag-group"]
|
1709
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1710
|
-
fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
|
1823
|
+
# verify the required parameter 'id' is set
|
1824
|
+
if @api_client.config.client_side_validation && id.nil?
|
1825
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.tag_segments"
|
1711
1826
|
end
|
1712
|
-
|
1713
|
-
if @api_client.config.client_side_validation &&
|
1714
|
-
fail ArgumentError, "
|
1827
|
+
# verify the required parameter 'tag_segment_op' is set
|
1828
|
+
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
1829
|
+
fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.tag_segments"
|
1715
1830
|
end
|
1716
1831
|
# resource path
|
1717
|
-
local_var_path = '/api/tags/'
|
1832
|
+
local_var_path = '/api/tags/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1718
1833
|
|
1719
1834
|
# query parameters
|
1720
1835
|
query_params = opts[:query_params] || {}
|
1721
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1722
|
-
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1723
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1724
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1725
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1726
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1727
1836
|
|
1728
1837
|
# header parameters
|
1729
1838
|
header_params = opts[:header_params] || {}
|
1730
1839
|
# klaviyo api revision
|
1731
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1840
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1732
1841
|
# HTTP header 'Accept' (if needed)
|
1733
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1842
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1843
|
+
# HTTP header 'Content-Type'
|
1844
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1845
|
+
if !content_type.nil?
|
1846
|
+
header_params['Content-Type'] = content_type
|
1847
|
+
end
|
1734
1848
|
|
1735
1849
|
# form parameters
|
1736
1850
|
form_params = opts[:form_params] || {}
|
1737
1851
|
|
1738
1852
|
# http body (model)
|
1739
|
-
post_body = opts[:debug_body]
|
1853
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_segment_op)
|
1740
1854
|
|
1741
1855
|
# return_type
|
1742
|
-
return_type = opts[:debug_return_type]
|
1856
|
+
return_type = opts[:debug_return_type]
|
1743
1857
|
|
1744
1858
|
# auth_names
|
1745
1859
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1746
1860
|
|
1747
1861
|
new_options = opts.merge(
|
1748
|
-
:operation => :"TagsApi.
|
1862
|
+
:operation => :"TagsApi.tag_segments",
|
1749
1863
|
:header_params => header_params,
|
1750
1864
|
:query_params => query_params,
|
1751
1865
|
:form_params => form_params,
|
@@ -1754,13 +1868,19 @@ module KlaviyoAPI
|
|
1754
1868
|
:return_type => return_type
|
1755
1869
|
)
|
1756
1870
|
|
1757
|
-
data, status_code, headers = @api_client.call_api(:
|
1871
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1758
1872
|
if @api_client.config.debugging
|
1759
|
-
@api_client.config.logger.debug "API called: TagsApi#
|
1873
|
+
@api_client.config.logger.debug "API called: TagsApi#tag_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1760
1874
|
end
|
1761
1875
|
return data, status_code, headers
|
1762
1876
|
end
|
1763
1877
|
|
1878
|
+
# alias of `tag_segments_with_http_info`
|
1879
|
+
alias create_tag_relationships_segments_with_http_info tag_segments_with_http_info
|
1880
|
+
|
1881
|
+
# alias of `tag_segments_with_http_info`
|
1882
|
+
alias create_tag_relationships_segment_with_http_info tag_segments_with_http_info
|
1883
|
+
|
1764
1884
|
# Update Tag
|
1765
1885
|
# 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`
|
1766
1886
|
# @param id [String] The Tag ID
|
@@ -1791,7 +1911,7 @@ module KlaviyoAPI
|
|
1791
1911
|
fail ArgumentError, "Missing the required parameter 'tag_update_query' when calling TagsApi.update_tag"
|
1792
1912
|
end
|
1793
1913
|
# resource path
|
1794
|
-
local_var_path = '/api/tags/{id}
|
1914
|
+
local_var_path = '/api/tags/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1795
1915
|
|
1796
1916
|
# query parameters
|
1797
1917
|
query_params = opts[:query_params] || {}
|
@@ -1799,11 +1919,11 @@ module KlaviyoAPI
|
|
1799
1919
|
# header parameters
|
1800
1920
|
header_params = opts[:header_params] || {}
|
1801
1921
|
# klaviyo api revision
|
1802
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1922
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1803
1923
|
# HTTP header 'Accept' (if needed)
|
1804
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1924
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1805
1925
|
# HTTP header 'Content-Type'
|
1806
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1926
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1807
1927
|
if !content_type.nil?
|
1808
1928
|
header_params['Content-Type'] = content_type
|
1809
1929
|
end
|
@@ -1867,7 +1987,7 @@ module KlaviyoAPI
|
|
1867
1987
|
fail ArgumentError, "Missing the required parameter 'tag_group_update_query' when calling TagsApi.update_tag_group"
|
1868
1988
|
end
|
1869
1989
|
# resource path
|
1870
|
-
local_var_path = '/api/tag-groups/{id}
|
1990
|
+
local_var_path = '/api/tag-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1871
1991
|
|
1872
1992
|
# query parameters
|
1873
1993
|
query_params = opts[:query_params] || {}
|
@@ -1875,11 +1995,11 @@ module KlaviyoAPI
|
|
1875
1995
|
# header parameters
|
1876
1996
|
header_params = opts[:header_params] || {}
|
1877
1997
|
# klaviyo api revision
|
1878
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-
|
1998
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
|
1879
1999
|
# HTTP header 'Accept' (if needed)
|
1880
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2000
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1881
2001
|
# HTTP header 'Content-Type'
|
1882
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
2002
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1883
2003
|
if !content_type.nil?
|
1884
2004
|
header_params['Content-Type'] = content_type
|
1885
2005
|
end
|