klaviyo-api-sdk 2.0.0 → 3.0.0

data/docs/SegmentsApi.md

@@ -1,543 +0,0 @@
-# KlaviyoAPI::SegmentsApi
-
-All URIs are relative to *https://a.klaviyo.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_segment**](SegmentsApi.md#get_segment) | **GET** /api/segments/{id}/ | Get Segment |
-| [**get_segment_profiles**](SegmentsApi.md#get_segment_profiles) | **GET** /api/segments/{segment_id}/profiles/ | Get Segment Profiles |
-| [**get_segment_relationships_profiles**](SegmentsApi.md#get_segment_relationships_profiles) | **GET** /api/segments/{id}/relationships/profiles/ | Get Segment Relationships Profiles |
-| [**get_segment_relationships_tags**](SegmentsApi.md#get_segment_relationships_tags) | **GET** /api/segments/{id}/relationships/tags/ | Get Segment Relationships Tags |
-| [**get_segment_tags**](SegmentsApi.md#get_segment_tags) | **GET** /api/segments/{segment_id}/tags/ | Get Segment Tags |
-| [**get_segments**](SegmentsApi.md#get_segments) | **GET** /api/segments/ | Get Segments |
-| [**update_segment**](SegmentsApi.md#update_segment) | **PATCH** /api/segments/{id}/ | Update Segment |
-
-
-## get_segment
-
-> Hash<String, Object> get_segment(id, opts)
-
-Get Segment
-
-Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Segments 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::SegmentsApi.new
-id = 'id_example' # String | 
-opts = {
-  fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-}
-
-begin
-  # Get Segment
-  result = api_instance.get_segment(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segment: #{e}"
-end
-```
-
-#### Using the get_segment_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_segment_with_http_info(id, opts)
-
-```ruby
-begin
-  # Get Segment
-  data, status_code, headers = api_instance.get_segment_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 SegmentsApi->get_segment_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **fields_segment** | [**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
-
-**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_segment_profiles
-
-> Hash&lt;String, Object&gt; get_segment_profiles(segment_id, opts)
-
-Get Segment Profiles
-
-Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Profiles Read` `Segments 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::SegmentsApi.new
-segment_id = 'segment_id_example' # String | 
-opts = {
-  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
-  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>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
-  page_size: 56 # Integer | The number of results to return per page. Default = 20. Max = 100
-}
-
-begin
-  # Get Segment Profiles
-  result = api_instance.get_segment_profiles(segment_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segment_profiles: #{e}"
-end
-```
-
-#### Using the get_segment_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_segment_profiles_with_http_info(segment_id, opts)
-
-```ruby
-begin
-  # Get Segment Profiles
-  data, status_code, headers = api_instance.get_segment_profiles_with_http_info(segment_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segment_profiles_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **segment_id** | **String** |  |  |
-| **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] |
-| **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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
-| **page_size** | **Integer** | The number of results to return per page. Default &#x3D; 20. Max &#x3D; 100 | [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_segment_relationships_profiles
-
-> Hash&lt;String, Object&gt; get_segment_relationships_profiles(id, opts)
-
-Get Segment Relationships Profiles
-
-Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Profiles Read` `Segments 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::SegmentsApi.new
-id = 'id_example' # String | 
-opts = {
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
-}
-
-begin
-  # Get Segment Relationships Profiles
-  result = api_instance.get_segment_relationships_profiles(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segment_relationships_profiles: #{e}"
-end
-```
-
-#### Using the get_segment_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_segment_relationships_profiles_with_http_info(id, opts)
-
-```ruby
-begin
-  # Get Segment Relationships Profiles
-  data, status_code, headers = api_instance.get_segment_relationships_profiles_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 SegmentsApi->get_segment_relationships_profiles_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [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_segment_relationships_tags
-
-> Hash&lt;String, Object&gt; get_segment_relationships_tags(id)
-
-Get Segment Relationships Tags
-
-If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Segments Read` `Tags 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::SegmentsApi.new
-id = 'id_example' # String | 
-
-begin
-  # Get Segment Relationships Tags
-  result = api_instance.get_segment_relationships_tags(id)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segment_relationships_tags: #{e}"
-end
-```
-
-#### Using the get_segment_relationships_tags_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_segment_relationships_tags_with_http_info(id)
-
-```ruby
-begin
-  # Get Segment Relationships Tags
-  data, status_code, headers = api_instance.get_segment_relationships_tags_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 SegmentsApi->get_segment_relationships_tags_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_segment_tags
-
-> Hash&lt;String, Object&gt; get_segment_tags(segment_id, opts)
-
-Get Segment Tags
-
-Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Segments Read` `Tags 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::SegmentsApi.new
-segment_id = 'segment_id_example' # String | 
-opts = {
-  fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-}
-
-begin
-  # Get Segment Tags
-  result = api_instance.get_segment_tags(segment_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segment_tags: #{e}"
-end
-```
-
-#### Using the get_segment_tags_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_segment_tags_with_http_info(segment_id, opts)
-
-```ruby
-begin
-  # Get Segment Tags
-  data, status_code, headers = api_instance.get_segment_tags_with_http_info(segment_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segment_tags_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **segment_id** | **String** |  |  |
-| **fields_tag** | [**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
-
-**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_segments
-
-> Hash&lt;String, Object&gt; get_segments(opts)
-
-Get Segments
-
-Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Segments 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::SegmentsApi.new
-opts = {
-  fields_segment: ['name'], # 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>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
-}
-
-begin
-  # Get Segments
-  result = api_instance.get_segments(opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->get_segments: #{e}"
-end
-```
-
-#### Using the get_segments_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_segments_with_http_info(opts)
-
-```ruby
-begin
-  # Get Segments
-  data, status_code, headers = api_instance.get_segments_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 SegmentsApi->get_segments_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **fields_segment** | [**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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [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
-
-
-## update_segment
-
-> Hash&lt;String, Object&gt; update_segment(id, segment_partial_update_query)
-
-Update Segment
-
-Update the name of a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Segments 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::SegmentsApi.new
-id = 'id_example' # String | 
-segment_partial_update_query = KlaviyoAPI::SegmentPartialUpdateQuery.new({data: KlaviyoAPI::SegmentPartialUpdateQueryResourceObject.new({type: KlaviyoAPI::SegmentEnum::SEGMENT, id: 'id_example', attributes: KlaviyoAPI::SegmentPartialUpdateQueryResourceObjectAttributes.new({name: 'name_example'})})}) # SegmentPartialUpdateQuery | 
-
-begin
-  # Update Segment
-  result = api_instance.update_segment(id, segment_partial_update_query)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->update_segment: #{e}"
-end
-```
-
-#### Using the update_segment_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)> update_segment_with_http_info(id, segment_partial_update_query)
-
-```ruby
-begin
-  # Update Segment
-  data, status_code, headers = api_instance.update_segment_with_http_info(id, segment_partial_update_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling SegmentsApi->update_segment_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **segment_partial_update_query** | [**SegmentPartialUpdateQuery**](SegmentPartialUpdateQuery.md) |  |  |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/SendOptions.md

@@ -1,20 +0,0 @@
-# KlaviyoAPI::SendOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **use_smart_sending** | **Boolean** |  |  |
-| **is_transactional** | **Boolean** |  |  |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::SendOptions.new(
-  use_smart_sending: null,
-  is_transactional: null
-)
-```
-

data/docs/SendOptionsSubObject.md

@@ -1,18 +0,0 @@
-# KlaviyoAPI::SendOptionsSubObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **use_smart_sending** | **Boolean** | Use smart sending. Defaults to True | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::SendOptionsSubObject.new(
-  use_smart_sending: null
-)
-```
-

data/docs/SendStrategySubObject.md

@@ -1,24 +0,0 @@
-# KlaviyoAPI::SendStrategySubObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **method** | **String** | Describes the shape of the options object. Allowed values: ['static', 'throttled', 'immediate', 'smart_send_time'] |  |
-| **options_static** | [**StaticScheduleOptions**](StaticScheduleOptions.md) |  | [optional] |
-| **options_throttled** | [**ThrottledScheduleOptions**](ThrottledScheduleOptions.md) |  | [optional] |
-| **options_sto** | [**STOScheduleOptions**](STOScheduleOptions.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::SendStrategySubObject.new(
-  method: static,
-  options_static: null,
-  options_throttled: null,
-  options_sto: null
-)
-```
-

data/docs/SendTimeSubObject.md

@@ -1,20 +0,0 @@
-# KlaviyoAPI::SendTimeSubObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **datetime** | **Time** | The datetime that the message is to be sent |  |
-| **is_local** | **Boolean** | Whether that datetime is to be a local datetime for the recipient |  |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::SendTimeSubObject.new(
-  datetime: null,
-  is_local: null
-)
-```
-

data/docs/StaticScheduleOptions.md

@@ -1,22 +0,0 @@
-# KlaviyoAPI::StaticScheduleOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **datetime** | **Time** | The time to send at |  |
-| **is_local** | **Boolean** | If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False. | [optional] |
-| **send_past_recipients_immediately** | **Boolean** | Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False. | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::StaticScheduleOptions.new(
-  datetime: null,
-  is_local: null,
-  send_past_recipients_immediately: null
-)
-```
-

data/docs/Subscription.md

@@ -1,24 +0,0 @@
-# KlaviyoAPI::Subscription
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **channels** | [**SubscriptionChannels**](SubscriptionChannels.md) |  | [optional] |
-| **email** | **String** | The email address to subscribe or to set on the profile if `channels` is specified and the email channel is omitted. | [optional] |
-| **phone_number** | **String** | The phone number to subscribe or to set on the profile if `channels` is specified and the SMS channel is omitted. | [optional] |
-| **profile_id** | **String** | The ID of the profile to subscribe. If provided, this will be used to perform the lookup. | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::Subscription.new(
-  channels: null,
-  email: matt-kemp@klaviyo-demo.com,
-  phone_number: +15005550006,
-  profile_id: 01GDDKASAP8TKDDA2GRZDSVP4H
-)
-```
-