klaviyo-api-sdk 1.0.0 → 1.1.0

data/docs/ProfilesApi.md

@@ -23,7 +23,7 @@ All URIs are relative to *https://a.klaviyo.com*
 
 Create Profile
 
-Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `Profiles Write`
+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`
 
 ### Examples
 
@@ -94,7 +94,7 @@ end
 
 Get Profile
 
-Get the profile with the given profile ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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. 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`
 
 ### Examples
 
@@ -112,10 +112,10 @@ 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/v2022-10-17/reference/api-overview#sparse-fieldsets
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
-  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
-  include: ['lists'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
+  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
 }
 
 begin
@@ -150,10 +150,10 @@ 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/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
-| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
-| **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | [optional] |
+| **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] |
 
 ### Return type
 
@@ -193,7 +193,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/v2022-10-17/reference/api-overview#sparse-fieldsets
+  fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -228,7 +228,7 @@ 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/v2022-10-17/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-01-24/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -250,7 +250,7 @@ end
 
 Get Profile Relationships
 
-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:** `Profiles Read` `Segments Read`
+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`
 
 ### Examples
 
@@ -341,7 +341,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/v2022-10-17/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
 }
 
 begin
@@ -376,7 +376,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/v2022-10-17/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] |
 
 ### Return type
 
@@ -398,7 +398,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` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 20 profiles per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Profiles Write`
+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`
 
 ### Examples
 
@@ -415,10 +415,10 @@ end
 
 api_instance = KlaviyoAPI::ProfilesApi.new
 opts = {
-  fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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`<br>`updated`: `greater-than`, `less-than`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
-  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
+  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
 }
 
 begin
@@ -452,10 +452,10 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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;&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/v2022-10-17/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [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] |
+| **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] |
 
 ### Return type
 
@@ -477,7 +477,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/v2022-10-17/reference/create_list_relationships).<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). 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
 
@@ -547,7 +547,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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `Profiles Write` `Subscriptions Write`
+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`
 
 ### Examples
 
@@ -617,7 +617,7 @@ nil (empty response body)
 
 Unsubscribe Profiles
 
-Unsubscribe one or more profiles to email marketing, SMS marketing, or both. To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_list_relationships).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `List Write` `Profiles Write` `Subscriptions Write`
+Unsubscribe one or more profiles to email marketing, SMS marketing, or both. 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:** `List Write` `Profiles Write` `Subscriptions Write`
 
 ### Examples
 
@@ -633,7 +633,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({list_id: 'list_id_example'})})}) # 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::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.
 
 begin
   # Unsubscribe Profiles
@@ -687,7 +687,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.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `Subscriptions Write`
+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`
 
 ### Examples
 
@@ -703,7 +703,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::SuppressionCreateJobCreateQueryAsSubResourceAttributes.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::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.
 
 begin
   # Unsuppress Profiles
@@ -757,7 +757,7 @@ nil (empty response body)
 
 Update Profile
 
-Update the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `Profiles Write`
+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`
 
 ### Examples
 

data/docs/SegmentsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**get_segment**](SegmentsApi.md#get_segment) | **GET** /api/segments/{id}/ | Get Segment |
 | [**get_segment_profiles**](SegmentsApi.md#get_segment_profiles) | **GET** /api/segments/{segment_id}/profiles/ | Get Segment Profiles |
 | [**get_segment_relationships**](SegmentsApi.md#get_segment_relationships) | **GET** /api/segments/{id}/relationships/{related_resource}/ | Get Segment Relationships |
+| [**get_segment_tags**](SegmentsApi.md#get_segment_tags) | **GET** /api/segments/{segment_id}/tags/ | Get Segment Tags |
 | [**get_segments**](SegmentsApi.md#get_segments) | **GET** /api/segments/ | Get Segments |
 | [**update_segment**](SegmentsApi.md#update_segment) | **PATCH** /api/segments/{id}/ | Update Segment |
 
@@ -35,7 +36,7 @@ end
 api_instance = KlaviyoAPI::SegmentsApi.new
 id = 'id_example' # String | 
 opts = {
-  fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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
 }
 
 begin
@@ -70,7 +71,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/v2022-10-17/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] |
 
 ### Return type
 
@@ -88,11 +89,11 @@ end
 
 ## get_segment_profiles
 
-> get_segment_profiles(segment_id, opts)
+> Hash&lt;String, Object&gt; get_segment_profiles(segment_id, opts)
 
 Get Segment Profiles
 
-Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Profiles Read` `Segments Read`
+Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. 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` `Segments Read`
 
 ### Examples
 
@@ -110,13 +111,15 @@ end
 api_instance = KlaviyoAPI::SegmentsApi.new
 segment_id = 'segment_id_example' # String | 
 opts = {
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
+  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>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
 }
 
 begin
   # Get Segment Profiles
-  api_instance.get_segment_profiles(segment_id, opts)
+  result = api_instance.get_segment_profiles(segment_id, opts)
+  p result
 rescue KlaviyoAPI::ApiError => e
   puts "Error when calling SegmentsApi->get_segment_profiles: #{e}"
 end
@@ -124,9 +127,9 @@ end
 
 #### Using the get_segment_profiles_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_segment_profiles_with_http_info(segment_id, opts)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segment_profiles_with_http_info(segment_id, opts)
 
 ```ruby
 begin
@@ -134,7 +137,7 @@ begin
   data, status_code, headers = api_instance.get_segment_profiles_with_http_info(segment_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => Hash&lt;String, Object&gt;
 rescue KlaviyoAPI::ApiError => e
   puts "Error when calling SegmentsApi->get_segment_profiles_with_http_info: #{e}"
 end
@@ -145,12 +148,13 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **segment_id** | **String** |  |  |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [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] |
+| **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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
 
 ### Return type
 
-nil (empty response body)
+**Hash&lt;String, Object&gt;**
 
 ### Authorization
 
@@ -168,7 +172,7 @@ nil (empty response body)
 
 Get Segment Relationships
 
-Get all profile membership [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for the given segment ID. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Profiles Read` `Segments Read`
+Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID. 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` `Segments Read`
 
 ### Examples
 
@@ -187,7 +191,7 @@ api_instance = KlaviyoAPI::SegmentsApi.new
 id = 'id_example' # String | 
 related_resource = 'profiles' # String | 
 opts = {
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
 }
 
 begin
@@ -223,7 +227,82 @@ end
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
 | **related_resource** | **String** |  |  |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [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_segment_tags
+
+> Hash&lt;String, Object&gt; get_segment_tags(segment_id, opts)
+
+Get Segment Tags
+
+Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Segments Read` `Tags 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::SegmentsApi.new
+segment_id = 'segment_id_example' # String | 
+opts = {
+  fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
+}
+
+begin
+  # Get Segment Tags
+  result = api_instance.get_segment_tags(segment_id, opts)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling SegmentsApi->get_segment_tags: #{e}"
+end
+```
+
+#### Using the get_segment_tags_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_segment_tags_with_http_info(segment_id, opts)
+
+```ruby
+begin
+  # Get Segment Tags
+  data, status_code, headers = api_instance.get_segment_tags_with_http_info(segment_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling SegmentsApi->get_segment_tags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **segment_id** | **String** |  |  |
+| **fields_tag** | [**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] |
 
 ### Return type
 
@@ -245,7 +324,7 @@ end
 
 Get Segments
 
-Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Segments Read`
+Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Segments Read`
 
 ### Examples
 
@@ -262,9 +341,9 @@ end
 
 api_instance = KlaviyoAPI::SegmentsApi.new
 opts = {
-  fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
-  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
+  fields_segment: ['name'], # 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>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
 }
 
 begin
@@ -298,9 +377,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [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] |
+| **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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
 
 ### Return type
 

data/docs/SendOptionsSubObject.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::SendOptionsSubObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **use_smart_sending** | **Boolean** | Use smart sending. Defaults to True | [optional] |
+| **ignore_unsubscribes** | **Boolean** | Ignore unsubscribes. Defaults to False | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SendOptionsSubObject.new(
+  use_smart_sending: null,
+  ignore_unsubscribes: null
+)
+```
+

data/docs/SendStrategySubObject.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::SendStrategySubObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | **String** | Describes the shape of the options object. Allowed values: ['static', 'throttled', 'immediate'] |  |
+| **options_static** | [**StaticScheduleOptions**](StaticScheduleOptions.md) |  | [optional] |
+| **options_throttled** | [**ThrottledScheduleOptions**](ThrottledScheduleOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SendStrategySubObject.new(
+  method: static,
+  options_static: null,
+  options_throttled: null
+)
+```
+

data/docs/SendTimeSubObject.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::SendTimeSubObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datetime** | **Time** | The datetime that the message is to be sent |  |
+| **is_local** | **Boolean** | Whether that datetime is to be a local datetime for the recipient |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::SendTimeSubObject.new(
+  datetime: null,
+  is_local: null
+)
+```
+

data/docs/StaticScheduleOptions.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::StaticScheduleOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datetime** | **Time** | The time to send at |  |
+| **is_local** | **Boolean** | If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False. | [optional] |
+| **send_past_recipients_immediately** | **Boolean** | Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False. | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::StaticScheduleOptions.new(
+  datetime: null,
+  is_local: null,
+  send_past_recipients_immediately: null
+)
+```
+

data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  |  |
-| **custom_source** | **String** |  | [optional] |
-| **subscriptions** | [**Array<Subscription>**](Subscription.md) |  |  |
+| **list_id** | **String** | The list to add the newly subscribed profiles to |  |
+| **custom_source** | **String** | A custom method detail or source to store on the consent records. | [optional] |
+| **subscriptions** | [**Array<Subscription>**](Subscription.md) | One or more subscriptions to be created. |  |
 
 ## Example
 

data/docs/Suppression.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  |  |
+| **email** | **String** | The email of the profile to suppress / unsuppress. |  |
 
 ## Example
 

data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **suppressions** | [**Array<Suppression>**](Suppression.md) |  |  |
+| **suppressions** | [**Array<Suppression>**](Suppression.md) | One or more suppressions to be created. |  |
 
 ## Example
 

data/docs/TagCreateQuery.md

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

data/docs/TagCreateQueryAsSubResource.md

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

data/docs/TagCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::TagCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The Tag name |  |
+| **tag_group_id** | **String** | The ID of the Tag Group to associate the Tag with. If this field is not specified, the Tag will be associated with the company's Default Tag Group. | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::TagCreateQueryAsSubResourceAttributes.new(
+  name: My Tag,
+  tag_group_id: zyxw9876-vu54-ts32-rq10-zyxwvu654321
+)
+```
+