diff --git a/CHANGELOG.md b/CHANGELOG.md
index c41312a..1b1fb22 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,28 @@ 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).
+## [7.0.0] - revision 2024-05-15
+
+### Added
+
+ - Bulk Create Events API with
+ - We have added support for creating events in bulk via the `KlaviyoAPI::Event.bulk_create_events` method
+ - Create multiple events for new and existing profiles and/or update profile properties in a single API call. For more information, see our [Events API overview](https://developers.klaviyo.com/en/reference/events_api_overview).
+
+### Changed
+
+ - Accounts Api
+ - `KlaviyoAPI::Accounts.get_accounts` and `KlaviyoAPI::Accounts.get_account` have been updated to return the account's locale, e.g. `en-US`.
+
+ - **Breaking** Subscribe API Synchronous Validation Improved
+ - To provide better feedback for handling SMS subscriptions, we’ve added improved validation behavior to `KlaviyoAPI::Profiles.subscribe_profiles` method. In prior revisions, such requests may appear as 202s but will fail to update SMS consent. To handle this issue, 400 validation errors are returned for the following cases
+ 1. If a profile is subscribed to SMS marketing and [age-gating is enabled](https://help.klaviyo.com/hc/en-us/articles/4408311712667) but age_gated_date_of_birth is not provided, or the DOB does not meet the region's requirements.
+ 2. If the account does not have a sending number in the phone number’s region.
+ 3. If the phone number is in a region not supported by Klaviyo.
+ 4. If consented_at is set and the list or global setting is double opt-in.
+ - Use `KLAVIYO_API_REVISION` as the env var for controlling which Klaviyo API to call, instead of `API_REVISION`. However, `API_REVISION` is a fallback, to avoid making this a breaking change
+
+
## [6.0.0] - revision 2024-02-15
### Added:
diff --git a/README.md b/README.md
index 1ed3483..e25e7f6 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
# Klaviyo Ruby SDK
-- SDK version: 6.0.0
-- API revision: 2024-02-15
+- SDK version: 7.0.0
+- API revision: 2024-05-15
## Helpful Resources
-- [API Reference](https://developers.klaviyo.com/en/v2024-02-15/reference)
-- [API Guides](https://developers.klaviyo.com/en/v2024-02-15/docs)
+- [API Reference](https://developers.klaviyo.com/en/v2024-05-15/reference)
+- [API Guides](https://developers.klaviyo.com/en/v2024-05-15/docs)
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
## Design & Approach
@@ -94,13 +94,13 @@ gem build klaviyo-api-sdk.gemspec
Then install the gem locally:
```shell
-gem install ./klaviyo-api-sdk-6.0.0.gem
+gem install ./klaviyo-api-sdk-7.0.0.gem
```
Finally add this to the Gemfile:
- gem 'klaviyo-api-sdk', '~> 6.0.0'
+ gem 'klaviyo-api-sdk', '~> 7.0.0'
To install directly from rubygems:
@@ -464,7 +464,7 @@ response = KlaviyoAPI::Events.get_events(opts)
## Comprehensive list of Operations & Parameters
_**NOTE:**_
-- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2024-02-15/reference/get_events).
+- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2024-05-15/reference/get_events).
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
@@ -476,7 +476,7 @@ _**NOTE:**_
## Accounts
-#### [Get Account](https://developers.klaviyo.com/en/v2024-02-15/reference/get_account)
+#### [Get Account](https://developers.klaviyo.com/en/v2024-05-15/reference/get_account)
```ruby
KlaviyoAPI::Accounts.get_account(id, opts)
@@ -486,7 +486,7 @@ KlaviyoAPI::Accounts.get_account(id, opts)
-#### [Get Accounts](https://developers.klaviyo.com/en/v2024-02-15/reference/get_accounts)
+#### [Get Accounts](https://developers.klaviyo.com/en/v2024-05-15/reference/get_accounts)
```ruby
KlaviyoAPI::Accounts.get_accounts(opts)
@@ -500,7 +500,7 @@ KlaviyoAPI::Accounts.get_accounts(opts)
## Campaigns
-#### [Create Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign)
+#### [Create Campaign](https://developers.klaviyo.com/en/v2024-05-15/reference/create_campaign)
```ruby
KlaviyoAPI::Campaigns.create_campaign(body)
@@ -510,7 +510,7 @@ KlaviyoAPI::Campaigns.create_campaign(body)
-#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_clone)
+#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2024-05-15/reference/create_campaign_clone)
```ruby
KlaviyoAPI::Campaigns.create_campaign_clone(body)
@@ -520,7 +520,7 @@ KlaviyoAPI::Campaigns.create_campaign_clone(body)
-#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_message_assign_template)
+#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2024-05-15/reference/create_campaign_message_assign_template)
```ruby
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
@@ -530,7 +530,7 @@ KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
-#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_recipient_estimation_job)
+#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-05-15/reference/create_campaign_recipient_estimation_job)
```ruby
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
@@ -540,7 +540,7 @@ KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
-#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2024-02-15/reference/create_campaign_send_job)
+#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2024-05-15/reference/create_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
@@ -550,7 +550,7 @@ KlaviyoAPI::Campaigns.create_campaign_send_job(body)
-#### [Delete Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_campaign)
+#### [Delete Campaign](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_campaign)
```ruby
KlaviyoAPI::Campaigns.delete_campaign(id)
@@ -560,7 +560,7 @@ KlaviyoAPI::Campaigns.delete_campaign(id)
-#### [Get Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign)
+#### [Get Campaign](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign(id, opts)
@@ -570,7 +570,7 @@ KlaviyoAPI::Campaigns.get_campaign(id, opts)
-#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_campaign_messages)
+#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_campaign_messages)
```ruby
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
@@ -580,7 +580,7 @@ KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
-#### [Get Campaign Message](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message)
+#### [Get Campaign Message](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_message)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
@@ -590,7 +590,7 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
-#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_campaign)
+#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_message_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
@@ -600,7 +600,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
-#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_relationships_campaign)
+#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_message_relationships_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
@@ -610,7 +610,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
-#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_relationships_template)
+#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_message_relationships_template)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
@@ -620,7 +620,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
-#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_message_template)
+#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_message_template)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
@@ -630,7 +630,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
-#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_recipient_estimation)
+#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_recipient_estimation)
```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
@@ -640,7 +640,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
-#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_recipient_estimation_job)
+#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_recipient_estimation_job)
```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
@@ -650,7 +650,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
-#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_relationships_campaign_messages)
+#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_relationships_campaign_messages)
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
@@ -660,7 +660,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
-#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_relationships_tags)
+#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_relationships_tags)
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
@@ -670,7 +670,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
-#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_send_job)
+#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
@@ -680,7 +680,7 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
-#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaign_tags)
+#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaign_tags)
```ruby
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
@@ -690,7 +690,7 @@ KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
-#### [Get Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/get_campaigns)
+#### [Get Campaigns](https://developers.klaviyo.com/en/v2024-05-15/reference/get_campaigns)
```ruby
KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
@@ -700,7 +700,7 @@ KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
-#### [Update Campaign](https://developers.klaviyo.com/en/v2024-02-15/reference/update_campaign)
+#### [Update Campaign](https://developers.klaviyo.com/en/v2024-05-15/reference/update_campaign)
```ruby
KlaviyoAPI::Campaigns.update_campaign(id, body)
@@ -710,7 +710,7 @@ KlaviyoAPI::Campaigns.update_campaign(id, body)
-#### [Update Campaign Message](https://developers.klaviyo.com/en/v2024-02-15/reference/update_campaign_message)
+#### [Update Campaign Message](https://developers.klaviyo.com/en/v2024-05-15/reference/update_campaign_message)
```ruby
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
@@ -720,7 +720,7 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body)
-#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2024-02-15/reference/update_campaign_send_job)
+#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2024-05-15/reference/update_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
@@ -734,7 +734,7 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
## Catalogs
-#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2024-02-15/reference/create_back_in_stock_subscription)
+#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2024-05-15/reference/create_back_in_stock_subscription)
```ruby
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
@@ -744,7 +744,7 @@ KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
-#### [Create Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_category)
+#### [Create Catalog Category](https://developers.klaviyo.com/en/v2024-05-15/reference/create_catalog_category)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category(body)
@@ -754,7 +754,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
-#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_category_relationships_items)
+#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-05-15/reference/create_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
@@ -764,7 +764,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
-#### [Create Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_item)
+#### [Create Catalog Item](https://developers.klaviyo.com/en/v2024-05-15/reference/create_catalog_item)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item(body)
@@ -774,7 +774,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
-#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_item_relationships_categories)
+#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-05-15/reference/create_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
@@ -784,7 +784,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
-#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/create_catalog_variant)
+#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2024-05-15/reference/create_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.create_catalog_variant(body)
@@ -794,7 +794,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
-#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_category)
+#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_catalog_category)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category(id)
@@ -804,7 +804,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
-#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_category_relationships_items)
+#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
@@ -814,7 +814,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
-#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_item)
+#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_catalog_item)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item(id)
@@ -824,7 +824,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
-#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_item_relationships_categories)
+#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
@@ -834,7 +834,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
-#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_catalog_variant)
+#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
@@ -844,7 +844,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
-#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_categories)
+#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
@@ -854,7 +854,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
-#### [Get Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_category)
+#### [Get Catalog Category](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_category)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
@@ -864,7 +864,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
-#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_category_items)
+#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_category_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
@@ -874,7 +874,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
-#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_category_relationships_items)
+#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
@@ -884,7 +884,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
-#### [Get Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item)
+#### [Get Catalog Item](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_item)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
@@ -894,7 +894,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
-#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item_categories)
+#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_item_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
@@ -904,7 +904,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
-#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item_relationships_categories)
+#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
@@ -914,7 +914,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
-#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_item_variants)
+#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_item_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
@@ -924,7 +924,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
-#### [Get Catalog Items](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_items)
+#### [Get Catalog Items](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_items(opts)
@@ -934,7 +934,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
-#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_variant)
+#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
@@ -944,7 +944,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
-#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2024-02-15/reference/get_catalog_variants)
+#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2024-05-15/reference/get_catalog_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
@@ -954,7 +954,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
-#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_categories_job)
+#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
@@ -964,7 +964,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
-#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_categories_jobs)
+#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_create_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
@@ -974,7 +974,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
-#### [Get Create Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_items_job)
+#### [Get Create Items Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_create_items_job)
```ruby
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
@@ -984,7 +984,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
-#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_items_jobs)
+#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_create_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
@@ -994,7 +994,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
-#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_variants_job)
+#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
@@ -1004,7 +1004,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
-#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_create_variants_jobs)
+#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_create_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
@@ -1014,7 +1014,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
-#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_categories_job)
+#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
@@ -1024,7 +1024,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
-#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_categories_jobs)
+#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_delete_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
@@ -1034,7 +1034,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
-#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_items_job)
+#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
@@ -1044,7 +1044,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
-#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_items_jobs)
+#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_delete_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
@@ -1054,7 +1054,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
-#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_variants_job)
+#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
@@ -1064,7 +1064,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
-#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_delete_variants_jobs)
+#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_delete_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
@@ -1074,7 +1074,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
-#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_categories_job)
+#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
@@ -1084,7 +1084,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
-#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_categories_jobs)
+#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_update_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
@@ -1094,7 +1094,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
-#### [Get Update Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_items_job)
+#### [Get Update Items Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_update_items_job)
```ruby
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
@@ -1104,7 +1104,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
-#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_items_jobs)
+#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_update_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
@@ -1114,7 +1114,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
-#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_variants_job)
+#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
@@ -1124,7 +1124,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
-#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_update_variants_jobs)
+#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_update_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
@@ -1134,7 +1134,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
-#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_create_categories_job)
+#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
@@ -1144,7 +1144,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
-#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_create_items_job)
+#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_create_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
@@ -1154,7 +1154,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
-#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_create_variants_job)
+#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
@@ -1164,7 +1164,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
-#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_delete_categories_job)
+#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
@@ -1174,7 +1174,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
-#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_delete_items_job)
+#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
@@ -1184,7 +1184,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
-#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_delete_variants_job)
+#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
@@ -1194,7 +1194,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
-#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_update_categories_job)
+#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
@@ -1204,7 +1204,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
-#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_update_items_job)
+#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_update_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
@@ -1214,7 +1214,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
-#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_update_variants_job)
+#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
@@ -1224,7 +1224,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
-#### [Update Catalog Category](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_category)
+#### [Update Catalog Category](https://developers.klaviyo.com/en/v2024-05-15/reference/update_catalog_category)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
@@ -1234,7 +1234,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
-#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_category_relationships_items)
+#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-05-15/reference/update_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
@@ -1244,7 +1244,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
-#### [Update Catalog Item](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_item)
+#### [Update Catalog Item](https://developers.klaviyo.com/en/v2024-05-15/reference/update_catalog_item)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
@@ -1254,7 +1254,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
-#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_item_relationships_categories)
+#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-05-15/reference/update_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
@@ -1264,7 +1264,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
-#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2024-02-15/reference/update_catalog_variant)
+#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2024-05-15/reference/update_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
@@ -1278,7 +1278,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
## Coupons
-#### [Create Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/create_coupon)
+#### [Create Coupon](https://developers.klaviyo.com/en/v2024-05-15/reference/create_coupon)
```ruby
KlaviyoAPI::Coupons.create_coupon(body)
@@ -1288,7 +1288,7 @@ KlaviyoAPI::Coupons.create_coupon(body)
-#### [Create Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/create_coupon_code)
+#### [Create Coupon Code](https://developers.klaviyo.com/en/v2024-05-15/reference/create_coupon_code)
```ruby
KlaviyoAPI::Coupons.create_coupon_code(body)
@@ -1298,7 +1298,7 @@ KlaviyoAPI::Coupons.create_coupon_code(body)
-#### [Delete Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_coupon)
+#### [Delete Coupon](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_coupon)
```ruby
KlaviyoAPI::Coupons.delete_coupon(id)
@@ -1308,7 +1308,7 @@ KlaviyoAPI::Coupons.delete_coupon(id)
-#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_coupon_code)
+#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_coupon_code)
```ruby
KlaviyoAPI::Coupons.delete_coupon_code(id)
@@ -1318,7 +1318,7 @@ KlaviyoAPI::Coupons.delete_coupon_code(id)
-#### [Get Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon)
+#### [Get Coupon](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon(id, opts)
@@ -1328,7 +1328,7 @@ KlaviyoAPI::Coupons.get_coupon(id, opts)
-#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code)
+#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_code)
```ruby
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
@@ -1338,7 +1338,7 @@ KlaviyoAPI::Coupons.get_coupon_code(id, opts)
-#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code_bulk_create_job)
+#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_code_bulk_create_job)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
@@ -1348,7 +1348,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
-#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code_bulk_create_jobs)
+#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_code_bulk_create_jobs)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
@@ -1358,7 +1358,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
-#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_code_relationships_coupon)
+#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_code_relationships_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
@@ -1368,7 +1368,7 @@ KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
-#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_codes)
+#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_codes)
```ruby
KlaviyoAPI::Coupons.get_coupon_codes(opts)
@@ -1378,7 +1378,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts)
-#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_codes_for_coupon)
+#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_codes_for_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
@@ -1388,7 +1388,7 @@ KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
-#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_for_coupon_code)
+#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_for_coupon_code)
```ruby
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
@@ -1398,7 +1398,7 @@ KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
-#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupon_relationships_coupon_codes)
+#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupon_relationships_coupon_codes)
```ruby
KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
@@ -1408,7 +1408,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
-#### [Get Coupons](https://developers.klaviyo.com/en/v2024-02-15/reference/get_coupons)
+#### [Get Coupons](https://developers.klaviyo.com/en/v2024-05-15/reference/get_coupons)
```ruby
KlaviyoAPI::Coupons.get_coupons(opts)
@@ -1418,7 +1418,7 @@ KlaviyoAPI::Coupons.get_coupons(opts)
-#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_coupon_code_bulk_create_job)
+#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_coupon_code_bulk_create_job)
```ruby
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
@@ -1428,7 +1428,7 @@ KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
-#### [Update Coupon](https://developers.klaviyo.com/en/v2024-02-15/reference/update_coupon)
+#### [Update Coupon](https://developers.klaviyo.com/en/v2024-05-15/reference/update_coupon)
```ruby
KlaviyoAPI::Coupons.update_coupon(id, body)
@@ -1438,7 +1438,7 @@ KlaviyoAPI::Coupons.update_coupon(id, body)
-#### [Update Coupon Code](https://developers.klaviyo.com/en/v2024-02-15/reference/update_coupon_code)
+#### [Update Coupon Code](https://developers.klaviyo.com/en/v2024-05-15/reference/update_coupon_code)
```ruby
KlaviyoAPI::Coupons.update_coupon_code(id, body)
@@ -1452,7 +1452,7 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body)
## Data Privacy
-#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-02-15/reference/request_profile_deletion)
+#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-05-15/reference/request_profile_deletion)
```ruby
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
@@ -1466,7 +1466,17 @@ KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
## Events
-#### [Create Event](https://developers.klaviyo.com/en/v2024-02-15/reference/create_event)
+#### [Bulk Create Events](https://developers.klaviyo.com/en/v2024-05-15/reference/bulk_create_events)
+
+```ruby
+KlaviyoAPI::Events.bulk_create_events(body)
+```
+
+
+
+
+
+#### [Create Event](https://developers.klaviyo.com/en/v2024-05-15/reference/create_event)
```ruby
KlaviyoAPI::Events.create_event(body)
@@ -1476,7 +1486,7 @@ KlaviyoAPI::Events.create_event(body)
-#### [Get Event](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event)
+#### [Get Event](https://developers.klaviyo.com/en/v2024-05-15/reference/get_event)
```ruby
KlaviyoAPI::Events.get_event(id, opts)
@@ -1486,7 +1496,7 @@ KlaviyoAPI::Events.get_event(id, opts)
-#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_metric)
+#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-05-15/reference/get_event_metric)
```ruby
KlaviyoAPI::Events.get_event_metric(id, opts)
@@ -1496,7 +1506,7 @@ KlaviyoAPI::Events.get_event_metric(id, opts)
-#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_profile)
+#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-05-15/reference/get_event_profile)
```ruby
KlaviyoAPI::Events.get_event_profile(id, opts)
@@ -1506,7 +1516,7 @@ KlaviyoAPI::Events.get_event_profile(id, opts)
-#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_relationships_metric)
+#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2024-05-15/reference/get_event_relationships_metric)
```ruby
KlaviyoAPI::Events.get_event_relationships_metric(id)
@@ -1516,7 +1526,7 @@ KlaviyoAPI::Events.get_event_relationships_metric(id)
-#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/get_event_relationships_profile)
+#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2024-05-15/reference/get_event_relationships_profile)
```ruby
KlaviyoAPI::Events.get_event_relationships_profile(id)
@@ -1526,7 +1536,7 @@ KlaviyoAPI::Events.get_event_relationships_profile(id)
-#### [Get Events](https://developers.klaviyo.com/en/v2024-02-15/reference/get_events)
+#### [Get Events](https://developers.klaviyo.com/en/v2024-05-15/reference/get_events)
```ruby
KlaviyoAPI::Events.get_events(opts)
@@ -1540,7 +1550,7 @@ KlaviyoAPI::Events.get_events(opts)
## Flows
-#### [Get Flow](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow)
+#### [Get Flow](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow)
```ruby
KlaviyoAPI::Flows.get_flow(id, opts)
@@ -1550,7 +1560,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
-#### [Get Flow Action](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action)
+#### [Get Flow Action](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_action)
```ruby
KlaviyoAPI::Flows.get_flow_action(id, opts)
@@ -1560,7 +1570,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
-#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_flow)
+#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_action_flow)
```ruby
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
@@ -1570,7 +1580,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
-#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_messages)
+#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_action_messages)
```ruby
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
@@ -1580,7 +1590,7 @@ KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
-#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_relationships_flow)
+#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_action_relationships_flow)
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
@@ -1590,7 +1600,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
-#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_action_relationships_messages)
+#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_action_relationships_messages)
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
@@ -1600,7 +1610,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
-#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_flow_actions)
+#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_flow_actions)
```ruby
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
@@ -1610,7 +1620,7 @@ KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
-#### [Get Flow Message](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message)
+#### [Get Flow Message](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_message)
```ruby
KlaviyoAPI::Flows.get_flow_message(id, opts)
@@ -1620,7 +1630,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
-#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_action)
+#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_message_action)
```ruby
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
@@ -1630,7 +1640,7 @@ KlaviyoAPI::Flows.get_flow_message_action(id, opts)
-#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_relationships_action)
+#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_message_relationships_action)
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
@@ -1640,7 +1650,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
-#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_relationships_template)
+#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_message_relationships_template)
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
@@ -1650,7 +1660,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
-#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_message_template)
+#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_message_template)
```ruby
KlaviyoAPI::Flows.get_flow_message_template(id, opts)
@@ -1660,7 +1670,7 @@ KlaviyoAPI::Flows.get_flow_message_template(id, opts)
-#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_relationships_flow_actions)
+#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_relationships_flow_actions)
```ruby
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
@@ -1670,7 +1680,7 @@ KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
-#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_relationships_tags)
+#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_relationships_tags)
```ruby
KlaviyoAPI::Flows.get_flow_relationships_tags(id)
@@ -1680,7 +1690,7 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
-#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flow_tags)
+#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flow_tags)
```ruby
KlaviyoAPI::Flows.get_flow_tags(id, opts)
@@ -1690,7 +1700,7 @@ KlaviyoAPI::Flows.get_flow_tags(id, opts)
-#### [Get Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/get_flows)
+#### [Get Flows](https://developers.klaviyo.com/en/v2024-05-15/reference/get_flows)
```ruby
KlaviyoAPI::Flows.get_flows(opts)
@@ -1700,7 +1710,7 @@ KlaviyoAPI::Flows.get_flows(opts)
-#### [Update Flow Status](https://developers.klaviyo.com/en/v2024-02-15/reference/update_flow)
+#### [Update Flow Status](https://developers.klaviyo.com/en/v2024-05-15/reference/update_flow)
```ruby
KlaviyoAPI::Flows.update_flow(id, body)
@@ -1714,7 +1724,7 @@ KlaviyoAPI::Flows.update_flow(id, body)
## Images
-#### [Get Image](https://developers.klaviyo.com/en/v2024-02-15/reference/get_image)
+#### [Get Image](https://developers.klaviyo.com/en/v2024-05-15/reference/get_image)
```ruby
KlaviyoAPI::Images.get_image(id, opts)
@@ -1724,7 +1734,7 @@ KlaviyoAPI::Images.get_image(id, opts)
-#### [Get Images](https://developers.klaviyo.com/en/v2024-02-15/reference/get_images)
+#### [Get Images](https://developers.klaviyo.com/en/v2024-05-15/reference/get_images)
```ruby
KlaviyoAPI::Images.get_images(opts)
@@ -1734,7 +1744,7 @@ KlaviyoAPI::Images.get_images(opts)
-#### [Update Image](https://developers.klaviyo.com/en/v2024-02-15/reference/update_image)
+#### [Update Image](https://developers.klaviyo.com/en/v2024-05-15/reference/update_image)
```ruby
KlaviyoAPI::Images.update_image(id, body)
@@ -1744,7 +1754,7 @@ KlaviyoAPI::Images.update_image(id, body)
-#### [Upload Image From File](https://developers.klaviyo.com/en/v2024-02-15/reference/upload_image_from_file)
+#### [Upload Image From File](https://developers.klaviyo.com/en/v2024-05-15/reference/upload_image_from_file)
```ruby
KlaviyoAPI::Images.upload_image_from_file(file, opts)
@@ -1754,7 +1764,7 @@ KlaviyoAPI::Images.upload_image_from_file(file, opts)
-#### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-02-15/reference/upload_image_from_url)
+#### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-05-15/reference/upload_image_from_url)
```ruby
KlaviyoAPI::Images.upload_image_from_url(body)
@@ -1768,7 +1778,7 @@ KlaviyoAPI::Images.upload_image_from_url(body)
## Lists
-#### [Create List](https://developers.klaviyo.com/en/v2024-02-15/reference/create_list)
+#### [Create List](https://developers.klaviyo.com/en/v2024-05-15/reference/create_list)
```ruby
KlaviyoAPI::Lists.create_list(body)
@@ -1778,7 +1788,7 @@ KlaviyoAPI::Lists.create_list(body)
-#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-02-15/reference/create_list_relationships)
+#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-05-15/reference/create_list_relationships)
```ruby
KlaviyoAPI::Lists.create_list_relationships(id, body)
@@ -1788,7 +1798,7 @@ KlaviyoAPI::Lists.create_list_relationships(id, body)
-#### [Delete List](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_list)
+#### [Delete List](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_list)
```ruby
KlaviyoAPI::Lists.delete_list(id)
@@ -1798,7 +1808,7 @@ KlaviyoAPI::Lists.delete_list(id)
-#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_list_relationships)
+#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_list_relationships)
```ruby
KlaviyoAPI::Lists.delete_list_relationships(id, body)
@@ -1808,7 +1818,7 @@ KlaviyoAPI::Lists.delete_list_relationships(id, body)
-#### [Get List](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list)
+#### [Get List](https://developers.klaviyo.com/en/v2024-05-15/reference/get_list)
```ruby
KlaviyoAPI::Lists.get_list(id, opts)
@@ -1818,7 +1828,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
-#### [Get List Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_profiles)
+#### [Get List Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/get_list_profiles)
```ruby
KlaviyoAPI::Lists.get_list_profiles(id, opts)
@@ -1828,7 +1838,7 @@ KlaviyoAPI::Lists.get_list_profiles(id, opts)
-#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_relationships_profiles)
+#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/get_list_relationships_profiles)
```ruby
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
@@ -1838,7 +1848,7 @@ KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
-#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_relationships_tags)
+#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_list_relationships_tags)
```ruby
KlaviyoAPI::Lists.get_list_relationships_tags(id)
@@ -1848,7 +1858,7 @@ KlaviyoAPI::Lists.get_list_relationships_tags(id)
-#### [Get List Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_list_tags)
+#### [Get List Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_list_tags)
```ruby
KlaviyoAPI::Lists.get_list_tags(id, opts)
@@ -1858,7 +1868,7 @@ KlaviyoAPI::Lists.get_list_tags(id, opts)
-#### [Get Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_lists)
+#### [Get Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/get_lists)
```ruby
KlaviyoAPI::Lists.get_lists(opts)
@@ -1868,7 +1878,7 @@ KlaviyoAPI::Lists.get_lists(opts)
-#### [Update List](https://developers.klaviyo.com/en/v2024-02-15/reference/update_list)
+#### [Update List](https://developers.klaviyo.com/en/v2024-05-15/reference/update_list)
```ruby
KlaviyoAPI::Lists.update_list(id, body)
@@ -1882,7 +1892,7 @@ KlaviyoAPI::Lists.update_list(id, body)
## Metrics
-#### [Get Metric](https://developers.klaviyo.com/en/v2024-02-15/reference/get_metric)
+#### [Get Metric](https://developers.klaviyo.com/en/v2024-05-15/reference/get_metric)
```ruby
KlaviyoAPI::Metrics.get_metric(id, opts)
@@ -1892,7 +1902,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
-#### [Get Metrics](https://developers.klaviyo.com/en/v2024-02-15/reference/get_metrics)
+#### [Get Metrics](https://developers.klaviyo.com/en/v2024-05-15/reference/get_metrics)
```ruby
KlaviyoAPI::Metrics.get_metrics(opts)
@@ -1902,7 +1912,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
-#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2024-02-15/reference/query_metric_aggregates)
+#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2024-05-15/reference/query_metric_aggregates)
```ruby
KlaviyoAPI::Metrics.query_metric_aggregates(body)
@@ -1916,7 +1926,7 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
## Profiles
-#### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/create_or_update_profile)
+#### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-05-15/reference/create_or_update_profile)
```ruby
KlaviyoAPI::Profiles.create_or_update_profile(body)
@@ -1926,7 +1936,7 @@ KlaviyoAPI::Profiles.create_or_update_profile(body)
-#### [Create Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/create_profile)
+#### [Create Profile](https://developers.klaviyo.com/en/v2024-05-15/reference/create_profile)
```ruby
KlaviyoAPI::Profiles.create_profile(body)
@@ -1936,7 +1946,7 @@ KlaviyoAPI::Profiles.create_profile(body)
-#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2024-02-15/reference/create_push_token)
+#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2024-05-15/reference/create_push_token)
```ruby
KlaviyoAPI::Profiles.create_push_token(body)
@@ -1946,7 +1956,7 @@ KlaviyoAPI::Profiles.create_push_token(body)
-#### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job)
+#### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-05-15/reference/get_bulk_profile_import_job)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
@@ -1956,7 +1966,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
-#### [Get Bulk Profile Import Job Errors](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_import_errors)
+#### [Get Bulk Profile Import Job Errors](https://developers.klaviyo.com/en/v2024-05-15/reference/get_bulk_profile_import_job_import_errors)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
@@ -1966,7 +1976,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
-#### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_lists)
+#### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/get_bulk_profile_import_job_lists)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
@@ -1976,7 +1986,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
-#### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_profiles)
+#### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/get_bulk_profile_import_job_profiles)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
@@ -1986,7 +1996,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
-#### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_relationships_lists)
+#### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/get_bulk_profile_import_job_relationships_lists)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
@@ -1996,7 +2006,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
-#### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_job_relationships_profiles)
+#### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/get_bulk_profile_import_job_relationships_profiles)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts)
@@ -2006,7 +2016,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts
-#### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2024-02-15/reference/get_bulk_profile_import_jobs)
+#### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2024-05-15/reference/get_bulk_profile_import_jobs)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
@@ -2016,7 +2026,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
-#### [Get Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile)
+#### [Get Profile](https://developers.klaviyo.com/en/v2024-05-15/reference/get_profile)
```ruby
KlaviyoAPI::Profiles.get_profile(id, opts)
@@ -2026,7 +2036,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
-#### [Get Profile Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_lists)
+#### [Get Profile Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/get_profile_lists)
```ruby
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
@@ -2036,7 +2046,7 @@ KlaviyoAPI::Profiles.get_profile_lists(id, opts)
-#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_relationships_lists)
+#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/get_profile_relationships_lists)
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
@@ -2046,7 +2056,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
-#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_relationships_segments)
+#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2024-05-15/reference/get_profile_relationships_segments)
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
@@ -2056,7 +2066,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
-#### [Get Profile Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profile_segments)
+#### [Get Profile Segments](https://developers.klaviyo.com/en/v2024-05-15/reference/get_profile_segments)
```ruby
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
@@ -2066,7 +2076,7 @@ KlaviyoAPI::Profiles.get_profile_segments(id, opts)
-#### [Get Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_profiles)
+#### [Get Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/get_profiles)
```ruby
KlaviyoAPI::Profiles.get_profiles(opts)
@@ -2076,7 +2086,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
-#### [Merge Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/merge_profiles)
+#### [Merge Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/merge_profiles)
```ruby
KlaviyoAPI::Profiles.merge_profiles(body)
@@ -2086,7 +2096,7 @@ KlaviyoAPI::Profiles.merge_profiles(body)
-#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-02-15/reference/spawn_bulk_profile_import_job)
+#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-05-15/reference/spawn_bulk_profile_import_job)
```ruby
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
@@ -2096,7 +2106,7 @@ KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
-#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/subscribe_profiles)
+#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/subscribe_profiles)
```ruby
KlaviyoAPI::Profiles.subscribe_profiles(body)
@@ -2106,7 +2116,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
-#### [Suppress Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/suppress_profiles)
+#### [Suppress Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/suppress_profiles)
```ruby
KlaviyoAPI::Profiles.suppress_profiles(body)
@@ -2116,7 +2126,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
-#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/unsubscribe_profiles)
+#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/unsubscribe_profiles)
```ruby
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
@@ -2126,7 +2136,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
-#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/unsuppress_profiles)
+#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/unsuppress_profiles)
```ruby
KlaviyoAPI::Profiles.unsuppress_profiles(body)
@@ -2136,7 +2146,7 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body)
-#### [Update Profile](https://developers.klaviyo.com/en/v2024-02-15/reference/update_profile)
+#### [Update Profile](https://developers.klaviyo.com/en/v2024-05-15/reference/update_profile)
```ruby
KlaviyoAPI::Profiles.update_profile(id, body)
@@ -2150,7 +2160,7 @@ KlaviyoAPI::Profiles.update_profile(id, body)
## Reporting
-#### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-02-15/reference/query_campaign_values)
+#### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-05-15/reference/query_campaign_values)
```ruby
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
@@ -2160,7 +2170,7 @@ KlaviyoAPI::Reporting.query_campaign_values(body, opts)
-#### [Query Flow Series](https://developers.klaviyo.com/en/v2024-02-15/reference/query_flow_series)
+#### [Query Flow Series](https://developers.klaviyo.com/en/v2024-05-15/reference/query_flow_series)
```ruby
KlaviyoAPI::Reporting.query_flow_series(body, opts)
@@ -2170,7 +2180,7 @@ KlaviyoAPI::Reporting.query_flow_series(body, opts)
-#### [Query Flow Values](https://developers.klaviyo.com/en/v2024-02-15/reference/query_flow_values)
+#### [Query Flow Values](https://developers.klaviyo.com/en/v2024-05-15/reference/query_flow_values)
```ruby
KlaviyoAPI::Reporting.query_flow_values(body, opts)
@@ -2184,7 +2194,7 @@ KlaviyoAPI::Reporting.query_flow_values(body, opts)
## Segments
-#### [Get Segment](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment)
+#### [Get Segment](https://developers.klaviyo.com/en/v2024-05-15/reference/get_segment)
```ruby
KlaviyoAPI::Segments.get_segment(id, opts)
@@ -2194,7 +2204,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
-#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_profiles)
+#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/get_segment_profiles)
```ruby
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
@@ -2204,7 +2214,7 @@ KlaviyoAPI::Segments.get_segment_profiles(id, opts)
-#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_relationships_profiles)
+#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2024-05-15/reference/get_segment_relationships_profiles)
```ruby
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
@@ -2214,7 +2224,7 @@ KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
-#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_relationships_tags)
+#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_segment_relationships_tags)
```ruby
KlaviyoAPI::Segments.get_segment_relationships_tags(id)
@@ -2224,7 +2234,7 @@ KlaviyoAPI::Segments.get_segment_relationships_tags(id)
-#### [Get Segment Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segment_tags)
+#### [Get Segment Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_segment_tags)
```ruby
KlaviyoAPI::Segments.get_segment_tags(id, opts)
@@ -2234,7 +2244,7 @@ KlaviyoAPI::Segments.get_segment_tags(id, opts)
-#### [Get Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_segments)
+#### [Get Segments](https://developers.klaviyo.com/en/v2024-05-15/reference/get_segments)
```ruby
KlaviyoAPI::Segments.get_segments(opts)
@@ -2244,7 +2254,7 @@ KlaviyoAPI::Segments.get_segments(opts)
-#### [Update Segment](https://developers.klaviyo.com/en/v2024-02-15/reference/update_segment)
+#### [Update Segment](https://developers.klaviyo.com/en/v2024-05-15/reference/update_segment)
```ruby
KlaviyoAPI::Segments.update_segment(id, body)
@@ -2258,7 +2268,7 @@ KlaviyoAPI::Segments.update_segment(id, body)
## Tags
-#### [Create Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag)
+#### [Create Tag](https://developers.klaviyo.com/en/v2024-05-15/reference/create_tag)
```ruby
KlaviyoAPI::Tags.create_tag(body)
@@ -2268,7 +2278,7 @@ KlaviyoAPI::Tags.create_tag(body)
-#### [Create Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_group)
+#### [Create Tag Group](https://developers.klaviyo.com/en/v2024-05-15/reference/create_tag_group)
```ruby
KlaviyoAPI::Tags.create_tag_group(body)
@@ -2278,7 +2288,7 @@ KlaviyoAPI::Tags.create_tag_group(body)
-#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_campaigns)
+#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-05-15/reference/create_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
@@ -2288,7 +2298,7 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
-#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_flows)
+#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-05-15/reference/create_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
@@ -2298,7 +2308,7 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
-#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_lists)
+#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/create_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
@@ -2308,7 +2318,7 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
-#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/create_tag_relationships_segments)
+#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-05-15/reference/create_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
@@ -2318,7 +2328,7 @@ KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
-#### [Delete Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag)
+#### [Delete Tag](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_tag)
```ruby
KlaviyoAPI::Tags.delete_tag(id)
@@ -2328,7 +2338,7 @@ KlaviyoAPI::Tags.delete_tag(id)
-#### [Delete Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_group)
+#### [Delete Tag Group](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_tag_group)
```ruby
KlaviyoAPI::Tags.delete_tag_group(id)
@@ -2338,7 +2348,7 @@ KlaviyoAPI::Tags.delete_tag_group(id)
-#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_campaigns)
+#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
@@ -2348,7 +2358,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
-#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_flows)
+#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
@@ -2358,7 +2368,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
-#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_lists)
+#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
@@ -2368,7 +2378,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
-#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_tag_relationships_segments)
+#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
@@ -2378,7 +2388,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
-#### [Get Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag)
+#### [Get Tag](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag)
```ruby
KlaviyoAPI::Tags.get_tag(id, opts)
@@ -2388,7 +2398,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
-#### [Get Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_group)
+#### [Get Tag Group](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_group(id, opts)
@@ -2398,7 +2408,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
-#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_group_relationships_tags)
+#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_group_relationships_tags)
```ruby
KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
@@ -2408,7 +2418,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
-#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_group_tags)
+#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_group_tags)
```ruby
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
@@ -2418,7 +2428,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
-#### [Get Tag Groups](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_groups)
+#### [Get Tag Groups](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_groups)
```ruby
KlaviyoAPI::Tags.get_tag_groups(opts)
@@ -2428,7 +2438,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
-#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_campaigns)
+#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
@@ -2438,7 +2448,7 @@ KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
-#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_flows)
+#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_flows(id)
@@ -2448,7 +2458,7 @@ KlaviyoAPI::Tags.get_tag_relationships_flows(id)
-#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_lists)
+#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_lists(id)
@@ -2458,7 +2468,7 @@ KlaviyoAPI::Tags.get_tag_relationships_lists(id)
-#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_segments)
+#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_segments(id)
@@ -2468,7 +2478,7 @@ KlaviyoAPI::Tags.get_tag_relationships_segments(id)
-#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_relationships_tag_group)
+#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_relationships_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
@@ -2478,7 +2488,7 @@ KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
-#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tag_tag_group)
+#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tag_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
@@ -2488,7 +2498,7 @@ KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
-#### [Get Tags](https://developers.klaviyo.com/en/v2024-02-15/reference/get_tags)
+#### [Get Tags](https://developers.klaviyo.com/en/v2024-05-15/reference/get_tags)
```ruby
KlaviyoAPI::Tags.get_tags(opts)
@@ -2498,7 +2508,7 @@ KlaviyoAPI::Tags.get_tags(opts)
-#### [Update Tag](https://developers.klaviyo.com/en/v2024-02-15/reference/update_tag)
+#### [Update Tag](https://developers.klaviyo.com/en/v2024-05-15/reference/update_tag)
```ruby
KlaviyoAPI::Tags.update_tag(id, body)
@@ -2508,7 +2518,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
-#### [Update Tag Group](https://developers.klaviyo.com/en/v2024-02-15/reference/update_tag_group)
+#### [Update Tag Group](https://developers.klaviyo.com/en/v2024-05-15/reference/update_tag_group)
```ruby
KlaviyoAPI::Tags.update_tag_group(id, body)
@@ -2522,7 +2532,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
## Templates
-#### [Create Template](https://developers.klaviyo.com/en/v2024-02-15/reference/create_template)
+#### [Create Template](https://developers.klaviyo.com/en/v2024-05-15/reference/create_template)
```ruby
KlaviyoAPI::Templates.create_template(body)
@@ -2532,7 +2542,7 @@ KlaviyoAPI::Templates.create_template(body)
-#### [Create Template Clone](https://developers.klaviyo.com/en/v2024-02-15/reference/create_template_clone)
+#### [Create Template Clone](https://developers.klaviyo.com/en/v2024-05-15/reference/create_template_clone)
```ruby
KlaviyoAPI::Templates.create_template_clone(body)
@@ -2542,7 +2552,7 @@ KlaviyoAPI::Templates.create_template_clone(body)
-#### [Create Template Render](https://developers.klaviyo.com/en/v2024-02-15/reference/create_template_render)
+#### [Create Template Render](https://developers.klaviyo.com/en/v2024-05-15/reference/create_template_render)
```ruby
KlaviyoAPI::Templates.create_template_render(body)
@@ -2552,7 +2562,7 @@ KlaviyoAPI::Templates.create_template_render(body)
-#### [Delete Template](https://developers.klaviyo.com/en/v2024-02-15/reference/delete_template)
+#### [Delete Template](https://developers.klaviyo.com/en/v2024-05-15/reference/delete_template)
```ruby
KlaviyoAPI::Templates.delete_template(id)
@@ -2562,7 +2572,7 @@ KlaviyoAPI::Templates.delete_template(id)
-#### [Get Template](https://developers.klaviyo.com/en/v2024-02-15/reference/get_template)
+#### [Get Template](https://developers.klaviyo.com/en/v2024-05-15/reference/get_template)
```ruby
KlaviyoAPI::Templates.get_template(id, opts)
@@ -2572,7 +2582,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
-#### [Get Templates](https://developers.klaviyo.com/en/v2024-02-15/reference/get_templates)
+#### [Get Templates](https://developers.klaviyo.com/en/v2024-05-15/reference/get_templates)
```ruby
KlaviyoAPI::Templates.get_templates(opts)
@@ -2582,7 +2592,7 @@ KlaviyoAPI::Templates.get_templates(opts)
-#### [Update Template](https://developers.klaviyo.com/en/v2024-02-15/reference/update_template)
+#### [Update Template](https://developers.klaviyo.com/en/v2024-05-15/reference/update_template)
```ruby
KlaviyoAPI::Templates.update_template(id, body)
diff --git a/klaviyo-api-sdk.gemspec b/klaviyo-api-sdk.gemspec
index fcc393d..f7ebe18 100644
--- a/klaviyo-api-sdk.gemspec
+++ b/klaviyo-api-sdk.gemspec
@@ -5,7 +5,7 @@
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
-The version of the OpenAPI document: 2024-02-15
+The version of the OpenAPI document: 2024-05-15
Contact: developers@klaviyo.com
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.2.1
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
Gem::Specification.new do |s|
s.name = "klaviyo-api-sdk"
- s.version = "6.0.0"
+ s.version = "7.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.rb b/lib/klaviyo-api-sdk.rb
index 5b731c0..69ece26 100644
--- a/lib/klaviyo-api-sdk.rb
+++ b/lib/klaviyo-api-sdk.rb
@@ -3,7 +3,7 @@
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
-The version of the OpenAPI document: 2024-02-15
+The version of the OpenAPI document: 2024-05-15
Contact: developers@klaviyo.com
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.2.1
@@ -19,6 +19,8 @@
# Models
require 'klaviyo-api-sdk/models/audiences_sub_object'
require 'klaviyo-api-sdk/models/back_in_stock_subscription_enum'
+require 'klaviyo-api-sdk/models/base_event_create_query_resource_object'
+require 'klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes'
require 'klaviyo-api-sdk/models/campaign_clone_query'
require 'klaviyo-api-sdk/models/campaign_clone_query_resource_object'
require 'klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes'
@@ -173,12 +175,24 @@
require 'klaviyo-api-sdk/models/email_send_options_sub_object'
require 'klaviyo-api-sdk/models/email_subscription_parameters'
require 'klaviyo-api-sdk/models/email_tracking_options_sub_object'
+require 'klaviyo-api-sdk/models/event_bulk_create_enum'
+require 'klaviyo-api-sdk/models/event_bulk_create_job_enum'
require 'klaviyo-api-sdk/models/event_create_query_v2'
require 'klaviyo-api-sdk/models/event_create_query_v2_resource_object'
require 'klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes'
require 'klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric'
require 'klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile'
require 'klaviyo-api-sdk/models/event_enum'
+require 'klaviyo-api-sdk/models/event_profile_create_query_resource_object'
+require 'klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes'
+require 'klaviyo-api-sdk/models/events_bulk_create_job'
+require 'klaviyo-api-sdk/models/events_bulk_create_job_resource_object'
+require 'klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes'
+require 'klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create'
+require 'klaviyo-api-sdk/models/events_bulk_create_query_resource_object'
+require 'klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes'
+require 'klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events'
+require 'klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile'
require 'klaviyo-api-sdk/models/flow_enum'
require 'klaviyo-api-sdk/models/flow_series_report_enum'
require 'klaviyo-api-sdk/models/flow_series_request_dto'
@@ -265,6 +279,8 @@
require 'klaviyo-api-sdk/models/profile_upsert_query'
require 'klaviyo-api-sdk/models/profile_upsert_query_resource_object'
require 'klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes'
+require 'klaviyo-api-sdk/models/push_profile_upsert_query_resource_object'
+require 'klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes'
require 'klaviyo-api-sdk/models/push_token_create_query'
require 'klaviyo-api-sdk/models/push_token_create_query_resource_object'
require 'klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes'
@@ -308,10 +324,20 @@
require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object'
require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes'
require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles'
+require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships'
+require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list'
+require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data'
+require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment'
+require 'klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data'
require 'klaviyo-api-sdk/models/suppression_delete_job_create_query'
require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object'
require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes'
require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles'
+require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships'
+require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list'
+require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data'
+require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment'
+require 'klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data'
require 'klaviyo-api-sdk/models/tag_campaign_op'
require 'klaviyo-api-sdk/models/tag_campaign_op_data_inner'
require 'klaviyo-api-sdk/models/tag_create_query'
diff --git a/lib/klaviyo-api-sdk/api/accounts_api.rb b/lib/klaviyo-api-sdk/api/accounts_api.rb
index f769fd5..f9fedf1 100644
--- a/lib/klaviyo-api-sdk/api/accounts_api.rb
+++ b/lib/klaviyo-api-sdk/api/accounts_api.rb
@@ -3,7 +3,7 @@
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
-The version of the OpenAPI document: 2024-02-15
+The version of the OpenAPI document: 2024-05-15
Contact: developers@klaviyo.com
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.2.1
@@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default)
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.
*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `accounts:read`
# @param id [String] The ID of the account
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_account(id, opts = {})
data, _status_code, _headers = get_account_with_http_info(id, opts)
@@ -34,7 +34,7 @@ def get_account(id, opts = {})
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
# @param id [String] The ID of the account
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_account_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -44,7 +44,7 @@ def get_account_with_http_info(id, opts = {})
if @api_client.config.client_side_validation && id.nil?
fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.get_account"
end
- allowable_values = ["contact_information", "contact_information.default_sender_name", "contact_information.default_sender_email", "contact_information.website_url", "contact_information.organization_name", "contact_information.street_address", "contact_information.street_address.address1", "contact_information.street_address.address2", "contact_information.street_address.city", "contact_information.street_address.region", "contact_information.street_address.country", "contact_information.street_address.zip", "industry", "timezone", "preferred_currency", "public_api_key"]
+ allowable_values = ["test_account", "contact_information", "contact_information.default_sender_name", "contact_information.default_sender_email", "contact_information.website_url", "contact_information.organization_name", "contact_information.street_address", "contact_information.street_address.address1", "contact_information.street_address.address2", "contact_information.street_address.city", "contact_information.street_address.region", "contact_information.street_address.country", "contact_information.street_address.zip", "industry", "timezone", "preferred_currency", "public_api_key", "locale"]
if @api_client.config.client_side_validation && opts[:'fields_account'] && !opts[:'fields_account'].all? { |item| allowable_values.include?(item) }
fail ArgumentError, "invalid value for \"fields_account\", must include one of #{allowable_values}"
end
@@ -58,7 +58,7 @@ def get_account_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -94,7 +94,7 @@ def get_account_with_http_info(id, opts = {})
# Get Accounts
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.
*Rate limits*:
Burst: `1/s`
Steady: `15/m` **Scopes:** `accounts:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_accounts(opts = {})
data, _status_code, _headers = get_accounts_with_http_info(opts)
@@ -104,13 +104,13 @@ def get_accounts(opts = {})
# Get Accounts
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_accounts_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
end
- allowable_values = ["contact_information", "contact_information.default_sender_name", "contact_information.default_sender_email", "contact_information.website_url", "contact_information.organization_name", "contact_information.street_address", "contact_information.street_address.address1", "contact_information.street_address.address2", "contact_information.street_address.city", "contact_information.street_address.region", "contact_information.street_address.country", "contact_information.street_address.zip", "industry", "timezone", "preferred_currency", "public_api_key"]
+ allowable_values = ["test_account", "contact_information", "contact_information.default_sender_name", "contact_information.default_sender_email", "contact_information.website_url", "contact_information.organization_name", "contact_information.street_address", "contact_information.street_address.address1", "contact_information.street_address.address2", "contact_information.street_address.city", "contact_information.street_address.region", "contact_information.street_address.country", "contact_information.street_address.zip", "industry", "timezone", "preferred_currency", "public_api_key", "locale"]
if @api_client.config.client_side_validation && opts[:'fields_account'] && !opts[:'fields_account'].all? { |item| allowable_values.include?(item) }
fail ArgumentError, "invalid value for \"fields_account\", must include one of #{allowable_values}"
end
@@ -124,7 +124,7 @@ def get_accounts_with_http_info(opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
diff --git a/lib/klaviyo-api-sdk/api/campaigns_api.rb b/lib/klaviyo-api-sdk/api/campaigns_api.rb
index 5a99e7e..df4299b 100644
--- a/lib/klaviyo-api-sdk/api/campaigns_api.rb
+++ b/lib/klaviyo-api-sdk/api/campaigns_api.rb
@@ -3,7 +3,7 @@
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
-The version of the OpenAPI document: 2024-02-15
+The version of the OpenAPI document: 2024-05-15
Contact: developers@klaviyo.com
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.2.1
@@ -51,7 +51,7 @@ def create_campaign_with_http_info(campaign_create_query, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -121,7 +121,7 @@ def create_campaign_clone_with_http_info(campaign_clone_query, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -191,7 +191,7 @@ def create_campaign_message_assign_template_with_http_info(campaign_message_assi
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -261,7 +261,7 @@ def create_campaign_recipient_estimation_job_with_http_info(campaign_recipient_e
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -331,7 +331,7 @@ def create_campaign_send_job_with_http_info(campaign_send_job_create_query, opts
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -401,7 +401,7 @@ def delete_campaign_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -438,10 +438,10 @@ def delete_campaign_with_http_info(id, opts = {})
# Returns a specific campaign based on a required id.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The campaign ID to be retrieved
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Hash]
def get_campaign(id, opts = {})
data, _status_code, _headers = get_campaign_with_http_info(id, opts)
@@ -452,10 +452,10 @@ def get_campaign(id, opts = {})
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The campaign ID to be retrieved
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -494,7 +494,7 @@ def get_campaign_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -531,10 +531,10 @@ def get_campaign_with_http_info(id, opts = {})
# Return all messages that belong to the given campaign.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Hash]
def get_campaign_campaign_messages(id, opts = {})
data, _status_code, _headers = get_campaign_campaign_messages_with_http_info(id, opts)
@@ -545,10 +545,10 @@ def get_campaign_campaign_messages(id, opts = {})
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_campaign_messages_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -587,7 +587,7 @@ def get_campaign_campaign_messages_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -624,10 +624,10 @@ def get_campaign_campaign_messages_with_http_info(id, opts = {})
# Returns a specific message based on a required id.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The message ID to be retrieved
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Hash]
def get_campaign_message(id, opts = {})
data, _status_code, _headers = get_campaign_message_with_http_info(id, opts)
@@ -638,10 +638,10 @@ def get_campaign_message(id, opts = {})
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The message ID to be retrieved
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_message_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -680,7 +680,7 @@ def get_campaign_message_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -717,7 +717,7 @@ def get_campaign_message_with_http_info(id, opts = {})
# Return the related campaign
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_campaign_message_campaign(id, opts = {})
data, _status_code, _headers = get_campaign_message_campaign_with_http_info(id, opts)
@@ -728,7 +728,7 @@ def get_campaign_message_campaign(id, opts = {})
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_message_campaign_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -752,7 +752,7 @@ def get_campaign_message_campaign_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -817,7 +817,7 @@ def get_campaign_message_relationships_campaign_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -882,7 +882,7 @@ def get_campaign_message_relationships_template_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -919,7 +919,7 @@ def get_campaign_message_relationships_template_with_http_info(id, opts = {})
# Return the related template
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_campaign_message_template(id, opts = {})
data, _status_code, _headers = get_campaign_message_template_with_http_info(id, opts)
@@ -930,7 +930,7 @@ def get_campaign_message_template(id, opts = {})
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_message_template_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -954,7 +954,7 @@ def get_campaign_message_template_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -991,7 +991,7 @@ def get_campaign_message_template_with_http_info(id, opts = {})
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_campaign_recipient_estimation(id, opts = {})
data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts)
@@ -1002,7 +1002,7 @@ def get_campaign_recipient_estimation(id, opts = {})
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_recipient_estimation_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1026,7 +1026,7 @@ def get_campaign_recipient_estimation_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1063,7 +1063,7 @@ def get_campaign_recipient_estimation_with_http_info(id, opts = {})
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The ID of the campaign to get recipient estimation status
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_campaign_recipient_estimation_job(id, opts = {})
data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts)
@@ -1074,7 +1074,7 @@ def get_campaign_recipient_estimation_job(id, opts = {})
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The ID of the campaign to get recipient estimation status
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1098,7 +1098,7 @@ def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1163,7 +1163,7 @@ def get_campaign_relationships_campaign_messages_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1228,7 +1228,7 @@ def get_campaign_relationships_tags_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1265,7 +1265,7 @@ def get_campaign_relationships_tags_with_http_info(id, opts = {})
# Get a campaign send job
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The ID of the campaign to send
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_campaign_send_job(id, opts = {})
data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts)
@@ -1276,7 +1276,7 @@ def get_campaign_send_job(id, opts = {})
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
# @param id [String] The ID of the campaign to send
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_send_job_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1300,7 +1300,7 @@ def get_campaign_send_job_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1337,7 +1337,7 @@ def get_campaign_send_job_with_http_info(id, opts = {})
# Return all tags that belong to the given campaign.
*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_campaign_tags(id, opts = {})
data, _status_code, _headers = get_campaign_tags_with_http_info(id, opts)
@@ -1348,7 +1348,7 @@ def get_campaign_tags(id, opts = {})
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaign_tags_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1372,7 +1372,7 @@ def get_campaign_tags_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1407,14 +1407,14 @@ def get_campaign_tags_with_http_info(id, opts = {})
# Get Campaigns
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.
*Rate limits*:
Burst: `10/s`
Steady: `150/m` **Scopes:** `campaigns:read`
- # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
+ # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Hash]
def get_campaigns(filter, opts = {})
data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
@@ -1423,14 +1423,14 @@ def get_campaigns(filter, opts = {})
# Get Campaigns
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
- # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
+ # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_campaigns_with_http_info(filter, opts = {})
if @api_client.config.debugging
@@ -1476,7 +1476,7 @@ def get_campaigns_with_http_info(filter, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1547,7 +1547,7 @@ def update_campaign_with_http_info(id, campaign_partial_update_query, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -1623,7 +1623,7 @@ def update_campaign_message_with_http_info(id, campaign_message_partial_update_q
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -1699,7 +1699,7 @@ def update_campaign_send_job_with_http_info(id, campaign_send_job_partial_update
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
diff --git a/lib/klaviyo-api-sdk/api/catalogs_api.rb b/lib/klaviyo-api-sdk/api/catalogs_api.rb
index a809a85..062ed4c 100644
--- a/lib/klaviyo-api-sdk/api/catalogs_api.rb
+++ b/lib/klaviyo-api-sdk/api/catalogs_api.rb
@@ -3,7 +3,7 @@
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
-The version of the OpenAPI document: 2024-02-15
+The version of the OpenAPI document: 2024-05-15
Contact: developers@klaviyo.com
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.2.1
@@ -51,7 +51,7 @@ def create_back_in_stock_subscription_with_http_info(server_bis_subscription_cre
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -121,7 +121,7 @@ def create_catalog_category_with_http_info(catalog_category_create_query, opts =
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -197,7 +197,7 @@ def create_catalog_category_relationships_items_with_http_info(id, catalog_categ
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -267,7 +267,7 @@ def create_catalog_item_with_http_info(catalog_item_create_query, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -343,7 +343,7 @@ def create_catalog_item_relationships_categories_with_http_info(id, catalog_item
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -413,7 +413,7 @@ def create_catalog_variant_with_http_info(catalog_variant_create_query, opts = {
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -483,7 +483,7 @@ def delete_catalog_category_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -554,7 +554,7 @@ def delete_catalog_category_relationships_items_with_http_info(id, catalog_categ
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -624,7 +624,7 @@ def delete_catalog_item_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -695,7 +695,7 @@ def delete_catalog_item_relationships_categories_with_http_info(id, catalog_item
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
@@ -765,7 +765,7 @@ def delete_catalog_variant_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -801,10 +801,10 @@ def delete_catalog_variant_with_http_info(id, opts = {})
# Get Catalog Categories
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Hash]
def get_catalog_categories(opts = {})
data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
@@ -814,10 +814,10 @@ def get_catalog_categories(opts = {})
# Get Catalog Categories
# Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_categories_with_http_info(opts = {})
if @api_client.config.debugging
@@ -844,7 +844,7 @@ def get_catalog_categories_with_http_info(opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -881,7 +881,7 @@ def get_catalog_categories_with_http_info(opts = {})
# Get a catalog category with the given category ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @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`.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_catalog_category(id, opts = {})
data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
@@ -892,7 +892,7 @@ def get_catalog_category(id, opts = {})
# Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @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`.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_category_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -916,7 +916,7 @@ def get_catalog_category_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -953,12 +953,12 @@ def get_catalog_category_with_http_info(id, opts = {})
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Hash]
def get_catalog_category_items(id, opts = {})
data, _status_code, _headers = get_catalog_category_items_with_http_info(id, opts)
@@ -969,12 +969,12 @@ def get_catalog_category_items(id, opts = {})
# Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_category_items_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1015,7 +1015,7 @@ def get_catalog_category_items_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1052,7 +1052,7 @@ def get_catalog_category_items_with_http_info(id, opts = {})
# Get all items in the given category ID. Returns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
# @return [Hash]
def get_catalog_category_relationships_items(id, opts = {})
data, _status_code, _headers = get_catalog_category_relationships_items_with_http_info(id, opts)
@@ -1063,7 +1063,7 @@ def get_catalog_category_relationships_items(id, opts = {})
# Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_category_relationships_items_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1083,7 +1083,7 @@ def get_catalog_category_relationships_items_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1120,9 +1120,9 @@ def get_catalog_category_relationships_items_with_http_info(id, opts = {})
# Get a specific catalog item with the given item ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String] The catalog item 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`.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Hash]
def get_catalog_item(id, opts = {})
data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
@@ -1133,9 +1133,9 @@ def get_catalog_item(id, opts = {})
# Get a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String] The catalog item 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`.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_item_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1169,7 +1169,7 @@ def get_catalog_item_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1206,10 +1206,10 @@ def get_catalog_item_with_http_info(id, opts = {})
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Hash]
def get_catalog_item_categories(id, opts = {})
data, _status_code, _headers = get_catalog_item_categories_with_http_info(id, opts)
@@ -1220,10 +1220,10 @@ def get_catalog_item_categories(id, opts = {})
# Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_item_categories_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1254,7 +1254,7 @@ def get_catalog_item_categories_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1291,7 +1291,7 @@ def get_catalog_item_categories_with_http_info(id, opts = {})
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
# @return [Hash]
def get_catalog_item_relationships_categories(id, opts = {})
data, _status_code, _headers = get_catalog_item_relationships_categories_with_http_info(id, opts)
@@ -1302,7 +1302,7 @@ def get_catalog_item_relationships_categories(id, opts = {})
# Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_item_relationships_categories_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1322,7 +1322,7 @@ def get_catalog_item_relationships_categories_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1359,10 +1359,10 @@ def get_catalog_item_relationships_categories_with_http_info(id, opts = {})
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Hash]
def get_catalog_item_variants(id, opts = {})
data, _status_code, _headers = get_catalog_item_variants_with_http_info(id, opts)
@@ -1373,10 +1373,10 @@ def get_catalog_item_variants(id, opts = {})
# Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_item_variants_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1407,7 +1407,7 @@ def get_catalog_item_variants_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1443,12 +1443,12 @@ def get_catalog_item_variants_with_http_info(id, opts = {})
# Get Catalog Items
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Hash]
def get_catalog_items(opts = {})
data, _status_code, _headers = get_catalog_items_with_http_info(opts)
@@ -1458,12 +1458,12 @@ def get_catalog_items(opts = {})
# Get Catalog Items
# Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_items_with_http_info(opts = {})
if @api_client.config.debugging
@@ -1500,7 +1500,7 @@ def get_catalog_items_with_http_info(opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1537,7 +1537,7 @@ def get_catalog_items_with_http_info(opts = {})
# Get a catalog item variant with the given variant ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String] The catalog variant 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`.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_catalog_variant(id, opts = {})
data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
@@ -1548,7 +1548,7 @@ def get_catalog_variant(id, opts = {})
# Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param id [String] The catalog variant 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`.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_variant_with_http_info(id, opts = {})
if @api_client.config.debugging
@@ -1572,7 +1572,7 @@ def get_catalog_variant_with_http_info(id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1608,10 +1608,10 @@ def get_catalog_variant_with_http_info(id, opts = {})
# Get Catalog Variants
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Hash]
def get_catalog_variants(opts = {})
data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
@@ -1621,10 +1621,10 @@ def get_catalog_variants(opts = {})
# Get Catalog Variants
# Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`. Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_catalog_variants_with_http_info(opts = {})
if @api_client.config.debugging
@@ -1651,7 +1651,7 @@ def get_catalog_variants_with_http_info(opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1688,9 +1688,9 @@ def get_catalog_variants_with_http_info(opts = {})
# 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`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` **Scopes:** `catalogs:read`
# @param job_id [String] ID of the job to retrieve.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Hash]
def get_create_categories_job(job_id, opts = {})
data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts)
@@ -1701,9 +1701,9 @@ def get_create_categories_job(job_id, opts = {})
# 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.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_create_categories_job_with_http_info(job_id, opts = {})
if @api_client.config.debugging
@@ -1737,7 +1737,7 @@ def get_create_categories_job_with_http_info(job_id, opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1773,9 +1773,9 @@ def get_create_categories_job_with_http_info(job_id, opts = {})
# 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
- # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
# @return [Hash]
def get_create_categories_jobs(opts = {})
data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts)
@@ -1785,9 +1785,9 @@ def get_create_categories_jobs(opts = {})
# 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
- # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+ # @option opts [Array] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
# @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers
def get_create_categories_jobs_with_http_info(opts = {})
if @api_client.config.debugging
@@ -1809,7 +1809,7 @@ def get_create_categories_jobs_with_http_info(opts = {})
# header parameters
header_params = opts[:header_params] || {}
# klaviyo api revision
- header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1846,9 +1846,9 @@ def get_create_categories_jobs_with_http_info(opts = {})
# 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.
# @param [Hash] opts the optional parameters
- # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
# @return [Hash