klaviyo-api-sdk 4.0.0 → 4.1.0

data/docs/DataPrivacyApi.md

@@ -0,0 +1,78 @@
+# 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 `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::DataPrivacyCreateDeletionJobQueryResourceObject.new({type: KlaviyoAPI::DataPrivacyDeletionJobEnum::DATA_PRIVACY_DELETION_JOB, attributes: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.new({profile: KlaviyoAPI::DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.new({data: KlaviyoAPI::DataPrivacyProfileQueryResourceObject.new({type: KlaviyoAPI::ProfileEnum::PROFILE, attributes: KlaviyoAPI::DataPrivacyProfileQueryResourceObjectAttributes.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

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

data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md

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

data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md

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

data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.md

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

data/docs/DataPrivacyDeletionJobEnum.md

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

data/docs/DataPrivacyProfileQueryResourceObject.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::DataPrivacyProfileQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ProfileEnum**](ProfileEnum.md) |  |  |
+| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | [optional] |
+| **attributes** | [**DataPrivacyProfileQueryResourceObjectAttributes**](DataPrivacyProfileQueryResourceObjectAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::DataPrivacyProfileQueryResourceObject.new(
+  type: null,
+  id: 01GDDKASAP8TKDDA2GRZDSVP4H,
+  attributes: null
+)
+```
+

data/docs/DataPrivacyProfileQueryResourceObjectAttributes.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::DataPrivacyProfileQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Individual's email address | [optional] |
+| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::DataPrivacyProfileQueryResourceObjectAttributes.new(
+  email: sarah.mason@klaviyo-demo.com,
+  phone_number: +15005550006
+)
+```
+

data/docs/DeviceMetadata.md

@@ -0,0 +1,40 @@
+# KlaviyoAPI::DeviceMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_id** | **String** | Relatively stable ID for the device. Will update on app uninstall and reinstall | [optional] |
+| **klaviyo_sdk** | **String** | The name of the SDK used to create the push token. | [optional] |
+| **sdk_version** | **String** | The version of the SDK used to create the push token | [optional] |
+| **device_model** | **String** | The model of the device | [optional] |
+| **os_name** | **String** | The name of the operating system on the device. | [optional] |
+| **os_version** | **String** | The version of the operating system on the device | [optional] |
+| **manufacturer** | **String** | The manufacturer of the device | [optional] |
+| **app_name** | **String** | The name of the app that created the push token | [optional] |
+| **app_version** | **String** | The version of the app that created the push token | [optional] |
+| **app_build** | **String** | The build of the app that created the push token | [optional] |
+| **app_id** | **String** | The ID of the app that created the push token | [optional] |
+| **environment** | **String** | The environment in which the push token was created | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::DeviceMetadata.new(
+  device_id: 1234567890,
+  klaviyo_sdk: swift,
+  sdk_version: 1.0.0,
+  device_model: iPhone12,1,
+  os_name: ios,
+  os_version: 14.0,
+  manufacturer: Apple,
+  app_name: Klaviyo,
+  app_version: 1.0.0,
+  app_build: 1,
+  app_id: com.klaviyo.app,
+  environment: release
+)
+```
+

data/docs/EmailContentSubObject.md

@@ -0,0 +1,30 @@
+# KlaviyoAPI::EmailContentSubObject
+
+## 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] |
+| **reply_to_email** | **String** | Optional Reply-To email address | [optional] |
+| **cc_email** | **String** | Optional CC email address | [optional] |
+| **bcc_email** | **String** | Optional BCC email address | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EmailContentSubObject.new(
+  subject: Buy our product!,
+  preview_text: My preview text,
+  from_email: store@my-company.com,
+  from_label: My Company,
+  reply_to_email: reply-to@my-company.com,
+  cc_email: cc@my-company.com,
+  bcc_email: bcc@my-company.com
+)
+```
+

data/docs/EmailSendOptionsSubObject.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::EmailSendOptionsSubObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **use_smart_sending** | **Boolean** | Use smart sending. Defaults to True | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EmailSendOptionsSubObject.new(
+  use_smart_sending: null
+)
+```
+

data/docs/EmailTrackingOptionsSubObject.md

@@ -0,0 +1,24 @@
+# KlaviyoAPI::EmailTrackingOptionsSubObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_add_utm** | **Boolean** | Whether the campaign needs UTM parameters. If set to False, UTM params will not be used. | [optional] |
+| **utm_params** | [**Array<UTMParamsSubObject>**](UTMParamsSubObject.md) | A list of UTM parameters. If an empty list is given and is_add_utm is True, uses company defaults. | [optional] |
+| **is_tracking_clicks** | **Boolean** | Whether the campaign is tracking click events. If not specified, uses company defaults. | [optional] |
+| **is_tracking_opens** | **Boolean** | Whether the campaign is tracking open events. If not specified, uses company defaults. | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EmailTrackingOptionsSubObject.new(
+  is_add_utm: null,
+  utm_params: null,
+  is_tracking_clicks: null,
+  is_tracking_opens: null
+)
+```
+

data/docs/EventCreateQueryV2.md

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

data/docs/EventCreateQueryV2ResourceObject.md

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

data/docs/EventCreateQueryV2ResourceObjectAttributes.md

@@ -0,0 +1,28 @@
+# KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **metric** | [**EventCreateQueryV2ResourceObjectAttributesMetric**](EventCreateQueryV2ResourceObjectAttributesMetric.md) |  |  |
+| **profile** | [**EventCreateQueryV2ResourceObjectAttributesProfile**](EventCreateQueryV2ResourceObjectAttributesProfile.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventCreateQueryV2ResourceObjectAttributes.new(
+  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,
+  metric: null,
+  profile: null
+)
+```
+

data/docs/EventCreateQueryV2ResourceObjectAttributesMetric.md

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

data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md

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

data/docs/EventEnum.md

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