klaviyo-api-sdk 9.0.0 → 10.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +29 -0
- data/README.md +1265 -519
- 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 +1025 -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 +248 -0
- data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
- data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
- data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
- data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
- data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
- data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
- data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
- data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
- data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +2 -7
- data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
- data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
- data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
- data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
- data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
- data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
- data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
- data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
- data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
- data/lib/klaviyo-api-sdk/version.rb +1 -1
- data/lib/klaviyo-api-sdk.rb +58 -3
- metadata +59 -4
data/README.md
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version:
|
4
|
-
- API revision: 2024-
|
3
|
+
- SDK version: 10.0.0
|
4
|
+
- API revision: 2024-10-15
|
5
5
|
|
6
6
|
## Helpful Resources
|
7
7
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/v2024-
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/v2024-
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2024-10-15/reference)
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2024-10-15/docs)
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
11
11
|
|
12
12
|
## Design & Approach
|
@@ -71,6 +71,10 @@ This SDK is organized into the following resources:
|
|
71
71
|
|
72
72
|
|
73
73
|
|
74
|
+
- Reviews
|
75
|
+
|
76
|
+
|
77
|
+
|
74
78
|
- Segments
|
75
79
|
|
76
80
|
|
@@ -83,6 +87,10 @@ This SDK is organized into the following resources:
|
|
83
87
|
|
84
88
|
|
85
89
|
|
90
|
+
- Tracking Settings
|
91
|
+
|
92
|
+
|
93
|
+
|
86
94
|
- Webhooks
|
87
95
|
|
88
96
|
|
@@ -102,13 +110,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
102
110
|
Then install the gem locally:
|
103
111
|
|
104
112
|
```shell
|
105
|
-
gem install ./klaviyo-api-sdk-
|
113
|
+
gem install ./klaviyo-api-sdk-10.0.0.gem
|
106
114
|
```
|
107
115
|
|
108
116
|
|
109
117
|
Finally add this to the Gemfile:
|
110
118
|
|
111
|
-
gem 'klaviyo-api-sdk', '~>
|
119
|
+
gem 'klaviyo-api-sdk', '~> 10.0.0'
|
112
120
|
|
113
121
|
To install directly from rubygems:
|
114
122
|
|
@@ -488,7 +496,7 @@ response = KlaviyoAPI::Events.get_events(opts)
|
|
488
496
|
## Comprehensive list of Operations & Parameters
|
489
497
|
|
490
498
|
_**NOTE:**_
|
491
|
-
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2024-
|
499
|
+
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2024-10-15/reference/get_events).
|
492
500
|
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
493
501
|
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
494
502
|
|
@@ -500,7 +508,7 @@ _**NOTE:**_
|
|
500
508
|
## Accounts
|
501
509
|
|
502
510
|
|
503
|
-
#### [Get Account](https://developers.klaviyo.com/en/v2024-
|
511
|
+
#### [Get Account](https://developers.klaviyo.com/en/v2024-10-15/reference/get_account)
|
504
512
|
|
505
513
|
```ruby
|
506
514
|
KlaviyoAPI::Accounts.get_account(id, opts)
|
@@ -510,7 +518,7 @@ KlaviyoAPI::Accounts.get_account(id, opts)
|
|
510
518
|
|
511
519
|
|
512
520
|
|
513
|
-
#### [Get Accounts](https://developers.klaviyo.com/en/v2024-
|
521
|
+
#### [Get Accounts](https://developers.klaviyo.com/en/v2024-10-15/reference/get_accounts)
|
514
522
|
|
515
523
|
```ruby
|
516
524
|
KlaviyoAPI::Accounts.get_accounts(opts)
|
@@ -524,87 +532,107 @@ KlaviyoAPI::Accounts.get_accounts(opts)
|
|
524
532
|
## Campaigns
|
525
533
|
|
526
534
|
|
527
|
-
#### [
|
535
|
+
#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2024-10-15/reference/assign_template_to_campaign_message)
|
528
536
|
|
529
537
|
```ruby
|
530
|
-
KlaviyoAPI::Campaigns.
|
538
|
+
KlaviyoAPI::Campaigns.assign_template_to_campaign_message(body)
|
539
|
+
```
|
540
|
+
##### Method alias:
|
541
|
+
```ruby
|
542
|
+
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
531
543
|
```
|
532
544
|
|
533
545
|
|
534
546
|
|
535
547
|
|
536
548
|
|
537
|
-
#### [
|
549
|
+
#### [Cancel Campaign Send](https://developers.klaviyo.com/en/v2024-10-15/reference/cancel_campaign_send)
|
538
550
|
|
539
551
|
```ruby
|
540
|
-
KlaviyoAPI::Campaigns.
|
552
|
+
KlaviyoAPI::Campaigns.cancel_campaign_send(id, body)
|
553
|
+
```
|
554
|
+
##### Method alias:
|
555
|
+
```ruby
|
556
|
+
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
541
557
|
```
|
542
558
|
|
543
559
|
|
544
560
|
|
545
561
|
|
546
562
|
|
547
|
-
#### [
|
563
|
+
#### [Create Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/create_campaign)
|
548
564
|
|
549
565
|
```ruby
|
550
|
-
KlaviyoAPI::Campaigns.
|
566
|
+
KlaviyoAPI::Campaigns.create_campaign(body)
|
551
567
|
```
|
552
568
|
|
553
569
|
|
554
570
|
|
555
571
|
|
556
572
|
|
557
|
-
#### [Create Campaign
|
573
|
+
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2024-10-15/reference/create_campaign_clone)
|
558
574
|
|
559
575
|
```ruby
|
560
|
-
KlaviyoAPI::Campaigns.
|
576
|
+
KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
577
|
+
```
|
578
|
+
##### Method alias:
|
579
|
+
```ruby
|
580
|
+
KlaviyoAPI::Campaigns.clone_campaign(body)
|
561
581
|
```
|
562
582
|
|
563
583
|
|
564
584
|
|
565
585
|
|
566
586
|
|
567
|
-
#### [
|
587
|
+
#### [Delete Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_campaign)
|
568
588
|
|
569
589
|
```ruby
|
570
|
-
KlaviyoAPI::Campaigns.
|
590
|
+
KlaviyoAPI::Campaigns.delete_campaign(id)
|
571
591
|
```
|
572
592
|
|
573
593
|
|
574
594
|
|
575
595
|
|
576
596
|
|
577
|
-
#### [
|
597
|
+
#### [Get Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign)
|
578
598
|
|
579
599
|
```ruby
|
580
|
-
KlaviyoAPI::Campaigns.
|
600
|
+
KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
581
601
|
```
|
582
602
|
|
583
603
|
|
584
604
|
|
585
605
|
|
586
606
|
|
587
|
-
#### [Get Campaign](https://developers.klaviyo.com/en/v2024-
|
607
|
+
#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_for_campaign_message)
|
588
608
|
|
589
609
|
```ruby
|
590
|
-
KlaviyoAPI::Campaigns.
|
610
|
+
KlaviyoAPI::Campaigns.get_campaign_for_campaign_message(id, opts)
|
611
|
+
```
|
612
|
+
##### Method alias:
|
613
|
+
```ruby
|
614
|
+
KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
|
591
615
|
```
|
592
616
|
|
593
617
|
|
594
618
|
|
595
619
|
|
596
620
|
|
597
|
-
#### [Get Campaign Campaign
|
621
|
+
#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_id_for_campaign_message)
|
598
622
|
|
599
623
|
```ruby
|
600
|
-
KlaviyoAPI::Campaigns.
|
624
|
+
KlaviyoAPI::Campaigns.get_campaign_id_for_campaign_message(id)
|
625
|
+
```
|
626
|
+
##### Method alias:
|
627
|
+
```ruby
|
628
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
|
601
629
|
```
|
602
630
|
|
603
631
|
|
604
632
|
|
605
633
|
|
606
634
|
|
607
|
-
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2024-
|
635
|
+
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_message)
|
608
636
|
|
609
637
|
```ruby
|
610
638
|
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
@@ -614,78 +642,90 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
614
642
|
|
615
643
|
|
616
644
|
|
617
|
-
#### [Get Campaign
|
645
|
+
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_recipient_estimation)
|
618
646
|
|
619
647
|
```ruby
|
620
|
-
KlaviyoAPI::Campaigns.
|
648
|
+
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
621
649
|
```
|
622
650
|
|
623
651
|
|
624
652
|
|
625
653
|
|
626
654
|
|
627
|
-
#### [Get Campaign
|
655
|
+
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_recipient_estimation_job)
|
628
656
|
|
629
657
|
```ruby
|
630
|
-
KlaviyoAPI::Campaigns.
|
658
|
+
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
631
659
|
```
|
632
660
|
|
633
661
|
|
634
662
|
|
635
663
|
|
636
664
|
|
637
|
-
#### [Get Campaign
|
665
|
+
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_send_job)
|
638
666
|
|
639
667
|
```ruby
|
640
|
-
KlaviyoAPI::Campaigns.
|
668
|
+
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
641
669
|
```
|
642
670
|
|
643
671
|
|
644
672
|
|
645
673
|
|
646
674
|
|
647
|
-
#### [Get Campaign
|
675
|
+
#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_tags)
|
648
676
|
|
649
677
|
```ruby
|
650
|
-
KlaviyoAPI::Campaigns.
|
678
|
+
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
651
679
|
```
|
652
680
|
|
653
681
|
|
654
682
|
|
655
683
|
|
656
684
|
|
657
|
-
#### [Get
|
685
|
+
#### [Get Campaigns](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaigns)
|
658
686
|
|
659
687
|
```ruby
|
660
|
-
KlaviyoAPI::Campaigns.
|
688
|
+
KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
|
661
689
|
```
|
662
690
|
|
663
691
|
|
664
692
|
|
665
693
|
|
666
694
|
|
667
|
-
#### [Get
|
695
|
+
#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/get_message_ids_for_campaign)
|
668
696
|
|
669
697
|
```ruby
|
670
|
-
KlaviyoAPI::Campaigns.
|
698
|
+
KlaviyoAPI::Campaigns.get_message_ids_for_campaign(id)
|
699
|
+
```
|
700
|
+
##### Method alias:
|
701
|
+
```ruby
|
702
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
|
671
703
|
```
|
672
704
|
|
673
705
|
|
674
706
|
|
675
707
|
|
676
708
|
|
677
|
-
#### [Get
|
709
|
+
#### [Get Messages for Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/get_messages_for_campaign)
|
678
710
|
|
679
711
|
```ruby
|
680
|
-
KlaviyoAPI::Campaigns.
|
712
|
+
KlaviyoAPI::Campaigns.get_messages_for_campaign(id, opts)
|
713
|
+
```
|
714
|
+
##### Method alias:
|
715
|
+
```ruby
|
716
|
+
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
|
681
717
|
```
|
682
718
|
|
683
719
|
|
684
720
|
|
685
721
|
|
686
722
|
|
687
|
-
#### [Get
|
723
|
+
#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_campaign)
|
688
724
|
|
725
|
+
```ruby
|
726
|
+
KlaviyoAPI::Campaigns.get_tag_ids_for_campaign(id)
|
727
|
+
```
|
728
|
+
##### Method alias:
|
689
729
|
```ruby
|
690
730
|
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
691
731
|
```
|
@@ -694,60 +734,76 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
|
694
734
|
|
695
735
|
|
696
736
|
|
697
|
-
#### [Get Campaign
|
737
|
+
#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template_for_campaign_message)
|
698
738
|
|
699
739
|
```ruby
|
700
|
-
KlaviyoAPI::Campaigns.
|
740
|
+
KlaviyoAPI::Campaigns.get_template_for_campaign_message(id, opts)
|
741
|
+
```
|
742
|
+
##### Method alias:
|
743
|
+
```ruby
|
744
|
+
KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
|
701
745
|
```
|
702
746
|
|
703
747
|
|
704
748
|
|
705
749
|
|
706
750
|
|
707
|
-
#### [Get Campaign
|
751
|
+
#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template_id_for_campaign_message)
|
708
752
|
|
709
753
|
```ruby
|
710
|
-
KlaviyoAPI::Campaigns.
|
754
|
+
KlaviyoAPI::Campaigns.get_template_id_for_campaign_message(id)
|
755
|
+
```
|
756
|
+
##### Method alias:
|
757
|
+
```ruby
|
758
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
|
711
759
|
```
|
712
760
|
|
713
761
|
|
714
762
|
|
715
763
|
|
716
764
|
|
717
|
-
#### [
|
765
|
+
#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2024-10-15/reference/refresh_campaign_recipient_estimation)
|
718
766
|
|
719
767
|
```ruby
|
720
|
-
KlaviyoAPI::Campaigns.
|
768
|
+
KlaviyoAPI::Campaigns.refresh_campaign_recipient_estimation(body)
|
769
|
+
```
|
770
|
+
##### Method alias:
|
771
|
+
```ruby
|
772
|
+
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
721
773
|
```
|
722
774
|
|
723
775
|
|
724
776
|
|
725
777
|
|
726
778
|
|
727
|
-
#### [
|
779
|
+
#### [Send Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/send_campaign)
|
728
780
|
|
729
781
|
```ruby
|
730
|
-
KlaviyoAPI::Campaigns.
|
782
|
+
KlaviyoAPI::Campaigns.send_campaign(body)
|
783
|
+
```
|
784
|
+
##### Method alias:
|
785
|
+
```ruby
|
786
|
+
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
731
787
|
```
|
732
788
|
|
733
789
|
|
734
790
|
|
735
791
|
|
736
792
|
|
737
|
-
#### [Update Campaign
|
793
|
+
#### [Update Campaign](https://developers.klaviyo.com/en/v2024-10-15/reference/update_campaign)
|
738
794
|
|
739
795
|
```ruby
|
740
|
-
KlaviyoAPI::Campaigns.
|
796
|
+
KlaviyoAPI::Campaigns.update_campaign(id, body)
|
741
797
|
```
|
742
798
|
|
743
799
|
|
744
800
|
|
745
801
|
|
746
802
|
|
747
|
-
#### [Update Campaign
|
803
|
+
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2024-10-15/reference/update_campaign_message)
|
748
804
|
|
749
805
|
```ruby
|
750
|
-
KlaviyoAPI::Campaigns.
|
806
|
+
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
751
807
|
```
|
752
808
|
|
753
809
|
|
@@ -758,28 +814,30 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
|
758
814
|
## Catalogs
|
759
815
|
|
760
816
|
|
761
|
-
#### [
|
817
|
+
#### [Add Category to Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/add_category_to_catalog_item)
|
762
818
|
|
763
819
|
```ruby
|
764
|
-
KlaviyoAPI::Catalogs.
|
820
|
+
KlaviyoAPI::Catalogs.add_category_to_catalog_item(id, body)
|
765
821
|
```
|
766
|
-
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_category)
|
772
|
-
|
822
|
+
##### Method alias:
|
773
823
|
```ruby
|
774
|
-
KlaviyoAPI::Catalogs.
|
824
|
+
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
825
|
+
```
|
826
|
+
##### Method alias:
|
827
|
+
```ruby
|
828
|
+
KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body)
|
775
829
|
```
|
776
830
|
|
777
831
|
|
778
832
|
|
779
833
|
|
780
834
|
|
781
|
-
#### [
|
835
|
+
#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/add_items_to_catalog_category)
|
782
836
|
|
837
|
+
```ruby
|
838
|
+
KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body)
|
839
|
+
```
|
840
|
+
##### Method alias:
|
783
841
|
```ruby
|
784
842
|
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
785
843
|
```
|
@@ -792,579 +850,673 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body)
|
|
792
850
|
|
793
851
|
|
794
852
|
|
795
|
-
#### [Create Catalog
|
853
|
+
#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_create_catalog_categories)
|
796
854
|
|
797
855
|
```ruby
|
798
|
-
KlaviyoAPI::Catalogs.
|
856
|
+
KlaviyoAPI::Catalogs.bulk_create_catalog_categories(body)
|
799
857
|
```
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_item_relationships_categories)
|
806
|
-
|
858
|
+
##### Method alias:
|
807
859
|
```ruby
|
808
|
-
KlaviyoAPI::Catalogs.
|
860
|
+
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
809
861
|
```
|
810
862
|
##### Method alias:
|
811
863
|
```ruby
|
812
|
-
KlaviyoAPI::Catalogs.
|
864
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body)
|
813
865
|
```
|
814
866
|
|
815
867
|
|
816
868
|
|
817
869
|
|
818
870
|
|
819
|
-
#### [Create Catalog
|
871
|
+
#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_create_catalog_items)
|
820
872
|
|
821
873
|
```ruby
|
822
|
-
KlaviyoAPI::Catalogs.
|
874
|
+
KlaviyoAPI::Catalogs.bulk_create_catalog_items(body)
|
823
875
|
```
|
824
|
-
|
825
|
-
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_catalog_category)
|
830
|
-
|
876
|
+
##### Method alias:
|
831
877
|
```ruby
|
832
|
-
KlaviyoAPI::Catalogs.
|
878
|
+
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
879
|
+
```
|
880
|
+
##### Method alias:
|
881
|
+
```ruby
|
882
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body)
|
833
883
|
```
|
834
884
|
|
835
885
|
|
836
886
|
|
837
887
|
|
838
888
|
|
839
|
-
#### [
|
889
|
+
#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_create_catalog_variants)
|
840
890
|
|
841
891
|
```ruby
|
842
|
-
KlaviyoAPI::Catalogs.
|
892
|
+
KlaviyoAPI::Catalogs.bulk_create_catalog_variants(body)
|
893
|
+
```
|
894
|
+
##### Method alias:
|
895
|
+
```ruby
|
896
|
+
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
897
|
+
```
|
898
|
+
##### Method alias:
|
899
|
+
```ruby
|
900
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body)
|
843
901
|
```
|
844
902
|
|
845
903
|
|
846
904
|
|
847
905
|
|
848
906
|
|
849
|
-
#### [Delete Catalog
|
907
|
+
#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_delete_catalog_categories)
|
850
908
|
|
851
909
|
```ruby
|
852
|
-
KlaviyoAPI::Catalogs.
|
910
|
+
KlaviyoAPI::Catalogs.bulk_delete_catalog_categories(body)
|
911
|
+
```
|
912
|
+
##### Method alias:
|
913
|
+
```ruby
|
914
|
+
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
915
|
+
```
|
916
|
+
##### Method alias:
|
917
|
+
```ruby
|
918
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body)
|
853
919
|
```
|
854
920
|
|
855
921
|
|
856
922
|
|
857
923
|
|
858
924
|
|
859
|
-
#### [Delete Catalog
|
925
|
+
#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_delete_catalog_items)
|
860
926
|
|
861
927
|
```ruby
|
862
|
-
KlaviyoAPI::Catalogs.
|
928
|
+
KlaviyoAPI::Catalogs.bulk_delete_catalog_items(body)
|
929
|
+
```
|
930
|
+
##### Method alias:
|
931
|
+
```ruby
|
932
|
+
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
933
|
+
```
|
934
|
+
##### Method alias:
|
935
|
+
```ruby
|
936
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body)
|
863
937
|
```
|
864
938
|
|
865
939
|
|
866
940
|
|
867
941
|
|
868
942
|
|
869
|
-
#### [Delete Catalog
|
943
|
+
#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_delete_catalog_variants)
|
870
944
|
|
871
945
|
```ruby
|
872
|
-
KlaviyoAPI::Catalogs.
|
946
|
+
KlaviyoAPI::Catalogs.bulk_delete_catalog_variants(body)
|
947
|
+
```
|
948
|
+
##### Method alias:
|
949
|
+
```ruby
|
950
|
+
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
951
|
+
```
|
952
|
+
##### Method alias:
|
953
|
+
```ruby
|
954
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body)
|
873
955
|
```
|
874
956
|
|
875
957
|
|
876
958
|
|
877
959
|
|
878
960
|
|
879
|
-
#### [
|
961
|
+
#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_update_catalog_categories)
|
880
962
|
|
881
963
|
```ruby
|
882
|
-
KlaviyoAPI::Catalogs.
|
964
|
+
KlaviyoAPI::Catalogs.bulk_update_catalog_categories(body)
|
965
|
+
```
|
966
|
+
##### Method alias:
|
967
|
+
```ruby
|
968
|
+
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
969
|
+
```
|
970
|
+
##### Method alias:
|
971
|
+
```ruby
|
972
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body)
|
883
973
|
```
|
884
974
|
|
885
975
|
|
886
976
|
|
887
977
|
|
888
978
|
|
889
|
-
#### [
|
979
|
+
#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_update_catalog_items)
|
890
980
|
|
891
981
|
```ruby
|
892
|
-
KlaviyoAPI::Catalogs.
|
982
|
+
KlaviyoAPI::Catalogs.bulk_update_catalog_items(body)
|
983
|
+
```
|
984
|
+
##### Method alias:
|
985
|
+
```ruby
|
986
|
+
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
987
|
+
```
|
988
|
+
##### Method alias:
|
989
|
+
```ruby
|
990
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body)
|
893
991
|
```
|
894
992
|
|
895
993
|
|
896
994
|
|
897
995
|
|
898
996
|
|
899
|
-
#### [
|
997
|
+
#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_update_catalog_variants)
|
900
998
|
|
901
999
|
```ruby
|
902
|
-
KlaviyoAPI::Catalogs.
|
1000
|
+
KlaviyoAPI::Catalogs.bulk_update_catalog_variants(body)
|
1001
|
+
```
|
1002
|
+
##### Method alias:
|
1003
|
+
```ruby
|
1004
|
+
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
1005
|
+
```
|
1006
|
+
##### Method alias:
|
1007
|
+
```ruby
|
1008
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body)
|
903
1009
|
```
|
904
1010
|
|
905
1011
|
|
906
1012
|
|
907
1013
|
|
908
1014
|
|
909
|
-
#### [
|
1015
|
+
#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2024-10-15/reference/create_back_in_stock_subscription)
|
910
1016
|
|
911
1017
|
```ruby
|
912
|
-
KlaviyoAPI::Catalogs.
|
1018
|
+
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
|
913
1019
|
```
|
914
1020
|
|
915
1021
|
|
916
1022
|
|
917
1023
|
|
918
1024
|
|
919
|
-
#### [
|
1025
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/create_catalog_category)
|
920
1026
|
|
921
1027
|
```ruby
|
922
|
-
KlaviyoAPI::Catalogs.
|
1028
|
+
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
923
1029
|
```
|
924
1030
|
|
925
1031
|
|
926
1032
|
|
927
1033
|
|
928
1034
|
|
929
|
-
#### [
|
1035
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/create_catalog_item)
|
930
1036
|
|
931
1037
|
```ruby
|
932
|
-
KlaviyoAPI::Catalogs.
|
1038
|
+
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
933
1039
|
```
|
934
1040
|
|
935
1041
|
|
936
1042
|
|
937
1043
|
|
938
1044
|
|
939
|
-
#### [
|
1045
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2024-10-15/reference/create_catalog_variant)
|
940
1046
|
|
941
1047
|
```ruby
|
942
|
-
KlaviyoAPI::Catalogs.
|
1048
|
+
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
943
1049
|
```
|
944
1050
|
|
945
1051
|
|
946
1052
|
|
947
1053
|
|
948
1054
|
|
949
|
-
#### [
|
1055
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_catalog_category)
|
950
1056
|
|
951
1057
|
```ruby
|
952
|
-
KlaviyoAPI::Catalogs.
|
1058
|
+
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
953
1059
|
```
|
954
1060
|
|
955
1061
|
|
956
1062
|
|
957
1063
|
|
958
1064
|
|
959
|
-
#### [
|
1065
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_catalog_item)
|
960
1066
|
|
961
1067
|
```ruby
|
962
|
-
KlaviyoAPI::Catalogs.
|
1068
|
+
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
963
1069
|
```
|
964
1070
|
|
965
1071
|
|
966
1072
|
|
967
1073
|
|
968
1074
|
|
969
|
-
#### [
|
1075
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_catalog_variant)
|
970
1076
|
|
971
1077
|
```ruby
|
972
|
-
KlaviyoAPI::Catalogs.
|
1078
|
+
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
973
1079
|
```
|
974
1080
|
|
975
1081
|
|
976
1082
|
|
977
1083
|
|
978
1084
|
|
979
|
-
#### [Get Catalog
|
1085
|
+
#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_create_catalog_items_job)
|
980
1086
|
|
981
1087
|
```ruby
|
982
|
-
KlaviyoAPI::Catalogs.
|
1088
|
+
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_job(job_id, opts)
|
1089
|
+
```
|
1090
|
+
##### Method alias:
|
1091
|
+
```ruby
|
1092
|
+
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
1093
|
+
```
|
1094
|
+
##### Method alias:
|
1095
|
+
```ruby
|
1096
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts)
|
983
1097
|
```
|
984
1098
|
|
985
1099
|
|
986
1100
|
|
987
1101
|
|
988
1102
|
|
989
|
-
#### [Get Create
|
1103
|
+
#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_create_catalog_items_jobs)
|
990
1104
|
|
991
1105
|
```ruby
|
992
|
-
KlaviyoAPI::Catalogs.
|
1106
|
+
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_jobs(opts)
|
993
1107
|
```
|
994
1108
|
##### Method alias:
|
995
1109
|
```ruby
|
996
|
-
KlaviyoAPI::Catalogs.
|
1110
|
+
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
1111
|
+
```
|
1112
|
+
##### Method alias:
|
1113
|
+
```ruby
|
1114
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts)
|
997
1115
|
```
|
998
1116
|
|
999
1117
|
|
1000
1118
|
|
1001
1119
|
|
1002
1120
|
|
1003
|
-
#### [Get
|
1121
|
+
#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_delete_catalog_items_job)
|
1004
1122
|
|
1005
1123
|
```ruby
|
1006
|
-
KlaviyoAPI::Catalogs.
|
1124
|
+
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_job(job_id, opts)
|
1007
1125
|
```
|
1008
1126
|
##### Method alias:
|
1009
1127
|
```ruby
|
1010
|
-
KlaviyoAPI::Catalogs.
|
1128
|
+
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
1129
|
+
```
|
1130
|
+
##### Method alias:
|
1131
|
+
```ruby
|
1132
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts)
|
1011
1133
|
```
|
1012
1134
|
|
1013
1135
|
|
1014
1136
|
|
1015
1137
|
|
1016
1138
|
|
1017
|
-
#### [Get
|
1139
|
+
#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_delete_catalog_items_jobs)
|
1018
1140
|
|
1019
1141
|
```ruby
|
1020
|
-
KlaviyoAPI::Catalogs.
|
1142
|
+
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_jobs(opts)
|
1021
1143
|
```
|
1022
1144
|
##### Method alias:
|
1023
1145
|
```ruby
|
1024
|
-
KlaviyoAPI::Catalogs.
|
1146
|
+
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
1147
|
+
```
|
1148
|
+
##### Method alias:
|
1149
|
+
```ruby
|
1150
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts)
|
1025
1151
|
```
|
1026
1152
|
|
1027
1153
|
|
1028
1154
|
|
1029
1155
|
|
1030
1156
|
|
1031
|
-
#### [Get
|
1157
|
+
#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_update_catalog_items_job)
|
1032
1158
|
|
1033
1159
|
```ruby
|
1034
|
-
KlaviyoAPI::Catalogs.
|
1160
|
+
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_job(job_id, opts)
|
1035
1161
|
```
|
1036
1162
|
##### Method alias:
|
1037
1163
|
```ruby
|
1038
|
-
KlaviyoAPI::Catalogs.
|
1164
|
+
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
1165
|
+
```
|
1166
|
+
##### Method alias:
|
1167
|
+
```ruby
|
1168
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts)
|
1039
1169
|
```
|
1040
1170
|
|
1041
1171
|
|
1042
1172
|
|
1043
1173
|
|
1044
1174
|
|
1045
|
-
#### [Get
|
1175
|
+
#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_update_catalog_items_jobs)
|
1046
1176
|
|
1047
1177
|
```ruby
|
1048
|
-
KlaviyoAPI::Catalogs.
|
1178
|
+
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_jobs(opts)
|
1049
1179
|
```
|
1050
1180
|
##### Method alias:
|
1051
1181
|
```ruby
|
1052
|
-
KlaviyoAPI::Catalogs.
|
1182
|
+
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
1183
|
+
```
|
1184
|
+
##### Method alias:
|
1185
|
+
```ruby
|
1186
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts)
|
1053
1187
|
```
|
1054
1188
|
|
1055
1189
|
|
1056
1190
|
|
1057
1191
|
|
1058
1192
|
|
1059
|
-
#### [Get
|
1193
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2024-10-15/reference/get_catalog_categories)
|
1060
1194
|
|
1061
1195
|
```ruby
|
1062
|
-
KlaviyoAPI::Catalogs.
|
1063
|
-
```
|
1064
|
-
##### Method alias:
|
1065
|
-
```ruby
|
1066
|
-
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts)
|
1196
|
+
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
1067
1197
|
```
|
1068
1198
|
|
1069
1199
|
|
1070
1200
|
|
1071
1201
|
|
1072
1202
|
|
1073
|
-
#### [Get
|
1203
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/get_catalog_category)
|
1074
1204
|
|
1075
1205
|
```ruby
|
1076
|
-
KlaviyoAPI::Catalogs.
|
1206
|
+
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
1077
1207
|
```
|
1078
|
-
|
1208
|
+
|
1209
|
+
|
1210
|
+
|
1211
|
+
|
1212
|
+
|
1213
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/get_catalog_item)
|
1214
|
+
|
1079
1215
|
```ruby
|
1080
|
-
KlaviyoAPI::Catalogs.
|
1216
|
+
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
1081
1217
|
```
|
1082
1218
|
|
1083
1219
|
|
1084
1220
|
|
1085
1221
|
|
1086
1222
|
|
1087
|
-
#### [Get
|
1223
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2024-10-15/reference/get_catalog_items)
|
1088
1224
|
|
1089
1225
|
```ruby
|
1090
|
-
KlaviyoAPI::Catalogs.
|
1226
|
+
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
1091
1227
|
```
|
1092
|
-
|
1228
|
+
|
1229
|
+
|
1230
|
+
|
1231
|
+
|
1232
|
+
|
1233
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2024-10-15/reference/get_catalog_variant)
|
1234
|
+
|
1093
1235
|
```ruby
|
1094
|
-
KlaviyoAPI::Catalogs.
|
1236
|
+
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
1095
1237
|
```
|
1096
1238
|
|
1097
1239
|
|
1098
1240
|
|
1099
1241
|
|
1100
1242
|
|
1101
|
-
#### [Get
|
1243
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2024-10-15/reference/get_catalog_variants)
|
1102
1244
|
|
1103
1245
|
```ruby
|
1104
|
-
KlaviyoAPI::Catalogs.
|
1246
|
+
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
1247
|
+
```
|
1248
|
+
|
1249
|
+
|
1250
|
+
|
1251
|
+
|
1252
|
+
|
1253
|
+
#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/get_categories_for_catalog_item)
|
1254
|
+
|
1255
|
+
```ruby
|
1256
|
+
KlaviyoAPI::Catalogs.get_categories_for_catalog_item(id, opts)
|
1105
1257
|
```
|
1106
1258
|
##### Method alias:
|
1107
1259
|
```ruby
|
1108
|
-
KlaviyoAPI::Catalogs.
|
1260
|
+
KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
|
1109
1261
|
```
|
1110
1262
|
|
1111
1263
|
|
1112
1264
|
|
1113
1265
|
|
1114
1266
|
|
1115
|
-
#### [Get
|
1267
|
+
#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/get_category_ids_for_catalog_item)
|
1116
1268
|
|
1117
1269
|
```ruby
|
1118
|
-
KlaviyoAPI::Catalogs.
|
1270
|
+
KlaviyoAPI::Catalogs.get_category_ids_for_catalog_item(id, opts)
|
1119
1271
|
```
|
1120
1272
|
##### Method alias:
|
1121
1273
|
```ruby
|
1122
|
-
KlaviyoAPI::Catalogs.
|
1274
|
+
KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
|
1123
1275
|
```
|
1124
1276
|
|
1125
1277
|
|
1126
1278
|
|
1127
1279
|
|
1128
1280
|
|
1129
|
-
#### [Get
|
1281
|
+
#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_create_categories_job)
|
1130
1282
|
|
1131
1283
|
```ruby
|
1132
|
-
KlaviyoAPI::Catalogs.
|
1284
|
+
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
1133
1285
|
```
|
1134
1286
|
##### Method alias:
|
1135
1287
|
```ruby
|
1136
|
-
KlaviyoAPI::Catalogs.
|
1288
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts)
|
1137
1289
|
```
|
1138
1290
|
|
1139
1291
|
|
1140
1292
|
|
1141
1293
|
|
1142
1294
|
|
1143
|
-
#### [Get
|
1295
|
+
#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_create_categories_jobs)
|
1144
1296
|
|
1145
1297
|
```ruby
|
1146
|
-
KlaviyoAPI::Catalogs.
|
1298
|
+
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
1147
1299
|
```
|
1148
1300
|
##### Method alias:
|
1149
1301
|
```ruby
|
1150
|
-
KlaviyoAPI::Catalogs.
|
1302
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts)
|
1151
1303
|
```
|
1152
1304
|
|
1153
1305
|
|
1154
1306
|
|
1155
1307
|
|
1156
1308
|
|
1157
|
-
#### [Get
|
1309
|
+
#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_create_variants_job)
|
1158
1310
|
|
1159
1311
|
```ruby
|
1160
|
-
KlaviyoAPI::Catalogs.
|
1312
|
+
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
1161
1313
|
```
|
1162
1314
|
##### Method alias:
|
1163
1315
|
```ruby
|
1164
|
-
KlaviyoAPI::Catalogs.
|
1316
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts)
|
1165
1317
|
```
|
1166
1318
|
|
1167
1319
|
|
1168
1320
|
|
1169
1321
|
|
1170
1322
|
|
1171
|
-
#### [Get
|
1323
|
+
#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_create_variants_jobs)
|
1172
1324
|
|
1173
1325
|
```ruby
|
1174
|
-
KlaviyoAPI::Catalogs.
|
1326
|
+
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
1175
1327
|
```
|
1176
1328
|
##### Method alias:
|
1177
1329
|
```ruby
|
1178
|
-
KlaviyoAPI::Catalogs.
|
1330
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts)
|
1179
1331
|
```
|
1180
1332
|
|
1181
1333
|
|
1182
1334
|
|
1183
1335
|
|
1184
1336
|
|
1185
|
-
#### [Get
|
1337
|
+
#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_delete_categories_job)
|
1186
1338
|
|
1187
1339
|
```ruby
|
1188
|
-
KlaviyoAPI::Catalogs.
|
1340
|
+
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
1189
1341
|
```
|
1190
1342
|
##### Method alias:
|
1191
1343
|
```ruby
|
1192
|
-
KlaviyoAPI::Catalogs.
|
1344
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts)
|
1193
1345
|
```
|
1194
1346
|
|
1195
1347
|
|
1196
1348
|
|
1197
1349
|
|
1198
1350
|
|
1199
|
-
#### [Get
|
1351
|
+
#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_delete_categories_jobs)
|
1200
1352
|
|
1201
1353
|
```ruby
|
1202
|
-
KlaviyoAPI::Catalogs.
|
1354
|
+
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
1203
1355
|
```
|
1204
1356
|
##### Method alias:
|
1205
1357
|
```ruby
|
1206
|
-
KlaviyoAPI::Catalogs.
|
1358
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts)
|
1207
1359
|
```
|
1208
1360
|
|
1209
1361
|
|
1210
1362
|
|
1211
1363
|
|
1212
1364
|
|
1213
|
-
#### [Get
|
1365
|
+
#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_delete_variants_job)
|
1214
1366
|
|
1215
1367
|
```ruby
|
1216
|
-
KlaviyoAPI::Catalogs.
|
1368
|
+
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
1217
1369
|
```
|
1218
1370
|
##### Method alias:
|
1219
1371
|
```ruby
|
1220
|
-
KlaviyoAPI::Catalogs.
|
1372
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts)
|
1221
1373
|
```
|
1222
1374
|
|
1223
1375
|
|
1224
1376
|
|
1225
1377
|
|
1226
1378
|
|
1227
|
-
#### [Get
|
1379
|
+
#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_delete_variants_jobs)
|
1228
1380
|
|
1229
1381
|
```ruby
|
1230
|
-
KlaviyoAPI::Catalogs.
|
1382
|
+
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
1231
1383
|
```
|
1232
1384
|
##### Method alias:
|
1233
1385
|
```ruby
|
1234
|
-
KlaviyoAPI::Catalogs.
|
1386
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts)
|
1235
1387
|
```
|
1236
1388
|
|
1237
1389
|
|
1238
1390
|
|
1239
1391
|
|
1240
1392
|
|
1241
|
-
#### [
|
1393
|
+
#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/get_item_ids_for_catalog_category)
|
1242
1394
|
|
1243
1395
|
```ruby
|
1244
|
-
KlaviyoAPI::Catalogs.
|
1396
|
+
KlaviyoAPI::Catalogs.get_item_ids_for_catalog_category(id, opts)
|
1245
1397
|
```
|
1246
1398
|
##### Method alias:
|
1247
1399
|
```ruby
|
1248
|
-
KlaviyoAPI::Catalogs.
|
1400
|
+
KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
|
1249
1401
|
```
|
1250
1402
|
|
1251
1403
|
|
1252
1404
|
|
1253
1405
|
|
1254
1406
|
|
1255
|
-
#### [
|
1407
|
+
#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/get_items_for_catalog_category)
|
1256
1408
|
|
1257
1409
|
```ruby
|
1258
|
-
KlaviyoAPI::Catalogs.
|
1410
|
+
KlaviyoAPI::Catalogs.get_items_for_catalog_category(id, opts)
|
1259
1411
|
```
|
1260
1412
|
##### Method alias:
|
1261
1413
|
```ruby
|
1262
|
-
KlaviyoAPI::Catalogs.
|
1414
|
+
KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
|
1263
1415
|
```
|
1264
1416
|
|
1265
1417
|
|
1266
1418
|
|
1267
1419
|
|
1268
1420
|
|
1269
|
-
#### [
|
1421
|
+
#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_update_categories_job)
|
1270
1422
|
|
1271
1423
|
```ruby
|
1272
|
-
KlaviyoAPI::Catalogs.
|
1424
|
+
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
1273
1425
|
```
|
1274
1426
|
##### Method alias:
|
1275
1427
|
```ruby
|
1276
|
-
KlaviyoAPI::Catalogs.
|
1428
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts)
|
1277
1429
|
```
|
1278
1430
|
|
1279
1431
|
|
1280
1432
|
|
1281
1433
|
|
1282
1434
|
|
1283
|
-
#### [
|
1435
|
+
#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_update_categories_jobs)
|
1284
1436
|
|
1285
1437
|
```ruby
|
1286
|
-
KlaviyoAPI::Catalogs.
|
1438
|
+
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
1287
1439
|
```
|
1288
1440
|
##### Method alias:
|
1289
1441
|
```ruby
|
1290
|
-
KlaviyoAPI::Catalogs.
|
1442
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts)
|
1291
1443
|
```
|
1292
1444
|
|
1293
1445
|
|
1294
1446
|
|
1295
1447
|
|
1296
1448
|
|
1297
|
-
#### [
|
1449
|
+
#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_update_variants_job)
|
1298
1450
|
|
1299
1451
|
```ruby
|
1300
|
-
KlaviyoAPI::Catalogs.
|
1452
|
+
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
1301
1453
|
```
|
1302
1454
|
##### Method alias:
|
1303
1455
|
```ruby
|
1304
|
-
KlaviyoAPI::Catalogs.
|
1456
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts)
|
1305
1457
|
```
|
1306
1458
|
|
1307
1459
|
|
1308
1460
|
|
1309
1461
|
|
1310
1462
|
|
1311
|
-
#### [
|
1463
|
+
#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_update_variants_jobs)
|
1312
1464
|
|
1313
1465
|
```ruby
|
1314
|
-
KlaviyoAPI::Catalogs.
|
1466
|
+
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
1315
1467
|
```
|
1316
1468
|
##### Method alias:
|
1317
1469
|
```ruby
|
1318
|
-
KlaviyoAPI::Catalogs.
|
1470
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts)
|
1319
1471
|
```
|
1320
1472
|
|
1321
1473
|
|
1322
1474
|
|
1323
1475
|
|
1324
1476
|
|
1325
|
-
#### [
|
1477
|
+
#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/get_variants_for_catalog_item)
|
1326
1478
|
|
1327
1479
|
```ruby
|
1328
|
-
KlaviyoAPI::Catalogs.
|
1480
|
+
KlaviyoAPI::Catalogs.get_variants_for_catalog_item(id, opts)
|
1329
1481
|
```
|
1330
1482
|
##### Method alias:
|
1331
1483
|
```ruby
|
1332
|
-
KlaviyoAPI::Catalogs.
|
1484
|
+
KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
|
1333
1485
|
```
|
1334
1486
|
|
1335
1487
|
|
1336
1488
|
|
1337
1489
|
|
1338
1490
|
|
1339
|
-
#### [
|
1491
|
+
#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_categories_from_catalog_item)
|
1340
1492
|
|
1341
1493
|
```ruby
|
1342
|
-
KlaviyoAPI::Catalogs.
|
1494
|
+
KlaviyoAPI::Catalogs.remove_categories_from_catalog_item(id, body)
|
1343
1495
|
```
|
1344
1496
|
##### Method alias:
|
1345
1497
|
```ruby
|
1346
|
-
KlaviyoAPI::Catalogs.
|
1498
|
+
KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
|
1347
1499
|
```
|
1348
1500
|
|
1349
1501
|
|
1350
1502
|
|
1351
1503
|
|
1352
1504
|
|
1353
|
-
#### [
|
1505
|
+
#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_items_from_catalog_category)
|
1354
1506
|
|
1355
1507
|
```ruby
|
1356
|
-
KlaviyoAPI::Catalogs.
|
1508
|
+
KlaviyoAPI::Catalogs.remove_items_from_catalog_category(id, body)
|
1357
1509
|
```
|
1358
1510
|
##### Method alias:
|
1359
1511
|
```ruby
|
1360
|
-
KlaviyoAPI::Catalogs.
|
1512
|
+
KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
|
1361
1513
|
```
|
1362
1514
|
|
1363
1515
|
|
1364
1516
|
|
1365
1517
|
|
1366
1518
|
|
1367
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2024-
|
1519
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/update_catalog_category)
|
1368
1520
|
|
1369
1521
|
```ruby
|
1370
1522
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
@@ -1374,28 +1526,32 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
1374
1526
|
|
1375
1527
|
|
1376
1528
|
|
1377
|
-
#### [Update Catalog
|
1529
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/update_catalog_item)
|
1378
1530
|
|
1379
1531
|
```ruby
|
1380
|
-
KlaviyoAPI::Catalogs.
|
1532
|
+
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
1381
1533
|
```
|
1382
1534
|
|
1383
1535
|
|
1384
1536
|
|
1385
1537
|
|
1386
1538
|
|
1387
|
-
#### [Update Catalog
|
1539
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2024-10-15/reference/update_catalog_variant)
|
1388
1540
|
|
1389
1541
|
```ruby
|
1390
|
-
KlaviyoAPI::Catalogs.
|
1542
|
+
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
1391
1543
|
```
|
1392
1544
|
|
1393
1545
|
|
1394
1546
|
|
1395
1547
|
|
1396
1548
|
|
1397
|
-
#### [Update Catalog Item
|
1549
|
+
#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/update_categories_for_catalog_item)
|
1398
1550
|
|
1551
|
+
```ruby
|
1552
|
+
KlaviyoAPI::Catalogs.update_categories_for_catalog_item(id, body)
|
1553
|
+
```
|
1554
|
+
##### Method alias:
|
1399
1555
|
```ruby
|
1400
1556
|
KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
1401
1557
|
```
|
@@ -1404,10 +1560,14 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
|
1404
1560
|
|
1405
1561
|
|
1406
1562
|
|
1407
|
-
#### [Update Catalog
|
1563
|
+
#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2024-10-15/reference/update_items_for_catalog_category)
|
1408
1564
|
|
1409
1565
|
```ruby
|
1410
|
-
KlaviyoAPI::Catalogs.
|
1566
|
+
KlaviyoAPI::Catalogs.update_items_for_catalog_category(id, body)
|
1567
|
+
```
|
1568
|
+
##### Method alias:
|
1569
|
+
```ruby
|
1570
|
+
KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
|
1411
1571
|
```
|
1412
1572
|
|
1413
1573
|
|
@@ -1418,7 +1578,25 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
1418
1578
|
## Coupons
|
1419
1579
|
|
1420
1580
|
|
1421
|
-
#### [Create Coupon](https://developers.klaviyo.com/en/v2024-
|
1581
|
+
#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_create_coupon_codes)
|
1582
|
+
|
1583
|
+
```ruby
|
1584
|
+
KlaviyoAPI::Coupons.bulk_create_coupon_codes(body)
|
1585
|
+
```
|
1586
|
+
##### Method alias:
|
1587
|
+
```ruby
|
1588
|
+
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
|
1589
|
+
```
|
1590
|
+
##### Method alias:
|
1591
|
+
```ruby
|
1592
|
+
KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body)
|
1593
|
+
```
|
1594
|
+
|
1595
|
+
|
1596
|
+
|
1597
|
+
|
1598
|
+
|
1599
|
+
#### [Create Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/create_coupon)
|
1422
1600
|
|
1423
1601
|
```ruby
|
1424
1602
|
KlaviyoAPI::Coupons.create_coupon(body)
|
@@ -1428,7 +1606,7 @@ KlaviyoAPI::Coupons.create_coupon(body)
|
|
1428
1606
|
|
1429
1607
|
|
1430
1608
|
|
1431
|
-
#### [Create Coupon Code](https://developers.klaviyo.com/en/v2024-
|
1609
|
+
#### [Create Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/create_coupon_code)
|
1432
1610
|
|
1433
1611
|
```ruby
|
1434
1612
|
KlaviyoAPI::Coupons.create_coupon_code(body)
|
@@ -1438,7 +1616,7 @@ KlaviyoAPI::Coupons.create_coupon_code(body)
|
|
1438
1616
|
|
1439
1617
|
|
1440
1618
|
|
1441
|
-
#### [Delete Coupon](https://developers.klaviyo.com/en/v2024-
|
1619
|
+
#### [Delete Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_coupon)
|
1442
1620
|
|
1443
1621
|
```ruby
|
1444
1622
|
KlaviyoAPI::Coupons.delete_coupon(id)
|
@@ -1448,7 +1626,7 @@ KlaviyoAPI::Coupons.delete_coupon(id)
|
|
1448
1626
|
|
1449
1627
|
|
1450
1628
|
|
1451
|
-
#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2024-
|
1629
|
+
#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_coupon_code)
|
1452
1630
|
|
1453
1631
|
```ruby
|
1454
1632
|
KlaviyoAPI::Coupons.delete_coupon_code(id)
|
@@ -1458,57 +1636,69 @@ KlaviyoAPI::Coupons.delete_coupon_code(id)
|
|
1458
1636
|
|
1459
1637
|
|
1460
1638
|
|
1461
|
-
#### [Get Coupon](https://developers.klaviyo.com/en/v2024-
|
1639
|
+
#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_create_coupon_code_jobs)
|
1462
1640
|
|
1463
1641
|
```ruby
|
1464
|
-
KlaviyoAPI::Coupons.
|
1642
|
+
KlaviyoAPI::Coupons.get_bulk_create_coupon_code_jobs(opts)
|
1643
|
+
```
|
1644
|
+
##### Method alias:
|
1645
|
+
```ruby
|
1646
|
+
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
|
1465
1647
|
```
|
1466
1648
|
|
1467
1649
|
|
1468
1650
|
|
1469
1651
|
|
1470
1652
|
|
1471
|
-
#### [Get Coupon
|
1653
|
+
#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_create_coupon_codes_job)
|
1472
1654
|
|
1473
1655
|
```ruby
|
1474
|
-
KlaviyoAPI::Coupons.
|
1656
|
+
KlaviyoAPI::Coupons.get_bulk_create_coupon_codes_job(job_id, opts)
|
1657
|
+
```
|
1658
|
+
##### Method alias:
|
1659
|
+
```ruby
|
1660
|
+
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
|
1475
1661
|
```
|
1476
1662
|
|
1477
1663
|
|
1478
1664
|
|
1479
1665
|
|
1480
1666
|
|
1481
|
-
#### [Get
|
1667
|
+
#### [Get Code IDs for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_code_ids_for_coupon)
|
1482
1668
|
|
1483
1669
|
```ruby
|
1484
|
-
KlaviyoAPI::Coupons.
|
1670
|
+
KlaviyoAPI::Coupons.get_code_ids_for_coupon(id, opts)
|
1671
|
+
```
|
1672
|
+
##### Method alias:
|
1673
|
+
```ruby
|
1674
|
+
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
|
1485
1675
|
```
|
1486
1676
|
|
1487
1677
|
|
1488
1678
|
|
1489
1679
|
|
1490
1680
|
|
1491
|
-
#### [Get Coupon
|
1681
|
+
#### [Get Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon)
|
1492
1682
|
|
1493
1683
|
```ruby
|
1494
|
-
KlaviyoAPI::Coupons.
|
1684
|
+
KlaviyoAPI::Coupons.get_coupon(id, opts)
|
1495
1685
|
```
|
1496
1686
|
|
1497
1687
|
|
1498
1688
|
|
1499
1689
|
|
1500
1690
|
|
1501
|
-
#### [Get Coupon Code
|
1691
|
+
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code)
|
1502
1692
|
|
1503
1693
|
```ruby
|
1504
|
-
KlaviyoAPI::Coupons.
|
1694
|
+
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
1505
1695
|
```
|
1506
1696
|
|
1507
1697
|
|
1508
1698
|
|
1509
1699
|
|
1510
1700
|
|
1511
|
-
#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2024-
|
1701
|
+
#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_codes)
|
1512
1702
|
|
1513
1703
|
```ruby
|
1514
1704
|
KlaviyoAPI::Coupons.get_coupon_codes(opts)
|
@@ -1518,7 +1708,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts)
|
|
1518
1708
|
|
1519
1709
|
|
1520
1710
|
|
1521
|
-
#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-
|
1711
|
+
#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_codes_for_coupon)
|
1522
1712
|
|
1523
1713
|
```ruby
|
1524
1714
|
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
@@ -1532,7 +1722,7 @@ KlaviyoAPI::Coupons.get_coupon_coupon_codes(id, opts)
|
|
1532
1722
|
|
1533
1723
|
|
1534
1724
|
|
1535
|
-
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-
|
1725
|
+
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_for_coupon_code)
|
1536
1726
|
|
1537
1727
|
```ruby
|
1538
1728
|
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
|
@@ -1546,41 +1736,31 @@ KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts)
|
|
1546
1736
|
|
1547
1737
|
|
1548
1738
|
|
1549
|
-
#### [Get Coupon
|
1739
|
+
#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_id_for_coupon_code)
|
1550
1740
|
|
1551
1741
|
```ruby
|
1552
|
-
KlaviyoAPI::Coupons.
|
1742
|
+
KlaviyoAPI::Coupons.get_coupon_id_for_coupon_code(id)
|
1553
1743
|
```
|
1554
|
-
|
1555
|
-
|
1556
|
-
|
1557
|
-
|
1558
|
-
|
1559
|
-
#### [Get Coupons](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupons)
|
1560
|
-
|
1744
|
+
##### Method alias:
|
1561
1745
|
```ruby
|
1562
|
-
KlaviyoAPI::Coupons.
|
1746
|
+
KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
|
1563
1747
|
```
|
1564
1748
|
|
1565
1749
|
|
1566
1750
|
|
1567
1751
|
|
1568
1752
|
|
1569
|
-
#### [
|
1753
|
+
#### [Get Coupons](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupons)
|
1570
1754
|
|
1571
1755
|
```ruby
|
1572
|
-
KlaviyoAPI::Coupons.
|
1573
|
-
```
|
1574
|
-
##### Method alias:
|
1575
|
-
```ruby
|
1576
|
-
KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body)
|
1756
|
+
KlaviyoAPI::Coupons.get_coupons(opts)
|
1577
1757
|
```
|
1578
1758
|
|
1579
1759
|
|
1580
1760
|
|
1581
1761
|
|
1582
1762
|
|
1583
|
-
#### [Update Coupon](https://developers.klaviyo.com/en/v2024-
|
1763
|
+
#### [Update Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/update_coupon)
|
1584
1764
|
|
1585
1765
|
```ruby
|
1586
1766
|
KlaviyoAPI::Coupons.update_coupon(id, body)
|
@@ -1590,7 +1770,7 @@ KlaviyoAPI::Coupons.update_coupon(id, body)
|
|
1590
1770
|
|
1591
1771
|
|
1592
1772
|
|
1593
|
-
#### [Update Coupon Code](https://developers.klaviyo.com/en/v2024-
|
1773
|
+
#### [Update Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/update_coupon_code)
|
1594
1774
|
|
1595
1775
|
```ruby
|
1596
1776
|
KlaviyoAPI::Coupons.update_coupon_code(id, body)
|
@@ -1604,7 +1784,7 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body)
|
|
1604
1784
|
## Data Privacy
|
1605
1785
|
|
1606
1786
|
|
1607
|
-
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-
|
1787
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-10-15/reference/request_profile_deletion)
|
1608
1788
|
|
1609
1789
|
```ruby
|
1610
1790
|
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
@@ -1622,7 +1802,7 @@ KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body)
|
|
1622
1802
|
## Events
|
1623
1803
|
|
1624
1804
|
|
1625
|
-
#### [Bulk Create Events](https://developers.klaviyo.com/en/v2024-
|
1805
|
+
#### [Bulk Create Events](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_create_events)
|
1626
1806
|
|
1627
1807
|
```ruby
|
1628
1808
|
KlaviyoAPI::Events.bulk_create_events(body)
|
@@ -1636,7 +1816,7 @@ KlaviyoAPI::Events.create_event_bulk_create_job(body)
|
|
1636
1816
|
|
1637
1817
|
|
1638
1818
|
|
1639
|
-
#### [Create Event](https://developers.klaviyo.com/en/v2024-
|
1819
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2024-10-15/reference/create_event)
|
1640
1820
|
|
1641
1821
|
```ruby
|
1642
1822
|
KlaviyoAPI::Events.create_event(body)
|
@@ -1646,7 +1826,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
1646
1826
|
|
1647
1827
|
|
1648
1828
|
|
1649
|
-
#### [Get Event](https://developers.klaviyo.com/en/v2024-
|
1829
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_event)
|
1650
1830
|
|
1651
1831
|
```ruby
|
1652
1832
|
KlaviyoAPI::Events.get_event(id, opts)
|
@@ -1656,7 +1836,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
1656
1836
|
|
1657
1837
|
|
1658
1838
|
|
1659
|
-
#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-
|
1839
|
+
#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_event_metric)
|
1660
1840
|
|
1661
1841
|
```ruby
|
1662
1842
|
KlaviyoAPI::Events.get_event_metric(id, opts)
|
@@ -1666,7 +1846,7 @@ KlaviyoAPI::Events.get_event_metric(id, opts)
|
|
1666
1846
|
|
1667
1847
|
|
1668
1848
|
|
1669
|
-
#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-
|
1849
|
+
#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/get_event_profile)
|
1670
1850
|
|
1671
1851
|
```ruby
|
1672
1852
|
KlaviyoAPI::Events.get_event_profile(id, opts)
|
@@ -1676,30 +1856,38 @@ KlaviyoAPI::Events.get_event_profile(id, opts)
|
|
1676
1856
|
|
1677
1857
|
|
1678
1858
|
|
1679
|
-
#### [Get
|
1859
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2024-10-15/reference/get_events)
|
1680
1860
|
|
1681
1861
|
```ruby
|
1682
|
-
KlaviyoAPI::Events.
|
1862
|
+
KlaviyoAPI::Events.get_events(opts)
|
1683
1863
|
```
|
1684
1864
|
|
1685
1865
|
|
1686
1866
|
|
1687
1867
|
|
1688
1868
|
|
1689
|
-
#### [Get
|
1869
|
+
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_id_for_event)
|
1690
1870
|
|
1691
1871
|
```ruby
|
1692
|
-
KlaviyoAPI::Events.
|
1872
|
+
KlaviyoAPI::Events.get_metric_id_for_event(id)
|
1873
|
+
```
|
1874
|
+
##### Method alias:
|
1875
|
+
```ruby
|
1876
|
+
KlaviyoAPI::Events.get_event_relationships_metric(id)
|
1693
1877
|
```
|
1694
1878
|
|
1695
1879
|
|
1696
1880
|
|
1697
1881
|
|
1698
1882
|
|
1699
|
-
#### [Get
|
1883
|
+
#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_id_for_event)
|
1700
1884
|
|
1701
1885
|
```ruby
|
1702
|
-
KlaviyoAPI::Events.
|
1886
|
+
KlaviyoAPI::Events.get_profile_id_for_event(id)
|
1887
|
+
```
|
1888
|
+
##### Method alias:
|
1889
|
+
```ruby
|
1890
|
+
KlaviyoAPI::Events.get_event_relationships_profile(id)
|
1703
1891
|
```
|
1704
1892
|
|
1705
1893
|
|
@@ -1710,7 +1898,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
1710
1898
|
## Flows
|
1711
1899
|
|
1712
1900
|
|
1713
|
-
#### [Delete Flow](https://developers.klaviyo.com/en/v2024-
|
1901
|
+
#### [Delete Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_flow)
|
1714
1902
|
|
1715
1903
|
```ruby
|
1716
1904
|
KlaviyoAPI::Flows.delete_flow(id)
|
@@ -1720,77 +1908,93 @@ KlaviyoAPI::Flows.delete_flow(id)
|
|
1720
1908
|
|
1721
1909
|
|
1722
1910
|
|
1723
|
-
#### [Get Flow](https://developers.klaviyo.com/en/v2024-
|
1911
|
+
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_id_for_flow_message)
|
1724
1912
|
|
1725
1913
|
```ruby
|
1726
|
-
KlaviyoAPI::Flows.
|
1914
|
+
KlaviyoAPI::Flows.get_action_id_for_flow_message(id)
|
1915
|
+
```
|
1916
|
+
##### Method alias:
|
1917
|
+
```ruby
|
1918
|
+
KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
|
1727
1919
|
```
|
1728
1920
|
|
1729
1921
|
|
1730
1922
|
|
1731
1923
|
|
1732
1924
|
|
1733
|
-
#### [Get Flow
|
1925
|
+
#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_ids_for_flow)
|
1734
1926
|
|
1735
1927
|
```ruby
|
1736
|
-
KlaviyoAPI::Flows.
|
1928
|
+
KlaviyoAPI::Flows.get_action_ids_for_flow(id, opts)
|
1929
|
+
```
|
1930
|
+
##### Method alias:
|
1931
|
+
```ruby
|
1932
|
+
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
|
1737
1933
|
```
|
1738
1934
|
|
1739
1935
|
|
1740
1936
|
|
1741
1937
|
|
1742
1938
|
|
1743
|
-
#### [Get
|
1939
|
+
#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/get_actions_for_flow)
|
1744
1940
|
|
1745
1941
|
```ruby
|
1746
|
-
KlaviyoAPI::Flows.
|
1942
|
+
KlaviyoAPI::Flows.get_actions_for_flow(id, opts)
|
1943
|
+
```
|
1944
|
+
##### Method alias:
|
1945
|
+
```ruby
|
1946
|
+
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
|
1747
1947
|
```
|
1748
1948
|
|
1749
1949
|
|
1750
1950
|
|
1751
1951
|
|
1752
1952
|
|
1753
|
-
#### [Get Flow
|
1953
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow)
|
1754
1954
|
|
1755
1955
|
```ruby
|
1756
|
-
KlaviyoAPI::Flows.
|
1956
|
+
KlaviyoAPI::Flows.get_flow(id, opts)
|
1757
1957
|
```
|
1758
1958
|
|
1759
1959
|
|
1760
1960
|
|
1761
1961
|
|
1762
1962
|
|
1763
|
-
#### [Get Flow Action
|
1963
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_action)
|
1764
1964
|
|
1765
1965
|
```ruby
|
1766
|
-
KlaviyoAPI::Flows.
|
1966
|
+
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
1767
1967
|
```
|
1768
1968
|
|
1769
1969
|
|
1770
1970
|
|
1771
1971
|
|
1772
1972
|
|
1773
|
-
#### [Get Flow
|
1973
|
+
#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_action_flow)
|
1774
1974
|
|
1775
1975
|
```ruby
|
1776
|
-
KlaviyoAPI::Flows.
|
1976
|
+
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
1777
1977
|
```
|
1778
1978
|
|
1779
1979
|
|
1780
1980
|
|
1781
1981
|
|
1782
1982
|
|
1783
|
-
#### [Get Flow Flow
|
1983
|
+
#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_id_for_flow_action)
|
1784
1984
|
|
1785
1985
|
```ruby
|
1786
|
-
KlaviyoAPI::Flows.
|
1986
|
+
KlaviyoAPI::Flows.get_flow_id_for_flow_action(id)
|
1987
|
+
```
|
1988
|
+
##### Method alias:
|
1989
|
+
```ruby
|
1990
|
+
KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
|
1787
1991
|
```
|
1788
1992
|
|
1789
1993
|
|
1790
1994
|
|
1791
1995
|
|
1792
1996
|
|
1793
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/v2024-
|
1997
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_message)
|
1794
1998
|
|
1795
1999
|
```ruby
|
1796
2000
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
@@ -1800,7 +2004,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
1800
2004
|
|
1801
2005
|
|
1802
2006
|
|
1803
|
-
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-
|
2007
|
+
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_message_action)
|
1804
2008
|
|
1805
2009
|
```ruby
|
1806
2010
|
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
@@ -1810,48 +2014,60 @@ KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
|
1810
2014
|
|
1811
2015
|
|
1812
2016
|
|
1813
|
-
#### [Get Flow
|
2017
|
+
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_tags)
|
1814
2018
|
|
1815
2019
|
```ruby
|
1816
|
-
KlaviyoAPI::Flows.
|
2020
|
+
KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
1817
2021
|
```
|
1818
2022
|
|
1819
2023
|
|
1820
2024
|
|
1821
2025
|
|
1822
2026
|
|
1823
|
-
#### [Get
|
2027
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows)
|
1824
2028
|
|
1825
2029
|
```ruby
|
1826
|
-
KlaviyoAPI::Flows.
|
2030
|
+
KlaviyoAPI::Flows.get_flows(opts)
|
1827
2031
|
```
|
1828
2032
|
|
1829
2033
|
|
1830
2034
|
|
1831
2035
|
|
1832
2036
|
|
1833
|
-
#### [Get Flow
|
2037
|
+
#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_message_ids_for_flow_action)
|
1834
2038
|
|
1835
2039
|
```ruby
|
1836
|
-
KlaviyoAPI::Flows.
|
2040
|
+
KlaviyoAPI::Flows.get_message_ids_for_flow_action(id, opts)
|
2041
|
+
```
|
2042
|
+
##### Method alias:
|
2043
|
+
```ruby
|
2044
|
+
KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
|
1837
2045
|
```
|
1838
2046
|
|
1839
2047
|
|
1840
2048
|
|
1841
2049
|
|
1842
2050
|
|
1843
|
-
#### [Get
|
2051
|
+
#### [Get Messages for Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_messages_for_flow_action)
|
1844
2052
|
|
1845
2053
|
```ruby
|
1846
|
-
KlaviyoAPI::Flows.
|
2054
|
+
KlaviyoAPI::Flows.get_messages_for_flow_action(id, opts)
|
2055
|
+
```
|
2056
|
+
##### Method alias:
|
2057
|
+
```ruby
|
2058
|
+
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
|
1847
2059
|
```
|
1848
2060
|
|
1849
2061
|
|
1850
2062
|
|
1851
2063
|
|
1852
2064
|
|
1853
|
-
#### [Get
|
2065
|
+
#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_flow)
|
1854
2066
|
|
2067
|
+
```ruby
|
2068
|
+
KlaviyoAPI::Flows.get_tag_ids_for_flow(id)
|
2069
|
+
```
|
2070
|
+
##### Method alias:
|
1855
2071
|
```ruby
|
1856
2072
|
KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
1857
2073
|
```
|
@@ -1860,27 +2076,35 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
|
1860
2076
|
|
1861
2077
|
|
1862
2078
|
|
1863
|
-
#### [Get Flow
|
2079
|
+
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template_for_flow_message)
|
1864
2080
|
|
1865
2081
|
```ruby
|
1866
|
-
KlaviyoAPI::Flows.
|
2082
|
+
KlaviyoAPI::Flows.get_template_for_flow_message(id, opts)
|
2083
|
+
```
|
2084
|
+
##### Method alias:
|
2085
|
+
```ruby
|
2086
|
+
KlaviyoAPI::Flows.get_flow_message_template(id, opts)
|
1867
2087
|
```
|
1868
2088
|
|
1869
2089
|
|
1870
2090
|
|
1871
2091
|
|
1872
2092
|
|
1873
|
-
#### [Get
|
2093
|
+
#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template_id_for_flow_message)
|
1874
2094
|
|
1875
2095
|
```ruby
|
1876
|
-
KlaviyoAPI::Flows.
|
2096
|
+
KlaviyoAPI::Flows.get_template_id_for_flow_message(id)
|
2097
|
+
```
|
2098
|
+
##### Method alias:
|
2099
|
+
```ruby
|
2100
|
+
KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
|
1877
2101
|
```
|
1878
2102
|
|
1879
2103
|
|
1880
2104
|
|
1881
2105
|
|
1882
2106
|
|
1883
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/v2024-
|
2107
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2024-10-15/reference/update_flow)
|
1884
2108
|
|
1885
2109
|
```ruby
|
1886
2110
|
KlaviyoAPI::Flows.update_flow(id, body)
|
@@ -1894,7 +2118,7 @@ KlaviyoAPI::Flows.update_flow(id, body)
|
|
1894
2118
|
## Forms
|
1895
2119
|
|
1896
2120
|
|
1897
|
-
#### [Get Form](https://developers.klaviyo.com/en/v2024-
|
2121
|
+
#### [Get Form](https://developers.klaviyo.com/en/v2024-10-15/reference/get_form)
|
1898
2122
|
|
1899
2123
|
```ruby
|
1900
2124
|
KlaviyoAPI::Forms.get_form(id, opts)
|
@@ -1904,7 +2128,7 @@ KlaviyoAPI::Forms.get_form(id, opts)
|
|
1904
2128
|
|
1905
2129
|
|
1906
2130
|
|
1907
|
-
#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2024-
|
2131
|
+
#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2024-10-15/reference/get_form_for_form_version)
|
1908
2132
|
|
1909
2133
|
```ruby
|
1910
2134
|
KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
|
@@ -1918,7 +2142,7 @@ KlaviyoAPI::Forms.get_form_version_form(id, opts)
|
|
1918
2142
|
|
1919
2143
|
|
1920
2144
|
|
1921
|
-
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2024-
|
2145
|
+
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2024-10-15/reference/get_form_id_for_form_version)
|
1922
2146
|
|
1923
2147
|
```ruby
|
1924
2148
|
KlaviyoAPI::Forms.get_form_id_for_form_version(id)
|
@@ -1932,7 +2156,7 @@ KlaviyoAPI::Forms.get_form_version_relationships_form(id)
|
|
1932
2156
|
|
1933
2157
|
|
1934
2158
|
|
1935
|
-
#### [Get Form Version](https://developers.klaviyo.com/en/v2024-
|
2159
|
+
#### [Get Form Version](https://developers.klaviyo.com/en/v2024-10-15/reference/get_form_version)
|
1936
2160
|
|
1937
2161
|
```ruby
|
1938
2162
|
KlaviyoAPI::Forms.get_form_version(id, opts)
|
@@ -1942,7 +2166,7 @@ KlaviyoAPI::Forms.get_form_version(id, opts)
|
|
1942
2166
|
|
1943
2167
|
|
1944
2168
|
|
1945
|
-
#### [Get Forms](https://developers.klaviyo.com/en/v2024-
|
2169
|
+
#### [Get Forms](https://developers.klaviyo.com/en/v2024-10-15/reference/get_forms)
|
1946
2170
|
|
1947
2171
|
```ruby
|
1948
2172
|
KlaviyoAPI::Forms.get_forms(opts)
|
@@ -1952,7 +2176,7 @@ KlaviyoAPI::Forms.get_forms(opts)
|
|
1952
2176
|
|
1953
2177
|
|
1954
2178
|
|
1955
|
-
#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2024-
|
2179
|
+
#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2024-10-15/reference/get_version_ids_for_form)
|
1956
2180
|
|
1957
2181
|
```ruby
|
1958
2182
|
KlaviyoAPI::Forms.get_version_ids_for_form(id)
|
@@ -1966,7 +2190,7 @@ KlaviyoAPI::Forms.get_form_relationships_form_versions(id)
|
|
1966
2190
|
|
1967
2191
|
|
1968
2192
|
|
1969
|
-
#### [Get Versions for Form](https://developers.klaviyo.com/en/v2024-
|
2193
|
+
#### [Get Versions for Form](https://developers.klaviyo.com/en/v2024-10-15/reference/get_versions_for_form)
|
1970
2194
|
|
1971
2195
|
```ruby
|
1972
2196
|
KlaviyoAPI::Forms.get_versions_for_form(id, opts)
|
@@ -1984,7 +2208,7 @@ KlaviyoAPI::Forms.get_form_form_versions(id, opts)
|
|
1984
2208
|
## Images
|
1985
2209
|
|
1986
2210
|
|
1987
|
-
#### [Get Image](https://developers.klaviyo.com/en/v2024-
|
2211
|
+
#### [Get Image](https://developers.klaviyo.com/en/v2024-10-15/reference/get_image)
|
1988
2212
|
|
1989
2213
|
```ruby
|
1990
2214
|
KlaviyoAPI::Images.get_image(id, opts)
|
@@ -1994,7 +2218,7 @@ KlaviyoAPI::Images.get_image(id, opts)
|
|
1994
2218
|
|
1995
2219
|
|
1996
2220
|
|
1997
|
-
#### [Get Images](https://developers.klaviyo.com/en/v2024-
|
2221
|
+
#### [Get Images](https://developers.klaviyo.com/en/v2024-10-15/reference/get_images)
|
1998
2222
|
|
1999
2223
|
```ruby
|
2000
2224
|
KlaviyoAPI::Images.get_images(opts)
|
@@ -2004,7 +2228,7 @@ KlaviyoAPI::Images.get_images(opts)
|
|
2004
2228
|
|
2005
2229
|
|
2006
2230
|
|
2007
|
-
#### [Update Image](https://developers.klaviyo.com/en/v2024-
|
2231
|
+
#### [Update Image](https://developers.klaviyo.com/en/v2024-10-15/reference/update_image)
|
2008
2232
|
|
2009
2233
|
```ruby
|
2010
2234
|
KlaviyoAPI::Images.update_image(id, body)
|
@@ -2014,7 +2238,7 @@ KlaviyoAPI::Images.update_image(id, body)
|
|
2014
2238
|
|
2015
2239
|
|
2016
2240
|
|
2017
|
-
#### [Upload Image From File](https://developers.klaviyo.com/en/v2024-
|
2241
|
+
#### [Upload Image From File](https://developers.klaviyo.com/en/v2024-10-15/reference/upload_image_from_file)
|
2018
2242
|
|
2019
2243
|
```ruby
|
2020
2244
|
KlaviyoAPI::Images.upload_image_from_file(file, opts)
|
@@ -2028,7 +2252,7 @@ KlaviyoAPI::Images.create_image_upload(file, opts)
|
|
2028
2252
|
|
2029
2253
|
|
2030
2254
|
|
2031
|
-
#### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-
|
2255
|
+
#### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-10-15/reference/upload_image_from_url)
|
2032
2256
|
|
2033
2257
|
```ruby
|
2034
2258
|
KlaviyoAPI::Images.upload_image_from_url(body)
|
@@ -2046,7 +2270,7 @@ KlaviyoAPI::Images.create_image(body)
|
|
2046
2270
|
## Lists
|
2047
2271
|
|
2048
2272
|
|
2049
|
-
#### [Create List](https://developers.klaviyo.com/en/v2024-
|
2273
|
+
#### [Create List](https://developers.klaviyo.com/en/v2024-10-15/reference/create_list)
|
2050
2274
|
|
2051
2275
|
```ruby
|
2052
2276
|
KlaviyoAPI::Lists.create_list(body)
|
@@ -2056,7 +2280,7 @@ KlaviyoAPI::Lists.create_list(body)
|
|
2056
2280
|
|
2057
2281
|
|
2058
2282
|
|
2059
|
-
#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-
|
2283
|
+
#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-10-15/reference/create_list_relationships)
|
2060
2284
|
|
2061
2285
|
```ruby
|
2062
2286
|
KlaviyoAPI::Lists.create_list_relationships(id, body)
|
@@ -2070,7 +2294,7 @@ KlaviyoAPI::Lists.create_list_relationships_profile(id, body)
|
|
2070
2294
|
|
2071
2295
|
|
2072
2296
|
|
2073
|
-
#### [Delete List](https://developers.klaviyo.com/en/v2024-
|
2297
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_list)
|
2074
2298
|
|
2075
2299
|
```ruby
|
2076
2300
|
KlaviyoAPI::Lists.delete_list(id)
|
@@ -2080,7 +2304,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
2080
2304
|
|
2081
2305
|
|
2082
2306
|
|
2083
|
-
#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-
|
2307
|
+
#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_list_relationships)
|
2084
2308
|
|
2085
2309
|
```ruby
|
2086
2310
|
KlaviyoAPI::Lists.delete_list_relationships(id, body)
|
@@ -2094,7 +2318,7 @@ KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
|
|
2094
2318
|
|
2095
2319
|
|
2096
2320
|
|
2097
|
-
#### [Get List](https://developers.klaviyo.com/en/v2024-
|
2321
|
+
#### [Get List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list)
|
2098
2322
|
|
2099
2323
|
```ruby
|
2100
2324
|
KlaviyoAPI::Lists.get_list(id, opts)
|
@@ -2104,37 +2328,37 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
2104
2328
|
|
2105
2329
|
|
2106
2330
|
|
2107
|
-
#### [Get List
|
2331
|
+
#### [Get List Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_flow_triggers)
|
2108
2332
|
|
2109
2333
|
```ruby
|
2110
|
-
KlaviyoAPI::Lists.
|
2334
|
+
KlaviyoAPI::Lists.get_list_flow_triggers(id, opts)
|
2111
2335
|
```
|
2112
2336
|
|
2113
2337
|
|
2114
2338
|
|
2115
2339
|
|
2116
2340
|
|
2117
|
-
#### [Get List
|
2341
|
+
#### [Get List Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_profiles)
|
2118
2342
|
|
2119
2343
|
```ruby
|
2120
|
-
KlaviyoAPI::Lists.
|
2344
|
+
KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
2121
2345
|
```
|
2122
2346
|
|
2123
2347
|
|
2124
2348
|
|
2125
2349
|
|
2126
2350
|
|
2127
|
-
#### [Get List Relationships
|
2351
|
+
#### [Get List Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_relationships_flow_triggers)
|
2128
2352
|
|
2129
2353
|
```ruby
|
2130
|
-
KlaviyoAPI::Lists.
|
2354
|
+
KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id)
|
2131
2355
|
```
|
2132
2356
|
|
2133
2357
|
|
2134
2358
|
|
2135
2359
|
|
2136
2360
|
|
2137
|
-
#### [Get List Tags](https://developers.klaviyo.com/en/v2024-
|
2361
|
+
#### [Get List Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_tags)
|
2138
2362
|
|
2139
2363
|
```ruby
|
2140
2364
|
KlaviyoAPI::Lists.get_list_tags(id, opts)
|
@@ -2144,7 +2368,7 @@ KlaviyoAPI::Lists.get_list_tags(id, opts)
|
|
2144
2368
|
|
2145
2369
|
|
2146
2370
|
|
2147
|
-
#### [Get Lists](https://developers.klaviyo.com/en/v2024-
|
2371
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2024-10-15/reference/get_lists)
|
2148
2372
|
|
2149
2373
|
```ruby
|
2150
2374
|
KlaviyoAPI::Lists.get_lists(opts)
|
@@ -2154,7 +2378,35 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
2154
2378
|
|
2155
2379
|
|
2156
2380
|
|
2157
|
-
#### [
|
2381
|
+
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_list)
|
2382
|
+
|
2383
|
+
```ruby
|
2384
|
+
KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts)
|
2385
|
+
```
|
2386
|
+
##### Method alias:
|
2387
|
+
```ruby
|
2388
|
+
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
2389
|
+
```
|
2390
|
+
|
2391
|
+
|
2392
|
+
|
2393
|
+
|
2394
|
+
|
2395
|
+
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_list)
|
2396
|
+
|
2397
|
+
```ruby
|
2398
|
+
KlaviyoAPI::Lists.get_tag_ids_for_list(id)
|
2399
|
+
```
|
2400
|
+
##### Method alias:
|
2401
|
+
```ruby
|
2402
|
+
KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
2403
|
+
```
|
2404
|
+
|
2405
|
+
|
2406
|
+
|
2407
|
+
|
2408
|
+
|
2409
|
+
#### [Update List](https://developers.klaviyo.com/en/v2024-10-15/reference/update_list)
|
2158
2410
|
|
2159
2411
|
```ruby
|
2160
2412
|
KlaviyoAPI::Lists.update_list(id, body)
|
@@ -2168,7 +2420,7 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
2168
2420
|
## Metrics
|
2169
2421
|
|
2170
2422
|
|
2171
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2024-
|
2423
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric)
|
2172
2424
|
|
2173
2425
|
```ruby
|
2174
2426
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
@@ -2178,20 +2430,106 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
2178
2430
|
|
2179
2431
|
|
2180
2432
|
|
2181
|
-
#### [Get
|
2433
|
+
#### [Get Metric Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_flow_triggers)
|
2182
2434
|
|
2183
2435
|
```ruby
|
2184
|
-
KlaviyoAPI::Metrics.
|
2436
|
+
KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts)
|
2185
2437
|
```
|
2186
2438
|
|
2187
2439
|
|
2188
2440
|
|
2189
2441
|
|
2190
2442
|
|
2191
|
-
#### [
|
2443
|
+
#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_for_metric_property)
|
2192
2444
|
|
2193
2445
|
```ruby
|
2194
|
-
KlaviyoAPI::Metrics.
|
2446
|
+
KlaviyoAPI::Metrics.get_metric_for_metric_property(id, opts)
|
2447
|
+
```
|
2448
|
+
##### Method alias:
|
2449
|
+
```ruby
|
2450
|
+
KlaviyoAPI::Metrics.get_metric_property_metric(id, opts)
|
2451
|
+
```
|
2452
|
+
|
2453
|
+
|
2454
|
+
|
2455
|
+
|
2456
|
+
|
2457
|
+
#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_id_for_metric_property)
|
2458
|
+
|
2459
|
+
```ruby
|
2460
|
+
KlaviyoAPI::Metrics.get_metric_id_for_metric_property(id)
|
2461
|
+
```
|
2462
|
+
##### Method alias:
|
2463
|
+
```ruby
|
2464
|
+
KlaviyoAPI::Metrics.get_metric_property_relationships_metric(id)
|
2465
|
+
```
|
2466
|
+
|
2467
|
+
|
2468
|
+
|
2469
|
+
|
2470
|
+
|
2471
|
+
#### [Get Metric Property](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_property)
|
2472
|
+
|
2473
|
+
```ruby
|
2474
|
+
KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
2475
|
+
```
|
2476
|
+
|
2477
|
+
|
2478
|
+
|
2479
|
+
|
2480
|
+
|
2481
|
+
#### [Get Metric Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_relationships_flow_triggers)
|
2482
|
+
|
2483
|
+
```ruby
|
2484
|
+
KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
2485
|
+
```
|
2486
|
+
|
2487
|
+
|
2488
|
+
|
2489
|
+
|
2490
|
+
|
2491
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metrics)
|
2492
|
+
|
2493
|
+
```ruby
|
2494
|
+
KlaviyoAPI::Metrics.get_metrics(opts)
|
2495
|
+
```
|
2496
|
+
|
2497
|
+
|
2498
|
+
|
2499
|
+
|
2500
|
+
|
2501
|
+
#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_properties_for_metric)
|
2502
|
+
|
2503
|
+
```ruby
|
2504
|
+
KlaviyoAPI::Metrics.get_properties_for_metric(id, opts)
|
2505
|
+
```
|
2506
|
+
##### Method alias:
|
2507
|
+
```ruby
|
2508
|
+
KlaviyoAPI::Metrics.get_metric_metric_properties(id, opts)
|
2509
|
+
```
|
2510
|
+
|
2511
|
+
|
2512
|
+
|
2513
|
+
|
2514
|
+
|
2515
|
+
#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_property_ids_for_metric)
|
2516
|
+
|
2517
|
+
```ruby
|
2518
|
+
KlaviyoAPI::Metrics.get_property_ids_for_metric(id)
|
2519
|
+
```
|
2520
|
+
##### Method alias:
|
2521
|
+
```ruby
|
2522
|
+
KlaviyoAPI::Metrics.get_metric_relationships_metric_properties(id)
|
2523
|
+
```
|
2524
|
+
|
2525
|
+
|
2526
|
+
|
2527
|
+
|
2528
|
+
|
2529
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2024-10-15/reference/query_metric_aggregates)
|
2530
|
+
|
2531
|
+
```ruby
|
2532
|
+
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
2195
2533
|
```
|
2196
2534
|
##### Method alias:
|
2197
2535
|
```ruby
|
@@ -2206,7 +2544,79 @@ KlaviyoAPI::Metrics.create_metric_aggregate(body)
|
|
2206
2544
|
## Profiles
|
2207
2545
|
|
2208
2546
|
|
2209
|
-
#### [
|
2547
|
+
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_subscribe_profiles)
|
2548
|
+
|
2549
|
+
```ruby
|
2550
|
+
KlaviyoAPI::Profiles.bulk_subscribe_profiles(body)
|
2551
|
+
```
|
2552
|
+
##### Method alias:
|
2553
|
+
```ruby
|
2554
|
+
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
2555
|
+
```
|
2556
|
+
##### Method alias:
|
2557
|
+
```ruby
|
2558
|
+
KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body)
|
2559
|
+
```
|
2560
|
+
|
2561
|
+
|
2562
|
+
|
2563
|
+
|
2564
|
+
|
2565
|
+
#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_suppress_profiles)
|
2566
|
+
|
2567
|
+
```ruby
|
2568
|
+
KlaviyoAPI::Profiles.bulk_suppress_profiles(body)
|
2569
|
+
```
|
2570
|
+
##### Method alias:
|
2571
|
+
```ruby
|
2572
|
+
KlaviyoAPI::Profiles.suppress_profiles(body)
|
2573
|
+
```
|
2574
|
+
##### Method alias:
|
2575
|
+
```ruby
|
2576
|
+
KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body)
|
2577
|
+
```
|
2578
|
+
|
2579
|
+
|
2580
|
+
|
2581
|
+
|
2582
|
+
|
2583
|
+
#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_unsubscribe_profiles)
|
2584
|
+
|
2585
|
+
```ruby
|
2586
|
+
KlaviyoAPI::Profiles.bulk_unsubscribe_profiles(body)
|
2587
|
+
```
|
2588
|
+
##### Method alias:
|
2589
|
+
```ruby
|
2590
|
+
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
2591
|
+
```
|
2592
|
+
##### Method alias:
|
2593
|
+
```ruby
|
2594
|
+
KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body)
|
2595
|
+
```
|
2596
|
+
|
2597
|
+
|
2598
|
+
|
2599
|
+
|
2600
|
+
|
2601
|
+
#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_unsuppress_profiles)
|
2602
|
+
|
2603
|
+
```ruby
|
2604
|
+
KlaviyoAPI::Profiles.bulk_unsuppress_profiles(body)
|
2605
|
+
```
|
2606
|
+
##### Method alias:
|
2607
|
+
```ruby
|
2608
|
+
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
2609
|
+
```
|
2610
|
+
##### Method alias:
|
2611
|
+
```ruby
|
2612
|
+
KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body)
|
2613
|
+
```
|
2614
|
+
|
2615
|
+
|
2616
|
+
|
2617
|
+
|
2618
|
+
|
2619
|
+
#### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_or_update_profile)
|
2210
2620
|
|
2211
2621
|
```ruby
|
2212
2622
|
KlaviyoAPI::Profiles.create_or_update_profile(body)
|
@@ -2220,7 +2630,7 @@ KlaviyoAPI::Profiles.create_profile_import(body)
|
|
2220
2630
|
|
2221
2631
|
|
2222
2632
|
|
2223
|
-
#### [Create Profile](https://developers.klaviyo.com/en/v2024-
|
2633
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_profile)
|
2224
2634
|
|
2225
2635
|
```ruby
|
2226
2636
|
KlaviyoAPI::Profiles.create_profile(body)
|
@@ -2230,7 +2640,7 @@ KlaviyoAPI::Profiles.create_profile(body)
|
|
2230
2640
|
|
2231
2641
|
|
2232
2642
|
|
2233
|
-
#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2024-
|
2643
|
+
#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2024-10-15/reference/create_push_token)
|
2234
2644
|
|
2235
2645
|
```ruby
|
2236
2646
|
KlaviyoAPI::Profiles.create_push_token(body)
|
@@ -2240,8 +2650,12 @@ KlaviyoAPI::Profiles.create_push_token(body)
|
|
2240
2650
|
|
2241
2651
|
|
2242
2652
|
|
2243
|
-
#### [Get Bulk
|
2653
|
+
#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_import_profiles_job)
|
2244
2654
|
|
2655
|
+
```ruby
|
2656
|
+
KlaviyoAPI::Profiles.get_bulk_import_profiles_job(job_id, opts)
|
2657
|
+
```
|
2658
|
+
##### Method alias:
|
2245
2659
|
```ruby
|
2246
2660
|
KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
|
2247
2661
|
```
|
@@ -2254,284 +2668,538 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts)
|
|
2254
2668
|
|
2255
2669
|
|
2256
2670
|
|
2257
|
-
#### [Get Bulk
|
2671
|
+
#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_import_profiles_jobs)
|
2672
|
+
|
2673
|
+
```ruby
|
2674
|
+
KlaviyoAPI::Profiles.get_bulk_import_profiles_jobs(opts)
|
2675
|
+
```
|
2676
|
+
##### Method alias:
|
2677
|
+
```ruby
|
2678
|
+
KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
|
2679
|
+
```
|
2680
|
+
##### Method alias:
|
2681
|
+
```ruby
|
2682
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts)
|
2683
|
+
```
|
2684
|
+
|
2685
|
+
|
2686
|
+
|
2687
|
+
|
2688
|
+
|
2689
|
+
#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_suppress_profiles_job)
|
2690
|
+
|
2691
|
+
```ruby
|
2692
|
+
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_job(job_id, opts)
|
2693
|
+
```
|
2694
|
+
##### Method alias:
|
2695
|
+
```ruby
|
2696
|
+
KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_job(job_id, opts)
|
2697
|
+
```
|
2698
|
+
|
2699
|
+
|
2700
|
+
|
2701
|
+
|
2702
|
+
|
2703
|
+
#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_suppress_profiles_jobs)
|
2704
|
+
|
2705
|
+
```ruby
|
2706
|
+
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_jobs(opts)
|
2707
|
+
```
|
2708
|
+
##### Method alias:
|
2709
|
+
```ruby
|
2710
|
+
KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_jobs(opts)
|
2711
|
+
```
|
2712
|
+
|
2713
|
+
|
2714
|
+
|
2715
|
+
|
2716
|
+
|
2717
|
+
#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_unsuppress_profiles_job)
|
2718
|
+
|
2719
|
+
```ruby
|
2720
|
+
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_job(job_id, opts)
|
2721
|
+
```
|
2722
|
+
##### Method alias:
|
2723
|
+
```ruby
|
2724
|
+
KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_job(job_id, opts)
|
2725
|
+
```
|
2726
|
+
|
2727
|
+
|
2728
|
+
|
2729
|
+
|
2730
|
+
|
2731
|
+
#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2024-10-15/reference/get_bulk_unsuppress_profiles_jobs)
|
2732
|
+
|
2733
|
+
```ruby
|
2734
|
+
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_jobs(opts)
|
2735
|
+
```
|
2736
|
+
##### Method alias:
|
2737
|
+
```ruby
|
2738
|
+
KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_jobs(opts)
|
2739
|
+
```
|
2740
|
+
|
2741
|
+
|
2742
|
+
|
2743
|
+
|
2744
|
+
|
2745
|
+
#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_errors_for_bulk_import_profiles_job)
|
2746
|
+
|
2747
|
+
```ruby
|
2748
|
+
KlaviyoAPI::Profiles.get_errors_for_bulk_import_profiles_job(id, opts)
|
2749
|
+
```
|
2750
|
+
##### Method alias:
|
2751
|
+
```ruby
|
2752
|
+
KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
|
2753
|
+
```
|
2754
|
+
##### Method alias:
|
2755
|
+
```ruby
|
2756
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
|
2757
|
+
```
|
2758
|
+
|
2759
|
+
|
2760
|
+
|
2761
|
+
|
2762
|
+
|
2763
|
+
#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_for_bulk_import_profiles_job)
|
2764
|
+
|
2765
|
+
```ruby
|
2766
|
+
KlaviyoAPI::Profiles.get_list_for_bulk_import_profiles_job(id, opts)
|
2767
|
+
```
|
2768
|
+
##### Method alias:
|
2769
|
+
```ruby
|
2770
|
+
KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
|
2771
|
+
```
|
2772
|
+
##### Method alias:
|
2773
|
+
```ruby
|
2774
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
|
2775
|
+
```
|
2776
|
+
|
2777
|
+
|
2778
|
+
|
2779
|
+
|
2780
|
+
|
2781
|
+
#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_ids_for_bulk_import_profiles_job)
|
2782
|
+
|
2783
|
+
```ruby
|
2784
|
+
KlaviyoAPI::Profiles.get_list_ids_for_bulk_import_profiles_job(id)
|
2785
|
+
```
|
2786
|
+
##### Method alias:
|
2787
|
+
```ruby
|
2788
|
+
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
|
2789
|
+
```
|
2790
|
+
##### Method alias:
|
2791
|
+
```ruby
|
2792
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
|
2793
|
+
```
|
2794
|
+
|
2795
|
+
|
2796
|
+
|
2797
|
+
|
2798
|
+
|
2799
|
+
#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_ids_for_profile)
|
2800
|
+
|
2801
|
+
```ruby
|
2802
|
+
KlaviyoAPI::Profiles.get_list_ids_for_profile(id)
|
2803
|
+
```
|
2804
|
+
##### Method alias:
|
2805
|
+
```ruby
|
2806
|
+
KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
|
2807
|
+
```
|
2808
|
+
|
2809
|
+
|
2810
|
+
|
2811
|
+
|
2812
|
+
|
2813
|
+
#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/get_lists_for_profile)
|
2814
|
+
|
2815
|
+
```ruby
|
2816
|
+
KlaviyoAPI::Profiles.get_lists_for_profile(id, opts)
|
2817
|
+
```
|
2818
|
+
##### Method alias:
|
2819
|
+
```ruby
|
2820
|
+
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
|
2821
|
+
```
|
2822
|
+
|
2823
|
+
|
2824
|
+
|
2825
|
+
|
2826
|
+
|
2827
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile)
|
2828
|
+
|
2829
|
+
```ruby
|
2830
|
+
KlaviyoAPI::Profiles.get_profile(id, opts)
|
2831
|
+
```
|
2832
|
+
|
2833
|
+
|
2834
|
+
|
2835
|
+
|
2836
|
+
|
2837
|
+
#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_bulk_import_profiles_job)
|
2838
|
+
|
2839
|
+
```ruby
|
2840
|
+
KlaviyoAPI::Profiles.get_profile_ids_for_bulk_import_profiles_job(id, opts)
|
2841
|
+
```
|
2842
|
+
##### Method alias:
|
2843
|
+
```ruby
|
2844
|
+
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts)
|
2845
|
+
```
|
2846
|
+
##### Method alias:
|
2847
|
+
```ruby
|
2848
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_profiles(id, opts)
|
2849
|
+
```
|
2850
|
+
|
2851
|
+
|
2852
|
+
|
2853
|
+
|
2854
|
+
|
2855
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles)
|
2856
|
+
|
2857
|
+
```ruby
|
2858
|
+
KlaviyoAPI::Profiles.get_profiles(opts)
|
2859
|
+
```
|
2860
|
+
|
2861
|
+
|
2862
|
+
|
2863
|
+
|
2864
|
+
|
2865
|
+
#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_bulk_import_profiles_job)
|
2866
|
+
|
2867
|
+
```ruby
|
2868
|
+
KlaviyoAPI::Profiles.get_profiles_for_bulk_import_profiles_job(id, opts)
|
2869
|
+
```
|
2870
|
+
##### Method alias:
|
2871
|
+
```ruby
|
2872
|
+
KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
|
2873
|
+
```
|
2874
|
+
##### Method alias:
|
2875
|
+
```ruby
|
2876
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts)
|
2877
|
+
```
|
2878
|
+
|
2879
|
+
|
2880
|
+
|
2881
|
+
|
2882
|
+
|
2883
|
+
#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment_ids_for_profile)
|
2884
|
+
|
2885
|
+
```ruby
|
2886
|
+
KlaviyoAPI::Profiles.get_segment_ids_for_profile(id)
|
2887
|
+
```
|
2888
|
+
##### Method alias:
|
2889
|
+
```ruby
|
2890
|
+
KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
|
2891
|
+
```
|
2892
|
+
|
2893
|
+
|
2894
|
+
|
2895
|
+
|
2896
|
+
|
2897
|
+
#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segments_for_profile)
|
2898
|
+
|
2899
|
+
```ruby
|
2900
|
+
KlaviyoAPI::Profiles.get_segments_for_profile(id, opts)
|
2901
|
+
```
|
2902
|
+
##### Method alias:
|
2903
|
+
```ruby
|
2904
|
+
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
|
2905
|
+
```
|
2906
|
+
|
2907
|
+
|
2908
|
+
|
2909
|
+
|
2910
|
+
|
2911
|
+
#### [Merge Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/merge_profiles)
|
2912
|
+
|
2913
|
+
```ruby
|
2914
|
+
KlaviyoAPI::Profiles.merge_profiles(body)
|
2915
|
+
```
|
2916
|
+
##### Method alias:
|
2917
|
+
```ruby
|
2918
|
+
KlaviyoAPI::Profiles.create_profile_merge(body)
|
2919
|
+
```
|
2920
|
+
|
2921
|
+
|
2922
|
+
|
2923
|
+
|
2924
|
+
|
2925
|
+
#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-10-15/reference/spawn_bulk_profile_import_job)
|
2926
|
+
|
2927
|
+
```ruby
|
2928
|
+
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
2929
|
+
```
|
2930
|
+
##### Method alias:
|
2931
|
+
```ruby
|
2932
|
+
KlaviyoAPI::Profiles.bulk_import_profiles(body)
|
2933
|
+
```
|
2934
|
+
##### Method alias:
|
2935
|
+
```ruby
|
2936
|
+
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
2937
|
+
```
|
2938
|
+
|
2939
|
+
|
2940
|
+
|
2941
|
+
|
2942
|
+
|
2943
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/update_profile)
|
2944
|
+
|
2945
|
+
```ruby
|
2946
|
+
KlaviyoAPI::Profiles.update_profile(id, body)
|
2947
|
+
```
|
2948
|
+
|
2949
|
+
|
2950
|
+
|
2951
|
+
|
2952
|
+
|
2953
|
+
|
2954
|
+
## Reporting
|
2955
|
+
|
2956
|
+
|
2957
|
+
#### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-10-15/reference/query_campaign_values)
|
2258
2958
|
|
2259
2959
|
```ruby
|
2260
|
-
KlaviyoAPI::
|
2960
|
+
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
2261
2961
|
```
|
2262
2962
|
##### Method alias:
|
2263
2963
|
```ruby
|
2264
|
-
KlaviyoAPI::
|
2964
|
+
KlaviyoAPI::Reporting.create_campaign_value_report(body, opts)
|
2265
2965
|
```
|
2266
2966
|
|
2267
2967
|
|
2268
2968
|
|
2269
2969
|
|
2270
2970
|
|
2271
|
-
#### [
|
2971
|
+
#### [Query Flow Series](https://developers.klaviyo.com/en/v2024-10-15/reference/query_flow_series)
|
2272
2972
|
|
2273
2973
|
```ruby
|
2274
|
-
KlaviyoAPI::
|
2974
|
+
KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
2275
2975
|
```
|
2276
2976
|
##### Method alias:
|
2277
2977
|
```ruby
|
2278
|
-
KlaviyoAPI::
|
2978
|
+
KlaviyoAPI::Reporting.create_flow_sery_report(body, opts)
|
2279
2979
|
```
|
2280
2980
|
|
2281
2981
|
|
2282
2982
|
|
2283
2983
|
|
2284
2984
|
|
2285
|
-
#### [
|
2985
|
+
#### [Query Flow Values](https://developers.klaviyo.com/en/v2024-10-15/reference/query_flow_values)
|
2286
2986
|
|
2287
2987
|
```ruby
|
2288
|
-
KlaviyoAPI::
|
2988
|
+
KlaviyoAPI::Reporting.query_flow_values(body, opts)
|
2289
2989
|
```
|
2290
2990
|
##### Method alias:
|
2291
2991
|
```ruby
|
2292
|
-
KlaviyoAPI::
|
2992
|
+
KlaviyoAPI::Reporting.create_flow_value_report(body, opts)
|
2293
2993
|
```
|
2294
2994
|
|
2295
2995
|
|
2296
2996
|
|
2297
2997
|
|
2298
2998
|
|
2299
|
-
#### [
|
2999
|
+
#### [Query Form Series](https://developers.klaviyo.com/en/v2024-10-15/reference/query_form_series)
|
2300
3000
|
|
2301
3001
|
```ruby
|
2302
|
-
KlaviyoAPI::
|
3002
|
+
KlaviyoAPI::Reporting.query_form_series(body)
|
2303
3003
|
```
|
2304
3004
|
##### Method alias:
|
2305
3005
|
```ruby
|
2306
|
-
KlaviyoAPI::
|
3006
|
+
KlaviyoAPI::Reporting.create_form_sery_report(body)
|
2307
3007
|
```
|
2308
3008
|
|
2309
3009
|
|
2310
3010
|
|
2311
3011
|
|
2312
3012
|
|
2313
|
-
#### [
|
3013
|
+
#### [Query Form Values](https://developers.klaviyo.com/en/v2024-10-15/reference/query_form_values)
|
2314
3014
|
|
2315
3015
|
```ruby
|
2316
|
-
KlaviyoAPI::
|
3016
|
+
KlaviyoAPI::Reporting.query_form_values(body)
|
2317
3017
|
```
|
2318
3018
|
##### Method alias:
|
2319
3019
|
```ruby
|
2320
|
-
KlaviyoAPI::
|
3020
|
+
KlaviyoAPI::Reporting.create_form_value_report(body)
|
2321
3021
|
```
|
2322
3022
|
|
2323
3023
|
|
2324
3024
|
|
2325
3025
|
|
2326
3026
|
|
2327
|
-
#### [
|
3027
|
+
#### [Query Segment Series](https://developers.klaviyo.com/en/v2024-10-15/reference/query_segment_series)
|
2328
3028
|
|
2329
3029
|
```ruby
|
2330
|
-
KlaviyoAPI::
|
3030
|
+
KlaviyoAPI::Reporting.query_segment_series(body)
|
2331
3031
|
```
|
2332
3032
|
##### Method alias:
|
2333
3033
|
```ruby
|
2334
|
-
KlaviyoAPI::
|
3034
|
+
KlaviyoAPI::Reporting.create_segment_sery_report(body)
|
2335
3035
|
```
|
2336
3036
|
|
2337
3037
|
|
2338
3038
|
|
2339
3039
|
|
2340
3040
|
|
2341
|
-
#### [
|
3041
|
+
#### [Query Segment Values](https://developers.klaviyo.com/en/v2024-10-15/reference/query_segment_values)
|
2342
3042
|
|
2343
3043
|
```ruby
|
2344
|
-
KlaviyoAPI::
|
3044
|
+
KlaviyoAPI::Reporting.query_segment_values(body)
|
3045
|
+
```
|
3046
|
+
##### Method alias:
|
3047
|
+
```ruby
|
3048
|
+
KlaviyoAPI::Reporting.create_segment_value_report(body)
|
2345
3049
|
```
|
2346
3050
|
|
2347
3051
|
|
2348
3052
|
|
2349
3053
|
|
2350
3054
|
|
2351
|
-
#### [Get Profile Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profile_lists)
|
2352
|
-
|
2353
|
-
```ruby
|
2354
|
-
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
|
2355
|
-
```
|
2356
|
-
|
2357
|
-
|
2358
3055
|
|
3056
|
+
## Reviews
|
2359
3057
|
|
2360
3058
|
|
2361
|
-
#### [Get
|
3059
|
+
#### [Get Review](https://developers.klaviyo.com/en/v2024-10-15/reference/get_review)
|
2362
3060
|
|
2363
3061
|
```ruby
|
2364
|
-
KlaviyoAPI::
|
3062
|
+
KlaviyoAPI::Reviews.get_review(id, opts)
|
2365
3063
|
```
|
2366
3064
|
|
2367
3065
|
|
2368
3066
|
|
2369
3067
|
|
2370
3068
|
|
2371
|
-
#### [Get
|
3069
|
+
#### [Get Reviews](https://developers.klaviyo.com/en/v2024-10-15/reference/get_reviews)
|
2372
3070
|
|
2373
3071
|
```ruby
|
2374
|
-
KlaviyoAPI::
|
3072
|
+
KlaviyoAPI::Reviews.get_reviews(opts)
|
2375
3073
|
```
|
2376
3074
|
|
2377
3075
|
|
2378
3076
|
|
2379
3077
|
|
2380
3078
|
|
2381
|
-
#### [Get Profile Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profile_segments)
|
2382
|
-
|
2383
|
-
```ruby
|
2384
|
-
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
|
2385
|
-
```
|
2386
|
-
|
2387
|
-
|
2388
3079
|
|
3080
|
+
## Segments
|
2389
3081
|
|
2390
3082
|
|
2391
|
-
#### [
|
3083
|
+
#### [Create Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/create_segment)
|
2392
3084
|
|
2393
3085
|
```ruby
|
2394
|
-
KlaviyoAPI::
|
3086
|
+
KlaviyoAPI::Segments.create_segment(body)
|
2395
3087
|
```
|
2396
3088
|
|
2397
3089
|
|
2398
3090
|
|
2399
3091
|
|
2400
3092
|
|
2401
|
-
#### [
|
3093
|
+
#### [Delete Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_segment)
|
2402
3094
|
|
2403
3095
|
```ruby
|
2404
|
-
KlaviyoAPI::
|
2405
|
-
```
|
2406
|
-
##### Method alias:
|
2407
|
-
```ruby
|
2408
|
-
KlaviyoAPI::Profiles.create_profile_merge(body)
|
3096
|
+
KlaviyoAPI::Segments.delete_segment(id)
|
2409
3097
|
```
|
2410
3098
|
|
2411
3099
|
|
2412
3100
|
|
2413
3101
|
|
2414
3102
|
|
2415
|
-
#### [
|
3103
|
+
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_segment)
|
2416
3104
|
|
2417
3105
|
```ruby
|
2418
|
-
KlaviyoAPI::
|
3106
|
+
KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts)
|
2419
3107
|
```
|
2420
3108
|
##### Method alias:
|
2421
3109
|
```ruby
|
2422
|
-
KlaviyoAPI::
|
3110
|
+
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
2423
3111
|
```
|
2424
3112
|
|
2425
3113
|
|
2426
3114
|
|
2427
3115
|
|
2428
3116
|
|
2429
|
-
#### [
|
3117
|
+
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_segment)
|
2430
3118
|
|
2431
3119
|
```ruby
|
2432
|
-
KlaviyoAPI::
|
3120
|
+
KlaviyoAPI::Segments.get_profiles_for_segment(id, opts)
|
2433
3121
|
```
|
2434
3122
|
##### Method alias:
|
2435
3123
|
```ruby
|
2436
|
-
KlaviyoAPI::
|
3124
|
+
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
2437
3125
|
```
|
2438
3126
|
|
2439
3127
|
|
2440
3128
|
|
2441
3129
|
|
2442
3130
|
|
2443
|
-
#### [
|
3131
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment)
|
2444
3132
|
|
2445
3133
|
```ruby
|
2446
|
-
KlaviyoAPI::
|
2447
|
-
```
|
2448
|
-
##### Method alias:
|
2449
|
-
```ruby
|
2450
|
-
KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body)
|
3134
|
+
KlaviyoAPI::Segments.get_segment(id, opts)
|
2451
3135
|
```
|
2452
3136
|
|
2453
3137
|
|
2454
3138
|
|
2455
3139
|
|
2456
3140
|
|
2457
|
-
#### [
|
3141
|
+
#### [Get Segment Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment_flow_triggers)
|
2458
3142
|
|
2459
3143
|
```ruby
|
2460
|
-
KlaviyoAPI::
|
2461
|
-
```
|
2462
|
-
##### Method alias:
|
2463
|
-
```ruby
|
2464
|
-
KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body)
|
3144
|
+
KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts)
|
2465
3145
|
```
|
2466
3146
|
|
2467
3147
|
|
2468
3148
|
|
2469
3149
|
|
2470
3150
|
|
2471
|
-
#### [
|
3151
|
+
#### [Get Segment Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment_relationships_flow_triggers)
|
2472
3152
|
|
2473
3153
|
```ruby
|
2474
|
-
KlaviyoAPI::
|
2475
|
-
```
|
2476
|
-
##### Method alias:
|
2477
|
-
```ruby
|
2478
|
-
KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body)
|
3154
|
+
KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id)
|
2479
3155
|
```
|
2480
3156
|
|
2481
3157
|
|
2482
3158
|
|
2483
3159
|
|
2484
3160
|
|
2485
|
-
#### [
|
3161
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segments)
|
2486
3162
|
|
2487
3163
|
```ruby
|
2488
|
-
KlaviyoAPI::
|
3164
|
+
KlaviyoAPI::Segments.get_segments(opts)
|
2489
3165
|
```
|
2490
3166
|
|
2491
3167
|
|
2492
3168
|
|
2493
3169
|
|
2494
3170
|
|
2495
|
-
|
2496
|
-
## Reporting
|
2497
|
-
|
2498
|
-
|
2499
|
-
#### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-07-15/reference/query_campaign_values)
|
3171
|
+
#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_segment)
|
2500
3172
|
|
2501
3173
|
```ruby
|
2502
|
-
KlaviyoAPI::
|
3174
|
+
KlaviyoAPI::Segments.get_tag_ids_for_segment(id)
|
2503
3175
|
```
|
2504
3176
|
##### Method alias:
|
2505
3177
|
```ruby
|
2506
|
-
KlaviyoAPI::
|
3178
|
+
KlaviyoAPI::Segments.get_segment_relationships_tags(id)
|
2507
3179
|
```
|
2508
3180
|
|
2509
3181
|
|
2510
3182
|
|
2511
3183
|
|
2512
3184
|
|
2513
|
-
#### [
|
3185
|
+
#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_segment)
|
2514
3186
|
|
2515
3187
|
```ruby
|
2516
|
-
KlaviyoAPI::
|
3188
|
+
KlaviyoAPI::Segments.get_tags_for_segment(id, opts)
|
2517
3189
|
```
|
2518
3190
|
##### Method alias:
|
2519
3191
|
```ruby
|
2520
|
-
KlaviyoAPI::
|
3192
|
+
KlaviyoAPI::Segments.get_segment_tags(id, opts)
|
2521
3193
|
```
|
2522
3194
|
|
2523
3195
|
|
2524
3196
|
|
2525
3197
|
|
2526
3198
|
|
2527
|
-
#### [
|
3199
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/update_segment)
|
2528
3200
|
|
2529
3201
|
```ruby
|
2530
|
-
KlaviyoAPI::
|
2531
|
-
```
|
2532
|
-
##### Method alias:
|
2533
|
-
```ruby
|
2534
|
-
KlaviyoAPI::Reporting.create_flow_value_report(body, opts)
|
3202
|
+
KlaviyoAPI::Segments.update_segment(id, body)
|
2535
3203
|
```
|
2536
3204
|
|
2537
3205
|
|
@@ -2539,201 +3207,207 @@ KlaviyoAPI::Reporting.create_flow_value_report(body, opts)
|
|
2539
3207
|
|
2540
3208
|
|
2541
3209
|
|
2542
|
-
##
|
3210
|
+
## Tags
|
2543
3211
|
|
2544
3212
|
|
2545
|
-
#### [Create
|
3213
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/create_tag)
|
2546
3214
|
|
2547
3215
|
```ruby
|
2548
|
-
KlaviyoAPI::
|
3216
|
+
KlaviyoAPI::Tags.create_tag(body)
|
2549
3217
|
```
|
2550
3218
|
|
2551
3219
|
|
2552
3220
|
|
2553
3221
|
|
2554
3222
|
|
2555
|
-
#### [
|
3223
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2024-10-15/reference/create_tag_group)
|
2556
3224
|
|
2557
3225
|
```ruby
|
2558
|
-
KlaviyoAPI::
|
3226
|
+
KlaviyoAPI::Tags.create_tag_group(body)
|
2559
3227
|
```
|
2560
3228
|
|
2561
3229
|
|
2562
3230
|
|
2563
3231
|
|
2564
3232
|
|
2565
|
-
#### [
|
3233
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_tag)
|
2566
3234
|
|
2567
3235
|
```ruby
|
2568
|
-
KlaviyoAPI::
|
3236
|
+
KlaviyoAPI::Tags.delete_tag(id)
|
2569
3237
|
```
|
2570
3238
|
|
2571
3239
|
|
2572
3240
|
|
2573
3241
|
|
2574
3242
|
|
2575
|
-
#### [
|
3243
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_tag_group)
|
2576
3244
|
|
2577
3245
|
```ruby
|
2578
|
-
KlaviyoAPI::
|
3246
|
+
KlaviyoAPI::Tags.delete_tag_group(id)
|
2579
3247
|
```
|
2580
3248
|
|
2581
3249
|
|
2582
3250
|
|
2583
3251
|
|
2584
3252
|
|
2585
|
-
#### [Get
|
3253
|
+
#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_ids_for_tag)
|
2586
3254
|
|
2587
3255
|
```ruby
|
2588
|
-
KlaviyoAPI::
|
3256
|
+
KlaviyoAPI::Tags.get_campaign_ids_for_tag(id)
|
2589
3257
|
```
|
2590
|
-
|
2591
|
-
|
2592
|
-
|
2593
|
-
|
2594
|
-
|
2595
|
-
#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_segment_relationships_tags)
|
2596
|
-
|
3258
|
+
##### Method alias:
|
2597
3259
|
```ruby
|
2598
|
-
KlaviyoAPI::
|
3260
|
+
KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
|
2599
3261
|
```
|
2600
3262
|
|
2601
3263
|
|
2602
3264
|
|
2603
3265
|
|
2604
3266
|
|
2605
|
-
#### [Get
|
3267
|
+
#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_ids_for_tag)
|
2606
3268
|
|
2607
3269
|
```ruby
|
2608
|
-
KlaviyoAPI::
|
3270
|
+
KlaviyoAPI::Tags.get_flow_ids_for_tag(id)
|
3271
|
+
```
|
3272
|
+
##### Method alias:
|
3273
|
+
```ruby
|
3274
|
+
KlaviyoAPI::Tags.get_tag_relationships_flows(id)
|
2609
3275
|
```
|
2610
3276
|
|
2611
3277
|
|
2612
3278
|
|
2613
3279
|
|
2614
3280
|
|
2615
|
-
#### [Get
|
3281
|
+
#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_ids_for_tag)
|
2616
3282
|
|
2617
3283
|
```ruby
|
2618
|
-
KlaviyoAPI::
|
3284
|
+
KlaviyoAPI::Tags.get_list_ids_for_tag(id)
|
3285
|
+
```
|
3286
|
+
##### Method alias:
|
3287
|
+
```ruby
|
3288
|
+
KlaviyoAPI::Tags.get_tag_relationships_lists(id)
|
2619
3289
|
```
|
2620
3290
|
|
2621
3291
|
|
2622
3292
|
|
2623
3293
|
|
2624
3294
|
|
2625
|
-
#### [
|
3295
|
+
#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment_ids_for_tag)
|
2626
3296
|
|
2627
3297
|
```ruby
|
2628
|
-
KlaviyoAPI::
|
3298
|
+
KlaviyoAPI::Tags.get_segment_ids_for_tag(id)
|
3299
|
+
```
|
3300
|
+
##### Method alias:
|
3301
|
+
```ruby
|
3302
|
+
KlaviyoAPI::Tags.get_tag_relationships_segments(id)
|
2629
3303
|
```
|
2630
3304
|
|
2631
3305
|
|
2632
3306
|
|
2633
3307
|
|
2634
3308
|
|
2635
|
-
|
2636
|
-
## Tags
|
2637
|
-
|
2638
|
-
|
2639
|
-
#### [Create Tag](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag)
|
3309
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag)
|
2640
3310
|
|
2641
3311
|
```ruby
|
2642
|
-
KlaviyoAPI::Tags.
|
3312
|
+
KlaviyoAPI::Tags.get_tag(id, opts)
|
2643
3313
|
```
|
2644
3314
|
|
2645
3315
|
|
2646
3316
|
|
2647
3317
|
|
2648
3318
|
|
2649
|
-
#### [
|
3319
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_group)
|
2650
3320
|
|
2651
3321
|
```ruby
|
2652
|
-
KlaviyoAPI::Tags.
|
3322
|
+
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
2653
3323
|
```
|
2654
3324
|
|
2655
3325
|
|
2656
3326
|
|
2657
3327
|
|
2658
3328
|
|
2659
|
-
#### [
|
3329
|
+
#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_group_for_tag)
|
2660
3330
|
|
2661
3331
|
```ruby
|
2662
|
-
KlaviyoAPI::Tags.
|
3332
|
+
KlaviyoAPI::Tags.get_tag_group_for_tag(id, opts)
|
2663
3333
|
```
|
2664
3334
|
##### Method alias:
|
2665
3335
|
```ruby
|
2666
|
-
KlaviyoAPI::Tags.
|
3336
|
+
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
2667
3337
|
```
|
2668
3338
|
|
2669
3339
|
|
2670
3340
|
|
2671
3341
|
|
2672
3342
|
|
2673
|
-
#### [
|
3343
|
+
#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_group_id_for_tag)
|
2674
3344
|
|
2675
3345
|
```ruby
|
2676
|
-
KlaviyoAPI::Tags.
|
3346
|
+
KlaviyoAPI::Tags.get_tag_group_id_for_tag(id)
|
2677
3347
|
```
|
2678
3348
|
##### Method alias:
|
2679
3349
|
```ruby
|
2680
|
-
KlaviyoAPI::Tags.
|
3350
|
+
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
|
2681
3351
|
```
|
2682
3352
|
|
2683
3353
|
|
2684
3354
|
|
2685
3355
|
|
2686
3356
|
|
2687
|
-
#### [
|
3357
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_groups)
|
2688
3358
|
|
2689
3359
|
```ruby
|
2690
|
-
KlaviyoAPI::Tags.
|
2691
|
-
```
|
2692
|
-
##### Method alias:
|
2693
|
-
```ruby
|
2694
|
-
KlaviyoAPI::Tags.create_tag_relationships_list(id, body)
|
3360
|
+
KlaviyoAPI::Tags.get_tag_groups(opts)
|
2695
3361
|
```
|
2696
3362
|
|
2697
3363
|
|
2698
3364
|
|
2699
3365
|
|
2700
3366
|
|
2701
|
-
#### [
|
3367
|
+
#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_tag_group)
|
2702
3368
|
|
2703
3369
|
```ruby
|
2704
|
-
KlaviyoAPI::Tags.
|
3370
|
+
KlaviyoAPI::Tags.get_tag_ids_for_tag_group(id)
|
2705
3371
|
```
|
2706
3372
|
##### Method alias:
|
2707
3373
|
```ruby
|
2708
|
-
KlaviyoAPI::Tags.
|
3374
|
+
KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
|
2709
3375
|
```
|
2710
3376
|
|
2711
3377
|
|
2712
3378
|
|
2713
3379
|
|
2714
3380
|
|
2715
|
-
#### [
|
3381
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags)
|
2716
3382
|
|
2717
3383
|
```ruby
|
2718
|
-
KlaviyoAPI::Tags.
|
3384
|
+
KlaviyoAPI::Tags.get_tags(opts)
|
2719
3385
|
```
|
2720
3386
|
|
2721
3387
|
|
2722
3388
|
|
2723
3389
|
|
2724
3390
|
|
2725
|
-
#### [
|
3391
|
+
#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_tag_group)
|
2726
3392
|
|
2727
3393
|
```ruby
|
2728
|
-
KlaviyoAPI::Tags.
|
3394
|
+
KlaviyoAPI::Tags.get_tags_for_tag_group(id, opts)
|
3395
|
+
```
|
3396
|
+
##### Method alias:
|
3397
|
+
```ruby
|
3398
|
+
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
2729
3399
|
```
|
2730
3400
|
|
2731
3401
|
|
2732
3402
|
|
2733
3403
|
|
2734
3404
|
|
2735
|
-
#### [
|
3405
|
+
#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_tag_from_campaigns)
|
2736
3406
|
|
3407
|
+
```ruby
|
3408
|
+
KlaviyoAPI::Tags.remove_tag_from_campaigns(id, body)
|
3409
|
+
```
|
3410
|
+
##### Method alias:
|
2737
3411
|
```ruby
|
2738
3412
|
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
|
2739
3413
|
```
|
@@ -2742,8 +3416,12 @@ KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
|
|
2742
3416
|
|
2743
3417
|
|
2744
3418
|
|
2745
|
-
#### [
|
3419
|
+
#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_tag_from_flows)
|
2746
3420
|
|
3421
|
+
```ruby
|
3422
|
+
KlaviyoAPI::Tags.remove_tag_from_flows(id, body)
|
3423
|
+
```
|
3424
|
+
##### Method alias:
|
2747
3425
|
```ruby
|
2748
3426
|
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
|
2749
3427
|
```
|
@@ -2752,8 +3430,12 @@ KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
|
|
2752
3430
|
|
2753
3431
|
|
2754
3432
|
|
2755
|
-
#### [
|
3433
|
+
#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_tag_from_lists)
|
2756
3434
|
|
3435
|
+
```ruby
|
3436
|
+
KlaviyoAPI::Tags.remove_tag_from_lists(id, body)
|
3437
|
+
```
|
3438
|
+
##### Method alias:
|
2757
3439
|
```ruby
|
2758
3440
|
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
|
2759
3441
|
```
|
@@ -2762,8 +3444,12 @@ KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
|
|
2762
3444
|
|
2763
3445
|
|
2764
3446
|
|
2765
|
-
#### [
|
3447
|
+
#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_tag_from_segments)
|
2766
3448
|
|
3449
|
+
```ruby
|
3450
|
+
KlaviyoAPI::Tags.remove_tag_from_segments(id, body)
|
3451
|
+
```
|
3452
|
+
##### Method alias:
|
2767
3453
|
```ruby
|
2768
3454
|
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
|
2769
3455
|
```
|
@@ -2772,214 +3458,274 @@ KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
|
|
2772
3458
|
|
2773
3459
|
|
2774
3460
|
|
2775
|
-
#### [
|
3461
|
+
#### [Tag Campaigns](https://developers.klaviyo.com/en/v2024-10-15/reference/tag_campaigns)
|
2776
3462
|
|
2777
3463
|
```ruby
|
2778
|
-
KlaviyoAPI::Tags.
|
3464
|
+
KlaviyoAPI::Tags.tag_campaigns(id, body)
|
3465
|
+
```
|
3466
|
+
##### Method alias:
|
3467
|
+
```ruby
|
3468
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
3469
|
+
```
|
3470
|
+
##### Method alias:
|
3471
|
+
```ruby
|
3472
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body)
|
2779
3473
|
```
|
2780
3474
|
|
2781
3475
|
|
2782
3476
|
|
2783
3477
|
|
2784
3478
|
|
2785
|
-
#### [
|
3479
|
+
#### [Tag Flows](https://developers.klaviyo.com/en/v2024-10-15/reference/tag_flows)
|
2786
3480
|
|
2787
3481
|
```ruby
|
2788
|
-
KlaviyoAPI::Tags.
|
3482
|
+
KlaviyoAPI::Tags.tag_flows(id, body)
|
3483
|
+
```
|
3484
|
+
##### Method alias:
|
3485
|
+
```ruby
|
3486
|
+
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
3487
|
+
```
|
3488
|
+
##### Method alias:
|
3489
|
+
```ruby
|
3490
|
+
KlaviyoAPI::Tags.create_tag_relationships_flow(id, body)
|
2789
3491
|
```
|
2790
3492
|
|
2791
3493
|
|
2792
3494
|
|
2793
3495
|
|
2794
3496
|
|
2795
|
-
#### [
|
3497
|
+
#### [Tag Lists](https://developers.klaviyo.com/en/v2024-10-15/reference/tag_lists)
|
2796
3498
|
|
2797
3499
|
```ruby
|
2798
|
-
KlaviyoAPI::Tags.
|
3500
|
+
KlaviyoAPI::Tags.tag_lists(id, body)
|
3501
|
+
```
|
3502
|
+
##### Method alias:
|
3503
|
+
```ruby
|
3504
|
+
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
3505
|
+
```
|
3506
|
+
##### Method alias:
|
3507
|
+
```ruby
|
3508
|
+
KlaviyoAPI::Tags.create_tag_relationships_list(id, body)
|
2799
3509
|
```
|
2800
3510
|
|
2801
3511
|
|
2802
3512
|
|
2803
3513
|
|
2804
3514
|
|
2805
|
-
#### [
|
3515
|
+
#### [Tag Segments](https://developers.klaviyo.com/en/v2024-10-15/reference/tag_segments)
|
2806
3516
|
|
2807
3517
|
```ruby
|
2808
|
-
KlaviyoAPI::Tags.
|
3518
|
+
KlaviyoAPI::Tags.tag_segments(id, body)
|
3519
|
+
```
|
3520
|
+
##### Method alias:
|
3521
|
+
```ruby
|
3522
|
+
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
3523
|
+
```
|
3524
|
+
##### Method alias:
|
3525
|
+
```ruby
|
3526
|
+
KlaviyoAPI::Tags.create_tag_relationships_segment(id, body)
|
2809
3527
|
```
|
2810
3528
|
|
2811
3529
|
|
2812
3530
|
|
2813
3531
|
|
2814
3532
|
|
2815
|
-
#### [
|
3533
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2024-10-15/reference/update_tag)
|
2816
3534
|
|
2817
3535
|
```ruby
|
2818
|
-
KlaviyoAPI::Tags.
|
3536
|
+
KlaviyoAPI::Tags.update_tag(id, body)
|
2819
3537
|
```
|
2820
3538
|
|
2821
3539
|
|
2822
3540
|
|
2823
3541
|
|
2824
3542
|
|
2825
|
-
#### [
|
3543
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2024-10-15/reference/update_tag_group)
|
2826
3544
|
|
2827
3545
|
```ruby
|
2828
|
-
KlaviyoAPI::Tags.
|
3546
|
+
KlaviyoAPI::Tags.update_tag_group(id, body)
|
2829
3547
|
```
|
2830
3548
|
|
2831
3549
|
|
2832
3550
|
|
2833
3551
|
|
2834
3552
|
|
2835
|
-
|
3553
|
+
|
3554
|
+
## Templates
|
3555
|
+
|
3556
|
+
|
3557
|
+
#### [Clone Template](https://developers.klaviyo.com/en/v2024-10-15/reference/clone_template)
|
2836
3558
|
|
2837
3559
|
```ruby
|
2838
|
-
KlaviyoAPI::
|
3560
|
+
KlaviyoAPI::Templates.clone_template(body)
|
3561
|
+
```
|
3562
|
+
##### Method alias:
|
3563
|
+
```ruby
|
3564
|
+
KlaviyoAPI::Templates.create_template_clone(body)
|
2839
3565
|
```
|
2840
3566
|
|
2841
3567
|
|
2842
3568
|
|
2843
3569
|
|
2844
3570
|
|
2845
|
-
#### [
|
3571
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2024-10-15/reference/create_template)
|
2846
3572
|
|
2847
3573
|
```ruby
|
2848
|
-
KlaviyoAPI::
|
3574
|
+
KlaviyoAPI::Templates.create_template(body)
|
2849
3575
|
```
|
2850
3576
|
|
2851
3577
|
|
2852
3578
|
|
2853
3579
|
|
2854
3580
|
|
2855
|
-
#### [
|
3581
|
+
#### [Create Universal Content](https://developers.klaviyo.com/en/v2024-10-15/reference/create_universal_content)
|
2856
3582
|
|
2857
3583
|
```ruby
|
2858
|
-
KlaviyoAPI::
|
3584
|
+
KlaviyoAPI::Templates.create_universal_content(body)
|
3585
|
+
```
|
3586
|
+
##### Method alias:
|
3587
|
+
```ruby
|
3588
|
+
KlaviyoAPI::Templates.create_template_universal_content(body)
|
2859
3589
|
```
|
2860
3590
|
|
2861
3591
|
|
2862
3592
|
|
2863
3593
|
|
2864
3594
|
|
2865
|
-
#### [
|
3595
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_template)
|
2866
3596
|
|
2867
3597
|
```ruby
|
2868
|
-
KlaviyoAPI::
|
3598
|
+
KlaviyoAPI::Templates.delete_template(id)
|
2869
3599
|
```
|
2870
3600
|
|
2871
3601
|
|
2872
3602
|
|
2873
3603
|
|
2874
3604
|
|
2875
|
-
#### [
|
3605
|
+
#### [Delete Universal Content](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_universal_content)
|
2876
3606
|
|
2877
3607
|
```ruby
|
2878
|
-
KlaviyoAPI::
|
3608
|
+
KlaviyoAPI::Templates.delete_universal_content(id)
|
3609
|
+
```
|
3610
|
+
##### Method alias:
|
3611
|
+
```ruby
|
3612
|
+
KlaviyoAPI::Templates.delete_template_universal_content(id)
|
2879
3613
|
```
|
2880
3614
|
|
2881
3615
|
|
2882
3616
|
|
2883
3617
|
|
2884
3618
|
|
2885
|
-
#### [Get
|
3619
|
+
#### [Get All Universal Content](https://developers.klaviyo.com/en/v2024-10-15/reference/get_all_universal_content)
|
2886
3620
|
|
2887
3621
|
```ruby
|
2888
|
-
KlaviyoAPI::
|
3622
|
+
KlaviyoAPI::Templates.get_all_universal_content(opts)
|
3623
|
+
```
|
3624
|
+
##### Method alias:
|
3625
|
+
```ruby
|
3626
|
+
KlaviyoAPI::Templates.get_template_universal_content(opts)
|
2889
3627
|
```
|
2890
3628
|
|
2891
3629
|
|
2892
3630
|
|
2893
3631
|
|
2894
3632
|
|
2895
|
-
#### [
|
3633
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template)
|
2896
3634
|
|
2897
3635
|
```ruby
|
2898
|
-
KlaviyoAPI::
|
3636
|
+
KlaviyoAPI::Templates.get_template(id, opts)
|
2899
3637
|
```
|
2900
3638
|
|
2901
3639
|
|
2902
3640
|
|
2903
3641
|
|
2904
3642
|
|
2905
|
-
#### [
|
3643
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2024-10-15/reference/get_templates)
|
2906
3644
|
|
2907
3645
|
```ruby
|
2908
|
-
KlaviyoAPI::
|
3646
|
+
KlaviyoAPI::Templates.get_templates(opts)
|
2909
3647
|
```
|
2910
3648
|
|
2911
3649
|
|
2912
3650
|
|
2913
3651
|
|
2914
3652
|
|
2915
|
-
|
2916
|
-
## Templates
|
2917
|
-
|
2918
|
-
|
2919
|
-
#### [Create Template](https://developers.klaviyo.com/en/v2024-07-15/reference/create_template)
|
3653
|
+
#### [Get Universal Content](https://developers.klaviyo.com/en/v2024-10-15/reference/get_universal_content)
|
2920
3654
|
|
2921
3655
|
```ruby
|
2922
|
-
KlaviyoAPI::Templates.
|
3656
|
+
KlaviyoAPI::Templates.get_universal_content(id, opts)
|
2923
3657
|
```
|
2924
3658
|
|
2925
3659
|
|
2926
3660
|
|
2927
3661
|
|
2928
3662
|
|
2929
|
-
#### [
|
3663
|
+
#### [Render Template](https://developers.klaviyo.com/en/v2024-10-15/reference/render_template)
|
2930
3664
|
|
2931
3665
|
```ruby
|
2932
|
-
KlaviyoAPI::Templates.
|
3666
|
+
KlaviyoAPI::Templates.render_template(body)
|
3667
|
+
```
|
3668
|
+
##### Method alias:
|
3669
|
+
```ruby
|
3670
|
+
KlaviyoAPI::Templates.create_template_render(body)
|
2933
3671
|
```
|
2934
3672
|
|
2935
3673
|
|
2936
3674
|
|
2937
3675
|
|
2938
3676
|
|
2939
|
-
#### [
|
3677
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2024-10-15/reference/update_template)
|
2940
3678
|
|
2941
3679
|
```ruby
|
2942
|
-
KlaviyoAPI::Templates.
|
3680
|
+
KlaviyoAPI::Templates.update_template(id, body)
|
2943
3681
|
```
|
2944
3682
|
|
2945
3683
|
|
2946
3684
|
|
2947
3685
|
|
2948
3686
|
|
2949
|
-
#### [
|
3687
|
+
#### [Update Universal Content](https://developers.klaviyo.com/en/v2024-10-15/reference/update_universal_content)
|
2950
3688
|
|
2951
3689
|
```ruby
|
2952
|
-
KlaviyoAPI::Templates.
|
3690
|
+
KlaviyoAPI::Templates.update_universal_content(id, body)
|
3691
|
+
```
|
3692
|
+
##### Method alias:
|
3693
|
+
```ruby
|
3694
|
+
KlaviyoAPI::Templates.update_template_universal_content(id, body)
|
2953
3695
|
```
|
2954
3696
|
|
2955
3697
|
|
2956
3698
|
|
2957
3699
|
|
2958
3700
|
|
2959
|
-
|
3701
|
+
|
3702
|
+
## Tracking Settings
|
3703
|
+
|
3704
|
+
|
3705
|
+
#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tracking_setting)
|
2960
3706
|
|
2961
3707
|
```ruby
|
2962
|
-
KlaviyoAPI::
|
3708
|
+
KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
|
2963
3709
|
```
|
2964
3710
|
|
2965
3711
|
|
2966
3712
|
|
2967
3713
|
|
2968
3714
|
|
2969
|
-
#### [Get
|
3715
|
+
#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tracking_settings)
|
2970
3716
|
|
2971
3717
|
```ruby
|
2972
|
-
KlaviyoAPI::
|
3718
|
+
KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
|
2973
3719
|
```
|
2974
3720
|
|
2975
3721
|
|
2976
3722
|
|
2977
3723
|
|
2978
3724
|
|
2979
|
-
#### [Update
|
3725
|
+
#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2024-10-15/reference/update_tracking_setting)
|
2980
3726
|
|
2981
3727
|
```ruby
|
2982
|
-
KlaviyoAPI::
|
3728
|
+
KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body)
|
2983
3729
|
```
|
2984
3730
|
|
2985
3731
|
|
@@ -2990,7 +3736,7 @@ KlaviyoAPI::Templates.update_template(id, body)
|
|
2990
3736
|
## Webhooks
|
2991
3737
|
|
2992
3738
|
|
2993
|
-
#### [Create Webhook](https://developers.klaviyo.com/en/v2024-
|
3739
|
+
#### [Create Webhook](https://developers.klaviyo.com/en/v2024-10-15/reference/create_webhook)
|
2994
3740
|
|
2995
3741
|
```ruby
|
2996
3742
|
KlaviyoAPI::Webhooks.create_webhook(body)
|
@@ -3000,7 +3746,7 @@ KlaviyoAPI::Webhooks.create_webhook(body)
|
|
3000
3746
|
|
3001
3747
|
|
3002
3748
|
|
3003
|
-
#### [Delete Webhook](https://developers.klaviyo.com/en/v2024-
|
3749
|
+
#### [Delete Webhook](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_webhook)
|
3004
3750
|
|
3005
3751
|
```ruby
|
3006
3752
|
KlaviyoAPI::Webhooks.delete_webhook(id)
|
@@ -3010,7 +3756,7 @@ KlaviyoAPI::Webhooks.delete_webhook(id)
|
|
3010
3756
|
|
3011
3757
|
|
3012
3758
|
|
3013
|
-
#### [Get Webhook](https://developers.klaviyo.com/en/v2024-
|
3759
|
+
#### [Get Webhook](https://developers.klaviyo.com/en/v2024-10-15/reference/get_webhook)
|
3014
3760
|
|
3015
3761
|
```ruby
|
3016
3762
|
KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
@@ -3020,7 +3766,7 @@ KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
|
3020
3766
|
|
3021
3767
|
|
3022
3768
|
|
3023
|
-
#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2024-
|
3769
|
+
#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2024-10-15/reference/get_webhook_topic)
|
3024
3770
|
|
3025
3771
|
```ruby
|
3026
3772
|
KlaviyoAPI::Webhooks.get_webhook_topic(id)
|
@@ -3030,7 +3776,7 @@ KlaviyoAPI::Webhooks.get_webhook_topic(id)
|
|
3030
3776
|
|
3031
3777
|
|
3032
3778
|
|
3033
|
-
#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2024-
|
3779
|
+
#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2024-10-15/reference/get_webhook_topics)
|
3034
3780
|
|
3035
3781
|
```ruby
|
3036
3782
|
KlaviyoAPI::Webhooks.get_webhook_topics
|
@@ -3040,7 +3786,7 @@ KlaviyoAPI::Webhooks.get_webhook_topics
|
|
3040
3786
|
|
3041
3787
|
|
3042
3788
|
|
3043
|
-
#### [Get Webhooks](https://developers.klaviyo.com/en/v2024-
|
3789
|
+
#### [Get Webhooks](https://developers.klaviyo.com/en/v2024-10-15/reference/get_webhooks)
|
3044
3790
|
|
3045
3791
|
```ruby
|
3046
3792
|
KlaviyoAPI::Webhooks.get_webhooks(opts)
|
@@ -3050,7 +3796,7 @@ KlaviyoAPI::Webhooks.get_webhooks(opts)
|
|
3050
3796
|
|
3051
3797
|
|
3052
3798
|
|
3053
|
-
#### [Update Webhook](https://developers.klaviyo.com/en/v2024-
|
3799
|
+
#### [Update Webhook](https://developers.klaviyo.com/en/v2024-10-15/reference/update_webhook)
|
3054
3800
|
|
3055
3801
|
```ruby
|
3056
3802
|
KlaviyoAPI::Webhooks.update_webhook(id, body)
|