klaviyo-api-sdk 9.0.0 → 11.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 +35 -0
- data/README.md +1272 -524
- 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 +1720 -1576
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +317 -287
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +5 -5
- data/lib/klaviyo-api-sdk/api/events_api.rb +134 -122
- data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
- data/lib/klaviyo-api-sdk/api/forms_api.rb +56 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +28 -28
- data/lib/klaviyo-api-sdk/api/lists_api.rb +316 -153
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +582 -19
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +1046 -603
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +323 -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 +741 -645
- 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 +238 -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 +14 -10
- 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 +90 -22
- metadata +59 -4
@@ -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,40 +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
|
-
|
176
|
-
# Create Tag Relationships Campaigns
|
177
|
-
# 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`
|
178
|
-
# @param id [String]
|
179
|
-
# @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
|
180
175
|
# @param [Hash] opts the optional parameters
|
181
176
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
182
|
-
def
|
177
|
+
def delete_tag_with_http_info(id, opts = {})
|
183
178
|
if @api_client.config.debugging
|
184
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
179
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
|
185
180
|
end
|
186
181
|
# verify the required parameter 'id' is set
|
187
182
|
if @api_client.config.client_side_validation && id.nil?
|
188
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
189
|
-
end
|
190
|
-
# verify the required parameter 'tag_campaign_op' is set
|
191
|
-
if @api_client.config.client_side_validation && tag_campaign_op.nil?
|
192
|
-
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"
|
193
184
|
end
|
194
185
|
# resource path
|
195
|
-
local_var_path = '/api/tags/{id}
|
186
|
+
local_var_path = '/api/tags/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
196
187
|
|
197
188
|
# query parameters
|
198
189
|
query_params = opts[:query_params] || {}
|
@@ -200,20 +191,15 @@ module KlaviyoAPI
|
|
200
191
|
# header parameters
|
201
192
|
header_params = opts[:header_params] || {}
|
202
193
|
# klaviyo api revision
|
203
|
-
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"
|
204
195
|
# HTTP header 'Accept' (if needed)
|
205
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
206
|
-
# HTTP header 'Content-Type'
|
207
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
208
|
-
if !content_type.nil?
|
209
|
-
header_params['Content-Type'] = content_type
|
210
|
-
end
|
196
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
211
197
|
|
212
198
|
# form parameters
|
213
199
|
form_params = opts[:form_params] || {}
|
214
200
|
|
215
201
|
# http body (model)
|
216
|
-
post_body = opts[:debug_body]
|
202
|
+
post_body = opts[:debug_body]
|
217
203
|
|
218
204
|
# return_type
|
219
205
|
return_type = opts[:debug_return_type]
|
@@ -222,7 +208,7 @@ module KlaviyoAPI
|
|
222
208
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
223
209
|
|
224
210
|
new_options = opts.merge(
|
225
|
-
:operation => :"TagsApi.
|
211
|
+
:operation => :"TagsApi.delete_tag",
|
226
212
|
:header_params => header_params,
|
227
213
|
:query_params => query_params,
|
228
214
|
:form_params => form_params,
|
@@ -231,50 +217,38 @@ module KlaviyoAPI
|
|
231
217
|
:return_type => return_type
|
232
218
|
)
|
233
219
|
|
234
|
-
data, status_code, headers = @api_client.call_api(:
|
220
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
235
221
|
if @api_client.config.debugging
|
236
|
-
@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}"
|
237
223
|
end
|
238
224
|
return data, status_code, headers
|
239
225
|
end
|
240
226
|
|
241
|
-
#
|
242
|
-
|
243
|
-
|
244
|
-
# Create Tag Relationships Flows
|
245
|
-
# 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`
|
246
|
-
# @param id [String]
|
247
|
-
# @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
|
248
230
|
# @param [Hash] opts the optional parameters
|
249
|
-
# @return [
|
250
|
-
def
|
251
|
-
|
252
|
-
|
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
|
253
235
|
end
|
254
236
|
|
255
|
-
#
|
256
|
-
|
257
|
-
|
258
|
-
# Create Tag Relationships Flows
|
259
|
-
# 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`
|
260
|
-
# @param id [String]
|
261
|
-
# @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
|
262
240
|
# @param [Hash] opts the optional parameters
|
263
|
-
# @return [Array<(
|
264
|
-
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 = {})
|
265
243
|
if @api_client.config.debugging
|
266
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
244
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_group ...'
|
267
245
|
end
|
268
246
|
# verify the required parameter 'id' is set
|
269
247
|
if @api_client.config.client_side_validation && id.nil?
|
270
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
271
|
-
end
|
272
|
-
# verify the required parameter 'tag_flow_op' is set
|
273
|
-
if @api_client.config.client_side_validation && tag_flow_op.nil?
|
274
|
-
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"
|
275
249
|
end
|
276
250
|
# resource path
|
277
|
-
local_var_path = '/api/
|
251
|
+
local_var_path = '/api/tag-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
278
252
|
|
279
253
|
# query parameters
|
280
254
|
query_params = opts[:query_params] || {}
|
@@ -282,29 +256,24 @@ module KlaviyoAPI
|
|
282
256
|
# header parameters
|
283
257
|
header_params = opts[:header_params] || {}
|
284
258
|
# klaviyo api revision
|
285
|
-
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"
|
286
260
|
# HTTP header 'Accept' (if needed)
|
287
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
288
|
-
# HTTP header 'Content-Type'
|
289
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
290
|
-
if !content_type.nil?
|
291
|
-
header_params['Content-Type'] = content_type
|
292
|
-
end
|
261
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
293
262
|
|
294
263
|
# form parameters
|
295
264
|
form_params = opts[:form_params] || {}
|
296
265
|
|
297
266
|
# http body (model)
|
298
|
-
post_body = opts[:debug_body]
|
267
|
+
post_body = opts[:debug_body]
|
299
268
|
|
300
269
|
# return_type
|
301
|
-
return_type = opts[:debug_return_type]
|
270
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
302
271
|
|
303
272
|
# auth_names
|
304
273
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
305
274
|
|
306
275
|
new_options = opts.merge(
|
307
|
-
:operation => :"TagsApi.
|
276
|
+
:operation => :"TagsApi.delete_tag_group",
|
308
277
|
:header_params => header_params,
|
309
278
|
:query_params => query_params,
|
310
279
|
:form_params => form_params,
|
@@ -313,50 +282,41 @@ module KlaviyoAPI
|
|
313
282
|
:return_type => return_type
|
314
283
|
)
|
315
284
|
|
316
|
-
data, status_code, headers = @api_client.call_api(:
|
285
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
317
286
|
if @api_client.config.debugging
|
318
|
-
@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}"
|
319
288
|
end
|
320
289
|
return data, status_code, headers
|
321
290
|
end
|
322
291
|
|
323
|
-
#
|
324
|
-
|
325
|
-
|
326
|
-
# Create Tag Relationships Lists
|
327
|
-
# 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`
|
328
|
-
# @param id [String]
|
329
|
-
# @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
|
330
295
|
# @param [Hash] opts the optional parameters
|
331
|
-
# @return [
|
332
|
-
def
|
333
|
-
|
334
|
-
|
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
|
335
300
|
end
|
336
301
|
|
337
|
-
# alias of `
|
338
|
-
alias
|
302
|
+
# alias of `get_campaign_ids_for_tag`
|
303
|
+
alias get_tag_relationships_campaigns get_campaign_ids_for_tag
|
339
304
|
|
340
|
-
#
|
341
|
-
#
|
342
|
-
# @param id [String]
|
343
|
-
# @param tag_list_op [TagListOp]
|
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
|
344
308
|
# @param [Hash] opts the optional parameters
|
345
|
-
# @return [Array<(
|
346
|
-
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 = {})
|
347
311
|
if @api_client.config.debugging
|
348
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
312
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_campaign_ids_for_tag ...'
|
349
313
|
end
|
350
314
|
# verify the required parameter 'id' is set
|
351
315
|
if @api_client.config.client_side_validation && id.nil?
|
352
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
353
|
-
end
|
354
|
-
# verify the required parameter 'tag_list_op' is set
|
355
|
-
if @api_client.config.client_side_validation && tag_list_op.nil?
|
356
|
-
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"
|
357
317
|
end
|
358
318
|
# resource path
|
359
|
-
local_var_path = '/api/tags/{id}/relationships/
|
319
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
360
320
|
|
361
321
|
# query parameters
|
362
322
|
query_params = opts[:query_params] || {}
|
@@ -364,29 +324,24 @@ module KlaviyoAPI
|
|
364
324
|
# header parameters
|
365
325
|
header_params = opts[:header_params] || {}
|
366
326
|
# klaviyo api revision
|
367
|
-
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"
|
368
328
|
# HTTP header 'Accept' (if needed)
|
369
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
370
|
-
# HTTP header 'Content-Type'
|
371
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
372
|
-
if !content_type.nil?
|
373
|
-
header_params['Content-Type'] = content_type
|
374
|
-
end
|
329
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
375
330
|
|
376
331
|
# form parameters
|
377
332
|
form_params = opts[:form_params] || {}
|
378
333
|
|
379
334
|
# http body (model)
|
380
|
-
post_body = opts[:debug_body]
|
335
|
+
post_body = opts[:debug_body]
|
381
336
|
|
382
337
|
# return_type
|
383
|
-
return_type = opts[:debug_return_type]
|
338
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
384
339
|
|
385
340
|
# auth_names
|
386
341
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
387
342
|
|
388
343
|
new_options = opts.merge(
|
389
|
-
:operation => :"TagsApi.
|
344
|
+
:operation => :"TagsApi.get_campaign_ids_for_tag",
|
390
345
|
:header_params => header_params,
|
391
346
|
:query_params => query_params,
|
392
347
|
:form_params => form_params,
|
@@ -395,50 +350,44 @@ module KlaviyoAPI
|
|
395
350
|
:return_type => return_type
|
396
351
|
)
|
397
352
|
|
398
|
-
data, status_code, headers = @api_client.call_api(:
|
353
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
399
354
|
if @api_client.config.debugging
|
400
|
-
@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}"
|
401
356
|
end
|
402
357
|
return data, status_code, headers
|
403
358
|
end
|
404
359
|
|
405
|
-
# alias of `
|
406
|
-
alias
|
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
|
407
362
|
|
408
|
-
#
|
409
|
-
#
|
410
|
-
# @param id [String]
|
411
|
-
# @param tag_segment_op [TagSegmentOp]
|
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
|
412
366
|
# @param [Hash] opts the optional parameters
|
413
|
-
# @return [
|
414
|
-
def
|
415
|
-
|
416
|
-
|
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
|
417
371
|
end
|
418
372
|
|
419
|
-
# alias of `
|
420
|
-
alias
|
373
|
+
# alias of `get_flow_ids_for_tag`
|
374
|
+
alias get_tag_relationships_flows get_flow_ids_for_tag
|
421
375
|
|
422
|
-
#
|
423
|
-
#
|
424
|
-
# @param id [String]
|
425
|
-
# @param tag_segment_op [TagSegmentOp]
|
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
|
426
379
|
# @param [Hash] opts the optional parameters
|
427
|
-
# @return [Array<(
|
428
|
-
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 = {})
|
429
382
|
if @api_client.config.debugging
|
430
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
383
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_flow_ids_for_tag ...'
|
431
384
|
end
|
432
385
|
# verify the required parameter 'id' is set
|
433
386
|
if @api_client.config.client_side_validation && id.nil?
|
434
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
435
|
-
end
|
436
|
-
# verify the required parameter 'tag_segment_op' is set
|
437
|
-
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
438
|
-
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"
|
439
388
|
end
|
440
389
|
# resource path
|
441
|
-
local_var_path = '/api/tags/{id}/relationships/
|
390
|
+
local_var_path = '/api/tags/{id}/relationships/flows'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
442
391
|
|
443
392
|
# query parameters
|
444
393
|
query_params = opts[:query_params] || {}
|
@@ -446,29 +395,24 @@ module KlaviyoAPI
|
|
446
395
|
# header parameters
|
447
396
|
header_params = opts[:header_params] || {}
|
448
397
|
# klaviyo api revision
|
449
|
-
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"
|
450
399
|
# HTTP header 'Accept' (if needed)
|
451
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
452
|
-
# HTTP header 'Content-Type'
|
453
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
454
|
-
if !content_type.nil?
|
455
|
-
header_params['Content-Type'] = content_type
|
456
|
-
end
|
400
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
457
401
|
|
458
402
|
# form parameters
|
459
403
|
form_params = opts[:form_params] || {}
|
460
404
|
|
461
405
|
# http body (model)
|
462
|
-
post_body = opts[:debug_body]
|
406
|
+
post_body = opts[:debug_body]
|
463
407
|
|
464
408
|
# return_type
|
465
|
-
return_type = opts[:debug_return_type]
|
409
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
466
410
|
|
467
411
|
# auth_names
|
468
412
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
469
413
|
|
470
414
|
new_options = opts.merge(
|
471
|
-
:operation => :"TagsApi.
|
415
|
+
:operation => :"TagsApi.get_flow_ids_for_tag",
|
472
416
|
:header_params => header_params,
|
473
417
|
:query_params => query_params,
|
474
418
|
:form_params => form_params,
|
@@ -477,41 +421,44 @@ module KlaviyoAPI
|
|
477
421
|
:return_type => return_type
|
478
422
|
)
|
479
423
|
|
480
|
-
data, status_code, headers = @api_client.call_api(:
|
424
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
481
425
|
if @api_client.config.debugging
|
482
|
-
@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}"
|
483
427
|
end
|
484
428
|
return data, status_code, headers
|
485
429
|
end
|
486
430
|
|
487
|
-
# alias of `
|
488
|
-
alias
|
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
|
489
433
|
|
490
|
-
#
|
491
|
-
#
|
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`
|
492
436
|
# @param id [String] The Tag ID
|
493
437
|
# @param [Hash] opts the optional parameters
|
494
|
-
# @return [
|
495
|
-
def
|
496
|
-
|
497
|
-
|
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
|
498
442
|
end
|
499
443
|
|
500
|
-
#
|
501
|
-
|
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`
|
502
449
|
# @param id [String] The Tag ID
|
503
450
|
# @param [Hash] opts the optional parameters
|
504
|
-
# @return [Array<(
|
505
|
-
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 = {})
|
506
453
|
if @api_client.config.debugging
|
507
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
454
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_list_ids_for_tag ...'
|
508
455
|
end
|
509
456
|
# verify the required parameter 'id' is set
|
510
457
|
if @api_client.config.client_side_validation && id.nil?
|
511
|
-
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"
|
512
459
|
end
|
513
460
|
# resource path
|
514
|
-
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))
|
515
462
|
|
516
463
|
# query parameters
|
517
464
|
query_params = opts[:query_params] || {}
|
@@ -519,9 +466,9 @@ module KlaviyoAPI
|
|
519
466
|
# header parameters
|
520
467
|
header_params = opts[:header_params] || {}
|
521
468
|
# klaviyo api revision
|
522
|
-
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"
|
523
470
|
# HTTP header 'Accept' (if needed)
|
524
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
471
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
525
472
|
|
526
473
|
# form parameters
|
527
474
|
form_params = opts[:form_params] || {}
|
@@ -530,13 +477,13 @@ module KlaviyoAPI
|
|
530
477
|
post_body = opts[:debug_body]
|
531
478
|
|
532
479
|
# return_type
|
533
|
-
return_type = opts[:debug_return_type]
|
480
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
534
481
|
|
535
482
|
# auth_names
|
536
483
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
537
484
|
|
538
485
|
new_options = opts.merge(
|
539
|
-
:operation => :"TagsApi.
|
486
|
+
:operation => :"TagsApi.get_list_ids_for_tag",
|
540
487
|
:header_params => header_params,
|
541
488
|
:query_params => query_params,
|
542
489
|
:form_params => form_params,
|
@@ -545,38 +492,44 @@ module KlaviyoAPI
|
|
545
492
|
:return_type => return_type
|
546
493
|
)
|
547
494
|
|
548
|
-
data, status_code, headers = @api_client.call_api(:
|
495
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
549
496
|
if @api_client.config.debugging
|
550
|
-
@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}"
|
551
498
|
end
|
552
499
|
return data, status_code, headers
|
553
500
|
end
|
554
501
|
|
555
|
-
#
|
556
|
-
|
557
|
-
|
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
|
558
508
|
# @param [Hash] opts the optional parameters
|
559
509
|
# @return [Hash<String, Object>]
|
560
|
-
def
|
561
|
-
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)
|
562
512
|
data
|
563
513
|
end
|
564
514
|
|
565
|
-
#
|
566
|
-
|
567
|
-
|
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
|
568
521
|
# @param [Hash] opts the optional parameters
|
569
522
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
570
|
-
def
|
523
|
+
def get_segment_ids_for_tag_with_http_info(id, opts = {})
|
571
524
|
if @api_client.config.debugging
|
572
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
525
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_segment_ids_for_tag ...'
|
573
526
|
end
|
574
527
|
# verify the required parameter 'id' is set
|
575
528
|
if @api_client.config.client_side_validation && id.nil?
|
576
|
-
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"
|
577
530
|
end
|
578
531
|
# resource path
|
579
|
-
local_var_path = '/api/
|
532
|
+
local_var_path = '/api/tags/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
580
533
|
|
581
534
|
# query parameters
|
582
535
|
query_params = opts[:query_params] || {}
|
@@ -584,9 +537,9 @@ module KlaviyoAPI
|
|
584
537
|
# header parameters
|
585
538
|
header_params = opts[:header_params] || {}
|
586
539
|
# klaviyo api revision
|
587
|
-
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"
|
588
541
|
# HTTP header 'Accept' (if needed)
|
589
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
542
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
590
543
|
|
591
544
|
# form parameters
|
592
545
|
form_params = opts[:form_params] || {}
|
@@ -601,7 +554,7 @@ module KlaviyoAPI
|
|
601
554
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
602
555
|
|
603
556
|
new_options = opts.merge(
|
604
|
-
:operation => :"TagsApi.
|
557
|
+
:operation => :"TagsApi.get_segment_ids_for_tag",
|
605
558
|
:header_params => header_params,
|
606
559
|
:query_params => query_params,
|
607
560
|
:form_params => form_params,
|
@@ -610,74 +563,87 @@ module KlaviyoAPI
|
|
610
563
|
:return_type => return_type
|
611
564
|
)
|
612
565
|
|
613
|
-
data, status_code, headers = @api_client.call_api(:
|
566
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
614
567
|
if @api_client.config.debugging
|
615
|
-
@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}"
|
616
569
|
end
|
617
570
|
return data, status_code, headers
|
618
571
|
end
|
619
572
|
|
620
|
-
#
|
621
|
-
|
622
|
-
|
623
|
-
#
|
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
|
624
579
|
# @param [Hash] opts the optional parameters
|
625
|
-
# @
|
626
|
-
|
627
|
-
|
628
|
-
|
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
|
629
587
|
end
|
630
588
|
|
631
|
-
#
|
632
|
-
#
|
633
|
-
# @param id [String]
|
634
|
-
# @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
|
635
592
|
# @param [Hash] opts the optional parameters
|
636
|
-
# @
|
637
|
-
|
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 = {})
|
638
598
|
if @api_client.config.debugging
|
639
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
599
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag ...'
|
640
600
|
end
|
641
601
|
# verify the required parameter 'id' is set
|
642
602
|
if @api_client.config.client_side_validation && id.nil?
|
643
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
603
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
644
604
|
end
|
645
|
-
|
646
|
-
if @api_client.config.client_side_validation &&
|
647
|
-
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}"
|
648
616
|
end
|
649
617
|
# resource path
|
650
|
-
local_var_path = '/api/tags/{id}
|
618
|
+
local_var_path = '/api/tags/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
651
619
|
|
652
620
|
# query parameters
|
653
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?
|
654
625
|
|
655
626
|
# header parameters
|
656
627
|
header_params = opts[:header_params] || {}
|
657
628
|
# klaviyo api revision
|
658
|
-
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"
|
659
630
|
# HTTP header 'Accept' (if needed)
|
660
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
661
|
-
# HTTP header 'Content-Type'
|
662
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
663
|
-
if !content_type.nil?
|
664
|
-
header_params['Content-Type'] = content_type
|
665
|
-
end
|
631
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
666
632
|
|
667
633
|
# form parameters
|
668
634
|
form_params = opts[:form_params] || {}
|
669
635
|
|
670
636
|
# http body (model)
|
671
|
-
post_body = opts[:debug_body]
|
637
|
+
post_body = opts[:debug_body]
|
672
638
|
|
673
639
|
# return_type
|
674
|
-
return_type = opts[:debug_return_type]
|
640
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
675
641
|
|
676
642
|
# auth_names
|
677
643
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
678
644
|
|
679
645
|
new_options = opts.merge(
|
680
|
-
:operation => :"TagsApi.
|
646
|
+
:operation => :"TagsApi.get_tag",
|
681
647
|
:header_params => header_params,
|
682
648
|
:query_params => query_params,
|
683
649
|
:form_params => form_params,
|
@@ -686,74 +652,70 @@ module KlaviyoAPI
|
|
686
652
|
:return_type => return_type
|
687
653
|
)
|
688
654
|
|
689
|
-
data, status_code, headers = @api_client.call_api(:
|
655
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
690
656
|
if @api_client.config.debugging
|
691
|
-
@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}"
|
692
658
|
end
|
693
659
|
return data, status_code, headers
|
694
660
|
end
|
695
661
|
|
696
|
-
#
|
697
|
-
#
|
698
|
-
# @param id [String]
|
699
|
-
# @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
|
700
665
|
# @param [Hash] opts the optional parameters
|
701
|
-
# @
|
702
|
-
|
703
|
-
|
704
|
-
|
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
|
705
671
|
end
|
706
672
|
|
707
|
-
#
|
708
|
-
#
|
709
|
-
# @param id [String]
|
710
|
-
# @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
|
711
676
|
# @param [Hash] opts the optional parameters
|
712
|
-
# @
|
713
|
-
|
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 = {})
|
714
680
|
if @api_client.config.debugging
|
715
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
681
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group ...'
|
716
682
|
end
|
717
683
|
# verify the required parameter 'id' is set
|
718
684
|
if @api_client.config.client_side_validation && id.nil?
|
719
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
685
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag_group"
|
720
686
|
end
|
721
|
-
|
722
|
-
if @api_client.config.client_side_validation &&
|
723
|
-
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}"
|
724
690
|
end
|
725
691
|
# resource path
|
726
|
-
local_var_path = '/api/
|
692
|
+
local_var_path = '/api/tag-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
727
693
|
|
728
694
|
# query parameters
|
729
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?
|
730
697
|
|
731
698
|
# header parameters
|
732
699
|
header_params = opts[:header_params] || {}
|
733
700
|
# klaviyo api revision
|
734
|
-
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"
|
735
702
|
# HTTP header 'Accept' (if needed)
|
736
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
737
|
-
# HTTP header 'Content-Type'
|
738
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
739
|
-
if !content_type.nil?
|
740
|
-
header_params['Content-Type'] = content_type
|
741
|
-
end
|
703
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
742
704
|
|
743
705
|
# form parameters
|
744
706
|
form_params = opts[:form_params] || {}
|
745
707
|
|
746
708
|
# http body (model)
|
747
|
-
post_body = opts[:debug_body]
|
709
|
+
post_body = opts[:debug_body]
|
748
710
|
|
749
711
|
# return_type
|
750
|
-
return_type = opts[:debug_return_type]
|
712
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
751
713
|
|
752
714
|
# auth_names
|
753
715
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
754
716
|
|
755
717
|
new_options = opts.merge(
|
756
|
-
:operation => :"TagsApi.
|
718
|
+
:operation => :"TagsApi.get_tag_group",
|
757
719
|
:header_params => header_params,
|
758
720
|
:query_params => query_params,
|
759
721
|
:form_params => form_params,
|
@@ -762,74 +724,73 @@ module KlaviyoAPI
|
|
762
724
|
:return_type => return_type
|
763
725
|
)
|
764
726
|
|
765
|
-
data, status_code, headers = @api_client.call_api(:
|
727
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
766
728
|
if @api_client.config.debugging
|
767
|
-
@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}"
|
768
730
|
end
|
769
731
|
return data, status_code, headers
|
770
732
|
end
|
771
733
|
|
772
|
-
#
|
773
|
-
#
|
774
|
-
# @param id [String]
|
775
|
-
# @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
|
776
737
|
# @param [Hash] opts the optional parameters
|
777
|
-
# @
|
778
|
-
|
779
|
-
|
780
|
-
|
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
|
781
743
|
end
|
782
744
|
|
783
|
-
#
|
784
|
-
|
785
|
-
|
786
|
-
#
|
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
|
787
751
|
# @param [Hash] opts the optional parameters
|
788
|
-
# @
|
789
|
-
|
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 = {})
|
790
755
|
if @api_client.config.debugging
|
791
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
756
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_for_tag ...'
|
792
757
|
end
|
793
758
|
# verify the required parameter 'id' is set
|
794
759
|
if @api_client.config.client_side_validation && id.nil?
|
795
|
-
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"
|
796
761
|
end
|
797
|
-
|
798
|
-
if @api_client.config.client_side_validation &&
|
799
|
-
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}"
|
800
765
|
end
|
801
766
|
# resource path
|
802
|
-
local_var_path = '/api/tags/{id}/
|
767
|
+
local_var_path = '/api/tags/{id}/tag-group'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
803
768
|
|
804
769
|
# query parameters
|
805
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?
|
806
772
|
|
807
773
|
# header parameters
|
808
774
|
header_params = opts[:header_params] || {}
|
809
775
|
# klaviyo api revision
|
810
|
-
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"
|
811
777
|
# HTTP header 'Accept' (if needed)
|
812
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
813
|
-
# HTTP header 'Content-Type'
|
814
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
815
|
-
if !content_type.nil?
|
816
|
-
header_params['Content-Type'] = content_type
|
817
|
-
end
|
778
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
818
779
|
|
819
780
|
# form parameters
|
820
781
|
form_params = opts[:form_params] || {}
|
821
782
|
|
822
783
|
# http body (model)
|
823
|
-
post_body = opts[:debug_body]
|
784
|
+
post_body = opts[:debug_body]
|
824
785
|
|
825
786
|
# return_type
|
826
|
-
return_type = opts[:debug_return_type]
|
787
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
827
788
|
|
828
789
|
# auth_names
|
829
790
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
830
791
|
|
831
792
|
new_options = opts.merge(
|
832
|
-
:operation => :"TagsApi.
|
793
|
+
:operation => :"TagsApi.get_tag_group_for_tag",
|
833
794
|
:header_params => header_params,
|
834
795
|
:query_params => query_params,
|
835
796
|
:form_params => form_params,
|
@@ -838,44 +799,44 @@ module KlaviyoAPI
|
|
838
799
|
:return_type => return_type
|
839
800
|
)
|
840
801
|
|
841
|
-
data, status_code, headers = @api_client.call_api(:
|
802
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
842
803
|
if @api_client.config.debugging
|
843
|
-
@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}"
|
844
805
|
end
|
845
806
|
return data, status_code, headers
|
846
807
|
end
|
847
808
|
|
848
|
-
#
|
849
|
-
|
850
|
-
|
851
|
-
#
|
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
|
852
815
|
# @param [Hash] opts the optional parameters
|
853
|
-
# @return [
|
854
|
-
def
|
855
|
-
|
856
|
-
|
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
|
857
820
|
end
|
858
821
|
|
859
|
-
#
|
860
|
-
|
861
|
-
|
862
|
-
#
|
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
|
863
828
|
# @param [Hash] opts the optional parameters
|
864
|
-
# @return [Array<(
|
865
|
-
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 = {})
|
866
831
|
if @api_client.config.debugging
|
867
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
832
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_id_for_tag ...'
|
868
833
|
end
|
869
834
|
# verify the required parameter 'id' is set
|
870
835
|
if @api_client.config.client_side_validation && id.nil?
|
871
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
872
|
-
end
|
873
|
-
# verify the required parameter 'tag_segment_op' is set
|
874
|
-
if @api_client.config.client_side_validation && tag_segment_op.nil?
|
875
|
-
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"
|
876
837
|
end
|
877
838
|
# resource path
|
878
|
-
local_var_path = '/api/tags/{id}/relationships/
|
839
|
+
local_var_path = '/api/tags/{id}/relationships/tag-group'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
879
840
|
|
880
841
|
# query parameters
|
881
842
|
query_params = opts[:query_params] || {}
|
@@ -883,29 +844,24 @@ module KlaviyoAPI
|
|
883
844
|
# header parameters
|
884
845
|
header_params = opts[:header_params] || {}
|
885
846
|
# klaviyo api revision
|
886
|
-
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"
|
887
848
|
# HTTP header 'Accept' (if needed)
|
888
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
889
|
-
# HTTP header 'Content-Type'
|
890
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
891
|
-
if !content_type.nil?
|
892
|
-
header_params['Content-Type'] = content_type
|
893
|
-
end
|
849
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
894
850
|
|
895
851
|
# form parameters
|
896
852
|
form_params = opts[:form_params] || {}
|
897
853
|
|
898
854
|
# http body (model)
|
899
|
-
post_body = opts[:debug_body]
|
855
|
+
post_body = opts[:debug_body]
|
900
856
|
|
901
857
|
# return_type
|
902
|
-
return_type = opts[:debug_return_type]
|
858
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
903
859
|
|
904
860
|
# auth_names
|
905
861
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
906
862
|
|
907
863
|
new_options = opts.merge(
|
908
|
-
:operation => :"TagsApi.
|
864
|
+
:operation => :"TagsApi.get_tag_group_id_for_tag",
|
909
865
|
:header_params => header_params,
|
910
866
|
:query_params => query_params,
|
911
867
|
:form_params => form_params,
|
@@ -914,69 +870,65 @@ module KlaviyoAPI
|
|
914
870
|
:return_type => return_type
|
915
871
|
)
|
916
872
|
|
917
|
-
data, status_code, headers = @api_client.call_api(:
|
873
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
918
874
|
if @api_client.config.debugging
|
919
|
-
@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}"
|
920
876
|
end
|
921
877
|
return data, status_code, headers
|
922
878
|
end
|
923
879
|
|
924
|
-
#
|
925
|
-
|
926
|
-
|
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`
|
927
885
|
# @param [Hash] opts the optional parameters
|
928
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-
|
929
|
-
# @option opts [
|
930
|
-
# @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
|
931
890
|
# @return [Hash<String, Object>]
|
932
|
-
def
|
933
|
-
data, _status_code, _headers =
|
891
|
+
def get_tag_groups(opts = {})
|
892
|
+
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
934
893
|
data
|
935
894
|
end
|
936
895
|
|
937
|
-
# Get Tag
|
938
|
-
#
|
939
|
-
# @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`
|
940
898
|
# @param [Hash] opts the optional parameters
|
941
|
-
# @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2024-
|
942
|
-
# @option opts [
|
943
|
-
# @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
|
944
903
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
945
|
-
def
|
904
|
+
def get_tag_groups_with_http_info(opts = {})
|
946
905
|
if @api_client.config.debugging
|
947
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
948
|
-
end
|
949
|
-
# verify the required parameter 'id' is set
|
950
|
-
if @api_client.config.client_side_validation && id.nil?
|
951
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.get_tag"
|
906
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_groups ...'
|
952
907
|
end
|
953
908
|
allowable_values = ["name", "exclusive", "default"]
|
954
909
|
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
955
910
|
fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}"
|
956
911
|
end
|
957
|
-
allowable_values = ["name"]
|
958
|
-
if @api_client.config.client_side_validation && opts[:'
|
959
|
-
fail ArgumentError, "invalid value for \"
|
960
|
-
end
|
961
|
-
allowable_values = ["tag-group"]
|
962
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
963
|
-
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}"
|
964
915
|
end
|
965
916
|
# resource path
|
966
|
-
local_var_path = '/api/
|
917
|
+
local_var_path = '/api/tag-groups'
|
967
918
|
|
968
919
|
# query parameters
|
969
920
|
query_params = opts[:query_params] || {}
|
970
921
|
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
971
|
-
query_params[:'
|
972
|
-
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?
|
973
925
|
|
974
926
|
# header parameters
|
975
927
|
header_params = opts[:header_params] || {}
|
976
928
|
# klaviyo api revision
|
977
|
-
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"
|
978
930
|
# HTTP header 'Accept' (if needed)
|
979
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
931
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
980
932
|
|
981
933
|
# form parameters
|
982
934
|
form_params = opts[:form_params] || {}
|
@@ -991,7 +943,7 @@ module KlaviyoAPI
|
|
991
943
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
992
944
|
|
993
945
|
new_options = opts.merge(
|
994
|
-
:operation => :"TagsApi.
|
946
|
+
:operation => :"TagsApi.get_tag_groups",
|
995
947
|
:header_params => header_params,
|
996
948
|
:query_params => query_params,
|
997
949
|
:form_params => form_params,
|
@@ -1002,53 +954,49 @@ module KlaviyoAPI
|
|
1002
954
|
|
1003
955
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1004
956
|
if @api_client.config.debugging
|
1005
|
-
@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}"
|
1006
958
|
end
|
1007
959
|
return data, status_code, headers
|
1008
960
|
end
|
1009
961
|
|
1010
|
-
# Get Tag Group
|
1011
|
-
#
|
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`
|
1012
964
|
# @param id [String] The Tag Group ID
|
1013
965
|
# @param [Hash] opts the optional parameters
|
1014
|
-
# @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
|
1015
966
|
# @return [Hash<String, Object>]
|
1016
|
-
def
|
1017
|
-
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)
|
1018
969
|
data
|
1019
970
|
end
|
1020
971
|
|
1021
|
-
#
|
1022
|
-
|
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`
|
1023
977
|
# @param id [String] The Tag Group ID
|
1024
978
|
# @param [Hash] opts the optional parameters
|
1025
|
-
# @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
|
1026
979
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1027
|
-
def
|
980
|
+
def get_tag_ids_for_tag_group_with_http_info(id, opts = {})
|
1028
981
|
if @api_client.config.debugging
|
1029
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
982
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tag_ids_for_tag_group ...'
|
1030
983
|
end
|
1031
984
|
# verify the required parameter 'id' is set
|
1032
985
|
if @api_client.config.client_side_validation && id.nil?
|
1033
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1034
|
-
end
|
1035
|
-
allowable_values = ["name", "exclusive", "default"]
|
1036
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
1037
|
-
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"
|
1038
987
|
end
|
1039
988
|
# resource path
|
1040
|
-
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))
|
1041
990
|
|
1042
991
|
# query parameters
|
1043
992
|
query_params = opts[:query_params] || {}
|
1044
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1045
993
|
|
1046
994
|
# header parameters
|
1047
995
|
header_params = opts[:header_params] || {}
|
1048
996
|
# klaviyo api revision
|
1049
|
-
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"
|
1050
998
|
# HTTP header 'Accept' (if needed)
|
1051
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
999
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1052
1000
|
|
1053
1001
|
# form parameters
|
1054
1002
|
form_params = opts[:form_params] || {}
|
@@ -1063,7 +1011,7 @@ module KlaviyoAPI
|
|
1063
1011
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1064
1012
|
|
1065
1013
|
new_options = opts.merge(
|
1066
|
-
:operation => :"TagsApi.
|
1014
|
+
:operation => :"TagsApi.get_tag_ids_for_tag_group",
|
1067
1015
|
:header_params => header_params,
|
1068
1016
|
:query_params => query_params,
|
1069
1017
|
:form_params => form_params,
|
@@ -1074,46 +1022,77 @@ module KlaviyoAPI
|
|
1074
1022
|
|
1075
1023
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1076
1024
|
if @api_client.config.debugging
|
1077
|
-
@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}"
|
1078
1026
|
end
|
1079
1027
|
return data, status_code, headers
|
1080
1028
|
end
|
1081
1029
|
|
1082
|
-
#
|
1083
|
-
|
1084
|
-
|
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`
|
1085
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
|
1086
1042
|
# @return [Hash<String, Object>]
|
1087
|
-
def
|
1088
|
-
data, _status_code, _headers =
|
1043
|
+
def get_tags(opts = {})
|
1044
|
+
data, _status_code, _headers = get_tags_with_http_info(opts)
|
1089
1045
|
data
|
1090
1046
|
end
|
1091
1047
|
|
1092
|
-
# Get
|
1093
|
-
# Returns
|
1094
|
-
# @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`
|
1095
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
|
1096
1057
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1097
|
-
def
|
1058
|
+
def get_tags_with_http_info(opts = {})
|
1098
1059
|
if @api_client.config.debugging
|
1099
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1060
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...'
|
1100
1061
|
end
|
1101
|
-
|
1102
|
-
if @api_client.config.client_side_validation &&
|
1103
|
-
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}"
|
1104
1077
|
end
|
1105
1078
|
# resource path
|
1106
|
-
local_var_path = '/api/
|
1079
|
+
local_var_path = '/api/tags'
|
1107
1080
|
|
1108
1081
|
# query parameters
|
1109
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?
|
1110
1089
|
|
1111
1090
|
# header parameters
|
1112
1091
|
header_params = opts[:header_params] || {}
|
1113
1092
|
# klaviyo api revision
|
1114
|
-
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"
|
1115
1094
|
# HTTP header 'Accept' (if needed)
|
1116
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1095
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1117
1096
|
|
1118
1097
|
# form parameters
|
1119
1098
|
form_params = opts[:form_params] || {}
|
@@ -1128,7 +1107,7 @@ module KlaviyoAPI
|
|
1128
1107
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1129
1108
|
|
1130
1109
|
new_options = opts.merge(
|
1131
|
-
:operation => :"TagsApi.
|
1110
|
+
:operation => :"TagsApi.get_tags",
|
1132
1111
|
:header_params => header_params,
|
1133
1112
|
:query_params => query_params,
|
1134
1113
|
:form_params => form_params,
|
@@ -1139,42 +1118,45 @@ module KlaviyoAPI
|
|
1139
1118
|
|
1140
1119
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1141
1120
|
if @api_client.config.debugging
|
1142
|
-
@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}"
|
1143
1122
|
end
|
1144
1123
|
return data, status_code, headers
|
1145
1124
|
end
|
1146
1125
|
|
1147
|
-
# Get Tag Group
|
1126
|
+
# Get Tags for Tag Group
|
1148
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`
|
1149
|
-
# @param id [String]
|
1128
|
+
# @param id [String] The Tag Group ID
|
1150
1129
|
# @param [Hash] opts the optional parameters
|
1151
|
-
# @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
|
1152
1131
|
# @return [Hash<String, Object>]
|
1153
|
-
def
|
1154
|
-
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)
|
1155
1134
|
data
|
1156
1135
|
end
|
1157
1136
|
|
1158
|
-
#
|
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
|
1159
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`
|
1160
|
-
# @param id [String]
|
1142
|
+
# @param id [String] The Tag Group ID
|
1161
1143
|
# @param [Hash] opts the optional parameters
|
1162
|
-
# @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
|
1163
1145
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1164
|
-
def
|
1146
|
+
def get_tags_for_tag_group_with_http_info(id, opts = {})
|
1165
1147
|
if @api_client.config.debugging
|
1166
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1148
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.get_tags_for_tag_group ...'
|
1167
1149
|
end
|
1168
1150
|
# verify the required parameter 'id' is set
|
1169
1151
|
if @api_client.config.client_side_validation && id.nil?
|
1170
|
-
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"
|
1171
1153
|
end
|
1172
1154
|
allowable_values = ["name"]
|
1173
1155
|
if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
|
1174
1156
|
fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
|
1175
1157
|
end
|
1176
1158
|
# resource path
|
1177
|
-
local_var_path = '/api/tag-groups/{id}/tags
|
1159
|
+
local_var_path = '/api/tag-groups/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1178
1160
|
|
1179
1161
|
# query parameters
|
1180
1162
|
query_params = opts[:query_params] || {}
|
@@ -1183,9 +1165,9 @@ module KlaviyoAPI
|
|
1183
1165
|
# header parameters
|
1184
1166
|
header_params = opts[:header_params] || {}
|
1185
1167
|
# klaviyo api revision
|
1186
|
-
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"
|
1187
1169
|
# HTTP header 'Accept' (if needed)
|
1188
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1170
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1189
1171
|
|
1190
1172
|
# form parameters
|
1191
1173
|
form_params = opts[:form_params] || {}
|
@@ -1200,7 +1182,7 @@ module KlaviyoAPI
|
|
1200
1182
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1201
1183
|
|
1202
1184
|
new_options = opts.merge(
|
1203
|
-
:operation => :"TagsApi.
|
1185
|
+
:operation => :"TagsApi.get_tags_for_tag_group",
|
1204
1186
|
:header_params => header_params,
|
1205
1187
|
:query_params => query_params,
|
1206
1188
|
:form_params => form_params,
|
@@ -1211,75 +1193,78 @@ module KlaviyoAPI
|
|
1211
1193
|
|
1212
1194
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1213
1195
|
if @api_client.config.debugging
|
1214
|
-
@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}"
|
1215
1197
|
end
|
1216
1198
|
return data, status_code, headers
|
1217
1199
|
end
|
1218
1200
|
|
1219
|
-
#
|
1220
|
-
|
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]
|
1221
1208
|
# @param [Hash] opts the optional parameters
|
1222
|
-
# @
|
1223
|
-
|
1224
|
-
|
1225
|
-
|
1226
|
-
# @return [Hash<String, Object>]
|
1227
|
-
def get_tag_groups(opts = {})
|
1228
|
-
data, _status_code, _headers = get_tag_groups_with_http_info(opts)
|
1229
|
-
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
|
1230
1213
|
end
|
1231
1214
|
|
1232
|
-
#
|
1233
|
-
|
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]
|
1234
1222
|
# @param [Hash] opts the optional parameters
|
1235
|
-
# @
|
1236
|
-
|
1237
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1238
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1239
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1240
|
-
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 = {})
|
1241
1225
|
if @api_client.config.debugging
|
1242
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1226
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_campaigns ...'
|
1243
1227
|
end
|
1244
|
-
|
1245
|
-
if @api_client.config.client_side_validation &&
|
1246
|
-
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"
|
1247
1231
|
end
|
1248
|
-
|
1249
|
-
if @api_client.config.client_side_validation &&
|
1250
|
-
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"
|
1251
1235
|
end
|
1252
1236
|
# resource path
|
1253
|
-
local_var_path = '/api/
|
1237
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1254
1238
|
|
1255
1239
|
# query parameters
|
1256
1240
|
query_params = opts[:query_params] || {}
|
1257
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1258
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1259
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1260
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1261
1241
|
|
1262
1242
|
# header parameters
|
1263
1243
|
header_params = opts[:header_params] || {}
|
1264
1244
|
# klaviyo api revision
|
1265
|
-
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"
|
1266
1246
|
# HTTP header 'Accept' (if needed)
|
1267
|
-
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
|
1268
1253
|
|
1269
1254
|
# form parameters
|
1270
1255
|
form_params = opts[:form_params] || {}
|
1271
1256
|
|
1272
1257
|
# http body (model)
|
1273
|
-
post_body = opts[:debug_body]
|
1258
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_campaign_op)
|
1274
1259
|
|
1275
1260
|
# return_type
|
1276
|
-
return_type = opts[:debug_return_type]
|
1261
|
+
return_type = opts[:debug_return_type]
|
1277
1262
|
|
1278
1263
|
# auth_names
|
1279
1264
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1280
1265
|
|
1281
1266
|
new_options = opts.merge(
|
1282
|
-
:operation => :"TagsApi.
|
1267
|
+
:operation => :"TagsApi.remove_tag_from_campaigns",
|
1283
1268
|
:header_params => header_params,
|
1284
1269
|
:query_params => query_params,
|
1285
1270
|
:form_params => form_params,
|
@@ -1288,38 +1273,50 @@ module KlaviyoAPI
|
|
1288
1273
|
:return_type => return_type
|
1289
1274
|
)
|
1290
1275
|
|
1291
|
-
data, status_code, headers = @api_client.call_api(:
|
1276
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1292
1277
|
if @api_client.config.debugging
|
1293
|
-
@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}"
|
1294
1279
|
end
|
1295
1280
|
return data, status_code, headers
|
1296
1281
|
end
|
1297
1282
|
|
1298
|
-
#
|
1299
|
-
|
1300
|
-
|
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]
|
1301
1290
|
# @param [Hash] opts the optional parameters
|
1302
|
-
# @return [
|
1303
|
-
def
|
1304
|
-
|
1305
|
-
|
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
|
1306
1295
|
end
|
1307
1296
|
|
1308
|
-
#
|
1309
|
-
|
1310
|
-
|
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]
|
1311
1304
|
# @param [Hash] opts the optional parameters
|
1312
|
-
# @return [Array<(
|
1313
|
-
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 = {})
|
1314
1307
|
if @api_client.config.debugging
|
1315
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1308
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_flows ...'
|
1316
1309
|
end
|
1317
1310
|
# verify the required parameter 'id' is set
|
1318
1311
|
if @api_client.config.client_side_validation && id.nil?
|
1319
|
-
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"
|
1320
1317
|
end
|
1321
1318
|
# resource path
|
1322
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1319
|
+
local_var_path = '/api/tags/{id}/relationships/flows'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1323
1320
|
|
1324
1321
|
# query parameters
|
1325
1322
|
query_params = opts[:query_params] || {}
|
@@ -1327,24 +1324,29 @@ module KlaviyoAPI
|
|
1327
1324
|
# header parameters
|
1328
1325
|
header_params = opts[:header_params] || {}
|
1329
1326
|
# klaviyo api revision
|
1330
|
-
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"
|
1331
1328
|
# HTTP header 'Accept' (if needed)
|
1332
|
-
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
|
1333
1335
|
|
1334
1336
|
# form parameters
|
1335
1337
|
form_params = opts[:form_params] || {}
|
1336
1338
|
|
1337
1339
|
# http body (model)
|
1338
|
-
post_body = opts[:debug_body]
|
1340
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_flow_op)
|
1339
1341
|
|
1340
1342
|
# return_type
|
1341
|
-
return_type = opts[:debug_return_type]
|
1343
|
+
return_type = opts[:debug_return_type]
|
1342
1344
|
|
1343
1345
|
# auth_names
|
1344
1346
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1345
1347
|
|
1346
1348
|
new_options = opts.merge(
|
1347
|
-
:operation => :"TagsApi.
|
1349
|
+
:operation => :"TagsApi.remove_tag_from_flows",
|
1348
1350
|
:header_params => header_params,
|
1349
1351
|
:query_params => query_params,
|
1350
1352
|
:form_params => form_params,
|
@@ -1353,38 +1355,50 @@ module KlaviyoAPI
|
|
1353
1355
|
:return_type => return_type
|
1354
1356
|
)
|
1355
1357
|
|
1356
|
-
data, status_code, headers = @api_client.call_api(:
|
1358
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1357
1359
|
if @api_client.config.debugging
|
1358
|
-
@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}"
|
1359
1361
|
end
|
1360
1362
|
return data, status_code, headers
|
1361
1363
|
end
|
1362
1364
|
|
1363
|
-
#
|
1364
|
-
|
1365
|
-
|
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]
|
1366
1372
|
# @param [Hash] opts the optional parameters
|
1367
|
-
# @return [
|
1368
|
-
def
|
1369
|
-
|
1370
|
-
|
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
|
1371
1377
|
end
|
1372
1378
|
|
1373
|
-
#
|
1374
|
-
|
1375
|
-
|
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]
|
1376
1386
|
# @param [Hash] opts the optional parameters
|
1377
|
-
# @return [Array<(
|
1378
|
-
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 = {})
|
1379
1389
|
if @api_client.config.debugging
|
1380
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1390
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_lists ...'
|
1381
1391
|
end
|
1382
1392
|
# verify the required parameter 'id' is set
|
1383
1393
|
if @api_client.config.client_side_validation && id.nil?
|
1384
|
-
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"
|
1385
1399
|
end
|
1386
1400
|
# resource path
|
1387
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1401
|
+
local_var_path = '/api/tags/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1388
1402
|
|
1389
1403
|
# query parameters
|
1390
1404
|
query_params = opts[:query_params] || {}
|
@@ -1392,24 +1406,29 @@ module KlaviyoAPI
|
|
1392
1406
|
# header parameters
|
1393
1407
|
header_params = opts[:header_params] || {}
|
1394
1408
|
# klaviyo api revision
|
1395
|
-
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"
|
1396
1410
|
# HTTP header 'Accept' (if needed)
|
1397
|
-
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
|
1398
1417
|
|
1399
1418
|
# form parameters
|
1400
1419
|
form_params = opts[:form_params] || {}
|
1401
1420
|
|
1402
1421
|
# http body (model)
|
1403
|
-
post_body = opts[:debug_body]
|
1422
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_list_op)
|
1404
1423
|
|
1405
1424
|
# return_type
|
1406
|
-
return_type = opts[:debug_return_type]
|
1425
|
+
return_type = opts[:debug_return_type]
|
1407
1426
|
|
1408
1427
|
# auth_names
|
1409
1428
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1410
1429
|
|
1411
1430
|
new_options = opts.merge(
|
1412
|
-
:operation => :"TagsApi.
|
1431
|
+
:operation => :"TagsApi.remove_tag_from_lists",
|
1413
1432
|
:header_params => header_params,
|
1414
1433
|
:query_params => query_params,
|
1415
1434
|
:form_params => form_params,
|
@@ -1418,38 +1437,50 @@ module KlaviyoAPI
|
|
1418
1437
|
:return_type => return_type
|
1419
1438
|
)
|
1420
1439
|
|
1421
|
-
data, status_code, headers = @api_client.call_api(:
|
1440
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1422
1441
|
if @api_client.config.debugging
|
1423
|
-
@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}"
|
1424
1443
|
end
|
1425
1444
|
return data, status_code, headers
|
1426
1445
|
end
|
1427
1446
|
|
1428
|
-
#
|
1429
|
-
|
1430
|
-
|
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]
|
1431
1454
|
# @param [Hash] opts the optional parameters
|
1432
|
-
# @return [
|
1433
|
-
def
|
1434
|
-
|
1435
|
-
|
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
|
1436
1459
|
end
|
1437
1460
|
|
1438
|
-
#
|
1439
|
-
|
1440
|
-
|
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]
|
1441
1468
|
# @param [Hash] opts the optional parameters
|
1442
|
-
# @return [Array<(
|
1443
|
-
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 = {})
|
1444
1471
|
if @api_client.config.debugging
|
1445
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1472
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.remove_tag_from_segments ...'
|
1446
1473
|
end
|
1447
1474
|
# verify the required parameter 'id' is set
|
1448
1475
|
if @api_client.config.client_side_validation && id.nil?
|
1449
|
-
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"
|
1450
1481
|
end
|
1451
1482
|
# resource path
|
1452
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1483
|
+
local_var_path = '/api/tags/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1453
1484
|
|
1454
1485
|
# query parameters
|
1455
1486
|
query_params = opts[:query_params] || {}
|
@@ -1457,24 +1488,29 @@ module KlaviyoAPI
|
|
1457
1488
|
# header parameters
|
1458
1489
|
header_params = opts[:header_params] || {}
|
1459
1490
|
# klaviyo api revision
|
1460
|
-
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"
|
1461
1492
|
# HTTP header 'Accept' (if needed)
|
1462
|
-
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
|
1463
1499
|
|
1464
1500
|
# form parameters
|
1465
1501
|
form_params = opts[:form_params] || {}
|
1466
1502
|
|
1467
1503
|
# http body (model)
|
1468
|
-
post_body = opts[:debug_body]
|
1504
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_segment_op)
|
1469
1505
|
|
1470
1506
|
# return_type
|
1471
|
-
return_type = opts[:debug_return_type]
|
1507
|
+
return_type = opts[:debug_return_type]
|
1472
1508
|
|
1473
1509
|
# auth_names
|
1474
1510
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1475
1511
|
|
1476
1512
|
new_options = opts.merge(
|
1477
|
-
:operation => :"TagsApi.
|
1513
|
+
:operation => :"TagsApi.remove_tag_from_segments",
|
1478
1514
|
:header_params => header_params,
|
1479
1515
|
:query_params => query_params,
|
1480
1516
|
:form_params => form_params,
|
@@ -1483,38 +1519,53 @@ module KlaviyoAPI
|
|
1483
1519
|
:return_type => return_type
|
1484
1520
|
)
|
1485
1521
|
|
1486
|
-
data, status_code, headers = @api_client.call_api(:
|
1522
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1487
1523
|
if @api_client.config.debugging
|
1488
|
-
@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}"
|
1489
1525
|
end
|
1490
1526
|
return data, status_code, headers
|
1491
1527
|
end
|
1492
1528
|
|
1493
|
-
#
|
1494
|
-
|
1495
|
-
|
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]
|
1496
1536
|
# @param [Hash] opts the optional parameters
|
1497
|
-
# @return [
|
1498
|
-
def
|
1499
|
-
|
1500
|
-
|
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
|
1501
1541
|
end
|
1502
1542
|
|
1503
|
-
#
|
1504
|
-
|
1505
|
-
|
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]
|
1506
1553
|
# @param [Hash] opts the optional parameters
|
1507
|
-
# @return [Array<(
|
1508
|
-
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 = {})
|
1509
1556
|
if @api_client.config.debugging
|
1510
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1557
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.tag_campaigns ...'
|
1511
1558
|
end
|
1512
1559
|
# verify the required parameter 'id' is set
|
1513
1560
|
if @api_client.config.client_side_validation && id.nil?
|
1514
|
-
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"
|
1515
1566
|
end
|
1516
1567
|
# resource path
|
1517
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1568
|
+
local_var_path = '/api/tags/{id}/relationships/campaigns'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1518
1569
|
|
1519
1570
|
# query parameters
|
1520
1571
|
query_params = opts[:query_params] || {}
|
@@ -1522,24 +1573,29 @@ module KlaviyoAPI
|
|
1522
1573
|
# header parameters
|
1523
1574
|
header_params = opts[:header_params] || {}
|
1524
1575
|
# klaviyo api revision
|
1525
|
-
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"
|
1526
1577
|
# HTTP header 'Accept' (if needed)
|
1527
|
-
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
|
1528
1584
|
|
1529
1585
|
# form parameters
|
1530
1586
|
form_params = opts[:form_params] || {}
|
1531
1587
|
|
1532
1588
|
# http body (model)
|
1533
|
-
post_body = opts[:debug_body]
|
1589
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_campaign_op)
|
1534
1590
|
|
1535
1591
|
# return_type
|
1536
|
-
return_type = opts[:debug_return_type]
|
1592
|
+
return_type = opts[:debug_return_type]
|
1537
1593
|
|
1538
1594
|
# auth_names
|
1539
1595
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1540
1596
|
|
1541
1597
|
new_options = opts.merge(
|
1542
|
-
:operation => :"TagsApi.
|
1598
|
+
:operation => :"TagsApi.tag_campaigns",
|
1543
1599
|
:header_params => header_params,
|
1544
1600
|
:query_params => query_params,
|
1545
1601
|
:form_params => form_params,
|
@@ -1548,38 +1604,56 @@ module KlaviyoAPI
|
|
1548
1604
|
:return_type => return_type
|
1549
1605
|
)
|
1550
1606
|
|
1551
|
-
data, status_code, headers = @api_client.call_api(:
|
1607
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1552
1608
|
if @api_client.config.debugging
|
1553
|
-
@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}"
|
1554
1610
|
end
|
1555
1611
|
return data, status_code, headers
|
1556
1612
|
end
|
1557
1613
|
|
1558
|
-
#
|
1559
|
-
|
1560
|
-
|
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]
|
1561
1624
|
# @param [Hash] opts the optional parameters
|
1562
|
-
# @return [
|
1563
|
-
def
|
1564
|
-
|
1565
|
-
|
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
|
1566
1629
|
end
|
1567
1630
|
|
1568
|
-
#
|
1569
|
-
|
1570
|
-
|
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]
|
1571
1641
|
# @param [Hash] opts the optional parameters
|
1572
|
-
# @return [Array<(
|
1573
|
-
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 = {})
|
1574
1644
|
if @api_client.config.debugging
|
1575
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1645
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.tag_flows ...'
|
1576
1646
|
end
|
1577
1647
|
# verify the required parameter 'id' is set
|
1578
1648
|
if @api_client.config.client_side_validation && id.nil?
|
1579
|
-
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"
|
1580
1654
|
end
|
1581
1655
|
# resource path
|
1582
|
-
local_var_path = '/api/tags/{id}/relationships/
|
1656
|
+
local_var_path = '/api/tags/{id}/relationships/flows'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1583
1657
|
|
1584
1658
|
# query parameters
|
1585
1659
|
query_params = opts[:query_params] || {}
|
@@ -1587,24 +1661,29 @@ module KlaviyoAPI
|
|
1587
1661
|
# header parameters
|
1588
1662
|
header_params = opts[:header_params] || {}
|
1589
1663
|
# klaviyo api revision
|
1590
|
-
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"
|
1591
1665
|
# HTTP header 'Accept' (if needed)
|
1592
|
-
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
|
1593
1672
|
|
1594
1673
|
# form parameters
|
1595
1674
|
form_params = opts[:form_params] || {}
|
1596
1675
|
|
1597
1676
|
# http body (model)
|
1598
|
-
post_body = opts[:debug_body]
|
1677
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_flow_op)
|
1599
1678
|
|
1600
1679
|
# return_type
|
1601
|
-
return_type = opts[:debug_return_type]
|
1680
|
+
return_type = opts[:debug_return_type]
|
1602
1681
|
|
1603
1682
|
# auth_names
|
1604
1683
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1605
1684
|
|
1606
1685
|
new_options = opts.merge(
|
1607
|
-
:operation => :"TagsApi.
|
1686
|
+
:operation => :"TagsApi.tag_flows",
|
1608
1687
|
:header_params => header_params,
|
1609
1688
|
:query_params => query_params,
|
1610
1689
|
:form_params => form_params,
|
@@ -1613,70 +1692,86 @@ module KlaviyoAPI
|
|
1613
1692
|
:return_type => return_type
|
1614
1693
|
)
|
1615
1694
|
|
1616
|
-
data, status_code, headers = @api_client.call_api(:
|
1695
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1617
1696
|
if @api_client.config.debugging
|
1618
|
-
@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}"
|
1619
1698
|
end
|
1620
1699
|
return data, status_code, headers
|
1621
1700
|
end
|
1622
1701
|
|
1623
|
-
#
|
1624
|
-
|
1625
|
-
|
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]
|
1626
1712
|
# @param [Hash] opts the optional parameters
|
1627
|
-
# @
|
1628
|
-
|
1629
|
-
|
1630
|
-
|
1631
|
-
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
|
1632
1717
|
end
|
1633
1718
|
|
1634
|
-
#
|
1635
|
-
|
1636
|
-
|
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]
|
1637
1729
|
# @param [Hash] opts the optional parameters
|
1638
|
-
# @
|
1639
|
-
|
1640
|
-
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 = {})
|
1641
1732
|
if @api_client.config.debugging
|
1642
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1733
|
+
@api_client.config.logger.debug 'Calling API: TagsApi.tag_lists ...'
|
1643
1734
|
end
|
1644
1735
|
# verify the required parameter 'id' is set
|
1645
1736
|
if @api_client.config.client_side_validation && id.nil?
|
1646
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.
|
1737
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TagsApi.tag_lists"
|
1647
1738
|
end
|
1648
|
-
|
1649
|
-
if @api_client.config.client_side_validation &&
|
1650
|
-
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"
|
1651
1742
|
end
|
1652
1743
|
# resource path
|
1653
|
-
local_var_path = '/api/tags/{id}/
|
1744
|
+
local_var_path = '/api/tags/{id}/relationships/lists'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1654
1745
|
|
1655
1746
|
# query parameters
|
1656
1747
|
query_params = opts[:query_params] || {}
|
1657
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1658
1748
|
|
1659
1749
|
# header parameters
|
1660
1750
|
header_params = opts[:header_params] || {}
|
1661
1751
|
# klaviyo api revision
|
1662
|
-
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"
|
1663
1753
|
# HTTP header 'Accept' (if needed)
|
1664
|
-
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
|
1665
1760
|
|
1666
1761
|
# form parameters
|
1667
1762
|
form_params = opts[:form_params] || {}
|
1668
1763
|
|
1669
1764
|
# http body (model)
|
1670
|
-
post_body = opts[:debug_body]
|
1765
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_list_op)
|
1671
1766
|
|
1672
1767
|
# return_type
|
1673
|
-
return_type = opts[:debug_return_type]
|
1768
|
+
return_type = opts[:debug_return_type]
|
1674
1769
|
|
1675
1770
|
# auth_names
|
1676
1771
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1677
1772
|
|
1678
1773
|
new_options = opts.merge(
|
1679
|
-
:operation => :"TagsApi.
|
1774
|
+
:operation => :"TagsApi.tag_lists",
|
1680
1775
|
:header_params => header_params,
|
1681
1776
|
:query_params => query_params,
|
1682
1777
|
:form_params => form_params,
|
@@ -1685,91 +1780,86 @@ module KlaviyoAPI
|
|
1685
1780
|
:return_type => return_type
|
1686
1781
|
)
|
1687
1782
|
|
1688
|
-
data, status_code, headers = @api_client.call_api(:
|
1783
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1689
1784
|
if @api_client.config.debugging
|
1690
|
-
@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}"
|
1691
1786
|
end
|
1692
1787
|
return data, status_code, headers
|
1693
1788
|
end
|
1694
1789
|
|
1695
|
-
#
|
1696
|
-
|
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]
|
1697
1800
|
# @param [Hash] opts the optional parameters
|
1698
|
-
# @
|
1699
|
-
|
1700
|
-
|
1701
|
-
|
1702
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1703
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1704
|
-
# @return [Hash<String, Object>]
|
1705
|
-
def get_tags(opts = {})
|
1706
|
-
data, _status_code, _headers = get_tags_with_http_info(opts)
|
1707
|
-
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
|
1708
1805
|
end
|
1709
1806
|
|
1710
|
-
#
|
1711
|
-
|
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]
|
1712
1817
|
# @param [Hash] opts the optional parameters
|
1713
|
-
# @
|
1714
|
-
|
1715
|
-
# @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`
|
1716
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
|
1717
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
|
1718
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
|
1719
|
-
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1720
|
-
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 = {})
|
1721
1820
|
if @api_client.config.debugging
|
1722
|
-
@api_client.config.logger.debug 'Calling API: TagsApi.
|
1723
|
-
end
|
1724
|
-
allowable_values = ["name", "exclusive", "default"]
|
1725
|
-
if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) }
|
1726
|
-
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 ...'
|
1727
1822
|
end
|
1728
|
-
|
1729
|
-
if @api_client.config.client_side_validation &&
|
1730
|
-
fail ArgumentError, "
|
1731
|
-
end
|
1732
|
-
allowable_values = ["tag-group"]
|
1733
|
-
if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
|
1734
|
-
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"
|
1735
1826
|
end
|
1736
|
-
|
1737
|
-
if @api_client.config.client_side_validation &&
|
1738
|
-
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"
|
1739
1830
|
end
|
1740
1831
|
# resource path
|
1741
|
-
local_var_path = '/api/tags/'
|
1832
|
+
local_var_path = '/api/tags/{id}/relationships/segments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1742
1833
|
|
1743
1834
|
# query parameters
|
1744
1835
|
query_params = opts[:query_params] || {}
|
1745
|
-
query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil?
|
1746
|
-
query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
|
1747
|
-
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
1748
|
-
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
1749
|
-
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
1750
|
-
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1751
1836
|
|
1752
1837
|
# header parameters
|
1753
1838
|
header_params = opts[:header_params] || {}
|
1754
1839
|
# klaviyo api revision
|
1755
|
-
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"
|
1756
1841
|
# HTTP header 'Accept' (if needed)
|
1757
|
-
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
|
1758
1848
|
|
1759
1849
|
# form parameters
|
1760
1850
|
form_params = opts[:form_params] || {}
|
1761
1851
|
|
1762
1852
|
# http body (model)
|
1763
|
-
post_body = opts[:debug_body]
|
1853
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_segment_op)
|
1764
1854
|
|
1765
1855
|
# return_type
|
1766
|
-
return_type = opts[:debug_return_type]
|
1856
|
+
return_type = opts[:debug_return_type]
|
1767
1857
|
|
1768
1858
|
# auth_names
|
1769
1859
|
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
|
1770
1860
|
|
1771
1861
|
new_options = opts.merge(
|
1772
|
-
:operation => :"TagsApi.
|
1862
|
+
:operation => :"TagsApi.tag_segments",
|
1773
1863
|
:header_params => header_params,
|
1774
1864
|
:query_params => query_params,
|
1775
1865
|
:form_params => form_params,
|
@@ -1778,13 +1868,19 @@ module KlaviyoAPI
|
|
1778
1868
|
:return_type => return_type
|
1779
1869
|
)
|
1780
1870
|
|
1781
|
-
data, status_code, headers = @api_client.call_api(:
|
1871
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1782
1872
|
if @api_client.config.debugging
|
1783
|
-
@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}"
|
1784
1874
|
end
|
1785
1875
|
return data, status_code, headers
|
1786
1876
|
end
|
1787
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
|
+
|
1788
1884
|
# Update Tag
|
1789
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`
|
1790
1886
|
# @param id [String] The Tag ID
|
@@ -1815,7 +1911,7 @@ module KlaviyoAPI
|
|
1815
1911
|
fail ArgumentError, "Missing the required parameter 'tag_update_query' when calling TagsApi.update_tag"
|
1816
1912
|
end
|
1817
1913
|
# resource path
|
1818
|
-
local_var_path = '/api/tags/{id}
|
1914
|
+
local_var_path = '/api/tags/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1819
1915
|
|
1820
1916
|
# query parameters
|
1821
1917
|
query_params = opts[:query_params] || {}
|
@@ -1823,11 +1919,11 @@ module KlaviyoAPI
|
|
1823
1919
|
# header parameters
|
1824
1920
|
header_params = opts[:header_params] || {}
|
1825
1921
|
# klaviyo api revision
|
1826
|
-
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"
|
1827
1923
|
# HTTP header 'Accept' (if needed)
|
1828
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1924
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1829
1925
|
# HTTP header 'Content-Type'
|
1830
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1926
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1831
1927
|
if !content_type.nil?
|
1832
1928
|
header_params['Content-Type'] = content_type
|
1833
1929
|
end
|
@@ -1891,7 +1987,7 @@ module KlaviyoAPI
|
|
1891
1987
|
fail ArgumentError, "Missing the required parameter 'tag_group_update_query' when calling TagsApi.update_tag_group"
|
1892
1988
|
end
|
1893
1989
|
# resource path
|
1894
|
-
local_var_path = '/api/tag-groups/{id}
|
1990
|
+
local_var_path = '/api/tag-groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1895
1991
|
|
1896
1992
|
# query parameters
|
1897
1993
|
query_params = opts[:query_params] || {}
|
@@ -1899,11 +1995,11 @@ module KlaviyoAPI
|
|
1899
1995
|
# header parameters
|
1900
1996
|
header_params = opts[:header_params] || {}
|
1901
1997
|
# klaviyo api revision
|
1902
|
-
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"
|
1903
1999
|
# HTTP header 'Accept' (if needed)
|
1904
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2000
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1905
2001
|
# HTTP header 'Content-Type'
|
1906
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
2002
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
1907
2003
|
if !content_type.nil?
|
1908
2004
|
header_params['Content-Type'] = content_type
|
1909
2005
|
end
|