klaviyo-api-sdk 6.0.0 → 7.0.0

data/docs/EventsApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://a.klaviyo.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**bulk_create_events**](EventsApi.md#bulk_create_events) | **POST** /api/event-bulk-create-jobs/ | Bulk Create Events |
 | [**create_event**](EventsApi.md#create_event) | **POST** /api/events/ | Create Event |
 | [**get_event**](EventsApi.md#get_event) | **GET** /api/events/{id}/ | Get Event |
 | [**get_event_metric**](EventsApi.md#get_event_metric) | **GET** /api/events/{id}/metric/ | Get Event Metric |
@@ -13,6 +14,76 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**get_events**](EventsApi.md#get_events) | **GET** /api/events/ | Get Events |
 
 
+## bulk_create_events
+
+> bulk_create_events(events_bulk_create_job)
+
+Bulk Create Events
+
+Create a batch of events for one or more profiles.  Accepts up to 1,000 events per request. The maximum allowed payload size is 5MB.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `events:write`
+
+### 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
+events_bulk_create_job = KlaviyoAPI::EventsBulkCreateJob.new({data: KlaviyoAPI::EventsBulkCreateJobResourceObject.new({type: KlaviyoAPI::EventBulkCreateJobEnum::EVENT_BULK_CREATE_JOB, attributes: KlaviyoAPI::EventsBulkCreateJobResourceObjectAttributes.new({events_bulk_create: KlaviyoAPI::EventsBulkCreateJobResourceObjectAttributesEventsBulkCreate.new({data: [KlaviyoAPI::EventsBulkCreateQueryResourceObject.new({type: KlaviyoAPI::EventBulkCreateEnum::EVENT_BULK_CREATE, attributes: KlaviyoAPI::EventsBulkCreateQueryResourceObjectAttributes.new({profile: KlaviyoAPI::EventsBulkCreateQueryResourceObjectAttributesProfile.new({data: KlaviyoAPI::OnsiteProfileCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes.new})}), events: KlaviyoAPI::EventsBulkCreateQueryResourceObjectAttributesEvents.new({data: [KlaviyoAPI::BaseEventCreateQueryResourceObject.new({type: KlaviyoAPI::EventEnum::EVENT, attributes: KlaviyoAPI::BaseEventCreateQueryResourceObjectAttributes.new({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"}}, metric: KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributesMetric.new({data: KlaviyoAPI::MetricCreateQueryResourceObject.new({type: KlaviyoAPI::MetricEnum::METRIC, attributes: KlaviyoAPI::MetricCreateQueryResourceObjectAttributes.new({name: 'Viewed Product'})})})})})]})})})]})})})}) # EventsBulkCreateJob | 
+
+begin
+  # Bulk Create Events
+  api_instance.bulk_create_events(events_bulk_create_job)
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling EventsApi->bulk_create_events: #{e}"
+end
+```
+
+#### Using the bulk_create_events_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> bulk_create_events_with_http_info(events_bulk_create_job)
+
+```ruby
+begin
+  # Bulk Create Events
+  data, status_code, headers = api_instance.bulk_create_events_with_http_info(events_bulk_create_job)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling EventsApi->bulk_create_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events_bulk_create_job** | [**EventsBulkCreateJob**](EventsBulkCreateJob.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_event
 
 > create_event(event_create_query_v2)
@@ -35,7 +106,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::EventsApi.new
-event_create_query_v2 = KlaviyoAPI::EventCreateQueryV2.new({data: KlaviyoAPI::EventCreateQueryV2ResourceObject.new({type: KlaviyoAPI::EventEnum::EVENT, attributes: KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributes.new({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"}}, metric: KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributesMetric.new({data: KlaviyoAPI::MetricCreateQueryResourceObject.new({type: KlaviyoAPI::MetricEnum::METRIC, attributes: KlaviyoAPI::MetricCreateQueryResourceObjectAttributes.new({name: 'Viewed Product'})})}), profile: KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributesProfile.new({data: KlaviyoAPI::OnsiteProfileCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes.new})})})})}) # EventCreateQueryV2 | 
+event_create_query_v2 = KlaviyoAPI::EventCreateQueryV2.new({data: KlaviyoAPI::EventCreateQueryV2ResourceObject.new({type: KlaviyoAPI::EventEnum::EVENT, attributes: KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributes.new({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"}}, metric: KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributesMetric.new({data: KlaviyoAPI::MetricCreateQueryResourceObject.new({type: KlaviyoAPI::MetricEnum::METRIC, attributes: KlaviyoAPI::MetricCreateQueryResourceObjectAttributes.new({name: 'Viewed Product'})})}), profile: KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributesProfile.new({data: KlaviyoAPI::EventProfileCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::EventProfileCreateQueryResourceObjectAttributes.new})})})})}) # EventCreateQueryV2 | 
 
 begin
   # Create Event
@@ -107,10 +178,10 @@ end
 api_instance = KlaviyoAPI::EventsApi.new
 id = 'id_example' # String | ID of the event
 opts = {
-  fields_event: ['timestamp'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  include: ['attributions'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+  fields_event: ['timestamp'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  include: ['attributions'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
 }
 
 begin
@@ -145,10 +216,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/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
+| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships | [optional] |
 
 ### Return type
 
@@ -188,7 +259,7 @@ end
 api_instance = KlaviyoAPI::EventsApi.new
 id = 'id_example' # String | 
 opts = {
-  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -223,7 +294,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -264,7 +335,7 @@ api_instance = KlaviyoAPI::EventsApi.new
 id = 'id_example' # String | 
 opts = {
   additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
-  fields_profile: ['email'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -300,7 +371,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
 | **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39; | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -481,13 +552,13 @@ end
 
 api_instance = KlaviyoAPI::EventsApi.new
 opts = {
-  fields_event: ['timestamp'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<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: ['attributions'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
-  sort: 'datetime' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
+  fields_event: ['timestamp'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<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: ['attributions'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+  sort: 'datetime' # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
 }
 
 begin
@@ -521,13 +592,13 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/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;profile&#x60;: &#x60;has&#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/v2024-02-15/reference/api-overview#relationships | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting | [optional] |
+| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/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;profile&#x60;: &#x60;has&#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/v2024-05-15/reference/api-overview#relationships | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 

data/docs/EventsBulkCreateJob.md

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

data/docs/EventsBulkCreateJobResourceObject.md

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

data/docs/EventsBulkCreateJobResourceObjectAttributes.md

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

data/docs/EventsBulkCreateJobResourceObjectAttributesEventsBulkCreate.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::EventsBulkCreateJobResourceObjectAttributesEventsBulkCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<EventsBulkCreateQueryResourceObject>**](EventsBulkCreateQueryResourceObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventsBulkCreateJobResourceObjectAttributesEventsBulkCreate.new(
+  data: null
+)
+```
+

data/docs/EventsBulkCreateQueryResourceObject.md

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

data/docs/EventsBulkCreateQueryResourceObjectAttributes.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::EventsBulkCreateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile** | [**EventsBulkCreateQueryResourceObjectAttributesProfile**](EventsBulkCreateQueryResourceObjectAttributesProfile.md) |  |  |
+| **events** | [**EventsBulkCreateQueryResourceObjectAttributesEvents**](EventsBulkCreateQueryResourceObjectAttributesEvents.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventsBulkCreateQueryResourceObjectAttributes.new(
+  profile: null,
+  events: null
+)
+```
+

data/docs/EventsBulkCreateQueryResourceObjectAttributesEvents.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::EventsBulkCreateQueryResourceObjectAttributesEvents
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<BaseEventCreateQueryResourceObject>**](BaseEventCreateQueryResourceObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventsBulkCreateQueryResourceObjectAttributesEvents.new(
+  data: null
+)
+```
+

data/docs/EventsBulkCreateQueryResourceObjectAttributesProfile.md

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

data/docs/FlowSeriesRequestDTOResourceObjectAttributes.md

@@ -8,7 +8,7 @@
 | **timeframe** | [**CampaignValuesRequestDTOResourceObjectAttributesTimeframe**](CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md) |  |  |
 | **interval** | **String** | The interval used to aggregate data within the series request. If hourly is used, the timeframe cannot be longer than 7 days. If daily is used, the timeframe cannot be longer than 60 days. If monthly is used, the timeframe cannot be longer than 52 weeks. |  |
 | **conversion_metric_id** | **String** | ID of the metric to be used for conversion statistics |  |
-| **filter** | **String** | API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. | [optional] |
+| **filter** | **String** | API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms. | [optional] |
 
 ## Example
 

data/docs/FlowValuesRequestDTOResourceObjectAttributes.md

@@ -7,7 +7,7 @@
 | **statistics** | **Array<String>** | List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0] |  |
 | **timeframe** | [**CampaignValuesRequestDTOResourceObjectAttributesTimeframe**](CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md) |  |  |
 | **conversion_metric_id** | **String** | ID of the metric to be used for conversion statistics |  |
-| **filter** | **String** | API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. | [optional] |
+| **filter** | **String** | API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms. | [optional] |
 
 ## Example