klaviyo_sdk 1.0.3.20220329 → 1.0.4.20220329

data/docs/ProfilesApi.md

@@ -1,391 +0,0 @@
-# Klaviyo::ProfilesApi
-
-All URIs are relative to *https://a.klaviyo.com/api*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**exchange**](ProfilesApi.md#exchange) | **POST** /v2/people/exchange | Exchange ID for Profile ID |
-| [**get_profile**](ProfilesApi.md#get_profile) | **GET** /v1/person/{person_id} | Get Profile |
-| [**profile_metric_timeline**](ProfilesApi.md#profile_metric_timeline) | **GET** /v1/person/{person_id}/metric/{metric_id}/timeline | Get Profile's Events for a Specific Metric |
-| [**profile_metrics_timeline**](ProfilesApi.md#profile_metrics_timeline) | **GET** /v1/person/{person_id}/metrics/timeline | Get Profile's Events for all Metrics |
-| [**update_profile**](ProfilesApi.md#update_profile) | **PUT** /v1/person/{person_id} | Update Profile |
-
-
-## exchange
-
-> Hash<String, Object> exchange(opts)
-
-Exchange ID for Profile ID
-
-Klaviyo's web tracking uses an encrypted identifier. However, there are many use cases that require developers to have access to a given profile's email or phone number. In such cases, developers can use this operation to exchange an encrypted identifier for a profile ID, which they can then use to retrieve the full profile data (by making a subsequent request to the `get-profiles` operation).  The `exchange_id` takes the following form:  `<IDENTIFIER>.<COMPANY_ID>`  The `exchange_id` appears in the url as follows:  `?_kx=<IDENTIFIER>.<COMPANY_ID>`
-
-### 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::ProfilesApi.new
-opts = {
-  inline_object: Klaviyo::InlineObject.new({exchange_id: 'EXCHANGE_ID'}) # InlineObject | 
-}
-
-begin
-  # Exchange ID for Profile ID
-  result = api_instance.exchange(opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->exchange: #{e}"
-end
-```
-
-#### Using the exchange_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)> exchange_with_http_info(opts)
-
-```ruby
-begin
-  # Exchange ID for Profile ID
-  data, status_code, headers = api_instance.exchange_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 ProfilesApi->exchange_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **inline_object** | [**InlineObject**](InlineObject.md) |  | [optional] |
-
-### Return type
-
-**Hash&lt;String, Object&gt;**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## get_profile
-
-> <Person> get_profile(person_id)
-
-Get Profile
-
-Retrieves all the data attributes for a person, based on the Klaviyo Person ID.
-
-### 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::ProfilesApi.new
-person_id = 'PERSON_ID' # String | 
-
-begin
-  # Get Profile
-  result = api_instance.get_profile(person_id)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->get_profile: #{e}"
-end
-```
-
-#### Using the get_profile_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Person>, Integer, Hash)> get_profile_with_http_info(person_id)
-
-```ruby
-begin
-  # Get Profile
-  data, status_code, headers = api_instance.get_profile_with_http_info(person_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Person>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->get_profile_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **person_id** | **String** |  | [default to &#39;PERSON_ID&#39;] |
-
-### Return type
-
-[**Person**](Person.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## profile_metric_timeline
-
-> <MetricTimeline> profile_metric_timeline(person_id, metric_id, opts)
-
-Get Profile's Events for a Specific Metric
-
-Returns a person's batched timeline for one specific event type.
-
-### 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::ProfilesApi.new
-person_id = 'PERSON_ID' # String | 
-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.
-  sort: 'desc' # String | Sort order to apply to timeline, either descending or ascending. Valid values are `desc` or `asc`. Defaults to `desc`.
-}
-
-begin
-  # Get Profile's Events for a Specific Metric
-  result = api_instance.profile_metric_timeline(person_id, metric_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->profile_metric_timeline: #{e}"
-end
-```
-
-#### Using the profile_metric_timeline_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<MetricTimeline>, Integer, Hash)> profile_metric_timeline_with_http_info(person_id, metric_id, opts)
-
-```ruby
-begin
-  # Get Profile's Events for a Specific Metric
-  data, status_code, headers = api_instance.profile_metric_timeline_with_http_info(person_id, metric_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <MetricTimeline>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->profile_metric_timeline_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **person_id** | **String** |  | [default to &#39;PERSON_ID&#39;] |
-| **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 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. | [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;. | [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
-
-
-## profile_metrics_timeline
-
-> <MetricTimeline> profile_metrics_timeline(person_id, opts)
-
-Get Profile's Events for all Metrics
-
-Returns a batched timeline of all events for a person.
-
-### 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::ProfilesApi.new
-person_id = 'PERSON_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: 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 Profile's Events for all Metrics
-  result = api_instance.profile_metrics_timeline(person_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->profile_metrics_timeline: #{e}"
-end
-```
-
-#### Using the profile_metrics_timeline_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<MetricTimeline>, Integer, Hash)> profile_metrics_timeline_with_http_info(person_id, opts)
-
-```ruby
-begin
-  # Get Profile's Events for all Metrics
-  data, status_code, headers = api_instance.profile_metrics_timeline_with_http_info(person_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <MetricTimeline>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->profile_metrics_timeline_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **person_id** | **String** |  | [default to &#39;PERSON_ID&#39;] |
-| **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
-
-
-## update_profile
-
-> <Person> update_profile(person_id, opts)
-
-Update Profile
-
-NOTE: If you are interested in creating or updating profiles in Klaviyo, you should be using the Identify API instead. The best use-case for this route is changing a profiles's email address or other primary identifier after a profile already exists in Klaviyo.  Add or update one more more attributes for a Person, based on the Klaviyo Person ID. If a property already exists, it will be updated. If a property is not set for that record, it will be created.  You can update any attribute, by sending one or more attributes along their new values, as query parameters. Recommended attributes for this endpoint: `$email`, `$phone_number`, `$id` 
-
-### 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::ProfilesApi.new
-person_id = 'PERSON_ID' # String | 
-opts = {
-  params: { key: 3.56} # Hash<String, Object> | 
-}
-
-begin
-  # Update Profile
-  result = api_instance.update_profile(person_id, opts)
-  p result
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->update_profile: #{e}"
-end
-```
-
-#### Using the update_profile_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Person>, Integer, Hash)> update_profile_with_http_info(person_id, opts)
-
-```ruby
-begin
-  # Update Profile
-  data, status_code, headers = api_instance.update_profile_with_http_info(person_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Person>
-rescue Klaviyo::ApiError => e
-  puts "Error when calling ProfilesApi->update_profile_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **person_id** | **String** |  | [default to &#39;PERSON_ID&#39;] |
-| **params** | [**Hash&lt;String, Object&gt;**](Object.md) |  | [optional] |
-
-### Return type
-
-[**Person**](Person.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/RenderedTemplate.md

@@ -1,24 +0,0 @@
-# Klaviyo::RenderedTemplate
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **object** | **String** |  | [optional] |
-| **id** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **data** | **Hash<String, Object>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Klaviyo::RenderedTemplate.new(
-  object: email-template,
-  id: TEMPLATE_ID,
-  name: My Cloned Template,
-  data: null
-)
-```
-

data/docs/Template.md

@@ -1,30 +0,0 @@
-# Klaviyo::Template
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **object** | **String** |  | [optional] |
-| **id** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **html** | **String** |  | [optional] |
-| **is_writeable** | **Boolean** |  | [optional] |
-| **created** | **String** |  | [optional] |
-| **updated** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Klaviyo::Template.new(
-  object: email-template,
-  id: TEMPLATE_ID,
-  name: TEMPLATE_NAME,
-  html: HTML_STRING,
-  is_writeable: true,
-  created: TEMPLATE_NAME,
-  updated: TEMPLATE_NAME
-)
-```
-