klaviyo-api-sdk 1.1.0 → 2.0.0

data/docs/ClientApi.md

@@ -25,7 +25,7 @@ require 'klaviyo-api-sdk'
 
 api_instance = KlaviyoAPI::ClientApi.new
 company_id = 'YOUR_COMPANY_ID' # String | ID of the Company to create event
-event_create_query = KlaviyoAPI::EventCreateQuery.new({data: KlaviyoAPI::EventCreateQueryAsSubResource.new({type: 'event', attributes: KlaviyoAPI::EventCreateQueryAsSubResourceAttributes.new({profile: {"$email":"matt.kemp@klaviyo-demo.com"}, metric: KlaviyoAPI::MetricCreateQuery.new({name: 'Viewed Product'}), properties: {"Brand":"Kids Book","Categories":["Fiction","Children"],"ProductID":1111,"ProductName":"Winnie the Pooh","$extra":{"URL":"http://www.example.com/path/to/product","ImageURL":"http://www.example.com/path/to/product/image.png"}}})})}) # EventCreateQuery | Event to create.
+event_create_query = KlaviyoAPI::EventCreateQuery.new({data: KlaviyoAPI::EventCreateQueryResourceObject.new({type: KlaviyoAPI::EventEnum::EVENT, attributes: KlaviyoAPI::EventCreateQueryResourceObjectAttributes.new({profile: {"$email":"matt.kemp@klaviyo-demo.com"}, metric: KlaviyoAPI::MetricCreateQuery.new({name: 'Viewed Product'}), properties: {"Brand":"Kids Book","Categories":["Fiction","Children"],"ProductID":1111,"ProductName":"Winnie the Pooh","$extra":{"URL":"http://www.example.com/path/to/product","ImageURL":"http://www.example.com/path/to/product/image.png"}}})})}) # EventCreateQuery | Event to create.
 
 begin
   # Create Client Event
@@ -90,7 +90,7 @@ require 'klaviyo-api-sdk'
 
 api_instance = KlaviyoAPI::ClientApi.new
 company_id = 'company_id_example' # String | 
-onsite_profile_create_query = KlaviyoAPI::OnsiteProfileCreateQuery.new({data: KlaviyoAPI::OnsiteProfileCreateQueryAsSubResource.new({type: 'profile', attributes: KlaviyoAPI::ProfileCreateQueryAsSubResourceAttributes.new})}) # OnsiteProfileCreateQuery | 
+onsite_profile_create_query = KlaviyoAPI::OnsiteProfileCreateQuery.new({data: KlaviyoAPI::OnsiteProfileCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes.new})}) # OnsiteProfileCreateQuery | 
 
 begin
   # Create or Update Client Profile
@@ -155,7 +155,7 @@ require 'klaviyo-api-sdk'
 
 api_instance = KlaviyoAPI::ClientApi.new
 company_id = 'COMPANY_ID' # String | Your company ID.
-onsite_subscription_create_query = KlaviyoAPI::OnsiteSubscriptionCreateQuery.new({data: KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResource.new({type: 'subscription', attributes: KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResourceAttributes.new({list_id: 'Y6nRLr'})})}) # OnsiteSubscriptionCreateQuery | Creates a subscription and consent records for Email and or SMS channels based on the provided email and phone_number attributes respectively. One of either email or phone_number must be provided. To create a subscription and consent record for only one channel but still include the other channel as a profile property the consent channel can be provided as a top level attribute and the other channel can be included in the properties object.
+onsite_subscription_create_query = KlaviyoAPI::OnsiteSubscriptionCreateQuery.new({data: KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObject.new({type: KlaviyoAPI::SubscriptionEnum::SUBSCRIPTION, attributes: KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObjectAttributes.new({list_id: 'Y6nRLr'})})}) # OnsiteSubscriptionCreateQuery | Creates a subscription and consent records for Email and or SMS channels based on the provided email and phone_number attributes respectively. One of either email or phone_number must be provided. To create a subscription and consent record for only one channel but still include the other channel as a profile property the consent channel can be provided as a top level attribute and the other channel can be included in the properties object.
 
 begin
   # Create Client Subscription

data/docs/CollectionLinks.md

@@ -0,0 +1,26 @@
+# KlaviyoAPI::CollectionLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_self** | **String** |  |  |
+| **first** | **String** |  | [optional] |
+| **last** | **String** |  | [optional] |
+| **prev** | **String** |  | [optional] |
+| **_next** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CollectionLinks.new(
+  _self: null,
+  first: null,
+  last: null,
+  prev: null,
+  _next: null
+)
+```
+

data/docs/DataPrivacyApi.md

@@ -29,7 +29,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::DataPrivacyApi.new
-data_privacy_create_deletion_job_query = KlaviyoAPI::DataPrivacyCreateDeletionJobQuery.new({data: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryAsSubResource.new({type: 'data-privacy-deletion-job', attributes: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.new})}) # DataPrivacyCreateDeletionJobQuery | 
+data_privacy_create_deletion_job_query = KlaviyoAPI::DataPrivacyCreateDeletionJobQuery.new({data: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObject.new({type: KlaviyoAPI::DataPrivacyDeletionJobEnum::DATA_PRIVACY_DELETION_JOB, attributes: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.new})}) # DataPrivacyCreateDeletionJobQuery | 
 
 begin
   # Request Profile Deletion

data/docs/DataPrivacyCreateDeletionJobQuery.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**DataPrivacyCreateDeletionJobQueryAsSubResource**](DataPrivacyCreateDeletionJobQueryAsSubResource.md) |  |  |
+| **data** | [**DataPrivacyCreateDeletionJobQueryResourceObject**](DataPrivacyCreateDeletionJobQueryResourceObject.md) |  |  |
 
 ## Example
 

data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**DataPrivacyDeletionJobEnum**](DataPrivacyDeletionJobEnum.md) |  |  |
+| **attributes** | [**DataPrivacyCreateDeletionJobQueryResourceObjectAttributes**](DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObject.new(
+  type: null,
+  attributes: null
+)
+```
+

data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** | The ID of the profile to delete. This is the `id` field on the profile object. | [optional] |
+| **email** | **String** | The email address of the profile to delete. | [optional] |
+| **phone_number** | **String** | The phone number of the profile to delete. | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.new(
+  profile_id: 01F2VWQ645BES947MP1BPAKVMB,
+  email: matt.kemp@klaviyo-demo.com,
+  phone_number: +15005550006
+)
+```
+

data/docs/DataPrivacyDeletionJobEnum.md

@@ -0,0 +1,15 @@
+# KlaviyoAPI::DataPrivacyDeletionJobEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::DataPrivacyDeletionJobEnum.new()
+```
+

data/docs/EmailChannel.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::EmailChannel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **marketing** | [**EmailMarketing**](EmailMarketing.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EmailChannel.new(
+  marketing: null
+)
+```
+

data/docs/EmailMarketing.md

@@ -0,0 +1,32 @@
+# KlaviyoAPI::EmailMarketing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consent** | **String** | The consent status for email marketing. |  |
+| **timestamp** | **Time** | The timestamp when consent record or updated for email marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
+| **method** | **String** | The method by which the profile was subscribed to email marketing. |  |
+| **method_detail** | **String** | Additional details about the method by which the profile was subscribed to SMS marketing. This may be empty if no details were provided. | [optional] |
+| **custom_method_detail** | **String** | Additional detail provided by the caller when the profile was subscribed. This may be empty if no details were provided. | [optional] |
+| **double_optin** | **Boolean** | Whether the profile was subscribed to email marketing using a double opt-in. | [optional] |
+| **suppressions** | [**EmailMarketingSuppression**](EmailMarketingSuppression.md) |  | [optional] |
+| **list_suppressions** | [**EmailMarketingListSuppression**](EmailMarketingListSuppression.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EmailMarketing.new(
+  consent: SUBSCRIBED,
+  timestamp: 2023-02-21T20:07:38Z,
+  method: PREFERENCE_PAGE,
+  method_detail: mydomain.com/signup,
+  custom_method_detail: marketing drive,
+  double_optin: true,
+  suppressions: null,
+  list_suppressions: null
+)
+```
+

data/docs/EmailMarketingListSuppression.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::EmailMarketingListSuppression
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **list_id** | **String** | The ID of list to which the suppression applies. |  |
+| **reason** | **String** | The reason the profile was suppressed from the list. |  |
+| **timestamp** | **Time** | The timestamp when the profile was suppressed from the list, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EmailMarketingListSuppression.new(
+  list_id: Y6nRLr,
+  reason: USER_SUPPRESSED,
+  timestamp: 2023-02-21T20:07:38Z
+)
+```
+

data/docs/EmailMarketingSuppression.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::EmailMarketingSuppression
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** | The reason the profile was suppressed from the list. |  |
+| **timestamp** | **Time** | The timestamp when the profile was suppressed from the list, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EmailMarketingSuppression.new(
+  reason: HARD_BOUNCE,
+  timestamp: 2023-02-21T20:07:38Z
+)
+```
+

data/docs/ErrorSource.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **pointer** | **String** |  | [default to '/data'] |
+| **pointer** | **String** | A pointer to the source of the error in the request payload. | [default to '/data'] |
 
 ## Example
 

data/docs/EventCreateQuery.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**EventCreateQueryAsSubResource**](EventCreateQueryAsSubResource.md) |  |  |
+| **data** | [**EventCreateQueryResourceObject**](EventCreateQueryResourceObject.md) |  |  |
 
 ## Example
 

data/docs/EventCreateQueryResourceObject.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::EventCreateQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**EventEnum**](EventEnum.md) |  |  |
+| **attributes** | [**EventCreateQueryResourceObjectAttributes**](EventCreateQueryResourceObjectAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventCreateQueryResourceObject.new(
+  type: null,
+  attributes: null
+)
+```
+

data/docs/EventCreateQueryResourceObjectAttributes.md

@@ -0,0 +1,28 @@
+# KlaviyoAPI::EventCreateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile** | **Object** |  Properties of the profile that triggered this event. The profile must contain an identifier. The $email and/or $phone_number can be used as the identify the profile. Other key value pairs can be used to create segments. For example, to create a list of people on trial plans, include a profile's plan type in the profile. The profile supports special fields. The fields include: $email (string), $first_name (string), $last_name (string), $phone_number (string), $city (string), $region (string; state or other region), $country (string), $zip (string), $image (string; url to a photo of a person), and $consent (list of strings; eg: ['sms', 'email', 'web', 'directmail', 'mobile']).  |  |
+| **metric** | [**MetricCreateQuery**](MetricCreateQuery.md) |  |  |
+| **properties** | **Object** |   Properties of this event. Any top level property (that are not objects) can be used to create segments. The $extra property is a special property. This records any non-segmentable values that can be references later. For example, HTML templates are useful on a segment, but itself is not used in creating a segment. There are limits placed onto the size of the data present. This must not exceed 5 MB. This must not exceed 300 event properties. A single string cannot be larger than 100 KB. Each array must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.  |  |
+| **time** | **Time** |  When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.  | [optional] |
+| **value** | **Float** | A numeric value to associate with this event. For example, the dollar amount of a purchase. | [optional] |
+| **unique_id** | **String** |  A unique identifier for an event. If the unique_id is repeated for the same profile and metric, only the first processed event will be recorded. If this is not present, this will use the time to the second. Using the default, this limits only one event per profile per second.  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventCreateQueryResourceObjectAttributes.new(
+  profile: {"$email":"matt.kemp@klaviyo-demo.com"},
+  metric: null,
+  properties: {"Brand":"Kids Book","Categories":["Fiction","Children"],"ProductID":1111,"ProductName":"Winnie the Pooh","$extra":{"URL":"http://www.example.com/path/to/product","ImageURL":"http://www.example.com/path/to/product/image.png"}},
+  time: null,
+  value: 9.99,
+  unique_id: null
+)
+```
+

data/docs/EventEnum.md

@@ -0,0 +1,15 @@
+# KlaviyoAPI::EventEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventEnum.new()
+```
+

data/docs/EventsApi.md

@@ -8,7 +8,8 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**get_event**](EventsApi.md#get_event) | **GET** /api/events/{id}/ | Get Event |
 | [**get_event_metrics**](EventsApi.md#get_event_metrics) | **GET** /api/events/{id}/metrics/ | Get Event Metrics |
 | [**get_event_profiles**](EventsApi.md#get_event_profiles) | **GET** /api/events/{id}/profiles/ | Get Event Profiles |
-| [**get_event_relationships**](EventsApi.md#get_event_relationships) | **GET** /api/events/{id}/relationships/{related_resource}/ | Get Event Relationships |
+| [**get_event_relationships_metrics**](EventsApi.md#get_event_relationships_metrics) | **GET** /api/events/{id}/relationships/metrics/ | Get Event Relationships Metrics |
+| [**get_event_relationships_profiles**](EventsApi.md#get_event_relationships_profiles) | **GET** /api/events/{id}/relationships/profiles/ | Get Event Relationships Profiles |
 | [**get_events**](EventsApi.md#get_events) | **GET** /api/events/ | Get Events |
 
 
@@ -34,7 +35,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::EventsApi.new
-event_create_query = KlaviyoAPI::EventCreateQuery.new({data: KlaviyoAPI::EventCreateQueryAsSubResource.new({type: 'event', attributes: KlaviyoAPI::EventCreateQueryAsSubResourceAttributes.new({profile: {"$email":"matt.kemp@klaviyo-demo.com"}, metric: KlaviyoAPI::MetricCreateQuery.new({name: 'Viewed Product'}), properties: {"Brand":"Kids Book","Categories":["Fiction","Children"],"ProductID":1111,"ProductName":"Winnie the Pooh","$extra":{"URL":"http://www.example.com/path/to/product","ImageURL":"http://www.example.com/path/to/product/image.png"}}})})}) # EventCreateQuery | Event to create.
+event_create_query = KlaviyoAPI::EventCreateQuery.new({data: KlaviyoAPI::EventCreateQueryResourceObject.new({type: KlaviyoAPI::EventEnum::EVENT, attributes: KlaviyoAPI::EventCreateQueryResourceObjectAttributes.new({profile: {"$email":"matt.kemp@klaviyo-demo.com"}, metric: KlaviyoAPI::MetricCreateQuery.new({name: 'Viewed Product'}), properties: {"Brand":"Kids Book","Categories":["Fiction","Children"],"ProductID":1111,"ProductName":"Winnie the Pooh","$extra":{"URL":"http://www.example.com/path/to/product","ImageURL":"http://www.example.com/path/to/product/image.png"}}})})}) # EventCreateQuery | Event to create.
 
 begin
   # Create Event
@@ -106,10 +107,10 @@ end
 api_instance = KlaviyoAPI::EventsApi.new
 id = 'id_example' # String | ID of the event
 opts = {
-  fields_event: ['metric_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  include: ['metrics'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
+  fields_event: ['metric_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  include: ['metrics'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
 }
 
 begin
@@ -144,10 +145,10 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | ID of the event |  |
-| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
+| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
 
 ### Return type
 
@@ -187,7 +188,7 @@ end
 api_instance = KlaviyoAPI::EventsApi.new
 id = 'id_example' # String | ID of the event
 opts = {
-  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -222,7 +223,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | ID of the event |  |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -262,7 +263,8 @@ end
 api_instance = KlaviyoAPI::EventsApi.new
 id = 'id_example' # String | ID of the event
 opts = {
-  fields_profile: ['email'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
+  additional_fields_profile: ['predictive_analytics'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
+  fields_profile: ['email'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -297,7 +299,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | ID of the event |  |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
+| **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39; | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -313,13 +316,13 @@ end
 - **Accept**: application/json
 
 
-## get_event_relationships
+## get_event_relationships_metrics
 
-> Hash&lt;String, Object&gt; get_event_relationships(id, related_resource)
+> Hash&lt;String, Object&gt; get_event_relationships_metrics(id)
 
-Get Event Relationships
+Get Event Relationships Metrics
 
-Get metrics or profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `Events Read` `Metrics Read` `Profiles Read`
+Get a list of related Metrics for an Event<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `Events Read` `Metrics Read`
 
 ### Examples
 
@@ -336,32 +339,102 @@ end
 
 api_instance = KlaviyoAPI::EventsApi.new
 id = 'id_example' # String | 
-related_resource = 'metrics' # String | 
 
 begin
-  # Get Event Relationships
-  result = api_instance.get_event_relationships(id, related_resource)
+  # Get Event Relationships Metrics
+  result = api_instance.get_event_relationships_metrics(id)
   p result
 rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_relationships: #{e}"
+  puts "Error when calling EventsApi->get_event_relationships_metrics: #{e}"
 end
 ```
 
-#### Using the get_event_relationships_with_http_info variant
+#### Using the get_event_relationships_metrics_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_event_relationships_with_http_info(id, related_resource)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_event_relationships_metrics_with_http_info(id)
 
 ```ruby
 begin
-  # Get Event Relationships
-  data, status_code, headers = api_instance.get_event_relationships_with_http_info(id, related_resource)
+  # Get Event Relationships Metrics
+  data, status_code, headers = api_instance.get_event_relationships_metrics_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
 rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_relationships_with_http_info: #{e}"
+  puts "Error when calling EventsApi->get_event_relationships_metrics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_relationships_profiles
+
+> Hash&lt;String, Object&gt; get_event_relationships_profiles(id)
+
+Get Event Relationships Profiles
+
+Get profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `Events Read` `Profiles Read`
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo-api-sdk'
+# setup authorization
+KlaviyoAPI.configure do |config|
+  # Configure API key authorization: Klaviyo-API-Key
+  config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
+end
+
+api_instance = KlaviyoAPI::EventsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get Event Relationships Profiles
+  result = api_instance.get_event_relationships_profiles(id)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling EventsApi->get_event_relationships_profiles: #{e}"
+end
+```
+
+#### Using the get_event_relationships_profiles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_event_relationships_profiles_with_http_info(id)
+
+```ruby
+begin
+  # Get Event Relationships Profiles
+  data, status_code, headers = api_instance.get_event_relationships_profiles_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling EventsApi->get_event_relationships_profiles_with_http_info: #{e}"
 end
 ```
 
@@ -370,7 +443,6 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **related_resource** | **String** |  |  |
 
 ### Return type
 
@@ -409,13 +481,13 @@ end
 
 api_instance = KlaviyoAPI::EventsApi.new
 opts = {
-  fields_event: ['metric_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
-  include: ['metrics'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
-  sort: 'datetime' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
+  fields_event: ['metric_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
+  include: ['metrics'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
+  sort: 'datetime' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
 }
 
 begin
@@ -449,13 +521,13 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
+| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;profile_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
 
 ### Return type
 

data/docs/FlowActionEnum.md

@@ -0,0 +1,15 @@
+# KlaviyoAPI::FlowActionEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::FlowActionEnum.new()
+```
+

data/docs/FlowEnum.md

@@ -0,0 +1,15 @@
+# KlaviyoAPI::FlowEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::FlowEnum.new()
+```
+