klaviyo-api-sdk 1.0.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/CatalogCategoryCreateJobCreateQuery.md

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

data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md

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

data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md

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

data/docs/CatalogCategoryCreateQuery.md

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

data/docs/CatalogCategoryCreateQueryAsSubResource.md

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

data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,24 @@
+# KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new(
+  external_id: null,
+  name: null,
+  integration_type: null,
+  catalog_type: null
+)
+```
+

data/docs/CatalogCategoryDeleteJobCreateQuery.md

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

data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md

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

data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md

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

data/docs/CatalogCategoryDeleteQueryAsSubResource.md

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

data/docs/CatalogCategoryItemOp.md

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

data/docs/CatalogCategoryUpdateJobCreateQuery.md

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

data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md

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

data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md

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

data/docs/CatalogCategoryUpdateQuery.md

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

data/docs/CatalogCategoryUpdateQueryAsSubResource.md

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

data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md

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

data/docs/CatalogItemCategoryOp.md

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

data/docs/CatalogItemCreateJobCreateQuery.md

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

data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md

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

data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md

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

data/docs/CatalogItemCreateQuery.md

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

data/docs/CatalogItemCreateQueryAsSubResource.md

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

data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md

@@ -0,0 +1,38 @@
+# KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new(
+  external_id: null,
+  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
+)
+```
+

data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md

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

data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md

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

data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md

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

data/docs/CatalogItemDeleteJobCreateQuery.md

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

data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md

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

data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md

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

data/docs/CatalogItemDeleteQueryAsSubResource.md

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