klaviyo-api-sdk 7.0.0 → 8.0.0

data/docs/SegmentsApi.md

@@ -4,6 +4,8 @@ All URIs are relative to *https://a.klaviyo.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_segment**](SegmentsApi.md#create_segment) | **POST** /api/segments/ | Create Segment |
+| [**delete_segment**](SegmentsApi.md#delete_segment) | **DELETE** /api/segments/{id}/ | Delete Segment |
 | [**get_segment**](SegmentsApi.md#get_segment) | **GET** /api/segments/{id}/ | Get Segment |
 | [**get_segment_profiles**](SegmentsApi.md#get_segment_profiles) | **GET** /api/segments/{id}/profiles/ | Get Segment Profiles |
 | [**get_segment_relationships_profiles**](SegmentsApi.md#get_segment_relationships_profiles) | **GET** /api/segments/{id}/relationships/profiles/ | Get Segment Relationships Profiles |
@@ -13,13 +15,154 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**update_segment**](SegmentsApi.md#update_segment) | **PATCH** /api/segments/{id}/ | Update Segment |
 
 
+## create_segment
+
+> Hash<String, Object> create_segment(segment_create_query)
+
+Create Segment
+
+Create a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`  **Scopes:** `segments:write`
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo-api-sdk'
+# setup authorization
+KlaviyoAPI.configure do |config|
+  # Configure API key authorization: Klaviyo-API-Key
+  config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
+end
+
+api_instance = KlaviyoAPI::SegmentsApi.new
+segment_create_query = KlaviyoAPI::SegmentCreateQuery.new({data: KlaviyoAPI::SegmentCreateQueryResourceObject.new({type: KlaviyoAPI::SegmentEnum::SEGMENT, attributes: KlaviyoAPI::SegmentCreateQueryResourceObjectAttributes.new({name: 'name_example', definition: KlaviyoAPI::SegmentDefinition.new({condition_groups: [KlaviyoAPI::ConditionGroup.new({conditions: [KlaviyoAPI::ProfileHasGroupMembershipCondition.new({type: KlaviyoAPI::ProfileGroupMembershipEnum::PROFILE_GROUP_MEMBERSHIP, is_member: true, group_ids: ['group_ids_example']})]})]})})})}) # SegmentCreateQuery | 
+
+begin
+  # Create Segment
+  result = api_instance.create_segment(segment_create_query)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling SegmentsApi->create_segment: #{e}"
+end
+```
+
+#### Using the create_segment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_segment_with_http_info(segment_create_query)
+
+```ruby
+begin
+  # Create Segment
+  data, status_code, headers = api_instance.create_segment_with_http_info(segment_create_query)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling SegmentsApi->create_segment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **segment_create_query** | [**SegmentCreateQuery**](SegmentCreateQuery.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
+
+
+## delete_segment
+
+> delete_segment(id)
+
+Delete Segment
+
+Delete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `segments:write`
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo-api-sdk'
+# setup authorization
+KlaviyoAPI.configure do |config|
+  # Configure API key authorization: Klaviyo-API-Key
+  config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
+end
+
+api_instance = KlaviyoAPI::SegmentsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Delete Segment
+  api_instance.delete_segment(id)
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling SegmentsApi->delete_segment: #{e}"
+end
+```
+
+#### Using the delete_segment_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_segment_with_http_info(id)
+
+```ruby
+begin
+  # Delete Segment
+  data, status_code, headers = api_instance.delete_segment_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling SegmentsApi->delete_segment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### 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
+
+
 ## get_segment
 
 > Hash&lt;String, Object&gt; get_segment(id, opts)
 
 Get Segment
 
-Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-05-15/docs/rate_limits_and_error_handling) guide.  **Scopes:** `segments:read`
+Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-07-15/docs/rate_limits_and_error_handling) guide.  **Scopes:** `segments:read`
 
 ### Examples
 
@@ -38,9 +181,9 @@ api_instance = KlaviyoAPI::SegmentsApi.new
 id = 'id_example' # String | 
 opts = {
   additional_fields_segment: ['profile_count'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'profile_count'
-  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
-  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
-  include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+  include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
 }
 
 begin
@@ -76,9 +219,9 @@ end
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
 | **additional_fields_segment** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39; | [optional] |
-| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships | [optional] |
+| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships | [optional] |
 
 ### Return type
 
@@ -119,11 +262,11 @@ api_instance = KlaviyoAPI::SegmentsApi.new
 id = 'id_example' # String | 
 opts = {
   additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `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/v2024-05-15/reference/api-overview#pagination
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `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/v2024-07-15/reference/api-overview#pagination
   page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
-  sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
+  sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
 }
 
 begin
@@ -159,11 +302,11 @@ end
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
 | **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39; | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#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/v2024-05-15/reference/api-overview#pagination | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#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/v2024-07-15/reference/api-overview#pagination | [optional] |
 | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 
@@ -203,10 +346,10 @@ end
 api_instance = KlaviyoAPI::SegmentsApi.new
 id = 'id_example' # String | 
 opts = {
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `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/v2024-05-15/reference/api-overview#pagination
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `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/v2024-07-15/reference/api-overview#pagination
   page_size: 56, # Integer | Default: 20. Min: 1. Max: 1000.
-  sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
+  sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
 }
 
 begin
@@ -241,10 +384,10 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#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/v2024-05-15/reference/api-overview#pagination | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#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/v2024-07-15/reference/api-overview#pagination | [optional] |
 | **page_size** | **Integer** | Default: 20. Min: 1. Max: 1000. | [optional][default to 20] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 
@@ -355,7 +498,7 @@ end
 api_instance = KlaviyoAPI::SegmentsApi.new
 id = 'id_example' # String | 
 opts = {
-  fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -390,7 +533,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -429,11 +572,12 @@ end
 
 api_instance = KlaviyoAPI::SegmentsApi.new
 opts = {
-  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
-  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`
-  include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`
+  include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
+  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
 }
 
 begin
@@ -467,11 +611,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;is_active&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;is_starred&#x60;: &#x60;equals&#x60; | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination | [optional] |
+| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;is_active&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;is_starred&#x60;: &#x60;equals&#x60; | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 
@@ -493,7 +638,7 @@ end
 
 Update Segment
 
-Update the name of a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`  **Scopes:** `segments:write`
+Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d`  **Scopes:** `segments:write`
 
 ### Examples
 

data/docs/SftpEnum.md

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

data/docs/SftpMethodFilter.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::SftpMethodFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**MethodEnum**](MethodEnum.md) |  |  |
+| **method** | [**SftpEnum**](SftpEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SftpMethodFilter.new(
+  field: null,
+  method: null
+)
+```
+

data/docs/ShopifyEnum.md

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

data/docs/ShopifyIntegrationFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::ShopifyIntegrationFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**StringEnum**](StringEnum.md) |  |  |
+| **operator** | [**InEnum**](InEnum.md) |  |  |
+| **value** | [**Array<ShopifyEnum>**](ShopifyEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ShopifyIntegrationFilter.new(
+  type: null,
+  operator: null,
+  value: null
+)
+```
+

data/docs/ShopifyIntegrationMethodFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::ShopifyIntegrationMethodFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**MethodEnum**](MethodEnum.md) |  |  |
+| **method** | [**IntegrationEnum**](IntegrationEnum.md) |  |  |
+| **filter** | [**ShopifyIntegrationFilter**](ShopifyIntegrationFilter.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ShopifyIntegrationMethodFilter.new(
+  field: null,
+  method: null,
+  filter: null
+)
+```
+

data/docs/SmsEnum.md

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

data/docs/SpamComplaintEnum.md

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

data/docs/SpamComplaintMethodFilter.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::SpamComplaintMethodFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**MethodEnum**](MethodEnum.md) |  |  |
+| **method** | [**SpamComplaintEnum**](SpamComplaintEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SpamComplaintMethodFilter.new(
+  field: null,
+  method: null
+)
+```
+

data/docs/StaticDateFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::StaticDateFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**DateEnum**](DateEnum.md) |  |  |
+| **operator** | **String** | Operators for static date filters.  E.g. \"before 2023-01-01\" |  |
+| **date** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::StaticDateFilter.new(
+  type: null,
+  operator: null,
+  date: 2022-11-08T00:00Z
+)
+```
+

data/docs/StaticDateRangeFilter.md

@@ -0,0 +1,24 @@
+# KlaviyoAPI::StaticDateRangeFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**DateEnum**](DateEnum.md) |  |  |
+| **operator** | **String** | Operators for static date range filters.  E.g. \"between 2023-01-01 and 2023-02-01\" |  |
+| **start** | **Time** |  |  |
+| **_end** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::StaticDateRangeFilter.new(
+  type: null,
+  operator: null,
+  start: 2022-11-08T00:00Z,
+  _end: 2022-11-08T00:00Z
+)
+```
+

data/docs/StatusDateEnum.md

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

data/docs/StatusDateFilter.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::StatusDateFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**StatusDateEnum**](StatusDateEnum.md) |  |  |
+| **filter** | [**StatusDateFilterFilter**](StatusDateFilterFilter.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::StatusDateFilter.new(
+  field: null,
+  filter: null
+)
+```
+

data/docs/StatusDateFilterFilter.md

@@ -0,0 +1,59 @@
+# KlaviyoAPI::StatusDateFilterFilter
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::StatusDateFilterFilter.openapi_one_of
+# =>
+# [
+#   :'AnniversaryDateFilter',
+#   :'CalendarDateFilter',
+#   :'RelativeAnniversaryDateFilter',
+#   :'RelativeDateOperatorBaseFilter',
+#   :'RelativeDateRangeFilter',
+#   :'StaticDateFilter',
+#   :'StaticDateRangeFilter'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::StatusDateFilterFilter.build(data)
+# => #<AnniversaryDateFilter:0x00007fdd4aab02a0>
+
+KlaviyoAPI::StatusDateFilterFilter.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `AnniversaryDateFilter`
+- `CalendarDateFilter`
+- `RelativeAnniversaryDateFilter`
+- `RelativeDateOperatorBaseFilter`
+- `RelativeDateRangeFilter`
+- `StaticDateFilter`
+- `StaticDateRangeFilter`
+- `nil` (if no type matches)
+

data/docs/StringArrayOperatorFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::StringArrayOperatorFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**StringEnum**](StringEnum.md) |  |  |
+| **operator** | **String** | Operators for string-in-array filters. |  |
+| **value** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::StringArrayOperatorFilter.new(
+  type: null,
+  operator: null,
+  value: null
+)
+```
+

data/docs/StringEnum.md

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