klaviyo-api-sdk 1.0.1 → 1.2.0

data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **categories** | [**Array<CatalogCategoryCreateQueryAsSubResource>**](CatalogCategoryCreateQueryAsSubResource.md) |  |  |
+| **categories** | [**Array<CatalogCategoryCreateQueryAsSubResource>**](CatalogCategoryCreateQueryAsSubResource.md) | Array of catalog categories to create. |  |
 
 ## Example
 

data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
+| **external_id** | **String** | The ID of the catalog category in an external system. |  |
+| **name** | **String** | The name of the catalog category. |  |
+| **integration_type** | **String** | The integration type. Currently only \"$custom\" is supported. | [optional] |
+| **catalog_type** | **String** | The type of catalog. Currently only \"$default\" is supported. | [optional][default to '$default'] |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new(
-  external_id: null,
-  name: null,
+  external_id: SAMPLE-DATA-CATEGORY-APPAREL,
+  name: Sample Data Category Apparel,
   integration_type: null,
-  catalog_type: null
+  catalog_type: $default
 )
 ```
 

data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **categories** | [**Array<CatalogCategoryDeleteQueryAsSubResource>**](CatalogCategoryDeleteQueryAsSubResource.md) |  |  |
+| **categories** | [**Array<CatalogCategoryDeleteQueryAsSubResource>**](CatalogCategoryDeleteQueryAsSubResource.md) | Array of catalog categories to delete. |  |
 
 ## Example
 

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`. |  |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogCategoryDeleteQueryAsSubResource.new(
   type: null,
-  id: null
+  id: $custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL
 )
 ```
 

data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **categories** | [**Array<CatalogCategoryUpdateQueryAsSubResource>**](CatalogCategoryUpdateQueryAsSubResource.md) |  |  |
+| **categories** | [**Array<CatalogCategoryUpdateQueryAsSubResource>**](CatalogCategoryUpdateQueryAsSubResource.md) | Array of catalog categories to update. |  |
 
 ## 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`. |  |
 | **attributes** | [**CatalogCategoryUpdateQueryAsSubResourceAttributes**](CatalogCategoryUpdateQueryAsSubResourceAttributes.md) |  |  |
 | **relationships** | [**CatalogVariantCreateQueryAsSubResourceRelationships**](CatalogVariantCreateQueryAsSubResourceRelationships.md) |  | [optional] |
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new(
   type: null,
-  id: null,
+  id: $custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL,
   attributes: null,
   relationships: null
 )

data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
+| **name** | **String** | The name of the catalog category. | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new(
-  name: null
+  name: Sample Data Category Apparel
 )
 ```
 

data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **items** | [**Array<CatalogItemCreateQueryAsSubResource>**](CatalogItemCreateQueryAsSubResource.md) |  |  |
+| **items** | [**Array<CatalogItemCreateQueryAsSubResource>**](CatalogItemCreateQueryAsSubResource.md) | Array of catalog items to create. |  |
 
 ## Example
 

data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md

@@ -4,17 +4,18 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
-| **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] |
+| **external_id** | **String** | The ID of the catalog item in an external system. |  |
+| **integration_type** | **String** | The integration type. Currently only \"$custom\" is supported. | [optional] |
+| **title** | **String** | The title of the catalog item. |  |
+| **price** | **Float** | This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant). | [optional] |
+| **catalog_type** | **String** | The type of catalog. Currently only \"$default\" is supported. | [optional][default to '$default'] |
+| **description** | **String** | A description of the catalog item. |  |
+| **url** | **String** | URL pointing to the location of the catalog item on your website. |  |
+| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item. | [optional] |
+| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item | [optional] |
+| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item. | [optional] |
+| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb. | [optional] |
+| **published** | **Boolean** | Boolean value indicating whether the catalog item is published. | [optional][default to true] |
 
 ## Example
 
@@ -22,17 +23,18 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new(
-  external_id: null,
+  external_id: SAMPLE-DATA-ITEM-1,
   integration_type: null,
-  title: null,
-  catalog_type: null,
-  description: null,
-  url: null,
-  image_full_url: null,
-  image_thumbnail_url: null,
-  images: null,
-  custom_metadata: null,
-  published: null
+  title: Ocean Blue Shirt (Sample),
+  price: 42,
+  catalog_type: $default,
+  description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
+  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/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **items** | [**Array<CatalogItemDeleteQueryAsSubResource>**](CatalogItemDeleteQueryAsSubResource.md) |  |  |
+| **items** | [**Array<CatalogItemDeleteQueryAsSubResource>**](CatalogItemDeleteQueryAsSubResource.md) | Array of catalog items to delete. |  |
 
 ## Example
 

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`. |  |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogItemDeleteQueryAsSubResource.new(
   type: null,
-  id: null
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1
 )
 ```
 

data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **items** | [**Array<CatalogItemUpdateQueryAsSubResource>**](CatalogItemUpdateQueryAsSubResource.md) |  |  |
+| **items** | [**Array<CatalogItemUpdateQueryAsSubResource>**](CatalogItemUpdateQueryAsSubResource.md) | Array of catalog items to update. |  |
 
 ## 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`. |  |
 | **attributes** | [**CatalogItemUpdateQueryAsSubResourceAttributes**](CatalogItemUpdateQueryAsSubResourceAttributes.md) |  |  |
 | **relationships** | [**CatalogItemCreateQueryAsSubResourceRelationships**](CatalogItemCreateQueryAsSubResourceRelationships.md) |  | [optional] |
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new(
   type: null,
-  id: null,
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1,
   attributes: null,
   relationships: null
 )

data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md

@@ -4,14 +4,15 @@
 
 | 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] |
+| **title** | **String** | The title of the catalog item. | [optional] |
+| **price** | **Float** | This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant). | [optional] |
+| **description** | **String** | A description of the catalog item. | [optional] |
+| **url** | **String** | URL pointing to the location of the catalog item on your website. | [optional] |
+| **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item. | [optional] |
+| **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item | [optional] |
+| **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item. | [optional] |
+| **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb. | [optional] |
+| **published** | **Boolean** | Boolean value indicating whether the catalog item is published. | [optional] |
 
 ## Example
 
@@ -19,14 +20,15 @@
 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
+  title: Ocean Blue Shirt (Sample),
+  price: 42,
+  description: A description of the catalog item.,
+  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/CatalogJobErrorPayload.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **code** | **String** |  |  |
-| **title** | **String** |  |  |
-| **detail** | **String** |  |  |
+| **id** | **String** | Unique identifier for the error. |  |
+| **code** | **String** | A code for classifying the error type. |  |
+| **title** | **String** | A high-level message about the error. |  |
+| **detail** | **String** | Specific details about the error. |  |
 | **source** | [**ErrorSource**](ErrorSource.md) |  |  |
 
 ## Example
@@ -16,10 +16,10 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogJobErrorPayload.new(
-  id: null,
-  code: null,
-  title: null,
-  detail: null,
+  id: e4eebb08-b055-4a6f-bb13-c8cb69c9eb94,
+  code: invalid,
+  title: Invalid input,
+  detail: The payload provided in the request is invalid.,
   source: null
 )
 ```

data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **variants** | [**Array<CatalogVariantCreateQueryAsSubResource>**](CatalogVariantCreateQueryAsSubResource.md) |  |  |
+| **variants** | [**Array<CatalogVariantCreateQueryAsSubResource>**](CatalogVariantCreateQueryAsSubResource.md) | Array of catalog variants to create. |  |
 
 ## Example
 

data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md

@@ -4,21 +4,21 @@
 
 | 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] |
+| **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] |
+| **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] |
+| **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
 
@@ -26,21 +26,21 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new(
-  external_id: null,
-  catalog_type: null,
+  external_id: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
+  catalog_type: $default,
   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
+  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: 25,
+  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/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **variants** | [**Array<CatalogVariantDeleteQueryAsSubResource>**](CatalogVariantDeleteQueryAsSubResource.md) |  |  |
+| **variants** | [**Array<CatalogVariantDeleteQueryAsSubResource>**](CatalogVariantDeleteQueryAsSubResource.md) | Array of catalog variants to delete. |  |
 
 ## Example
 

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`. |  |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogVariantDeleteQueryAsSubResource.new(
   type: null,
-  id: null
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM
 )
 ```
 

data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **variants** | [**Array<CatalogVariantUpdateQueryAsSubResource>**](CatalogVariantUpdateQueryAsSubResource.md) |  |  |
+| **variants** | [**Array<CatalogVariantUpdateQueryAsSubResource>**](CatalogVariantUpdateQueryAsSubResource.md) | Array of catalog variants to update. |  |
 
 ## 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`. |  |
 | **attributes** | [**CatalogVariantUpdateQueryAsSubResourceAttributes**](CatalogVariantUpdateQueryAsSubResourceAttributes.md) |  |  |
 
 ## Example
@@ -15,7 +15,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new(
   type: null,
-  id: null,
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
   attributes: null
 )
 ```

data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md

@@ -4,17 +4,17 @@
 
 | 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] |
+| **title** | **String** | The title of the catalog item variant. | [optional] |
+| **description** | **String** | A description 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
 
@@ -22,17 +22,17 @@
 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
+  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.,
+  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
 )
 ```