klaviyo-api-sdk 13.0.0 → 13.0.1

data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md

@@ -0,0 +1,46 @@
+# KlaviyoAPI::CatalogVariantCreateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** | The ID of the catalog item variant in an external system. |  |
+| **catalog_type** | **String** | The type of catalog. Currently only \"$default\" is supported. | [optional][default to '$default'] |
+| **integration_type** | **String** | The integration type. Currently only \"$custom\" is supported. | [optional][default to '$custom'] |
+| **title** | **String** | The title of the catalog item variant. |  |
+| **description** | **String** | A description of the catalog item variant. |  |
+| **sku** | **String** | The SKU of the catalog item variant. |  |
+| **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional][default to INVENTORY_POLICY::N0] |
+| **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. |  |
+| **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). |  |
+| **url** | **String** | URL pointing to the location of the catalog item variant on your website. |  |
+| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
+| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
+| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
+| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
+| **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantCreateQueryResourceObjectAttributes.new(
+  external_id: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
+  catalog_type: $default,
+  integration_type: $custom,
+  title: Ocean Blue Shirt (Sample) Variant Medium,
+  description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
+  sku: OBS-MD,
+  inventory_policy: 2,
+  inventory_quantity: 25,
+  price: 42,
+  url: https://via.placeholder.com/150,
+  image_full_url: https://via.placeholder.com/300,
+  image_thumbnail_url: https://via.placeholder.com/150,
+  images: ["https://via.placeholder.com/150"],
+  custom_metadata: {"Top Pick":true},
+  published: true
+)
+```
+

data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md

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

data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md

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

data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**CatalogItemEnum**](CatalogItemEnum.md) |  |  |
+| **id** | **String** | The original catalog item ID for which this is a variant. |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemData.new(
+  type: null,
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1
+)
+```
+

data/docs/CatalogVariantDeleteJobCreateQuery.md

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

data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md

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

data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md

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

data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.md

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

data/docs/CatalogVariantDeleteQueryResourceObject.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::CatalogVariantDeleteQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**CatalogVariantEnum**](CatalogVariantEnum.md) |  |  |
+| **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`. |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantDeleteQueryResourceObject.new(
+  type: null,
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM
+)
+```
+

data/docs/CatalogVariantEnum.md

@@ -0,0 +1,15 @@
+# KlaviyoAPI::CatalogVariantEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantEnum.new()
+```
+

data/docs/CatalogVariantUpdateJobCreateQuery.md

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

data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md

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

data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md

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

data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.md

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

data/docs/CatalogVariantUpdateQuery.md

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

data/docs/CatalogVariantUpdateQueryResourceObject.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::CatalogVariantUpdateQueryResourceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**CatalogVariantEnum**](CatalogVariantEnum.md) |  |  |
+| **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`. |  |
+| **attributes** | [**CatalogVariantUpdateQueryResourceObjectAttributes**](CatalogVariantUpdateQueryResourceObjectAttributes.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantUpdateQueryResourceObject.new(
+  type: null,
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
+  attributes: null
+)
+```
+

data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md

@@ -0,0 +1,40 @@
+# KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | The title of the catalog item variant. | [optional] |
+| **description** | **String** | A description of the catalog item variant. | [optional] |
+| **sku** | **String** | The SKU of the catalog item variant. | [optional] |
+| **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional] |
+| **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | [optional] |
+| **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). | [optional] |
+| **url** | **String** | URL pointing to the location of the catalog item variant on your website. | [optional] |
+| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
+| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
+| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
+| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
+| **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes.new(
+  title: Ocean Blue Shirt (Sample) Variant Medium,
+  description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
+  sku: OBS-MD,
+  inventory_policy: 2,
+  inventory_quantity: 25,
+  price: 42,
+  url: https://via.placeholder.com/150,
+  image_full_url: https://via.placeholder.com/300,
+  image_thumbnail_url: https://via.placeholder.com/150,
+  images: ["https://via.placeholder.com/150"],
+  custom_metadata: {"Top Pick":true},
+  published: true
+)
+```
+