RubyGems - klaviyo-api-sdk - Versions diffs - 1.0.1 → 1.1.0 - Mend

klaviyo-api-sdk 1.0.1 → 1.1.0

Files changed (530) hide show

data/docs/TemplateCloneQueryAsSubResource.md CHANGED Viewed

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
+| **id** | **Object** | The ID of MessageTemplate |  |
 | **attributes** | [**TemplateCloneQueryAsSubResourceAttributes**](TemplateCloneQueryAsSubResourceAttributes.md) |  |  |
 ## Example
@@ -14,6 +15,7 @@ require 'klaviyo-api-sdk'
 instance = KlaviyoAPI::TemplateCloneQueryAsSubResource.new(
   type: null,
+  id: null,
   attributes: null
 )
 ```

data/docs/TemplateCloneQueryAsSubResourceAttributes.md CHANGED Viewed

@@ -4,8 +4,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **return_fields** | **Array&lt;String&gt;** |  | [optional] |
+| **id** | **String** | The ID of template to be cloned |  |
+| **name** | **String** | The name of the template | [optional] |
+| **return_fields** | **Array&lt;String&gt;** | Any subset of TemplateResponse fields | [optional] |
 ## Example
@@ -13,7 +14,8 @@
 require 'klaviyo-api-sdk'
 instance = KlaviyoAPI::TemplateCloneQueryAsSubResourceAttributes.new(
-  name: null,
+  id: null,
+  name: Clone of Monthly Newsletter Template,
   return_fields: null
 )
 ```

data/docs/TemplateCreateQueryAsSubResourceAttributes.md CHANGED Viewed

@@ -4,11 +4,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  |  |
-| **editor_type** | **String** |  |  |
-| **html** | **String** |  | [optional] |
-| **text** | **String** |  | [optional] |
-| **return_fields** | **Array&lt;String&gt;** |  | [optional] |
+| **name** | **String** | The name of the template |  |
+| **editor_type** | **String** | Restricted to CODE |  |
+| **html** | **String** | The HTML contents of the template | [optional] |
+| **text** | **String** | The plaintext version of the template | [optional] |
+| **return_fields** | **Array&lt;String&gt;** | Provide fields to limit the returned data | [optional] |
 ## Example
@@ -16,10 +16,16 @@
 require 'klaviyo-api-sdk'
 instance = KlaviyoAPI::TemplateCreateQueryAsSubResourceAttributes.new(
-  name: null,
+  name: Monthly Newsletter Template,
   editor_type: null,
-  html: null,
-  text: null,
+  html:
+            &lt;html&gt;
+                &lt;body&gt;
+                    hello world
+                &lt;/body&gt;
+            &lt;/html&gt;
+        ,
+  text: hello world,
   return_fields: null
 )
 ```

data/docs/TemplateRenderQuery.md ADDED Viewed

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

data/docs/TemplateRenderQueryAsSubResource.md ADDED Viewed

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

data/docs/TemplateRenderQueryAsSubResourceAttributes.md ADDED Viewed

@@ -0,0 +1,22 @@
+# KlaviyoAPI::TemplateRenderQueryAsSubResourceAttributes
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of template |  |
+| **context** | **Object** | The context for the template render. This must be a JSON object which has values for any tags used in the template. See [this doc](https://help.klaviyo.com/hc/en-us/articles/115005084927-Template-tags-and-variable-syntax-reference-classic-editor-) for more details. |  |
+| **return_fields** | **Array&lt;String&gt;** | Provide fields to limit the returned data | [optional] |
+## Example
+```ruby
+require 'klaviyo-api-sdk'
+instance = KlaviyoAPI::TemplateRenderQueryAsSubResourceAttributes.new(
+  id: null,
+  context: {&quot;first_name&quot;:&quot;Jane&quot;,&quot;last_name&quot;:&quot;Smith&quot;},
+  return_fields: null
+)
+```

data/docs/TemplateUpdateQueryAsSubResource.md CHANGED Viewed

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The ID of template |  |
 | **attributes** | [**TemplateUpdateQueryAsSubResourceAttributes**](TemplateUpdateQueryAsSubResourceAttributes.md) |  |  |
 ## Example

data/docs/TemplateUpdateQueryAsSubResourceAttributes.md CHANGED Viewed

@@ -4,10 +4,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **html** | **String** |  | [optional] |
-| **text** | **String** |  | [optional] |
-| **return_fields** | **Array&lt;String&gt;** |  | [optional] |
+| **name** | **String** | The name of the template | [optional] |
+| **html** | **String** | The HTML of the template | [optional] |
+| **text** | **String** | The plaintext of the template | [optional] |
+| **return_fields** | **Array&lt;String&gt;** | Provide fields to limit the returned data | [optional] |
 ## Example
@@ -15,9 +15,15 @@
 require 'klaviyo-api-sdk'
 instance = KlaviyoAPI::TemplateUpdateQueryAsSubResourceAttributes.new(
-  name: null,
-  html: null,
-  text: null,
+  name: Monthly Newsletter Template,
+  html:
+              &lt;html&gt;
+                  &lt;body&gt;
+                      hello world
+                  &lt;/body&gt;
+              &lt;/html&gt;
+          ,
+  text: hello world,
   return_fields: null
 )
 ```

data/docs/TemplatesApi.md CHANGED Viewed

@@ -5,8 +5,8 @@ All URIs are relative to *https://a.klaviyo.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_template**](TemplatesApi.md#create_template) | **POST** /api/templates/ | Create Template |
-| [**create_template_clone**](TemplatesApi.md#create_template_clone) | **POST** /api/templates/{id}/clone/ | Create Template Clone |
-| [**create_template_render**](TemplatesApi.md#create_template_render) | **POST** /api/templates/{id}/render/ | Create Template Render |
+| [**create_template_clone**](TemplatesApi.md#create_template_clone) | **POST** /api/template-clone/ | Create Template Clone |
+| [**create_template_render**](TemplatesApi.md#create_template_render) | **POST** /api/template-render/ | Create Template Render |
 | [**delete_template**](TemplatesApi.md#delete_template) | **DELETE** /api/templates/{id}/ | Delete Template |
 | [**get_template**](TemplatesApi.md#get_template) | **GET** /api/templates/{id}/ | Get Template |
 | [**get_templates**](TemplatesApi.md#get_templates) | **GET** /api/templates/ | Get Templates |
@@ -19,7 +19,7 @@ All URIs are relative to *https://a.klaviyo.com*
 Create Template
-Create a new custom HTML template. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Write`
+Create a new custom HTML template. If there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates that can be created via the API. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Write`
 ### Examples
@@ -35,7 +35,7 @@ KlaviyoAPI.configure do |config|
 end
 api_instance = KlaviyoAPI::TemplatesApi.new
-template_create_query = KlaviyoAPI::TemplateCreateQuery.new({data: KlaviyoAPI::TemplateCreateQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::TemplateCreateQueryAsSubResourceAttributes.new({name: 'name_example', editor_type: 'editor_type_example'})})}) # TemplateCreateQuery | Query for creating a CODE template
+template_create_query = KlaviyoAPI::TemplateCreateQuery.new({data: KlaviyoAPI::TemplateCreateQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::TemplateCreateQueryAsSubResourceAttributes.new({name: 'Monthly Newsletter Template', editor_type: 'editor_type_example'})})}) # TemplateCreateQuery |
 begin
   # Create Template
@@ -68,7 +68,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **template_create_query** | [**TemplateCreateQuery**](TemplateCreateQuery.md) | Query for creating a CODE template |  |
+| **template_create_query** | [**TemplateCreateQuery**](TemplateCreateQuery.md) |  |  |
 ### Return type
@@ -86,11 +86,11 @@ end
 ## create_template_clone
-> Hash&lt;String, Object&gt; create_template_clone(id, template_clone_query)
+> Hash&lt;String, Object&gt; create_template_clone(template_clone_query)
 Create Template Clone
-Create a clone of a template with the given template ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Write`
+Create a clone of a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Write`
 ### Examples
@@ -106,12 +106,11 @@ KlaviyoAPI.configure do |config|
 end
 api_instance = KlaviyoAPI::TemplatesApi.new
-id = 'id_example' # String |
-template_clone_query = KlaviyoAPI::TemplateCloneQuery.new({data: KlaviyoAPI::TemplateCloneQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::TemplateCloneQueryAsSubResourceAttributes.new})}) # TemplateCloneQuery | Query for cloning a template
+template_clone_query = KlaviyoAPI::TemplateCloneQuery.new({data: KlaviyoAPI::TemplateCloneQueryAsSubResource.new({type: 'template', id: 3.56, attributes: KlaviyoAPI::TemplateCloneQueryAsSubResourceAttributes.new({id: 'id_example'})})}) # TemplateCloneQuery |
 begin
   # Create Template Clone
-  result = api_instance.create_template_clone(id, template_clone_query)
+  result = api_instance.create_template_clone(template_clone_query)
   p result
 rescue KlaviyoAPI::ApiError => e
   puts "Error when calling TemplatesApi->create_template_clone: #{e}"
@@ -122,12 +121,12 @@ end
 This returns an Array which contains the response data, status code and headers.
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_template_clone_with_http_info(id, template_clone_query)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_template_clone_with_http_info(template_clone_query)
 ```ruby
 begin
   # Create Template Clone
-  data, status_code, headers = api_instance.create_template_clone_with_http_info(id, template_clone_query)
+  data, status_code, headers = api_instance.create_template_clone_with_http_info(template_clone_query)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
@@ -140,8 +139,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **template_clone_query** | [**TemplateCloneQuery**](TemplateCloneQuery.md) | Query for cloning a template |  |
+| **template_clone_query** | [**TemplateCloneQuery**](TemplateCloneQuery.md) |  |  |
 ### Return type
@@ -159,11 +157,11 @@ end
 ## create_template_render
-> Hash&lt;String, Object&gt; create_template_render(id, v2_template_render_query)
+> Hash&lt;String, Object&gt; create_template_render(template_render_query)
 Create Template Render
-Render a template with the given template ID and context attribute. Returns the HTML and plain text versions of the email template.  **Request body parameters** (nested under `attributes`):  * `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). * `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object.  Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing.  Ex. `{ \"name\" : \"George Washington\", \"state\" : \"VA\" }`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Templates Read`
+Render a template with the given template ID and context attribute. Returns the HTML and plain text versions of the email template.  **Request body parameters** (nested under `attributes`):  * `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets). * `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object.  Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing.  Ex. `{ \"name\" : \"George Washington\", \"state\" : \"VA\" }`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Templates Read`
 ### Examples
@@ -179,12 +177,11 @@ KlaviyoAPI.configure do |config|
 end
 api_instance = KlaviyoAPI::TemplatesApi.new
-id = 'id_example' # String |
-v2_template_render_query = KlaviyoAPI::V2TemplateRenderQuery.new({data: KlaviyoAPI::V2TemplateRenderQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::V2TemplateRenderQueryAsSubResourceAttributes.new({context: 3.56})})}) # V2TemplateRenderQuery | Query for rendering a template
+template_render_query = KlaviyoAPI::TemplateRenderQuery.new({data: KlaviyoAPI::TemplateRenderQueryAsSubResource.new({type: 'template', attributes: KlaviyoAPI::TemplateRenderQueryAsSubResourceAttributes.new({id: 'id_example', context: {"first_name":"Jane","last_name":"Smith"}})})}) # TemplateRenderQuery |
 begin
   # Create Template Render
-  result = api_instance.create_template_render(id, v2_template_render_query)
+  result = api_instance.create_template_render(template_render_query)
   p result
 rescue KlaviyoAPI::ApiError => e
   puts "Error when calling TemplatesApi->create_template_render: #{e}"
@@ -195,12 +192,12 @@ end
 This returns an Array which contains the response data, status code and headers.
-> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_template_render_with_http_info(id, v2_template_render_query)
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_template_render_with_http_info(template_render_query)
 ```ruby
 begin
   # Create Template Render
-  data, status_code, headers = api_instance.create_template_render_with_http_info(id, v2_template_render_query)
+  data, status_code, headers = api_instance.create_template_render_with_http_info(template_render_query)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Hash&lt;String, Object&gt;
@@ -213,8 +210,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **v2_template_render_query** | [**V2TemplateRenderQuery**](V2TemplateRenderQuery.md) | Query for rendering a template |  |
+| **template_render_query** | [**TemplateRenderQuery**](TemplateRenderQuery.md) |  |  |
 ### Return type
@@ -252,7 +248,7 @@ KlaviyoAPI.configure do |config|
 end
 api_instance = KlaviyoAPI::TemplatesApi.new
-id = 'id_example' # String |
+id = 'id_example' # String | The ID of template
 begin
   # Delete Template
@@ -285,7 +281,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+| **id** | **String** | The ID of template |  |
 ### Return type
@@ -307,7 +303,7 @@ end
 Get Template
-Get a template with the given template ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Read`
+Get a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Read`
 ### Examples
@@ -323,9 +319,9 @@ KlaviyoAPI.configure do |config|
 end
 api_instance = KlaviyoAPI::TemplatesApi.new
-id = 'id_example' # String |
+id = 'id_example' # String | The ID of template
 opts = {
-  fields_template: ['company_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
+  fields_template: ['company_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
 }
 begin
@@ -359,8 +355,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
+| **id** | **String** | The ID of template |  |
+| **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
 ### Return type
@@ -382,7 +378,7 @@ end
 Get Templates
-Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 20 results per page. Results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Read`
+Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 20 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Read`
 ### Examples
@@ -399,10 +395,10 @@ end
 api_instance = KlaviyoAPI::TemplatesApi.new
 opts = {
-  fields_template: ['company_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
-  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
+  fields_template: ['company_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
+  sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
 }
 begin
@@ -436,10 +432,10 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | [optional] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting | [optional] |
+| **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
 ### Return type
@@ -461,7 +457,7 @@ end
 Update Template
-Update a template with the given template ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Write`
+Update a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Templates Write`
 ### Examples
@@ -477,8 +473,8 @@ KlaviyoAPI.configure do |config|
 end
 api_instance = KlaviyoAPI::TemplatesApi.new
-id = 'id_example' # String |
-template_update_query = KlaviyoAPI::TemplateUpdateQuery.new({data: KlaviyoAPI::TemplateUpdateQueryAsSubResource.new({type: 'template', id: 'id_example', attributes: KlaviyoAPI::TemplateUpdateQueryAsSubResourceAttributes.new})}) # TemplateUpdateQuery | Query for updating a CODE template
+id = 'id_example' # String | The ID of template
+template_update_query = KlaviyoAPI::TemplateUpdateQuery.new({data: KlaviyoAPI::TemplateUpdateQueryAsSubResource.new({type: 'template', id: 'id_example', attributes: KlaviyoAPI::TemplateUpdateQueryAsSubResourceAttributes.new})}) # TemplateUpdateQuery |
 begin
   # Update Template
@@ -511,8 +507,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **template_update_query** | [**TemplateUpdateQuery**](TemplateUpdateQuery.md) | Query for updating a CODE template |  |
+| **id** | **String** | The ID of template |  |
+| **template_update_query** | [**TemplateUpdateQuery**](TemplateUpdateQuery.md) |  |  |
 ### Return type

data/docs/ThrottledScheduleOptions.md ADDED Viewed

@@ -0,0 +1,20 @@
+# KlaviyoAPI::ThrottledScheduleOptions
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datetime** | **Time** | The time to send at |  |
+| **throttle_percentage** | **Integer** | The percentage of recipients per hour to send to. Allowed values: [10, 11, 13, 14, 17, 20, 25, 33, 50] |  |
+## Example
+```ruby
+require 'klaviyo-api-sdk'
+instance = KlaviyoAPI::ThrottledScheduleOptions.new(
+  datetime: null,
+  throttle_percentage: 10
+)
+```

data/docs/TrackingOptionsSubObject.md ADDED Viewed

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

data/docs/UTMParamsSubObject.md ADDED Viewed

@@ -0,0 +1,20 @@
+# KlaviyoAPI::UTMParamsSubObject
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the UTM param |  |
+| **value** | **String** | Value of the UTM param. Can be templated data. |  |
+## Example
+```ruby
+require 'klaviyo-api-sdk'
+instance = KlaviyoAPI::UTMParamsSubObject.new(
+  name: utm_medium,
+  value: campaign
+)
+```

data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md CHANGED Viewed

@@ -4,9 +4,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **list_id** | **String** |  |  |
-| **emails** | **Array&lt;String&gt;** |  | [optional] |
-| **phone_numbers** | **Array&lt;String&gt;** |  | [optional] |
+| **list_id** | **String** | Optional, the list to remove the profiles from | [optional] |
+| **emails** | **Array&lt;String&gt;** | The emails to unsubscribe if any. | [optional] |
+| **phone_numbers** | **Array&lt;String&gt;** | The phone numbers to unsubscribe if any. | [optional] |
 ## Example

data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md CHANGED Viewed

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **attributes** | [**SuppressionCreateJobCreateQueryAsSubResourceAttributes**](SuppressionCreateJobCreateQueryAsSubResourceAttributes.md) |  |  |
+| **attributes** | [**UnsuppressionCreateJobCreateQueryAsSubResourceAttributes**](UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md) |  |  |
 ## Example

data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md ADDED Viewed

@@ -0,0 +1,18 @@
+# KlaviyoAPI::UnsuppressionCreateJobCreateQueryAsSubResourceAttributes
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suppressions** | [**Array&lt;Suppression&gt;**](Suppression.md) | One or more suppressions to be removed. |  |
+## Example
+```ruby
+require 'klaviyo-api-sdk'
+instance = KlaviyoAPI::UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.new(
+  suppressions: null
+)
+```

data/docs/V2TemplateRenderQueryAsSubResource.md CHANGED Viewed

@@ -4,8 +4,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** |  |  |
-| **attributes** | [**V2TemplateRenderQueryAsSubResourceAttributes**](V2TemplateRenderQueryAsSubResourceAttributes.md) |  |  |
+| **id** | **Object** | The ID of MessageTemplate |  |
 ## Example
@@ -13,8 +12,7 @@
 require 'klaviyo-api-sdk'
 instance = KlaviyoAPI::V2TemplateRenderQueryAsSubResource.new(
-  type: null,
-  attributes: null
+  id: null
 )
 ```

data/klaviyo-api-sdk.gemspec CHANGED Viewed

@@ -5,10 +5,10 @@
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
-The version of the OpenAPI document: 2022-10-17
+The version of the OpenAPI document: 2023-01-24
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+OpenAPI Generator version: 6.2.1
 =end
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
 Gem::Specification.new do |s|
   s.name        = "klaviyo-api-sdk"
-  s.version     = "1.0.1"
+  s.version     = "1.1.0"
   s.authors     = ['Klaviyo Team']
   s.email       = ['libraries@klaviyo.com']
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'