klaviyo-api-sdk 1.2.0 → 3.0.0

data/docs/ClientApi.md

@@ -1,205 +0,0 @@
-# KlaviyoAPI::ClientApi
-
-All URIs are relative to *https://a.klaviyo.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_client_event**](ClientApi.md#create_client_event) | **POST** /client/events/ | Create Client Event |
-| [**create_client_profile**](ClientApi.md#create_client_profile) | **POST** /client/profiles/ | Create or Update Client Profile |
-| [**create_client_subscription**](ClientApi.md#create_client_subscription) | **POST** /client/subscriptions/ | Create Client Subscription |
-
-
-## create_client_event
-
-> create_client_event(company_id, event_create_query)
-
-Create Client Event
-
-Create a new event to track a profile's activity. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create events from server-based applications, please use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event)<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `Events Write`
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo-api-sdk'
-
-api_instance = KlaviyoAPI::ClientApi.new
-company_id = 'YOUR_COMPANY_ID' # String | ID of the Company to create event
-event_create_query = KlaviyoAPI::EventCreateQuery.new({data: KlaviyoAPI::EventCreateQueryAsSubResource.new({type: 'event', attributes: KlaviyoAPI::EventCreateQueryAsSubResourceAttributes.new({profile: {"$email":"matt.kemp@klaviyo-demo.com"}, metric: KlaviyoAPI::MetricCreateQuery.new({name: 'Viewed Product'}), properties: {"Brand":"Kids Book","Categories":["Fiction","Children"],"ProductID":1111,"ProductName":"Winnie the Pooh","$extra":{"URL":"http://www.example.com/path/to/product","ImageURL":"http://www.example.com/path/to/product/image.png"}}})})}) # EventCreateQuery | Event to create.
-
-begin
-  # Create Client Event
-  api_instance.create_client_event(company_id, event_create_query)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ClientApi->create_client_event: #{e}"
-end
-```
-
-#### Using the create_client_event_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> create_client_event_with_http_info(company_id, event_create_query)
-
-```ruby
-begin
-  # Create Client Event
-  data, status_code, headers = api_instance.create_client_event_with_http_info(company_id, event_create_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ClientApi->create_client_event_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **company_id** | **String** | ID of the Company to create event |  |
-| **event_create_query** | [**EventCreateQuery**](EventCreateQuery.md) | Event to create. |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_client_profile
-
-> create_client_profile(company_id, onsite_profile_create_query)
-
-Create or Update Client Profile
-
-Create and update properties about a profile without tracking an associated event. This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create profiles from server applications (e.g. custom server-side scripts / applications), please use [POST /api/profiles](https://developers.klaviyo.com/en/reference/create_profile)<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m`  **Scopes:** `Profiles Write`
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo-api-sdk'
-
-api_instance = KlaviyoAPI::ClientApi.new
-company_id = 'company_id_example' # String | 
-onsite_profile_create_query = KlaviyoAPI::OnsiteProfileCreateQuery.new({data: KlaviyoAPI::OnsiteProfileCreateQueryAsSubResource.new({type: 'profile', attributes: KlaviyoAPI::ProfileCreateQueryAsSubResourceAttributes.new})}) # OnsiteProfileCreateQuery | 
-
-begin
-  # Create or Update Client Profile
-  api_instance.create_client_profile(company_id, onsite_profile_create_query)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ClientApi->create_client_profile: #{e}"
-end
-```
-
-#### Using the create_client_profile_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> create_client_profile_with_http_info(company_id, onsite_profile_create_query)
-
-```ruby
-begin
-  # Create or Update Client Profile
-  data, status_code, headers = api_instance.create_client_profile_with_http_info(company_id, onsite_profile_create_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ClientApi->create_client_profile_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **company_id** | **String** |  |  |
-| **onsite_profile_create_query** | [**OnsiteProfileCreateQuery**](OnsiteProfileCreateQuery.md) |  |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_client_subscription
-
-> create_client_subscription(company_id, onsite_subscription_create_query)
-
-Create Client Subscription
-
-Create a new subscription for the given list ID and channel:  * Email `email` * SMS `phone_number`  This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create subscriptions from server-based applications, please use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles)<br><br>*Rate limits*:<br>Burst: `100/s`<br>Steady: `100/m`  **Scopes:** `Subscriptions Write`
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo-api-sdk'
-
-api_instance = KlaviyoAPI::ClientApi.new
-company_id = 'COMPANY_ID' # String | Your company ID.
-onsite_subscription_create_query = KlaviyoAPI::OnsiteSubscriptionCreateQuery.new({data: KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResource.new({type: 'subscription', attributes: KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResourceAttributes.new({list_id: 'Y6nRLr'})})}) # OnsiteSubscriptionCreateQuery | Creates a subscription and consent records for Email and or SMS channels based on the provided email and phone_number attributes respectively. One of either email or phone_number must be provided. To create a subscription and consent record for only one channel but still include the other channel as a profile property the consent channel can be provided as a top level attribute and the other channel can be included in the properties object.
-
-begin
-  # Create Client Subscription
-  api_instance.create_client_subscription(company_id, onsite_subscription_create_query)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ClientApi->create_client_subscription: #{e}"
-end
-```
-
-#### Using the create_client_subscription_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> create_client_subscription_with_http_info(company_id, onsite_subscription_create_query)
-
-```ruby
-begin
-  # Create Client Subscription
-  data, status_code, headers = api_instance.create_client_subscription_with_http_info(company_id, onsite_subscription_create_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling ClientApi->create_client_subscription_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **company_id** | **String** | Your company ID. |  |
-| **onsite_subscription_create_query** | [**OnsiteSubscriptionCreateQuery**](OnsiteSubscriptionCreateQuery.md) | Creates a subscription and consent records for Email and or SMS channels based on the provided email and phone_number attributes respectively. One of either email or phone_number must be provided. To create a subscription and consent record for only one channel but still include the other channel as a profile property the consent channel can be provided as a top level attribute and the other channel can be included in the properties object. |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-

data/docs/ContentSubObject.md

@@ -1,28 +0,0 @@
-# KlaviyoAPI::ContentSubObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | **String** | The subject of the message | [optional] |
-| **preview_text** | **String** | Preview text associated with the message | [optional] |
-| **from_email** | **String** | The email the message should be sent from | [optional] |
-| **from_label** | **String** | The label associated with the from_email | [optional] |
-| **template_id** | **String** | The ID of the template associated to the message | [optional] |
-| **template_name** | **String** | The name of the template associated to the message | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::ContentSubObject.new(
-  subject: Buy our product!,
-  preview_text: My preview text,
-  from_email: store@my-company.com,
-  from_label: My Company,
-  template_id: RipRmi,
-  template_name: My email template
-)
-```
-

data/docs/DataPrivacyApi.md

@@ -1,78 +0,0 @@
-# KlaviyoAPI::DataPrivacyApi
-
-All URIs are relative to *https://a.klaviyo.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**request_profile_deletion**](DataPrivacyApi.md#request_profile_deletion) | **POST** /api/data-privacy-deletion-jobs/ | Request Profile Deletion |
-
-
-## request_profile_deletion
-
-> request_profile_deletion(data_privacy_create_deletion_job_query)
-
-Request Profile Deletion
-
-Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `profile_id`. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted.         The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted).         For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Data Privacy Write`
-
-### 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::DataPrivacyApi.new
-data_privacy_create_deletion_job_query = KlaviyoAPI::DataPrivacyCreateDeletionJobQuery.new({data: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryAsSubResource.new({type: 'data-privacy-deletion-job', attributes: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.new})}) # DataPrivacyCreateDeletionJobQuery | 
-
-begin
-  # Request Profile Deletion
-  api_instance.request_profile_deletion(data_privacy_create_deletion_job_query)
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling DataPrivacyApi->request_profile_deletion: #{e}"
-end
-```
-
-#### Using the request_profile_deletion_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> request_profile_deletion_with_http_info(data_privacy_create_deletion_job_query)
-
-```ruby
-begin
-  # Request Profile Deletion
-  data, status_code, headers = api_instance.request_profile_deletion_with_http_info(data_privacy_create_deletion_job_query)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue KlaviyoAPI::ApiError => e
-  puts "Error when calling DataPrivacyApi->request_profile_deletion_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **data_privacy_create_deletion_job_query** | [**DataPrivacyCreateDeletionJobQuery**](DataPrivacyCreateDeletionJobQuery.md) |  |  |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/DataPrivacyCreateDeletionJobQuery.md

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

data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md

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

data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md

@@ -1,22 +0,0 @@
-# KlaviyoAPI::DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **profile_id** | **String** | The ID of the profile to delete. This is the `id` field on the profile object. | [optional] |
-| **email** | **String** | The email address of the profile to delete. | [optional] |
-| **phone_number** | **String** | The phone number of the profile to delete. | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.new(
-  profile_id: 01F2VWQ645BES947MP1BPAKVMB,
-  email: matt.kemp@klaviyo-demo.com,
-  phone_number: +15005550006
-)
-```
-

data/docs/EmailMessageContent.md

@@ -1,24 +0,0 @@
-# KlaviyoAPI::EmailMessageContent
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | **String** |  |  |
-| **preview_text** | **String** |  |  |
-| **from_email** | **String** |  |  |
-| **from_name** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::EmailMessageContent.new(
-  subject: null,
-  preview_text: null,
-  from_email: null,
-  from_name: null
-)
-```
-

data/docs/EmailTrackingOptions.md

@@ -1,24 +0,0 @@
-# KlaviyoAPI::EmailTrackingOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **add_utm** | **Boolean** |  |  |
-| **utm_params** | [**Array<UtmParamInfo>**](UtmParamInfo.md) |  |  |
-| **is_tracking_opens** | **Boolean** |  |  |
-| **is_tracking_clicks** | **Boolean** |  |  |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::EmailTrackingOptions.new(
-  add_utm: null,
-  utm_params: null,
-  is_tracking_opens: null,
-  is_tracking_clicks: null
-)
-```
-

data/docs/ErrorSource.md

@@ -1,18 +0,0 @@
-# KlaviyoAPI::ErrorSource
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pointer** | **String** | A pointer to the source of the error in the request payload. | [default to '/data'] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::ErrorSource.new(
-  pointer: /data
-)
-```
-

data/docs/EventCreateQuery.md

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

data/docs/EventCreateQueryAsSubResource.md

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

data/docs/EventCreateQueryAsSubResourceAttributes.md

@@ -1,28 +0,0 @@
-# KlaviyoAPI::EventCreateQueryAsSubResourceAttributes
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **profile** | **Object** |  Properties of the profile that triggered this event. The profile must contain an identifier. The $email and/or $phone_number can be used as the identify the profile. Other key value pairs can be used to create segments. For example, to create a list of people on trial plans, include a profile's plan type in the profile. The profile supports special fields. The fields include: $email (string), $first_name (string), $last_name (string), $phone_number (string), $city (string), $region (string; state or other region), $country (string), $zip (string), $image (string; url to a photo of a person), and $consent (list of strings; eg: ['sms', 'email', 'web', 'directmail', 'mobile']).  |  |
-| **metric** | [**MetricCreateQuery**](MetricCreateQuery.md) |  |  |
-| **properties** | **Object** |   Properties of this event. Any top level property (that are not objects) can be used to create segments. The $extra property is a special property. This records any non-segmentable values that can be references later. For example, HTML templates are useful on a segment, but itself is not used in creating a segment. There are limits placed onto the size of the data present. This must not exceed 5 MB. This must not exceed 300 event properties. A single string cannot be larger than 100 KB. Each array must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.  |  |
-| **time** | **Time** |  When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.  | [optional] |
-| **value** | **Float** | A numeric value to associate with this event. For example, the dollar amount of a purchase. | [optional] |
-| **unique_id** | **String** |  A unique identifier for an event. If the unique_id is repeated for the same profile and metric, only the first processed event will be recorded. If this is not present, this will use the time to the second. Using the default, this limits only one event per profile per second.  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo-api-sdk'
-
-instance = KlaviyoAPI::EventCreateQueryAsSubResourceAttributes.new(
-  profile: {"$email":"matt.kemp@klaviyo-demo.com"},
-  metric: null,
-  properties: {"Brand":"Kids Book","Categories":["Fiction","Children"],"ProductID":1111,"ProductName":"Winnie the Pooh","$extra":{"URL":"http://www.example.com/path/to/product","ImageURL":"http://www.example.com/path/to/product/image.png"}},
-  time: null,
-  value: 9.99,
-  unique_id: null
-)
-```
-