RubyGems - klaviyo-api-sdk - Versions diffs - 1.2.0 → 3.0.0 - Mend

klaviyo-api-sdk 1.2.0 → 3.0.0

Files changed (765) hide show

data/docs/FlowsApi.md DELETED Viewed

@@ -1,1029 +0,0 @@
-# KlaviyoAPI::FlowsApi
-All URIs are relative to *https://a.klaviyo.com*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_flow**](FlowsApi.md#get_flow) | **GET** /api/flows/{id}/ | Get Flow |
-| [**get_flow_action**](FlowsApi.md#get_flow_action) | **GET** /api/flow-actions/{id}/ | Get Flow Action |
-| [**get_flow_action_flow**](FlowsApi.md#get_flow_action_flow) | **GET** /api/flow-actions/{action_id}/flow/ | Get Flow For Flow Action |
-| [**get_flow_action_messages**](FlowsApi.md#get_flow_action_messages) | **GET** /api/flow-actions/{action_id}/flow-messages/ | Get Messages For Flow Action |
-| [**get_flow_action_relationships**](FlowsApi.md#get_flow_action_relationships) | **GET** /api/flow-actions/{id}/relationships/{related_resource}/ | Get Flow Action Relationships |
-| [**get_flow_flow_actions**](FlowsApi.md#get_flow_flow_actions) | **GET** /api/flows/{flow_id}/flow-actions/ | Get Flow Actions For Flow |
-| [**get_flow_message**](FlowsApi.md#get_flow_message) | **GET** /api/flow-messages/{id}/ | Get Flow Message |
-| [**get_flow_message_action**](FlowsApi.md#get_flow_message_action) | **GET** /api/flow-messages/{message_id}/flow-action/ | Get Flow Action For Message |
-| [**get_flow_message_relationships**](FlowsApi.md#get_flow_message_relationships) | **GET** /api/flow-messages/{id}/relationships/{related_resource}/ | Get Flow Message Relationships |
-| [**get_flow_relationships**](FlowsApi.md#get_flow_relationships) | **GET** /api/flows/{id}/relationships/{related_resource}/ | Get Flow Relationships |
-| [**get_flow_tags**](FlowsApi.md#get_flow_tags) | **GET** /api/flows/{flow_id}/tags/ | Get Flow Tags |
-| [**get_flows**](FlowsApi.md#get_flows) | **GET** /api/flows/ | Get Flows |
-| [**update_flow**](FlowsApi.md#update_flow) | **PATCH** /api/flows/{id}/ | Update Flow Status |
-## get_flow
-> Hash&lt;String, Object&gt; get_flow(id, opts)
-Get Flow
-Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-id = 'id_example' # String |
-opts = {
-  fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  include: ['flow-actions'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
-}
-begin
-  # Get Flow
-  result = api_instance.get_flow(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow: #{e}"
-end
-```
-#### Using the get_flow_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_flow_with_http_info(id, opts)
-```ruby
-begin
-  # Get Flow
-  data, status_code, headers = api_instance.get_flow_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 FlowsApi->get_flow_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_flow** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
-### Return type
-**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_flow_action
-> Hash&lt;String, Object&gt; get_flow_action(id, opts)
-Get Flow Action
-Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-id = 'id_example' # String |
-opts = {
-  fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  fields_flow: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  include: ['flow-messages'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
-}
-begin
-  # Get Flow Action
-  result = api_instance.get_flow_action(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action: #{e}"
-end
-```
-#### Using the get_flow_action_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_flow_action_with_http_info(id, opts)
-```ruby
-begin
-  # Get Flow Action
-  data, status_code, headers = api_instance.get_flow_action_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 FlowsApi->get_flow_action_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_flow_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_flow** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
-### Return type
-**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_flow_action_flow
-> Hash&lt;String, Object&gt; get_flow_action_flow(action_id, opts)
-Get Flow For Flow Action
-Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-action_id = 'action_id_example' # String |
-opts = {
-  fields_flow: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-}
-begin
-  # Get Flow For Flow Action
-  result = api_instance.get_flow_action_flow(action_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action_flow: #{e}"
-end
-```
-#### Using the get_flow_action_flow_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_flow_action_flow_with_http_info(action_id, opts)
-```ruby
-begin
-  # Get Flow For Flow Action
-  data, status_code, headers = api_instance.get_flow_action_flow_with_http_info(action_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action_flow_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_id** | **String** |  |  |
-| **fields_flow** | [**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_flow_action_messages
-> Hash&lt;String, Object&gt; get_flow_action_messages(action_id, opts)
-Get Messages For Flow Action
-Get all flow messages associated with the given flow action ID.  Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-action_id = 'action_id_example' # String |
-opts = {
-  fields_flow_message: ['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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
-  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
-}
-begin
-  # Get Messages For Flow Action
-  result = api_instance.get_flow_action_messages(action_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action_messages: #{e}"
-end
-```
-#### Using the get_flow_action_messages_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_flow_action_messages_with_http_info(action_id, opts)
-```ruby
-begin
-  # Get Messages For Flow Action
-  data, status_code, headers = api_instance.get_flow_action_messages_with_http_info(action_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action_messages_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_id** | **String** |  |  |
-| **fields_flow_message** | [**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;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
-### Return type
-**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_flow_action_relationships
-> Hash&lt;String, Object&gt; get_flow_action_relationships(id, related_resource, opts)
-Get Flow Action Relationships
-Get all relationships for flow messages associated with the given flow action ID.  Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-id = 'id_example' # String |
-related_resource = 'flow' # String |
-opts = {
-  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`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
-  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
-}
-begin
-  # Get Flow Action Relationships
-  result = api_instance.get_flow_action_relationships(id, related_resource, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action_relationships: #{e}"
-end
-```
-#### Using the get_flow_action_relationships_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_flow_action_relationships_with_http_info(id, related_resource, opts)
-```ruby
-begin
-  # Get Flow Action Relationships
-  data, status_code, headers = api_instance.get_flow_action_relationships_with_http_info(id, related_resource, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action_relationships_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **related_resource** | **String** |  |  |
-| **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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
-### Return type
-**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_flow_flow_actions
-> Hash&lt;String, Object&gt; get_flow_flow_actions(flow_id, opts)
-Get Flow Actions For Flow
-Get all flow actions associated with the given flow ID.  Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-flow_id = 'flow_id_example' # String |
-opts = {
-  fields_flow_action: ['action_type'], # 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>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
-  sort: 'action_type' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
-}
-begin
-  # Get Flow Actions For Flow
-  result = api_instance.get_flow_flow_actions(flow_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_flow_actions: #{e}"
-end
-```
-#### Using the get_flow_flow_actions_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_flow_flow_actions_with_http_info(flow_id, opts)
-```ruby
-begin
-  # Get Flow Actions For Flow
-  data, status_code, headers = api_instance.get_flow_flow_actions_with_http_info(flow_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_flow_actions_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **flow_id** | **String** |  |  |
-| **fields_flow_action** | [**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;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;action_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
-### Return type
-**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_flow_message
-> Hash&lt;String, Object&gt; get_flow_message(id, opts)
-Get Flow Message
-Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-id = 'id_example' # String |
-opts = {
-  fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  fields_flow_message: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  include: ['flow-action'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
-}
-begin
-  # Get Flow Message
-  result = api_instance.get_flow_message(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_message: #{e}"
-end
-```
-#### Using the get_flow_message_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_flow_message_with_http_info(id, opts)
-```ruby
-begin
-  # Get Flow Message
-  data, status_code, headers = api_instance.get_flow_message_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 FlowsApi->get_flow_message_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_flow_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
-### Return type
-**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_flow_message_action
-> Hash&lt;String, Object&gt; get_flow_message_action(message_id, opts)
-Get Flow Action For Message
-Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-message_id = 'message_id_example' # String |
-opts = {
-  fields_flow_action: ['action_type'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-}
-begin
-  # Get Flow Action For Message
-  result = api_instance.get_flow_message_action(message_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_message_action: #{e}"
-end
-```
-#### Using the get_flow_message_action_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_flow_message_action_with_http_info(message_id, opts)
-```ruby
-begin
-  # Get Flow Action For Message
-  data, status_code, headers = api_instance.get_flow_message_action_with_http_info(message_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_message_action_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message_id** | **String** |  |  |
-| **fields_flow_action** | [**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_flow_message_relationships
-> Hash&lt;String, Object&gt; get_flow_message_relationships(id, related_resource)
-Get Flow Message Relationships
-Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-id = 'id_example' # String |
-related_resource = 'flow-action' # String |
-begin
-  # Get Flow Message Relationships
-  result = api_instance.get_flow_message_relationships(id, related_resource)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_message_relationships: #{e}"
-end
-```
-#### Using the get_flow_message_relationships_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_flow_message_relationships_with_http_info(id, related_resource)
-```ruby
-begin
-  # Get Flow Message Relationships
-  data, status_code, headers = api_instance.get_flow_message_relationships_with_http_info(id, related_resource)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_message_relationships_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **related_resource** | **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_flow_relationships
-> Hash&lt;String, Object&gt; get_flow_relationships(id, related_resource)
-Get Flow Relationships
-If the `related_resource` is `tags`, returns the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-id = 'id_example' # String |
-related_resource = 'flow-actions' # String |
-begin
-  # Get Flow Relationships
-  result = api_instance.get_flow_relationships(id, related_resource)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_relationships: #{e}"
-end
-```
-#### Using the get_flow_relationships_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_flow_relationships_with_http_info(id, related_resource)
-```ruby
-begin
-  # Get Flow Relationships
-  data, status_code, headers = api_instance.get_flow_relationships_with_http_info(id, related_resource)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_relationships_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **related_resource** | **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_flow_tags
-> Hash&lt;String, Object&gt; get_flow_tags(flow_id, opts)
-Get Flow Tags
-Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-flow_id = 'flow_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 Flow Tags
-  result = api_instance.get_flow_tags(flow_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_tags: #{e}"
-end
-```
-#### Using the get_flow_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_flow_tags_with_http_info(flow_id, opts)
-```ruby
-begin
-  # Get Flow Tags
-  data, status_code, headers = api_instance.get_flow_tags_with_http_info(flow_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_tags_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **flow_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_flows
-> Hash&lt;String, Object&gt; get_flows(opts)
-Get Flows
-Get all flows in an account.  Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-opts = {
-  fields_flow_action: ['action_type'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-  fields_flow: ['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>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
-  include: ['flow-actions'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
-  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
-}
-begin
-  # Get Flows
-  result = api_instance.get_flows(opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flows: #{e}"
-end
-```
-#### Using the get_flows_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_flows_with_http_info(opts)
-```ruby
-begin
-  # Get Flows
-  data, status_code, headers = api_instance.get_flows_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 FlowsApi->get_flows_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **fields_flow_action** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_flow** | [**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;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;trigger_type&#x60;: &#x60;equals&#x60; | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
-### Return type
-**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_flow
-> Hash&lt;String, Object&gt; update_flow(id, flow_update_query)
-Update Flow Status
-Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows 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::FlowsApi.new
-id = 'id_example' # String |
-flow_update_query = KlaviyoAPI::FlowUpdateQuery.new({data: KlaviyoAPI::FlowUpdateQueryAsSubResource.new({type: 'flow', id: 'id_example', attributes: KlaviyoAPI::FlowUpdateQueryAsSubResourceAttributes.new({status: 'status_example'})})}) # FlowUpdateQuery |
-begin
-  # Update Flow Status
-  result = api_instance.update_flow(id, flow_update_query)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->update_flow: #{e}"
-end
-```
-#### Using the update_flow_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_flow_with_http_info(id, flow_update_query)
-```ruby
-begin
-  # Update Flow Status
-  data, status_code, headers = api_instance.update_flow_with_http_info(id, flow_update_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->update_flow_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **flow_update_query** | [**FlowUpdateQuery**](FlowUpdateQuery.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