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