klaviyo-api-sdk 1.0.0 → 1.1.0

data/docs/AudiencesSubObject.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::AudiencesSubObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **included** | **Array<String>** | A list of included audiences | [optional] |
+| **excluded** | **Array<String>** | An optional list of excluded audiences | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::AudiencesSubObject.new(
+  included: ["Y6nRLr"],
+  excluded: ["UTd5ui"]
+)
+```
+

data/docs/CampaignCloneQuery.md

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

data/docs/CampaignCloneQueryAsSubResource.md

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

data/docs/CampaignCloneQueryAsSubResourceAttributes.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::CampaignCloneQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The campaign ID to be cloned |  |
+| **new_name** | **String** | The name for the new cloned campaign | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignCloneQueryAsSubResourceAttributes.new(
+  id: null,
+  new_name: My cloned campaign's new name
+)
+```
+

data/docs/CampaignCreateQuery.md

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

data/docs/CampaignCreateQueryAsSubResource.md

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

data/docs/CampaignCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,28 @@
+# KlaviyoAPI::CampaignCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The campaign name |  |
+| **channel** | **String** | The type of campaign (email or sms, for example) |  |
+| **audiences** | [**AudiencesSubObject**](AudiencesSubObject.md) |  |  |
+| **send_strategy** | [**SendStrategySubObject**](SendStrategySubObject.md) |  |  |
+| **send_options** | [**SendOptionsSubObject**](SendOptionsSubObject.md) |  |  |
+| **tracking_options** | [**TrackingOptionsSubObject**](TrackingOptionsSubObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignCreateQueryAsSubResourceAttributes.new(
+  name: My new campaign,
+  channel: email,
+  audiences: null,
+  send_strategy: null,
+  send_options: null,
+  tracking_options: null
+)
+```
+

data/docs/CampaignMessageAssignTemplateQuery.md

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

data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md

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

data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::CampaignMessageAssignTemplateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The message ID to be assigned to |  |
+| **template_id** | **String** | The template ID to assign |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignMessageAssignTemplateQueryAsSubResourceAttributes.new(
+  id: null,
+  template_id: RipRmi
+)
+```
+

data/docs/CampaignMessagePartialUpdateQuery.md

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

data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::CampaignMessagePartialUpdateQueryAsSubResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **id** | **String** | The message ID to be retrieved |  |
+| **attributes** | [**CampaignMessagePartialUpdateQueryAsSubResourceAttributes**](CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignMessagePartialUpdateQueryAsSubResource.new(
+  type: null,
+  id: null,
+  attributes: null
+)
+```
+

data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::CampaignMessagePartialUpdateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The label or name on the message | [optional] |
+| **content** | [**ContentSubObject**](ContentSubObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignMessagePartialUpdateQueryAsSubResourceAttributes.new(
+  label: My message name,
+  content: null
+)
+```
+

data/docs/CampaignPartialUpdateQuery.md

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

data/docs/CampaignPartialUpdateQueryAsSubResource.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::CampaignPartialUpdateQueryAsSubResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **id** | **String** | The campaign ID to be retrieved |  |
+| **attributes** | [**CampaignPartialUpdateQueryAsSubResourceAttributes**](CampaignPartialUpdateQueryAsSubResourceAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignPartialUpdateQueryAsSubResource.new(
+  type: null,
+  id: null,
+  attributes: null
+)
+```
+

data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md

@@ -0,0 +1,26 @@
+# KlaviyoAPI::CampaignPartialUpdateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The campaign name | [optional] |
+| **audiences** | [**AudiencesSubObject**](AudiencesSubObject.md) |  | [optional] |
+| **send_options** | [**SendOptionsSubObject**](SendOptionsSubObject.md) |  | [optional] |
+| **tracking_options** | [**TrackingOptionsSubObject**](TrackingOptionsSubObject.md) |  | [optional] |
+| **send_strategy** | [**SendStrategySubObject**](SendStrategySubObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignPartialUpdateQueryAsSubResourceAttributes.new(
+  name: My new campaign,
+  audiences: null,
+  send_options: null,
+  tracking_options: null,
+  send_strategy: null
+)
+```
+

data/docs/CampaignSendJobCreateQuery.md

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

data/docs/CampaignSendJobCreateQueryAsSubResource.md

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

data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::CampaignSendJobCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the campaign to send |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignSendJobCreateQueryAsSubResourceAttributes.new(
+  id: null
+)
+```
+

data/docs/CampaignSendJobPartialUpdateQuery.md

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

data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::CampaignSendJobPartialUpdateQueryAsSubResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **id** | **String** | The ID of the currently sending campaign to cancel or revert |  |
+| **attributes** | [**CampaignSendJobPartialUpdateQueryAsSubResourceAttributes**](CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignSendJobPartialUpdateQueryAsSubResource.new(
+  type: null,
+  id: null,
+  attributes: null
+)
+```
+

data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::CampaignSendJobPartialUpdateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | The action you would like to take with this send job from among 'cancel' and 'revert' |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.new(
+  action: cancel
+)
+```
+

data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md

@@ -7,7 +7,7 @@
 | **external_id** | **String** |  |  |
 | **name** | **String** |  |  |
 | **integration_type** | **String** | The integration type. Currently, this can only be set to $custom (and defaults to $custom if not included in the payload). | [optional] |
-| **catalog_type** | **String** |  | [optional] |
+| **catalog_type** | **String** |  | [optional][default to '$default'] |
 
 ## Example
 
@@ -18,7 +18,7 @@ instance = KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new(
   external_id: null,
   name: null,
   integration_type: null,
-  catalog_type: null
+  catalog_type: $default
 )
 ```
 

data/docs/CatalogCategoryDeleteQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs  & non-custom integrations is forthcoming. |  |
 
 ## Example
 

data/docs/CatalogCategoryUpdateQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs  & non-custom integrations is forthcoming. |  |
 | **attributes** | [**CatalogCategoryUpdateQueryAsSubResourceAttributes**](CatalogCategoryUpdateQueryAsSubResourceAttributes.md) |  |  |
 | **relationships** | [**CatalogVariantCreateQueryAsSubResourceRelationships**](CatalogVariantCreateQueryAsSubResourceRelationships.md) |  | [optional] |
 

data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md

@@ -7,14 +7,14 @@
 | **external_id** | **String** |  |  |
 | **integration_type** | **String** | The integration type. Currently, this can only be set to $custom (and defaults to $custom if not included in the payload). | [optional] |
 | **title** | **String** |  |  |
-| **catalog_type** | **String** |  | [optional] |
+| **catalog_type** | **String** |  | [optional][default to '$default'] |
 | **description** | **String** |  |  |
 | **url** | **String** |  |  |
 | **image_full_url** | **String** |  | [optional] |
 | **image_thumbnail_url** | **String** |  | [optional] |
 | **images** | **Array<String>** |  | [optional] |
 | **custom_metadata** | **Object** |  | [optional] |
-| **published** | **Boolean** |  | [optional] |
+| **published** | **Boolean** |  | [optional][default to true] |
 
 ## Example
 
@@ -25,14 +25,14 @@ instance = KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new(
   external_id: null,
   integration_type: null,
   title: null,
-  catalog_type: null,
+  catalog_type: $default,
   description: null,
   url: null,
   image_full_url: null,
   image_thumbnail_url: null,
   images: null,
   custom_metadata: null,
-  published: null
+  published: true
 )
 ```
 

data/docs/CatalogItemDeleteQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs  & non-custom integrations is forthcoming. |  |
 
 ## Example
 

data/docs/CatalogItemUpdateQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs  & non-custom integrations is forthcoming. |  |
 | **attributes** | [**CatalogItemUpdateQueryAsSubResourceAttributes**](CatalogItemUpdateQueryAsSubResourceAttributes.md) |  |  |
 | **relationships** | [**CatalogItemCreateQueryAsSubResourceRelationships**](CatalogItemCreateQueryAsSubResourceRelationships.md) |  | [optional] |
 

data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **external_id** | **String** |  |  |
-| **catalog_type** | **String** |  | [optional] |
+| **catalog_type** | **String** |  | [optional][default to '$default'] |
 | **integration_type** | **String** | The integration type. Currently, this can only be set to $custom (and defaults to $custom if not included in the payload). | [optional] |
 | **title** | **String** |  |  |
 | **description** | **String** |  |  |
@@ -18,7 +18,7 @@
 | **image_thumbnail_url** | **String** |  | [optional] |
 | **images** | **Array<String>** |  | [optional] |
 | **custom_metadata** | **Object** |  | [optional] |
-| **published** | **Boolean** |  | [optional] |
+| **published** | **Boolean** |  | [optional][default to true] |
 
 ## Example
 
@@ -27,7 +27,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new(
   external_id: null,
-  catalog_type: null,
+  catalog_type: $default,
   integration_type: null,
   title: null,
   description: null,
@@ -40,7 +40,7 @@ instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new(
   image_thumbnail_url: null,
   images: null,
   custom_metadata: null,
-  published: null
+  published: true
 )
 ```
 

data/docs/CatalogVariantDeleteQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs  & non-custom integrations is forthcoming. |  |
 
 ## Example
 

data/docs/CatalogVariantUpdateQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs  & non-custom integrations is forthcoming. |  |
 | **attributes** | [**CatalogVariantUpdateQueryAsSubResourceAttributes**](CatalogVariantUpdateQueryAsSubResourceAttributes.md) |  |  |
 
 ## Example