klaviyo-api-sdk 11.1.0 → 13.0.0

data/docs/EventProfileCreateQueryResourceObject.md

@@ -1,22 +0,0 @@
-# KlaviyoAPI::EventProfileCreateQueryResourceObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | [**ProfileEnum**](ProfileEnum.md) |  |  |
-| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | [optional] |
-| **attributes** | [**EventProfileCreateQueryResourceObjectAttributes**](EventProfileCreateQueryResourceObjectAttributes.md) |  |  |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::EventProfileCreateQueryResourceObject.new(
-  type: null,
-  id: null,
-  attributes: null
-)
-```
-

data/docs/EventProfileCreateQueryResourceObjectAttributes.md

@@ -1,42 +0,0 @@
-# KlaviyoAPI::EventProfileCreateQueryResourceObjectAttributes
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **email** | **String** | Individual's email address | [optional] |
-| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
-| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
-| **anonymous_id** | **String** |  | [optional] |
-| **_kx** | **String** | Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo's web tracking.  You can use this field as a filter when retrieving profiles via the Get Profiles endpoint. | [optional] |
-| **first_name** | **String** | Individual's first name | [optional] |
-| **last_name** | **String** | Individual's last name | [optional] |
-| **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
-| **title** | **String** | Individual's job title | [optional] |
-| **image** | **String** | URL pointing to the location of a profile image | [optional] |
-| **location** | [**ProfileLocation**](ProfileLocation.md) |  | [optional] |
-| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
-| **meta** | [**OnsiteProfileMeta**](OnsiteProfileMeta.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::EventProfileCreateQueryResourceObjectAttributes.new(
-  email: sarah.mason@klaviyo-demo.com,
-  phone_number: +15005550006,
-  external_id: null,
-  anonymous_id: null,
-  _kx: null,
-  first_name: Sarah,
-  last_name: Mason,
-  organization: Example Corporation,
-  title: Regional Manager,
-  image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
-  location: null,
-  properties: {"pseudonym":"Dr. Octopus"},
-  meta: null
-)
-```
-

data/docs/EventsApi.md

@@ -1,615 +0,0 @@
-# KlaviyoAPI::EventsApi
-
-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 |
-| [**get_event_profile**](EventsApi.md#get_event_profile) | **GET** /api/events/{id}/profile/ | Get Event Profile |
-| [**get_event_relationships_metric**](EventsApi.md#get_event_relationships_metric) | **GET** /api/events/{id}/relationships/metric/ | Get Event Relationships Metric |
-| [**get_event_relationships_profile**](EventsApi.md#get_event_relationships_profile) | **GET** /api/events/{id}/relationships/profile/ | Get Event Relationships Profile |
-| [**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.  Note that this endpoint allows you to create new profiles or update existing profile properties.  At a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.  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)
-
-Create Event
-
-Create a new event to track a profile's activity.  Note that this endpoint allows you to create a new profile or update an existing profile's properties.  At a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.  Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/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
-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
-  api_instance.create_event(event_create_query_v2)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->create_event: #{e}"
-end
-```
-
-#### Using the create_event_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)> create_event_with_http_info(event_create_query_v2)
-
-```ruby
-begin
-  # Create Event
-  data, status_code, headers = api_instance.create_event_with_http_info(event_create_query_v2)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->create_event_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **event_create_query_v2** | [**EventCreateQueryV2**](EventCreateQueryV2.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
-
-
-## get_event
-
-> Hash&lt;String, Object&gt; get_event(id, opts)
-
-Get Event
-
-Get an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `events: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 | ID of the event
-opts = {
-  fields_event: ['timestamp'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
-  include: ['attributions'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
-}
-
-begin
-  # Get Event
-  result = api_instance.get_event(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event: #{e}"
-end
-```
-
-#### Using the get_event_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_with_http_info(id, opts)
-
-```ruby
-begin
-  # Get Event
-  data, status_code, headers = api_instance.get_event_with_http_info(id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| 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-07-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-07-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-07-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-07-15/reference/api-overview#relationships | [optional] |
-
-### 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_metric
-
-> Hash&lt;String, Object&gt; get_event_metric(id, opts)
-
-Get Event Metric
-
-Get the metric 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`
-
-### 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 | 
-opts = {
-  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
-}
-
-begin
-  # Get Event Metric
-  result = api_instance.get_event_metric(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_metric: #{e}"
-end
-```
-
-#### Using the get_event_metric_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_metric_with_http_info(id, opts)
-
-```ruby
-begin
-  # Get Event Metric
-  data, status_code, headers = api_instance.get_event_metric_with_http_info(id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_metric_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| 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-07-15/reference/api-overview#sparse-fieldsets | [optional] |
-
-### 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_profile
-
-> Hash&lt;String, Object&gt; get_event_profile(id, opts)
-
-Get Event Profile
-
-Get the profile associated with 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 | 
-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-07-15/reference/api-overview#sparse-fieldsets
-}
-
-begin
-  # Get Event Profile
-  result = api_instance.get_event_profile(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_profile: #{e}"
-end
-```
-
-#### Using the get_event_profile_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_profile_with_http_info(id, opts)
-
-```ruby
-begin
-  # Get Event Profile
-  data, status_code, headers = api_instance.get_event_profile_with_http_info(id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_profile_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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-07-15/reference/api-overview#sparse-fieldsets | [optional] |
-
-### 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_metric
-
-> Hash&lt;String, Object&gt; get_event_relationships_metric(id)
-
-Get Event Relationships Metric
-
-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
-
-```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 Metric
-  result = api_instance.get_event_relationships_metric(id)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_relationships_metric: #{e}"
-end
-```
-
-#### Using the get_event_relationships_metric_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_metric_with_http_info(id)
-
-```ruby
-begin
-  # Get Event Relationships Metric
-  data, status_code, headers = api_instance.get_event_relationships_metric_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_metric_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_profile
-
-> Hash&lt;String, Object&gt; get_event_relationships_profile(id)
-
-Get Event Relationships Profile
-
-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 Profile
-  result = api_instance.get_event_relationships_profile(id)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_event_relationships_profile: #{e}"
-end
-```
-
-#### Using the get_event_relationships_profile_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_profile_with_http_info(id)
-
-```ruby
-begin
-  # Get Event Relationships Profile
-  data, status_code, headers = api_instance.get_event_relationships_profile_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_profile_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_events
-
-> Hash&lt;String, Object&gt; get_events(opts)
-
-Get Events
-
-Get all events in an account  Requests can be sorted by the following fields: `datetime`, `timestamp`  Returns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `events: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
-opts = {
-  fields_event: ['timestamp'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`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-07-15/reference/api-overview#relationships
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
-  sort: 'datetime' # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
-}
-
-begin
-  # Get Events
-  result = api_instance.get_events(opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_events: #{e}"
-end
-```
-
-#### Using the get_events_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_events_with_http_info(opts)
-
-```ruby
-begin
-  # Get Events
-  data, status_code, headers = api_instance.get_events_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling EventsApi->get_events_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **fields_event** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-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-07-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-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-07-15/reference/api-overview#relationships | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting | [optional] |
-
-### 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
-