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