README.md in klaviyo-api-sdk-11.0.0 vs README.md in klaviyo-api-sdk-11.1.0

- old
+ new

@@ -1,8 +1,8 @@ # Klaviyo Ruby SDK -- SDK version: 11.0.0 +- SDK version: 11.1.0 - API revision: 2024-10-15 ## Helpful Resources - [API Reference](https://developers.klaviyo.com/en/v2024-10-15/reference) @@ -108,17 +108,17 @@ ``` Then install the gem locally: ```shell -gem install ./klaviyo-api-sdk-11.0.0.gem +gem install ./klaviyo-api-sdk-11.1.0.gem ``` Finally add this to the Gemfile: - gem 'klaviyo-api-sdk', '~> 11.0.0' + gem 'klaviyo-api-sdk', '~> 11.1.0' To install directly from rubygems: ```shell gem install klaviyo-api-sdk @@ -170,10 +170,22 @@ begin result = KlaviyoAPI::Catalogs.get_catalog_items(opts) end ``` +## OAuth Authentication + +To use OAuth Authentication, pass an access token instead of an API key: + +```ruby +KlaviyoAPI.configure do |config| + config.access_token = 'your-oauth-access-token' +end +``` + +See our [guide](https://developers.klaviyo.com/en/docs/set_up_oauth) for an overview on setting up an OAuth integration. + ## Error Handling This SDK throws an `ApiException` error when the server returns a non-`2XX` response. ```ruby begin @@ -677,10 +689,14 @@ #### [Get Campaign Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_campaign_tags) ```ruby KlaviyoAPI::Campaigns.get_campaign_tags(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Campaigns.get_tags_for_campaign(id, opts) +``` @@ -701,10 +717,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Campaigns.get_campaign_relationships_messages(id) +``` @@ -715,10 +735,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Campaigns.get_campaign_messages(id, opts) +``` @@ -814,23 +838,27 @@ ## Catalogs -#### [Add Category to Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/add_category_to_catalog_item) +#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/add_categories_to_catalog_item) ```ruby -KlaviyoAPI::Catalogs.add_category_to_catalog_item(id, body) +KlaviyoAPI::Catalogs.add_categories_to_catalog_item(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body) +KlaviyoAPI::Catalogs.add_category_to_catalog_item(id, body) ``` ##### Method alias: ```ruby KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body) +``` @@ -839,15 +867,15 @@ ```ruby KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body) +KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body) +KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body) ``` @@ -1664,39 +1692,47 @@ -#### [Get Code IDs for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_code_ids_for_coupon) +#### [Get Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon) ```ruby -KlaviyoAPI::Coupons.get_code_ids_for_coupon(id, opts) +KlaviyoAPI::Coupons.get_coupon(id, opts) ``` -##### Method alias: -```ruby -KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts) -``` -#### [Get Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon) +#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code) ```ruby -KlaviyoAPI::Coupons.get_coupon(id, opts) +KlaviyoAPI::Coupons.get_coupon_code(id, opts) ``` -#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code) +#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code_ids_for_coupon) ```ruby -KlaviyoAPI::Coupons.get_coupon_code(id, opts) +KlaviyoAPI::Coupons.get_coupon_code_ids_for_coupon(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts) +``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.get_code_ids_for_coupon(id, opts) +``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.get_coupon_relationships_codes(id, opts) +``` @@ -1708,19 +1744,23 @@ -#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_codes_for_coupon) +#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_codes_for_coupon) ```ruby KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts) ``` ##### Method alias: ```ruby KlaviyoAPI::Coupons.get_coupon_coupon_codes(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.get_codes_for_coupon(id, opts) +``` @@ -1836,48 +1876,56 @@ -#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_event_metric) +#### [Get Events](https://developers.klaviyo.com/en/v2024-10-15/reference/get_events) ```ruby -KlaviyoAPI::Events.get_event_metric(id, opts) +KlaviyoAPI::Events.get_events(opts) ``` -#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/get_event_profile) +#### [Get Metric for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_for_event) ```ruby -KlaviyoAPI::Events.get_event_profile(id, opts) +KlaviyoAPI::Events.get_metric_for_event(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Events.get_event_metric(id, opts) +``` -#### [Get Events](https://developers.klaviyo.com/en/v2024-10-15/reference/get_events) +#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_id_for_event) ```ruby -KlaviyoAPI::Events.get_events(opts) +KlaviyoAPI::Events.get_metric_id_for_event(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Events.get_event_relationships_metric(id) +``` -#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_id_for_event) +#### [Get Profile for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_for_event) ```ruby -KlaviyoAPI::Events.get_metric_id_for_event(id) +KlaviyoAPI::Events.get_profile_for_event(id, opts) ``` ##### Method alias: ```ruby -KlaviyoAPI::Events.get_event_relationships_metric(id) +KlaviyoAPI::Events.get_event_profile(id, opts) ``` @@ -1908,10 +1956,24 @@ +#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_for_flow_message) + +```ruby +KlaviyoAPI::Flows.get_action_for_flow_message(id, opts) +``` +##### Method alias: +```ruby +KlaviyoAPI::Flows.get_flow_message_action(id, opts) +``` + + + + + #### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_id_for_flow_message) ```ruby KlaviyoAPI::Flows.get_action_id_for_flow_message(id) ``` @@ -1931,10 +1993,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Flows.get_flow_relationships_actions(id, opts) +``` @@ -1945,10 +2011,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Flows.get_flow_flow_actions(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Flows.get_flow_actions(id, opts) +``` @@ -1970,13 +2040,17 @@ -#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_action_flow) +#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_for_flow_action) ```ruby +KlaviyoAPI::Flows.get_flow_for_flow_action(id, opts) +``` +##### Method alias: +```ruby KlaviyoAPI::Flows.get_flow_action_flow(id, opts) ``` @@ -2004,30 +2078,10 @@ -#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_message_action) - -```ruby -KlaviyoAPI::Flows.get_flow_message_action(id, opts) -``` - - - - - -#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_tags) - -```ruby -KlaviyoAPI::Flows.get_flow_tags(id, opts) -``` - - - - - #### [Get Flows](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows) ```ruby KlaviyoAPI::Flows.get_flows(opts) ``` @@ -2076,10 +2130,24 @@ +#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_flow) + +```ruby +KlaviyoAPI::Flows.get_tags_for_flow(id, opts) +``` +##### Method alias: +```ruby +KlaviyoAPI::Flows.get_flow_tags(id, opts) +``` + + + + + #### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template_for_flow_message) ```ruby KlaviyoAPI::Flows.get_template_for_flow_message(id, opts) ``` @@ -2185,10 +2253,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Forms.get_form_relationships_form_versions(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_relationships_versions(id) +``` @@ -2199,10 +2271,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Forms.get_form_form_versions(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_versions(id, opts) +``` @@ -2270,29 +2346,37 @@ ## Lists -#### [Create List](https://developers.klaviyo.com/en/v2024-10-15/reference/create_list) +#### [Add Profiles to List](https://developers.klaviyo.com/en/v2024-10-15/reference/add_profiles_to_list) ```ruby -KlaviyoAPI::Lists.create_list(body) +KlaviyoAPI::Lists.add_profiles_to_list(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.create_list_relationships(id, body) +``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.create_list_relationships_profile(id, body) +``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.create_list_relationships_profiles(id, body) +``` -#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-10-15/reference/create_list_relationships) +#### [Create List](https://developers.klaviyo.com/en/v2024-10-15/reference/create_list) ```ruby -KlaviyoAPI::Lists.create_list_relationships(id, body) +KlaviyoAPI::Lists.create_list(body) ``` -##### Method alias: -```ruby -KlaviyoAPI::Lists.create_list_relationships_profile(id, body) -``` @@ -2304,107 +2388,135 @@ -#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-10-15/reference/delete_list_relationships) +#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_list) ```ruby -KlaviyoAPI::Lists.delete_list_relationships(id, body) +KlaviyoAPI::Lists.get_flows_triggered_by_list(id, opts) ``` ##### Method alias: ```ruby -KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body) +KlaviyoAPI::Lists.get_flow_triggers_for_list(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.get_list_flow_triggers(id, opts) +``` -#### [Get List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list) +#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_list) ```ruby -KlaviyoAPI::Lists.get_list(id, opts) +KlaviyoAPI::Lists.get_ids_for_flows_triggered_by_list(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.get_flow_trigger_ids_for_list(id) +``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id) +``` -#### [Get List Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_flow_triggers) +#### [Get List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list) ```ruby -KlaviyoAPI::Lists.get_list_flow_triggers(id, opts) +KlaviyoAPI::Lists.get_list(id, opts) ``` -#### [Get List Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_profiles) +#### [Get Lists](https://developers.klaviyo.com/en/v2024-10-15/reference/get_lists) ```ruby -KlaviyoAPI::Lists.get_list_profiles(id, opts) +KlaviyoAPI::Lists.get_lists(opts) ``` -#### [Get List Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_relationships_flow_triggers) +#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_list) ```ruby -KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id) +KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts) +``` -#### [Get List Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list_tags) +#### [Get Profiles for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_list) ```ruby -KlaviyoAPI::Lists.get_list_tags(id, opts) +KlaviyoAPI::Lists.get_profiles_for_list(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.get_list_profiles(id, opts) +``` -#### [Get Lists](https://developers.klaviyo.com/en/v2024-10-15/reference/get_lists) +#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_list) ```ruby -KlaviyoAPI::Lists.get_lists(opts) +KlaviyoAPI::Lists.get_tag_ids_for_list(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.get_list_relationships_tags(id) +``` -#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_list) +#### [Get Tags for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_list) ```ruby -KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts) +KlaviyoAPI::Lists.get_tags_for_list(id, opts) ``` ##### Method alias: ```ruby -KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts) +KlaviyoAPI::Lists.get_list_tags(id, opts) ``` -#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_list) +#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_profiles_from_list) ```ruby -KlaviyoAPI::Lists.get_tag_ids_for_list(id) +KlaviyoAPI::Lists.remove_profiles_from_list(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Lists.get_list_relationships_tags(id) +KlaviyoAPI::Lists.delete_list_relationships(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body) +``` @@ -2420,30 +2532,56 @@ ## Metrics -#### [Get Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric) +#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_metric) ```ruby -KlaviyoAPI::Metrics.get_metric(id, opts) +KlaviyoAPI::Metrics.get_flows_triggered_by_metric(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.get_flow_triggers_for_metric(id, opts) +``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts) +``` -#### [Get Metric Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_flow_triggers) +#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_metric) ```ruby -KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts) +KlaviyoAPI::Metrics.get_ids_for_flows_triggered_by_metric(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.get_flow_trigger_ids_for_metric(id) +``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id) +``` +#### [Get Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric) + +```ruby +KlaviyoAPI::Metrics.get_metric(id, opts) +``` + + + + + #### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_for_metric_property) ```ruby KlaviyoAPI::Metrics.get_metric_for_metric_property(id, opts) ``` @@ -2478,20 +2616,10 @@ -#### [Get Metric Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_relationships_flow_triggers) - -```ruby -KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id) -``` - - - - - #### [Get Metrics](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metrics) ```ruby KlaviyoAPI::Metrics.get_metrics(opts) ``` @@ -2507,10 +2635,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Metrics.get_metric_metric_properties(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.get_metric_properties(id, opts) +``` @@ -2521,10 +2653,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Metrics.get_metric_relationships_metric_properties(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.get_metric_relationships_properties(id) +``` @@ -2544,10 +2680,28 @@ ## Profiles +#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_import_profiles) + +```ruby +KlaviyoAPI::Profiles.bulk_import_profiles(body) +``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body) +``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_bulk_import_job(body) +``` + + + + + #### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_subscribe_profiles) ```ruby KlaviyoAPI::Profiles.bulk_subscribe_profiles(body) ``` @@ -2753,10 +2907,14 @@ ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts) ``` ##### Method alias: ```ruby +KlaviyoAPI::Profiles.get_import_errors_for_profile_bulk_import_job(id, opts) +``` +##### Method alias: +```ruby KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts) ``` @@ -2771,10 +2929,14 @@ ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts) ``` ##### Method alias: ```ruby +KlaviyoAPI::Profiles.get_lists_for_profile_bulk_import_job(id, opts) +``` +##### Method alias: +```ruby KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts) ``` @@ -2789,10 +2951,14 @@ ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id) ``` ##### Method alias: ```ruby +KlaviyoAPI::Profiles.get_list_ids_for_profile_bulk_import_job(id) +``` +##### Method alias: +```ruby KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id) ``` @@ -2847,10 +3013,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_profiles(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_ids_for_profile_bulk_import_job(id, opts) +``` @@ -2875,10 +3045,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profiles_for_profile_bulk_import_job(id, opts) +``` @@ -2922,28 +3096,10 @@ -#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-10-15/reference/spawn_bulk_profile_import_job) - -```ruby -KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body) -``` -##### Method alias: -```ruby -KlaviyoAPI::Profiles.bulk_import_profiles(body) -``` -##### Method alias: -```ruby -KlaviyoAPI::Profiles.create_profile_bulk_import_job(body) -``` - - - - - #### [Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/update_profile) ```ruby KlaviyoAPI::Profiles.update_profile(id, body, opts) ``` @@ -2963,10 +3119,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Reporting.create_campaign_value_report(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_campaign_values_report(body, opts) +``` @@ -2977,10 +3137,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Reporting.create_flow_sery_report(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_flow_series_report(body, opts) +``` @@ -2991,10 +3155,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Reporting.create_flow_value_report(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_flow_values_report(body, opts) +``` @@ -3005,10 +3173,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Reporting.create_form_sery_report(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_form_series_report(body) +``` @@ -3019,10 +3191,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Reporting.create_form_value_report(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_form_values_report(body) +``` @@ -3033,10 +3209,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Reporting.create_segment_sery_report(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_segment_series_report(body) +``` @@ -3047,10 +3227,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Reporting.create_segment_value_report(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_segment_values_report(body) +``` @@ -3100,62 +3284,78 @@ -#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_segment) +#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_segment) ```ruby -KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts) +KlaviyoAPI::Segments.get_flows_triggered_by_segment(id, opts) ``` ##### Method alias: ```ruby -KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts) +KlaviyoAPI::Segments.get_flow_triggers_for_segment(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts) +``` -#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_segment) +#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_segment) ```ruby -KlaviyoAPI::Segments.get_profiles_for_segment(id, opts) +KlaviyoAPI::Segments.get_ids_for_flows_triggered_by_segment(id) ``` ##### Method alias: ```ruby -KlaviyoAPI::Segments.get_segment_profiles(id, opts) +KlaviyoAPI::Segments.get_flow_trigger_ids_for_segment(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id) +``` -#### [Get Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment) +#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_segment) ```ruby -KlaviyoAPI::Segments.get_segment(id, opts) +KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts) +``` -#### [Get Segment Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment_flow_triggers) +#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_segment) ```ruby -KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts) +KlaviyoAPI::Segments.get_profiles_for_segment(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Segments.get_segment_profiles(id, opts) +``` -#### [Get Segment Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment_relationships_flow_triggers) +#### [Get Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment) ```ruby -KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id) +KlaviyoAPI::Segments.get_segment(id, opts) ``` @@ -3335,10 +3535,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Tags.get_tag_tag_group(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.get_group_for_tag(id, opts) +``` @@ -3349,10 +3553,18 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Tags.get_tag_relationships_tag_group(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.get_group_id_for_tag(id) +``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.get_tag_relationships_group(id) +``` @@ -3411,10 +3623,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.remove_campaigns_from_tag(id, body) +``` @@ -3425,10 +3641,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.remove_flows_from_tag(id, body) +``` @@ -3439,10 +3659,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.remove_lists_from_tag(id, body) +``` @@ -3453,10 +3677,14 @@ ``` ##### Method alias: ```ruby KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.remove_segments_from_tag(id, body) +``` @@ -3465,16 +3693,20 @@ ```ruby KlaviyoAPI::Tags.tag_campaigns(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body) +KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body) +KlaviyoAPI::Tags.add_campaigns_to_tag(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body) +``` @@ -3483,16 +3715,20 @@ ```ruby KlaviyoAPI::Tags.tag_flows(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_flows(id, body) +KlaviyoAPI::Tags.create_tag_relationships_flow(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_flow(id, body) +KlaviyoAPI::Tags.add_flows_to_tag(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_flows(id, body) +``` @@ -3501,16 +3737,20 @@ ```ruby KlaviyoAPI::Tags.tag_lists(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_lists(id, body) +KlaviyoAPI::Tags.create_tag_relationships_list(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_list(id, body) +KlaviyoAPI::Tags.add_lists_to_tag(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_lists(id, body) +``` @@ -3519,14 +3759,18 @@ ```ruby KlaviyoAPI::Tags.tag_segments(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_segments(id, body) +KlaviyoAPI::Tags.create_tag_relationships_segment(id, body) ``` ##### Method alias: ```ruby -KlaviyoAPI::Tags.create_tag_relationships_segment(id, body) +KlaviyoAPI::Tags.add_segments_to_tag(id, body) +``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_segments(id, body) ```