klaviyo-api-sdk 1.1.0 → 1.2.0

data/docs/MetricsApi.md

@@ -33,7 +33,7 @@ end
 api_instance = KlaviyoAPI::MetricsApi.new
 id = 'id_example' # String | Metric ID
 opts = {
-  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
+  fields_metric: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -68,7 +68,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Metric ID |  |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -107,9 +107,9 @@ end
 
 api_instance = KlaviyoAPI::MetricsApi.new
 opts = {
-  fields_metric: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-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
+  fields_metric: ['name'], # 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>`integration.name`: `equals`<br>`integration.category`: `equals`
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
 }
 
 begin
@@ -143,9 +143,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_metric** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-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] |
+| **fields_metric** | [**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;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-02-22/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/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`
+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)     * While the payload accepts a timezone, the response datetimes returned will be in UTC.  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
 

data/docs/OnsiteProfileMetaIdentifiers.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **external_id** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **phone_number** | **String** |  | [optional] |
+| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | [optional] |
+| **email** | **String** | Individual's email address | [optional] |
+| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
+| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
 | **anonymous_id** | **String** |  | [optional] |
-| **_kx** | **String** |  | [optional] |
+| **_kx** | **String** |  Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo's web tracking.  You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.  | [optional] |
 
 ## Example
 
@@ -17,12 +17,12 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::OnsiteProfileMetaIdentifiers.new(
-  id: null,
-  external_id: null,
-  email: null,
-  phone_number: null,
+  id: 01GDDKASAP8TKDDA2GRZDSVP4H,
+  email: sarah.mason@klaviyo-demo.com,
+  phone_number: +15005550006,
+  external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
   anonymous_id: null,
-  _kx: null
+  _kx: J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66
 )
 ```
 

data/docs/ProfileCreateQueryAsSubResourceAttributes.md

@@ -4,17 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  | [optional] |
-| **phone_number** | **String** |  | [optional] |
-| **external_id** | **String** |  | [optional] |
+| **email** | **String** | Individual's email address | [optional] |
+| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
+| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
 | **anonymous_id** | **String** |  | [optional] |
-| **first_name** | **String** |  | [optional] |
-| **last_name** | **String** |  | [optional] |
-| **organization** | **String** |  | [optional] |
-| **title** | **String** |  | [optional] |
-| **image** | **String** |  | [optional] |
+| **first_name** | **String** | Individual's first name | [optional] |
+| **last_name** | **String** | Individual's last name | [optional] |
+| **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
+| **title** | **String** | Individual's job title | [optional] |
+| **image** | **String** | URL pointing to the location of a profile image | [optional] |
 | **location** | [**ProfileLocation**](ProfileLocation.md) |  | [optional] |
-| **properties** | **Object** |  | [optional] |
+| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
 
 ## Example
 
@@ -22,17 +22,17 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::ProfileCreateQueryAsSubResourceAttributes.new(
-  email: null,
-  phone_number: null,
-  external_id: null,
+  email: sarah.mason@klaviyo-demo.com,
+  phone_number: +15005550006,
+  external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
   anonymous_id: null,
-  first_name: null,
-  last_name: null,
-  organization: null,
-  title: null,
-  image: null,
+  first_name: Sarah,
+  last_name: Mason,
+  organization: Klaviyo,
+  title: Engineer,
+  image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
   location: null,
-  properties: null
+  properties: {"pseudonym":"Dr. Octopus"}
 )
 ```
 

data/docs/ProfileLocation.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **address1** | **String** |  | [optional] |
-| **address2** | **String** |  | [optional] |
-| **city** | **String** |  | [optional] |
-| **country** | **String** |  | [optional] |
+| **address1** | **String** | First line of street address | [optional] |
+| **address2** | **String** | Second line of street address | [optional] |
+| **city** | **String** | City name | [optional] |
+| **country** | **String** | Country name | [optional] |
 | **latitude** | [**ProfileLocationLatitude**](ProfileLocationLatitude.md) |  | [optional] |
-| **longitude** | [**ProfileLocationLatitude**](ProfileLocationLatitude.md) |  | [optional] |
-| **region** | **String** |  | [optional] |
-| **zip** | **String** |  | [optional] |
-| **timezone** | **String** |  | [optional] |
+| **longitude** | [**ProfileLocationLongitude**](ProfileLocationLongitude.md) |  | [optional] |
+| **region** | **String** | Region within a country, such as state or province | [optional] |
+| **zip** | **String** | Zip code | [optional] |
+| **timezone** | **String** | Time zone name. We recommend using time zones from the IANA Time Zone Database. | [optional] |
 
 ## Example
 
@@ -20,15 +20,15 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::ProfileLocation.new(
-  address1: null,
-  address2: null,
-  city: null,
-  country: null,
+  address1: 89 E 42nd St,
+  address2: 1st floor,
+  city: New York,
+  country: United States,
   latitude: null,
   longitude: null,
-  region: null,
-  zip: null,
-  timezone: null
+  region: NY,
+  zip: 10017,
+  timezone: America/New_York
 )
 ```
 

data/docs/ProfileLocationLongitude.md

@@ -0,0 +1,49 @@
+# KlaviyoAPI::ProfileLocationLongitude
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::ProfileLocationLongitude.openapi_one_of
+# =>
+# [
+#   :'Float',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::ProfileLocationLongitude.build(data)
+# => #<Float:0x00007fdd4aab02a0>
+
+KlaviyoAPI::ProfileLocationLongitude.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Float`
+- `String`
+- `nil` (if no type matches)
+

data/docs/ProfilePartialUpdateQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. |  |
 | **attributes** | [**ProfileCreateQueryAsSubResourceAttributes**](ProfileCreateQueryAsSubResourceAttributes.md) |  |  |
 
 ## Example
@@ -15,7 +15,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::ProfilePartialUpdateQueryAsSubResource.new(
   type: null,
-  id: null,
+  id: 01GDDKASAP8TKDDA2GRZDSVP4H,
   attributes: null
 )
 ```

data/docs/ProfilesApi.md

@@ -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/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
+  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 +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/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] |
+| **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 +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/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 +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/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
 
@@ -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/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 +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/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
 
@@ -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/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
+  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>`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-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
 }
 
 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/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] |
+| **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;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-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] |
 
 ### Return type
 
@@ -493,7 +493,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::SubscriptionCreateJobCreateQueryAsSubResource.new({type: 'profile-subscription-bulk-create-job', attributes: KlaviyoAPI::SubscriptionCreateJobCreateQueryAsSubResourceAttributes.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
@@ -563,7 +563,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::SuppressionCreateJobCreateQueryAsSubResource.new({type: 'profile-suppression-bulk-create-job', attributes: KlaviyoAPI::SuppressionCreateJobCreateQueryAsSubResourceAttributes.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
@@ -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::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::UnsuppressionCreateJobCreateQueryAsSubResource.new({type: 'profile-unsuppression-bulk-create-job', attributes: KlaviyoAPI::UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.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
@@ -773,8 +773,8 @@ 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::ProfilePartialUpdateQueryAsSubResource.new({type: 'profile', id: '01GDDKASAP8TKDDA2GRZDSVP4H', attributes: KlaviyoAPI::ProfileCreateQueryAsSubResourceAttributes.new})}) # ProfilePartialUpdateQuery | 
 
 begin
   # Update Profile
@@ -807,7 +807,7 @@ 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) |  |  |
 
 ### Return type

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/SegmentPartialUpdateQueryAsSubResource.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
 | **id** | **String** |  |  |
-| **attributes** | [**ListCreateQueryAsSubResourceAttributes**](ListCreateQueryAsSubResourceAttributes.md) |  |  |
+| **attributes** | [**SegmentPartialUpdateQueryAsSubResourceAttributes**](SegmentPartialUpdateQueryAsSubResourceAttributes.md) |  |  |
 
 ## Example
 

data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md

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

data/docs/SegmentsApi.md

@@ -36,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/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
@@ -71,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/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
 
@@ -111,9 +111,9 @@ end
 api_instance = KlaviyoAPI::SegmentsApi.new
 segment_id = 'segment_id_example' # String | 
 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>`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
+  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>`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-02-22/reference/api-overview#pagination
 }
 
 begin
@@ -148,9 +148,9 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **segment_id** | **String** |  |  |
-| **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] |
+| **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;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-02-22/reference/api-overview#pagination | [optional] |
 
 ### Return type
 
@@ -191,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/v2023-01-24/reference/api-overview#pagination
+  page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
 }
 
 begin
@@ -227,7 +227,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
 | **related_resource** | **String** |  |  |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
 
 ### Return type
 
@@ -267,7 +267,7 @@ 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
+  fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -302,7 +302,7 @@ end
 | 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] |
+| **fields_tag** | [**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
 
@@ -341,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/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
+  fields_segment: ['name'], # 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>`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-02-22/reference/api-overview#pagination
 }
 
 begin
@@ -377,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/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] |
+| **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] |
+| **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;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-02-22/reference/api-overview#pagination | [optional] |
 
 ### Return type
 
@@ -418,7 +418,7 @@ end
 
 api_instance = KlaviyoAPI::SegmentsApi.new
 id = 'id_example' # String | 
-segment_partial_update_query = KlaviyoAPI::SegmentPartialUpdateQuery.new({data: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResource.new({type: 'segment', id: 'id_example', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # SegmentPartialUpdateQuery | 
+segment_partial_update_query = KlaviyoAPI::SegmentPartialUpdateQuery.new({data: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResource.new({type: 'segment', id: 'id_example', attributes: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # SegmentPartialUpdateQuery | 
 
 begin
   # Update Segment

data/docs/SendOptionsSubObject.md

@@ -5,7 +5,6 @@
 | 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
 
@@ -13,8 +12,7 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::SendOptionsSubObject.new(
-  use_smart_sending: null,
-  ignore_unsubscribes: null
+  use_smart_sending: null
 )
 ```