klaviyo-api-sdk 1.0.0

data/docs/CatalogItemUpdateJobCreateQuery.md

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

data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md

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

data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<CatalogItemUpdateQueryAsSubResource>**](CatalogItemUpdateQueryAsSubResource.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.new(
+  items: null
+)
+```
+

data/docs/CatalogItemUpdateQuery.md

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

data/docs/CatalogItemUpdateQueryAsSubResource.md

@@ -0,0 +1,24 @@
+# KlaviyoAPI::CatalogItemUpdateQueryAsSubResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **attributes** | [**CatalogItemUpdateQueryAsSubResourceAttributes**](CatalogItemUpdateQueryAsSubResourceAttributes.md) |  |  |
+| **relationships** | [**CatalogItemCreateQueryAsSubResourceRelationships**](CatalogItemCreateQueryAsSubResourceRelationships.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null
+)
+```
+

data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md

@@ -0,0 +1,32 @@
+# KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **image_full_url** | **String** |  | [optional] |
+| **image_thumbnail_url** | **String** |  | [optional] |
+| **images** | **Array<String>** |  | [optional] |
+| **custom_metadata** | **Object** |  | [optional] |
+| **published** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new(
+  title: null,
+  description: null,
+  url: null,
+  image_full_url: null,
+  image_thumbnail_url: null,
+  images: null,
+  custom_metadata: null,
+  published: null
+)
+```
+

data/docs/CatalogJobErrorPayload.md

@@ -0,0 +1,26 @@
+# KlaviyoAPI::CatalogJobErrorPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **code** | **String** |  |  |
+| **title** | **String** |  |  |
+| **detail** | **String** |  |  |
+| **source** | [**ErrorSource**](ErrorSource.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogJobErrorPayload.new(
+  id: null,
+  code: null,
+  title: null,
+  detail: null,
+  source: null
+)
+```
+

data/docs/CatalogVariantCreateJobCreateQuery.md

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

data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md

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

data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variants** | [**Array<CatalogVariantCreateQueryAsSubResource>**](CatalogVariantCreateQueryAsSubResource.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.new(
+  variants: null
+)
+```
+

data/docs/CatalogVariantCreateQuery.md

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

data/docs/CatalogVariantCreateQueryAsSubResource.md

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

data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,46 @@
+# KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** |  |  |
+| **catalog_type** | **String** |  | [optional] |
+| **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** |  |  |
+| **sku** | **String** |  |  |
+| **inventory_policy** | **Integer** | A field that controls product visibility in product feeds/blocks. This field has two options:     DENY (1): a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.     CONTINUE (2): a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.     UNKNOWN (0): the behavior will be the same as if it were set to 2 [Default] |  |
+| **inventory_quantity** | **Float** |  |  |
+| **price** | **Float** |  |  |
+| **url** | **String** |  |  |
+| **image_full_url** | **String** |  | [optional] |
+| **image_thumbnail_url** | **String** |  | [optional] |
+| **images** | **Array<String>** |  | [optional] |
+| **custom_metadata** | **Object** |  | [optional] |
+| **published** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new(
+  external_id: null,
+  catalog_type: null,
+  integration_type: null,
+  title: null,
+  description: null,
+  sku: null,
+  inventory_policy: null,
+  inventory_quantity: null,
+  price: null,
+  url: null,
+  image_full_url: null,
+  image_thumbnail_url: null,
+  images: null,
+  custom_metadata: null,
+  published: null
+)
+```
+

data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md

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

data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md

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

data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md

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

data/docs/CatalogVariantDeleteJobCreateQuery.md

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

data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md

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

data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variants** | [**Array<CatalogVariantDeleteQueryAsSubResource>**](CatalogVariantDeleteQueryAsSubResource.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.new(
+  variants: null
+)
+```
+

data/docs/CatalogVariantDeleteQueryAsSubResource.md

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

data/docs/CatalogVariantUpdateJobCreateQuery.md

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

data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md

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

data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,18 @@
+# KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variants** | [**Array<CatalogVariantUpdateQueryAsSubResource>**](CatalogVariantUpdateQueryAsSubResource.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.new(
+  variants: null
+)
+```
+

data/docs/CatalogVariantUpdateQuery.md

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

data/docs/CatalogVariantUpdateQueryAsSubResource.md

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

data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md

@@ -0,0 +1,38 @@
+# KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **inventory_policy** | **Integer** | A field that controls product visibility in product feeds/blocks. This field has two options:     DENY (1): a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.     CONTINUE (2): a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.     UNKNOWN (0): the behavior will be the same as if it were set to 2 [Default] | [optional] |
+| **inventory_quantity** | **Float** |  | [optional] |
+| **price** | **Float** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **image_full_url** | **String** |  | [optional] |
+| **image_thumbnail_url** | **String** |  | [optional] |
+| **images** | **Array<String>** |  | [optional] |
+| **custom_metadata** | **Object** |  | [optional] |
+| **published** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new(
+  title: null,
+  description: null,
+  inventory_policy: null,
+  inventory_quantity: null,
+  price: null,
+  url: null,
+  image_full_url: null,
+  image_thumbnail_url: null,
+  images: null,
+  custom_metadata: null,
+  published: null
+)
+```
+