klaviyo_sdk 1.0.0.20220329 → 1.0.3.20220329

data/docs/Metric.md

@@ -0,0 +1,28 @@
+# Klaviyo::Metric
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **integration** | **Hash<String, Object>** |  | [optional] |
+| **created** | **String** |  | [optional] |
+| **updated** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::Metric.new(
+  object: null,
+  id: null,
+  name: null,
+  integration: null,
+  created: null,
+  updated: null
+)
+```
+

data/docs/MetricExport.md

@@ -0,0 +1,32 @@
+# Klaviyo::MetricExport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metric** | **Hash<String, Object>** |  | [optional] |
+| **start_date** | **String** |  | [optional] |
+| **end_date** | **String** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **measurement** | **String** |  | [optional] |
+| **by** | **String** |  | [optional] |
+| **where** | **String** |  | [optional] |
+| **results** | **Array<Hash<String, Object>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::MetricExport.new(
+  metric: null,
+  start_date: null,
+  end_date: null,
+  unit: null,
+  measurement: null,
+  by: null,
+  where: null,
+  results: null
+)
+```
+

data/docs/MetricTimeline.md

@@ -0,0 +1,24 @@
+# Klaviyo::MetricTimeline
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **data** | [**Array<MetricTimelineData>**](MetricTimelineData.md) |  | [optional] |
+| **_next** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::MetricTimeline.new(
+  object: null,
+  count: null,
+  data: null,
+  _next: null
+)
+```
+

data/docs/MetricTimelineData.md

@@ -0,0 +1,34 @@
+# Klaviyo::MetricTimelineData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **statistic_id** | **String** |  | [optional] |
+| **timestamp** | **Integer** |  | [optional] |
+| **event_name** | **String** |  | [optional] |
+| **event_properties** | **Hash<String, Object>** |  | [optional] |
+| **datetime** | **String** |  | [optional] |
+| **uuid** | **String** |  | [optional] |
+| **person** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::MetricTimelineData.new(
+  object: null,
+  id: null,
+  statistic_id: null,
+  timestamp: null,
+  event_name: null,
+  event_properties: null,
+  datetime: null,
+  uuid: null,
+  person: null
+)
+```
+

data/docs/MetricsApi.md

@@ -0,0 +1,329 @@
+# Klaviyo::MetricsApi
+
+All URIs are relative to *https://a.klaviyo.com/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_metrics**](MetricsApi.md#get_metrics) | **GET** /v1/metrics | Get Metrics Info |
+| [**metric_export**](MetricsApi.md#metric_export) | **GET** /v1/metric/{metric_id}/export | Query Event Data |
+| [**metric_timeline**](MetricsApi.md#metric_timeline) | **GET** /v1/metric/{metric_id}/timeline | Get Events for a Specific Metric |
+| [**metrics_timeline**](MetricsApi.md#metrics_timeline) | **GET** /v1/metrics/timeline | Get Events for All Metrics |
+
+
+## get_metrics
+
+> Hash<String, Object> get_metrics(opts)
+
+Get Metrics Info
+
+Returns a list of all the metrics in your account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo_sdk'
+# setup authorization
+Klaviyo.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Klaviyo::MetricsApi.new
+opts = {
+  page: 0, # Integer | For pagination, which page of results to return. Default = 0
+  count: 50 # Integer | For pagination, the number of results to return. Default = 50 ; Max = 100
+}
+
+begin
+  # Get Metrics Info
+  result = api_instance.get_metrics(opts)
+  p result
+rescue Klaviyo::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 Info
+  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 Klaviyo::ApiError => e
+  puts "Error when calling MetricsApi->get_metrics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | For pagination, which page of results to return. Default &#x3D; 0 | [optional][default to 0] |
+| **count** | **Integer** | For pagination, the number of results to return. Default &#x3D; 50 ; Max &#x3D; 100 | [optional][default to 50] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## metric_export
+
+> <MetricExport> metric_export(metric_id, opts)
+
+Query Event Data
+
+Exports event data from Klaviyo, optionally filtering and segmenting on available event properties. Note that the only comparison operator currently supported is `=`. To ensure a correct response, enter parameters in the curl request as they are ordered below:
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo_sdk'
+# setup authorization
+Klaviyo.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Klaviyo::MetricsApi.new
+metric_id = 'METRIC_ID' # String | 
+opts = {
+  start_date: 'start_date_example', # String |  Beginning of timeframe to pull event data for. The default value is 1 month ago. Can also accept a 10-digit UNIX timestamp. When sending a `start_date`, you must also send an `end_date`  Ex: `1610524800` OR `2021-01-13` 
+  end_date: 'end_date_example', # String |  End of timeframe to pull event data for. The default is the current day, or 1 month from start_date, whichever is sooner. Can also accept a 10-digit UNIX timestamp. When sending an `end_date`, you must also send a `start_date`. Must be *at most* 31 days after `start_date`  Ex: `1612080000` OR `2021-01-31` 
+  unit: 'day', # String | Granularity to bucket data points into - one of `day`, `week`, or `month`. Defaults to `day`.
+  measurement: 'count', # String |  Type of metric to fetch - one of `unique`, `count`, `value`, or `sum`. Defaults to `count`. For `sum` a property name to operate on must be supplied as a JSON-encoded list like `[\"sum\",\"ItemCount\"]` 
+  where: '[["$attributed_flow","=","FLOW_ID"]]', # String | Optional, JSON-encoded list. Conditions to use to filter the set of events. A max of 1 condition can be given. `where` and `by` parameters cannot be specified at the same time.  ex: `[[\"$attributed_flow\",\"=\",\"FLOW_ID\"]]` 
+  by: '$attributed_flow', # String | The name of a property to segment the event data on. `where` and `by` parameters cannot be specified at the same time. Cannot be used alongside `where` parameter.
+  count: 25 # Integer | Maximum number of segments to return. Default = 25, **MAX = 1000**
+}
+
+begin
+  # Query Event Data
+  result = api_instance.metric_export(metric_id, opts)
+  p result
+rescue Klaviyo::ApiError => e
+  puts "Error when calling MetricsApi->metric_export: #{e}"
+end
+```
+
+#### Using the metric_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetricExport>, Integer, Hash)> metric_export_with_http_info(metric_id, opts)
+
+```ruby
+begin
+  # Query Event Data
+  data, status_code, headers = api_instance.metric_export_with_http_info(metric_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetricExport>
+rescue Klaviyo::ApiError => e
+  puts "Error when calling MetricsApi->metric_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metric_id** | **String** |  | [default to &#39;METRIC_ID&#39;] |
+| **start_date** | **String** |  Beginning of timeframe to pull event data for. The default value is 1 month ago. Can also accept a 10-digit UNIX timestamp. When sending a &#x60;start_date&#x60;, you must also send an &#x60;end_date&#x60;  Ex: &#x60;1610524800&#x60; OR &#x60;2021-01-13&#x60;  | [optional] |
+| **end_date** | **String** |  End of timeframe to pull event data for. The default is the current day, or 1 month from start_date, whichever is sooner. Can also accept a 10-digit UNIX timestamp. When sending an &#x60;end_date&#x60;, you must also send a &#x60;start_date&#x60;. Must be *at most* 31 days after &#x60;start_date&#x60;  Ex: &#x60;1612080000&#x60; OR &#x60;2021-01-31&#x60;  | [optional] |
+| **unit** | **String** | Granularity to bucket data points into - one of &#x60;day&#x60;, &#x60;week&#x60;, or &#x60;month&#x60;. Defaults to &#x60;day&#x60;. | [optional][default to &#39;day&#39;] |
+| **measurement** | **String** |  Type of metric to fetch - one of &#x60;unique&#x60;, &#x60;count&#x60;, &#x60;value&#x60;, or &#x60;sum&#x60;. Defaults to &#x60;count&#x60;. For &#x60;sum&#x60; a property name to operate on must be supplied as a JSON-encoded list like &#x60;[\&quot;sum\&quot;,\&quot;ItemCount\&quot;]&#x60;  | [optional][default to &#39;count&#39;] |
+| **where** | **String** | Optional, JSON-encoded list. Conditions to use to filter the set of events. A max of 1 condition can be given. &#x60;where&#x60; and &#x60;by&#x60; parameters cannot be specified at the same time.  ex: &#x60;[[\&quot;$attributed_flow\&quot;,\&quot;&#x3D;\&quot;,\&quot;FLOW_ID\&quot;]]&#x60;  | [optional] |
+| **by** | **String** | The name of a property to segment the event data on. &#x60;where&#x60; and &#x60;by&#x60; parameters cannot be specified at the same time. Cannot be used alongside &#x60;where&#x60; parameter. | [optional] |
+| **count** | **Integer** | Maximum number of segments to return. Default &#x3D; 25, **MAX &#x3D; 1000** | [optional][default to 25] |
+
+### Return type
+
+[**MetricExport**](MetricExport.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## metric_timeline
+
+> <MetricTimeline> metric_timeline(metric_id, opts)
+
+Get Events for a Specific Metric
+
+Returns a batched timeline for one specific metric.
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo_sdk'
+# setup authorization
+Klaviyo.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Klaviyo::MetricsApi.new
+metric_id = 'METRIC_ID' # String | 
+opts = {
+  since: 'since_example', # String | Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the `next` attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time.
+  count: 100, # Integer | Number of events to return in a batch. Max = 100
+  sort: 'desc' # String | Sort order to apply to timeline, either descending or ascending. Valid values are `desc` or `asc`. Defaults to `desc`. Always descending when `since` is not sent, as `since` defaults to current time.
+}
+
+begin
+  # Get Events for a Specific Metric
+  result = api_instance.metric_timeline(metric_id, opts)
+  p result
+rescue Klaviyo::ApiError => e
+  puts "Error when calling MetricsApi->metric_timeline: #{e}"
+end
+```
+
+#### Using the metric_timeline_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetricTimeline>, Integer, Hash)> metric_timeline_with_http_info(metric_id, opts)
+
+```ruby
+begin
+  # Get Events for a Specific Metric
+  data, status_code, headers = api_instance.metric_timeline_with_http_info(metric_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetricTimeline>
+rescue Klaviyo::ApiError => e
+  puts "Error when calling MetricsApi->metric_timeline_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metric_id** | **String** |  | [default to &#39;METRIC_ID&#39;] |
+| **since** | **String** | Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the &#x60;next&#x60; attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time. | [optional] |
+| **count** | **Integer** | Number of events to return in a batch. Max &#x3D; 100 | [optional][default to 50] |
+| **sort** | **String** | Sort order to apply to timeline, either descending or ascending. Valid values are &#x60;desc&#x60; or &#x60;asc&#x60;. Defaults to &#x60;desc&#x60;. Always descending when &#x60;since&#x60; is not sent, as &#x60;since&#x60; defaults to current time. | [optional][default to &#39;desc&#39;] |
+
+### Return type
+
+[**MetricTimeline**](MetricTimeline.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## metrics_timeline
+
+> <MetricTimeline> metrics_timeline(opts)
+
+Get Events for All Metrics
+
+Returns a batched timeline of all events in your account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'klaviyo_sdk'
+# setup authorization
+Klaviyo.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Klaviyo::MetricsApi.new
+opts = {
+  since: 'since_example', # String | Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the next attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time.
+  count: 50, # Integer | Number of events to return in a batch. Default = 50, Max = 100
+  sort: 'desc' # String | Sort order to apply to timeline, either descending or ascending. Valid values are `desc` or `asc`. Defaults to `desc`. Always descending when `since` is not sent, as `since` defaults to current time.
+}
+
+begin
+  # Get Events for All Metrics
+  result = api_instance.metrics_timeline(opts)
+  p result
+rescue Klaviyo::ApiError => e
+  puts "Error when calling MetricsApi->metrics_timeline: #{e}"
+end
+```
+
+#### Using the metrics_timeline_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetricTimeline>, Integer, Hash)> metrics_timeline_with_http_info(opts)
+
+```ruby
+begin
+  # Get Events for All Metrics
+  data, status_code, headers = api_instance.metrics_timeline_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetricTimeline>
+rescue Klaviyo::ApiError => e
+  puts "Error when calling MetricsApi->metrics_timeline_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **since** | **String** | Either a 10-digit Unix timestamp (UTC) to use as starting datetime, OR a pagination token obtained from the next attribute of a prior API call. For backwards compatibility, UUIDs will continue to be supported for a limited time. Defaults to current time. | [optional] |
+| **count** | **Integer** | Number of events to return in a batch. Default &#x3D; 50, Max &#x3D; 100 | [optional][default to 50] |
+| **sort** | **String** | Sort order to apply to timeline, either descending or ascending. Valid values are &#x60;desc&#x60; or &#x60;asc&#x60;. Defaults to &#x60;desc&#x60;. Always descending when &#x60;since&#x60; is not sent, as &#x60;since&#x60; defaults to current time. | [optional][default to &#39;desc&#39;] |
+
+### Return type
+
+[**MetricTimeline**](MetricTimeline.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Person.md

@@ -0,0 +1,56 @@
+# Klaviyo::Person
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **_address1** | **String** |  | [optional] |
+| **_address2** | **String** |  | [optional] |
+| **_city** | **String** |  | [optional] |
+| **_country** | **String** |  | [optional] |
+| **_latitude** | **String** |  | [optional] |
+| **_longitude** | **String** |  | [optional] |
+| **_region** | **String** |  | [optional] |
+| **_zip** | **String** |  | [optional] |
+| **_email** | **String** |  | [optional] |
+| **_title** | **String** |  | [optional] |
+| **_phone_number** | **String** |  | [optional] |
+| **_organization** | **String** |  | [optional] |
+| **_first_name** | **String** |  | [optional] |
+| **_last_name** | **String** |  | [optional] |
+| **_timezone** | **String** |  | [optional] |
+| **_id** | **String** |  | [optional] |
+| **created** | **String** |  | [optional] |
+| **updated** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::Person.new(
+  object: person,
+  id: PERSON_ID,
+  _address1: ,
+  _address2: ,
+  _city: Mount Vernon,
+  _country: United States,
+  _latitude: ,
+  _longitude: ,
+  _region: Virginia,
+  _zip: 22121,
+  _email: george.washington@klaviyo.com,
+  _title: President,
+  _phone_number: +13239169023,
+  _organization: U.S. Government,
+  _first_name: George,
+  _last_name: Washington,
+  _timezone: US/Eastern,
+  _id: CUSTOM_ID,
+  created: 2021-11-04 09:06:13,
+  updated: 2021-11-23 11:21:03
+)
+```
+

data/docs/PrivacyEmail.md

@@ -0,0 +1,18 @@
+# Klaviyo::PrivacyEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::PrivacyEmail.new(
+  email: abraham.lincoln@klaviyo.com
+)
+```
+

data/docs/PrivacyId.md

@@ -0,0 +1,18 @@
+# Klaviyo::PrivacyId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **person_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::PrivacyId.new(
+  person_id: PERSON_ID
+)
+```
+

data/docs/PrivacyPhone.md

@@ -0,0 +1,18 @@
+# Klaviyo::PrivacyPhone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo_sdk'
+
+instance = Klaviyo::PrivacyPhone.new(
+  phone_number: +13239169023
+)
+```
+