klaviyo-api-sdk 1.0.0 → 1.1.0

data/docs/ListsApi.md

@@ -10,7 +10,8 @@ All URIs are relative to *https://a.klaviyo.com*
 | [**delete_list_relationships**](ListsApi.md#delete_list_relationships) | **DELETE** /api/lists/{id}/relationships/{related_resource}/ | Remove Profile from List |
 | [**get_list**](ListsApi.md#get_list) | **GET** /api/lists/{id}/ | Get List |
 | [**get_list_profiles**](ListsApi.md#get_list_profiles) | **GET** /api/lists/{list_id}/profiles/ | Get List Profiles |
-| [**get_list_relationships**](ListsApi.md#get_list_relationships) | **GET** /api/lists/{id}/relationships/{related_resource}/ | Get List Profile Relationships |
+| [**get_list_relationships**](ListsApi.md#get_list_relationships) | **GET** /api/lists/{id}/relationships/{related_resource}/ | Get List Relationships |
+| [**get_list_tags**](ListsApi.md#get_list_tags) | **GET** /api/lists/{list_id}/tags/ | Get List Tags |
 | [**get_lists**](ListsApi.md#get_lists) | **GET** /api/lists/ | Get Lists |
 | [**update_list**](ListsApi.md#update_list) | **PATCH** /api/lists/{id}/ | Update List |
 
@@ -92,7 +93,7 @@ end
 
 Add Profile to List
 
-Add a profile to a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Write` `Profiles Write`
+Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Write` `Profiles Write`
 
 ### Examples
 
@@ -236,7 +237,7 @@ nil (empty response body)
 
 Remove Profile from List
 
-Remove a profile from a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Write` `Profiles Write`
+Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile's consent status or subscription status in general. To update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `List Write` `Profiles Write`
 
 ### Examples
 
@@ -328,7 +329,7 @@ end
 api_instance = KlaviyoAPI::ListsApi.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_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -363,7 +364,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/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
 
@@ -385,7 +386,7 @@ end
 
 Get List Profiles
 
-Get all profiles within a list with the given list ID. Use filters to narrow your results. 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:** `List Read` `Profiles Read`
+Get all profiles within a list with the given list 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:** `List Read` `Profiles Read`
 
 ### Examples
 
@@ -403,9 +404,9 @@ end
 api_instance = KlaviyoAPI::ListsApi.new
 list_id = 'list_id_example' # String | 
 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>`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
@@ -440,9 +441,9 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **list_id** | **String** |  |  |
-| **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;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
 
@@ -462,9 +463,9 @@ end
 
 > Hash&lt;String, Object&gt; get_list_relationships(id, related_resource, opts)
 
-Get List Profile Relationships
+Get List Relationships
 
-Get profile membership [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a list with the given list 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:** `List Read` `Profiles Read`
+Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list 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:** `List Read` `Profiles Read`
 
 ### Examples
 
@@ -483,11 +484,11 @@ api_instance = KlaviyoAPI::ListsApi.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
-  # Get List Profile Relationships
+  # Get List Relationships
   result = api_instance.get_list_relationships(id, related_resource, opts)
   p result
 rescue KlaviyoAPI::ApiError => e
@@ -503,7 +504,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get List Profile Relationships
+  # Get List Relationships
   data, status_code, headers = api_instance.get_list_relationships_with_http_info(id, related_resource, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -519,7 +520,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_list_tags
+
+> Hash&lt;String, Object&gt; get_list_tags(list_id, opts)
+
+Get List Tags
+
+Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `List 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::ListsApi.new
+list_id = 'list_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 List Tags
+  result = api_instance.get_list_tags(list_id, opts)
+  p result
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ListsApi->get_list_tags: #{e}"
+end
+```
+
+#### Using the get_list_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_list_tags_with_http_info(list_id, opts)
+
+```ruby
+begin
+  # Get List Tags
+  data, status_code, headers = api_instance.get_list_tags_with_http_info(list_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue KlaviyoAPI::ApiError => e
+  puts "Error when calling ListsApi->get_list_tags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **list_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
 
@@ -541,7 +617,7 @@ end
 
 Get Lists
 
-Get all lists in an account. Use filters to narrow your results. 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:** `List Read`
+Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `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:** `List Read`
 
 ### Examples
 
@@ -558,9 +634,9 @@ end
 
 api_instance = KlaviyoAPI::ListsApi.new
 opts = {
-  fields_list: ['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_list: ['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
@@ -594,9 +670,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
-| **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_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] |
+| **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/MetricAggregateQueryAsSubResourceAttributes.md

@@ -4,14 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **metric_id** | **String** |  |  |
-| **measurements** | **Array<String>** |  |  |
-| **interval** | **String** | Supported intervals for bucketing query results by time |  |
-| **page_size** | **Integer** |  | [optional] |
-| **by** | **Array<String>** |  | [optional] |
-| **return_fields** | **Array<String>** |  | [optional] |
-| **filter** | **Array<String>** |  |  |
-| **timezone** | **String** |  |  |
+| **metric_id** | **String** | The metric ID used in the aggregation. |  |
+| **measurements** | **Array<String>** | Measurement key, e.g. `unique`, `sum_value`, `count` |  |
+| **interval** | **String** | Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\" |  |
+| **page_size** | **Integer** | Alter the maximum number of returned rows in a single page of aggregation results | [optional][default to 500] |
+| **by** | **Array<String>** | Optional attribute(s) used for partitioning by the aggregation function | [optional] |
+| **return_fields** | **Array<String>** | Provide fields to limit the returned data | [optional] |
+| **filter** | **Array<String>** | List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).             These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list.             The time range can be filtered by providing a `greater_or_equal` and a `less-than` filter on the `datetime` field. |  |
+| **timezone** | **String** | The timezone used for processing the query, e.g. `'America/New_York'`.             This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones).             While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive. | [optional][default to 'UTC'] |
 | **sort** | **String** |  | [optional] |
 | **page_cursor** | **String** |  | [optional] |
 
@@ -21,14 +21,14 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new(
-  metric_id: null,
-  measurements: null,
-  interval: null,
-  page_size: null,
-  by: null,
+  metric_id: 0rG4eQ,
+  measurements: count,
+  interval: day,
+  page_size: 500,
+  by: $message,
   return_fields: null,
-  filter: null,
-  timezone: null,
+  filter: ["greater-or-equal(datetime,2022-12-01T00:00:00)","less-than(datetime,2022-12-08T00:00:00"],
+  timezone: America/New_York,
   sort: null,
   page_cursor: null
 )

data/docs/MetricAggregateRowDTO.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **dimensions** | **Array<String>** |  |  |
-| **measurements** | **Object** |  |  |
+| **dimensions** | **Array<String>** | List of dimensions associated with this set of measurements |  |
+| **measurements** | **Object** | Dictionary of measurement_key, values |  |
 
 ## Example
 

data/docs/MetricCreateQuery.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  |  |
-| **service** | **String** |  | [optional] |
+| **name** | **String** | Name of the event. Must be less than 128 characters. |  |
+| **service** | **String** | This is for advanced usage. For api requests, this should use the default, which is set to api. | [optional] |
 
 ## Example
 
@@ -13,7 +13,7 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::MetricCreateQuery.new(
-  name: null,
+  name: Viewed Product,
   service: null
 )
 ```

data/docs/MetricsApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://a.klaviyo.com*
 
 Get Metric
 
-Get a metric with the given metric ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets)<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Metrics Read`
+Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Metrics Read`
 
 ### Examples
 
@@ -31,9 +31,9 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::MetricsApi.new
-id = 'id_example' # String | 
+id = 'id_example' # String | Metric ID
 opts = {
-  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -67,8 +67,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **fields_metric** | [**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] |
+| **id** | **String** | Metric ID |  |
+| **fields_metric** | [**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
 
@@ -90,7 +90,7 @@ end
 
 Get Metrics
 
-Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 200 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:** `Metrics Read`
+Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Metrics Read`
 
 ### Examples
 
@@ -107,9 +107,9 @@ end
 
 api_instance = KlaviyoAPI::MetricsApi.new
 opts = {
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/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>`integration.name`: `equals`<br>`integration.category`: `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_metric: ['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>`integration.name`: `equals`<br>`integration.category`: `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
@@ -143,9 +143,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/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;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
+| **fields_metric** | [**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;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
 
 ### Return type
 
@@ -167,7 +167,7 @@ end
 
 Query Metric Aggregates
 
-Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request.  Results can be filtered and grouped by time, event, or profile dimensions.  **Request body parameters** (nested under `attributes`):  * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function     * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values:     * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field     * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field     * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`)     * The time range can be filtered by providing a `greater_or_equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"`     * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date     * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones)  For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/v2022-10-17/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Metrics Read`
+Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your `POST` request.  Results can be filtered and grouped by time, event, or profile dimensions.  **Request body parameters** (nested under `attributes`):  * `return_fields`: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets) * `sort`: sort results by a specified field, such as `\"-timestamp\"` * `page_cursor`: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/reference/api_overview#pagination) * `page_size`: limit the number of returned results per page * `by`: optional attributes used to group by the aggregation function     * When using `by` attributes, an empty `dimensions` response is expected when the counts for the events do not have the associated dimension requested by the set `by` attribute. For example, a query including `\"by\": [\"$flow\"]` will return an empty dimensions response for counts of metrics not associated with a `$flow` * `measurement`: the measurement key supports the following values:     * `\"sum_value\"`: perform a summation of the `_Event Value_`, optionally partitioned over any dimension provided in the `by` field     * `\"count\"`: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the `by` field     * `\"unique\"` counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the `by` field * `interval`: aggregation interval, such as `\"hour\"`,`\"day\"`,`\"week\"`, and `\"month\"` * `metric_id`: the metric ID used in the aggregation * `filter`: list of filters for specific fields, must include time range using ISO 8601 format (`\"YYYY-MM-DDTHH:MM:SS.mmmmmm\"`)     * The time range can be filtered by providing a `greater_or_equal` filter on the datetime field, such as `\"greater-or-equal(datetime,2021-07-01T00:00:00)\"` and a `less-than` filter on the same datetime field, such as `\"less-than(datetime,2022-07-01T00:00:00)\"`     * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date     * Filter the list of supported aggregate dimensions using the common filter syntax, such as `\"equals(URL,\\\"https://www.klaviyo.com/\\\")\"` * `timezone`: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones)  For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Metrics Read`
 
 ### Examples
 
@@ -183,7 +183,7 @@ KlaviyoAPI.configure do |config|
 end
 
 api_instance = KlaviyoAPI::MetricsApi.new
-metric_aggregate_query = KlaviyoAPI::MetricAggregateQuery.new({data: KlaviyoAPI::MetricAggregateQueryAsSubResource.new({type: 'metric-aggregate', attributes: KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new({metric_id: 'metric_id_example', measurements: ['count'], interval: 'day', filter: ['filter_example'], timezone: 'timezone_example'})})}) # MetricAggregateQuery | Retrieve Metric Aggregations
+metric_aggregate_query = KlaviyoAPI::MetricAggregateQuery.new({data: KlaviyoAPI::MetricAggregateQueryAsSubResource.new({type: 'metric-aggregate', attributes: KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new({metric_id: '0rG4eQ', measurements: count, interval: 'day', filter: ["greater-or-equal(datetime, 2022-12-01T00: 00: 00)", "less-than(datetime, 2022-12-08T00: 00: 00"]})})}) # MetricAggregateQuery | Retrieve Metric Aggregations
 
 begin
   # Query Metric Aggregates

data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  |  |
-| **custom_source** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **phone_number** | **String** |  | [optional] |
-| **properties** | **Object** |  | [optional] |
+| **list_id** | **String** | The list ID to add the newly subscribed profile to. |  |
+| **custom_source** | **String** | A custom method detail or source to store on the consent records for this subscription. | [optional] |
+| **email** | **String** | Email address to create subscription and email consent record for. | [optional] |
+| **phone_number** | **String** | Phone number to create subscription and SMS consent record for, in E.164 format. | [optional] |
+| **properties** | **Object** | Profile properties to set on the newly subscribed profile. | [optional] |
 
 ## Example
 
@@ -16,11 +16,11 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResourceAttributes.new(
-  list_id: null,
-  custom_source: null,
-  email: null,
-  phone_number: null,
-  properties: null
+  list_id: Y6nRLr,
+  custom_source: Homepage footer signup form,
+  email: matt.kemp@klaviyo-demo.com,
+  phone_number: +15005550006,
+  properties: {"first_name":"Matt","last_name":"Kemp","favorite_color":"Blue"}
 )
 ```