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/ListsApi.md DELETED Viewed

@@ -1,762 +0,0 @@
-# KlaviyoAPI::ListsApi
-All URIs are relative to *https://a.klaviyo.com*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_list**](ListsApi.md#create_list) | **POST** /api/lists/ | Create List |
-| [**create_list_relationships**](ListsApi.md#create_list_relationships) | **POST** /api/lists/{id}/relationships/{related_resource}/ | Add Profile to List |
-| [**delete_list**](ListsApi.md#delete_list) | **DELETE** /api/lists/{id}/ | Delete List |
-| [**delete_list_relationships**](ListsApi.md#delete_list_relationships) | **DELETE** /api/lists/{id}/relationships/{related_resource}/ | Remove Profile from List |
-| [**get_list**](ListsApi.md#get_list) | **GET** /api/lists/{id}/ | Get List |
-| [**get_list_profiles**](ListsApi.md#get_list_profiles) | **GET** /api/lists/{list_id}/profiles/ | Get List Profiles |
-| [**get_list_relationships**](ListsApi.md#get_list_relationships) | **GET** /api/lists/{id}/relationships/{related_resource}/ | Get List Relationships |
-| [**get_list_tags**](ListsApi.md#get_list_tags) | **GET** /api/lists/{list_id}/tags/ | Get List Tags |
-| [**get_lists**](ListsApi.md#get_lists) | **GET** /api/lists/ | Get Lists |
-| [**update_list**](ListsApi.md#update_list) | **PATCH** /api/lists/{id}/ | Update List |
-## create_list
-> Hash&lt;String, Object&gt; create_list(list_create_query)
-Create List
-Create a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List 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::ListsApi.new
-list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryAsSubResource.new({type: 'list', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'Newsletter'})})}) # ListCreateQuery |
-begin
-  # Create List
-  result = api_instance.create_list(list_create_query)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->create_list: #{e}"
-end
-```
-#### Using the create_list_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)> create_list_with_http_info(list_create_query)
-```ruby
-begin
-  # Create List
-  data, status_code, headers = api_instance.create_list_with_http_info(list_create_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->create_list_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_create_query** | [**ListCreateQuery**](ListCreateQuery.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
-## create_list_relationships
-> create_list_relationships(id, related_resource, list_members_add_query)
-Add Profile to List
-Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Write` `Profiles 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::ListsApi.new
-id = 'id_example' # String |
-related_resource = 'profiles' # String |
-list_members_add_query = KlaviyoAPI::ListMembersAddQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersAddQuery |
-begin
-  # Add Profile to List
-  api_instance.create_list_relationships(id, related_resource, list_members_add_query)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->create_list_relationships: #{e}"
-end
-```
-#### Using the create_list_relationships_with_http_info variant
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-> <Array(nil, Integer, Hash)> create_list_relationships_with_http_info(id, related_resource, list_members_add_query)
-```ruby
-begin
-  # Add Profile to List
-  data, status_code, headers = api_instance.create_list_relationships_with_http_info(id, related_resource, list_members_add_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->create_list_relationships_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **related_resource** | **String** |  |  |
-| **list_members_add_query** | [**ListMembersAddQuery**](ListMembersAddQuery.md) |  |  |
-### Return type
-nil (empty response body)
-### Authorization
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## delete_list
-> delete_list(id)
-Delete List
-Delete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List 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::ListsApi.new
-id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
-begin
-  # Delete List
-  api_instance.delete_list(id)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->delete_list: #{e}"
-end
-```
-#### Using the delete_list_with_http_info variant
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-> <Array(nil, Integer, Hash)> delete_list_with_http_info(id)
-```ruby
-begin
-  # Delete List
-  data, status_code, headers = api_instance.delete_list_with_http_info(id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->delete_list_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. |  |
-### Return type
-nil (empty response body)
-### Authorization
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
-## delete_list_relationships
-> delete_list_relationships(id, related_resource, list_members_delete_query)
-Remove Profile from List
-Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Write` `Profiles 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::ListsApi.new
-id = 'id_example' # String |
-related_resource = 'profiles' # String |
-list_members_delete_query = KlaviyoAPI::ListMembersDeleteQuery.new({data: [KlaviyoAPI::ListMembersAddQueryDataInner.new({type: 'profile', id: 'id_example'})]}) # ListMembersDeleteQuery |
-begin
-  # Remove Profile from List
-  api_instance.delete_list_relationships(id, related_resource, list_members_delete_query)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->delete_list_relationships: #{e}"
-end
-```
-#### Using the delete_list_relationships_with_http_info variant
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-> <Array(nil, Integer, Hash)> delete_list_relationships_with_http_info(id, related_resource, list_members_delete_query)
-```ruby
-begin
-  # Remove Profile from List
-  data, status_code, headers = api_instance.delete_list_relationships_with_http_info(id, related_resource, list_members_delete_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->delete_list_relationships_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **related_resource** | **String** |  |  |
-| **list_members_delete_query** | [**ListMembersDeleteQuery**](ListMembersDeleteQuery.md) |  |  |
-### Return type
-nil (empty response body)
-### Authorization
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json
-## get_list
-> Hash&lt;String, Object&gt; get_list(id, opts)
-Get List
-Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List 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::ListsApi.new
-id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
-opts = {
-  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
-}
-begin
-  # Get List
-  result = api_instance.get_list(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->get_list: #{e}"
-end
-```
-#### Using the get_list_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_list_with_http_info(id, opts)
-```ruby
-begin
-  # Get List
-  data, status_code, headers = api_instance.get_list_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 ListsApi->get_list_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. |  |
-| **fields_list** | [**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_list_profiles
-> Hash&lt;String, Object&gt; get_list_profiles(list_id, opts)
-Get List Profiles
-Get all profiles within a list with the given list 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:** `List Read` `Profiles Read`
-### Examples
-```ruby
-require 'time'
-require 'klaviyo-api-sdk'
-# setup authorization
-KlaviyoAPI.configure do |config|
-  # Configure API key authorization: Klaviyo-API-Key
-  config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
-end
-api_instance = KlaviyoAPI::ListsApi.new
-list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
-opts = {
-  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
-}
-begin
-  # Get List Profiles
-  result = api_instance.get_list_profiles(list_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->get_list_profiles: #{e}"
-end
-```
-#### Using the get_list_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_list_profiles_with_http_info(list_id, opts)
-```ruby
-begin
-  # Get List Profiles
-  data, status_code, headers = api_instance.get_list_profiles_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->get_list_profiles_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. |  |
-| **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] |
-### 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_list_relationships
-> Hash&lt;String, Object&gt; get_list_relationships(id, related_resource, opts)
-Get List Relationships
-Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list 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:** `List Read` `Profiles Read`
-### Examples
-```ruby
-require 'time'
-require 'klaviyo-api-sdk'
-# setup authorization
-KlaviyoAPI.configure do |config|
-  # Configure API key authorization: Klaviyo-API-Key
-  config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
-end
-api_instance = KlaviyoAPI::ListsApi.new
-id = 'id_example' # String |
-related_resource = 'profiles' # 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 List Relationships
-  result = api_instance.get_list_relationships(id, related_resource, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->get_list_relationships: #{e}"
-end
-```
-#### Using the get_list_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_list_relationships_with_http_info(id, related_resource, opts)
-```ruby
-begin
-  # Get List Relationships
-  data, status_code, headers = api_instance.get_list_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 ListsApi->get_list_relationships_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **related_resource** | **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_list_tags
-> Hash&lt;String, Object&gt; get_list_tags(list_id, opts)
-Get List Tags
-Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `List 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::ListsApi.new
-list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
-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 List Tags
-  result = api_instance.get_list_tags(list_id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->get_list_tags: #{e}"
-end
-```
-#### Using the get_list_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_list_tags_with_http_info(list_id, opts)
-```ruby
-begin
-  # Get List Tags
-  data, status_code, headers = api_instance.get_list_tags_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->get_list_tags_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. |  |
-| **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_lists
-> Hash&lt;String, Object&gt; get_lists(opts)
-Get Lists
-Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `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:** `List 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::ListsApi.new
-opts = {
-  fields_list: ['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 Lists
-  result = api_instance.get_lists(opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->get_lists: #{e}"
-end
-```
-#### Using the get_lists_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_lists_with_http_info(opts)
-```ruby
-begin
-  # Get Lists
-  data, status_code, headers = api_instance.get_lists_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 ListsApi->get_lists_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **fields_list** | [**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_list
-> Hash&lt;String, Object&gt; update_list(id, list_partial_update_query)
-Update List
-Update the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List 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::ListsApi.new
-id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
-list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new({type: 'list', id: 'Y6nRLr', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'Newsletter'})})}) # ListPartialUpdateQuery |
-begin
-  # Update List
-  result = api_instance.update_list(id, list_partial_update_query)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->update_list: #{e}"
-end
-```
-#### Using the update_list_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_list_with_http_info(id, list_partial_update_query)
-```ruby
-begin
-  # Update List
-  data, status_code, headers = api_instance.update_list_with_http_info(id, list_partial_update_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ListsApi->update_list_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. |  |
-| **list_partial_update_query** | [**ListPartialUpdateQuery**](ListPartialUpdateQuery.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