klaviyo-api-sdk 2.0.0 → 4.0.0

data/docs/MetricAggregateEnum.md

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

data/docs/MetricAggregateQuery.md

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

data/docs/MetricAggregateQueryResourceObject.md

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

data/docs/MetricAggregateQueryResourceObjectAttributes.md

@@ -1,36 +0,0 @@
-# KlaviyoAPI::MetricAggregateQueryResourceObjectAttributes
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **metric_id** | **String** | The metric ID used in the aggregation. |  |
-| **page_cursor** | **String** | Optional pagination cursor to iterate over large result sets | [optional] |
-| **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** | Provide a sort key (e.g. -$message) | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::MetricAggregateQueryResourceObjectAttributes.new(
-  metric_id: 0rG4eQ,
-  page_cursor: null,
-  measurements: count,
-  interval: day,
-  page_size: 500,
-  by: $message,
-  return_fields: 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
-)
-```
-

data/docs/MetricAggregateRowDTO.md

@@ -1,20 +0,0 @@
-# KlaviyoAPI::MetricAggregateRowDTO
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **dimensions** | **Array<String>** | List of dimensions associated with this set of measurements |  |
-| **measurements** | **Object** | Dictionary of measurement_key, values |  |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::MetricAggregateRowDTO.new(
-  dimensions: null,
-  measurements: null
-)
-```
-

data/docs/MetricCreateQuery.md

@@ -1,20 +0,0 @@
-# KlaviyoAPI::MetricCreateQuery
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::MetricCreateQuery.new(
-  name: Viewed Product,
-  service: null
-)
-```
-

data/docs/MetricEnum.md

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

data/docs/MetricsApi.md

@@ -1,233 +0,0 @@
-# KlaviyoAPI::MetricsApi
-
-All URIs are relative to *https://a.klaviyo.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_metric**](MetricsApi.md#get_metric) | **GET** /api/metrics/{id}/ | Get Metric |
-| [**get_metrics**](MetricsApi.md#get_metrics) | **GET** /api/metrics/ | Get Metrics |
-| [**query_metric_aggregates**](MetricsApi.md#query_metric_aggregates) | **POST** /api/metric-aggregates/ | Query Metric Aggregates |
-
-
-## get_metric
-
-> Hash<String, Object> get_metric(id, opts)
-
-Get Metric
-
-Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Metrics 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::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-02-22/reference/api-overview#sparse-fieldsets
-}
-
-begin
-  # Get Metric
-  result = api_instance.get_metric(id, opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling MetricsApi->get_metric: #{e}"
-end
-```
-
-#### Using the get_metric_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_metric_with_http_info(id, opts)
-
-```ruby
-begin
-  # Get Metric
-  data, status_code, headers = api_instance.get_metric_with_http_info(id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling MetricsApi->get_metric_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| 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-02-22/reference/api-overview#sparse-fieldsets | [optional] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_metrics
-
-> Hash&lt;String, Object&gt; get_metrics(opts)
-
-Get Metrics
-
-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
-
-```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::MetricsApi.new
-opts = {
-  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
-  # Get Metrics
-  result = api_instance.get_metrics(opts)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling MetricsApi->get_metrics: #{e}"
-end
-```
-
-#### Using the get_metrics_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_metrics_with_http_info(opts)
-
-```ruby
-begin
-  # Get Metrics
-  data, status_code, headers = api_instance.get_metrics_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling MetricsApi->get_metrics_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## query_metric_aggregates
-
-> Hash&lt;String, Object&gt; query_metric_aggregates(metric_aggregate_query)
-
-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)     * 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
-
-```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::MetricsApi.new
-metric_aggregate_query = KlaviyoAPI::MetricAggregateQuery.new({data: KlaviyoAPI::MetricAggregateQueryResourceObject.new({type: KlaviyoAPI::MetricAggregateEnum::METRIC_AGGREGATE, attributes: KlaviyoAPI::MetricAggregateQueryResourceObjectAttributes.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
-  result = api_instance.query_metric_aggregates(metric_aggregate_query)
-  p result
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling MetricsApi->query_metric_aggregates: #{e}"
-end
-```
-
-#### Using the query_metric_aggregates_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)> query_metric_aggregates_with_http_info(metric_aggregate_query)
-
-```ruby
-begin
-  # Query Metric Aggregates
-  data, status_code, headers = api_instance.query_metric_aggregates_with_http_info(metric_aggregate_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, Object&gt;
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling MetricsApi->query_metric_aggregates_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **metric_aggregate_query** | [**MetricAggregateQuery**](MetricAggregateQuery.md) | Retrieve Metric Aggregations |  |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/ObjectLinks.md

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

data/docs/OnsiteProfileCreateQuery.md

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

data/docs/OnsiteProfileCreateQueryResourceObject.md

@@ -1,22 +0,0 @@
-# KlaviyoAPI::OnsiteProfileCreateQueryResourceObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | [**ProfileEnum**](ProfileEnum.md) |  |  |
-| **attributes** | [**OnsiteProfileCreateQueryResourceObjectAttributes**](OnsiteProfileCreateQueryResourceObjectAttributes.md) |  |  |
-| **meta** | [**OnsiteProfileMeta**](OnsiteProfileMeta.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::OnsiteProfileCreateQueryResourceObject.new(
-  type: null,
-  attributes: null,
-  meta: null
-)
-```
-

data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md

@@ -1,38 +0,0 @@
-# KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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** | Individual's first name | [optional] |
-| **last_name** | **String** | Individual's last name | [optional] |
-| **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
-| **title** | **String** | Individual's job title | [optional] |
-| **image** | **String** | URL pointing to the location of a profile image | [optional] |
-| **location** | [**ProfileLocation**](ProfileLocation.md) |  | [optional] |
-| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::OnsiteProfileCreateQueryResourceObjectAttributes.new(
-  email: sarah.mason@klaviyo-demo.com,
-  phone_number: +15005550006,
-  external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
-  anonymous_id: 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: {"pseudonym":"Dr. Octopus"}
-)
-```
-

data/docs/OnsiteProfileMeta.md

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

data/docs/OnsiteProfileMetaIdentifiers.md

@@ -1,28 +0,0 @@
-# KlaviyoAPI::OnsiteProfileMetaIdentifiers
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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** |  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
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::OnsiteProfileMetaIdentifiers.new(
-  id: 01GDDKASAP8TKDDA2GRZDSVP4H,
-  email: sarah.mason@klaviyo-demo.com,
-  phone_number: +15005550006,
-  external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
-  anonymous_id: null,
-  _kx: J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66
-)
-```
-

data/docs/OnsiteSubscriptionCreateQuery.md

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

data/docs/OnsiteSubscriptionCreateQueryResourceObject.md

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

data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md

@@ -1,26 +0,0 @@
-# KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObjectAttributes
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::OnsiteSubscriptionCreateQueryResourceObjectAttributes.new(
-  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"}
-)
-```
-

data/docs/PredictiveAnalytics.md

@@ -1,34 +0,0 @@
-# KlaviyoAPI::PredictiveAnalytics
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **historic_clv** | **Float** | Total value of all historically placed orders | [optional] |
-| **predicted_clv** | **Float** | Predicted value of all placed orders in the next 365 days | [optional] |
-| **total_clv** | **Float** | Sum of historic and predicted CLV | [optional] |
-| **historic_number_of_orders** | **Integer** | Number of already placed orders | [optional] |
-| **predicted_number_of_orders** | **Float** | Predicted number of placed orders in the next 365 days | [optional] |
-| **average_days_between_orders** | **Float** | Average number of days between orders (None if only one order has been placed) | [optional] |
-| **average_order_value** | **Float** | Average value of placed orders | [optional] |
-| **churn_probability** | **Float** | Probability the customer has churned | [optional] |
-| **expected_date_of_next_order** | **Time** | Expected date of next order, as calculated at the time of their most recent order | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::PredictiveAnalytics.new(
-  historic_clv: 93.87,
-  predicted_clv: 27.24,
-  total_clv: 121.11,
-  historic_number_of_orders: 2,
-  predicted_number_of_orders: 0.54,
-  average_days_between_orders: 189,
-  average_order_value: 46.94,
-  churn_probability: 0.89,
-  expected_date_of_next_order: null
-)
-```
-

data/docs/ProfileAggregateEnum.md

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

data/docs/ProfileCreateQuery.md

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