klaviyo-api-sdk 3.0.0 → 4.1.0

data/docs/SegmentsApi.md

@@ -0,0 +1,553 @@
+# 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/{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/{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: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-08-15/docs/rate_limits_and_error_handling) guide.  **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 = {
+  additional_fields_segment: ['profile_count'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'profile_count'
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+  include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
+}
+
+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** |  |  |
+| **additional_fields_segment** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39; | [optional] |
+| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-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_segment_profiles
+
+> Hash&lt;String, Object&gt; get_segment_profiles(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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/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 = {
+  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-08-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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-08-15/reference/api-overview#pagination
+  page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
+}
+
+begin
+  # Get Segment Profiles
+  result = api_instance.get_segment_profiles(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(id, opts)
+
+```ruby
+begin
+  # Get Segment Profiles
+  data, status_code, headers = api_instance.get_segment_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_profiles_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;predictive_analytics&#39; | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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-08-15/reference/api-overview#pagination | [optional] |
+| **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
+
+### 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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/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-08-15/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-08-15/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(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
+id = 'id_example' # String | 
+opts = {
+  fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+}
+
+begin
+  # Get Segment Tags
+  result = api_instance.get_segment_tags(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(id, opts)
+
+```ruby
+begin
+  # Get Segment Tags
+  data, status_code, headers = api_instance.get_segment_tags_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_tags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-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_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: `75/s`<br>Steady: `700/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-08-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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`
+  include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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/SendStrategySubObject.md

@@ -0,0 +1,24 @@
+# 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/ServerBISSubscriptionCreateQuery.md

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

data/docs/ServerBISSubscriptionCreateQueryResourceObject.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::ServerBISSubscriptionCreateQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**BackInStockSubscriptionEnum**](BackInStockSubscriptionEnum.md) |  |  |
+| **attributes** | [**ServerBISSubscriptionCreateQueryResourceObjectAttributes**](ServerBISSubscriptionCreateQueryResourceObjectAttributes.md) |  |  |
+| **relationships** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationships**](ServerBISSubscriptionCreateQueryResourceObjectRelationships.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ServerBISSubscriptionCreateQueryResourceObject.new(
+  type: null,
+  attributes: null,
+  relationships: null
+)
+```
+

data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributes.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::ServerBISSubscriptionCreateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channels** | **Array<String>** | The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s). |  |
+| **profile** | [**ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile**](ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ServerBISSubscriptionCreateQueryResourceObjectAttributes.new(
+  channels: ["EMAIL","SMS"],
+  profile: null
+)
+```
+

data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md

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

data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md

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