From 08b5b91209e60664e9e07f481a2bfdfd45a06738 Mon Sep 17 00:00:00 2001 From: klaviyo-sdk Date: Thu, 29 Aug 2024 20:23:54 +0000 Subject: [PATCH] version 9.0.0 --- CHANGELOG.md | 7 + README.md | 272 +++++++++++++++++++- klaviyo-api-sdk.gemspec | 2 +- lib/klaviyo-api-sdk/api/catalogs_api.rb | 174 +++++++++++++ lib/klaviyo-api-sdk/api/coupons_api.rb | 22 +- lib/klaviyo-api-sdk/api/data_privacy_api.rb | 6 + lib/klaviyo-api-sdk/api/events_api.rb | 8 +- lib/klaviyo-api-sdk/api/forms_api.rb | 24 ++ lib/klaviyo-api-sdk/api/images_api.rb | 12 + lib/klaviyo-api-sdk/api/lists_api.rb | 14 +- lib/klaviyo-api-sdk/api/metrics_api.rb | 10 +- lib/klaviyo-api-sdk/api/profiles_api.rb | 90 ++++++- lib/klaviyo-api-sdk/api/reporting_api.rb | 18 ++ lib/klaviyo-api-sdk/api/segments_api.rb | 2 +- lib/klaviyo-api-sdk/api/tags_api.rb | 24 ++ lib/klaviyo-api-sdk/api_client.rb | 2 +- 16 files changed, 672 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 24b3052..0f0716f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [9.0.0] - revision 2024-07-15 +### Added +- Added several method aliases based on previous operation IDs +### Fixed +- **Breaking** + - Removed incorrect `links` property from several DTO classes + ## [8.0.0] - revision 2024-07-15 ### Added diff --git a/README.md b/README.md index 9d3fcb1..6d5ff83 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Klaviyo Ruby SDK -- SDK version: 8.0.0 +- SDK version: 9.0.0 - API revision: 2024-07-15 ## Helpful Resources @@ -102,13 +102,13 @@ gem build klaviyo-api-sdk.gemspec 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: @@ -116,6 +116,16 @@ To install directly from rubygems: 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 @@ -773,6 +783,10 @@ KlaviyoAPI::Catalogs.create_catalog_category(body) ```ruby KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body) +``` @@ -793,6 +807,10 @@ KlaviyoAPI::Catalogs.create_catalog_item(body) ```ruby KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body) +``` @@ -973,6 +991,10 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts) ```ruby KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts) +``` @@ -983,6 +1005,10 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_create_categories_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts) +``` @@ -993,6 +1019,10 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts) +``` @@ -1003,6 +1033,10 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_create_items_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts) +``` @@ -1013,6 +1047,10 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts) +``` @@ -1023,6 +1061,10 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_create_variants_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts) +``` @@ -1033,6 +1075,10 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts) +``` @@ -1043,6 +1089,10 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts) +``` @@ -1053,6 +1103,10 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts) +``` @@ -1063,6 +1117,10 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_delete_items_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts) +``` @@ -1073,6 +1131,10 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts) +``` @@ -1083,6 +1145,10 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts) +``` @@ -1093,6 +1159,10 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts) +``` @@ -1103,6 +1173,10 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_update_categories_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts) +``` @@ -1113,6 +1187,10 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts) +``` @@ -1123,6 +1201,10 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_update_items_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts) +``` @@ -1133,6 +1215,10 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts) ```ruby KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts) +``` @@ -1143,6 +1229,10 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts) ```ruby KlaviyoAPI::Catalogs.get_update_variants_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts) +``` @@ -1153,6 +1243,10 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts) ```ruby KlaviyoAPI::Catalogs.spawn_create_categories_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body) +``` @@ -1163,6 +1257,10 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_create_items_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body) +``` @@ -1173,6 +1271,10 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_create_variants_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body) +``` @@ -1183,6 +1285,10 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_delete_categories_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body) +``` @@ -1193,6 +1299,10 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_delete_items_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body) +``` @@ -1203,6 +1313,10 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_delete_variants_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body) +``` @@ -1213,6 +1327,10 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_update_categories_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body) +``` @@ -1223,6 +1341,10 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_update_items_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body) +``` @@ -1233,6 +1355,10 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body) ```ruby KlaviyoAPI::Catalogs.spawn_update_variants_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body) +``` @@ -1397,6 +1523,10 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts) ```ruby KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.get_coupon_coupon_codes(id, opts) +``` @@ -1407,6 +1537,10 @@ KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts) ```ruby KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts) +``` @@ -1437,6 +1571,10 @@ KlaviyoAPI::Coupons.get_coupons(opts) ```ruby KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body) +``` @@ -1471,6 +1609,10 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body) ```ruby KlaviyoAPI::DataPrivacy.request_profile_deletion(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body) +``` @@ -1485,6 +1627,10 @@ KlaviyoAPI::DataPrivacy.request_profile_deletion(body) ```ruby KlaviyoAPI::Events.bulk_create_events(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Events.create_event_bulk_create_job(body) +``` @@ -1763,6 +1909,10 @@ KlaviyoAPI::Forms.get_form(id, opts) ```ruby KlaviyoAPI::Forms.get_form_for_form_version(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_version_form(id, opts) +``` @@ -1773,6 +1923,10 @@ KlaviyoAPI::Forms.get_form_for_form_version(id, opts) ```ruby KlaviyoAPI::Forms.get_form_id_for_form_version(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_version_relationships_form(id) +``` @@ -1803,6 +1957,10 @@ KlaviyoAPI::Forms.get_forms(opts) ```ruby KlaviyoAPI::Forms.get_version_ids_for_form(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_relationships_form_versions(id) +``` @@ -1813,6 +1971,10 @@ KlaviyoAPI::Forms.get_version_ids_for_form(id) ```ruby KlaviyoAPI::Forms.get_versions_for_form(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Forms.get_form_form_versions(id, opts) +``` @@ -1857,6 +2019,10 @@ KlaviyoAPI::Images.update_image(id, body) ```ruby KlaviyoAPI::Images.upload_image_from_file(file, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Images.create_image_upload(file, opts) +``` @@ -1867,6 +2033,10 @@ KlaviyoAPI::Images.upload_image_from_file(file, opts) ```ruby KlaviyoAPI::Images.upload_image_from_url(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Images.create_image(body) +``` @@ -1891,6 +2061,10 @@ KlaviyoAPI::Lists.create_list(body) ```ruby KlaviyoAPI::Lists.create_list_relationships(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.create_list_relationships_profile(id, body) +``` @@ -1911,6 +2085,10 @@ KlaviyoAPI::Lists.delete_list(id) ```ruby KlaviyoAPI::Lists.delete_list_relationships(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body) +``` @@ -2015,6 +2193,10 @@ KlaviyoAPI::Metrics.get_metrics(opts) ```ruby KlaviyoAPI::Metrics.query_metric_aggregates(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Metrics.create_metric_aggregate(body) +``` @@ -2029,6 +2211,10 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body) ```ruby KlaviyoAPI::Profiles.create_or_update_profile(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_import(body) +``` @@ -2059,6 +2245,10 @@ KlaviyoAPI::Profiles.create_push_token(body) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts) +``` @@ -2069,6 +2259,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts) ```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) +``` @@ -2079,6 +2273,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts) +``` @@ -2089,6 +2287,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts) +``` @@ -2099,6 +2301,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts) ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id) +``` @@ -2109,6 +2315,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id) ```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) +``` @@ -2119,6 +2329,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts ```ruby KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts) +``` @@ -2189,6 +2403,10 @@ KlaviyoAPI::Profiles.get_profiles(opts) ```ruby KlaviyoAPI::Profiles.merge_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_merge(body) +``` @@ -2199,6 +2417,10 @@ KlaviyoAPI::Profiles.merge_profiles(body) ```ruby KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_bulk_import_job(body) +``` @@ -2209,6 +2431,10 @@ KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body) ```ruby KlaviyoAPI::Profiles.subscribe_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body) +``` @@ -2219,6 +2445,10 @@ KlaviyoAPI::Profiles.subscribe_profiles(body) ```ruby KlaviyoAPI::Profiles.suppress_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body) +``` @@ -2229,6 +2459,10 @@ KlaviyoAPI::Profiles.suppress_profiles(body) ```ruby KlaviyoAPI::Profiles.unsubscribe_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body) +``` @@ -2239,6 +2473,10 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body) ```ruby KlaviyoAPI::Profiles.unsuppress_profiles(body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body) +``` @@ -2263,6 +2501,10 @@ KlaviyoAPI::Profiles.update_profile(id, body) ```ruby KlaviyoAPI::Reporting.query_campaign_values(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_campaign_value_report(body, opts) +``` @@ -2273,6 +2515,10 @@ KlaviyoAPI::Reporting.query_campaign_values(body, opts) ```ruby KlaviyoAPI::Reporting.query_flow_series(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_flow_sery_report(body, opts) +``` @@ -2283,6 +2529,10 @@ KlaviyoAPI::Reporting.query_flow_series(body, opts) ```ruby KlaviyoAPI::Reporting.query_flow_values(body, opts) ``` +##### Method alias: +```ruby +KlaviyoAPI::Reporting.create_flow_value_report(body, opts) +``` @@ -2411,6 +2661,10 @@ KlaviyoAPI::Tags.create_tag_group(body) ```ruby KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body) +``` @@ -2421,6 +2675,10 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body) ```ruby KlaviyoAPI::Tags.create_tag_relationships_flows(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_flow(id, body) +``` @@ -2431,6 +2689,10 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body) ```ruby KlaviyoAPI::Tags.create_tag_relationships_lists(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_list(id, body) +``` @@ -2441,6 +2703,10 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body) ```ruby KlaviyoAPI::Tags.create_tag_relationships_segments(id, body) ``` +##### Method alias: +```ruby +KlaviyoAPI::Tags.create_tag_relationships_segment(id, body) +``` diff --git a/klaviyo-api-sdk.gemspec b/klaviyo-api-sdk.gemspec index 967ac3f..018d5e3 100644 --- a/klaviyo-api-sdk.gemspec +++ b/klaviyo-api-sdk.gemspec @@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version" Gem::Specification.new do |s| s.name = "klaviyo-api-sdk" - s.version = "8.0.0" + s.version = "9.0.0" s.authors = ['Klaviyo Team'] s.email = ['libraries@klaviyo.com'] s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API' diff --git a/lib/klaviyo-api-sdk/api/catalogs_api.rb b/lib/klaviyo-api-sdk/api/catalogs_api.rb index 6a56bb0..a742162 100644 --- a/lib/klaviyo-api-sdk/api/catalogs_api.rb +++ b/lib/klaviyo-api-sdk/api/catalogs_api.rb @@ -170,6 +170,9 @@ def create_catalog_category_relationships_items(id, catalog_category_item_op, op nil end + # alias of `create_catalog_category_relationships_items` + alias create_catalog_category_relationships_item create_catalog_category_relationships_items + # Create Catalog Category Relationships Items # Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param id [String] @@ -235,6 +238,9 @@ def create_catalog_category_relationships_items_with_http_info(id, catalog_categ return data, status_code, headers end + # alias of `create_catalog_category_relationships_items_with_http_info` + alias create_catalog_category_relationships_item_with_http_info create_catalog_category_relationships_items_with_http_info + # Create Catalog Item # Create a new catalog item.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_item_create_query [CatalogItemCreateQuery] @@ -316,6 +322,9 @@ def create_catalog_item_relationships_categories(id, catalog_item_category_op, o nil end + # alias of `create_catalog_item_relationships_categories` + alias create_catalog_item_relationships_category create_catalog_item_relationships_categories + # Create Catalog Item Relationships Categories # Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param id [String] @@ -381,6 +390,9 @@ def create_catalog_item_relationships_categories_with_http_info(id, catalog_item return data, status_code, headers end + # alias of `create_catalog_item_relationships_categories_with_http_info` + alias create_catalog_item_relationships_category_with_http_info create_catalog_item_relationships_categories_with_http_info + # Create Catalog Variant # Create a new variant for a related catalog item.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_variant_create_query [CatalogVariantCreateQuery] @@ -1697,6 +1709,9 @@ def get_create_categories_job(job_id, opts = {}) data end + # alias of `get_create_categories_job` + alias get_catalog_category_bulk_create_job get_create_categories_job + # Get Create Categories Job # Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -1770,6 +1785,9 @@ def get_create_categories_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_create_categories_job_with_http_info` + alias get_catalog_category_bulk_create_job_with_http_info get_create_categories_job_with_http_info + # Get Create Categories Jobs # Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -1782,6 +1800,9 @@ def get_create_categories_jobs(opts = {}) data end + # alias of `get_create_categories_jobs` + alias get_catalog_category_bulk_create_jobs get_create_categories_jobs + # Get Create Categories Jobs # Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -1842,6 +1863,9 @@ def get_create_categories_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_create_categories_jobs_with_http_info` + alias get_catalog_category_bulk_create_jobs_with_http_info get_create_categories_jobs_with_http_info + # Get Create Items Job # Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -1855,6 +1879,9 @@ def get_create_items_job(job_id, opts = {}) data end + # alias of `get_create_items_job` + alias get_catalog_item_bulk_create_job get_create_items_job + # Get Create Items Job # Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -1928,6 +1955,9 @@ def get_create_items_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_create_items_job_with_http_info` + alias get_catalog_item_bulk_create_job_with_http_info get_create_items_job_with_http_info + # Get Create Items Jobs # Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -1940,6 +1970,9 @@ def get_create_items_jobs(opts = {}) data end + # alias of `get_create_items_jobs` + alias get_catalog_item_bulk_create_jobs get_create_items_jobs + # Get Create Items Jobs # Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2000,6 +2033,9 @@ def get_create_items_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_create_items_jobs_with_http_info` + alias get_catalog_item_bulk_create_jobs_with_http_info get_create_items_jobs_with_http_info + # Get Create Variants Job # Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2013,6 +2049,9 @@ def get_create_variants_job(job_id, opts = {}) data end + # alias of `get_create_variants_job` + alias get_catalog_variant_bulk_create_job get_create_variants_job + # Get Create Variants Job # Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2086,6 +2125,9 @@ def get_create_variants_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_create_variants_job_with_http_info` + alias get_catalog_variant_bulk_create_job_with_http_info get_create_variants_job_with_http_info + # Get Create Variants Jobs # Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2098,6 +2140,9 @@ def get_create_variants_jobs(opts = {}) data end + # alias of `get_create_variants_jobs` + alias get_catalog_variant_bulk_create_jobs get_create_variants_jobs + # Get Create Variants Jobs # Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2158,6 +2203,9 @@ def get_create_variants_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_create_variants_jobs_with_http_info` + alias get_catalog_variant_bulk_create_jobs_with_http_info get_create_variants_jobs_with_http_info + # Get Delete Categories Job # Get a catalog category bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2169,6 +2217,9 @@ def get_delete_categories_job(job_id, opts = {}) data end + # alias of `get_delete_categories_job` + alias get_catalog_category_bulk_delete_job get_delete_categories_job + # Get Delete Categories Job # Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2230,6 +2281,9 @@ def get_delete_categories_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_delete_categories_job_with_http_info` + alias get_catalog_category_bulk_delete_job_with_http_info get_delete_categories_job_with_http_info + # Get Delete Categories Jobs # Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2242,6 +2296,9 @@ def get_delete_categories_jobs(opts = {}) data end + # alias of `get_delete_categories_jobs` + alias get_catalog_category_bulk_delete_jobs get_delete_categories_jobs + # Get Delete Categories Jobs # Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2302,6 +2359,9 @@ def get_delete_categories_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_delete_categories_jobs_with_http_info` + alias get_catalog_category_bulk_delete_jobs_with_http_info get_delete_categories_jobs_with_http_info + # Get Delete Items Job # Get a catalog item bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2313,6 +2373,9 @@ def get_delete_items_job(job_id, opts = {}) data end + # alias of `get_delete_items_job` + alias get_catalog_item_bulk_delete_job get_delete_items_job + # Get Delete Items Job # Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2374,6 +2437,9 @@ def get_delete_items_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_delete_items_job_with_http_info` + alias get_catalog_item_bulk_delete_job_with_http_info get_delete_items_job_with_http_info + # Get Delete Items Jobs # Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2386,6 +2452,9 @@ def get_delete_items_jobs(opts = {}) data end + # alias of `get_delete_items_jobs` + alias get_catalog_item_bulk_delete_jobs get_delete_items_jobs + # Get Delete Items Jobs # Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2446,6 +2515,9 @@ def get_delete_items_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_delete_items_jobs_with_http_info` + alias get_catalog_item_bulk_delete_jobs_with_http_info get_delete_items_jobs_with_http_info + # Get Delete Variants Job # Get a catalog variant bulk delete job with the given job ID.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2457,6 +2529,9 @@ def get_delete_variants_job(job_id, opts = {}) data end + # alias of `get_delete_variants_job` + alias get_catalog_variant_bulk_delete_job get_delete_variants_job + # Get Delete Variants Job # Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2518,6 +2593,9 @@ def get_delete_variants_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_delete_variants_job_with_http_info` + alias get_catalog_variant_bulk_delete_job_with_http_info get_delete_variants_job_with_http_info + # Get Delete Variants Jobs # Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2530,6 +2608,9 @@ def get_delete_variants_jobs(opts = {}) data end + # alias of `get_delete_variants_jobs` + alias get_catalog_variant_bulk_delete_jobs get_delete_variants_jobs + # Get Delete Variants Jobs # Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2590,6 +2671,9 @@ def get_delete_variants_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_delete_variants_jobs_with_http_info` + alias get_catalog_variant_bulk_delete_jobs_with_http_info get_delete_variants_jobs_with_http_info + # Get Update Categories Job # Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2603,6 +2687,9 @@ def get_update_categories_job(job_id, opts = {}) data end + # alias of `get_update_categories_job` + alias get_catalog_category_bulk_update_job get_update_categories_job + # Get Update Categories Job # Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2676,6 +2763,9 @@ def get_update_categories_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_update_categories_job_with_http_info` + alias get_catalog_category_bulk_update_job_with_http_info get_update_categories_job_with_http_info + # Get Update Categories Jobs # Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2688,6 +2778,9 @@ def get_update_categories_jobs(opts = {}) data end + # alias of `get_update_categories_jobs` + alias get_catalog_category_bulk_update_jobs get_update_categories_jobs + # Get Update Categories Jobs # Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2748,6 +2841,9 @@ def get_update_categories_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_update_categories_jobs_with_http_info` + alias get_catalog_category_bulk_update_jobs_with_http_info get_update_categories_jobs_with_http_info + # Get Update Items Job # Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2761,6 +2857,9 @@ def get_update_items_job(job_id, opts = {}) data end + # alias of `get_update_items_job` + alias get_catalog_item_bulk_update_job get_update_items_job + # Get Update Items Job # Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2834,6 +2933,9 @@ def get_update_items_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_update_items_job_with_http_info` + alias get_catalog_item_bulk_update_job_with_http_info get_update_items_job_with_http_info + # Get Update Items Jobs # Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2846,6 +2948,9 @@ def get_update_items_jobs(opts = {}) data end + # alias of `get_update_items_jobs` + alias get_catalog_item_bulk_update_jobs get_update_items_jobs + # Get Update Items Jobs # Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -2906,6 +3011,9 @@ def get_update_items_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_update_items_jobs_with_http_info` + alias get_catalog_item_bulk_update_jobs_with_http_info get_update_items_jobs_with_http_info + # Get Update Variants Job # Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2919,6 +3027,9 @@ def get_update_variants_job(job_id, opts = {}) data end + # alias of `get_update_variants_job` + alias get_catalog_variant_bulk_update_job get_update_variants_job + # Get Update Variants Job # Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param job_id [String] ID of the job to retrieve. @@ -2992,6 +3103,9 @@ def get_update_variants_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_update_variants_job_with_http_info` + alias get_catalog_variant_bulk_update_job_with_http_info get_update_variants_job_with_http_info + # Get Update Variants Jobs # Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -3004,6 +3118,9 @@ def get_update_variants_jobs(opts = {}) data end + # alias of `get_update_variants_jobs` + alias get_catalog_variant_bulk_update_jobs get_update_variants_jobs + # Get Update Variants Jobs # Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read` # @param [Hash] opts the optional parameters @@ -3064,6 +3181,9 @@ def get_update_variants_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_update_variants_jobs_with_http_info` + alias get_catalog_variant_bulk_update_jobs_with_http_info get_update_variants_jobs_with_http_info + # Spawn Create Categories Job # Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery] @@ -3074,6 +3194,9 @@ def spawn_create_categories_job(catalog_category_create_job_create_query, opts = data end + # alias of `spawn_create_categories_job` + alias create_catalog_category_bulk_create_job spawn_create_categories_job + # Spawn Create Categories Job # Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery] @@ -3134,6 +3257,9 @@ def spawn_create_categories_job_with_http_info(catalog_category_create_job_creat return data, status_code, headers end + # alias of `spawn_create_categories_job_with_http_info` + alias create_catalog_category_bulk_create_job_with_http_info spawn_create_categories_job_with_http_info + # Spawn Create Items Job # Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery] @@ -3144,6 +3270,9 @@ def spawn_create_items_job(catalog_item_create_job_create_query, opts = {}) data end + # alias of `spawn_create_items_job` + alias create_catalog_item_bulk_create_job spawn_create_items_job + # Spawn Create Items Job # Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery] @@ -3204,6 +3333,9 @@ def spawn_create_items_job_with_http_info(catalog_item_create_job_create_query, return data, status_code, headers end + # alias of `spawn_create_items_job_with_http_info` + alias create_catalog_item_bulk_create_job_with_http_info spawn_create_items_job_with_http_info + # Spawn Create Variants Job # Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery] @@ -3214,6 +3346,9 @@ def spawn_create_variants_job(catalog_variant_create_job_create_query, opts = {} data end + # alias of `spawn_create_variants_job` + alias create_catalog_variant_bulk_create_job spawn_create_variants_job + # Spawn Create Variants Job # Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery] @@ -3274,6 +3409,9 @@ def spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_q return data, status_code, headers end + # alias of `spawn_create_variants_job_with_http_info` + alias create_catalog_variant_bulk_create_job_with_http_info spawn_create_variants_job_with_http_info + # Spawn Delete Categories Job # Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery] @@ -3284,6 +3422,9 @@ def spawn_delete_categories_job(catalog_category_delete_job_create_query, opts = data end + # alias of `spawn_delete_categories_job` + alias create_catalog_category_bulk_delete_job spawn_delete_categories_job + # Spawn Delete Categories Job # Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery] @@ -3344,6 +3485,9 @@ def spawn_delete_categories_job_with_http_info(catalog_category_delete_job_creat return data, status_code, headers end + # alias of `spawn_delete_categories_job_with_http_info` + alias create_catalog_category_bulk_delete_job_with_http_info spawn_delete_categories_job_with_http_info + # Spawn Delete Items Job # Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery] @@ -3354,6 +3498,9 @@ def spawn_delete_items_job(catalog_item_delete_job_create_query, opts = {}) data end + # alias of `spawn_delete_items_job` + alias create_catalog_item_bulk_delete_job spawn_delete_items_job + # Spawn Delete Items Job # Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery] @@ -3414,6 +3561,9 @@ def spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query, return data, status_code, headers end + # alias of `spawn_delete_items_job_with_http_info` + alias create_catalog_item_bulk_delete_job_with_http_info spawn_delete_items_job_with_http_info + # Spawn Delete Variants Job # Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery] @@ -3424,6 +3574,9 @@ def spawn_delete_variants_job(catalog_variant_delete_job_create_query, opts = {} data end + # alias of `spawn_delete_variants_job` + alias create_catalog_variant_bulk_delete_job spawn_delete_variants_job + # Spawn Delete Variants Job # Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery] @@ -3484,6 +3637,9 @@ def spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_q return data, status_code, headers end + # alias of `spawn_delete_variants_job_with_http_info` + alias create_catalog_variant_bulk_delete_job_with_http_info spawn_delete_variants_job_with_http_info + # Spawn Update Categories Job # Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery] @@ -3494,6 +3650,9 @@ def spawn_update_categories_job(catalog_category_update_job_create_query, opts = data end + # alias of `spawn_update_categories_job` + alias create_catalog_category_bulk_update_job spawn_update_categories_job + # Spawn Update Categories Job # Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery] @@ -3554,6 +3713,9 @@ def spawn_update_categories_job_with_http_info(catalog_category_update_job_creat return data, status_code, headers end + # alias of `spawn_update_categories_job_with_http_info` + alias create_catalog_category_bulk_update_job_with_http_info spawn_update_categories_job_with_http_info + # Spawn Update Items Job # Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery] @@ -3564,6 +3726,9 @@ def spawn_update_items_job(catalog_item_update_job_create_query, opts = {}) data end + # alias of `spawn_update_items_job` + alias create_catalog_item_bulk_update_job spawn_update_items_job + # Spawn Update Items Job # Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery] @@ -3624,6 +3789,9 @@ def spawn_update_items_job_with_http_info(catalog_item_update_job_create_query, return data, status_code, headers end + # alias of `spawn_update_items_job_with_http_info` + alias create_catalog_item_bulk_update_job_with_http_info spawn_update_items_job_with_http_info + # Spawn Update Variants Job # Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery] @@ -3634,6 +3802,9 @@ def spawn_update_variants_job(catalog_variant_update_job_create_query, opts = {} data end + # alias of `spawn_update_variants_job` + alias create_catalog_variant_bulk_update_job spawn_update_variants_job + # Spawn Update Variants Job # Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write` # @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery] @@ -3694,6 +3865,9 @@ def spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_q return data, status_code, headers end + # alias of `spawn_update_variants_job_with_http_info` + alias create_catalog_variant_bulk_update_job_with_http_info spawn_update_variants_job_with_http_info + # Update Catalog Category # Update a catalog category with the given category ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `catalogs:write` # @param id [String] The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. diff --git a/lib/klaviyo-api-sdk/api/coupons_api.rb b/lib/klaviyo-api-sdk/api/coupons_api.rb index 20a3b9d..3abce5d 100644 --- a/lib/klaviyo-api-sdk/api/coupons_api.rb +++ b/lib/klaviyo-api-sdk/api/coupons_api.rb @@ -772,6 +772,9 @@ def get_coupon_codes_for_coupon(id, opts = {}) data end + # alias of `get_coupon_codes_for_coupon` + alias get_coupon_coupon_codes get_coupon_codes_for_coupon + # Get Coupon Codes For Coupon # Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read` # @param id [String] @@ -837,6 +840,9 @@ def get_coupon_codes_for_coupon_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_coupon_codes_for_coupon_with_http_info` + alias get_coupon_coupon_codes_with_http_info get_coupon_codes_for_coupon_with_http_info + # Get Coupon For Coupon Code # Get the coupon associated with a given coupon code ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` # @param id [String] @@ -848,6 +854,9 @@ def get_coupon_for_coupon_code(id, opts = {}) data end + # alias of `get_coupon_for_coupon_code` + alias get_coupon_code_coupon get_coupon_for_coupon_code + # Get Coupon For Coupon Code # Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read` # @param id [String] @@ -909,6 +918,9 @@ def get_coupon_for_coupon_code_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_coupon_for_coupon_code_with_http_info` + alias get_coupon_code_coupon_with_http_info get_coupon_for_coupon_code_with_http_info + # Get Coupon Relationships Coupon Codes # Gets the coupon relationship associated with the given coupon code id

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupons:read` # @param id [String] @@ -1044,7 +1056,7 @@ def get_coupons_with_http_info(opts = {}) end # Spawn Coupon Code Bulk Create Job - # Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of jobs queued at once we allow for is 100.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:write` + # Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of coupon codes per job we allow for is 1000. Max number of jobs queued at once we allow for is 100.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `coupon-codes:write` # @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery] # @param [Hash] opts the optional parameters # @return [Hash] @@ -1053,8 +1065,11 @@ def spawn_coupon_code_bulk_create_job(coupon_code_create_job_create_query, opts data end + # alias of `spawn_coupon_code_bulk_create_job` + alias create_coupon_code_bulk_create_job spawn_coupon_code_bulk_create_job + # Spawn Coupon Code Bulk Create Job - # Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:write` + # Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of coupon codes per job we allow for is 1000. Max number of jobs queued at once we allow for is 100.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:write` # @param coupon_code_create_job_create_query [CouponCodeCreateJobCreateQuery] # @param [Hash] opts the optional parameters # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers @@ -1113,6 +1128,9 @@ def spawn_coupon_code_bulk_create_job_with_http_info(coupon_code_create_job_crea return data, status_code, headers end + # alias of `spawn_coupon_code_bulk_create_job_with_http_info` + alias create_coupon_code_bulk_create_job_with_http_info spawn_coupon_code_bulk_create_job_with_http_info + # Update Coupon # *Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `coupons:write` # @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration. diff --git a/lib/klaviyo-api-sdk/api/data_privacy_api.rb b/lib/klaviyo-api-sdk/api/data_privacy_api.rb index aed1c32..34d7b09 100644 --- a/lib/klaviyo-api-sdk/api/data_privacy_api.rb +++ b/lib/klaviyo-api-sdk/api/data_privacy_api.rb @@ -29,6 +29,9 @@ def request_profile_deletion(data_privacy_create_deletion_job_query, opts = {}) nil end + # alias of `request_profile_deletion` + alias create_data_privacy_deletion_job request_profile_deletion + # Request Profile Deletion # Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted). For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `data-privacy:write` # @param data_privacy_create_deletion_job_query [DataPrivacyCreateDeletionJobQuery] @@ -88,5 +91,8 @@ def request_profile_deletion_with_http_info(data_privacy_create_deletion_job_que end return data, status_code, headers end + + # alias of `request_profile_deletion_with_http_info` + alias create_data_privacy_deletion_job_with_http_info request_profile_deletion_with_http_info end end diff --git a/lib/klaviyo-api-sdk/api/events_api.rb b/lib/klaviyo-api-sdk/api/events_api.rb index f9c574e..16718d6 100644 --- a/lib/klaviyo-api-sdk/api/events_api.rb +++ b/lib/klaviyo-api-sdk/api/events_api.rb @@ -29,6 +29,9 @@ def bulk_create_events(events_bulk_create_job, opts = {}) nil end + # alias of `bulk_create_events` + alias create_event_bulk_create_job bulk_create_events + # Bulk Create Events # Create a batch of events for one or more profiles. Note that this endpoint allows you to create new profiles or update existing profile properties. At a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively. Accepts up to 1,000 events per request. The maximum allowed payload size is 5MB.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `events:write` # @param events_bulk_create_job [EventsBulkCreateJob] @@ -89,6 +92,9 @@ def bulk_create_events_with_http_info(events_bulk_create_job, opts = {}) return data, status_code, headers end + # alias of `bulk_create_events_with_http_info` + alias create_event_bulk_create_job_with_http_info bulk_create_events_with_http_info + # Create Event # Create a new event to track a profile's activity. Note that this endpoint allows you to create a new profile or update an existing profile's properties. At a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively. Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.

*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `events:write` # @param event_create_query_v2 [EventCreateQueryV2] @@ -355,7 +361,7 @@ def get_event_profile_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] + allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end diff --git a/lib/klaviyo-api-sdk/api/forms_api.rb b/lib/klaviyo-api-sdk/api/forms_api.rb index 02de5dc..7ecb2f2 100644 --- a/lib/klaviyo-api-sdk/api/forms_api.rb +++ b/lib/klaviyo-api-sdk/api/forms_api.rb @@ -116,6 +116,9 @@ def get_form_for_form_version(id, opts = {}) data end + # alias of `get_form_for_form_version` + alias get_form_version_form get_form_for_form_version + # Get Form for Form Version # Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` # @param id [String] @@ -177,6 +180,9 @@ def get_form_for_form_version_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_form_for_form_version_with_http_info` + alias get_form_version_form_with_http_info get_form_for_form_version_with_http_info + # Get Form ID for Form Version # Get the ID of the form associated with the given form version.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `forms:read` # @param id [String] @@ -187,6 +193,9 @@ def get_form_id_for_form_version(id, opts = {}) data end + # alias of `get_form_id_for_form_version` + alias get_form_version_relationships_form get_form_id_for_form_version + # Get Form ID for Form Version # Get the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` # @param id [String] @@ -242,6 +251,9 @@ def get_form_id_for_form_version_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_form_id_for_form_version_with_http_info` + alias get_form_version_relationships_form_with_http_info get_form_id_for_form_version_with_http_info + # Get Form Version # Get the form version with the given ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `forms:read` # @param id [String] The ID of the form version @@ -414,6 +426,9 @@ def get_version_ids_for_form(id, opts = {}) data end + # alias of `get_version_ids_for_form` + alias get_form_relationships_form_versions get_version_ids_for_form + # Get Version IDs for Form # Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` # @param id [String] @@ -469,6 +484,9 @@ def get_version_ids_for_form_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_version_ids_for_form_with_http_info` + alias get_form_relationships_form_versions_with_http_info get_version_ids_for_form_with_http_info + # Get Versions for Form # Get the form versions for the given form.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `forms:read` # @param id [String] @@ -484,6 +502,9 @@ def get_versions_for_form(id, opts = {}) data end + # alias of `get_versions_for_form` + alias get_form_form_versions get_versions_for_form + # Get Versions for Form # Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read` # @param id [String] @@ -564,5 +585,8 @@ def get_versions_for_form_with_http_info(id, opts = {}) end return data, status_code, headers end + + # alias of `get_versions_for_form_with_http_info` + alias get_form_form_versions_with_http_info get_versions_for_form_with_http_info end end diff --git a/lib/klaviyo-api-sdk/api/images_api.rb b/lib/klaviyo-api-sdk/api/images_api.rb index 02ea73b..f7d109f 100644 --- a/lib/klaviyo-api-sdk/api/images_api.rb +++ b/lib/klaviyo-api-sdk/api/images_api.rb @@ -269,6 +269,9 @@ def upload_image_from_file(file, opts = {}) data end + # alias of `upload_image_from_file` + alias create_image_upload upload_image_from_file + # Upload Image From File # Upload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d` **Scopes:** `images:write` # @param file [File] The image file to upload. Supported image formats: jpeg,png,gif. Maximum image size: 5MB. @@ -334,6 +337,9 @@ def upload_image_from_file_with_http_info(file, opts = {}) return data, status_code, headers end + # alias of `upload_image_from_file_with_http_info` + alias create_image_upload_with_http_info upload_image_from_file_with_http_info + # Upload Image From URL # Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.

*Rate limits*:
Burst: `3/s`
Steady: `100/m`
Daily: `100/d` **Scopes:** `images:write` # @param image_create_query [ImageCreateQuery] @@ -344,6 +350,9 @@ def upload_image_from_url(image_create_query, opts = {}) data end + # alias of `upload_image_from_url` + alias create_image upload_image_from_url + # Upload Image From URL # Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d` **Scopes:** `images:write` # @param image_create_query [ImageCreateQuery] @@ -403,5 +412,8 @@ def upload_image_from_url_with_http_info(image_create_query, opts = {}) end return data, status_code, headers end + + # alias of `upload_image_from_url_with_http_info` + alias create_image_with_http_info upload_image_from_url_with_http_info end end diff --git a/lib/klaviyo-api-sdk/api/lists_api.rb b/lib/klaviyo-api-sdk/api/lists_api.rb index a044a69..c0be32c 100644 --- a/lib/klaviyo-api-sdk/api/lists_api.rb +++ b/lib/klaviyo-api-sdk/api/lists_api.rb @@ -100,6 +100,9 @@ def create_list_relationships(id, list_members_add_query, opts = {}) nil end + # alias of `create_list_relationships` + alias create_list_relationships_profile create_list_relationships + # Add Profile To List # Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) to receive email marketing, SMS marketing, or both. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write` # @param id [String] @@ -165,6 +168,9 @@ def create_list_relationships_with_http_info(id, list_members_add_query, opts = return data, status_code, headers end + # alias of `create_list_relationships_with_http_info` + alias create_list_relationships_profile_with_http_info create_list_relationships_with_http_info + # Delete List # Delete a list with the given list ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:write` # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo. @@ -241,6 +247,9 @@ def delete_list_relationships(id, list_members_delete_query, opts = {}) nil end + # alias of `delete_list_relationships` + alias delete_list_relationships_profiles delete_list_relationships + # Remove Profile From List # Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles). This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write` # @param id [String] @@ -306,6 +315,9 @@ def delete_list_relationships_with_http_info(id, list_members_delete_query, opts return data, status_code, headers end + # alias of `delete_list_relationships_with_http_info` + alias delete_list_relationships_profiles_with_http_info delete_list_relationships_with_http_info + # Get List # Get a list with the given list ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m`

Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`

To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo. @@ -438,7 +450,7 @@ def get_list_profiles_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] + allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end diff --git a/lib/klaviyo-api-sdk/api/metrics_api.rb b/lib/klaviyo-api-sdk/api/metrics_api.rb index d3f0f4d..cb4b10b 100644 --- a/lib/klaviyo-api-sdk/api/metrics_api.rb +++ b/lib/klaviyo-api-sdk/api/metrics_api.rb @@ -164,7 +164,7 @@ def get_metrics_with_http_info(opts = {}) end # Query Metric Aggregates - # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) * While the payload accepts a timezone, the response datetimes returned will be in UTC. For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `metrics:read` + # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. To request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview). Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). For a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `metrics:read` # @param metric_aggregate_query [MetricAggregateQuery] Retrieve Metric Aggregations # @param [Hash] opts the optional parameters # @return [Hash] @@ -173,8 +173,11 @@ def query_metric_aggregates(metric_aggregate_query, opts = {}) data end + # alias of `query_metric_aggregates` + alias create_metric_aggregate query_metric_aggregates + # Query Metric Aggregates - # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). **Request body parameters** (nested under `attributes`): * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values: * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`) * The time range can be filtered by providing a `greater-or-equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"` * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) * While the payload accepts a timezone, the response datetimes returned will be in UTC. For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` + # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request. To request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview). Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). For a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` # @param metric_aggregate_query [MetricAggregateQuery] Retrieve Metric Aggregations # @param [Hash] opts the optional parameters # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers @@ -232,5 +235,8 @@ def query_metric_aggregates_with_http_info(metric_aggregate_query, opts = {}) end return data, status_code, headers end + + # alias of `query_metric_aggregates_with_http_info` + alias create_metric_aggregate_with_http_info query_metric_aggregates_with_http_info end end diff --git a/lib/klaviyo-api-sdk/api/profiles_api.rb b/lib/klaviyo-api-sdk/api/profiles_api.rb index 250a86b..d0addc0 100644 --- a/lib/klaviyo-api-sdk/api/profiles_api.rb +++ b/lib/klaviyo-api-sdk/api/profiles_api.rb @@ -29,6 +29,9 @@ def create_or_update_profile(profile_upsert_query, opts = {}) data end + # alias of `create_or_update_profile` + alias create_profile_import create_or_update_profile + # Create or Update Profile # Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` # @param profile_upsert_query [ProfileUpsertQuery] @@ -89,6 +92,9 @@ def create_or_update_profile_with_http_info(profile_upsert_query, opts = {}) return data, status_code, headers end + # alias of `create_or_update_profile_with_http_info` + alias create_profile_import_with_http_info create_or_update_profile_with_http_info + # Create Profile # Create a new profile.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:write` # @param profile_create_query [ProfileCreateQuery] @@ -242,6 +248,9 @@ def get_bulk_profile_import_job(job_id, opts = {}) data end + # alias of `get_bulk_profile_import_job` + alias get_profile_bulk_import_job get_bulk_profile_import_job + # Get Bulk Profile Import Job # Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` # @param job_id [String] ID of the job to retrieve. @@ -315,6 +324,9 @@ def get_bulk_profile_import_job_with_http_info(job_id, opts = {}) return data, status_code, headers end + # alias of `get_bulk_profile_import_job_with_http_info` + alias get_profile_bulk_import_job_with_http_info get_bulk_profile_import_job_with_http_info + # Get Bulk Profile Import Job Errors # Get import errors for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] @@ -328,6 +340,9 @@ def get_bulk_profile_import_job_import_errors(id, opts = {}) data end + # alias of `get_bulk_profile_import_job_import_errors` + alias get_profile_bulk_import_job_import_errors get_bulk_profile_import_job_import_errors + # Get Bulk Profile Import Job Errors # Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] @@ -401,6 +416,9 @@ def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_bulk_profile_import_job_import_errors_with_http_info` + alias get_profile_bulk_import_job_import_errors_with_http_info get_bulk_profile_import_job_import_errors_with_http_info + # Get Bulk Profile Import Job Lists # Get list for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:read` # @param id [String] @@ -412,6 +430,9 @@ def get_bulk_profile_import_job_lists(id, opts = {}) data end + # alias of `get_bulk_profile_import_job_lists` + alias get_profile_bulk_import_job_lists get_bulk_profile_import_job_lists + # Get Bulk Profile Import Job Lists # Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` # @param id [String] @@ -473,6 +494,9 @@ def get_bulk_profile_import_job_lists_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_bulk_profile_import_job_lists_with_http_info` + alias get_profile_bulk_import_job_lists_with_http_info get_bulk_profile_import_job_lists_with_http_info + # Get Bulk Profile Import Job Profiles # Get profiles for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] @@ -487,6 +511,9 @@ def get_bulk_profile_import_job_profiles(id, opts = {}) data end + # alias of `get_bulk_profile_import_job_profiles` + alias get_profile_bulk_import_job_profiles get_bulk_profile_import_job_profiles + # Get Bulk Profile Import Job Profiles # Get profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] @@ -508,7 +535,7 @@ def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] + allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end @@ -566,6 +593,9 @@ def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {}) return data, status_code, headers end + # alias of `get_bulk_profile_import_job_profiles_with_http_info` + alias get_profile_bulk_import_job_profiles_with_http_info get_bulk_profile_import_job_profiles_with_http_info + # Get Bulk Profile Import Job Relationships Lists # Get list relationship for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:read` # @param id [String] @@ -576,6 +606,9 @@ def get_bulk_profile_import_job_relationships_lists(id, opts = {}) data end + # alias of `get_bulk_profile_import_job_relationships_lists` + alias get_profile_bulk_import_job_relationships_lists get_bulk_profile_import_job_relationships_lists + # Get Bulk Profile Import Job Relationships Lists # Get list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` # @param id [String] @@ -631,6 +664,9 @@ def get_bulk_profile_import_job_relationships_lists_with_http_info(id, opts = {} return data, status_code, headers end + # alias of `get_bulk_profile_import_job_relationships_lists_with_http_info` + alias get_profile_bulk_import_job_relationships_lists_with_http_info get_bulk_profile_import_job_relationships_lists_with_http_info + # Get Bulk Profile Import Job Relationships Profiles # Get profile relationships for the bulk profile import job with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] @@ -643,6 +679,9 @@ def get_bulk_profile_import_job_relationships_profiles(id, opts = {}) data end + # alias of `get_bulk_profile_import_job_relationships_profiles` + alias get_profile_bulk_import_job_relationships_profiles get_bulk_profile_import_job_relationships_profiles + # Get Bulk Profile Import Job Relationships Profiles # Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` # @param id [String] @@ -710,6 +749,9 @@ def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = return data, status_code, headers end + # alias of `get_bulk_profile_import_job_relationships_profiles_with_http_info` + alias get_profile_bulk_import_job_relationships_profiles_with_http_info get_bulk_profile_import_job_relationships_profiles_with_http_info + # Get Bulk Profile Import Jobs # Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:read` `profiles:read` # @param [Hash] opts the optional parameters @@ -724,6 +766,9 @@ def get_bulk_profile_import_jobs(opts = {}) data end + # alias of `get_bulk_profile_import_jobs` + alias get_profile_bulk_import_jobs get_bulk_profile_import_jobs + # Get Bulk Profile Import Jobs # Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read` # @param [Hash] opts the optional parameters @@ -800,6 +845,9 @@ def get_bulk_profile_import_jobs_with_http_info(opts = {}) return data, status_code, headers end + # alias of `get_bulk_profile_import_jobs_with_http_info` + alias get_profile_bulk_import_jobs_with_http_info get_bulk_profile_import_jobs_with_http_info + # Get Profile # Get the profile with the given profile ID.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:read` # @param id [String] @@ -841,7 +889,7 @@ def get_profile_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}" end - allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] + allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end @@ -1207,7 +1255,7 @@ def get_profiles_with_http_info(opts = {}) if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] + allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end @@ -1281,6 +1329,9 @@ def merge_profiles(profile_merge_query, opts = {}) data end + # alias of `merge_profiles` + alias create_profile_merge merge_profiles + # Merge Profiles # Merge a given related profile into a profile with the given profile ID. The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile. To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:write` # @param profile_merge_query [ProfileMergeQuery] @@ -1341,6 +1392,9 @@ def merge_profiles_with_http_info(profile_merge_query, opts = {}) return data, status_code, headers end + # alias of `merge_profiles_with_http_info` + alias create_profile_merge_with_http_info merge_profiles_with_http_info + # Spawn Bulk Profile Import Job # Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).

*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `lists:write` `profiles:write` # @param profile_import_job_create_query [ProfileImportJobCreateQuery] @@ -1351,6 +1405,9 @@ def spawn_bulk_profile_import_job(profile_import_job_create_query, opts = {}) data end + # alias of `spawn_bulk_profile_import_job` + alias create_profile_bulk_import_job spawn_bulk_profile_import_job + # Spawn Bulk Profile Import Job # Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write` # @param profile_import_job_create_query [ProfileImportJobCreateQuery] @@ -1411,6 +1468,9 @@ def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query return data, status_code, headers end + # alias of `spawn_bulk_profile_import_job_with_http_info` + alias create_profile_bulk_import_job_with_http_info spawn_bulk_profile_import_job_with_http_info + # Subscribe Profiles # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed. @@ -1421,6 +1481,9 @@ def subscribe_profiles(subscription_create_job_create_query, opts = {}) nil end + # alias of `subscribe_profiles` + alias create_profile_subscription_bulk_create_job subscribe_profiles + # Subscribe Profiles # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 1000 This endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed. @@ -1481,6 +1544,9 @@ def subscribe_profiles_with_http_info(subscription_create_job_create_query, opts return data, status_code, headers end + # alias of `subscribe_profiles_with_http_info` + alias create_profile_subscription_bulk_create_job_with_http_info subscribe_profiles_with_http_info + # Suppress Profiles # Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write` # @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed. @@ -1491,6 +1557,9 @@ def suppress_profiles(suppression_create_job_create_query, opts = {}) nil end + # alias of `suppress_profiles` + alias create_profile_suppression_bulk_create_job suppress_profiles + # Suppress Profiles # Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write` # @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed. @@ -1551,6 +1620,9 @@ def suppress_profiles_with_http_info(suppression_create_job_create_query, opts = return data, status_code, headers end + # alias of `suppress_profiles_with_http_info` + alias create_profile_suppression_bulk_create_job_with_http_info suppress_profiles_with_http_info + # Unsubscribe Profiles # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed. @@ -1561,6 +1633,9 @@ def unsubscribe_profiles(subscription_delete_job_create_query, opts = {}) nil end + # alias of `unsubscribe_profiles` + alias create_profile_subscription_bulk_delete_job unsubscribe_profiles + # Unsubscribe Profiles # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write` # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed. @@ -1621,6 +1696,9 @@ def unsubscribe_profiles_with_http_info(subscription_delete_job_create_query, op return data, status_code, headers end + # alias of `unsubscribe_profiles_with_http_info` + alias create_profile_subscription_bulk_delete_job_with_http_info unsubscribe_profiles_with_http_info + # Unsuppress Profiles # Manually unsuppress profiles using their email address, or by specifying a segment or list ID to unsuppress all current members. This only removes suppressions with reason `USER_SUPPRESSED`, leaving unsubscribed profiles and profiles suppressed with reason `INVALID_EMAIL` or `HARD_BOUNCE` unchanged. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `subscriptions:write` # @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken. @@ -1631,6 +1709,9 @@ def unsuppress_profiles(suppression_delete_job_create_query, opts = {}) nil end + # alias of `unsuppress_profiles` + alias create_profile_suppression_bulk_delete_job unsuppress_profiles + # Unsuppress Profiles # Manually unsuppress profiles using their email address, or by specifying a segment or list ID to unsuppress all current members. This only removes suppressions with reason `USER_SUPPRESSED`, leaving unsubscribed profiles and profiles suppressed with reason `INVALID_EMAIL` or `HARD_BOUNCE` unchanged. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write` # @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken. @@ -1691,6 +1772,9 @@ def unsuppress_profiles_with_http_info(suppression_delete_job_create_query, opts return data, status_code, headers end + # alias of `unsuppress_profiles_with_http_info` + alias create_profile_suppression_bulk_delete_job_with_http_info unsuppress_profiles_with_http_info + # Update Profile # Update the profile with the given profile ID. Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.

*Rate limits*:
Burst: `75/s`
Steady: `700/m` **Scopes:** `profiles:write` # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo. diff --git a/lib/klaviyo-api-sdk/api/reporting_api.rb b/lib/klaviyo-api-sdk/api/reporting_api.rb index 2881b11..ccc3bf8 100644 --- a/lib/klaviyo-api-sdk/api/reporting_api.rb +++ b/lib/klaviyo-api-sdk/api/reporting_api.rb @@ -30,6 +30,9 @@ def query_campaign_values(campaign_values_request_dto, opts = {}) data end + # alias of `query_campaign_values` + alias create_campaign_value_report query_campaign_values + # Query Campaign Values # Returns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `campaigns:read` # @param campaign_values_request_dto [CampaignValuesRequestDTO] @@ -92,6 +95,9 @@ def query_campaign_values_with_http_info(campaign_values_request_dto, opts = {}) return data, status_code, headers end + # alias of `query_campaign_values_with_http_info` + alias create_campaign_value_report_with_http_info query_campaign_values_with_http_info + # Query Flow Series # Returns the requested flow analytics series data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `flows:read` # @param flow_series_request_dto [FlowSeriesRequestDTO] @@ -103,6 +109,9 @@ def query_flow_series(flow_series_request_dto, opts = {}) data end + # alias of `query_flow_series` + alias create_flow_sery_report query_flow_series + # Query Flow Series # Returns the requested flow analytics series data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` # @param flow_series_request_dto [FlowSeriesRequestDTO] @@ -165,6 +174,9 @@ def query_flow_series_with_http_info(flow_series_request_dto, opts = {}) return data, status_code, headers end + # alias of `query_flow_series_with_http_info` + alias create_flow_sery_report_with_http_info query_flow_series_with_http_info + # Query Flow Values # Returns the requested flow analytics values data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `flows:read` # @param flow_values_request_dto [FlowValuesRequestDTO] @@ -176,6 +188,9 @@ def query_flow_values(flow_values_request_dto, opts = {}) data end + # alias of `query_flow_values` + alias create_flow_value_report query_flow_values + # Query Flow Values # Returns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read` # @param flow_values_request_dto [FlowValuesRequestDTO] @@ -237,5 +252,8 @@ def query_flow_values_with_http_info(flow_values_request_dto, opts = {}) end return data, status_code, headers end + + # alias of `query_flow_values_with_http_info` + alias create_flow_value_report_with_http_info query_flow_values_with_http_info end end diff --git a/lib/klaviyo-api-sdk/api/segments_api.rb b/lib/klaviyo-api-sdk/api/segments_api.rb index a598440..2def003 100644 --- a/lib/klaviyo-api-sdk/api/segments_api.rb +++ b/lib/klaviyo-api-sdk/api/segments_api.rb @@ -286,7 +286,7 @@ def get_segment_profiles_with_http_info(id, opts = {}) if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}" end - allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] + allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"] if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}" end diff --git a/lib/klaviyo-api-sdk/api/tags_api.rb b/lib/klaviyo-api-sdk/api/tags_api.rb index 4e5d168..9a7dde4 100644 --- a/lib/klaviyo-api-sdk/api/tags_api.rb +++ b/lib/klaviyo-api-sdk/api/tags_api.rb @@ -170,6 +170,9 @@ def create_tag_relationships_campaigns(id, tag_campaign_op, opts = {}) nil end + # alias of `create_tag_relationships_campaigns` + alias create_tag_relationships_campaign create_tag_relationships_campaigns + # Create Tag Relationships Campaigns # Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:write` `tags:write` # @param id [String] @@ -235,6 +238,9 @@ def create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts return data, status_code, headers end + # alias of `create_tag_relationships_campaigns_with_http_info` + alias create_tag_relationships_campaign_with_http_info create_tag_relationships_campaigns_with_http_info + # Create Tag Relationships Flows # Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:write` `tags:write` # @param id [String] @@ -246,6 +252,9 @@ def create_tag_relationships_flows(id, tag_flow_op, opts = {}) nil end + # alias of `create_tag_relationships_flows` + alias create_tag_relationships_flow create_tag_relationships_flows + # Create Tag Relationships Flows # Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write` `tags:write` # @param id [String] @@ -311,6 +320,9 @@ def create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) return data, status_code, headers end + # alias of `create_tag_relationships_flows_with_http_info` + alias create_tag_relationships_flow_with_http_info create_tag_relationships_flows_with_http_info + # Create Tag Relationships Lists # Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `lists:write` `tags:write` # @param id [String] @@ -322,6 +334,9 @@ def create_tag_relationships_lists(id, tag_list_op, opts = {}) nil end + # alias of `create_tag_relationships_lists` + alias create_tag_relationships_list create_tag_relationships_lists + # Create Tag Relationships Lists # Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:write` `tags:write` # @param id [String] @@ -387,6 +402,9 @@ def create_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) return data, status_code, headers end + # alias of `create_tag_relationships_lists_with_http_info` + alias create_tag_relationships_list_with_http_info create_tag_relationships_lists_with_http_info + # Create Tag Relationships Segments # Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `segments:write` `tags:write` # @param id [String] @@ -398,6 +416,9 @@ def create_tag_relationships_segments(id, tag_segment_op, opts = {}) nil end + # alias of `create_tag_relationships_segments` + alias create_tag_relationships_segment create_tag_relationships_segments + # Create Tag Relationships Segments # Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write` `tags:write` # @param id [String] @@ -463,6 +484,9 @@ def create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = return data, status_code, headers end + # alias of `create_tag_relationships_segments_with_http_info` + alias create_tag_relationships_segment_with_http_info create_tag_relationships_segments_with_http_info + # Delete Tag # Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `tags:read` `tags:write` # @param id [String] The Tag ID diff --git a/lib/klaviyo-api-sdk/api_client.rb b/lib/klaviyo-api-sdk/api_client.rb index 630f10e..e4476ca 100644 --- a/lib/klaviyo-api-sdk/api_client.rb +++ b/lib/klaviyo-api-sdk/api_client.rb @@ -32,7 +32,7 @@ class ApiClient # @option config [Configuration] Configuration for initializing the object, default to Configuration.default def initialize(config = Configuration.default) @config = config - @user_agent = "klaviyo-api-ruby/8.0.0" + @user_agent = "klaviyo-api-ruby/9.0.0" @default_headers = { 'Content-Type' => 'application/json', 'User-Agent' => @user_agent