klaviyo-api-sdk 1.2.0 → 2.0.0

data/docs/FlowsApi.md

@@ -8,12 +8,14 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**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_action_relationships_flow**](FlowsApi.md#get_flow_action_relationships_flow) | **GET** /api/flow-actions/{id}/relationships/flow/ | Get Flow Action Relationships Flow |
+| [**get_flow_action_relationships_messages**](FlowsApi.md#get_flow_action_relationships_messages) | **GET** /api/flow-actions/{id}/relationships/flow-messages/ | Get Flow Action Relationships Messages |
 | [**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_message_relationships_action**](FlowsApi.md#get_flow_message_relationships_action) | **GET** /api/flow-messages/{id}/relationships/flow-action/ | Get Flow Message Relationships Action |
+| [**get_flow_relationships_flow_actions**](FlowsApi.md#get_flow_relationships_flow_actions) | **GET** /api/flows/{id}/relationships/flow-actions/ | Get Flow Relationships Flow Actions |
+| [**get_flow_relationships_tags**](FlowsApi.md#get_flow_relationships_tags) | **GET** /api/flows/{id}/relationships/tags/ | Get Flow Relationships Tags |
 | [**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 |
@@ -335,11 +337,82 @@ end
 - **Accept**: application/json
 
 
-## get_flow_action_relationships
+## get_flow_action_relationships_flow
 
-> Hash<String, Object> get_flow_action_relationships(id, related_resource, opts)
+> Hash<String, Object> get_flow_action_relationships_flow(id)
 
-Get Flow Action Relationships
+Get Flow Action Relationships Flow
+
+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
+id = 'id_example' # String | 
+
+begin
+  # Get Flow Action Relationships Flow
+  result = api_instance.get_flow_action_relationships_flow(id)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling FlowsApi->get_flow_action_relationships_flow: #{e}"
+end
+```
+
+#### Using the get_flow_action_relationships_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_relationships_flow_with_http_info(id)
+
+```ruby
+begin
+  # Get Flow Action Relationships Flow
+  data, status_code, headers = api_instance.get_flow_action_relationships_flow_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 FlowsApi->get_flow_action_relationships_flow_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_flow_action_relationships_messages
+
+> Hash&lt;String, Object&gt; get_flow_action_relationships_messages(id, opts)
+
+Get Flow Action Relationships Messages
 
 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`
 
@@ -358,7 +431,6 @@ 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
@@ -366,29 +438,29 @@ opts = {
 }
 
 begin
-  # Get Flow Action Relationships
-  result = api_instance.get_flow_action_relationships(id, related_resource, opts)
+  # Get Flow Action Relationships Messages
+  result = api_instance.get_flow_action_relationships_messages(id, opts)
   p result
 rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_action_relationships: #{e}"
+  puts "Error when calling FlowsApi->get_flow_action_relationships_messages: #{e}"
 end
 ```
 
-#### Using the get_flow_action_relationships_with_http_info variant
+#### Using the get_flow_action_relationships_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_relationships_with_http_info(id, related_resource, opts)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_action_relationships_messages_with_http_info(id, opts)
 
 ```ruby
 begin
-  # Get Flow Action Relationships
-  data, status_code, headers = api_instance.get_flow_action_relationships_with_http_info(id, related_resource, opts)
+  # Get Flow Action Relationships Messages
+  data, status_code, headers = api_instance.get_flow_action_relationships_messages_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_relationships_with_http_info: #{e}"
+  puts "Error when calling FlowsApi->get_flow_action_relationships_messages_with_http_info: #{e}"
 end
 ```
 
@@ -397,7 +469,6 @@ end
 | 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] |
@@ -651,11 +722,11 @@ end
 - **Accept**: application/json
 
 
-## get_flow_message_relationships
+## get_flow_message_relationships_action
 
-> Hash&lt;String, Object&gt; get_flow_message_relationships(id, related_resource)
+> Hash&lt;String, Object&gt; get_flow_message_relationships_action(id)
 
-Get Flow Message Relationships
+Get Flow Message Relationships Action
 
 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`
 
@@ -674,32 +745,31 @@ 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)
+  # Get Flow Message Relationships Action
+  result = api_instance.get_flow_message_relationships_action(id)
   p result
 rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_message_relationships: #{e}"
+  puts "Error when calling FlowsApi->get_flow_message_relationships_action: #{e}"
 end
 ```
 
-#### Using the get_flow_message_relationships_with_http_info variant
+#### Using the get_flow_message_relationships_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_relationships_with_http_info(id, related_resource)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_message_relationships_action_with_http_info(id)
 
 ```ruby
 begin
-  # Get Flow Message Relationships
-  data, status_code, headers = api_instance.get_flow_message_relationships_with_http_info(id, related_resource)
+  # Get Flow Message Relationships Action
+  data, status_code, headers = api_instance.get_flow_message_relationships_action_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 FlowsApi->get_flow_message_relationships_with_http_info: #{e}"
+  puts "Error when calling FlowsApi->get_flow_message_relationships_action_with_http_info: #{e}"
 end
 ```
 
@@ -708,7 +778,6 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **related_resource** | **String** |  |  |
 
 ### Return type
 
@@ -724,13 +793,13 @@ end
 - **Accept**: application/json
 
 
-## get_flow_relationships
+## get_flow_relationships_flow_actions
 
-> Hash&lt;String, Object&gt; get_flow_relationships(id, related_resource)
+> Hash&lt;String, Object&gt; get_flow_relationships_flow_actions(id, opts)
 
-Get Flow Relationships
+Get Flow Relationships Flow Actions
 
-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`
+Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`,  `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows Read`
 
 ### Examples
 
@@ -747,32 +816,108 @@ end
 
 api_instance = KlaviyoAPI::FlowsApi.new
 id = 'id_example' # String | 
-related_resource = 'flow-actions' # 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>`action_type`: `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`
+  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
+}
 
 begin
-  # Get Flow Relationships
-  result = api_instance.get_flow_relationships(id, related_resource)
+  # Get Flow Relationships Flow Actions
+  result = api_instance.get_flow_relationships_flow_actions(id, opts)
   p result
 rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling FlowsApi->get_flow_relationships: #{e}"
+  puts "Error when calling FlowsApi->get_flow_relationships_flow_actions: #{e}"
 end
 ```
 
-#### Using the get_flow_relationships_with_http_info variant
+#### Using the get_flow_relationships_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_relationships_with_http_info(id, related_resource)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_flow_relationships_flow_actions_with_http_info(id, opts)
 
 ```ruby
 begin
-  # Get Flow Relationships
-  data, status_code, headers = api_instance.get_flow_relationships_with_http_info(id, related_resource)
+  # Get Flow Relationships Flow Actions
+  data, status_code, headers = api_instance.get_flow_relationships_flow_actions_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_relationships_with_http_info: #{e}"
+  puts "Error when calling FlowsApi->get_flow_relationships_flow_actions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **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;action_type&#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] |
+| **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_relationships_tags
+
+> Hash&lt;String, Object&gt; get_flow_relationships_tags(id)
+
+Get Flow Relationships Tags
+
+Return 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 | 
+
+begin
+  # Get Flow Relationships Tags
+  result = api_instance.get_flow_relationships_tags(id)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling FlowsApi->get_flow_relationships_tags: #{e}"
+end
+```
+
+#### Using the get_flow_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_flow_relationships_tags_with_http_info(id)
+
+```ruby
+begin
+  # Get Flow Relationships Tags
+  data, status_code, headers = api_instance.get_flow_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 FlowsApi->get_flow_relationships_tags_with_http_info: #{e}"
 end
 ```
 
@@ -781,7 +926,6 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **related_resource** | **String** |  |  |
 
 ### Return type
 
@@ -977,8 +1121,8 @@ KlaviyoAPI.configure do |config|
 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 | 
+id = 'id_example' # String | ID of the Flow to update. Ex: XVTP5Q
+flow_update_query = KlaviyoAPI::FlowUpdateQuery.new({data: KlaviyoAPI::FlowUpdateQueryResourceObject.new({type: KlaviyoAPI::FlowEnum::FLOW, id: 'id_example', attributes: KlaviyoAPI::FlowUpdateQueryResourceObjectAttributes.new({status: 'status_example'})})}) # FlowUpdateQuery | 
 
 begin
   # Update Flow Status
@@ -1011,7 +1155,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+| **id** | **String** | ID of the Flow to update. Ex: XVTP5Q |  |
 | **flow_update_query** | [**FlowUpdateQuery**](FlowUpdateQuery.md) |  |  |
 
 ### Return type

data/docs/ListCreateQuery.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**ListCreateQueryAsSubResource**](ListCreateQueryAsSubResource.md) |  |  |
+| **data** | [**ListCreateQueryResourceObject**](ListCreateQueryResourceObject.md) |  |  |
 
 ## Example
 

data/docs/ListCreateQueryResourceObject.md

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

data/docs/ListCreateQueryResourceObjectAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::ListCreateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A helpful name to label the list |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ListCreateQueryResourceObjectAttributes.new(
+  name: Newsletter
+)
+```
+

data/docs/ListEnum.md

@@ -0,0 +1,15 @@
+# KlaviyoAPI::ListEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ListEnum.new()
+```
+

data/docs/ListPartialUpdateQuery.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**ListPartialUpdateQueryAsSubResource**](ListPartialUpdateQueryAsSubResource.md) |  |  |
+| **data** | [**ListPartialUpdateQueryResourceObject**](ListPartialUpdateQueryResourceObject.md) |  |  |
 
 ## Example
 

data/docs/ListPartialUpdateQueryResourceObject.md

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