klaviyo-api-sdk 5.1.0 → 7.0.0

data/docs/ProfilesApi.md

@@ -4,10 +4,11 @@ All URIs are relative to *https://a.klaviyo.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_or_update_profile**](ProfilesApi.md#create_or_update_profile) | **POST** /api/profile-import/ | Create or Update Profile |
 | [**create_profile**](ProfilesApi.md#create_profile) | **POST** /api/profiles/ | Create Profile |
 | [**create_push_token**](ProfilesApi.md#create_push_token) | **POST** /api/push-tokens/ | Create or Update Push Token |
 | [**get_bulk_profile_import_job**](ProfilesApi.md#get_bulk_profile_import_job) | **GET** /api/profile-bulk-import-jobs/{job_id}/ | Get Bulk Profile Import Job |
-| [**get_bulk_profile_import_job_import_errors**](ProfilesApi.md#get_bulk_profile_import_job_import_errors) | **GET** /api/profile-bulk-import-jobs/{id}/import-errors/ | Get Bulk Profile Import Job Import Errors |
+| [**get_bulk_profile_import_job_import_errors**](ProfilesApi.md#get_bulk_profile_import_job_import_errors) | **GET** /api/profile-bulk-import-jobs/{id}/import-errors/ | Get Bulk Profile Import Job Errors |
 | [**get_bulk_profile_import_job_lists**](ProfilesApi.md#get_bulk_profile_import_job_lists) | **GET** /api/profile-bulk-import-jobs/{id}/lists/ | Get Bulk Profile Import Job Lists |
 | [**get_bulk_profile_import_job_profiles**](ProfilesApi.md#get_bulk_profile_import_job_profiles) | **GET** /api/profile-bulk-import-jobs/{id}/profiles/ | Get Bulk Profile Import Job Profiles |
 | [**get_bulk_profile_import_job_relationships_lists**](ProfilesApi.md#get_bulk_profile_import_job_relationships_lists) | **GET** /api/profile-bulk-import-jobs/{id}/relationships/lists/ | Get Bulk Profile Import Job Relationships Lists |
@@ -28,13 +29,84 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**update_profile**](ProfilesApi.md#update_profile) | **PATCH** /api/profiles/{id}/ | Update Profile |
 
 
+## create_or_update_profile
+
+> Hash<String, Object> create_or_update_profile(profile_upsert_query)
+
+Create or Update Profile
+
+Given a set of profile attributes and optionally an ID, create or update a profile.  Returns 201 if a new profile was created, 200 if an existing profile was updated.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/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_upsert_query = KlaviyoAPI::ProfileUpsertQuery.new({data: KlaviyoAPI::ProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new})}) # ProfileUpsertQuery | 
+
+begin
+  # Create or Update Profile
+  result = api_instance.create_or_update_profile(profile_upsert_query)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ProfilesApi->create_or_update_profile: #{e}"
+end
+```
+
+#### Using the create_or_update_profile_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_or_update_profile_with_http_info(profile_upsert_query)
+
+```ruby
+begin
+  # Create or Update Profile
+  data, status_code, headers = api_instance.create_or_update_profile_with_http_info(profile_upsert_query)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ProfilesApi->create_or_update_profile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_upsert_query** | [**ProfileUpsertQuery**](ProfileUpsertQuery.md) |  |  |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_profile
 
 > Hash&lt;String, Object&gt; create_profile(profile_create_query)
 
 Create Profile
 
-Create a new profile.  If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write`
+Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write`
 
 ### Examples
 
@@ -121,7 +193,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-push_token_create_query = KlaviyoAPI::PushTokenCreateQuery.new({data: KlaviyoAPI::PushTokenCreateQueryResourceObject.new({type: KlaviyoAPI::PushTokenEnum::PUSH_TOKEN, attributes: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributes.new({token: '1234567890', platform: 'android', vendor: 'apns', profile: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributesProfile.new({data: KlaviyoAPI::ProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes.new})})})})}) # PushTokenCreateQuery | 
+push_token_create_query = KlaviyoAPI::PushTokenCreateQuery.new({data: KlaviyoAPI::PushTokenCreateQueryResourceObject.new({type: KlaviyoAPI::PushTokenEnum::PUSH_TOKEN, attributes: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributes.new({token: '1234567890', platform: 'android', vendor: 'apns', profile: KlaviyoAPI::PushTokenCreateQueryResourceObjectAttributesProfile.new({data: KlaviyoAPI::PushProfileUpsertQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::PushProfileUpsertQueryResourceObjectAttributes.new})})})})}) # PushTokenCreateQuery | 
 
 begin
   # Create or Update Push Token
@@ -193,9 +265,9 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
 opts = {
-  fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
-  fields_profile_bulk_import_job: ['status'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
-  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
+  fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_profile_bulk_import_job: ['status'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
 }
 
 begin
@@ -230,9 +302,9 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **job_id** | **String** | ID of the job to retrieve. |  |
-| **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_profile_bulk_import_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-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-12-15/reference/api-overview#relationships | [optional] |
+| **fields_list** | [**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_profile_bulk_import_job** | [**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] |
 
 ### Return type
 
@@ -252,7 +324,7 @@ end
 
 > Hash&lt;String, Object&gt; get_bulk_profile_import_job_import_errors(id, opts)
 
-Get Bulk Profile Import Job Import Errors
+Get Bulk Profile Import Job Errors
 
 Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `profiles:read`
 
@@ -272,13 +344,13 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 id = 'id_example' # String | 
 opts = {
-  fields_import_error: ['code'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
+  fields_import_error: ['code'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
   page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
 }
 
 begin
-  # Get Bulk Profile Import Job Import Errors
+  # Get Bulk Profile Import Job Errors
   result = api_instance.get_bulk_profile_import_job_import_errors(id, opts)
   p result
 rescue KlaviyoAPI::ApiError => e
@@ -294,7 +366,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get Bulk Profile Import Job Import Errors
+  # Get Bulk Profile Import Job Errors
   data, status_code, headers = api_instance.get_bulk_profile_import_job_import_errors_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -309,8 +381,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **fields_import_error** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
+| **fields_import_error** | [**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] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination | [optional] |
 | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
 
 ### Return type
@@ -351,7 +423,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-12-15/reference/api-overview#sparse-fieldsets
+  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -386,7 +458,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-12-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/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -427,8 +499,8 @@ api_instance = KlaviyoAPI::ProfilesApi.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/v2023-12-15/reference/api-overview#sparse-fieldsets
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
   page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
 }
 
@@ -465,8 +537,8 @@ 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/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-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-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination | [optional] |
 | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
 
 ### Return type
@@ -578,7 +650,7 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 id = 'id_example' # String | 
 opts = {
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
   page_size: 56 # Integer | Default: 20. Min: 1. Max: 100.
 }
 
@@ -614,7 +686,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination | [optional] |
 | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
 
 ### Return type
@@ -654,11 +726,11 @@ end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
 opts = {
-  fields_profile_bulk_import_job: ['status'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
+  fields_profile_bulk_import_job: ['status'], # 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>`status`: `any`, `equals`
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
   page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
-  sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
+  sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
 }
 
 begin
@@ -692,11 +764,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_profile_bulk_import_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
+| **fields_profile_bulk_import_job** | [**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;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-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-12-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 
@@ -737,10 +809,10 @@ api_instance = KlaviyoAPI::ProfilesApi.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_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
-  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
-  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
+  fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
 }
 
 begin
@@ -776,10 +848,10 @@ 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_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-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-12-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-12-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-12-15/reference/api-overview#relationships | [optional] |
+| **fields_list** | [**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_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] |
+| **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] |
+| **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] |
 
 ### Return type
 
@@ -819,7 +891,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-12-15/reference/api-overview#sparse-fieldsets
+  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -854,7 +926,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-12-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/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -1036,7 +1108,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-12-15/reference/api-overview#sparse-fieldsets
+  fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -1071,7 +1143,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-12-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/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -1093,7 +1165,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`, `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-12-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/v2024-05-15/docs/rate_limits_and_error_handling) guide.  **Scopes:** `profiles:read`
 
 ### Examples
 
@@ -1111,11 +1183,11 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 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/v2023-12-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-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-12-15/reference/api-overview#pagination
+  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>`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/v2024-05-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-12-15/reference/api-overview#sorting
+  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
 }
 
 begin
@@ -1150,11 +1222,11 @@ 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;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-12-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-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-12-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-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;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/v2024-05-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-12-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 
@@ -1192,7 +1264,7 @@ KlaviyoAPI.configure do |config|
 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 | 
+profile_merge_query = KlaviyoAPI::ProfileMergeQuery.new({data: KlaviyoAPI::ProfileMergeQueryResourceObject.new({type: KlaviyoAPI::ProfileMergeEnum::PROFILE_MERGE, id: '01GDDKASAP8TKDDA2GRZDSVP4H'})}) # ProfileMergeQuery | 
 
 begin
   # Merge Profiles
@@ -1247,7 +1319,7 @@ end
 
 Spawn Bulk Profile Import Job
 
-*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `lists:write` `profiles:write`
+Create a bulk profile import job to create or update a batch of profiles.  Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB.  To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `lists:write` `profiles:write`
 
 ### Examples
 
@@ -1318,7 +1390,7 @@ end
 
 Subscribe Profiles
 
-Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.  To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships).  This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1).  Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
+Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).  If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys).  To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships).  This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1).  Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
 
 ### Examples
 
@@ -1388,7 +1460,7 @@ nil (empty response body)
 
 Suppress Profiles
 
-Manually suppress one or more profiles. Such profiles will have `USER_SUPPRESSED` as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Learn about [collecting consent and best practices](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).  Not supported for SMS marketing.  Maximum number of profile can be submitted for suppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write` `subscriptions:write`
+Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members.  Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).  Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write` `subscriptions:write`
 
 ### Examples
 
@@ -1404,7 +1476,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-suppression_create_job_create_query = KlaviyoAPI::SuppressionCreateJobCreateQuery.new({data: KlaviyoAPI::SuppressionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSuppressionBulkCreateJobEnum::PROFILE_SUPPRESSION_BULK_CREATE_JOB, attributes: KlaviyoAPI::SuppressionCreateJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::SuppressionCreateJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileSuppressionCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileSuppressionCreateQueryResourceObjectAttributes.new})]})})})}) # SuppressionCreateJobCreateQuery | Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
+suppression_create_job_create_query = KlaviyoAPI::SuppressionCreateJobCreateQuery.new({data: KlaviyoAPI::SuppressionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSuppressionBulkCreateJobEnum::PROFILE_SUPPRESSION_BULK_CREATE_JOB, attributes: KlaviyoAPI::SuppressionCreateJobCreateQueryResourceObjectAttributes.new})}) # SuppressionCreateJobCreateQuery | Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
 
 begin
   # Suppress Profiles
@@ -1458,7 +1530,7 @@ nil (empty response body)
 
 Unsubscribe Profiles
 
-Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).  To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships).  Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
+Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).  To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships).  Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
 
 ### Examples
 
@@ -1528,7 +1600,7 @@ nil (empty response body)
 
 Unsuppress Profiles
 
-Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api), i.e. unsubscribed.  Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. `UNSUBSCRIBE` and `SPAM_REPORT` suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). `INVALID_EMAIL` and `HARD_BOUNCE` suppressions cannot be removed by the API.  Maximum number of profile can be submitted for unsuppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `subscriptions:write`
+Manually unsuppress profiles using their email address, or by specifying a segment or list ID to unsuppress all current members.  This only removes suppressions with reason `USER_SUPPRESSED`, leaving unsubscribed profiles and profiles suppressed with reason `INVALID_EMAIL` or `HARD_BOUNCE` unchanged. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).  Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `subscriptions:write`
 
 ### Examples
 
@@ -1544,7 +1616,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-suppression_delete_job_create_query = KlaviyoAPI::SuppressionDeleteJobCreateQuery.new({data: KlaviyoAPI::SuppressionDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSuppressionBulkDeleteJobEnum::PROFILE_SUPPRESSION_BULK_DELETE_JOB, attributes: KlaviyoAPI::SuppressionDeleteJobCreateQueryResourceObjectAttributes.new({profiles: KlaviyoAPI::SuppressionDeleteJobCreateQueryResourceObjectAttributesProfiles.new({data: [KlaviyoAPI::ProfileSuppressionDeleteQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileSuppressionDeleteQueryResourceObjectAttributes.new})]})})})}) # SuppressionDeleteJobCreateQuery | Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
+suppression_delete_job_create_query = KlaviyoAPI::SuppressionDeleteJobCreateQuery.new({data: KlaviyoAPI::SuppressionDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileSuppressionBulkDeleteJobEnum::PROFILE_SUPPRESSION_BULK_DELETE_JOB, attributes: KlaviyoAPI::SuppressionDeleteJobCreateQueryResourceObjectAttributes.new})}) # SuppressionDeleteJobCreateQuery | Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
 
 begin
   # Unsuppress Profiles
@@ -1598,7 +1670,7 @@ nil (empty response body)
 
 Update Profile
 
-Update the profile with the given profile ID.  If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write`
+Update the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write`
 
 ### Examples
 

data/docs/PushProfileUpsertQueryResourceObject.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::PushProfileUpsertQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ProfileEnum**](ProfileEnum.md) |  |  |
+| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | [optional] |
+| **attributes** | [**PushProfileUpsertQueryResourceObjectAttributes**](PushProfileUpsertQueryResourceObjectAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::PushProfileUpsertQueryResourceObject.new(
+  type: null,
+  id: null,
+  attributes: null
+)
+```
+

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