klaviyo-api-sdk 1.0.0

data/docs/ClientApi.md

@@ -0,0 +1,205 @@
+# 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 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/v2022-10-17/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 = 'company_id_example' # String | 
+event_create_query = KlaviyoAPI::EventCreateQuery.new({data: KlaviyoAPI::EventCreateQueryAsSubResource.new({type: 'event', attributes: KlaviyoAPI::EventCreateQueryAsSubResourceAttributes.new({profile: 3.56, metric: KlaviyoAPI::MetricCreateQuery.new({name: 'name_example'}), properties: 3.56})})}) # 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** |  |  |
+| **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 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 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 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_example' # String | 
+onsite_subscription_create_query = KlaviyoAPI::OnsiteSubscriptionCreateQuery.new({data: KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResource.new({type: 'subscription', attributes: KlaviyoAPI::OnsiteSubscriptionCreateQueryAsSubResourceAttributes.new({list_id: 'list_id_example'})})}) # 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** |  |  |
+| **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/EmailMessageContent.md

@@ -0,0 +1,24 @@
+# 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

@@ -0,0 +1,24 @@
+# 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

@@ -0,0 +1,18 @@
+# KlaviyoAPI::ErrorSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pointer** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ErrorSource.new(
+  pointer: null
+)
+```
+

data/docs/EventCreateQuery.md

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,28 @@
+# KlaviyoAPI::EventCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile** | **Object** |  |  |
+| **metric** | [**MetricCreateQuery**](MetricCreateQuery.md) |  |  |
+| **properties** | **Object** |  |  |
+| **time** | **Time** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **unique_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::EventCreateQueryAsSubResourceAttributes.new(
+  profile: null,
+  metric: null,
+  properties: null,
+  time: null,
+  value: null,
+  unique_id: null
+)
+```
+