klaviyo-api-sdk 1.1.0 → 2.0.0

data/docs/ProfilesApi.md

@@ -7,7 +7,8 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**create_profile**](ProfilesApi.md#create_profile) | **POST** /api/profiles/ | Create Profile |
 | [**get_profile**](ProfilesApi.md#get_profile) | **GET** /api/profiles/{id}/ | Get Profile |
 | [**get_profile_lists**](ProfilesApi.md#get_profile_lists) | **GET** /api/profiles/{profile_id}/lists/ | Get Profile Lists |
-| [**get_profile_relationships**](ProfilesApi.md#get_profile_relationships) | **GET** /api/profiles/{id}/relationships/{related_resource}/ | Get Profile Relationships |
+| [**get_profile_relationships_lists**](ProfilesApi.md#get_profile_relationships_lists) | **GET** /api/profiles/{id}/relationships/lists/ | Get Profile Relationships Lists |
+| [**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/{profile_id}/segments/ | Get Profile Segments |
 | [**get_profiles**](ProfilesApi.md#get_profiles) | **GET** /api/profiles/ | Get Profiles |
 | [**subscribe_profiles**](ProfilesApi.md#subscribe_profiles) | **POST** /api/profile-subscription-bulk-create-jobs/ | Subscribe Profiles |
@@ -19,7 +20,7 @@ All URIs are relative to *https://a.klaviyo.com*
 
 ## create_profile
 
-> Hash<String, Object> create_profile(profile_create_query)
+> Hash<String, Object> create_profile(profile_create_query, opts)
 
 Create Profile
 
@@ -39,11 +40,14 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-profile_create_query = KlaviyoAPI::ProfileCreateQuery.new({data: KlaviyoAPI::ProfileCreateQueryAsSubResource.new({type: 'profile', attributes: KlaviyoAPI::ProfileCreateQueryAsSubResourceAttributes.new})}) # ProfileCreateQuery | 
+profile_create_query = KlaviyoAPI::ProfileCreateQuery.new({data: KlaviyoAPI::ProfileCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::ProfileCreateQueryResourceObjectAttributes.new})}) # ProfileCreateQuery | 
+opts = {
+  additional_fields_profile: ['predictive_analytics'] # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
+}
 
 begin
   # Create Profile
-  result = api_instance.create_profile(profile_create_query)
+  result = api_instance.create_profile(profile_create_query, opts)
   p result
 rescue KlaviyoAPI::ApiError => e
   puts "Error when calling ProfilesApi->create_profile: #{e}"
@@ -54,12 +58,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_profile_with_http_info(profile_create_query)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_profile_with_http_info(profile_create_query, opts)
 
 ```ruby
 begin
   # Create Profile
-  data, status_code, headers = api_instance.create_profile_with_http_info(profile_create_query)
+  data, status_code, headers = api_instance.create_profile_with_http_info(profile_create_query, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
@@ -73,6 +77,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **profile_create_query** | [**ProfileCreateQuery**](ProfileCreateQuery.md) |  |  |
+| **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] |
 
 ### Return type
 
@@ -94,7 +99,7 @@ end
 
 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: `3/s`<br>Steady: `60/m`  **Scopes:** `Profiles Read`
+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`
 
 ### Examples
 
@@ -112,10 +117,11 @@ 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-01-24/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
+  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-02-22/reference/api-overview#sparse-fieldsets
+  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
+  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
 }
 
 begin
@@ -150,10 +156,11 @@ 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-01-24/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-01-24/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-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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;predictive_analytics&#39; | [optional] |
+| **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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-02-22/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-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
 
 ### Return type
 
@@ -193,7 +200,7 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 profile_id = 'profile_id_example' # String | 
 opts = {
-  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
+  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -228,7 +235,78 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **profile_id** | **String** |  |  |
-| **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_profile_relationships_lists
+
+> Hash&lt;String, Object&gt; get_profile_relationships_lists(id)
+
+Get Profile Relationships Lists
+
+Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `List Read` `Profiles Read`
+
+### 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
+id = 'id_example' # String | 
+
+begin
+  # Get Profile Relationships Lists
+  result = api_instance.get_profile_relationships_lists(id)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ProfilesApi->get_profile_relationships_lists: #{e}"
+end
+```
+
+#### Using the get_profile_relationships_lists_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_profile_relationships_lists_with_http_info(id)
+
+```ruby
+begin
+  # Get Profile Relationships Lists
+  data, status_code, headers = api_instance.get_profile_relationships_lists_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ProfilesApi->get_profile_relationships_lists_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
 
 ### Return type
 
@@ -244,13 +322,13 @@ end
 - **Accept**: application/json
 
 
-## get_profile_relationships
+## get_profile_relationships_segments
 
-> Hash&lt;String, Object&gt; get_profile_relationships(id, related_resource)
+> Hash&lt;String, Object&gt; get_profile_relationships_segments(id)
 
-Get Profile Relationships
+Get Profile Relationships Segments
 
-Get list membership or segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Lists Read` `Profiles Read` `Segments Read`
+Get segment membership relationships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Profiles Read` `Segments Read`
 
 ### Examples
 
@@ -267,32 +345,31 @@ end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
 id = 'id_example' # String | 
-related_resource = 'lists' # String | 
 
 begin
-  # Get Profile Relationships
-  result = api_instance.get_profile_relationships(id, related_resource)
+  # Get Profile Relationships Segments
+  result = api_instance.get_profile_relationships_segments(id)
   p result
 rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ProfilesApi->get_profile_relationships: #{e}"
+  puts "Error when calling ProfilesApi->get_profile_relationships_segments: #{e}"
 end
 ```
 
-#### Using the get_profile_relationships_with_http_info variant
+#### Using the get_profile_relationships_segments_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_profile_relationships_with_http_info(id, related_resource)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_profile_relationships_segments_with_http_info(id)
 
 ```ruby
 begin
-  # Get Profile Relationships
-  data, status_code, headers = api_instance.get_profile_relationships_with_http_info(id, related_resource)
+  # Get Profile Relationships Segments
+  data, status_code, headers = api_instance.get_profile_relationships_segments_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
 rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ProfilesApi->get_profile_relationships_with_http_info: #{e}"
+  puts "Error when calling ProfilesApi->get_profile_relationships_segments_with_http_info: #{e}"
 end
 ```
 
@@ -301,7 +378,6 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **related_resource** | **String** |  |  |
 
 ### Return type
 
@@ -341,7 +417,7 @@ end
 api_instance = KlaviyoAPI::ProfilesApi.new
 profile_id = 'profile_id_example' # String | 
 opts = {
-  fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
+  fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -376,7 +452,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **profile_id** | **String** |  |  |
-| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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-02-22/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -398,7 +474,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`, `email` You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **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` You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Profiles Read`
 
 ### Examples
 
@@ -415,10 +491,12 @@ end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
 opts = {
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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>`anonymous_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
-  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
+  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-02-22/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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-02-22/reference/api-overview#pagination
+  sort: 'created', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
+  page_size: 56 # Integer | The number of results to return per page. Default = 20. Max = 100
 }
 
 begin
@@ -452,10 +530,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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;anonymous_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; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
+| **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-02-22/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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-02-22/reference/api-overview#pagination | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
+| **page_size** | **Integer** | The number of results to return per page. Default &#x3D; 20. Max &#x3D; 100 | [optional] |
 
 ### Return type
 
@@ -477,7 +557,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). Maximum number of profile can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `List Write` `Profiles Write` `Subscriptions Write`
+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 profile can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `List Write` `Profiles Write` `Subscriptions Write`
 
 ### Examples
 
@@ -493,7 +573,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-subscription_create_job_create_query = KlaviyoAPI::SubscriptionCreateJobCreateQuery.new({data: KlaviyoAPI::SubscriptionCreateJobCreateQueryAsSubResource.new({type: 'profile-subscription-bulk-create-job', attributes: KlaviyoAPI::SubscriptionCreateJobCreateQueryAsSubResourceAttributes.new({list_id: 'list_id_example', subscriptions: [KlaviyoAPI::Subscription.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({list_id: 'Y6nRLr', subscriptions: [KlaviyoAPI::Subscription.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.
 
 begin
   # Subscribe Profiles
@@ -547,7 +627,7 @@ nil (empty response body)
 
 Suppress Profiles
 
-Manually suppress one or more profiles. Manually suppressed profiles will not receive email marketing. 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 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 [in this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). 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`
 
 ### Examples
 
@@ -563,7 +643,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-suppression_create_job_create_query = KlaviyoAPI::SuppressionCreateJobCreateQuery.new({data: KlaviyoAPI::SuppressionCreateJobCreateQueryAsSubResource.new({type: 'profile-suppression-bulk-create-job', attributes: KlaviyoAPI::SuppressionCreateJobCreateQueryAsSubResourceAttributes.new({suppressions: [KlaviyoAPI::Suppression.new({email: 'email_example'})]})})}) # 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({suppressions: [KlaviyoAPI::Suppression.new({email: 'matt-kemp@klaviyo-demo.com'})]})})}) # 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
@@ -633,7 +713,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-unsubscription_create_job_create_query = KlaviyoAPI::UnsubscriptionCreateJobCreateQuery.new({data: KlaviyoAPI::UnsubscriptionCreateJobCreateQueryAsSubResource.new({type: 'profile-unsubscription-bulk-create-job', attributes: KlaviyoAPI::UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.new})}) # UnsubscriptionCreateJobCreateQuery | Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
+unsubscription_create_job_create_query = KlaviyoAPI::UnsubscriptionCreateJobCreateQuery.new({data: KlaviyoAPI::UnsubscriptionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileUnsubscriptionBulkCreateJobEnum::PROFILE_UNSUBSCRIPTION_BULK_CREATE_JOB, attributes: KlaviyoAPI::UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.new})}) # UnsubscriptionCreateJobCreateQuery | Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
 
 begin
   # Unsubscribe Profiles
@@ -687,7 +767,7 @@ nil (empty response body)
 
 Unsuppress Profiles
 
-Unsuppress one or more profiles. Unsuppressed profiles will receive email marketing. Not supported for SMS marketing. Profiles suppressed due to a hard bounced email will not be unsuppressed. 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`
+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, 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`
 
 ### Examples
 
@@ -703,7 +783,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-unsuppression_create_job_create_query = KlaviyoAPI::UnsuppressionCreateJobCreateQuery.new({data: KlaviyoAPI::UnsuppressionCreateJobCreateQueryAsSubResource.new({type: 'profile-unsuppression-bulk-create-job', attributes: KlaviyoAPI::UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.new({suppressions: [KlaviyoAPI::Suppression.new({email: 'email_example'})]})})}) # UnsuppressionCreateJobCreateQuery | 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.
+unsuppression_create_job_create_query = KlaviyoAPI::UnsuppressionCreateJobCreateQuery.new({data: KlaviyoAPI::UnsuppressionCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::ProfileUnsuppressionBulkCreateJobEnum::PROFILE_UNSUPPRESSION_BULK_CREATE_JOB, attributes: KlaviyoAPI::UnsuppressionCreateJobCreateQueryResourceObjectAttributes.new({suppressions: [KlaviyoAPI::Suppression.new({email: 'matt-kemp@klaviyo-demo.com'})]})})}) # UnsuppressionCreateJobCreateQuery | 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
@@ -753,7 +833,7 @@ nil (empty response body)
 
 ## update_profile
 
-> Hash&lt;String, Object&gt; update_profile(id, profile_partial_update_query)
+> Hash&lt;String, Object&gt; update_profile(id, profile_partial_update_query, opts)
 
 Update Profile
 
@@ -773,12 +853,15 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
-id = 'id_example' # String | 
-profile_partial_update_query = KlaviyoAPI::ProfilePartialUpdateQuery.new({data: KlaviyoAPI::ProfilePartialUpdateQueryAsSubResource.new({type: 'profile', id: 'id_example', attributes: KlaviyoAPI::ProfileCreateQueryAsSubResourceAttributes.new})}) # ProfilePartialUpdateQuery | 
+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 | 
+opts = {
+  additional_fields_profile: ['predictive_analytics'] # Array<String> | Request additional fields not included by default in the response. Supported values: 'predictive_analytics'
+}
 
 begin
   # Update Profile
-  result = api_instance.update_profile(id, profile_partial_update_query)
+  result = api_instance.update_profile(id, profile_partial_update_query, opts)
   p result
 rescue KlaviyoAPI::ApiError => e
   puts "Error when calling ProfilesApi->update_profile: #{e}"
@@ -789,12 +872,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_profile_with_http_info(id, profile_partial_update_query)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_profile_with_http_info(id, profile_partial_update_query, opts)
 
 ```ruby
 begin
   # Update Profile
-  data, status_code, headers = api_instance.update_profile_with_http_info(id, profile_partial_update_query)
+  data, status_code, headers = api_instance.update_profile_with_http_info(id, profile_partial_update_query, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
@@ -807,8 +890,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. |  |
 | **profile_partial_update_query** | [**ProfilePartialUpdateQuery**](ProfilePartialUpdateQuery.md) |  |  |
+| **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] |
 
 ### Return type
 

data/docs/SMSChannel.md

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

data/docs/SMSMarketing.md

@@ -0,0 +1,24 @@
+# KlaviyoAPI::SMSMarketing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consent** | **String** | The consent status for SMS marketing. |  |
+| **timestamp** | **Time** | The timestamp when consent record or updated for SMS marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). |  |
+| **method** | **String** | The method by which the profile was subscribed to SMS marketing. |  |
+| **method_detail** | **String** | Additional details about the method which the profile was subscribed to SMS marketing. This may be empty if no details were provided. |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SMSMarketing.new(
+  consent: SUBSCRIBED,
+  timestamp: 2023-02-21T20:07:38Z,
+  method: TEXT,
+  method_detail: JOIN
+)
+```
+

data/docs/STOScheduleOptions.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::STOScheduleOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The day to send on |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::STOScheduleOptions.new(
+  date: null
+)
+```
+

data/docs/SegmentEnum.md

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

data/docs/SegmentPartialUpdateQuery.md

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

data/docs/SegmentPartialUpdateQueryResourceObject.md

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

data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::SegmentPartialUpdateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SegmentPartialUpdateQueryResourceObjectAttributes.new(
+  name: null
+)
+```
+