diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2ffb66e..24b3052 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,21 @@ 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).
+## [8.0.0] - revision 2024-07-15
+
+### Added
+
+ - Forms API
+ - New `KlaviyoAPI::Forms` class with methods to get forms, form versions and relationships.
+ - Webhooks API
+ - new `KlaviyoAPI::Webooks` class containing CRUD operations for webhooks.
+
+### Changed
+ - `ProfilesApi.subscribe()`
+ - Added `historical_import` flag for importing historically consented profiles can now be optionally supplied in the payload for the Subscribe Profiles endpoint.
+ - When using this flag, a consented_at date must be provided and must be in the past.
+
+
## [7.1.0] - revision 2024-06-15
### Added
diff --git a/README.md b/README.md
index e3a1336..9d3fcb1 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
# Klaviyo Ruby SDK
-- SDK version: 7.1.0
-- API revision: 2024-06-15
+- SDK version: 8.0.0
+- API revision: 2024-07-15
## Helpful Resources
-- [API Reference](https://developers.klaviyo.com/en/v2024-06-15/reference)
-- [API Guides](https://developers.klaviyo.com/en/v2024-06-15/docs)
+- [API Reference](https://developers.klaviyo.com/en/v2024-07-15/reference)
+- [API Guides](https://developers.klaviyo.com/en/v2024-07-15/docs)
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
## Design & Approach
@@ -47,6 +47,10 @@ This SDK is organized into the following resources:
+- Forms
+
+
+
- Images
@@ -79,6 +83,10 @@ This SDK is organized into the following resources:
+- Webhooks
+
+
+
## Installation
@@ -94,13 +102,13 @@ gem build klaviyo-api-sdk.gemspec
Then install the gem locally:
```shell
-gem install ./klaviyo-api-sdk-7.1.0.gem
+gem install ./klaviyo-api-sdk-8.0.0.gem
```
Finally add this to the Gemfile:
- gem 'klaviyo-api-sdk', '~> 7.1.0'
+ gem 'klaviyo-api-sdk', '~> 8.0.0'
To install directly from rubygems:
@@ -470,7 +478,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-06-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-07-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.
@@ -482,7 +490,7 @@ _**NOTE:**_
## Accounts
-#### [Get Account](https://developers.klaviyo.com/en/v2024-06-15/reference/get_account)
+#### [Get Account](https://developers.klaviyo.com/en/v2024-07-15/reference/get_account)
```ruby
KlaviyoAPI::Accounts.get_account(id, opts)
@@ -492,7 +500,7 @@ KlaviyoAPI::Accounts.get_account(id, opts)
-#### [Get Accounts](https://developers.klaviyo.com/en/v2024-06-15/reference/get_accounts)
+#### [Get Accounts](https://developers.klaviyo.com/en/v2024-07-15/reference/get_accounts)
```ruby
KlaviyoAPI::Accounts.get_accounts(opts)
@@ -506,7 +514,7 @@ KlaviyoAPI::Accounts.get_accounts(opts)
## Campaigns
-#### [Create Campaign](https://developers.klaviyo.com/en/v2024-06-15/reference/create_campaign)
+#### [Create Campaign](https://developers.klaviyo.com/en/v2024-07-15/reference/create_campaign)
```ruby
KlaviyoAPI::Campaigns.create_campaign(body)
@@ -516,7 +524,7 @@ KlaviyoAPI::Campaigns.create_campaign(body)
-#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2024-06-15/reference/create_campaign_clone)
+#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2024-07-15/reference/create_campaign_clone)
```ruby
KlaviyoAPI::Campaigns.create_campaign_clone(body)
@@ -526,7 +534,7 @@ KlaviyoAPI::Campaigns.create_campaign_clone(body)
-#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2024-06-15/reference/create_campaign_message_assign_template)
+#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2024-07-15/reference/create_campaign_message_assign_template)
```ruby
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
@@ -536,7 +544,7 @@ KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
-#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-06-15/reference/create_campaign_recipient_estimation_job)
+#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-07-15/reference/create_campaign_recipient_estimation_job)
```ruby
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
@@ -546,7 +554,7 @@ KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
-#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2024-06-15/reference/create_campaign_send_job)
+#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2024-07-15/reference/create_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
@@ -556,7 +564,7 @@ KlaviyoAPI::Campaigns.create_campaign_send_job(body)
-#### [Delete Campaign](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_campaign)
+#### [Delete Campaign](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_campaign)
```ruby
KlaviyoAPI::Campaigns.delete_campaign(id)
@@ -566,7 +574,7 @@ KlaviyoAPI::Campaigns.delete_campaign(id)
-#### [Get Campaign](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign)
+#### [Get Campaign](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign(id, opts)
@@ -576,7 +584,7 @@ KlaviyoAPI::Campaigns.get_campaign(id, opts)
-#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_campaign_messages)
+#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_campaign_messages)
```ruby
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
@@ -586,7 +594,7 @@ KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
-#### [Get Campaign Message](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_message)
+#### [Get Campaign Message](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_message)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
@@ -596,7 +604,7 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
-#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_message_campaign)
+#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_message_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
@@ -606,7 +614,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
-#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_message_relationships_campaign)
+#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_message_relationships_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
@@ -616,7 +624,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
-#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_message_relationships_template)
+#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_message_relationships_template)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
@@ -626,7 +634,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
-#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_message_template)
+#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_message_template)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
@@ -636,7 +644,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
-#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_recipient_estimation)
+#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_recipient_estimation)
```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
@@ -646,7 +654,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
-#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_recipient_estimation_job)
+#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_recipient_estimation_job)
```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
@@ -656,7 +664,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
-#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_relationships_campaign_messages)
+#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_relationships_campaign_messages)
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
@@ -666,7 +674,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
-#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_relationships_tags)
+#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_relationships_tags)
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
@@ -676,7 +684,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
-#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_send_job)
+#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
@@ -686,7 +694,7 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
-#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaign_tags)
+#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaign_tags)
```ruby
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
@@ -696,7 +704,7 @@ KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
-#### [Get Campaigns](https://developers.klaviyo.com/en/v2024-06-15/reference/get_campaigns)
+#### [Get Campaigns](https://developers.klaviyo.com/en/v2024-07-15/reference/get_campaigns)
```ruby
KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
@@ -706,7 +714,7 @@ KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
-#### [Update Campaign](https://developers.klaviyo.com/en/v2024-06-15/reference/update_campaign)
+#### [Update Campaign](https://developers.klaviyo.com/en/v2024-07-15/reference/update_campaign)
```ruby
KlaviyoAPI::Campaigns.update_campaign(id, body)
@@ -716,7 +724,7 @@ KlaviyoAPI::Campaigns.update_campaign(id, body)
-#### [Update Campaign Message](https://developers.klaviyo.com/en/v2024-06-15/reference/update_campaign_message)
+#### [Update Campaign Message](https://developers.klaviyo.com/en/v2024-07-15/reference/update_campaign_message)
```ruby
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
@@ -726,7 +734,7 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body)
-#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2024-06-15/reference/update_campaign_send_job)
+#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2024-07-15/reference/update_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
@@ -740,7 +748,7 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
## Catalogs
-#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2024-06-15/reference/create_back_in_stock_subscription)
+#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2024-07-15/reference/create_back_in_stock_subscription)
```ruby
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
@@ -750,7 +758,7 @@ KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
-#### [Create Catalog Category](https://developers.klaviyo.com/en/v2024-06-15/reference/create_catalog_category)
+#### [Create Catalog Category](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_category)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category(body)
@@ -760,7 +768,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
-#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-06-15/reference/create_catalog_category_relationships_items)
+#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
@@ -770,7 +778,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
-#### [Create Catalog Item](https://developers.klaviyo.com/en/v2024-06-15/reference/create_catalog_item)
+#### [Create Catalog Item](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_item)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item(body)
@@ -780,7 +788,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
-#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-06-15/reference/create_catalog_item_relationships_categories)
+#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
@@ -790,7 +798,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
-#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2024-06-15/reference/create_catalog_variant)
+#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2024-07-15/reference/create_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.create_catalog_variant(body)
@@ -800,7 +808,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
-#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_catalog_category)
+#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_catalog_category)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category(id)
@@ -810,7 +818,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
-#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_catalog_category_relationships_items)
+#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
@@ -820,7 +828,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
-#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_catalog_item)
+#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_catalog_item)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item(id)
@@ -830,7 +838,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
-#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_catalog_item_relationships_categories)
+#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
@@ -840,7 +848,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
-#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_catalog_variant)
+#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
@@ -850,7 +858,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
-#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_categories)
+#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
@@ -860,7 +868,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
-#### [Get Catalog Category](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_category)
+#### [Get Catalog Category](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_category)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
@@ -870,7 +878,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
-#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_category_items)
+#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_category_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
@@ -880,7 +888,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
-#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_category_relationships_items)
+#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
@@ -890,7 +898,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
-#### [Get Catalog Item](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_item)
+#### [Get Catalog Item](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_item)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
@@ -900,7 +908,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
-#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_item_categories)
+#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_item_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
@@ -910,7 +918,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
-#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_item_relationships_categories)
+#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
@@ -920,7 +928,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
-#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_item_variants)
+#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_item_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
@@ -930,7 +938,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
-#### [Get Catalog Items](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_items)
+#### [Get Catalog Items](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_items(opts)
@@ -940,7 +948,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
-#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_variant)
+#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
@@ -950,7 +958,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
-#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2024-06-15/reference/get_catalog_variants)
+#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2024-07-15/reference/get_catalog_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
@@ -960,7 +968,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
-#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_create_categories_job)
+#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
@@ -970,7 +978,7 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
-#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_create_categories_jobs)
+#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
@@ -980,7 +988,7 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
-#### [Get Create Items Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_create_items_job)
+#### [Get Create Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_items_job)
```ruby
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
@@ -990,7 +998,7 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
-#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_create_items_jobs)
+#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
@@ -1000,7 +1008,7 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
-#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_create_variants_job)
+#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
@@ -1010,7 +1018,7 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
-#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_create_variants_jobs)
+#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_create_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
@@ -1020,7 +1028,7 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
-#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_delete_categories_job)
+#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
@@ -1030,7 +1038,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
-#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_delete_categories_jobs)
+#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
@@ -1040,7 +1048,7 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
-#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_delete_items_job)
+#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
@@ -1050,7 +1058,7 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
-#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_delete_items_jobs)
+#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
@@ -1060,7 +1068,7 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
-#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_delete_variants_job)
+#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
@@ -1070,7 +1078,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
-#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_delete_variants_jobs)
+#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_delete_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
@@ -1080,7 +1088,7 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
-#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_update_categories_job)
+#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
@@ -1090,7 +1098,7 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
-#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_update_categories_jobs)
+#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
@@ -1100,7 +1108,7 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
-#### [Get Update Items Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_update_items_job)
+#### [Get Update Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_items_job)
```ruby
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
@@ -1110,7 +1118,7 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
-#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_update_items_jobs)
+#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
@@ -1120,7 +1128,7 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
-#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_update_variants_job)
+#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
@@ -1130,7 +1138,7 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
-#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_update_variants_jobs)
+#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_update_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
@@ -1140,7 +1148,7 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
-#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_create_categories_job)
+#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
@@ -1150,7 +1158,7 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
-#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_create_items_job)
+#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_create_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
@@ -1160,7 +1168,7 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
-#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_create_variants_job)
+#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
@@ -1170,7 +1178,7 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
-#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_delete_categories_job)
+#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
@@ -1180,7 +1188,7 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
-#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_delete_items_job)
+#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
@@ -1190,7 +1198,7 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
-#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_delete_variants_job)
+#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
@@ -1200,7 +1208,7 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
-#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_update_categories_job)
+#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
@@ -1210,7 +1218,7 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
-#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_update_items_job)
+#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_update_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
@@ -1220,7 +1228,7 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
-#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_update_variants_job)
+#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
@@ -1230,7 +1238,7 @@ KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
-#### [Update Catalog Category](https://developers.klaviyo.com/en/v2024-06-15/reference/update_catalog_category)
+#### [Update Catalog Category](https://developers.klaviyo.com/en/v2024-07-15/reference/update_catalog_category)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
@@ -1240,7 +1248,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
-#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-06-15/reference/update_catalog_category_relationships_items)
+#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2024-07-15/reference/update_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
@@ -1250,7 +1258,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
-#### [Update Catalog Item](https://developers.klaviyo.com/en/v2024-06-15/reference/update_catalog_item)
+#### [Update Catalog Item](https://developers.klaviyo.com/en/v2024-07-15/reference/update_catalog_item)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
@@ -1260,7 +1268,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
-#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-06-15/reference/update_catalog_item_relationships_categories)
+#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2024-07-15/reference/update_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
@@ -1270,7 +1278,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
-#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2024-06-15/reference/update_catalog_variant)
+#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2024-07-15/reference/update_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
@@ -1284,7 +1292,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
## Coupons
-#### [Create Coupon](https://developers.klaviyo.com/en/v2024-06-15/reference/create_coupon)
+#### [Create Coupon](https://developers.klaviyo.com/en/v2024-07-15/reference/create_coupon)
```ruby
KlaviyoAPI::Coupons.create_coupon(body)
@@ -1294,7 +1302,7 @@ KlaviyoAPI::Coupons.create_coupon(body)
-#### [Create Coupon Code](https://developers.klaviyo.com/en/v2024-06-15/reference/create_coupon_code)
+#### [Create Coupon Code](https://developers.klaviyo.com/en/v2024-07-15/reference/create_coupon_code)
```ruby
KlaviyoAPI::Coupons.create_coupon_code(body)
@@ -1304,7 +1312,7 @@ KlaviyoAPI::Coupons.create_coupon_code(body)
-#### [Delete Coupon](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_coupon)
+#### [Delete Coupon](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_coupon)
```ruby
KlaviyoAPI::Coupons.delete_coupon(id)
@@ -1314,7 +1322,7 @@ KlaviyoAPI::Coupons.delete_coupon(id)
-#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_coupon_code)
+#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_coupon_code)
```ruby
KlaviyoAPI::Coupons.delete_coupon_code(id)
@@ -1324,7 +1332,7 @@ KlaviyoAPI::Coupons.delete_coupon_code(id)
-#### [Get Coupon](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon)
+#### [Get Coupon](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon(id, opts)
@@ -1334,7 +1342,7 @@ KlaviyoAPI::Coupons.get_coupon(id, opts)
-#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_code)
+#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_code)
```ruby
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
@@ -1344,7 +1352,7 @@ KlaviyoAPI::Coupons.get_coupon_code(id, opts)
-#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_code_bulk_create_job)
+#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_code_bulk_create_job)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
@@ -1354,7 +1362,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
-#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_code_bulk_create_jobs)
+#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_code_bulk_create_jobs)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
@@ -1364,7 +1372,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
-#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_code_relationships_coupon)
+#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_code_relationships_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
@@ -1374,7 +1382,7 @@ KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
-#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_codes)
+#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_codes)
```ruby
KlaviyoAPI::Coupons.get_coupon_codes(opts)
@@ -1384,7 +1392,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts)
-#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_codes_for_coupon)
+#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_codes_for_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
@@ -1394,7 +1402,7 @@ KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
-#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_for_coupon_code)
+#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_for_coupon_code)
```ruby
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
@@ -1404,7 +1412,7 @@ KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
-#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupon_relationships_coupon_codes)
+#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupon_relationships_coupon_codes)
```ruby
KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
@@ -1414,7 +1422,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
-#### [Get Coupons](https://developers.klaviyo.com/en/v2024-06-15/reference/get_coupons)
+#### [Get Coupons](https://developers.klaviyo.com/en/v2024-07-15/reference/get_coupons)
```ruby
KlaviyoAPI::Coupons.get_coupons(opts)
@@ -1424,7 +1432,7 @@ KlaviyoAPI::Coupons.get_coupons(opts)
-#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_coupon_code_bulk_create_job)
+#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_coupon_code_bulk_create_job)
```ruby
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
@@ -1434,7 +1442,7 @@ KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
-#### [Update Coupon](https://developers.klaviyo.com/en/v2024-06-15/reference/update_coupon)
+#### [Update Coupon](https://developers.klaviyo.com/en/v2024-07-15/reference/update_coupon)
```ruby
KlaviyoAPI::Coupons.update_coupon(id, body)
@@ -1444,7 +1452,7 @@ KlaviyoAPI::Coupons.update_coupon(id, body)
-#### [Update Coupon Code](https://developers.klaviyo.com/en/v2024-06-15/reference/update_coupon_code)
+#### [Update Coupon Code](https://developers.klaviyo.com/en/v2024-07-15/reference/update_coupon_code)
```ruby
KlaviyoAPI::Coupons.update_coupon_code(id, body)
@@ -1458,7 +1466,7 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body)
## Data Privacy
-#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-06-15/reference/request_profile_deletion)
+#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2024-07-15/reference/request_profile_deletion)
```ruby
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
@@ -1472,7 +1480,7 @@ KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
## Events
-#### [Bulk Create Events](https://developers.klaviyo.com/en/v2024-06-15/reference/bulk_create_events)
+#### [Bulk Create Events](https://developers.klaviyo.com/en/v2024-07-15/reference/bulk_create_events)
```ruby
KlaviyoAPI::Events.bulk_create_events(body)
@@ -1482,7 +1490,7 @@ KlaviyoAPI::Events.bulk_create_events(body)
-#### [Create Event](https://developers.klaviyo.com/en/v2024-06-15/reference/create_event)
+#### [Create Event](https://developers.klaviyo.com/en/v2024-07-15/reference/create_event)
```ruby
KlaviyoAPI::Events.create_event(body)
@@ -1492,7 +1500,7 @@ KlaviyoAPI::Events.create_event(body)
-#### [Get Event](https://developers.klaviyo.com/en/v2024-06-15/reference/get_event)
+#### [Get Event](https://developers.klaviyo.com/en/v2024-07-15/reference/get_event)
```ruby
KlaviyoAPI::Events.get_event(id, opts)
@@ -1502,7 +1510,7 @@ KlaviyoAPI::Events.get_event(id, opts)
-#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-06-15/reference/get_event_metric)
+#### [Get Event Metric](https://developers.klaviyo.com/en/v2024-07-15/reference/get_event_metric)
```ruby
KlaviyoAPI::Events.get_event_metric(id, opts)
@@ -1512,7 +1520,7 @@ KlaviyoAPI::Events.get_event_metric(id, opts)
-#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-06-15/reference/get_event_profile)
+#### [Get Event Profile](https://developers.klaviyo.com/en/v2024-07-15/reference/get_event_profile)
```ruby
KlaviyoAPI::Events.get_event_profile(id, opts)
@@ -1522,7 +1530,7 @@ KlaviyoAPI::Events.get_event_profile(id, opts)
-#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2024-06-15/reference/get_event_relationships_metric)
+#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2024-07-15/reference/get_event_relationships_metric)
```ruby
KlaviyoAPI::Events.get_event_relationships_metric(id)
@@ -1532,7 +1540,7 @@ KlaviyoAPI::Events.get_event_relationships_metric(id)
-#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2024-06-15/reference/get_event_relationships_profile)
+#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2024-07-15/reference/get_event_relationships_profile)
```ruby
KlaviyoAPI::Events.get_event_relationships_profile(id)
@@ -1542,7 +1550,7 @@ KlaviyoAPI::Events.get_event_relationships_profile(id)
-#### [Get Events](https://developers.klaviyo.com/en/v2024-06-15/reference/get_events)
+#### [Get Events](https://developers.klaviyo.com/en/v2024-07-15/reference/get_events)
```ruby
KlaviyoAPI::Events.get_events(opts)
@@ -1556,7 +1564,7 @@ KlaviyoAPI::Events.get_events(opts)
## Flows
-#### [Delete Flow](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_flow)
+#### [Delete Flow](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_flow)
```ruby
KlaviyoAPI::Flows.delete_flow(id)
@@ -1566,7 +1574,7 @@ KlaviyoAPI::Flows.delete_flow(id)
-#### [Get Flow](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow)
+#### [Get Flow](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow)
```ruby
KlaviyoAPI::Flows.get_flow(id, opts)
@@ -1576,7 +1584,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
-#### [Get Flow Action](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_action)
+#### [Get Flow Action](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_action)
```ruby
KlaviyoAPI::Flows.get_flow_action(id, opts)
@@ -1586,7 +1594,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
-#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_action_flow)
+#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_action_flow)
```ruby
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
@@ -1596,7 +1604,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
-#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_action_messages)
+#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_action_messages)
```ruby
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
@@ -1606,7 +1614,7 @@ KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
-#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_action_relationships_flow)
+#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_action_relationships_flow)
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
@@ -1616,7 +1624,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
-#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_action_relationships_messages)
+#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_action_relationships_messages)
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
@@ -1626,7 +1634,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
-#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_flow_actions)
+#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_flow_actions)
```ruby
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
@@ -1636,7 +1644,7 @@ KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
-#### [Get Flow Message](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_message)
+#### [Get Flow Message](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_message)
```ruby
KlaviyoAPI::Flows.get_flow_message(id, opts)
@@ -1646,7 +1654,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
-#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_message_action)
+#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_message_action)
```ruby
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
@@ -1656,7 +1664,7 @@ KlaviyoAPI::Flows.get_flow_message_action(id, opts)
-#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_message_relationships_action)
+#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_message_relationships_action)
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
@@ -1666,7 +1674,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
-#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_message_relationships_template)
+#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_message_relationships_template)
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
@@ -1676,7 +1684,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
-#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_message_template)
+#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_message_template)
```ruby
KlaviyoAPI::Flows.get_flow_message_template(id, opts)
@@ -1686,7 +1694,7 @@ KlaviyoAPI::Flows.get_flow_message_template(id, opts)
-#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_relationships_flow_actions)
+#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_relationships_flow_actions)
```ruby
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
@@ -1696,7 +1704,7 @@ KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
-#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_relationships_tags)
+#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_relationships_tags)
```ruby
KlaviyoAPI::Flows.get_flow_relationships_tags(id)
@@ -1706,7 +1714,7 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
-#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flow_tags)
+#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flow_tags)
```ruby
KlaviyoAPI::Flows.get_flow_tags(id, opts)
@@ -1716,7 +1724,7 @@ KlaviyoAPI::Flows.get_flow_tags(id, opts)
-#### [Get Flows](https://developers.klaviyo.com/en/v2024-06-15/reference/get_flows)
+#### [Get Flows](https://developers.klaviyo.com/en/v2024-07-15/reference/get_flows)
```ruby
KlaviyoAPI::Flows.get_flows(opts)
@@ -1726,7 +1734,7 @@ KlaviyoAPI::Flows.get_flows(opts)
-#### [Update Flow Status](https://developers.klaviyo.com/en/v2024-06-15/reference/update_flow)
+#### [Update Flow Status](https://developers.klaviyo.com/en/v2024-07-15/reference/update_flow)
```ruby
KlaviyoAPI::Flows.update_flow(id, body)
@@ -1737,10 +1745,84 @@ KlaviyoAPI::Flows.update_flow(id, body)
+## Forms
+
+
+#### [Get Form](https://developers.klaviyo.com/en/v2024-07-15/reference/get_form)
+
+```ruby
+KlaviyoAPI::Forms.get_form(id, opts)
+```
+
+
+
+
+
+#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2024-07-15/reference/get_form_for_form_version)
+
+```ruby
+KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
+```
+
+
+
+
+
+#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2024-07-15/reference/get_form_id_for_form_version)
+
+```ruby
+KlaviyoAPI::Forms.get_form_id_for_form_version(id)
+```
+
+
+
+
+
+#### [Get Form Version](https://developers.klaviyo.com/en/v2024-07-15/reference/get_form_version)
+
+```ruby
+KlaviyoAPI::Forms.get_form_version(id, opts)
+```
+
+
+
+
+
+#### [Get Forms](https://developers.klaviyo.com/en/v2024-07-15/reference/get_forms)
+
+```ruby
+KlaviyoAPI::Forms.get_forms(opts)
+```
+
+
+
+
+
+#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2024-07-15/reference/get_version_ids_for_form)
+
+```ruby
+KlaviyoAPI::Forms.get_version_ids_for_form(id)
+```
+
+
+
+
+
+#### [Get Versions for Form](https://developers.klaviyo.com/en/v2024-07-15/reference/get_versions_for_form)
+
+```ruby
+KlaviyoAPI::Forms.get_versions_for_form(id, opts)
+```
+
+
+
+
+
+
## Images
-#### [Get Image](https://developers.klaviyo.com/en/v2024-06-15/reference/get_image)
+#### [Get Image](https://developers.klaviyo.com/en/v2024-07-15/reference/get_image)
```ruby
KlaviyoAPI::Images.get_image(id, opts)
@@ -1750,7 +1832,7 @@ KlaviyoAPI::Images.get_image(id, opts)
-#### [Get Images](https://developers.klaviyo.com/en/v2024-06-15/reference/get_images)
+#### [Get Images](https://developers.klaviyo.com/en/v2024-07-15/reference/get_images)
```ruby
KlaviyoAPI::Images.get_images(opts)
@@ -1760,7 +1842,7 @@ KlaviyoAPI::Images.get_images(opts)
-#### [Update Image](https://developers.klaviyo.com/en/v2024-06-15/reference/update_image)
+#### [Update Image](https://developers.klaviyo.com/en/v2024-07-15/reference/update_image)
```ruby
KlaviyoAPI::Images.update_image(id, body)
@@ -1770,7 +1852,7 @@ KlaviyoAPI::Images.update_image(id, body)
-#### [Upload Image From File](https://developers.klaviyo.com/en/v2024-06-15/reference/upload_image_from_file)
+#### [Upload Image From File](https://developers.klaviyo.com/en/v2024-07-15/reference/upload_image_from_file)
```ruby
KlaviyoAPI::Images.upload_image_from_file(file, opts)
@@ -1780,7 +1862,7 @@ KlaviyoAPI::Images.upload_image_from_file(file, opts)
-#### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-06-15/reference/upload_image_from_url)
+#### [Upload Image From URL](https://developers.klaviyo.com/en/v2024-07-15/reference/upload_image_from_url)
```ruby
KlaviyoAPI::Images.upload_image_from_url(body)
@@ -1794,7 +1876,7 @@ KlaviyoAPI::Images.upload_image_from_url(body)
## Lists
-#### [Create List](https://developers.klaviyo.com/en/v2024-06-15/reference/create_list)
+#### [Create List](https://developers.klaviyo.com/en/v2024-07-15/reference/create_list)
```ruby
KlaviyoAPI::Lists.create_list(body)
@@ -1804,7 +1886,7 @@ KlaviyoAPI::Lists.create_list(body)
-#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-06-15/reference/create_list_relationships)
+#### [Add Profile To List](https://developers.klaviyo.com/en/v2024-07-15/reference/create_list_relationships)
```ruby
KlaviyoAPI::Lists.create_list_relationships(id, body)
@@ -1814,7 +1896,7 @@ KlaviyoAPI::Lists.create_list_relationships(id, body)
-#### [Delete List](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_list)
+#### [Delete List](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_list)
```ruby
KlaviyoAPI::Lists.delete_list(id)
@@ -1824,7 +1906,7 @@ KlaviyoAPI::Lists.delete_list(id)
-#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_list_relationships)
+#### [Remove Profile From List](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_list_relationships)
```ruby
KlaviyoAPI::Lists.delete_list_relationships(id, body)
@@ -1834,7 +1916,7 @@ KlaviyoAPI::Lists.delete_list_relationships(id, body)
-#### [Get List](https://developers.klaviyo.com/en/v2024-06-15/reference/get_list)
+#### [Get List](https://developers.klaviyo.com/en/v2024-07-15/reference/get_list)
```ruby
KlaviyoAPI::Lists.get_list(id, opts)
@@ -1844,7 +1926,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
-#### [Get List Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/get_list_profiles)
+#### [Get List Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_list_profiles)
```ruby
KlaviyoAPI::Lists.get_list_profiles(id, opts)
@@ -1854,7 +1936,7 @@ KlaviyoAPI::Lists.get_list_profiles(id, opts)
-#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/get_list_relationships_profiles)
+#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_list_relationships_profiles)
```ruby
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
@@ -1864,7 +1946,7 @@ KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
-#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_list_relationships_tags)
+#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_list_relationships_tags)
```ruby
KlaviyoAPI::Lists.get_list_relationships_tags(id)
@@ -1874,7 +1956,7 @@ KlaviyoAPI::Lists.get_list_relationships_tags(id)
-#### [Get List Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_list_tags)
+#### [Get List Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_list_tags)
```ruby
KlaviyoAPI::Lists.get_list_tags(id, opts)
@@ -1884,7 +1966,7 @@ KlaviyoAPI::Lists.get_list_tags(id, opts)
-#### [Get Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/get_lists)
+#### [Get Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_lists)
```ruby
KlaviyoAPI::Lists.get_lists(opts)
@@ -1894,7 +1976,7 @@ KlaviyoAPI::Lists.get_lists(opts)
-#### [Update List](https://developers.klaviyo.com/en/v2024-06-15/reference/update_list)
+#### [Update List](https://developers.klaviyo.com/en/v2024-07-15/reference/update_list)
```ruby
KlaviyoAPI::Lists.update_list(id, body)
@@ -1908,7 +1990,7 @@ KlaviyoAPI::Lists.update_list(id, body)
## Metrics
-#### [Get Metric](https://developers.klaviyo.com/en/v2024-06-15/reference/get_metric)
+#### [Get Metric](https://developers.klaviyo.com/en/v2024-07-15/reference/get_metric)
```ruby
KlaviyoAPI::Metrics.get_metric(id, opts)
@@ -1918,7 +2000,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
-#### [Get Metrics](https://developers.klaviyo.com/en/v2024-06-15/reference/get_metrics)
+#### [Get Metrics](https://developers.klaviyo.com/en/v2024-07-15/reference/get_metrics)
```ruby
KlaviyoAPI::Metrics.get_metrics(opts)
@@ -1928,7 +2010,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
-#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2024-06-15/reference/query_metric_aggregates)
+#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2024-07-15/reference/query_metric_aggregates)
```ruby
KlaviyoAPI::Metrics.query_metric_aggregates(body)
@@ -1942,7 +2024,7 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
## Profiles
-#### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-06-15/reference/create_or_update_profile)
+#### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-07-15/reference/create_or_update_profile)
```ruby
KlaviyoAPI::Profiles.create_or_update_profile(body)
@@ -1952,7 +2034,7 @@ KlaviyoAPI::Profiles.create_or_update_profile(body)
-#### [Create Profile](https://developers.klaviyo.com/en/v2024-06-15/reference/create_profile)
+#### [Create Profile](https://developers.klaviyo.com/en/v2024-07-15/reference/create_profile)
```ruby
KlaviyoAPI::Profiles.create_profile(body)
@@ -1962,7 +2044,7 @@ KlaviyoAPI::Profiles.create_profile(body)
-#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2024-06-15/reference/create_push_token)
+#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2024-07-15/reference/create_push_token)
```ruby
KlaviyoAPI::Profiles.create_push_token(body)
@@ -1972,7 +2054,7 @@ KlaviyoAPI::Profiles.create_push_token(body)
-#### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-06-15/reference/get_bulk_profile_import_job)
+#### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
@@ -1982,7 +2064,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
-#### [Get Bulk Profile Import Job Errors](https://developers.klaviyo.com/en/v2024-06-15/reference/get_bulk_profile_import_job_import_errors)
+#### [Get Bulk Profile Import Job Errors](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_import_errors)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
@@ -1992,7 +2074,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
-#### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/get_bulk_profile_import_job_lists)
+#### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_lists)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
@@ -2002,7 +2084,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
-#### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/get_bulk_profile_import_job_profiles)
+#### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_profiles)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
@@ -2012,7 +2094,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
-#### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/get_bulk_profile_import_job_relationships_lists)
+#### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_relationships_lists)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
@@ -2022,7 +2104,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
-#### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/get_bulk_profile_import_job_relationships_profiles)
+#### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_job_relationships_profiles)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts)
@@ -2032,7 +2114,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts
-#### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2024-06-15/reference/get_bulk_profile_import_jobs)
+#### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2024-07-15/reference/get_bulk_profile_import_jobs)
```ruby
KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
@@ -2042,7 +2124,7 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
-#### [Get Profile](https://developers.klaviyo.com/en/v2024-06-15/reference/get_profile)
+#### [Get Profile](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profile)
```ruby
KlaviyoAPI::Profiles.get_profile(id, opts)
@@ -2052,7 +2134,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
-#### [Get Profile Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/get_profile_lists)
+#### [Get Profile Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profile_lists)
```ruby
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
@@ -2062,7 +2144,7 @@ KlaviyoAPI::Profiles.get_profile_lists(id, opts)
-#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/get_profile_relationships_lists)
+#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profile_relationships_lists)
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
@@ -2072,7 +2154,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
-#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2024-06-15/reference/get_profile_relationships_segments)
+#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profile_relationships_segments)
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
@@ -2082,7 +2164,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
-#### [Get Profile Segments](https://developers.klaviyo.com/en/v2024-06-15/reference/get_profile_segments)
+#### [Get Profile Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profile_segments)
```ruby
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
@@ -2092,7 +2174,7 @@ KlaviyoAPI::Profiles.get_profile_segments(id, opts)
-#### [Get Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/get_profiles)
+#### [Get Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_profiles)
```ruby
KlaviyoAPI::Profiles.get_profiles(opts)
@@ -2102,7 +2184,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
-#### [Merge Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/merge_profiles)
+#### [Merge Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/merge_profiles)
```ruby
KlaviyoAPI::Profiles.merge_profiles(body)
@@ -2112,7 +2194,7 @@ KlaviyoAPI::Profiles.merge_profiles(body)
-#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-06-15/reference/spawn_bulk_profile_import_job)
+#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-07-15/reference/spawn_bulk_profile_import_job)
```ruby
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
@@ -2122,7 +2204,7 @@ KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
-#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/subscribe_profiles)
+#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/subscribe_profiles)
```ruby
KlaviyoAPI::Profiles.subscribe_profiles(body)
@@ -2132,7 +2214,7 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
-#### [Suppress Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/suppress_profiles)
+#### [Suppress Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/suppress_profiles)
```ruby
KlaviyoAPI::Profiles.suppress_profiles(body)
@@ -2142,7 +2224,7 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
-#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/unsubscribe_profiles)
+#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/unsubscribe_profiles)
```ruby
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
@@ -2152,7 +2234,7 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
-#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/unsuppress_profiles)
+#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/unsuppress_profiles)
```ruby
KlaviyoAPI::Profiles.unsuppress_profiles(body)
@@ -2162,7 +2244,7 @@ KlaviyoAPI::Profiles.unsuppress_profiles(body)
-#### [Update Profile](https://developers.klaviyo.com/en/v2024-06-15/reference/update_profile)
+#### [Update Profile](https://developers.klaviyo.com/en/v2024-07-15/reference/update_profile)
```ruby
KlaviyoAPI::Profiles.update_profile(id, body)
@@ -2176,7 +2258,7 @@ KlaviyoAPI::Profiles.update_profile(id, body)
## Reporting
-#### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-06-15/reference/query_campaign_values)
+#### [Query Campaign Values](https://developers.klaviyo.com/en/v2024-07-15/reference/query_campaign_values)
```ruby
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
@@ -2186,7 +2268,7 @@ KlaviyoAPI::Reporting.query_campaign_values(body, opts)
-#### [Query Flow Series](https://developers.klaviyo.com/en/v2024-06-15/reference/query_flow_series)
+#### [Query Flow Series](https://developers.klaviyo.com/en/v2024-07-15/reference/query_flow_series)
```ruby
KlaviyoAPI::Reporting.query_flow_series(body, opts)
@@ -2196,7 +2278,7 @@ KlaviyoAPI::Reporting.query_flow_series(body, opts)
-#### [Query Flow Values](https://developers.klaviyo.com/en/v2024-06-15/reference/query_flow_values)
+#### [Query Flow Values](https://developers.klaviyo.com/en/v2024-07-15/reference/query_flow_values)
```ruby
KlaviyoAPI::Reporting.query_flow_values(body, opts)
@@ -2210,7 +2292,7 @@ KlaviyoAPI::Reporting.query_flow_values(body, opts)
## Segments
-#### [Create Segment](https://developers.klaviyo.com/en/v2024-06-15/reference/create_segment)
+#### [Create Segment](https://developers.klaviyo.com/en/v2024-07-15/reference/create_segment)
```ruby
KlaviyoAPI::Segments.create_segment(body)
@@ -2220,7 +2302,7 @@ KlaviyoAPI::Segments.create_segment(body)
-#### [Delete Segment](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_segment)
+#### [Delete Segment](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_segment)
```ruby
KlaviyoAPI::Segments.delete_segment(id)
@@ -2230,7 +2312,7 @@ KlaviyoAPI::Segments.delete_segment(id)
-#### [Get Segment](https://developers.klaviyo.com/en/v2024-06-15/reference/get_segment)
+#### [Get Segment](https://developers.klaviyo.com/en/v2024-07-15/reference/get_segment)
```ruby
KlaviyoAPI::Segments.get_segment(id, opts)
@@ -2240,7 +2322,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
-#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/get_segment_profiles)
+#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_segment_profiles)
```ruby
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
@@ -2250,7 +2332,7 @@ KlaviyoAPI::Segments.get_segment_profiles(id, opts)
-#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2024-06-15/reference/get_segment_relationships_profiles)
+#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2024-07-15/reference/get_segment_relationships_profiles)
```ruby
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
@@ -2260,7 +2342,7 @@ KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
-#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_segment_relationships_tags)
+#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_segment_relationships_tags)
```ruby
KlaviyoAPI::Segments.get_segment_relationships_tags(id)
@@ -2270,7 +2352,7 @@ KlaviyoAPI::Segments.get_segment_relationships_tags(id)
-#### [Get Segment Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_segment_tags)
+#### [Get Segment Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_segment_tags)
```ruby
KlaviyoAPI::Segments.get_segment_tags(id, opts)
@@ -2280,7 +2362,7 @@ KlaviyoAPI::Segments.get_segment_tags(id, opts)
-#### [Get Segments](https://developers.klaviyo.com/en/v2024-06-15/reference/get_segments)
+#### [Get Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/get_segments)
```ruby
KlaviyoAPI::Segments.get_segments(opts)
@@ -2290,7 +2372,7 @@ KlaviyoAPI::Segments.get_segments(opts)
-#### [Update Segment](https://developers.klaviyo.com/en/v2024-06-15/reference/update_segment)
+#### [Update Segment](https://developers.klaviyo.com/en/v2024-07-15/reference/update_segment)
```ruby
KlaviyoAPI::Segments.update_segment(id, body)
@@ -2304,7 +2386,7 @@ KlaviyoAPI::Segments.update_segment(id, body)
## Tags
-#### [Create Tag](https://developers.klaviyo.com/en/v2024-06-15/reference/create_tag)
+#### [Create Tag](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag)
```ruby
KlaviyoAPI::Tags.create_tag(body)
@@ -2314,7 +2396,7 @@ KlaviyoAPI::Tags.create_tag(body)
-#### [Create Tag Group](https://developers.klaviyo.com/en/v2024-06-15/reference/create_tag_group)
+#### [Create Tag Group](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_group)
```ruby
KlaviyoAPI::Tags.create_tag_group(body)
@@ -2324,7 +2406,7 @@ KlaviyoAPI::Tags.create_tag_group(body)
-#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-06-15/reference/create_tag_relationships_campaigns)
+#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
@@ -2334,7 +2416,7 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
-#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-06-15/reference/create_tag_relationships_flows)
+#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
@@ -2344,7 +2426,7 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
-#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/create_tag_relationships_lists)
+#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
@@ -2354,7 +2436,7 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
-#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-06-15/reference/create_tag_relationships_segments)
+#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/create_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
@@ -2364,7 +2446,7 @@ KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
-#### [Delete Tag](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_tag)
+#### [Delete Tag](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_tag)
```ruby
KlaviyoAPI::Tags.delete_tag(id)
@@ -2374,7 +2456,7 @@ KlaviyoAPI::Tags.delete_tag(id)
-#### [Delete Tag Group](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_tag_group)
+#### [Delete Tag Group](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_tag_group)
```ruby
KlaviyoAPI::Tags.delete_tag_group(id)
@@ -2384,7 +2466,7 @@ KlaviyoAPI::Tags.delete_tag_group(id)
-#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_tag_relationships_campaigns)
+#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
@@ -2394,7 +2476,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
-#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_tag_relationships_flows)
+#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
@@ -2404,7 +2486,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
-#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_tag_relationships_lists)
+#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
@@ -2414,7 +2496,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
-#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_tag_relationships_segments)
+#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
@@ -2424,7 +2506,7 @@ KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
-#### [Get Tag](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag)
+#### [Get Tag](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag)
```ruby
KlaviyoAPI::Tags.get_tag(id, opts)
@@ -2434,7 +2516,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
-#### [Get Tag Group](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_group)
+#### [Get Tag Group](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_group(id, opts)
@@ -2444,7 +2526,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
-#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_group_relationships_tags)
+#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_group_relationships_tags)
```ruby
KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
@@ -2454,7 +2536,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
-#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_group_tags)
+#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_group_tags)
```ruby
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
@@ -2464,7 +2546,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
-#### [Get Tag Groups](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_groups)
+#### [Get Tag Groups](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_groups)
```ruby
KlaviyoAPI::Tags.get_tag_groups(opts)
@@ -2474,7 +2556,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
-#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_relationships_campaigns)
+#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
@@ -2484,7 +2566,7 @@ KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
-#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_relationships_flows)
+#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_flows(id)
@@ -2494,7 +2576,7 @@ KlaviyoAPI::Tags.get_tag_relationships_flows(id)
-#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_relationships_lists)
+#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_lists(id)
@@ -2504,7 +2586,7 @@ KlaviyoAPI::Tags.get_tag_relationships_lists(id)
-#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_relationships_segments)
+#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_segments(id)
@@ -2514,7 +2596,7 @@ KlaviyoAPI::Tags.get_tag_relationships_segments(id)
-#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_relationships_tag_group)
+#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_relationships_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
@@ -2524,7 +2606,7 @@ KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
-#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tag_tag_group)
+#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tag_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
@@ -2534,7 +2616,7 @@ KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
-#### [Get Tags](https://developers.klaviyo.com/en/v2024-06-15/reference/get_tags)
+#### [Get Tags](https://developers.klaviyo.com/en/v2024-07-15/reference/get_tags)
```ruby
KlaviyoAPI::Tags.get_tags(opts)
@@ -2544,7 +2626,7 @@ KlaviyoAPI::Tags.get_tags(opts)
-#### [Update Tag](https://developers.klaviyo.com/en/v2024-06-15/reference/update_tag)
+#### [Update Tag](https://developers.klaviyo.com/en/v2024-07-15/reference/update_tag)
```ruby
KlaviyoAPI::Tags.update_tag(id, body)
@@ -2554,7 +2636,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
-#### [Update Tag Group](https://developers.klaviyo.com/en/v2024-06-15/reference/update_tag_group)
+#### [Update Tag Group](https://developers.klaviyo.com/en/v2024-07-15/reference/update_tag_group)
```ruby
KlaviyoAPI::Tags.update_tag_group(id, body)
@@ -2568,7 +2650,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
## Templates
-#### [Create Template](https://developers.klaviyo.com/en/v2024-06-15/reference/create_template)
+#### [Create Template](https://developers.klaviyo.com/en/v2024-07-15/reference/create_template)
```ruby
KlaviyoAPI::Templates.create_template(body)
@@ -2578,7 +2660,7 @@ KlaviyoAPI::Templates.create_template(body)
-#### [Create Template Clone](https://developers.klaviyo.com/en/v2024-06-15/reference/create_template_clone)
+#### [Create Template Clone](https://developers.klaviyo.com/en/v2024-07-15/reference/create_template_clone)
```ruby
KlaviyoAPI::Templates.create_template_clone(body)
@@ -2588,7 +2670,7 @@ KlaviyoAPI::Templates.create_template_clone(body)
-#### [Create Template Render](https://developers.klaviyo.com/en/v2024-06-15/reference/create_template_render)
+#### [Create Template Render](https://developers.klaviyo.com/en/v2024-07-15/reference/create_template_render)
```ruby
KlaviyoAPI::Templates.create_template_render(body)
@@ -2598,7 +2680,7 @@ KlaviyoAPI::Templates.create_template_render(body)
-#### [Delete Template](https://developers.klaviyo.com/en/v2024-06-15/reference/delete_template)
+#### [Delete Template](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_template)
```ruby
KlaviyoAPI::Templates.delete_template(id)
@@ -2608,7 +2690,7 @@ KlaviyoAPI::Templates.delete_template(id)
-#### [Get Template](https://developers.klaviyo.com/en/v2024-06-15/reference/get_template)
+#### [Get Template](https://developers.klaviyo.com/en/v2024-07-15/reference/get_template)
```ruby
KlaviyoAPI::Templates.get_template(id, opts)
@@ -2618,7 +2700,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
-#### [Get Templates](https://developers.klaviyo.com/en/v2024-06-15/reference/get_templates)
+#### [Get Templates](https://developers.klaviyo.com/en/v2024-07-15/reference/get_templates)
```ruby
KlaviyoAPI::Templates.get_templates(opts)
@@ -2628,7 +2710,7 @@ KlaviyoAPI::Templates.get_templates(opts)
-#### [Update Template](https://developers.klaviyo.com/en/v2024-06-15/reference/update_template)
+#### [Update Template](https://developers.klaviyo.com/en/v2024-07-15/reference/update_template)
```ruby
KlaviyoAPI::Templates.update_template(id, body)
@@ -2638,6 +2720,80 @@ KlaviyoAPI::Templates.update_template(id, body)
+
+## Webhooks
+
+
+#### [Create Webhook](https://developers.klaviyo.com/en/v2024-07-15/reference/create_webhook)
+
+```ruby
+KlaviyoAPI::Webhooks.create_webhook(body)
+```
+
+
+
+
+
+#### [Delete Webhook](https://developers.klaviyo.com/en/v2024-07-15/reference/delete_webhook)
+
+```ruby
+KlaviyoAPI::Webhooks.delete_webhook(id)
+```
+
+
+
+
+
+#### [Get Webhook](https://developers.klaviyo.com/en/v2024-07-15/reference/get_webhook)
+
+```ruby
+KlaviyoAPI::Webhooks.get_webhook(id, opts)
+```
+
+
+
+
+
+#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2024-07-15/reference/get_webhook_topic)
+
+```ruby
+KlaviyoAPI::Webhooks.get_webhook_topic(id)
+```
+
+
+
+
+
+#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2024-07-15/reference/get_webhook_topics)
+
+```ruby
+KlaviyoAPI::Webhooks.get_webhook_topics
+```
+
+
+
+
+
+#### [Get Webhooks](https://developers.klaviyo.com/en/v2024-07-15/reference/get_webhooks)
+
+```ruby
+KlaviyoAPI::Webhooks.get_webhooks(opts)
+```
+
+
+
+
+
+#### [Update Webhook](https://developers.klaviyo.com/en/v2024-07-15/reference/update_webhook)
+
+```ruby
+KlaviyoAPI::Webhooks.update_webhook(id, body)
+```
+
+
+
+
+
# Appendix
## Per Request API key
diff --git a/klaviyo-api-sdk.gemspec b/klaviyo-api-sdk.gemspec
index ba50d0d..967ac3f 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-06-15
+The version of the OpenAPI document: 2024-07-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 = "7.1.0"
+ s.version = "8.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 726406c..5f286de 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-06-15
+The version of the OpenAPI document: 2024-07-15
Contact: developers@klaviyo.com
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.2.1
@@ -418,7 +418,7 @@
require 'klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile'
require 'klaviyo-api-sdk/models/push_token_enum'
require 'klaviyo-api-sdk/models/relative_anniversary_date_filter'
-require 'klaviyo-api-sdk/models/relative_date_filter'
+require 'klaviyo-api-sdk/models/relative_date_operator_base_filter'
require 'klaviyo-api-sdk/models/relative_date_range_filter'
require 'klaviyo-api-sdk/models/render_options_sub_object'
require 'klaviyo-api-sdk/models/sms_content_sub_object_create'
@@ -537,6 +537,17 @@
require 'klaviyo-api-sdk/models/union_positive_numeric_filter'
require 'klaviyo-api-sdk/models/union_positive_numeric_filter_operator'
require 'klaviyo-api-sdk/models/unsubscribed_enum'
+require 'klaviyo-api-sdk/models/webhook_create_query'
+require 'klaviyo-api-sdk/models/webhook_create_query_resource_object'
+require 'klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes'
+require 'klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships'
+require 'klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics'
+require 'klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner'
+require 'klaviyo-api-sdk/models/webhook_enum'
+require 'klaviyo-api-sdk/models/webhook_partial_update_query'
+require 'klaviyo-api-sdk/models/webhook_partial_update_query_resource_object'
+require 'klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes'
+require 'klaviyo-api-sdk/models/webhook_topic_enum'
# APIs
require 'klaviyo-api-sdk/api/accounts_api'
@@ -546,6 +557,7 @@
require 'klaviyo-api-sdk/api/data_privacy_api'
require 'klaviyo-api-sdk/api/events_api'
require 'klaviyo-api-sdk/api/flows_api'
+require 'klaviyo-api-sdk/api/forms_api'
require 'klaviyo-api-sdk/api/images_api'
require 'klaviyo-api-sdk/api/lists_api'
require 'klaviyo-api-sdk/api/metrics_api'
@@ -554,6 +566,7 @@
require 'klaviyo-api-sdk/api/segments_api'
require 'klaviyo-api-sdk/api/tags_api'
require 'klaviyo-api-sdk/api/templates_api'
+require 'klaviyo-api-sdk/api/webhooks_api'
# retry logic
require 'retriable'
diff --git a/lib/klaviyo-api-sdk/api/accounts_api.rb b/lib/klaviyo-api-sdk/api/accounts_api.rb
index 4335fdf..9b6af3c 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-06-15
+The version of the OpenAPI document: 2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-07-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
@@ -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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
# @return [Hash]
def get_accounts(opts = {})
data, _status_code, _headers = get_accounts_with_http_info(opts)
@@ -104,7 +104,7 @@ 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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_account For more information please visit https://developers.klaviyo.com/en/v2024-07-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
@@ -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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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 3ef9b50..0237072 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-06-15
+The version of the OpenAPI document: 2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-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-07-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-06-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-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-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-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-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-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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 6fa993a..6a56bb0 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-06-15
+The version of the OpenAPI document: 2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#relationships
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#pagination
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#relationships
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#relationships
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#pagination
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting
+ # @option opts [Array] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#pagination
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-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-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-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-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-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-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-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-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-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['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-06-15"
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-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-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
- # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-06-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-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+ # @option opts [Array] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
# @return [Hash]
def get_create_items_job(job_id, opts = {})
data, _status_code, _headers = get_create_items_job_with_http_info(job_id, opts)
@@ -1859,9 +1859,9 @@ def get_create_items_job(job_id, 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`.<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