klaviyo_sdk 1.0.0.20220329 → 1.0.1.20220329

data/docs/TemplatesApi.md

@@ -0,0 +1,541 @@
+# Client::TemplatesApi
+
+All URIs are relative to *https://a.klaviyo.com/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**clone_template**](TemplatesApi.md#clone_template) | **POST** /v1/email-template/{template_id}/clone | Clone Template |
+| [**create_template**](TemplatesApi.md#create_template) | **POST** /v1/email-templates | Create New Template |
+| [**delete_template**](TemplatesApi.md#delete_template) | **DELETE** /v1/email-template/{template_id} | Delete Template |
+| [**get_templates**](TemplatesApi.md#get_templates) | **GET** /v1/email-templates | Get All Templates |
+| [**render_template**](TemplatesApi.md#render_template) | **POST** /v1/email-template/{template_id}/render | Render Template |
+| [**send_template**](TemplatesApi.md#send_template) | **POST** /v1/email-template/{template_id}/send | Render and Send Template |
+| [**update_template**](TemplatesApi.md#update_template) | **PUT** /v1/email-template/{template_id} | Update Template |
+
+
+## clone_template
+
+> <Template> clone_template(template_id, name)
+
+Clone Template
+
+Creates a copy of a given template with a new name.
+
+### 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::TemplatesApi.new
+template_id = 'TEMPLATE_ID' # String | 
+name = 'name_example' # String | The new name of the email template.
+
+begin
+  # Clone Template
+  result = api_instance.clone_template(template_id, name)
+  p result
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->clone_template: #{e}"
+end
+```
+
+#### Using the clone_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> clone_template_with_http_info(template_id, name)
+
+```ruby
+begin
+  # Clone Template
+  data, status_code, headers = api_instance.clone_template_with_http_info(template_id, name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->clone_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** |  | [default to &#39;TEMPLATE_ID&#39;] |
+| **name** | **String** | The new name of the email template. | [default to &#39;My Cloned Template&#39;] |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## create_template
+
+> <Template> create_template(name, html)
+
+Create New Template
+
+Creates a new email template.
+
+### 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::TemplatesApi.new
+name = 'name_example' # String | The name of the email template.
+html = 'html_example' # String | 
+
+begin
+  # Create New Template
+  result = api_instance.create_template(name, html)
+  p result
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->create_template: #{e}"
+end
+```
+
+#### Using the create_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> create_template_with_http_info(name, html)
+
+```ruby
+begin
+  # Create New Template
+  data, status_code, headers = api_instance.create_template_with_http_info(name, html)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->create_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the email template. | [default to &#39;New Template Name&#39;] |
+| **html** | **String** |  | [default to &#39;&lt;html&gt;&lt;body&gt;&lt;p&gt;This is an email for {{ email }}.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;&#39;] |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## delete_template
+
+> Hash&lt;String, Object&gt; delete_template(template_id)
+
+Delete Template
+
+Deletes a given template.
+
+### 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::TemplatesApi.new
+template_id = 'TEMPLATE_ID' # String | 
+
+begin
+  # Delete Template
+  result = api_instance.delete_template(template_id)
+  p result
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->delete_template: #{e}"
+end
+```
+
+#### Using the delete_template_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)> delete_template_with_http_info(template_id)
+
+```ruby
+begin
+  # Delete Template
+  data, status_code, headers = api_instance.delete_template_with_http_info(template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->delete_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** |  | [default to &#39;TEMPLATE_ID&#39;] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_templates
+
+> Hash&lt;String, Object&gt; get_templates(opts)
+
+Get All Templates
+
+Returns a list of all the email templates you've created. The templates are returned in sorted order by `name`.
+
+### 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::TemplatesApi.new
+opts = {
+  page: 0, # Integer | For pagination, which page of results to return. Default = 0
+  count: 100 # Integer | For pagination, the number of results to return. Max = 100
+}
+
+begin
+  # Get All Templates
+  result = api_instance.get_templates(opts)
+  p result
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->get_templates: #{e}"
+end
+```
+
+#### Using the get_templates_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)> get_templates_with_http_info(opts)
+
+```ruby
+begin
+  # Get All Templates
+  data, status_code, headers = api_instance.get_templates_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->get_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | For pagination, which page of results to return. Default &#x3D; 0 | [optional][default to 0] |
+| **count** | **Integer** | For pagination, the number of results to return. Max &#x3D; 100 | [optional][default to 50] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## render_template
+
+> <RenderedTemplate> render_template(template_id, opts)
+
+Render Template
+
+Renders the specified template with the provided data and return HTML and text versions of the email.
+
+### 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::TemplatesApi.new
+template_id = 'TEMPLATE_ID' # String | 
+opts = {
+  context: 'context_example' # String | This is the context your email template will be rendered with. Email templates are rendered with contexts in a similar manner to how Django templates are rendered. This means that nested template variables can be referenced via dot notation and template variables without corresponding context values are treated as falsy and output nothing.
+}
+
+begin
+  # Render Template
+  result = api_instance.render_template(template_id, opts)
+  p result
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->render_template: #{e}"
+end
+```
+
+#### Using the render_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RenderedTemplate>, Integer, Hash)> render_template_with_http_info(template_id, opts)
+
+```ruby
+begin
+  # Render Template
+  data, status_code, headers = api_instance.render_template_with_http_info(template_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RenderedTemplate>
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->render_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** |  | [default to &#39;TEMPLATE_ID&#39;] |
+| **context** | **String** | This is the context your email template will be rendered with. Email templates are rendered with contexts in a similar manner to how Django templates are rendered. This means that nested template variables can be referenced via dot notation and template variables without corresponding context values are treated as falsy and output nothing. | [optional][default to &#39;{ \&quot;name\&quot; : \&quot;George Washington\&quot;, \&quot;state\&quot; : \&quot;VA\&quot; }&#39;] |
+
+### Return type
+
+[**RenderedTemplate**](RenderedTemplate.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## send_template
+
+> <RenderedTemplate> send_template(template_id, from_email, from_name, subject, to, opts)
+
+Render and Send Template
+
+Renders the specified template with the provided data and send the contents in an email via the service specified. This API is intended to test templates only, and is rate limited to the following thresholds: 100/hour, 1,000/day.
+
+### 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::TemplatesApi.new
+template_id = 'TEMPLATE_ID' # String | 
+from_email = 'from_email_example' # String | 
+from_name = 'from_name_example' # String | 
+subject = 'subject_example' # String | 
+to = 'to_example' # String | **Mixed**. string, or JSON encoded array of objects with \\\"email\\\" and \\\"name\\\" keys. `abraham.lincoln@klaviyo.com` OR `[{\\\"name\\\":\\\"Abraham Lincoln\\\",\\\"email\\\":\\\"abraham.lincoln@klaviyo.com\\\"}]` 
+opts = {
+  context: 'context_example' # String | Optional, JSON object. This is the context your email template will be rendered with. Email templates are rendered with contexts in a similar manner to how Django templates are rendered. This means that nested template variables can be referenced via dot notation and template variables without corresponding context values are treated as falsy and output nothing. ex: `{ \\\"name\\\" : \\\"George Washington\\\", \\\"state\\\" : \\\"VA\\\" }` 
+}
+
+begin
+  # Render and Send Template
+  result = api_instance.send_template(template_id, from_email, from_name, subject, to, opts)
+  p result
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->send_template: #{e}"
+end
+```
+
+#### Using the send_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RenderedTemplate>, Integer, Hash)> send_template_with_http_info(template_id, from_email, from_name, subject, to, opts)
+
+```ruby
+begin
+  # Render and Send Template
+  data, status_code, headers = api_instance.send_template_with_http_info(template_id, from_email, from_name, subject, to, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RenderedTemplate>
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->send_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** |  | [default to &#39;TEMPLATE_ID&#39;] |
+| **from_email** | **String** |  | [default to &#39;george.washington@klaviyo.com&#39;] |
+| **from_name** | **String** |  | [default to &#39;George Washington&#39;] |
+| **subject** | **String** |  | [default to &#39;Happy Fourth!&#39;] |
+| **to** | **String** | **Mixed**. string, or JSON encoded array of objects with \\\&quot;email\\\&quot; and \\\&quot;name\\\&quot; keys. &#x60;abraham.lincoln@klaviyo.com&#x60; OR &#x60;[{\\\&quot;name\\\&quot;:\\\&quot;Abraham Lincoln\\\&quot;,\\\&quot;email\\\&quot;:\\\&quot;abraham.lincoln@klaviyo.com\\\&quot;}]&#x60;  | [default to &#39;[{\&quot;name\&quot;:\&quot;Abraham Lincoln\&quot;,\&quot;email\&quot;:\&quot;abraham.lincoln@klaviyo.com\&quot;}]&#39;] |
+| **context** | **String** | Optional, JSON object. This is the context your email template will be rendered with. Email templates are rendered with contexts in a similar manner to how Django templates are rendered. This means that nested template variables can be referenced via dot notation and template variables without corresponding context values are treated as falsy and output nothing. ex: &#x60;{ \\\&quot;name\\\&quot; : \\\&quot;George Washington\\\&quot;, \\\&quot;state\\\&quot; : \\\&quot;VA\\\&quot; }&#x60;  | [optional][default to &#39;{ \&quot;name\&quot; : \&quot;George Washington\&quot;, \&quot;state\&quot; : \&quot;VA\&quot; }&#39;] |
+
+### Return type
+
+[**RenderedTemplate**](RenderedTemplate.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## update_template
+
+> <Template> update_template(template_id, opts)
+
+Update Template
+
+Updates the name and/or HTML content of a template. Only updates imported HTML templates; does not currently update drag & drop templates.
+
+### 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::TemplatesApi.new
+template_id = 'TEMPLATE_ID' # String | 
+opts = {
+  name: 'name_example', # String | The new name of the email template.
+  html: 'html_example' # String | The new HTML content for this template.
+}
+
+begin
+  # Update Template
+  result = api_instance.update_template(template_id, opts)
+  p result
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->update_template: #{e}"
+end
+```
+
+#### Using the update_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> update_template_with_http_info(template_id, opts)
+
+```ruby
+begin
+  # Update Template
+  data, status_code, headers = api_instance.update_template_with_http_info(template_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Client::ApiError => e
+  puts "Error when calling TemplatesApi->update_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** |  | [default to &#39;TEMPLATE_ID&#39;] |
+| **name** | **String** | The new name of the email template. | [optional] |
+| **html** | **String** | The new HTML content for this template. | [optional] |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+