klaviyo-api-sdk 7.0.0 → 8.0.0

data/docs/HasEmailMarketingSubscribedFiltersInner.md

@@ -0,0 +1,69 @@
+# KlaviyoAPI::HasEmailMarketingSubscribedFiltersInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::HasEmailMarketingSubscribedFiltersInner.openapi_one_of
+# =>
+# [
+#   :'APIMethodFilter',
+#   :'BackInStockMethodFilter',
+#   :'CustomSourceFilter',
+#   :'DoubleOptinFilter',
+#   :'FormMethodFilter',
+#   :'InboundMessageMethodFilter',
+#   :'ManualAddMethodFilter',
+#   :'ManualImportMethodFilter',
+#   :'PreferencePageFilter',
+#   :'SftpMethodFilter',
+#   :'ShopifyIntegrationMethodFilter',
+#   :'StatusDateFilter'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::HasEmailMarketingSubscribedFiltersInner.build(data)
+# => #<APIMethodFilter:0x00007fdd4aab02a0>
+
+KlaviyoAPI::HasEmailMarketingSubscribedFiltersInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `APIMethodFilter`
+- `BackInStockMethodFilter`
+- `CustomSourceFilter`
+- `DoubleOptinFilter`
+- `FormMethodFilter`
+- `InboundMessageMethodFilter`
+- `ManualAddMethodFilter`
+- `ManualImportMethodFilter`
+- `PreferencePageFilter`
+- `SftpMethodFilter`
+- `ShopifyIntegrationMethodFilter`
+- `StatusDateFilter`
+- `nil` (if no type matches)
+

data/docs/HasPushMarketing.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::HasPushMarketing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription** | [**AnyEnum**](AnyEnum.md) |  |  |
+| **filters** | [**Array<StatusDateFilter>**](StatusDateFilter.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::HasPushMarketing.new(
+  subscription: null,
+  filters: null
+)
+```
+

data/docs/HasPushMarketingConsent.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::HasPushMarketingConsent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel** | [**PushEnum**](PushEnum.md) |  |  |
+| **can_receive_marketing** | **Boolean** |  |  |
+| **consent_status** | [**HasPushMarketing**](HasPushMarketing.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::HasPushMarketingConsent.new(
+  channel: null,
+  can_receive_marketing: null,
+  consent_status: null
+)
+```
+

data/docs/HasSMSMarketingConsent.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::HasSMSMarketingConsent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel** | [**SmsEnum**](SmsEnum.md) |  |  |
+| **can_receive_marketing** | **Boolean** |  |  |
+| **consent_status** | [**HasSMSMarketingSubscribed**](HasSMSMarketingSubscribed.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::HasSMSMarketingConsent.new(
+  channel: null,
+  can_receive_marketing: null,
+  consent_status: null
+)
+```
+

data/docs/HasSMSMarketingSubscribed.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::HasSMSMarketingSubscribed
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription** | [**SubscribedEnum**](SubscribedEnum.md) |  |  |
+| **filters** | [**Array<HasSMSMarketingSubscribedFiltersInner>**](HasSMSMarketingSubscribedFiltersInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::HasSMSMarketingSubscribed.new(
+  subscription: null,
+  filters: null
+)
+```
+

data/docs/HasSMSMarketingSubscribedFiltersInner.md

@@ -0,0 +1,63 @@
+# KlaviyoAPI::HasSMSMarketingSubscribedFiltersInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::HasSMSMarketingSubscribedFiltersInner.openapi_one_of
+# =>
+# [
+#   :'CheckoutMethodFilter',
+#   :'FormMethodFilter',
+#   :'InboundMessageMethodFilter',
+#   :'ManualAddMethodFilter',
+#   :'ManualImportMethodFilter',
+#   :'PreferencePageMethodFilter',
+#   :'SftpMethodFilter',
+#   :'ShopifyIntegrationMethodFilter',
+#   :'StatusDateFilter'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::HasSMSMarketingSubscribedFiltersInner.build(data)
+# => #<CheckoutMethodFilter:0x00007fdd4aab02a0>
+
+KlaviyoAPI::HasSMSMarketingSubscribedFiltersInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `CheckoutMethodFilter`
+- `FormMethodFilter`
+- `InboundMessageMethodFilter`
+- `ManualAddMethodFilter`
+- `ManualImportMethodFilter`
+- `PreferencePageMethodFilter`
+- `SftpMethodFilter`
+- `ShopifyIntegrationMethodFilter`
+- `StatusDateFilter`
+- `nil` (if no type matches)
+

data/docs/ImagesApi.md

@@ -35,7 +35,7 @@ end
 api_instance = KlaviyoAPI::ImagesApi.new
 id = '7' # String | The ID of the image
 opts = {
-  fields_image: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
+  fields_image: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
 }
 
 begin
@@ -70,7 +70,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The ID of the image |  |
-| **fields_image** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **fields_image** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
 
 ### Return type
 
@@ -109,11 +109,11 @@ end
 
 api_instance = KlaviyoAPI::ImagesApi.new
 opts = {
-  fields_image: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
-  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`
-  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
+  fields_image: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
+  filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`
+  page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
   page_size: 56, # Integer | Default: 20. Min: 1. Max: 100.
-  sort: 'format' # String | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
+  sort: 'format' # String | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
 }
 
 begin
@@ -147,11 +147,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **fields_image** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets | [optional] |
-| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; | [optional] |
-| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination | [optional] |
+| **fields_image** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | [optional] |
+| **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60; | [optional] |
+| **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination | [optional] |
 | **page_size** | **Integer** | Default: 20. Min: 1. Max: 100. | [optional][default to 20] |
-| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting | [optional] |
+| **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting | [optional] |
 
 ### Return type
 

data/docs/InEnum.md

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

data/docs/InStringArrayFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::InStringArrayFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**StringEnum**](StringEnum.md) |  |  |
+| **operator** | [**InEnum**](InEnum.md) |  |  |
+| **value** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::InStringArrayFilter.new(
+  type: null,
+  operator: null,
+  value: null
+)
+```
+

data/docs/InboundMessageEnum.md

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

data/docs/InboundMessageMethodFilter.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::InboundMessageMethodFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**MethodEnum**](MethodEnum.md) |  |  |
+| **method** | [**InboundMessageEnum**](InboundMessageEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::InboundMessageMethodFilter.new(
+  field: null,
+  method: null
+)
+```
+

data/docs/IntegrationEnum.md

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

data/docs/InvalidEmailDateEnum.md

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

data/docs/InvalidEmailDateFilter.md

@@ -0,0 +1,20 @@
+# KlaviyoAPI::InvalidEmailDateFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**InvalidEmailDateEnum**](InvalidEmailDateEnum.md) |  |  |
+| **filter** | [**BounceDateFilterFilter**](BounceDateFilterFilter.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::InvalidEmailDateFilter.new(
+  field: null,
+  filter: null
+)
+```
+

data/docs/IsDoubleOptInEnum.md

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

data/docs/IsSetEnum.md

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

data/docs/IsSetExistenceFilter.md

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

data/docs/LessThanEnum.md

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

data/docs/ListContainsOperatorFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::ListContainsOperatorFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ListEnum**](ListEnum.md) |  |  |
+| **operator** | **String** | Operators for list contains filters. |  |
+| **value** | [**ListContainsOperatorFilterValue**](ListContainsOperatorFilterValue.md) |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ListContainsOperatorFilter.new(
+  type: null,
+  operator: null,
+  value: null
+)
+```
+

data/docs/ListContainsOperatorFilterValue.md

@@ -0,0 +1,49 @@
+# KlaviyoAPI::ListContainsOperatorFilterValue
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::ListContainsOperatorFilterValue.openapi_one_of
+# =>
+# [
+#   :'Integer',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+KlaviyoAPI::ListContainsOperatorFilterValue.build(data)
+# => #<Integer:0x00007fdd4aab02a0>
+
+KlaviyoAPI::ListContainsOperatorFilterValue.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Integer`
+- `String`
+- `nil` (if no type matches)
+

data/docs/ListLengthFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::ListLengthFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ListEnum**](ListEnum.md) |  |  |
+| **operator** | **String** | Operators for list length filters. |  |
+| **value** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ListLengthFilter.new(
+  type: null,
+  operator: null,
+  value: null
+)
+```
+

data/docs/ListSetFilter.md

@@ -0,0 +1,22 @@
+# KlaviyoAPI::ListSetFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ListEnum**](ListEnum.md) |  |  |
+| **operator** | **String** | Operators for list contains set filters. |  |
+| **value** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'klaviyo-api-sdk'
+
+instance = KlaviyoAPI::ListSetFilter.new(
+  type: null,
+  operator: null,
+  value: null
+)
+```
+