klaviyo_sdk 1.0.1.20220329 → 1.0.4.20220329

data/docs/CheckMembershipRequest.md

@@ -1,22 +0,0 @@
-# Client::CheckMembershipRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **emails** | **Array<String>** | List of email addresses | [optional] |
-| **phone_numbers** | **Array<String>** | List of phone numbers | [optional] |
-| **push_tokens** | **Array<String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::CheckMembershipRequest.new(
-  emails: ["george.washington@klaviyo.com","abraham.lincoln@klaviyo.com"],
-  phone_numbers: ["+13239169023","+12028837032"],
-  push_tokens: ["PUSH_TOKEN_1","PUSH_TOKEN_2"]
-)
-```
-

data/docs/DataPrivacyApi.md

@@ -1,81 +0,0 @@
-# Client::DataPrivacyApi
-
-All URIs are relative to *https://a.klaviyo.com/api*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**request_deletion**](DataPrivacyApi.md#request_deletion) | **POST** /v2/data-privacy/deletion-request | Request a Deletion |
-
-
-## request_deletion
-
-> String request_deletion(opts)
-
-Request a Deletion
-
-Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier.   **If multiple person records exist for the provided identifier, only one of them will be deleted.**  The arguments should be sent as content type application/json.           Note that only **one** identifier (email, phone_number, or person_id) can be specified.  In addition to your API key, you need to set exactly one of the following parameters: `email`, `phone_number`, `or person_id`, along with the associated `string` value.   Examples:  Email:    `{\"email\":\"abraham.lincoln@klaviyo.com\"}`    Phone Number:      `{\"phone_number\":\"+13239169023\"}`    Person ID:      `{\"person_id\":\"PERSON_ID\"}` 
-
-### Examples
-
-```ruby
-require 'time'
-require 'klaviyo_sdk'
-# setup authorization
-Client.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 = Client::DataPrivacyApi.new
-opts = {
-  body: '{"email":"abraham.lincoln@klaviyo.com"}' # String | 
-}
-
-begin
-  # Request a Deletion
-  result = api_instance.request_deletion(opts)
-  p result
-rescue Client::ApiError => e
-  puts "Error when calling DataPrivacyApi->request_deletion: #{e}"
-end
-```
-
-#### Using the request_deletion_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(String, Integer, Hash)> request_deletion_with_http_info(opts)
-
-```ruby
-begin
-  # Request a Deletion
-  data, status_code, headers = api_instance.request_deletion_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => String
-rescue Client::ApiError => e
-  puts "Error when calling DataPrivacyApi->request_deletion_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | **String** |  | [optional] |
-
-### Return type
-
-**String**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/DeleteEmail.md

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

data/docs/DeletePerson.md

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

data/docs/DeletePhone.md

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

data/docs/DeprecatedGetListResponse.md

@@ -1,30 +0,0 @@
-# Client::DeprecatedGetListResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **object** | **String** |  | [optional] |
-| **start** | **Integer** |  | [optional] |
-| **_end** | **Integer** |  | [optional] |
-| **page** | **Integer** |  | [optional] |
-| **size** | **Integer** |  | [optional] |
-| **total** | **Integer** |  | [optional] |
-| **data** | [**Array<DeprecatedGetListResponseData>**](DeprecatedGetListResponseData.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::DeprecatedGetListResponse.new(
-  object: null,
-  start: null,
-  _end: null,
-  page: null,
-  size: null,
-  total: null,
-  data: null
-)
-```
-

data/docs/DeprecatedGetListResponseData.md

@@ -1,28 +0,0 @@
-# Client::DeprecatedGetListResponseData
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **object** | **String** |  | [optional] |
-| **id** | **String** |  | [optional] |
-| **type** | **String** |  | [optional] |
-| **created** | **String** |  | [optional] |
-| **updated** | **String** |  | [optional] |
-| **person_count** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::DeprecatedGetListResponseData.new(
-  object: null,
-  id: null,
-  type: null,
-  created: null,
-  updated: null,
-  person_count: null
-)
-```
-

data/docs/GlobalExclusionResponseData.md

@@ -1,30 +0,0 @@
-# Client::GlobalExclusionResponseData
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **object** | **String** |  | [optional] |
-| **data** | **Array<Hash<String, Object>>** |  | [optional] |
-| **page** | **Integer** |  | [optional] |
-| **start** | **Integer** |  | [optional] |
-| **_end** | **Integer** |  | [optional] |
-| **total** | **Integer** |  | [optional] |
-| **page_size** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::GlobalExclusionResponseData.new(
-  object: $list,
-  data: null,
-  page: 0,
-  start: 0,
-  _end: 1,
-  total: 1,
-  page_size: 1
-)
-```
-

data/docs/IdentifyPayload.md

@@ -1,20 +0,0 @@
-# Client::IdentifyPayload
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **token** | **String** |  |  |
-| **properties** | [**IdentifyPayloadProperties**](IdentifyPayloadProperties.md) |  |  |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::IdentifyPayload.new(
-  token: null,
-  properties: null
-)
-```
-

data/docs/IdentifyPayloadProperties.md

@@ -1,42 +0,0 @@
-# Client::IdentifyPayloadProperties
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **_email** | **String** |  | [optional] |
-| **_first_name** | **String** |  | [optional] |
-| **_last_name** | **String** |  | [optional] |
-| **_phone_number** | **String** |  | [optional] |
-| **_title** | **String** |  | [optional] |
-| **_organization** | **String** |  | [optional] |
-| **_city** | **String** |  | [optional] |
-| **_region** | **String** |  | [optional] |
-| **_country** | **String** |  | [optional] |
-| **_zip** | **String** |  | [optional] |
-| **image** | **String** |  | [optional] |
-| **consent** | **String** |  | [optional] |
-| **your_custom_field** | [**OneOfstringintegernumberbooleanarray**](OneOfstringintegernumberbooleanarray.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::IdentifyPayloadProperties.new(
-  _email: null,
-  _first_name: null,
-  _last_name: null,
-  _phone_number: null,
-  _title: null,
-  _organization: null,
-  _city: null,
-  _region: null,
-  _country: null,
-  _zip: null,
-  image: null,
-  consent: null,
-  your_custom_field: null
-)
-```
-

data/docs/InlineObject.md

@@ -1,18 +0,0 @@
-# Client::InlineObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **exchange_id** | **String** |  | [optional][default to 'EXCHANGE_ID'] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::InlineObject.new(
-  exchange_id: EXCHANGE_ID
-)
-```
-

data/docs/InlineObject3.md

@@ -1,18 +0,0 @@
-# Client::InlineObject3
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **profiles** | **Array<Hash<String, Object>>** |  |  |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::InlineObject3.new(
-  profiles: [{"email":"george.washington@klaviyo.com"},{"phone_number":"+13239169023","sms_consent":true}]
-)
-```
-

data/docs/InlineObject4.md

@@ -1,18 +0,0 @@
-# Client::InlineObject4
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **profiles** | **Array<Hash<String, Object>>** |  |  |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::InlineObject4.new(
-  profiles: [{"email":"george.washington@klaviyo.com"},{"phone_number":"+13239169023"}]
-)
-```
-

data/docs/InlineObject5.md

@@ -1,22 +0,0 @@
-# Client::InlineObject5
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **emails** | **Array<String>** |  | [optional] |
-| **phone_numbers** | **Array<String>** |  | [optional] |
-| **push_tokens** | **Array<String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'klaviyo_sdk'
-
-instance = Client::InlineObject5.new(
-  emails: ["george.washington@klaviyo.com","abraham.lincoln@klaviyo.com"],
-  phone_numbers: ["+13239169023"],
-  push_tokens: ["PUSH_TOKEN"]
-)
-```
-