klaviyo-api-sdk 4.1.0 → 5.0.0

data/docs/MetricsApi.md

@@ -33,7 +33,7 @@ end
 api_instance = KlaviyoAPI::MetricsApi.new
 id = 'id_example' # String | Metric ID
 opts = {
-  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -68,7 +68,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Metric ID |  |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -107,9 +107,9 @@ end
 
 api_instance = KlaviyoAPI::MetricsApi.new
 opts = {
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
+  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
 }
 
 begin
@@ -143,9 +143,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | [optional] |
 
 ### Return type
 

data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md

@@ -8,6 +8,7 @@
 | **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** |  | [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] |
@@ -26,6 +27,7 @@ instance = KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes.new(
   phone_number: +15005550006,
   external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
   anonymous_id: null,
+  _kx: J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66,
   first_name: Sarah,
   last_name: Mason,
   organization: Klaviyo,

data/docs/ProfileLocation.md

@@ -13,6 +13,7 @@
 | **region** | **String** | Region within a country, such as state or province | [optional] |
 | **zip** | **String** | Zip code | [optional] |
 | **timezone** | **String** | Time zone name. We recommend using time zones from the IANA Time Zone Database. | [optional] |
+| **ip** | **String** | IP Address | [optional] |
 
 ## Example
 
@@ -28,7 +29,8 @@ instance = KlaviyoAPI::ProfileLocation.new(
   longitude: null,
   region: NY,
   zip: 10017,
-  timezone: America/New_York
+  timezone: America/New_York,
+  ip: 127.0.0.1
 )
 ```
 

data/docs/ProfileMergeEnum.md

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

data/docs/ProfileMergeQuery.md

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

data/docs/ProfileMergeQueryResourceObject.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::ProfileMergeQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ProfileMergeEnum**](ProfileMergeEnum.md) |  |  |
+| **id** | **String** | The ID of the destination profile to merge into |  |
+| **relationships** | [**ProfileMergeQueryResourceObjectRelationships**](ProfileMergeQueryResourceObjectRelationships.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ProfileMergeQueryResourceObject.new(
+  type: null,
+  id: 01GDDKASAP8TKDDA2GRZDSVP4H,
+  relationships: null
+)
+```
+

data/docs/ProfileMergeQueryResourceObjectRelationships.md

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

data/docs/ProfileMergeQueryResourceObjectRelationshipsProfiles.md

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

data/docs/ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ProfileEnum**](ProfileEnum.md) |  |  |
+| **id** | **String** | The ID of a source profile to merge into the destination profile |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.new(
+  type: null,
+  id: 01GDDKASAP8TKDDA2GRZDSVP4I
+)
+```
+

data/docs/ProfilePartialUpdateQueryResourceObject.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | [**ProfileEnum**](ProfileEnum.md) |  |  |
 | **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. |  |
-| **attributes** | [**OnsiteProfileCreateQueryResourceObjectAttributes**](OnsiteProfileCreateQueryResourceObjectAttributes.md) |  |  |
+| **attributes** | [**ProfilePartialUpdateQueryResourceObjectAttributes**](ProfilePartialUpdateQueryResourceObjectAttributes.md) |  |  |
 | **meta** | [**ProfileMeta**](ProfileMeta.md) |  | [optional] |
 
 ## Example

data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md

@@ -0,0 +1,38 @@
+# KlaviyoAPI::ProfilePartialUpdateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Individual's email address | [optional] |
+| **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** |  | [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] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ProfilePartialUpdateQueryResourceObjectAttributes.new(
+  email: sarah.mason@klaviyo-demo.com,
+  phone_number: +15005550006,
+  external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
+  anonymous_id: null,
+  first_name: Sarah,
+  last_name: Mason,
+  organization: Klaviyo,
+  title: Engineer,
+  image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
+  location: null,
+  properties: {"pseudonym":"Dr. Octopus"}
+)
+```
+

data/docs/ProfileUpsertQueryResourceObjectAttributes.md

@@ -8,6 +8,7 @@
 | **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] |
@@ -27,6 +28,7 @@ instance = KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new(
   phone_number: +15005550006,
   external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
   anonymous_id: 01GDDKASAP8TKDDA2GRZDSVP4H,
+  _kx: J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66,
   first_name: Sarah,
   last_name: Mason,
   organization: Klaviyo,

data/docs/ProfilesApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**get_profile_relationships_segments**](ProfilesApi.md#get_profile_relationships_segments) | **GET** /api/profiles/{id}/relationships/segments/ | Get Profile Relationships Segments |
 | [**get_profile_segments**](ProfilesApi.md#get_profile_segments) | **GET** /api/profiles/{id}/segments/ | Get Profile Segments |
 | [**get_profiles**](ProfilesApi.md#get_profiles) | **GET** /api/profiles/ | Get Profiles |
+| [**merge_profiles**](ProfilesApi.md#merge_profiles) | **POST** /api/profile-merge/ | Merge Profiles |
 | [**subscribe_profiles**](ProfilesApi.md#subscribe_profiles) | **POST** /api/profile-subscription-bulk-create-jobs/ | Subscribe Profiles |
 | [**suppress_profiles**](ProfilesApi.md#suppress_profiles) | **POST** /api/profile-suppression-bulk-create-jobs/ | Suppress Profiles |
 | [**unsubscribe_profiles**](ProfilesApi.md#unsubscribe_profiles) | **POST** /api/profile-subscription-bulk-delete-jobs/ | Unsubscribe Profiles |
@@ -166,7 +167,7 @@ nil (empty response body)
 
 Get Profile
 
-Get the profile with the given profile ID.  Include parameters can be provided to get the following related resource data: `lists` (memberships), `segments` (memberships)<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:read`
+Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:read`
 
 ### Examples
 
@@ -184,11 +185,11 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 id = 'id_example' # String | 
 opts = {
-  additional_fields_profile: ['predictive_analytics'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
-  fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
-  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
-  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
+  additional_fields_profile: ['subscriptions'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
+  fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
+  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships
 }
 
 begin
@@ -223,11 +224,11 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39; | [optional] |
-| **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
+| **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_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | [optional] |
 
 ### Return type
 
@@ -267,7 +268,7 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 id = 'id_example' # String | 
 opts = {
-  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -302,7 +303,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -484,7 +485,7 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 id = 'id_example' # String | 
 opts = {
-  fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
+  fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -519,7 +520,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -541,7 +542,7 @@ end
 
 Get Profiles
 
-Get all profiles in an account.  Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/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/v2023-08-15/docs/rate_limits_and_error_handling) guide.  **Scopes:** `profiles:read`
+Get all profiles in an account.  Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/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/v2023-10-15/docs/rate_limits_and_error_handling) guide.  **Scopes:** `profiles:read`
 
 ### Examples
 
@@ -558,12 +559,12 @@ end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
 opts = {
-  additional_fields_profile: ['predictive_analytics'], # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
+  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/v2023-10-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.suppression.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`<br>`subscriptions.email.marketing.suppression.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.list_id` : `equals`<br>`subscriptions.email.marketing.list_suppressions.reason` : `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp` : `greater-than`, `greater-or-equal`, `less-than`, `less-or-equal`
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination
   page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
-  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
+  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting
 }
 
 begin
@@ -597,12 +598,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **additional_fields_profile** | [**Array&lt;String&gt;**](String.md) | Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39; | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&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;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
+| **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/v2023-10-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&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;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.list_id&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-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/v2023-08-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 
@@ -618,6 +619,77 @@ end
 - **Accept**: application/json
 
 
+## merge_profiles
+
+> Hash&lt;String, Object&gt; merge_profiles(profile_merge_query)
+
+Merge Profiles
+
+Merge a given related profile into a profile with the given profile ID.  The profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.  To learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `profiles:write`
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo-api-sdk'
+# setup authorization
+KlaviyoAPI.configure do |config|
+  # Configure API key authorization: Klaviyo-API-Key
+  config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
+end
+
+api_instance = KlaviyoAPI::ProfilesApi.new
+profile_merge_query = KlaviyoAPI::ProfileMergeQuery.new({data: KlaviyoAPI::ProfileMergeQueryResourceObject.new({type: KlaviyoAPI::ProfileMergeEnum::PROFILE_MERGE, id: '01GDDKASAP8TKDDA2GRZDSVP4H', relationships: KlaviyoAPI::ProfileMergeQueryResourceObjectRelationships.new({profiles: KlaviyoAPI::ProfileMergeQueryResourceObjectRelationshipsProfiles.new({data: [KlaviyoAPI::ProfileMergeQueryResourceObjectRelationshipsProfilesDataInner.new({type: KlaviyoAPI::ProfileEnum::PROFILE, id: '01GDDKASAP8TKDDA2GRZDSVP4I'})]})})})}) # ProfileMergeQuery | 
+
+begin
+  # Merge Profiles
+  result = api_instance.merge_profiles(profile_merge_query)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ProfilesApi->merge_profiles: #{e}"
+end
+```
+
+#### Using the merge_profiles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> merge_profiles_with_http_info(profile_merge_query)
+
+```ruby
+begin
+  # Merge Profiles
+  data, status_code, headers = api_instance.merge_profiles_with_http_info(profile_merge_query)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ProfilesApi->merge_profiles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_merge_query** | [**ProfileMergeQuery**](ProfileMergeQuery.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
+
+
 ## subscribe_profiles
 
 > subscribe_profiles(subscription_create_job_create_query)
@@ -640,7 +712,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-subscription_create_job_create_query = KlaviyoAPI::SubscriptionCreateJobCreateQuery.new({data: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSubscriptionBulkCreateJobEnum::PROFILE_SUBSCRIPTION_BULK_CREATE_JOB, attributes: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObjectAttributes.new})]})})})}) # SubscriptionCreateJobCreateQuery | Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
+subscription_create_job_create_query = KlaviyoAPI::SubscriptionCreateJobCreateQuery.new({data: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSubscriptionBulkCreateJobEnum::PROFILE_SUBSCRIPTION_BULK_CREATE_JOB, attributes: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileSubscriptionCreateQueryResourceObjectAttributes.new})]})}), relationships: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectRelationships.new({list: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.new({data: KlaviyoAPI::SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.new({type: KlaviyoAPI::ListEnum::LIST, id: 'Y6nRLr'})})})})}) # SubscriptionCreateJobCreateQuery | Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
 
 begin
   # Subscribe Profiles
@@ -921,7 +993,7 @@ end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
 id = '01GDDKASAP8TKDDA2GRZDSVP4H' # String | Primary key that uniquely identifies this profile. Generated by Klaviyo.
-profile_partial_update_query = KlaviyoAPI::ProfilePartialUpdateQuery.new({data: KlaviyoAPI::ProfilePartialUpdateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, id: '01GDDKASAP8TKDDA2GRZDSVP4H', attributes: KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes.new})}) # ProfilePartialUpdateQuery | 
+profile_partial_update_query = KlaviyoAPI::ProfilePartialUpdateQuery.new({data: KlaviyoAPI::ProfilePartialUpdateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, id: '01GDDKASAP8TKDDA2GRZDSVP4H', attributes: KlaviyoAPI::ProfilePartialUpdateQueryResourceObjectAttributes.new})}) # ProfilePartialUpdateQuery | 
 
 begin
   # Update Profile

data/docs/RenderOptionsSubObject.md

@@ -7,7 +7,7 @@
 | **shorten_links** | **Boolean** |  | [optional][default to true] |
 | **add_org_prefix** | **Boolean** |  | [optional][default to true] |
 | **add_info_link** | **Boolean** |  | [optional][default to true] |
-| **add_opt_out_language** | **Boolean** |  | [optional] |
+| **add_opt_out_language** | **Boolean** |  | [optional][default to false] |
 
 ## Example
 

data/docs/SMSSubscriptionParameters.md

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