klaviyo-api-sdk 1.0.1 → 1.2.0

data/docs/IncludedItemsAttributes.md

@@ -4,17 +4,18 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **external_id** | **String** |  | [optional] |
-| **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] |
-| **created** | **Time** |  | [optional] |
-| **updated** | **Time** |  | [optional] |
+| **external_id** | **String** | The ID of the catalog item in an external system. | [optional] |
+| **title** | **String** | The title of the catalog item. | [optional] |
+| **description** | **String** | A description 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] |
+| **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] |
+| **created** | **Time** | Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
+| **updated** | **Time** | Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
 
 ## Example
 
@@ -22,15 +23,16 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::IncludedItemsAttributes.new(
-  external_id: null,
-  title: null,
-  description: null,
-  url: null,
-  image_full_url: null,
-  image_thumbnail_url: null,
-  images: null,
-  custom_metadata: null,
-  published: null,
+  external_id: SAMPLE-DATA-ITEM-1,
+  title: Ocean Blue Shirt (Sample),
+  description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
+  price: null,
+  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,
   created: null,
   updated: null
 )

data/docs/IncludedLists.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. |  |
 | **attributes** | [**IncludedListsAttributes**](IncludedListsAttributes.md) |  |  |
 | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) |  |  |
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::IncludedLists.new(
   type: null,
-  id: null,
+  id: Y6nRLr,
   attributes: null,
   links: null
 )

data/docs/IncludedListsAttributes.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **created** | **Time** |  | [optional] |
-| **updated** | **Time** |  | [optional] |
+| **name** | **String** | A helpful name to label the list | [optional] |
+| **created** | **Time** | Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
+| **updated** | **Time** | Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
 
 ## Example
 
@@ -14,7 +14,7 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::IncludedListsAttributes.new(
-  name: null,
+  name: Newsletter,
   created: null,
   updated: null
 )

data/docs/IncludedMetrics.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The Metric ID |  |
 | **attributes** | [**IncludedMetricsAttributes**](IncludedMetricsAttributes.md) |  |  |
 | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) |  |  |
 

data/docs/IncludedMetricsAttributes.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **created** | **String** |  | [optional] |
-| **updated** | **String** |  | [optional] |
-| **integration** | **Object** |  | [optional] |
+| **name** | **String** | The name of the metric | [optional] |
+| **created** | **String** | Creation time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
+| **updated** | **String** | Last updated time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
+| **integration** | **Object** | The integration associated with the event | [optional] |
 
 ## Example
 

data/docs/IncludedProfiles.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. |  |
 | **attributes** | [**IncludedProfilesAttributes**](IncludedProfilesAttributes.md) |  |  |
 | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) |  |  |
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::IncludedProfiles.new(
   type: null,
-  id: null,
+  id: 01GDDKASAP8TKDDA2GRZDSVP4H,
   attributes: null,
   links: null
 )

data/docs/IncludedProfilesAttributes.md

@@ -4,20 +4,20 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  | [optional] |
-| **phone_number** | **String** |  | [optional] |
-| **external_id** | **String** |  | [optional] |
+| **email** | **String** | Individual's email address | [optional] |
+| **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
+| **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
 | **anonymous_id** | **String** |  | [optional] |
-| **first_name** | **String** |  | [optional] |
-| **last_name** | **String** |  | [optional] |
-| **organization** | **String** |  | [optional] |
-| **title** | **String** |  | [optional] |
-| **image** | **String** |  | [optional] |
-| **created** | **Time** |  | [optional] |
-| **updated** | **Time** |  | [optional] |
-| **last_event_date** | **Time** |  | [optional] |
+| **first_name** | **String** | Individual's first name | [optional] |
+| **last_name** | **String** | Individual's last name | [optional] |
+| **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
+| **title** | **String** | Individual's job title | [optional] |
+| **image** | **String** | URL pointing to the location of a profile image | [optional] |
+| **created** | **Time** | Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
+| **updated** | **Time** | Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
+| **last_event_date** | **Time** | Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
 | **location** | [**ProfileLocation**](ProfileLocation.md) |  | [optional] |
-| **properties** | **Object** |  | [optional] |
+| **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
 
 ## Example
 
@@ -25,20 +25,20 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::IncludedProfilesAttributes.new(
-  email: null,
-  phone_number: null,
-  external_id: null,
+  email: sarah.mason@klaviyo-demo.com,
+  phone_number: +15005550006,
+  external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
   anonymous_id: null,
-  first_name: null,
-  last_name: null,
-  organization: null,
-  title: null,
-  image: null,
+  first_name: Sarah,
+  last_name: Mason,
+  organization: Klaviyo,
+  title: Engineer,
+  image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
   created: null,
   updated: null,
   last_event_date: null,
   location: null,
-  properties: null
+  properties: {"pseudonym":"Dr. Octopus"}
 )
 ```
 

data/docs/IncludedSegments.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
 | **id** | **String** |  |  |
-| **attributes** | [**IncludedListsAttributes**](IncludedListsAttributes.md) |  |  |
+| **attributes** | [**IncludedSegmentsAttributes**](IncludedSegmentsAttributes.md) |  |  |
 | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) |  |  |
 
 ## Example

data/docs/IncludedSegmentsAttributes.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::IncludedSegmentsAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A helpful name to label the segment  | [optional] |
+| **created** | **Time** | Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
+| **updated** | **Time** | Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::IncludedSegmentsAttributes.new(
+  name: Repeat Purchasers,
+  created: null,
+  updated: null
+)
+```
+

data/docs/{IncludedProfile.md → IncludedTags.md}

@@ -1,12 +1,12 @@
-# KlaviyoAPI::IncludedProfile
+# KlaviyoAPI::IncludedTags
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
-| **attributes** | [**IncludedProfilesAttributes**](IncludedProfilesAttributes.md) |  |  |
+| **id** | **String** | The Tag ID |  |
+| **attributes** | [**TagUpdateQueryAsSubResourceAttributes**](TagUpdateQueryAsSubResourceAttributes.md) |  |  |
 | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) |  |  |
 
 ## Example
@@ -14,9 +14,9 @@
 ```ruby
 require 'klaviyo-api-sdk'
 
-instance = KlaviyoAPI::IncludedProfile.new(
+instance = KlaviyoAPI::IncludedTags.new(
   type: null,
-  id: null,
+  id: abcd1234-ef56-gh78-ij90-abcdef123456,
   attributes: null,
   links: null
 )

data/docs/IncludedVariants.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** | [**IncludedVariantsAttributes**](IncludedVariantsAttributes.md) |  |  |
 | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) |  |  |
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::IncludedVariants.new(
   type: null,
-  id: null,
+  id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
   attributes: null,
   links: null
 )

data/docs/IncludedVariantsAttributes.md

@@ -4,21 +4,21 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **external_id** | **String** |  | [optional] |
-| **title** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **sku** | **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] |
-| **created** | **Time** |  | [optional] |
-| **updated** | **Time** |  | [optional] |
+| **external_id** | **String** | The ID of the catalog item variant in an external system. | [optional] |
+| **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] |
+| **created** | **Time** | Date and time when the catalog item  variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
+| **updated** | **Time** | Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
 
 ## Example
 
@@ -26,19 +26,19 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::IncludedVariantsAttributes.new(
-  external_id: 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,
+  external_id: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
+  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,
   created: null,
   updated: null
 )

data/docs/ListCreateQueryAsSubResourceAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  |  |
+| **name** | **String** | A helpful name to label the list |  |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new(
-  name: null
+  name: Newsletter
 )
 ```
 

data/docs/ListPartialUpdateQueryAsSubResource.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. |  |
 | **attributes** | [**ListCreateQueryAsSubResourceAttributes**](ListCreateQueryAsSubResourceAttributes.md) |  |  |
 
 ## Example
@@ -15,7 +15,7 @@ require 'klaviyo-api-sdk'
 
 instance = KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new(
   type: null,
-  id: null,
+  id: Y6nRLr,
   attributes: null
 )
 ```