README.md in klaviyo-api-sdk-5.0.0 vs README.md in klaviyo-api-sdk-5.1.0
- old
+ new
@@ -1,14 +1,14 @@
# Klaviyo Ruby SDK
-- SDK version: 5.0.0
-- API revision: 2023-10-15
+- SDK version: 5.1.0
+- API revision: 2023-12-15
## Helpful Resources
-- [API Reference](https://developers.klaviyo.com/en/v2023-10-15/reference)
-- [API Guides](https://developers.klaviyo.com/en/v2023-10-15/docs)
+- [API Reference](https://developers.klaviyo.com/en/v2023-12-15/reference)
+- [API Guides](https://developers.klaviyo.com/en/v2023-12-15/docs)
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
## Design & Approach
This SDK is a thin wrapper around our API. See our API Reference for full documentation on API behavior.
@@ -88,17 +88,17 @@
```
Then install the gem locally:
```shell
-gem install ./klaviyo-api-sdk-5.0.0.gem
+gem install ./klaviyo-api-sdk-5.1.0.gem
```
Finally add this to the Gemfile:
- gem 'klaviyo-api-sdk', '~> 5.0.0'
+ gem 'klaviyo-api-sdk', '~> 5.1.0'
To install directly from rubygems:
```shell
gem install klaviyo-api-sdk
@@ -458,11 +458,11 @@
```
## 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/v2023-10-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/v2023-12-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.
@@ -470,21 +470,21 @@
## Accounts
-#### [Get Account](https://developers.klaviyo.com/en/v2023-10-15/reference/get_account)
+#### [Get Account](https://developers.klaviyo.com/en/v2023-12-15/reference/get_account)
```ruby
KlaviyoAPI::Accounts.get_account(id, opts)
```
-#### [Get Accounts](https://developers.klaviyo.com/en/v2023-10-15/reference/get_accounts)
+#### [Get Accounts](https://developers.klaviyo.com/en/v2023-12-15/reference/get_accounts)
```ruby
KlaviyoAPI::Accounts.get_accounts(opts)
```
@@ -494,231 +494,231 @@
## Campaigns
-#### [Create Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign)
+#### [Create Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign)
```ruby
KlaviyoAPI::Campaigns.create_campaign(body)
```
-#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_clone)
+#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_clone)
```ruby
KlaviyoAPI::Campaigns.create_campaign_clone(body)
```
-#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_message_assign_template)
+#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_message_assign_template)
```ruby
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
```
-#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_recipient_estimation_job)
+#### [Create Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_recipient_estimation_job)
```ruby
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
```
-#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-10-15/reference/create_campaign_send_job)
+#### [Create Campaign Send Job](https://developers.klaviyo.com/en/v2023-12-15/reference/create_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
```
-#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_campaign)
+#### [Delete Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_campaign)
```ruby
KlaviyoAPI::Campaigns.delete_campaign(id)
```
-#### [Get Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign)
+#### [Get Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign(id, opts)
```
-#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_campaign_messages)
+#### [Get Campaign Campaign Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_campaign_messages)
```ruby
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
```
-#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message)
+#### [Get Campaign Message](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
```
-#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_campaign)
+#### [Get Campaign Message Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
```
-#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_relationships_campaign)
+#### [Get Campaign Message Relationships Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_relationships_campaign)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
```
-#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_relationships_template)
+#### [Get Campaign Message Relationships Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_relationships_template)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
```
-#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_message_template)
+#### [Get Campaign Message Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_message_template)
```ruby
KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
```
-#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_recipient_estimation)
+#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_recipient_estimation)
```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
```
-#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_recipient_estimation_job)
+#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_recipient_estimation_job)
```ruby
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
```
-#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_relationships_campaign_messages)
+#### [Get Campaign Relationships Campaign Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_relationships_campaign_messages)
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
```
-#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_relationships_tags)
+#### [Get Campaign Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_relationships_tags)
```ruby
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
```
-#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_send_job)
+#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
```
-#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaign_tags)
+#### [Get Campaign Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaign_tags)
```ruby
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
```
-#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/get_campaigns)
+#### [Get Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/get_campaigns)
```ruby
KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
```
-#### [Update Campaign](https://developers.klaviyo.com/en/v2023-10-15/reference/update_campaign)
+#### [Update Campaign](https://developers.klaviyo.com/en/v2023-12-15/reference/update_campaign)
```ruby
KlaviyoAPI::Campaigns.update_campaign(id, body)
```
-#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-10-15/reference/update_campaign_message)
+#### [Update Campaign Message](https://developers.klaviyo.com/en/v2023-12-15/reference/update_campaign_message)
```ruby
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
```
-#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-10-15/reference/update_campaign_send_job)
+#### [Update Campaign Send Job](https://developers.klaviyo.com/en/v2023-12-15/reference/update_campaign_send_job)
```ruby
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
```
@@ -728,541 +728,541 @@
## Catalogs
-#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2023-10-15/reference/create_back_in_stock_subscription)
+#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2023-12-15/reference/create_back_in_stock_subscription)
```ruby
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
```
-#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_category)
+#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_category)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category(body)
```
-#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_category_relationships_items)
+#### [Create Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
```
-#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_item)
+#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_item)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item(body)
```
-#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_item_relationships_categories)
+#### [Create Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
```
-#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/create_catalog_variant)
+#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/create_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.create_catalog_variant(body)
```
-#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_category)
+#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_category)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category(id)
```
-#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_category_relationships_items)
+#### [Delete Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
```
-#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_item)
+#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_item)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item(id)
```
-#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_item_relationships_categories)
+#### [Delete Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
```
-#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_catalog_variant)
+#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
```
-#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_categories)
+#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
```
-#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_category)
+#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_category)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
```
-#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_category_items)
+#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_category_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
```
-#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_category_relationships_items)
+#### [Get Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
```
-#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item)
+#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
```
-#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item_categories)
+#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
```
-#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item_relationships_categories)
+#### [Get Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
```
-#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_item_variants)
+#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_item_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
```
-#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_items)
+#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_items(opts)
```
-#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_variant)
+#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
```
-#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-10-15/reference/get_catalog_variants)
+#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-12-15/reference/get_catalog_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
```
-#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_categories_job)
+#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
```
-#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_categories_jobs)
+#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
```
-#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_items_job)
+#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_items_job)
```ruby
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
```
-#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_items_jobs)
+#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
```
-#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_variants_job)
+#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
```
-#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_create_variants_jobs)
+#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_create_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
```
-#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_categories_job)
+#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
```
-#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_categories_jobs)
+#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
```
-#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_items_job)
+#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
```
-#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_items_jobs)
+#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
```
-#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_variants_job)
+#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
```
-#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_delete_variants_jobs)
+#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_delete_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
```
-#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_categories_job)
+#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
```
-#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_categories_jobs)
+#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
```
-#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_items_job)
+#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_items_job)
```ruby
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
```
-#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_items_jobs)
+#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
```
-#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_variants_job)
+#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
```
-#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_update_variants_jobs)
+#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_update_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
```
-#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_create_categories_job)
+#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
```
-#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_create_items_job)
+#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_create_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
```
-#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_create_variants_job)
+#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
```
-#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_delete_categories_job)
+#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
```
-#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_delete_items_job)
+#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
```
-#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_delete_variants_job)
+#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
```
-#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_update_categories_job)
+#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
```
-#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_update_items_job)
+#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_update_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
```
-#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_update_variants_job)
+#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
```
-#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_category)
+#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_category)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
```
-#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_category_relationships_items)
+#### [Update Catalog Category Relationships Items](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_category_relationships_items)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
```
-#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_item)
+#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_item)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
```
-#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_item_relationships_categories)
+#### [Update Catalog Item Relationships Categories](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_item_relationships_categories)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
```
-#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-10-15/reference/update_catalog_variant)
+#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-12-15/reference/update_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
```
@@ -1272,171 +1272,171 @@
## Coupons
-#### [Create Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/create_coupon)
+#### [Create Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/create_coupon)
```ruby
KlaviyoAPI::Coupons.create_coupon(body)
```
-#### [Create Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/create_coupon_code)
+#### [Create Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/create_coupon_code)
```ruby
KlaviyoAPI::Coupons.create_coupon_code(body)
```
-#### [Delete Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_coupon)
+#### [Delete Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_coupon)
```ruby
KlaviyoAPI::Coupons.delete_coupon(id)
```
-#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_coupon_code)
+#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_coupon_code)
```ruby
KlaviyoAPI::Coupons.delete_coupon_code(id)
```
-#### [Get Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon)
+#### [Get Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon(id, opts)
```
-#### [Get Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code)
+#### [Get Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code)
```ruby
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
```
-#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code_bulk_create_job)
+#### [Get Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code_bulk_create_job)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
```
-#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code_bulk_create_jobs)
+#### [Get Coupon Code Bulk Create Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code_bulk_create_jobs)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
```
-#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_code_relationships_coupon)
+#### [Get Coupon Code Relationships Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_code_relationships_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
```
-#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_codes)
+#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_codes)
```ruby
KlaviyoAPI::Coupons.get_coupon_codes(opts)
```
-#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_codes_for_coupon)
+#### [Get Coupon Codes For Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_codes_for_coupon)
```ruby
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
```
-#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_for_coupon_code)
+#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_for_coupon_code)
```ruby
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
```
-#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupon_relationships_coupon_codes)
+#### [Get Coupon Relationships Coupon Codes](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupon_relationships_coupon_codes)
```ruby
KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
```
-#### [Get Coupons](https://developers.klaviyo.com/en/v2023-10-15/reference/get_coupons)
+#### [Get Coupons](https://developers.klaviyo.com/en/v2023-12-15/reference/get_coupons)
```ruby
KlaviyoAPI::Coupons.get_coupons(opts)
```
-#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-10-15/reference/spawn_coupon_code_bulk_create_job)
+#### [Spawn Coupon Code Bulk Create Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_coupon_code_bulk_create_job)
```ruby
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
```
-#### [Update Coupon](https://developers.klaviyo.com/en/v2023-10-15/reference/update_coupon)
+#### [Update Coupon](https://developers.klaviyo.com/en/v2023-12-15/reference/update_coupon)
```ruby
KlaviyoAPI::Coupons.update_coupon(id, body)
```
-#### [Update Coupon Code](https://developers.klaviyo.com/en/v2023-10-15/reference/update_coupon_code)
+#### [Update Coupon Code](https://developers.klaviyo.com/en/v2023-12-15/reference/update_coupon_code)
```ruby
KlaviyoAPI::Coupons.update_coupon_code(id, body)
```
@@ -1446,11 +1446,11 @@
## Data Privacy
-#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-10-15/reference/request_profile_deletion)
+#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-12-15/reference/request_profile_deletion)
```ruby
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
```
@@ -1460,71 +1460,71 @@
## Events
-#### [Create Event](https://developers.klaviyo.com/en/v2023-10-15/reference/create_event)
+#### [Create Event](https://developers.klaviyo.com/en/v2023-12-15/reference/create_event)
```ruby
KlaviyoAPI::Events.create_event(body)
```
-#### [Get Event](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event)
+#### [Get Event](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event)
```ruby
KlaviyoAPI::Events.get_event(id, opts)
```
-#### [Get Event Metric](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_metric)
+#### [Get Event Metric](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_metric)
```ruby
KlaviyoAPI::Events.get_event_metric(id, opts)
```
-#### [Get Event Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_profile)
+#### [Get Event Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_profile)
```ruby
KlaviyoAPI::Events.get_event_profile(id, opts)
```
-#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_relationships_metric)
+#### [Get Event Relationships Metric](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_relationships_metric)
```ruby
KlaviyoAPI::Events.get_event_relationships_metric(id)
```
-#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/get_event_relationships_profile)
+#### [Get Event Relationships Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/get_event_relationships_profile)
```ruby
KlaviyoAPI::Events.get_event_relationships_profile(id)
```
-#### [Get Events](https://developers.klaviyo.com/en/v2023-10-15/reference/get_events)
+#### [Get Events](https://developers.klaviyo.com/en/v2023-12-15/reference/get_events)
```ruby
KlaviyoAPI::Events.get_events(opts)
```
@@ -1534,171 +1534,171 @@
## Flows
-#### [Get Flow](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow)
+#### [Get Flow](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow)
```ruby
KlaviyoAPI::Flows.get_flow(id, opts)
```
-#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action)
+#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action)
```ruby
KlaviyoAPI::Flows.get_flow_action(id, opts)
```
-#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_flow)
+#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_flow)
```ruby
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
```
-#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_messages)
+#### [Get Flow Action Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_messages)
```ruby
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
```
-#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_relationships_flow)
+#### [Get Flow Action Relationships Flow](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_relationships_flow)
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
```
-#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_action_relationships_messages)
+#### [Get Flow Action Relationships Messages](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_action_relationships_messages)
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
```
-#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_flow_actions)
+#### [Get Flow Flow Actions](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_flow_actions)
```ruby
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
```
-#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message)
+#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message)
```ruby
KlaviyoAPI::Flows.get_flow_message(id, opts)
```
-#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_action)
+#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_action)
```ruby
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
```
-#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_relationships_action)
+#### [Get Flow Message Relationships Action](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_relationships_action)
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
```
-#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_relationships_template)
+#### [Get Flow Message Relationships Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_relationships_template)
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
```
-#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_message_template)
+#### [Get Flow Message Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_message_template)
```ruby
KlaviyoAPI::Flows.get_flow_message_template(id, opts)
```
-#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_relationships_flow_actions)
+#### [Get Flow Relationships Flow Actions](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_relationships_flow_actions)
```ruby
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
```
-#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_relationships_tags)
+#### [Get Flow Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_relationships_tags)
```ruby
KlaviyoAPI::Flows.get_flow_relationships_tags(id)
```
-#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flow_tags)
+#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flow_tags)
```ruby
KlaviyoAPI::Flows.get_flow_tags(id, opts)
```
-#### [Get Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/get_flows)
+#### [Get Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/get_flows)
```ruby
KlaviyoAPI::Flows.get_flows(opts)
```
-#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-10-15/reference/update_flow)
+#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-12-15/reference/update_flow)
```ruby
KlaviyoAPI::Flows.update_flow(id, body)
```
@@ -1708,51 +1708,51 @@
## Images
-#### [Get Image](https://developers.klaviyo.com/en/v2023-10-15/reference/get_image)
+#### [Get Image](https://developers.klaviyo.com/en/v2023-12-15/reference/get_image)
```ruby
KlaviyoAPI::Images.get_image(id, opts)
```
-#### [Get Images](https://developers.klaviyo.com/en/v2023-10-15/reference/get_images)
+#### [Get Images](https://developers.klaviyo.com/en/v2023-12-15/reference/get_images)
```ruby
KlaviyoAPI::Images.get_images(opts)
```
-#### [Update Image](https://developers.klaviyo.com/en/v2023-10-15/reference/update_image)
+#### [Update Image](https://developers.klaviyo.com/en/v2023-12-15/reference/update_image)
```ruby
KlaviyoAPI::Images.update_image(id, body)
```
-#### [Upload Image From File](https://developers.klaviyo.com/en/v2023-10-15/reference/upload_image_from_file)
+#### [Upload Image From File](https://developers.klaviyo.com/en/v2023-12-15/reference/upload_image_from_file)
```ruby
KlaviyoAPI::Images.upload_image_from_file(file, opts)
```
-#### [Upload Image From URL](https://developers.klaviyo.com/en/v2023-10-15/reference/upload_image_from_url)
+#### [Upload Image From URL](https://developers.klaviyo.com/en/v2023-12-15/reference/upload_image_from_url)
```ruby
KlaviyoAPI::Images.upload_image_from_url(body)
```
@@ -1762,111 +1762,111 @@
## Lists
-#### [Create List](https://developers.klaviyo.com/en/v2023-10-15/reference/create_list)
+#### [Create List](https://developers.klaviyo.com/en/v2023-12-15/reference/create_list)
```ruby
KlaviyoAPI::Lists.create_list(body)
```
-#### [Add Profile To List](https://developers.klaviyo.com/en/v2023-10-15/reference/create_list_relationships)
+#### [Add Profile To List](https://developers.klaviyo.com/en/v2023-12-15/reference/create_list_relationships)
```ruby
KlaviyoAPI::Lists.create_list_relationships(id, body)
```
-#### [Delete List](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_list)
+#### [Delete List](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_list)
```ruby
KlaviyoAPI::Lists.delete_list(id)
```
-#### [Remove Profile From List](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_list_relationships)
+#### [Remove Profile From List](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_list_relationships)
```ruby
KlaviyoAPI::Lists.delete_list_relationships(id, body)
```
-#### [Get List](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list)
+#### [Get List](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list)
```ruby
KlaviyoAPI::Lists.get_list(id, opts)
```
-#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_profiles)
+#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_profiles)
```ruby
KlaviyoAPI::Lists.get_list_profiles(id, opts)
```
-#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_relationships_profiles)
+#### [Get List Relationships Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_relationships_profiles)
```ruby
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
```
-#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_relationships_tags)
+#### [Get List Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_relationships_tags)
```ruby
KlaviyoAPI::Lists.get_list_relationships_tags(id)
```
-#### [Get List Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_list_tags)
+#### [Get List Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_list_tags)
```ruby
KlaviyoAPI::Lists.get_list_tags(id, opts)
```
-#### [Get Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_lists)
+#### [Get Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_lists)
```ruby
KlaviyoAPI::Lists.get_lists(opts)
```
-#### [Update List](https://developers.klaviyo.com/en/v2023-10-15/reference/update_list)
+#### [Update List](https://developers.klaviyo.com/en/v2023-12-15/reference/update_list)
```ruby
KlaviyoAPI::Lists.update_list(id, body)
```
@@ -1876,31 +1876,31 @@
## Metrics
-#### [Get Metric](https://developers.klaviyo.com/en/v2023-10-15/reference/get_metric)
+#### [Get Metric](https://developers.klaviyo.com/en/v2023-12-15/reference/get_metric)
```ruby
KlaviyoAPI::Metrics.get_metric(id, opts)
```
-#### [Get Metrics](https://developers.klaviyo.com/en/v2023-10-15/reference/get_metrics)
+#### [Get Metrics](https://developers.klaviyo.com/en/v2023-12-15/reference/get_metrics)
```ruby
KlaviyoAPI::Metrics.get_metrics(opts)
```
-#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-10-15/reference/query_metric_aggregates)
+#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-12-15/reference/query_metric_aggregates)
```ruby
KlaviyoAPI::Metrics.query_metric_aggregates(body)
```
@@ -1910,141 +1910,221 @@
## Profiles
-#### [Create Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/create_profile)
+#### [Create Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/create_profile)
```ruby
KlaviyoAPI::Profiles.create_profile(body)
```
-#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2023-10-15/reference/create_push_token)
+#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2023-12-15/reference/create_push_token)
```ruby
KlaviyoAPI::Profiles.create_push_token(body)
```
-#### [Get Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile)
+#### [Get Bulk Profile Import Job](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job)
```ruby
+KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
+```
+
+
+
+
+
+#### [Get Bulk Profile Import Job Import Errors](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_import_errors)
+
+```ruby
+KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
+```
+
+
+
+
+
+#### [Get Bulk Profile Import Job Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_lists)
+
+```ruby
+KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
+```
+
+
+
+
+
+#### [Get Bulk Profile Import Job Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_profiles)
+
+```ruby
+KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
+```
+
+
+
+
+
+#### [Get Bulk Profile Import Job Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_relationships_lists)
+
+```ruby
+KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
+```
+
+
+
+
+
+#### [Get Bulk Profile Import Job Relationships Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_job_relationships_profiles)
+
+```ruby
+KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts)
+```
+
+
+
+
+
+#### [Get Bulk Profile Import Jobs](https://developers.klaviyo.com/en/v2023-12-15/reference/get_bulk_profile_import_jobs)
+
+```ruby
+KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
+```
+
+
+
+
+
+#### [Get Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile)
+
+```ruby
KlaviyoAPI::Profiles.get_profile(id, opts)
```
-#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_lists)
+#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_lists)
```ruby
KlaviyoAPI::Profiles.get_profile_lists(id, opts)
```
-#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_relationships_lists)
+#### [Get Profile Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_relationships_lists)
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
```
-#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_relationships_segments)
+#### [Get Profile Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_relationships_segments)
```ruby
KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
```
-#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profile_segments)
+#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profile_segments)
```ruby
KlaviyoAPI::Profiles.get_profile_segments(id, opts)
```
-#### [Get Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_profiles)
+#### [Get Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_profiles)
```ruby
KlaviyoAPI::Profiles.get_profiles(opts)
```
-#### [Merge Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/merge_profiles)
+#### [Merge Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/merge_profiles)
```ruby
KlaviyoAPI::Profiles.merge_profiles(body)
```
-#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/subscribe_profiles)
+#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2023-12-15/reference/spawn_bulk_profile_import_job)
```ruby
+KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
+```
+
+
+
+
+
+#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/subscribe_profiles)
+
+```ruby
KlaviyoAPI::Profiles.subscribe_profiles(body)
```
-#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/suppress_profiles)
+#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/suppress_profiles)
```ruby
KlaviyoAPI::Profiles.suppress_profiles(body)
```
-#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/unsubscribe_profiles)
+#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/unsubscribe_profiles)
```ruby
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
```
-#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/unsuppress_profiles)
+#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/unsuppress_profiles)
```ruby
KlaviyoAPI::Profiles.unsuppress_profiles(body)
```
-#### [Update Profile](https://developers.klaviyo.com/en/v2023-10-15/reference/update_profile)
+#### [Update Profile](https://developers.klaviyo.com/en/v2023-12-15/reference/update_profile)
```ruby
KlaviyoAPI::Profiles.update_profile(id, body)
```
@@ -2054,71 +2134,71 @@
## Segments
-#### [Get Segment](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment)
+#### [Get Segment](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment)
```ruby
KlaviyoAPI::Segments.get_segment(id, opts)
```
-#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_profiles)
+#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_profiles)
```ruby
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
```
-#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_relationships_profiles)
+#### [Get Segment Relationships Profiles](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_relationships_profiles)
```ruby
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
```
-#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_relationships_tags)
+#### [Get Segment Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_relationships_tags)
```ruby
KlaviyoAPI::Segments.get_segment_relationships_tags(id)
```
-#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segment_tags)
+#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segment_tags)
```ruby
KlaviyoAPI::Segments.get_segment_tags(id, opts)
```
-#### [Get Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_segments)
+#### [Get Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_segments)
```ruby
KlaviyoAPI::Segments.get_segments(opts)
```
-#### [Update Segment](https://developers.klaviyo.com/en/v2023-10-15/reference/update_segment)
+#### [Update Segment](https://developers.klaviyo.com/en/v2023-12-15/reference/update_segment)
```ruby
KlaviyoAPI::Segments.update_segment(id, body)
```
@@ -2128,261 +2208,261 @@
## Tags
-#### [Create Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag)
+#### [Create Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag)
```ruby
KlaviyoAPI::Tags.create_tag(body)
```
-#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_group)
+#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_group)
```ruby
KlaviyoAPI::Tags.create_tag_group(body)
```
-#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_campaigns)
+#### [Create Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
```
-#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_flows)
+#### [Create Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
```
-#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_lists)
+#### [Create Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
```
-#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/create_tag_relationships_segments)
+#### [Create Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/create_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
```
-#### [Delete Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag)
+#### [Delete Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag)
```ruby
KlaviyoAPI::Tags.delete_tag(id)
```
-#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_group)
+#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_group)
```ruby
KlaviyoAPI::Tags.delete_tag_group(id)
```
-#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_campaigns)
+#### [Delete Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
```
-#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_flows)
+#### [Delete Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
```
-#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_lists)
+#### [Delete Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
```
-#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_tag_relationships_segments)
+#### [Delete Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
```
-#### [Get Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag)
+#### [Get Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag)
```ruby
KlaviyoAPI::Tags.get_tag(id, opts)
```
-#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_group)
+#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_group(id, opts)
```
-#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_group_relationships_tags)
+#### [Get Tag Group Relationships Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_group_relationships_tags)
```ruby
KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
```
-#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_group_tags)
+#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_group_tags)
```ruby
KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
```
-#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_groups)
+#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_groups)
```ruby
KlaviyoAPI::Tags.get_tag_groups(opts)
```
-#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_campaigns)
+#### [Get Tag Relationships Campaigns](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_campaigns)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
```
-#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_flows)
+#### [Get Tag Relationships Flows](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_flows)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_flows(id)
```
-#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_lists)
+#### [Get Tag Relationships Lists](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_lists)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_lists(id)
```
-#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_segments)
+#### [Get Tag Relationships Segments](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_segments)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_segments(id)
```
-#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_relationships_tag_group)
+#### [Get Tag Relationships Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_relationships_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
```
-#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tag_tag_group)
+#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tag_tag_group)
```ruby
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
```
-#### [Get Tags](https://developers.klaviyo.com/en/v2023-10-15/reference/get_tags)
+#### [Get Tags](https://developers.klaviyo.com/en/v2023-12-15/reference/get_tags)
```ruby
KlaviyoAPI::Tags.get_tags(opts)
```
-#### [Update Tag](https://developers.klaviyo.com/en/v2023-10-15/reference/update_tag)
+#### [Update Tag](https://developers.klaviyo.com/en/v2023-12-15/reference/update_tag)
```ruby
KlaviyoAPI::Tags.update_tag(id, body)
```
-#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-10-15/reference/update_tag_group)
+#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-12-15/reference/update_tag_group)
```ruby
KlaviyoAPI::Tags.update_tag_group(id, body)
```
@@ -2392,70 +2472,70 @@
## Templates
-#### [Create Template](https://developers.klaviyo.com/en/v2023-10-15/reference/create_template)
+#### [Create Template](https://developers.klaviyo.com/en/v2023-12-15/reference/create_template)
```ruby
KlaviyoAPI::Templates.create_template(body)
```
-#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-10-15/reference/create_template_clone)
+#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-12-15/reference/create_template_clone)
```ruby
KlaviyoAPI::Templates.create_template_clone(body)
```
-#### [Create Template Render](https://developers.klaviyo.com/en/v2023-10-15/reference/create_template_render)
+#### [Create Template Render](https://developers.klaviyo.com/en/v2023-12-15/reference/create_template_render)
```ruby
KlaviyoAPI::Templates.create_template_render(body)
```
-#### [Delete Template](https://developers.klaviyo.com/en/v2023-10-15/reference/delete_template)
+#### [Delete Template](https://developers.klaviyo.com/en/v2023-12-15/reference/delete_template)
```ruby
KlaviyoAPI::Templates.delete_template(id)
```
-#### [Get Template](https://developers.klaviyo.com/en/v2023-10-15/reference/get_template)
+#### [Get Template](https://developers.klaviyo.com/en/v2023-12-15/reference/get_template)
```ruby
KlaviyoAPI::Templates.get_template(id, opts)
```
-#### [Get Templates](https://developers.klaviyo.com/en/v2023-10-15/reference/get_templates)
+#### [Get Templates](https://developers.klaviyo.com/en/v2023-12-15/reference/get_templates)
```ruby
KlaviyoAPI::Templates.get_templates(opts)
```
-#### [Update Template](https://developers.klaviyo.com/en/v2023-10-15/reference/update_template)
+#### [Update Template](https://developers.klaviyo.com/en/v2023-12-15/reference/update_template)
```ruby
KlaviyoAPI::Templates.update_template(id, body)
```