README.md in klaviyo-api-sdk-8.0.0 vs README.md in klaviyo-api-sdk-9.0.0

- old
+ new

@@ -1,8 +1,8 @@ # Klaviyo Ruby SDK -- SDK version: 8.0.0 +- SDK version: 9.0.0 - API revision: 2024-07-15 ## Helpful Resources - [API Reference](https://developers.klaviyo.com/en/v2024-07-15/reference) @@ -100,24 +100,34 @@ ``` Then install the gem locally: ```shell -gem install ./klaviyo-api-sdk-8.0.0.gem +gem install ./klaviyo-api-sdk-9.0.0.gem ``` Finally add this to the Gemfile: - gem 'klaviyo-api-sdk', '~> 8.0.0' + gem 'klaviyo-api-sdk', '~> 9.0.0' To install directly from rubygems: ```shell gem install klaviyo-api-sdk ``` +### For macOS developers + +To avoid compatability issues between macOS and the underlying HTTP client library (Typhoeus), add the following to your local bash file: + +``` +export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES +``` + +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. + ## Usage Example ### To load the gem ```ruby @@ -771,10 +781,14 @@ #### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_category_relationships_items) ```ruby KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body) +``` @@ -791,10 +805,14 @@ #### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_item_relationships_categories) ```ruby KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body) +``` @@ -971,270 +989,378 @@ #### [Get Create Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_categories_job) ```ruby KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts) +``` #### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_categories_jobs) ```ruby KlaviyoAPI::Catalogs.get_create_categories_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts) +``` #### [Get Create Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_items_job) ```ruby KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts) +``` #### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_items_jobs) ```ruby KlaviyoAPI::Catalogs.get_create_items_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts) +``` #### [Get Create Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_variants_job) ```ruby KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts) +``` #### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_variants_jobs) ```ruby KlaviyoAPI::Catalogs.get_create_variants_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts) +``` #### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_categories_job) ```ruby KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts) +``` #### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_categories_jobs) ```ruby KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts) +``` #### [Get Delete Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_items_job) ```ruby KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts) +``` #### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_items_jobs) ```ruby KlaviyoAPI::Catalogs.get_delete_items_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts) +``` #### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_variants_job) ```ruby KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts) +``` #### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_variants_jobs) ```ruby KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts) +``` #### [Get Update Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_categories_job) ```ruby KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts) +``` #### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_categories_jobs) ```ruby KlaviyoAPI::Catalogs.get_update_categories_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts) +``` #### [Get Update Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_items_job) ```ruby KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts) +``` #### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_items_jobs) ```ruby KlaviyoAPI::Catalogs.get_update_items_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts) +``` #### [Get Update Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_variants_job) ```ruby KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts) +``` #### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_variants_jobs) ```ruby KlaviyoAPI::Catalogs.get_update_variants_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts) +``` #### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_create_categories_job) ```ruby KlaviyoAPI::Catalogs.spawn_create_categories_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body) +``` #### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_create_items_job) ```ruby KlaviyoAPI::Catalogs.spawn_create_items_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body) +``` #### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_create_variants_job) ```ruby KlaviyoAPI::Catalogs.spawn_create_variants_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body) +``` #### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_delete_categories_job) ```ruby KlaviyoAPI::Catalogs.spawn_delete_categories_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body) +``` #### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_delete_items_job) ```ruby KlaviyoAPI::Catalogs.spawn_delete_items_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body) +``` #### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_delete_variants_job) ```ruby KlaviyoAPI::Catalogs.spawn_delete_variants_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body) +``` #### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_update_categories_job) ```ruby KlaviyoAPI::Catalogs.spawn_update_categories_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body) +``` #### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_update_items_job) ```ruby KlaviyoAPI::Catalogs.spawn_update_items_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body) +``` #### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_update_variants_job) ```ruby KlaviyoAPI::Catalogs.spawn_update_variants_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body) +``` @@ -1395,20 +1521,28 @@ #### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-07-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) +``` #### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_for_coupon_code) ```ruby KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts) +``` @@ -1435,10 +1569,14 @@ #### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_coupon_code_bulk_create_job) ```ruby KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body) +``` @@ -1469,10 +1607,14 @@ #### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-07-15/reference/request_profile_deletion) ```ruby KlaviyoAPI::DataPrivacy.request_profile_deletion(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body) +``` @@ -1483,10 +1625,14 @@ #### [Bulk Create Events](https://developers.klaviyo.com/en/v2024-07-15/reference/bulk_create_events) ```ruby KlaviyoAPI::Events.bulk_create_events(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Events.create_event_bulk_create_job(body) +``` @@ -1761,20 +1907,28 @@ #### [Get Form for Form Version](https://developers.klaviyo.com/en/v2024-07-15/reference/get_form_for_form_version) ```ruby KlaviyoAPI::Forms.get_form_for_form_version(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_version_form(id, opts) +``` #### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2024-07-15/reference/get_form_id_for_form_version) ```ruby KlaviyoAPI::Forms.get_form_id_for_form_version(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_version_relationships_form(id) +``` @@ -1801,20 +1955,28 @@ #### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2024-07-15/reference/get_version_ids_for_form) ```ruby KlaviyoAPI::Forms.get_version_ids_for_form(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_relationships_form_versions(id) +``` #### [Get Versions for Form](https://developers.klaviyo.com/en/v2024-07-15/reference/get_versions_for_form) ```ruby KlaviyoAPI::Forms.get_versions_for_form(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_form_versions(id, opts) +``` @@ -1855,20 +2017,28 @@ #### [Upload Image From File](https://developers.klaviyo.com/en/v2024-07-15/reference/upload_image_from_file) ```ruby KlaviyoAPI::Images.upload_image_from_file(file, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Images.create_image_upload(file, opts) +``` #### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-07-15/reference/upload_image_from_url) ```ruby KlaviyoAPI::Images.upload_image_from_url(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Images.create_image(body) +``` @@ -1889,10 +2059,14 @@ #### [Add Profile To List](https://developers.klaviyo.com/en/v2024-07-15/reference/create_list_relationships) ```ruby KlaviyoAPI::Lists.create_list_relationships(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.create_list_relationships_profile(id, body) +``` @@ -1909,10 +2083,14 @@ #### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_list_relationships) ```ruby KlaviyoAPI::Lists.delete_list_relationships(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body) +``` @@ -2013,10 +2191,14 @@ #### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2024-07-15/reference/query_metric_aggregates) ```ruby KlaviyoAPI::Metrics.query_metric_aggregates(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.create_metric_aggregate(body) +``` @@ -2027,10 +2209,14 @@ #### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-07-15/reference/create_or_update_profile) ```ruby KlaviyoAPI::Profiles.create_or_update_profile(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_import(body) +``` @@ -2057,70 +2243,98 @@ #### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts) +``` #### [Get Bulk Profile Import Job Errors](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_import_errors) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts) +``` #### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_lists) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts) +``` #### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_profiles) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts) +``` #### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_relationships_lists) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id) +``` #### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_relationships_profiles) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_profiles(id, opts) +``` #### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_jobs) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts) +``` @@ -2187,60 +2401,84 @@ #### [Merge Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/merge_profiles) ```ruby KlaviyoAPI::Profiles.merge_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_merge(body) +``` #### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_bulk_profile_import_job) ```ruby KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_bulk_import_job(body) +``` #### [Subscribe Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/subscribe_profiles) ```ruby KlaviyoAPI::Profiles.subscribe_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body) +``` #### [Suppress Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/suppress_profiles) ```ruby KlaviyoAPI::Profiles.suppress_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body) +``` #### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/unsubscribe_profiles) ```ruby KlaviyoAPI::Profiles.unsubscribe_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body) +``` #### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/unsuppress_profiles) ```ruby KlaviyoAPI::Profiles.unsuppress_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body) +``` @@ -2261,30 +2499,42 @@ #### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-07-15/reference/query_campaign_values) ```ruby KlaviyoAPI::Reporting.query_campaign_values(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_campaign_value_report(body, opts) +``` #### [Query Flow Series](https://developers.klaviyo.com/en/v2024-07-15/reference/query_flow_series) ```ruby KlaviyoAPI::Reporting.query_flow_series(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_flow_sery_report(body, opts) +``` #### [Query Flow Values](https://developers.klaviyo.com/en/v2024-07-15/reference/query_flow_values) ```ruby KlaviyoAPI::Reporting.query_flow_values(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_flow_value_report(body, opts) +``` @@ -2409,38 +2659,54 @@ #### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_campaigns) ```ruby KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body) +``` #### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_flows) ```ruby KlaviyoAPI::Tags.create_tag_relationships_flows(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_flow(id, body) +``` #### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_lists) ```ruby KlaviyoAPI::Tags.create_tag_relationships_lists(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_list(id, body) +``` #### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_segments) ```ruby KlaviyoAPI::Tags.create_tag_relationships_segments(id, body) +``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_segment(id, body) ```