klaviyo-api-sdk 14.0.0 → 14.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +3 -3
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +5 -5
- data/lib/klaviyo-api-sdk/api/events_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/lists_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/segments_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/ab_test_action_data_current_experiment.rb +2 -15
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +16 -5
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +16 -5
- data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +2 -0
- data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +2 -1
- data/lib/klaviyo-api-sdk/models/is_rcs_capable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter2.rb +117 -0
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +195 -87
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +117 -0
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter2.rb +117 -0
- data/lib/klaviyo-api-sdk/models/subscribed_smsis_rcs_capable_filter.rb +237 -0
- data/lib/klaviyo-api-sdk.rb +6 -1
- data/lib/klaviyo-api-sdk.rb.bak +6 -1
- metadata +7 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 69201ad1ecd91a8f4d38ea9c516bad0d2d79666a34c2eeffda26c4f34a1be007
|
4
|
+
data.tar.gz: ddaacea6a1cbe17390bb6e9734399424dbcd27b0223508d66a71177bc210a56f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cc7d40c41af4fad2e6b497a92f0c935507441b7627010cec21608b941fb9481fabd65bae045b90fc7efb1f6cd5f87be2fc959cdae299250865c6552b9e631a27
|
7
|
+
data.tar.gz: f118a20c059d363beb0db0f171c9aaec956e1f6502e11c59e6e0eb6513eac98e01c33665238cbd93f9c0b69bf68ab423c431c2930daeb16d164780554eca2122
|
data/CHANGELOG.md
CHANGED
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
|
|
4
4
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
5
5
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
6
6
|
|
7
|
+
## [14.0.1] - revision 2025-07-15
|
8
|
+
### Fixed
|
9
|
+
- Added nil check when accessing `Retry-After` header
|
10
|
+
|
7
11
|
## [14.0.0] - revision 2025-07-15
|
8
12
|
### Added
|
9
13
|
#### Mapped Metrics API
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version: 14.0.
|
3
|
+
- SDK version: 14.0.1
|
4
4
|
- API revision: 2025-07-15
|
5
5
|
|
6
6
|
## Helpful Resources
|
@@ -118,13 +118,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
118
118
|
Then install the gem locally:
|
119
119
|
|
120
120
|
```shell
|
121
|
-
gem install ./klaviyo-api-sdk-14.0.
|
121
|
+
gem install ./klaviyo-api-sdk-14.0.1.gem
|
122
122
|
```
|
123
123
|
|
124
124
|
|
125
125
|
Finally add this to the Gemfile:
|
126
126
|
|
127
|
-
gem 'klaviyo-api-sdk', '~> 14.0.
|
127
|
+
gem 'klaviyo-api-sdk', '~> 14.0.1'
|
128
128
|
|
129
129
|
To install directly from rubygems:
|
130
130
|
|
data/klaviyo-api-sdk.gemspec
CHANGED
@@ -16,7 +16,7 @@ require "klaviyo-api-sdk/version"
|
|
16
16
|
|
17
17
|
Gem::Specification.new do |s|
|
18
18
|
s.name = "klaviyo-api-sdk"
|
19
|
-
s.version = "14.0.
|
19
|
+
s.version = "14.0.1"
|
20
20
|
s.authors = ['Klaviyo Team']
|
21
21
|
s.email = ['libraries@klaviyo.com']
|
22
22
|
s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
|
@@ -422,7 +422,7 @@ module KlaviyoAPI
|
|
422
422
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
423
423
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
424
424
|
end
|
425
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.
|
425
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.date", "send_strategy.throttle_percentage", "created_at", "scheduled_at", "updated_at", "send_time"]
|
426
426
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
427
427
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
428
428
|
end
|
@@ -508,7 +508,7 @@ module KlaviyoAPI
|
|
508
508
|
if @api_client.config.client_side_validation && id.nil?
|
509
509
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_for_campaign_message"
|
510
510
|
end
|
511
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.
|
511
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.date", "send_strategy.throttle_percentage", "created_at", "scheduled_at", "updated_at", "send_time"]
|
512
512
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
513
513
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
514
514
|
end
|
@@ -666,7 +666,7 @@ module KlaviyoAPI
|
|
666
666
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
667
667
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
668
668
|
end
|
669
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.
|
669
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.date", "send_strategy.throttle_percentage", "created_at", "scheduled_at", "updated_at", "send_time"]
|
670
670
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
671
671
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
672
672
|
end
|
@@ -947,7 +947,7 @@ module KlaviyoAPI
|
|
947
947
|
|
948
948
|
# Get Campaigns
|
949
949
|
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns. `?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
950
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
950
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
951
951
|
# @param [Hash] opts the optional parameters
|
952
952
|
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
953
953
|
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
@@ -963,7 +963,7 @@ module KlaviyoAPI
|
|
963
963
|
|
964
964
|
# Get Campaigns
|
965
965
|
# Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns. `?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
966
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
966
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
967
967
|
# @param [Hash] opts the optional parameters
|
968
968
|
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
969
969
|
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
@@ -984,7 +984,7 @@ module KlaviyoAPI
|
|
984
984
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
985
985
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
986
986
|
end
|
987
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.
|
987
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.date", "send_strategy.throttle_percentage", "created_at", "scheduled_at", "updated_at", "send_time"]
|
988
988
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
989
989
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
990
990
|
end
|
@@ -1318,7 +1318,7 @@ module KlaviyoAPI
|
|
1318
1318
|
if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
|
1319
1319
|
fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
|
1320
1320
|
end
|
1321
|
-
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.
|
1321
|
+
allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.date", "send_strategy.throttle_percentage", "created_at", "scheduled_at", "updated_at", "send_time"]
|
1322
1322
|
if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
|
1323
1323
|
fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
|
1324
1324
|
end
|
@@ -565,7 +565,7 @@ module KlaviyoAPI
|
|
565
565
|
if @api_client.config.client_side_validation && id.nil?
|
566
566
|
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_coupon"
|
567
567
|
end
|
568
|
-
allowable_values = ["external_id", "description"]
|
568
|
+
allowable_values = ["external_id", "description", "monitor_configuration"]
|
569
569
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
570
570
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
571
571
|
end
|
@@ -645,7 +645,7 @@ module KlaviyoAPI
|
|
645
645
|
if @api_client.config.client_side_validation && opts[:'fields_coupon_code'] && !opts[:'fields_coupon_code'].all? { |item| allowable_values.include?(item) }
|
646
646
|
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
647
647
|
end
|
648
|
-
allowable_values = ["external_id", "description"]
|
648
|
+
allowable_values = ["external_id", "description", "monitor_configuration"]
|
649
649
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
650
650
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
651
651
|
end
|
@@ -822,7 +822,7 @@ module KlaviyoAPI
|
|
822
822
|
if @api_client.config.client_side_validation && opts[:'fields_coupon_code'] && !opts[:'fields_coupon_code'].all? { |item| allowable_values.include?(item) }
|
823
823
|
fail ArgumentError, "invalid value for \"fields_coupon_code\", must include one of #{allowable_values}"
|
824
824
|
end
|
825
|
-
allowable_values = ["external_id", "description"]
|
825
|
+
allowable_values = ["external_id", "description", "monitor_configuration"]
|
826
826
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
827
827
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
828
828
|
end
|
@@ -995,7 +995,7 @@ module KlaviyoAPI
|
|
995
995
|
if @api_client.config.client_side_validation && id.nil?
|
996
996
|
fail ArgumentError, "Missing the required parameter 'id' when calling CouponsApi.get_coupon_for_coupon_code"
|
997
997
|
end
|
998
|
-
allowable_values = ["external_id", "description"]
|
998
|
+
allowable_values = ["external_id", "description", "monitor_configuration"]
|
999
999
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
1000
1000
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
1001
1001
|
end
|
@@ -1137,7 +1137,7 @@ module KlaviyoAPI
|
|
1137
1137
|
if @api_client.config.debugging
|
1138
1138
|
@api_client.config.logger.debug 'Calling API: CouponsApi.get_coupons ...'
|
1139
1139
|
end
|
1140
|
-
allowable_values = ["external_id", "description"]
|
1140
|
+
allowable_values = ["external_id", "description", "monitor_configuration"]
|
1141
1141
|
if @api_client.config.client_side_validation && opts[:'fields_coupon'] && !opts[:'fields_coupon'].all? { |item| allowable_values.include?(item) }
|
1142
1142
|
fail ArgumentError, "invalid value for \"fields_coupon\", must include one of #{allowable_values}"
|
1143
1143
|
end
|
@@ -540,7 +540,7 @@ module KlaviyoAPI
|
|
540
540
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
541
541
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
542
542
|
end
|
543
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
543
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.ranked_channel_affinity"]
|
544
544
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
545
545
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
546
546
|
end
|
@@ -745,7 +745,7 @@ module KlaviyoAPI
|
|
745
745
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
746
746
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
747
747
|
end
|
748
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
748
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.ranked_channel_affinity"]
|
749
749
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
750
750
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
751
751
|
end
|
@@ -265,7 +265,7 @@ module KlaviyoAPI
|
|
265
265
|
alias create_profile_suppression_bulk_create_job_with_http_info bulk_suppress_profiles_with_http_info
|
266
266
|
|
267
267
|
# Bulk Unsubscribe Profiles
|
268
|
-
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove
|
268
|
+
# > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes. Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list). Maximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
269
269
|
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
270
270
|
# @param [Hash] opts the optional parameters
|
271
271
|
# @return [nil]
|
@@ -281,7 +281,7 @@ module KlaviyoAPI
|
|
281
281
|
alias create_profile_subscription_bulk_delete_job bulk_unsubscribe_profiles
|
282
282
|
|
283
283
|
# Bulk Unsubscribe Profiles
|
284
|
-
# Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove
|
284
|
+
# > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes. Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list). Maximum number of profiles per call: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
|
285
285
|
# @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
|
286
286
|
# @param [Hash] opts the optional parameters
|
287
287
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1718,7 +1718,7 @@ module KlaviyoAPI
|
|
1718
1718
|
if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
|
1719
1719
|
fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
|
1720
1720
|
end
|
1721
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
1721
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.ranked_channel_affinity"]
|
1722
1722
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1723
1723
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1724
1724
|
end
|
@@ -1816,7 +1816,7 @@ module KlaviyoAPI
|
|
1816
1816
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
1817
1817
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
1818
1818
|
end
|
1819
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
1819
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.ranked_channel_affinity"]
|
1820
1820
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
1821
1821
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
1822
1822
|
end
|
@@ -2070,7 +2070,7 @@ module KlaviyoAPI
|
|
2070
2070
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
2071
2071
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
2072
2072
|
end
|
2073
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
2073
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.ranked_channel_affinity"]
|
2074
2074
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
2075
2075
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
2076
2076
|
end
|
@@ -2183,7 +2183,7 @@ module KlaviyoAPI
|
|
2183
2183
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
2184
2184
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
2185
2185
|
end
|
2186
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
2186
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.ranked_channel_affinity"]
|
2187
2187
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
2188
2188
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
2189
2189
|
end
|
@@ -451,7 +451,7 @@ module KlaviyoAPI
|
|
451
451
|
if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
|
452
452
|
fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
|
453
453
|
end
|
454
|
-
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
|
454
|
+
allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order", "predictive_analytics.ranked_channel_affinity"]
|
455
455
|
if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
|
456
456
|
fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
|
457
457
|
end
|
@@ -31,7 +31,7 @@ module KlaviyoAPI
|
|
31
31
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
32
32
|
def initialize(config = Configuration.default)
|
33
33
|
@config = config
|
34
|
-
@user_agent = "klaviyo-api-ruby/14.0.
|
34
|
+
@user_agent = "klaviyo-api-ruby/14.0.1"
|
35
35
|
@default_headers = {
|
36
36
|
'Content-Type' => 'application/json',
|
37
37
|
'User-Agent' => @user_agent
|
@@ -87,7 +87,9 @@ module KlaviyoAPI
|
|
87
87
|
Set.new([
|
88
88
|
:'id',
|
89
89
|
:'name',
|
90
|
+
:'allocations',
|
90
91
|
:'started',
|
92
|
+
:'winner_metric',
|
91
93
|
])
|
92
94
|
end
|
93
95
|
|
@@ -145,18 +147,6 @@ module KlaviyoAPI
|
|
145
147
|
invalid_properties.push('invalid value for "variations", variations cannot be nil.')
|
146
148
|
end
|
147
149
|
|
148
|
-
if @allocations.nil?
|
149
|
-
invalid_properties.push('invalid value for "allocations", allocations cannot be nil.')
|
150
|
-
end
|
151
|
-
|
152
|
-
if @winner_metric.nil?
|
153
|
-
invalid_properties.push('invalid value for "winner_metric", winner_metric cannot be nil.')
|
154
|
-
end
|
155
|
-
|
156
|
-
if @automatic_winner_selection_settings.nil?
|
157
|
-
invalid_properties.push('invalid value for "automatic_winner_selection_settings", automatic_winner_selection_settings cannot be nil.')
|
158
|
-
end
|
159
|
-
|
160
150
|
invalid_properties
|
161
151
|
end
|
162
152
|
|
@@ -164,11 +154,8 @@ module KlaviyoAPI
|
|
164
154
|
# @return true if the model is valid
|
165
155
|
def valid?
|
166
156
|
return false if @variations.nil?
|
167
|
-
return false if @allocations.nil?
|
168
|
-
return false if @winner_metric.nil?
|
169
157
|
winner_metric_validator = EnumAttributeValidator.new('String', ["submission", "unique-clicks", "unique-opens", "unique-placed-orders"])
|
170
158
|
return false unless winner_metric_validator.valid?(@winner_metric)
|
171
|
-
return false if @automatic_winner_selection_settings.nil?
|
172
159
|
true
|
173
160
|
end
|
174
161
|
|
@@ -20,11 +20,15 @@ module KlaviyoAPI
|
|
20
20
|
# A description of the coupon.
|
21
21
|
attr_accessor :description
|
22
22
|
|
23
|
+
# The monitor configuration for the coupon.
|
24
|
+
attr_accessor :monitor_configuration
|
25
|
+
|
23
26
|
# Attribute mapping from ruby-style variable name to JSON key.
|
24
27
|
def self.attribute_map
|
25
28
|
{
|
26
29
|
:'external_id' => :'external_id',
|
27
|
-
:'description' => :'description'
|
30
|
+
:'description' => :'description',
|
31
|
+
:'monitor_configuration' => :'monitor_configuration'
|
28
32
|
}
|
29
33
|
end
|
30
34
|
|
@@ -37,14 +41,16 @@ module KlaviyoAPI
|
|
37
41
|
def self.openapi_types
|
38
42
|
{
|
39
43
|
:'external_id' => :'String',
|
40
|
-
:'description' => :'String'
|
44
|
+
:'description' => :'String',
|
45
|
+
:'monitor_configuration' => :'Object'
|
41
46
|
}
|
42
47
|
end
|
43
48
|
|
44
49
|
# List of attributes with nullable: true
|
45
50
|
def self.openapi_nullable
|
46
51
|
Set.new([
|
47
|
-
:'description'
|
52
|
+
:'description',
|
53
|
+
:'monitor_configuration'
|
48
54
|
])
|
49
55
|
end
|
50
56
|
|
@@ -70,6 +76,10 @@ module KlaviyoAPI
|
|
70
76
|
if attributes.key?(:'description')
|
71
77
|
self.description = attributes[:'description']
|
72
78
|
end
|
79
|
+
|
80
|
+
if attributes.key?(:'monitor_configuration')
|
81
|
+
self.monitor_configuration = attributes[:'monitor_configuration']
|
82
|
+
end
|
73
83
|
end
|
74
84
|
|
75
85
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -96,7 +106,8 @@ module KlaviyoAPI
|
|
96
106
|
return true if self.equal?(o)
|
97
107
|
self.class == o.class &&
|
98
108
|
external_id == o.external_id &&
|
99
|
-
description == o.description
|
109
|
+
description == o.description &&
|
110
|
+
monitor_configuration == o.monitor_configuration
|
100
111
|
end
|
101
112
|
|
102
113
|
# @see the `==` method
|
@@ -108,7 +119,7 @@ module KlaviyoAPI
|
|
108
119
|
# Calculates hash code according to all attributes.
|
109
120
|
# @return [Integer] Hash code
|
110
121
|
def hash
|
111
|
-
[external_id, description].hash
|
122
|
+
[external_id, description, monitor_configuration].hash
|
112
123
|
end
|
113
124
|
|
114
125
|
# Builds the object from hash
|
@@ -17,10 +17,14 @@ module KlaviyoAPI
|
|
17
17
|
# A description of the coupon.
|
18
18
|
attr_accessor :description
|
19
19
|
|
20
|
+
# The monitor configuration for the coupon.
|
21
|
+
attr_accessor :monitor_configuration
|
22
|
+
|
20
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
21
24
|
def self.attribute_map
|
22
25
|
{
|
23
|
-
:'description' => :'description'
|
26
|
+
:'description' => :'description',
|
27
|
+
:'monitor_configuration' => :'monitor_configuration'
|
24
28
|
}
|
25
29
|
end
|
26
30
|
|
@@ -32,14 +36,16 @@ module KlaviyoAPI
|
|
32
36
|
# Attribute type mapping.
|
33
37
|
def self.openapi_types
|
34
38
|
{
|
35
|
-
:'description' => :'String'
|
39
|
+
:'description' => :'String',
|
40
|
+
:'monitor_configuration' => :'Object'
|
36
41
|
}
|
37
42
|
end
|
38
43
|
|
39
44
|
# List of attributes with nullable: true
|
40
45
|
def self.openapi_nullable
|
41
46
|
Set.new([
|
42
|
-
:'description'
|
47
|
+
:'description',
|
48
|
+
:'monitor_configuration'
|
43
49
|
])
|
44
50
|
end
|
45
51
|
|
@@ -61,6 +67,10 @@ module KlaviyoAPI
|
|
61
67
|
if attributes.key?(:'description')
|
62
68
|
self.description = attributes[:'description']
|
63
69
|
end
|
70
|
+
|
71
|
+
if attributes.key?(:'monitor_configuration')
|
72
|
+
self.monitor_configuration = attributes[:'monitor_configuration']
|
73
|
+
end
|
64
74
|
end
|
65
75
|
|
66
76
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -81,7 +91,8 @@ module KlaviyoAPI
|
|
81
91
|
def ==(o)
|
82
92
|
return true if self.equal?(o)
|
83
93
|
self.class == o.class &&
|
84
|
-
description == o.description
|
94
|
+
description == o.description &&
|
95
|
+
monitor_configuration == o.monitor_configuration
|
85
96
|
end
|
86
97
|
|
87
98
|
# @see the `==` method
|
@@ -93,7 +104,7 @@ module KlaviyoAPI
|
|
93
104
|
# Calculates hash code according to all attributes.
|
94
105
|
# @return [Integer] Hash code
|
95
106
|
def hash
|
96
|
-
[description].hash
|
107
|
+
[description, monitor_configuration].hash
|
97
108
|
end
|
98
109
|
|
99
110
|
# Builds the object from hash
|
@@ -14,8 +14,10 @@ require 'time'
|
|
14
14
|
|
15
15
|
module KlaviyoAPI
|
16
16
|
class CustomTimeframe
|
17
|
+
# A datetime that represents the start of a custom time frame. Offset is ignored and the company timezone is used.
|
17
18
|
attr_accessor :start
|
18
19
|
|
20
|
+
# A datetime that represents the end of a custom time frame. Offset is ignored and the company timezone is used.
|
19
21
|
attr_accessor :_end
|
20
22
|
|
21
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -0,0 +1,35 @@
|
|
1
|
+
=begin
|
2
|
+
#Klaviyo API
|
3
|
+
|
4
|
+
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
|
+
|
6
|
+
Contact: developers@klaviyo.com
|
7
|
+
Generated by: https://openapi-generator.tech
|
8
|
+
OpenAPI Generator version: 6.2.1
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require 'date'
|
13
|
+
require 'time'
|
14
|
+
|
15
|
+
module KlaviyoAPI
|
16
|
+
class IsRcsCapableEnum
|
17
|
+
IS_RCS_CAPABLE = "is_rcs_capable".freeze
|
18
|
+
|
19
|
+
# Builds the enum from string
|
20
|
+
# @param [String] The enum value in the form of the string
|
21
|
+
# @return [String] The enum value
|
22
|
+
def self.build_from_hash(value)
|
23
|
+
new.build_from_hash(value)
|
24
|
+
end
|
25
|
+
|
26
|
+
# Builds the enum from string
|
27
|
+
# @param [String] The enum value in the form of the string
|
28
|
+
# @return [String] The enum value
|
29
|
+
def build_from_hash(value)
|
30
|
+
constantValues = IsRcsCapableEnum.constants.select { |c| IsRcsCapableEnum::const_get(c) == value }
|
31
|
+
raise "Invalid ENUM value #{value} for class #IsRcsCapableEnum" if constantValues.empty?
|
32
|
+
value
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|