klaviyo_sdk 1.0.3.20220329 → 1.0.5.20220329

data/docs/ListsSegmentsApi.md

@@ -1,1198 +0,0 @@
-# Klaviyo::ListsSegmentsApi
-
-All URIs are relative to *https://a.klaviyo.com/api*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**add_members**](ListsSegmentsApi.md#add_members) | **POST** /v2/list/{list_id}/members | Add Members to a List |
-| [**create_list**](ListsSegmentsApi.md#create_list) | **POST** /v2/lists | Create List |
-| [**delete_list**](ListsSegmentsApi.md#delete_list) | **DELETE** /v2/list/{list_id} | Delete List |
-| [**exclude_globally**](ListsSegmentsApi.md#exclude_globally) | **POST** /v1/people/exclusions | Exclude Profile From All Email |
-| [**get_global_exclusions**](ListsSegmentsApi.md#get_global_exclusions) | **GET** /v1/people/exclusions | Get Global Exclusions & Unsubscribes |
-| [**get_list_exclusions**](ListsSegmentsApi.md#get_list_exclusions) | **GET** /v2/list/{list_id}/exclusions/all | Get All Exclusions for a List |
-| [**get_list_info**](ListsSegmentsApi.md#get_list_info) | **GET** /v2/list/{list_id} | Get List Info |
-| [**get_list_members**](ListsSegmentsApi.md#get_list_members) | **POST** /v2/list/{list_id}/get-members | Check if Profiles Are in a List |
-| [**get_list_subscriptions**](ListsSegmentsApi.md#get_list_subscriptions) | **POST** /v2/list/{list_id}/get-list-subscriptions | Check if Profiles Are in a List and not Suppressed |
-| [**get_lists**](ListsSegmentsApi.md#get_lists) | **GET** /v2/lists | Get Lists |
-| [**get_members**](ListsSegmentsApi.md#get_members) | **GET** /v2/group/{list_or_segment_id}/members/all | Get List and Segment Members |
-| [**get_segment_members**](ListsSegmentsApi.md#get_segment_members) | **POST** /v2/segment/{segment_id}/get-members | Check if Profiles Are in a Segment |
-| [**remove_members**](ListsSegmentsApi.md#remove_members) | **DELETE** /v2/list/{list_id}/members | Remove Profiles From List |
-| [**subscribe**](ListsSegmentsApi.md#subscribe) | **POST** /v2/list/{list_id}/subscribe | Subscribe Profiles to List |
-| [**unsubscribe**](ListsSegmentsApi.md#unsubscribe) | **DELETE** /v2/list/{list_id}/subscribe | Unsubscribe Profiles From List |
-| [**update_list_name**](ListsSegmentsApi.md#update_list_name) | **PUT** /v2/list/{list_id} | Update List Name |
-
-
-## add_members
-
-> Array<Hash<String, Object>> add_members(list_id, opts)
-
-Add Members to a List
-
-Adds profiles to a list. This endpoint is functionally equivalent to adding profiles to a list via a CSV upload and will immediately add profiles to the list. If you would like to subscribe profiles to a list and use the double opt-in settings for the list, please use the subscribe endpoint.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-opts = {
-  inline_object4: Klaviyo::InlineObject4.new({profiles: [{"email": "george.washington@klaviyo.com"}, {"phone_number": "+13239169023"}]}) # InlineObject4 | 
-}
-
-begin
-  # Add Members to a List
-  result = api_instance.add_members(list_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->add_members: #{e}"
-end
-```
-
-#### Using the add_members_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;Hash&lt;String, Object&gt;&gt;, Integer, Hash)> add_members_with_http_info(list_id, opts)
-
-```ruby
-begin
-  # Add Members to a List
-  data, status_code, headers = api_instance.add_members_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;Hash&lt;String, Object&gt;&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->add_members_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **inline_object4** | [**InlineObject4**](InlineObject4.md) |  | [optional] |
-
-### Return type
-
-**Array&lt;Hash&lt;String, Object&gt;&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_list
-
-> Hash&lt;String, Object&gt; create_list(list_name)
-
-Create List
-
-Creates a new list.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_name = 'list_name_example' # String | 
-
-begin
-  # Create List
-  result = api_instance.create_list(list_name)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->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_name)
-
-```ruby
-begin
-  # Create List
-  data, status_code, headers = api_instance.create_list_with_http_info(list_name)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->create_list_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_name** | **String** |  | [default to &#39;MyNewList&#39;] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: application/json
-
-
-## delete_list
-
-> delete_list(list_id)
-
-Delete List
-
-Deletes a list from an account. This is a destructive operation and cannot be undone. It will also remove flow triggers associated with the list.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-
-begin
-  # Delete List
-  api_instance.delete_list(list_id)
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->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(list_id)
-
-```ruby
-begin
-  # Delete List
-  data, status_code, headers = api_instance.delete_list_with_http_info(list_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->delete_list_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## exclude_globally
-
-> Hash&lt;String, Object&gt; exclude_globally(email)
-
-Exclude Profile From All Email
-
-Marks a person as excluded from all email. This works the same way as manually excluding someone via the excluded people page. Someone who is excluded will no longer receive any campaigns or flow emails.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-email = 'email_example' # String | 
-
-begin
-  # Exclude Profile From All Email
-  result = api_instance.exclude_globally(email)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->exclude_globally: #{e}"
-end
-```
-
-#### Using the exclude_globally_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)> exclude_globally_with_http_info(email)
-
-```ruby
-begin
-  # Exclude Profile From All Email
-  data, status_code, headers = api_instance.exclude_globally_with_http_info(email)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->exclude_globally_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **email** | **String** |  | [default to &#39;george.washington@klaviyo.com&#39;] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: application/json
-
-
-## get_global_exclusions
-
-> <GlobalExclusionResponseData> get_global_exclusions(opts)
-
-Get Global Exclusions & Unsubscribes
-
-Returns global exclusions/unsubscribes. Global exclusions are distinct from list exclusions in that these email addresses will not receive any emails from any list. Typically, when someone unsubscribes from a campaign, they are only unsubscribed from that list and are not globally unsubscribed.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-opts = {
-  reason: 'reason_example', # String | Filter results based on the reason for someone being excluded. The possible values are `unsubscribed`, `bounced`, `invalid_email`, `reported_spam` and `manually_excluded`. Only a single value may be specified at a time. Defaults to return all profiles regardless of reason.
-  sort: 'asc', # String | Sort order to apply to results, either ascending or descending. Valid values are `asc` or `desc`. Defaults to `asc`.
-  count: 500, # Integer | For pagination, the number of results to return. Default = 500
-  page: 0 # Integer | For pagination, which page of results to return. Default = 0
-}
-
-begin
-  # Get Global Exclusions & Unsubscribes
-  result = api_instance.get_global_exclusions(opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_global_exclusions: #{e}"
-end
-```
-
-#### Using the get_global_exclusions_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GlobalExclusionResponseData>, Integer, Hash)> get_global_exclusions_with_http_info(opts)
-
-```ruby
-begin
-  # Get Global Exclusions & Unsubscribes
-  data, status_code, headers = api_instance.get_global_exclusions_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GlobalExclusionResponseData>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_global_exclusions_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **reason** | **String** | Filter results based on the reason for someone being excluded. The possible values are &#x60;unsubscribed&#x60;, &#x60;bounced&#x60;, &#x60;invalid_email&#x60;, &#x60;reported_spam&#x60; and &#x60;manually_excluded&#x60;. Only a single value may be specified at a time. Defaults to return all profiles regardless of reason. | [optional] |
-| **sort** | **String** | Sort order to apply to results, either ascending or descending. Valid values are &#x60;asc&#x60; or &#x60;desc&#x60;. Defaults to &#x60;asc&#x60;. | [optional][default to &#39;asc&#39;] |
-| **count** | **Integer** | For pagination, the number of results to return. Default &#x3D; 500 | [optional][default to 500] |
-| **page** | **Integer** | For pagination, which page of results to return. Default &#x3D; 0 | [optional][default to 0] |
-
-### Return type
-
-[**GlobalExclusionResponseData**](GlobalExclusionResponseData.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_list_exclusions
-
-> Hash&lt;String, Object&gt; get_list_exclusions(list_id, opts)
-
-Get All Exclusions for a List
-
-Gets all of the emails and phone numbers that have been excluded from a list along with the exclusion reasons and exclusion time. This endpoint uses batching to return the records, so for a large list multiple calls will need to be made to get all of the records.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-opts = {
-  marker: 123456 # Integer | A marker value returned by a previous GET call. Use this to grab the next batch of records.
-}
-
-begin
-  # Get All Exclusions for a List
-  result = api_instance.get_list_exclusions(list_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_exclusions: #{e}"
-end
-```
-
-#### Using the get_list_exclusions_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_exclusions_with_http_info(list_id, opts)
-
-```ruby
-begin
-  # Get All Exclusions for a List
-  data, status_code, headers = api_instance.get_list_exclusions_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_exclusions_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **marker** | **Integer** | A marker value returned by a previous GET call. Use this to grab the next batch of records. | [optional] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_list_info
-
-> Hash&lt;String, Object&gt; get_list_info(list_id)
-
-Get List Info
-
-Returns information about a list.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-
-begin
-  # Get List Info
-  result = api_instance.get_list_info(list_id)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_info: #{e}"
-end
-```
-
-#### Using the get_list_info_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_info_with_http_info(list_id)
-
-```ruby
-begin
-  # Get List Info
-  data, status_code, headers = api_instance.get_list_info_with_http_info(list_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_info_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_list_members
-
-> Array&lt;Hash&lt;String, Object&gt;&gt; get_list_members(list_id, opts)
-
-Check if Profiles Are in a List
-
-Checks if one or more emails, phone numbers, or push tokens are in a given list. No distinction is made between a person not being in a given list, and not being present in Klaviyo at all. Can check up to a maximum of 100 emails at a time.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-opts = {
-  check_membership_request: Klaviyo::CheckMembershipRequest.new # CheckMembershipRequest | 
-}
-
-begin
-  # Check if Profiles Are in a List
-  result = api_instance.get_list_members(list_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_members: #{e}"
-end
-```
-
-#### Using the get_list_members_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;Hash&lt;String, Object&gt;&gt;, Integer, Hash)> get_list_members_with_http_info(list_id, opts)
-
-```ruby
-begin
-  # Check if Profiles Are in a List
-  data, status_code, headers = api_instance.get_list_members_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;Hash&lt;String, Object&gt;&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_members_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **check_membership_request** | [**CheckMembershipRequest**](CheckMembershipRequest.md) |  | [optional] |
-
-### Return type
-
-**Array&lt;Hash&lt;String, Object&gt;&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## get_list_subscriptions
-
-> Array&lt;Hash&lt;String, Object&gt;&gt; get_list_subscriptions(list_id, opts)
-
-Check if Profiles Are in a List and not Suppressed
-
-Checks if one or more emails are in a given list and not suppressed. No distinction is made between a person not being in a given list, and not being present in Klaviyo at all. Can check up to a maximum of 100 emails at a time.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-opts = {
-  check_membership_request: Klaviyo::CheckMembershipRequest.new # CheckMembershipRequest | 
-}
-
-begin
-  # Check if Profiles Are in a List and not Suppressed
-  result = api_instance.get_list_subscriptions(list_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_subscriptions: #{e}"
-end
-```
-
-#### Using the get_list_subscriptions_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;Hash&lt;String, Object&gt;&gt;, Integer, Hash)> get_list_subscriptions_with_http_info(list_id, opts)
-
-```ruby
-begin
-  # Check if Profiles Are in a List and not Suppressed
-  data, status_code, headers = api_instance.get_list_subscriptions_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;Hash&lt;String, Object&gt;&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_list_subscriptions_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **check_membership_request** | [**CheckMembershipRequest**](CheckMembershipRequest.md) |  | [optional] |
-
-### Return type
-
-**Array&lt;Hash&lt;String, Object&gt;&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## get_lists
-
-> Array&lt;Hash&lt;String, Object&gt;&gt; get_lists
-
-Get Lists
-
-Returns a listing of all of the lists in an account.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-
-begin
-  # Get Lists
-  result = api_instance.get_lists
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->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(Array&lt;Hash&lt;String, Object&gt;&gt;, Integer, Hash)> get_lists_with_http_info
-
-```ruby
-begin
-  # Get Lists
-  data, status_code, headers = api_instance.get_lists_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;Hash&lt;String, Object&gt;&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_lists_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-**Array&lt;Hash&lt;String, Object&gt;&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_members
-
-> Hash&lt;String, Object&gt; get_members(list_or_segment_id, opts)
-
-Get List and Segment Members
-
-Gets all of the emails, phone numbers, and push tokens for profiles in a given list or segment
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_or_segment_id = 'LIST_OR_SEGMENT_ID' # String | 
-opts = {
-  marker: 123456 # Integer | A marker value returned by a previous GET call. Use this to grab the next batch of records.
-}
-
-begin
-  # Get List and Segment Members
-  result = api_instance.get_members(list_or_segment_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_members: #{e}"
-end
-```
-
-#### Using the get_members_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_members_with_http_info(list_or_segment_id, opts)
-
-```ruby
-begin
-  # Get List and Segment Members
-  data, status_code, headers = api_instance.get_members_with_http_info(list_or_segment_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_members_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_or_segment_id** | **String** |  | [default to &#39;LIST_OR_SEGMENT_ID&#39;] |
-| **marker** | **Integer** | A marker value returned by a previous GET call. Use this to grab the next batch of records. | [optional] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_segment_members
-
-> Array&lt;Hash&lt;String, Object&gt;&gt; get_segment_members(segment_id, opts)
-
-Check if Profiles Are in a Segment
-
-Checks if one or more emails, phone numbers, or push tokens are in a given segment. No distinction is made between a person not being in a given segment, and not being present in Klaviyo at all. Can check up to a maximum of 100 emails at a time.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-segment_id = 'SEGMENT_ID' # String | 
-opts = {
-  check_membership_request: Klaviyo::CheckMembershipRequest.new # CheckMembershipRequest | 
-}
-
-begin
-  # Check if Profiles Are in a Segment
-  result = api_instance.get_segment_members(segment_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_segment_members: #{e}"
-end
-```
-
-#### Using the get_segment_members_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;Hash&lt;String, Object&gt;&gt;, Integer, Hash)> get_segment_members_with_http_info(segment_id, opts)
-
-```ruby
-begin
-  # Check if Profiles Are in a Segment
-  data, status_code, headers = api_instance.get_segment_members_with_http_info(segment_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;Hash&lt;String, Object&gt;&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->get_segment_members_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **segment_id** | **String** |  | [default to &#39;SEGMENT_ID&#39;] |
-| **check_membership_request** | [**CheckMembershipRequest**](CheckMembershipRequest.md) |  | [optional] |
-
-### Return type
-
-**Array&lt;Hash&lt;String, Object&gt;&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## remove_members
-
-> remove_members(list_id, opts)
-
-Remove Profiles From List
-
-Removes profiles from a list.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-opts = {
-  inline_object5: Klaviyo::InlineObject5.new # InlineObject5 | 
-}
-
-begin
-  # Remove Profiles From List
-  api_instance.remove_members(list_id, opts)
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->remove_members: #{e}"
-end
-```
-
-#### Using the remove_members_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)> remove_members_with_http_info(list_id, opts)
-
-```ruby
-begin
-  # Remove Profiles From List
-  data, status_code, headers = api_instance.remove_members_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->remove_members_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **inline_object5** | [**InlineObject5**](InlineObject5.md) |  | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## subscribe
-
-> Array&lt;Object&gt; subscribe(list_id, opts)
-
-Subscribe Profiles to List
-
-Subscribes profiles to a list. Profiles will be single or double opted into the specified list in accordance with that list’s settings. **Note:** If you have double opt-in enabled (default behavior), users will not be added to list until they opt-in, and so API will respond with an empty list: `[]`
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-opts = {
-  inline_object3: Klaviyo::InlineObject3.new({profiles: [{"email": "george.washington@klaviyo.com"}, {"phone_number": "+13239169023", "sms_consent": true}]}) # InlineObject3 | 
-}
-
-begin
-  # Subscribe Profiles to List
-  result = api_instance.subscribe(list_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->subscribe: #{e}"
-end
-```
-
-#### Using the subscribe_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;Object&gt;, Integer, Hash)> subscribe_with_http_info(list_id, opts)
-
-```ruby
-begin
-  # Subscribe Profiles to List
-  data, status_code, headers = api_instance.subscribe_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;Object&gt;
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->subscribe_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **inline_object3** | [**InlineObject3**](InlineObject3.md) |  | [optional] |
-
-### Return type
-
-**Array&lt;Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## unsubscribe
-
-> unsubscribe(list_id, opts)
-
-Unsubscribe Profiles From List
-
-Unsubscribes and removes profiles from a list.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-opts = {
-  request_body: { key: 3.56} # Hash<String, Object> | Unsubscribe and remove profiles from a list.
-}
-
-begin
-  # Unsubscribe Profiles From List
-  api_instance.unsubscribe(list_id, opts)
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->unsubscribe: #{e}"
-end
-```
-
-#### Using the unsubscribe_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)> unsubscribe_with_http_info(list_id, opts)
-
-```ruby
-begin
-  # Unsubscribe Profiles From List
-  data, status_code, headers = api_instance.unsubscribe_with_http_info(list_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->unsubscribe_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | Unsubscribe and remove profiles from a list. | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## update_list_name
-
-> update_list_name(list_id, list_name)
-
-Update List Name
-
-Updates a list's name.
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Klaviyo.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
-end
-
-api_instance = Klaviyo::ListsSegmentsApi.new
-list_id = 'LIST_ID' # String | 
-list_name = 'list_name_example' # String | 
-
-begin
-  # Update List Name
-  api_instance.update_list_name(list_id, list_name)
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->update_list_name: #{e}"
-end
-```
-
-#### Using the update_list_name_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)> update_list_name_with_http_info(list_id, list_name)
-
-```ruby
-begin
-  # Update List Name
-  data, status_code, headers = api_instance.update_list_name_with_http_info(list_id, list_name)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ListsSegmentsApi->update_list_name_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  | [default to &#39;LIST_ID&#39;] |
-| **list_name** | **String** |  | [default to &#39;MyRenamedList&#39;] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: Not defined
-