README.md in klaviyo-api-sdk-1.0.1 vs README.md in klaviyo-api-sdk-1.1.0
- old
+ new
@@ -1,14 +1,14 @@
# Klaviyo Ruby SDK
-- SDK version: 1.0.1
-- API revision: 2022-10-17
+- SDK version: 1.1.0
+- API revision: 2023-01-24
## Helpful Resources
-- [API Reference](https://developers.klaviyo.com/en/v2022-10-17/reference)
-- [API Guides](https://developers.klaviyo.com/en/v2022-10-17/docs)
+- [API Reference](https://developers.klaviyo.com/en/v2023-01-24/reference)
+- [API Guides](https://developers.klaviyo.com/en/v2023-01-24/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.
@@ -25,10 +25,14 @@
- Client
+- Data Privacy
+
+
+
- Events
- Flows
@@ -49,10 +53,14 @@
- Segments
+- Tags
+
+
+
- Templates
@@ -68,17 +76,17 @@
```
Then install the gem locally:
```shell
-gem install ./klaviyo-api-sdk-1.0.1.gem
+gem install ./klaviyo-api-sdk-1.1.0.gem
```
Finally add this to the Gemfile:
- gem 'klaviyo-api-sdk', '~> 1.0.1'
+ gem 'klaviyo-api-sdk', '~> 1.1.0'
To install directly from rubygems:
```shell
gem install klaviyo-api-sdk
@@ -132,11 +140,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/v2022-10-17/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-01-24/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.
## Method signatures
- `get` operations can be passed an optional `opts` object (e.g. `get_list_profiles(opts)`).
@@ -177,531 +185,531 @@
## Catalogs
-#### [Create Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_category)
+#### [Create Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_category)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category(body)
```
-#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_category_relationships)
+#### [Create Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_category_relationships)
```ruby
KlaviyoAPI::Catalogs.create_catalog_category_relationships(id, related_resource, body)
```
-#### [Create Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_item)
+#### [Create Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_item)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item(body)
```
-#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_item_relationships)
+#### [Create Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_item_relationships)
```ruby
KlaviyoAPI::Catalogs.create_catalog_item_relationships(id, related_resource, body)
```
-#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/create_catalog_variant)
+#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/create_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.create_catalog_variant(body)
```
-#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_category)
+#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_category)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category(id)
```
-#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_category_relationships)
+#### [Delete Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_category_relationships)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_category_relationships(id, related_resource, body)
```
-#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_item)
+#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_item)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item(id)
```
-#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_item_relationships)
+#### [Delete Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_item_relationships)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_item_relationships(id, related_resource, body)
```
-#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_catalog_variant)
+#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
```
-#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_categories)
+#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
```
-#### [Get Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_category)
+#### [Get Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_category)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
```
-#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_category_items)
+#### [Get Catalog Category Items](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_category_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_items(category_id, opts)
```
-#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_category_relationships)
+#### [Get Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_category_relationships)
```ruby
KlaviyoAPI::Catalogs.get_catalog_category_relationships(id, related_resource, opts)
```
-#### [Get Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item)
+#### [Get Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
```
-#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item_categories)
+#### [Get Catalog Item Categories](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item_categories)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_categories(item_id, opts)
```
-#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item_relationships)
+#### [Get Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item_relationships)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_relationships(id, related_resource, opts)
```
-#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_item_variants)
+#### [Get Catalog Item Variants](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_item_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_item_variants(item_id, opts)
```
-#### [Get Catalog Items](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_items)
+#### [Get Catalog Items](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_items)
```ruby
KlaviyoAPI::Catalogs.get_catalog_items(opts)
```
-#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_variant)
+#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
```
-#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2022-10-17/reference/get_catalog_variants)
+#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2023-01-24/reference/get_catalog_variants)
```ruby
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
```
-#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_categories_job)
+#### [Get Create Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
```
-#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_categories_jobs)
+#### [Get Create Categories Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
```
-#### [Get Create Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_items_job)
+#### [Get Create Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_items_job)
```ruby
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
```
-#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_items_jobs)
+#### [Get Create Items Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
```
-#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_variants_job)
+#### [Get Create Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
```
-#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_create_variants_jobs)
+#### [Get Create Variants Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_create_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
```
-#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_categories_job)
+#### [Get Delete Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
```
-#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_categories_jobs)
+#### [Get Delete Categories Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
```
-#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_items_job)
+#### [Get Delete Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
```
-#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_items_jobs)
+#### [Get Delete Items Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
```
-#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_variants_job)
+#### [Get Delete Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
```
-#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_delete_variants_jobs)
+#### [Get Delete Variants Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_delete_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
```
-#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_categories_job)
+#### [Get Update Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
```
-#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_categories_jobs)
+#### [Get Update Categories Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_categories_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
```
-#### [Get Update Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_items_job)
+#### [Get Update Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_items_job)
```ruby
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
```
-#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_items_jobs)
+#### [Get Update Items Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_items_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
```
-#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_variants_job)
+#### [Get Update Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
```
-#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2022-10-17/reference/get_update_variants_jobs)
+#### [Get Update Variants Jobs](https://developers.klaviyo.com/en/v2023-01-24/reference/get_update_variants_jobs)
```ruby
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
```
-#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_create_categories_job)
+#### [Spawn Create Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_create_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
```
-#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_create_items_job)
+#### [Spawn Create Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_create_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
```
-#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_create_variants_job)
+#### [Spawn Create Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_create_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
```
-#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_delete_categories_job)
+#### [Spawn Delete Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_delete_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
```
-#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_delete_items_job)
+#### [Spawn Delete Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_delete_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
```
-#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_delete_variants_job)
+#### [Spawn Delete Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_delete_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
```
-#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_update_categories_job)
+#### [Spawn Update Categories Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_update_categories_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
```
-#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_update_items_job)
+#### [Spawn Update Items Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_update_items_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
```
-#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2022-10-17/reference/spawn_update_variants_job)
+#### [Spawn Update Variants Job](https://developers.klaviyo.com/en/v2023-01-24/reference/spawn_update_variants_job)
```ruby
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
```
-#### [Update Catalog Category](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_category)
+#### [Update Catalog Category](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_category)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
```
-#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_category_relationships)
+#### [Update Catalog Category Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_category_relationships)
```ruby
KlaviyoAPI::Catalogs.update_catalog_category_relationships(id, related_resource, body)
```
-#### [Update Catalog Item](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_item)
+#### [Update Catalog Item](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_item)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
```
-#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_item_relationships)
+#### [Update Catalog Item Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_item_relationships)
```ruby
KlaviyoAPI::Catalogs.update_catalog_item_relationships(id, related_resource, body)
```
-#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2022-10-17/reference/update_catalog_variant)
+#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2023-01-24/reference/update_catalog_variant)
```ruby
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
```
@@ -711,95 +719,109 @@
## Client
-#### [Create Client Event](https://developers.klaviyo.com/en/v2022-10-17/reference/create_client_event)
+#### [Create Client Event](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_event)
```ruby
KlaviyoAPI::Client.create_client_event(company_id, body)
```
-#### [Create Client Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/create_client_profile)
+#### [Create or Update Client Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_profile)
```ruby
KlaviyoAPI::Client.create_client_profile(company_id, body)
```
-#### [Create Client Subscription](https://developers.klaviyo.com/en/v2022-10-17/reference/create_client_subscription)
+#### [Create Client Subscription](https://developers.klaviyo.com/en/v2023-01-24/reference/create_client_subscription)
```ruby
KlaviyoAPI::Client.create_client_subscription(company_id, body)
```
+## Data Privacy
+
+
+#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2023-01-24/reference/request_profile_deletion)
+
+```ruby
+KlaviyoAPI::Data Privacy.request_profile_deletion(body)
+```
+
+
+
+
+
+
## Events
-#### [Create Event](https://developers.klaviyo.com/en/v2022-10-17/reference/create_event)
+#### [Create Event](https://developers.klaviyo.com/en/v2023-01-24/reference/create_event)
```ruby
KlaviyoAPI::Events.create_event(body)
```
-#### [Get Event](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event)
+#### [Get Event](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event)
```ruby
KlaviyoAPI::Events.get_event(id, opts)
```
-#### [Get Event Metrics](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event_metrics)
+#### [Get Event Metrics](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event_metrics)
```ruby
KlaviyoAPI::Events.get_event_metrics(id, opts)
```
-#### [Get Event Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event_profiles)
+#### [Get Event Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event_profiles)
```ruby
KlaviyoAPI::Events.get_event_profiles(id, opts)
```
-#### [Get Event Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_event_relationships)
+#### [Get Event Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_event_relationships)
```ruby
KlaviyoAPI::Events.get_event_relationships(id, related_resource)
```
-#### [Get Events](https://developers.klaviyo.com/en/v2022-10-17/reference/get_events)
+#### [Get Events](https://developers.klaviyo.com/en/v2023-01-24/reference/get_events)
```ruby
KlaviyoAPI::Events.get_events(opts)
```
@@ -809,121 +831,131 @@
## Flows
-#### [Get Flow](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow)
+#### [Get Flow](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow)
```ruby
KlaviyoAPI::Flows.get_flow(id, opts)
```
-#### [Get Flow Action](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action)
+#### [Get Flow Action](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action)
```ruby
KlaviyoAPI::Flows.get_flow_action(id, opts)
```
-#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action_flow)
+#### [Get Flow For Flow Action](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action_flow)
```ruby
KlaviyoAPI::Flows.get_flow_action_flow(action_id, opts)
```
-#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action_messages)
+#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action_messages)
```ruby
KlaviyoAPI::Flows.get_flow_action_messages(action_id, opts)
```
-#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_action_relationships)
+#### [Get Flow Action Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_action_relationships)
```ruby
KlaviyoAPI::Flows.get_flow_action_relationships(id, related_resource, opts)
```
-#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_flow_actions)
+#### [Get Flow Actions For Flow](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_flow_actions)
```ruby
KlaviyoAPI::Flows.get_flow_flow_actions(flow_id, opts)
```
-#### [Get Flow Message](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_message)
+#### [Get Flow Message](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_message)
```ruby
KlaviyoAPI::Flows.get_flow_message(id, opts)
```
-#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_message_action)
+#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_message_action)
```ruby
KlaviyoAPI::Flows.get_flow_message_action(message_id, opts)
```
-#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_message_relationships)
+#### [Get Flow Message Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_message_relationships)
```ruby
KlaviyoAPI::Flows.get_flow_message_relationships(id, related_resource)
```
-#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flow_relationships)
+#### [Get Flow Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_relationships)
```ruby
-KlaviyoAPI::Flows.get_flow_relationships(id, related_resource, opts)
+KlaviyoAPI::Flows.get_flow_relationships(id, related_resource)
```
-#### [Get Flows](https://developers.klaviyo.com/en/v2022-10-17/reference/get_flows)
+#### [Get Flow Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flow_tags)
```ruby
+KlaviyoAPI::Flows.get_flow_tags(flow_id, opts)
+```
+
+
+
+
+
+#### [Get Flows](https://developers.klaviyo.com/en/v2023-01-24/reference/get_flows)
+
+```ruby
KlaviyoAPI::Flows.get_flows(opts)
```
-#### [Update Flow Status](https://developers.klaviyo.com/en/v2022-10-17/reference/update_flow)
+#### [Update Flow Status](https://developers.klaviyo.com/en/v2023-01-24/reference/update_flow)
```ruby
KlaviyoAPI::Flows.update_flow(id, body)
```
@@ -933,91 +965,101 @@
## Lists
-#### [Create List](https://developers.klaviyo.com/en/v2022-10-17/reference/create_list)
+#### [Create List](https://developers.klaviyo.com/en/v2023-01-24/reference/create_list)
```ruby
KlaviyoAPI::Lists.create_list(body)
```
-#### [Add Profile to List](https://developers.klaviyo.com/en/v2022-10-17/reference/create_list_relationships)
+#### [Add Profile to List](https://developers.klaviyo.com/en/v2023-01-24/reference/create_list_relationships)
```ruby
KlaviyoAPI::Lists.create_list_relationships(id, related_resource, body)
```
-#### [Delete List](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_list)
+#### [Delete List](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_list)
```ruby
KlaviyoAPI::Lists.delete_list(id)
```
-#### [Remove Profile from List](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_list_relationships)
+#### [Remove Profile from List](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_list_relationships)
```ruby
KlaviyoAPI::Lists.delete_list_relationships(id, related_resource, body)
```
-#### [Get List](https://developers.klaviyo.com/en/v2022-10-17/reference/get_list)
+#### [Get List](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list)
```ruby
KlaviyoAPI::Lists.get_list(id, opts)
```
-#### [Get List Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_list_profiles)
+#### [Get List Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list_profiles)
```ruby
KlaviyoAPI::Lists.get_list_profiles(list_id, opts)
```
-#### [Get List Profile Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_list_relationships)
+#### [Get List Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list_relationships)
```ruby
KlaviyoAPI::Lists.get_list_relationships(id, related_resource, opts)
```
-#### [Get Lists](https://developers.klaviyo.com/en/v2022-10-17/reference/get_lists)
+#### [Get List Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_list_tags)
```ruby
+KlaviyoAPI::Lists.get_list_tags(list_id, opts)
+```
+
+
+
+
+
+#### [Get Lists](https://developers.klaviyo.com/en/v2023-01-24/reference/get_lists)
+
+```ruby
KlaviyoAPI::Lists.get_lists(opts)
```
-#### [Update List](https://developers.klaviyo.com/en/v2022-10-17/reference/update_list)
+#### [Update List](https://developers.klaviyo.com/en/v2023-01-24/reference/update_list)
```ruby
KlaviyoAPI::Lists.update_list(id, body)
```
@@ -1027,31 +1069,31 @@
## Metrics
-#### [Get Metric](https://developers.klaviyo.com/en/v2022-10-17/reference/get_metric)
+#### [Get Metric](https://developers.klaviyo.com/en/v2023-01-24/reference/get_metric)
```ruby
KlaviyoAPI::Metrics.get_metric(id, opts)
```
-#### [Get Metrics](https://developers.klaviyo.com/en/v2022-10-17/reference/get_metrics)
+#### [Get Metrics](https://developers.klaviyo.com/en/v2023-01-24/reference/get_metrics)
```ruby
KlaviyoAPI::Metrics.get_metrics(opts)
```
-#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2022-10-17/reference/query_metric_aggregates)
+#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2023-01-24/reference/query_metric_aggregates)
```ruby
KlaviyoAPI::Metrics.query_metric_aggregates(body)
```
@@ -1061,111 +1103,111 @@
## Profiles
-#### [Create Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/create_profile)
+#### [Create Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/create_profile)
```ruby
KlaviyoAPI::Profiles.create_profile(body)
```
-#### [Get Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile)
+#### [Get Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile)
```ruby
KlaviyoAPI::Profiles.get_profile(id, opts)
```
-#### [Get Profile Lists](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile_lists)
+#### [Get Profile Lists](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile_lists)
```ruby
KlaviyoAPI::Profiles.get_profile_lists(profile_id, opts)
```
-#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile_relationships)
+#### [Get Profile Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile_relationships)
```ruby
KlaviyoAPI::Profiles.get_profile_relationships(id, related_resource)
```
-#### [Get Profile Segments](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profile_segments)
+#### [Get Profile Segments](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profile_segments)
```ruby
KlaviyoAPI::Profiles.get_profile_segments(profile_id, opts)
```
-#### [Get Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_profiles)
+#### [Get Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_profiles)
```ruby
KlaviyoAPI::Profiles.get_profiles(opts)
```
-#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/subscribe_profiles)
+#### [Subscribe Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/subscribe_profiles)
```ruby
KlaviyoAPI::Profiles.subscribe_profiles(body)
```
-#### [Suppress Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/suppress_profiles)
+#### [Suppress Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/suppress_profiles)
```ruby
KlaviyoAPI::Profiles.suppress_profiles(body)
```
-#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/unsubscribe_profiles)
+#### [Unsubscribe Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/unsubscribe_profiles)
```ruby
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
```
-#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/unsuppress_profiles)
+#### [Unsuppress Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/unsuppress_profiles)
```ruby
KlaviyoAPI::Profiles.unsuppress_profiles(body)
```
-#### [Update Profile](https://developers.klaviyo.com/en/v2022-10-17/reference/update_profile)
+#### [Update Profile](https://developers.klaviyo.com/en/v2023-01-24/reference/update_profile)
```ruby
KlaviyoAPI::Profiles.update_profile(id, body)
```
@@ -1175,124 +1217,298 @@
## Segments
-#### [Get Segment](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segment)
+#### [Get Segment](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment)
```ruby
KlaviyoAPI::Segments.get_segment(id, opts)
```
-#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segment_profiles)
+#### [Get Segment Profiles](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment_profiles)
```ruby
KlaviyoAPI::Segments.get_segment_profiles(segment_id, opts)
```
-#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segment_relationships)
+#### [Get Segment Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment_relationships)
```ruby
KlaviyoAPI::Segments.get_segment_relationships(id, related_resource, opts)
```
-#### [Get Segments](https://developers.klaviyo.com/en/v2022-10-17/reference/get_segments)
+#### [Get Segment Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segment_tags)
```ruby
+KlaviyoAPI::Segments.get_segment_tags(segment_id, opts)
+```
+
+
+
+
+
+#### [Get Segments](https://developers.klaviyo.com/en/v2023-01-24/reference/get_segments)
+
+```ruby
KlaviyoAPI::Segments.get_segments(opts)
```
-#### [Update Segment](https://developers.klaviyo.com/en/v2022-10-17/reference/update_segment)
+#### [Update Segment](https://developers.klaviyo.com/en/v2023-01-24/reference/update_segment)
```ruby
KlaviyoAPI::Segments.update_segment(id, body)
```
+## Tags
+
+
+#### [Create Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/create_tag)
+
+```ruby
+KlaviyoAPI::Tags.create_tag(body)
+```
+
+
+
+
+
+#### [Create Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/create_tag_group)
+
+```ruby
+KlaviyoAPI::Tags.create_tag_group(body)
+```
+
+
+
+
+
+#### [Create Tag Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/create_tag_relationships)
+
+```ruby
+KlaviyoAPI::Tags.create_tag_relationships(id, related_resource, body)
+```
+
+
+
+
+
+#### [Delete Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_tag)
+
+```ruby
+KlaviyoAPI::Tags.delete_tag(id)
+```
+
+
+
+
+
+#### [Delete Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_tag_group)
+
+```ruby
+KlaviyoAPI::Tags.delete_tag_group(id)
+```
+
+
+
+
+
+#### [Delete Tag Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_tag_relationships)
+
+```ruby
+KlaviyoAPI::Tags.delete_tag_relationships(id, related_resource, body)
+```
+
+
+
+
+
+#### [Get Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag)
+
+```ruby
+KlaviyoAPI::Tags.get_tag(id, opts)
+```
+
+
+
+
+
+#### [Get Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_group)
+
+```ruby
+KlaviyoAPI::Tags.get_tag_group(id, opts)
+```
+
+
+
+
+
+#### [Get Tag Group Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_group_relationships)
+
+```ruby
+KlaviyoAPI::Tags.get_tag_group_relationships(id, related_resource)
+```
+
+
+
+
+
+#### [Get Tag Group Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_group_tags)
+
+```ruby
+KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
+```
+
+
+
+
+
+#### [Get Tag Groups](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_groups)
+
+```ruby
+KlaviyoAPI::Tags.get_tag_groups(opts)
+```
+
+
+
+
+
+#### [Get Tag Relationships](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_relationships)
+
+```ruby
+KlaviyoAPI::Tags.get_tag_relationships(id, related_resource)
+```
+
+
+
+
+
+#### [Get Tag Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tag_tag_group)
+
+```ruby
+KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
+```
+
+
+
+
+
+#### [Get Tags](https://developers.klaviyo.com/en/v2023-01-24/reference/get_tags)
+
+```ruby
+KlaviyoAPI::Tags.get_tags(opts)
+```
+
+
+
+
+
+#### [Update Tag](https://developers.klaviyo.com/en/v2023-01-24/reference/update_tag)
+
+```ruby
+KlaviyoAPI::Tags.update_tag(id, body)
+```
+
+
+
+
+
+#### [Update Tag Group](https://developers.klaviyo.com/en/v2023-01-24/reference/update_tag_group)
+
+```ruby
+KlaviyoAPI::Tags.update_tag_group(id, body)
+```
+
+
+
+
+
+
## Templates
-#### [Create Template](https://developers.klaviyo.com/en/v2022-10-17/reference/create_template)
+#### [Create Template](https://developers.klaviyo.com/en/v2023-01-24/reference/create_template)
```ruby
KlaviyoAPI::Templates.create_template(body)
```
-#### [Create Template Clone](https://developers.klaviyo.com/en/v2022-10-17/reference/create_template_clone)
+#### [Create Template Clone](https://developers.klaviyo.com/en/v2023-01-24/reference/create_template_clone)
```ruby
-KlaviyoAPI::Templates.create_template_clone(id, body)
+KlaviyoAPI::Templates.create_template_clone(body)
```
-#### [Create Template Render](https://developers.klaviyo.com/en/v2022-10-17/reference/create_template_render)
+#### [Create Template Render](https://developers.klaviyo.com/en/v2023-01-24/reference/create_template_render)
```ruby
-KlaviyoAPI::Templates.create_template_render(id, body)
+KlaviyoAPI::Templates.create_template_render(body)
```
-#### [Delete Template](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_template)
+#### [Delete Template](https://developers.klaviyo.com/en/v2023-01-24/reference/delete_template)
```ruby
KlaviyoAPI::Templates.delete_template(id)
```
-#### [Get Template](https://developers.klaviyo.com/en/v2022-10-17/reference/get_template)
+#### [Get Template](https://developers.klaviyo.com/en/v2023-01-24/reference/get_template)
```ruby
KlaviyoAPI::Templates.get_template(id, opts)
```
-#### [Get Templates](https://developers.klaviyo.com/en/v2022-10-17/reference/get_templates)
+#### [Get Templates](https://developers.klaviyo.com/en/v2023-01-24/reference/get_templates)
```ruby
KlaviyoAPI::Templates.get_templates(opts)
```
-#### [Update Template](https://developers.klaviyo.com/en/v2022-10-17/reference/update_template)
+#### [Update Template](https://developers.klaviyo.com/en/v2023-01-24/reference/update_template)
```ruby
KlaviyoAPI::Templates.update_template(id, body)
```