klaviyo-api-sdk 6.0.0 → 7.1.0

data/docs/PushProfileUpsertQueryResourceObjectAttributes.md

@@ -0,0 +1,42 @@
+# KlaviyoAPI::PushProfileUpsertQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
+| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
+| **anonymous_id** | **String** | Id that can be used to identify a profile when other identifiers are not available | [optional] |
+| **_kx** | **String** | Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo's web tracking.  You can use this field as a filter when retrieving profiles via the Get Profiles endpoint. | [optional] |
+| **first_name** | **String** | Individual's first name | [optional] |
+| **last_name** | **String** | Individual's last name | [optional] |
+| **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
+| **title** | **String** | Individual's job title | [optional] |
+| **image** | **String** | URL pointing to the location of a profile image | [optional] |
+| **location** | [**ProfileLocation**](ProfileLocation.md) |  | [optional] |
+| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
+| **meta** | [**ProfileMeta**](ProfileMeta.md) |  | [optional] |
+| **email** | **String** | Individual's email address | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::PushProfileUpsertQueryResourceObjectAttributes.new(
+  phone_number: +15005550006,
+  external_id: null,
+  anonymous_id: 01GDDKASAP8TKDDA2GRZDSVP4H,
+  _kx: null,
+  first_name: Sarah,
+  last_name: Mason,
+  organization: Example Corporation,
+  title: Regional Manager,
+  image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
+  location: null,
+  properties: {"pseudonym":"Dr. Octopus"},
+  meta: null,
+  email: sarah.mason@klaviyo-demo.com
+)
+```
+

data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md

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

data/docs/RelativeAnniversaryDateFilter.md

@@ -0,0 +1,24 @@
+# KlaviyoAPI::RelativeAnniversaryDateFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**DateEnum**](DateEnum.md) |  |  |
+| **operator** | **String** | Operators for relative date filters.  e.g. \"anniversary in the last 10 days\" |  |
+| **unit** | **String** | Units for relative date filters. |  |
+| **quantity** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::RelativeAnniversaryDateFilter.new(
+  type: null,
+  operator: null,
+  unit: null,
+  quantity: null
+)
+```
+

data/docs/RelativeDateFilter.md

@@ -0,0 +1,24 @@
+# KlaviyoAPI::RelativeDateFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**DateEnum**](DateEnum.md) |  |  |
+| **operator** | **String** | Operators for relative date filters.  e.g. \"in the last 10 days\" |  |
+| **unit** | **String** | Units for relative date filters. |  |
+| **quantity** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::RelativeDateFilter.new(
+  type: null,
+  operator: null,
+  unit: null,
+  quantity: null
+)
+```
+

data/docs/RelativeDateRangeFilter.md

@@ -0,0 +1,26 @@
+# KlaviyoAPI::RelativeDateRangeFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**DateEnum**](DateEnum.md) |  |  |
+| **operator** | **String** | Operators for relative date range filters.  e.g. \"between 10 and 20 days ago\" |  |
+| **start** | **Integer** |  |  |
+| **_end** | **Integer** |  |  |
+| **unit** | **String** | Units for relative date filters. |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::RelativeDateRangeFilter.new(
+  type: null,
+  operator: null,
+  start: null,
+  _end: null,
+  unit: null
+)
+```
+

data/docs/ReportingApi.md

@@ -31,9 +31,9 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ReportingApi.new
-campaign_values_request_dto = KlaviyoAPI::CampaignValuesRequestDTO.new({data: KlaviyoAPI::CampaignValuesRequestDTOResourceObject.new({type: KlaviyoAPI::CampaignValuesReportEnum::CAMPAIGN_VALUES_REPORT, attributes: KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.now, _end: Time.now}), conversion_metric_id: 'RESQ6t'})})}) # CampaignValuesRequestDTO | 
+campaign_values_request_dto = KlaviyoAPI::CampaignValuesRequestDTO.new({data: KlaviyoAPI::CampaignValuesRequestDTOResourceObject.new({type: KlaviyoAPI::CampaignValuesReportEnum::CAMPAIGN_VALUES_REPORT, attributes: KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.parse('2022-11-08T00:00Z'), _end: Time.parse('2022-11-08T00:00Z')}), conversion_metric_id: 'RESQ6t'})})}) # CampaignValuesRequestDTO | 
 opts = {
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
 }
 
 begin
@@ -68,7 +68,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **campaign_values_request_dto** | [**CampaignValuesRequestDTO**](CampaignValuesRequestDTO.md) |  |  |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | [optional] |
 
 ### Return type
 
@@ -106,9 +106,9 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ReportingApi.new
-flow_series_request_dto = KlaviyoAPI::FlowSeriesRequestDTO.new({data: KlaviyoAPI::FlowSeriesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowSeriesReportEnum::FLOW_SERIES_REPORT, attributes: KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.now, _end: Time.now}), interval: 'daily', conversion_metric_id: 'RESQ6t'})})}) # FlowSeriesRequestDTO | 
+flow_series_request_dto = KlaviyoAPI::FlowSeriesRequestDTO.new({data: KlaviyoAPI::FlowSeriesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowSeriesReportEnum::FLOW_SERIES_REPORT, attributes: KlaviyoAPI::FlowSeriesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.parse('2022-11-08T00:00Z'), _end: Time.parse('2022-11-08T00:00Z')}), interval: 'daily', conversion_metric_id: 'RESQ6t'})})}) # FlowSeriesRequestDTO | 
 opts = {
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
 }
 
 begin
@@ -143,7 +143,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **flow_series_request_dto** | [**FlowSeriesRequestDTO**](FlowSeriesRequestDTO.md) |  |  |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | [optional] |
 
 ### Return type
 
@@ -181,9 +181,9 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ReportingApi.new
-flow_values_request_dto = KlaviyoAPI::FlowValuesRequestDTO.new({data: KlaviyoAPI::FlowValuesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowValuesReportEnum::FLOW_VALUES_REPORT, attributes: KlaviyoAPI::FlowValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.now, _end: Time.now}), conversion_metric_id: 'RESQ6t'})})}) # FlowValuesRequestDTO | 
+flow_values_request_dto = KlaviyoAPI::FlowValuesRequestDTO.new({data: KlaviyoAPI::FlowValuesRequestDTOResourceObject.new({type: KlaviyoAPI::FlowValuesReportEnum::FLOW_VALUES_REPORT, attributes: KlaviyoAPI::FlowValuesRequestDTOResourceObjectAttributes.new({statistics: ["opens", "open_rate"], timeframe: KlaviyoAPI::CustomTimeframe.new({start: Time.parse('2022-11-08T00:00Z'), _end: Time.parse('2022-11-08T00:00Z')}), conversion_metric_id: 'RESQ6t'})})}) # FlowValuesRequestDTO | 
 opts = {
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
 }
 
 begin
@@ -218,7 +218,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **flow_values_request_dto** | [**FlowValuesRequestDTO**](FlowValuesRequestDTO.md) |  |  |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | [optional] |
 
 ### Return type
 

data/docs/SegmentCreateQuery.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::SegmentCreateQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**SegmentCreateQueryResourceObject**](SegmentCreateQueryResourceObject.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SegmentCreateQuery.new(
+  data: null
+)
+```
+

data/docs/SegmentCreateQueryResourceObject.md

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

data/docs/SegmentCreateQueryResourceObjectAttributes.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::SegmentCreateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **definition** | [**SegmentDefinition**](SegmentDefinition.md) |  |  |
+| **is_starred** | **Boolean** |  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SegmentCreateQueryResourceObjectAttributes.new(
+  name: null,
+  definition: null,
+  is_starred: null
+)
+```
+

data/docs/SegmentDefinition.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::SegmentDefinition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_groups** | [**Array<ConditionGroup>**](ConditionGroup.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SegmentDefinition.new(
+  condition_groups: null
+)
+```
+

data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md

@@ -4,7 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **definition** | [**SegmentDefinition**](SegmentDefinition.md) |  | [optional] |
 | **name** | **String** |  | [optional] |
+| **is_starred** | **Boolean** |  | [optional] |
 
 ## Example
 
@@ -12,7 +14,9 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::SegmentPartialUpdateQueryResourceObjectAttributes.new(
-  name: null
+  definition: null,
+  name: null,
+  is_starred: null
 )
 ```
 

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-02-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-06-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-02-15/reference/api-overview#sparse-fieldsets
-  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
+  include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-02-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-02-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-02-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-06-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-06-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-06-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-02-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-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-02-15/reference/api-overview#pagination
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-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-02-15/reference/api-overview#sorting
+  sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-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-02-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-06-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-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-02-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-02-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-02-15/reference/api-overview#pagination
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-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-02-15/reference/api-overview#sorting
+  sort: 'joined_group_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-02-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-02-15/reference/api-overview#pagination | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-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-02-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-02-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-02-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-06-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-02-15/reference/api-overview#sparse-fieldsets
-  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-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`
-  include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
+  fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#relationships
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination
+  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-02-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-02-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-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; | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-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-06-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-06-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-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-06-15/reference/api-overview#relationships | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-06-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`  **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/ServerBISSubscriptionCreateQueryResourceObject.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | [**BackInStockSubscriptionEnum**](BackInStockSubscriptionEnum.md) |  |  |
 | **attributes** | [**ServerBISSubscriptionCreateQueryResourceObjectAttributes**](ServerBISSubscriptionCreateQueryResourceObjectAttributes.md) |  |  |
-| **relationships** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationships**](ServerBISSubscriptionCreateQueryResourceObjectRelationships.md) |  |  |
+| **relationships** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationships**](ServerBISSubscriptionCreateQueryResourceObjectRelationships.md) |  | [optional] |
 
 ## Example
 

data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **variant** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant**](ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md) |  |  |
+| **variant** | [**ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant**](ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md) |  | [optional] |
 
 ## Example