klaviyo-api-sdk 13.0.1 → 14.0.0
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 +12 -0
- data/README.md +434 -286
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +82 -82
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +235 -235
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +63 -63
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +384 -0
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +34 -34
- data/lib/klaviyo-api-sdk/api/flows_api.rb +93 -93
- data/lib/klaviyo-api-sdk/api/forms_api.rb +40 -40
- data/lib/klaviyo-api-sdk/api/images_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/lists_api.rb +59 -59
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +643 -59
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +128 -128
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +13 -13
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/segments_api.rb +53 -53
- data/lib/klaviyo-api-sdk/api/tags_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/templates_api.rb +36 -36
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/button_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{custom_object_property_enum.rb → button_enum.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +3 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/data_source_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/data_source_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +219 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships_data_source.rb +218 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter.rb → dsr_bulk_create_attrs_data_source_records.rb} +15 -14
- data/lib/klaviyo-api-sdk/models/dsr_bulk_create_rels_data_source_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/image_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object.rb +281 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships.rb +227 -0
- data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter_condition_groups_inner.rb → mapped_metric_partial_update_query_resource_object_relationships_custom_metric.rb} +10 -17
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_custom_metric_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric.rb +218 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/priority_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +327 -0
- data/lib/klaviyo-api-sdk/models/{custom_object_property_condition.rb → profile_predictive_analytics_channel_affinity_priority_filter.rb} +23 -37
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +327 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_filter.rb +286 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_date_condition.rb +286 -0
- data/lib/klaviyo-api-sdk/models/rank_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spacer_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/spacer_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +6 -2
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +5 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +5 -0
- data/lib/klaviyo-api-sdk.rb +40 -5
- data/lib/klaviyo-api-sdk.rb.bak +974 -0
- metadata +43 -7
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter_condition_groups_inner_conditions_inner.rb +0 -106
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 = "
|
19
|
+
s.version = "14.0.0"
|
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'
|
@@ -22,7 +22,7 @@ module KlaviyoAPI
|
|
22
22
|
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
23
23
|
# @param id [String] The ID of the account
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-
|
25
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
26
26
|
# @return [Hash<String, Object>]
|
27
27
|
def get_account(id, opts = {})
|
28
28
|
data, _status_code, _headers = get_account_with_http_info(id, opts)
|
@@ -33,7 +33,7 @@ module KlaviyoAPI
|
|
33
33
|
# Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
34
34
|
# @param id [String] The ID of the account
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-
|
36
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
37
37
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
38
38
|
def get_account_with_http_info(id, opts = {})
|
39
39
|
if @api_client.config.debugging
|
@@ -57,7 +57,7 @@ module KlaviyoAPI
|
|
57
57
|
# header parameters
|
58
58
|
header_params = opts[:header_params] || {}
|
59
59
|
# klaviyo api revision
|
60
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
61
61
|
# HTTP header 'Accept' (if needed)
|
62
62
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
63
63
|
|
@@ -93,7 +93,7 @@ module KlaviyoAPI
|
|
93
93
|
# Get Accounts
|
94
94
|
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
95
95
|
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-
|
96
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
97
97
|
# @return [Hash<String, Object>]
|
98
98
|
def get_accounts(opts = {})
|
99
99
|
data, _status_code, _headers = get_accounts_with_http_info(opts)
|
@@ -103,7 +103,7 @@ module KlaviyoAPI
|
|
103
103
|
# Get Accounts
|
104
104
|
# Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array. You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
|
105
105
|
# @param [Hash] opts the optional parameters
|
106
|
-
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-
|
106
|
+
# @option opts [Array<String>] :fields_account For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
107
107
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
108
108
|
def get_accounts_with_http_info(opts = {})
|
109
109
|
if @api_client.config.debugging
|
@@ -123,7 +123,7 @@ module KlaviyoAPI
|
|
123
123
|
# header parameters
|
124
124
|
header_params = opts[:header_params] || {}
|
125
125
|
# klaviyo api revision
|
126
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
126
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
127
127
|
# HTTP header 'Accept' (if needed)
|
128
128
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
129
129
|
|
@@ -53,7 +53,7 @@ module KlaviyoAPI
|
|
53
53
|
# header parameters
|
54
54
|
header_params = opts[:header_params] || {}
|
55
55
|
# klaviyo api revision
|
56
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
56
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
57
57
|
# HTTP header 'Accept' (if needed)
|
58
58
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
59
59
|
# HTTP header 'Content-Type'
|
@@ -135,7 +135,7 @@ module KlaviyoAPI
|
|
135
135
|
# header parameters
|
136
136
|
header_params = opts[:header_params] || {}
|
137
137
|
# klaviyo api revision
|
138
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
138
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
139
139
|
# HTTP header 'Accept' (if needed)
|
140
140
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
141
141
|
# HTTP header 'Content-Type'
|
@@ -208,7 +208,7 @@ module KlaviyoAPI
|
|
208
208
|
# header parameters
|
209
209
|
header_params = opts[:header_params] || {}
|
210
210
|
# klaviyo api revision
|
211
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
211
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
212
212
|
# HTTP header 'Accept' (if needed)
|
213
213
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
214
214
|
# HTTP header 'Content-Type'
|
@@ -281,7 +281,7 @@ module KlaviyoAPI
|
|
281
281
|
# header parameters
|
282
282
|
header_params = opts[:header_params] || {}
|
283
283
|
# klaviyo api revision
|
284
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
284
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
285
285
|
# HTTP header 'Accept' (if needed)
|
286
286
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
287
287
|
# HTTP header 'Content-Type'
|
@@ -354,7 +354,7 @@ module KlaviyoAPI
|
|
354
354
|
# header parameters
|
355
355
|
header_params = opts[:header_params] || {}
|
356
356
|
# klaviyo api revision
|
357
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
357
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
358
358
|
# HTTP header 'Accept' (if needed)
|
359
359
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
360
360
|
|
@@ -391,10 +391,10 @@ module KlaviyoAPI
|
|
391
391
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
392
392
|
# @param id [String] The campaign ID to be retrieved
|
393
393
|
# @param [Hash] opts the optional parameters
|
394
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
395
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
396
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
397
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
394
|
+
# @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
|
395
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
396
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
397
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
398
398
|
# @return [Hash<String, Object>]
|
399
399
|
def get_campaign(id, opts = {})
|
400
400
|
data, _status_code, _headers = get_campaign_with_http_info(id, opts)
|
@@ -405,10 +405,10 @@ module KlaviyoAPI
|
|
405
405
|
# Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
406
406
|
# @param id [String] The campaign ID to be retrieved
|
407
407
|
# @param [Hash] opts the optional parameters
|
408
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
409
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
410
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
411
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
408
|
+
# @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
|
409
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
410
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
411
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
412
412
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
413
413
|
def get_campaign_with_http_info(id, opts = {})
|
414
414
|
if @api_client.config.debugging
|
@@ -447,7 +447,7 @@ module KlaviyoAPI
|
|
447
447
|
# header parameters
|
448
448
|
header_params = opts[:header_params] || {}
|
449
449
|
# klaviyo api revision
|
450
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
450
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
451
451
|
# HTTP header 'Accept' (if needed)
|
452
452
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
453
453
|
|
@@ -484,7 +484,7 @@ module KlaviyoAPI
|
|
484
484
|
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
485
485
|
# @param id [String]
|
486
486
|
# @param [Hash] opts the optional parameters
|
487
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
487
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
488
488
|
# @return [Hash<String, Object>]
|
489
489
|
def get_campaign_for_campaign_message(id, opts = {})
|
490
490
|
data, _status_code, _headers = get_campaign_for_campaign_message_with_http_info(id, opts)
|
@@ -498,7 +498,7 @@ module KlaviyoAPI
|
|
498
498
|
# Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
499
499
|
# @param id [String]
|
500
500
|
# @param [Hash] opts the optional parameters
|
501
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
501
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
502
502
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
503
503
|
def get_campaign_for_campaign_message_with_http_info(id, opts = {})
|
504
504
|
if @api_client.config.debugging
|
@@ -522,7 +522,7 @@ module KlaviyoAPI
|
|
522
522
|
# header parameters
|
523
523
|
header_params = opts[:header_params] || {}
|
524
524
|
# klaviyo api revision
|
525
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
525
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
526
526
|
# HTTP header 'Accept' (if needed)
|
527
527
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
528
528
|
|
@@ -593,7 +593,7 @@ module KlaviyoAPI
|
|
593
593
|
# header parameters
|
594
594
|
header_params = opts[:header_params] || {}
|
595
595
|
# klaviyo api revision
|
596
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
596
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
597
597
|
# HTTP header 'Accept' (if needed)
|
598
598
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
599
599
|
|
@@ -633,11 +633,11 @@ module KlaviyoAPI
|
|
633
633
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
634
634
|
# @param id [String] The message ID to be retrieved
|
635
635
|
# @param [Hash] opts the optional parameters
|
636
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
637
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
638
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
639
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
640
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
636
|
+
# @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
|
637
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
638
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
639
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
640
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
641
641
|
# @return [Hash<String, Object>]
|
642
642
|
def get_campaign_message(id, opts = {})
|
643
643
|
data, _status_code, _headers = get_campaign_message_with_http_info(id, opts)
|
@@ -648,11 +648,11 @@ module KlaviyoAPI
|
|
648
648
|
# Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
649
649
|
# @param id [String] The message ID to be retrieved
|
650
650
|
# @param [Hash] opts the optional parameters
|
651
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
652
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
653
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
654
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
655
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
651
|
+
# @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
|
652
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
653
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
654
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
655
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
656
656
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
657
657
|
def get_campaign_message_with_http_info(id, opts = {})
|
658
658
|
if @api_client.config.debugging
|
@@ -696,7 +696,7 @@ module KlaviyoAPI
|
|
696
696
|
# header parameters
|
697
697
|
header_params = opts[:header_params] || {}
|
698
698
|
# klaviyo api revision
|
699
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
699
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
700
700
|
# HTTP header 'Accept' (if needed)
|
701
701
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
702
702
|
|
@@ -733,7 +733,7 @@ module KlaviyoAPI
|
|
733
733
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
734
734
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
735
735
|
# @param [Hash] opts the optional parameters
|
736
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-
|
736
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
737
737
|
# @return [Hash<String, Object>]
|
738
738
|
def get_campaign_recipient_estimation(id, opts = {})
|
739
739
|
data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts)
|
@@ -744,7 +744,7 @@ module KlaviyoAPI
|
|
744
744
|
# Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
745
745
|
# @param id [String] The ID of the campaign for which to get the estimated number of recipients
|
746
746
|
# @param [Hash] opts the optional parameters
|
747
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-
|
747
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
748
748
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
749
749
|
def get_campaign_recipient_estimation_with_http_info(id, opts = {})
|
750
750
|
if @api_client.config.debugging
|
@@ -768,7 +768,7 @@ module KlaviyoAPI
|
|
768
768
|
# header parameters
|
769
769
|
header_params = opts[:header_params] || {}
|
770
770
|
# klaviyo api revision
|
771
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
771
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
772
772
|
# HTTP header 'Accept' (if needed)
|
773
773
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
774
774
|
|
@@ -805,7 +805,7 @@ module KlaviyoAPI
|
|
805
805
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
806
806
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
807
807
|
# @param [Hash] opts the optional parameters
|
808
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
808
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
809
809
|
# @return [Hash<String, Object>]
|
810
810
|
def get_campaign_recipient_estimation_job(id, opts = {})
|
811
811
|
data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts)
|
@@ -816,7 +816,7 @@ module KlaviyoAPI
|
|
816
816
|
# Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
817
817
|
# @param id [String] The ID of the campaign to get recipient estimation status
|
818
818
|
# @param [Hash] opts the optional parameters
|
819
|
-
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
819
|
+
# @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
820
820
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
821
821
|
def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
|
822
822
|
if @api_client.config.debugging
|
@@ -840,7 +840,7 @@ module KlaviyoAPI
|
|
840
840
|
# header parameters
|
841
841
|
header_params = opts[:header_params] || {}
|
842
842
|
# klaviyo api revision
|
843
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
843
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
844
844
|
# HTTP header 'Accept' (if needed)
|
845
845
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
846
846
|
|
@@ -877,7 +877,7 @@ module KlaviyoAPI
|
|
877
877
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
878
878
|
# @param id [String] The ID of the campaign to send
|
879
879
|
# @param [Hash] opts the optional parameters
|
880
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
880
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
881
881
|
# @return [Hash<String, Object>]
|
882
882
|
def get_campaign_send_job(id, opts = {})
|
883
883
|
data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts)
|
@@ -888,7 +888,7 @@ module KlaviyoAPI
|
|
888
888
|
# Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
889
889
|
# @param id [String] The ID of the campaign to send
|
890
890
|
# @param [Hash] opts the optional parameters
|
891
|
-
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
891
|
+
# @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
892
892
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
893
893
|
def get_campaign_send_job_with_http_info(id, opts = {})
|
894
894
|
if @api_client.config.debugging
|
@@ -912,7 +912,7 @@ module KlaviyoAPI
|
|
912
912
|
# header parameters
|
913
913
|
header_params = opts[:header_params] || {}
|
914
914
|
# klaviyo api revision
|
915
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
915
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
916
916
|
# HTTP header 'Accept' (if needed)
|
917
917
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
918
918
|
|
@@ -947,14 +947,14 @@ 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-
|
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`
|
951
951
|
# @param [Hash] opts the optional parameters
|
952
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
953
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
954
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
955
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
956
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
957
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
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
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
954
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
955
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
956
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
957
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
958
958
|
# @return [Hash<String, Object>]
|
959
959
|
def get_campaigns(filter, opts = {})
|
960
960
|
data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
|
@@ -963,14 +963,14 @@ 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-
|
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`
|
967
967
|
# @param [Hash] opts the optional parameters
|
968
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
969
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
970
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
971
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
972
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
973
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
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
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
970
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
971
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
972
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
973
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
974
974
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
975
975
|
def get_campaigns_with_http_info(filter, opts = {})
|
976
976
|
if @api_client.config.debugging
|
@@ -1016,7 +1016,7 @@ module KlaviyoAPI
|
|
1016
1016
|
# header parameters
|
1017
1017
|
header_params = opts[:header_params] || {}
|
1018
1018
|
# klaviyo api revision
|
1019
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1019
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1020
1020
|
# HTTP header 'Accept' (if needed)
|
1021
1021
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1022
1022
|
|
@@ -1053,7 +1053,7 @@ module KlaviyoAPI
|
|
1053
1053
|
# Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
|
1054
1054
|
# @param id [String]
|
1055
1055
|
# @param [Hash] opts the optional parameters
|
1056
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
1056
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1057
1057
|
# @return [Hash<String, Object>]
|
1058
1058
|
def get_image_for_campaign_message(id, opts = {})
|
1059
1059
|
data, _status_code, _headers = get_image_for_campaign_message_with_http_info(id, opts)
|
@@ -1067,7 +1067,7 @@ module KlaviyoAPI
|
|
1067
1067
|
# Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
|
1068
1068
|
# @param id [String]
|
1069
1069
|
# @param [Hash] opts the optional parameters
|
1070
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
1070
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1071
1071
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1072
1072
|
def get_image_for_campaign_message_with_http_info(id, opts = {})
|
1073
1073
|
if @api_client.config.debugging
|
@@ -1091,7 +1091,7 @@ module KlaviyoAPI
|
|
1091
1091
|
# header parameters
|
1092
1092
|
header_params = opts[:header_params] || {}
|
1093
1093
|
# klaviyo api revision
|
1094
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1094
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1095
1095
|
# HTTP header 'Accept' (if needed)
|
1096
1096
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1097
1097
|
|
@@ -1162,7 +1162,7 @@ module KlaviyoAPI
|
|
1162
1162
|
# header parameters
|
1163
1163
|
header_params = opts[:header_params] || {}
|
1164
1164
|
# klaviyo api revision
|
1165
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1165
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1166
1166
|
# HTTP header 'Accept' (if needed)
|
1167
1167
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1168
1168
|
|
@@ -1236,7 +1236,7 @@ module KlaviyoAPI
|
|
1236
1236
|
# header parameters
|
1237
1237
|
header_params = opts[:header_params] || {}
|
1238
1238
|
# klaviyo api revision
|
1239
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1239
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1240
1240
|
# HTTP header 'Accept' (if needed)
|
1241
1241
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1242
1242
|
|
@@ -1279,11 +1279,11 @@ module KlaviyoAPI
|
|
1279
1279
|
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1280
1280
|
# @param id [String]
|
1281
1281
|
# @param [Hash] opts the optional parameters
|
1282
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
1283
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
1284
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
1285
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
1286
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1282
|
+
# @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
|
1283
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1284
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1285
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1286
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
1287
1287
|
# @return [Hash<String, Object>]
|
1288
1288
|
def get_messages_for_campaign(id, opts = {})
|
1289
1289
|
data, _status_code, _headers = get_messages_for_campaign_with_http_info(id, opts)
|
@@ -1300,11 +1300,11 @@ module KlaviyoAPI
|
|
1300
1300
|
# Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
|
1301
1301
|
# @param id [String]
|
1302
1302
|
# @param [Hash] opts the optional parameters
|
1303
|
-
# @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
1304
|
-
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-
|
1305
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
1306
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
1307
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1303
|
+
# @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
|
1304
|
+
# @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1305
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1306
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1307
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
1308
1308
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1309
1309
|
def get_messages_for_campaign_with_http_info(id, opts = {})
|
1310
1310
|
if @api_client.config.debugging
|
@@ -1348,7 +1348,7 @@ module KlaviyoAPI
|
|
1348
1348
|
# header parameters
|
1349
1349
|
header_params = opts[:header_params] || {}
|
1350
1350
|
# klaviyo api revision
|
1351
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1351
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1352
1352
|
# HTTP header 'Accept' (if needed)
|
1353
1353
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1354
1354
|
|
@@ -1422,7 +1422,7 @@ module KlaviyoAPI
|
|
1422
1422
|
# header parameters
|
1423
1423
|
header_params = opts[:header_params] || {}
|
1424
1424
|
# klaviyo api revision
|
1425
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1425
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1426
1426
|
# HTTP header 'Accept' (if needed)
|
1427
1427
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1428
1428
|
|
@@ -1462,7 +1462,7 @@ module KlaviyoAPI
|
|
1462
1462
|
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
1463
1463
|
# @param id [String]
|
1464
1464
|
# @param [Hash] opts the optional parameters
|
1465
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
1465
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1466
1466
|
# @return [Hash<String, Object>]
|
1467
1467
|
def get_tags_for_campaign(id, opts = {})
|
1468
1468
|
data, _status_code, _headers = get_tags_for_campaign_with_http_info(id, opts)
|
@@ -1476,7 +1476,7 @@ module KlaviyoAPI
|
|
1476
1476
|
# Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
|
1477
1477
|
# @param id [String]
|
1478
1478
|
# @param [Hash] opts the optional parameters
|
1479
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
1479
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1480
1480
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1481
1481
|
def get_tags_for_campaign_with_http_info(id, opts = {})
|
1482
1482
|
if @api_client.config.debugging
|
@@ -1500,7 +1500,7 @@ module KlaviyoAPI
|
|
1500
1500
|
# header parameters
|
1501
1501
|
header_params = opts[:header_params] || {}
|
1502
1502
|
# klaviyo api revision
|
1503
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1503
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1504
1504
|
# HTTP header 'Accept' (if needed)
|
1505
1505
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1506
1506
|
|
@@ -1540,7 +1540,7 @@ module KlaviyoAPI
|
|
1540
1540
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1541
1541
|
# @param id [String]
|
1542
1542
|
# @param [Hash] opts the optional parameters
|
1543
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
1543
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1544
1544
|
# @return [Hash<String, Object>]
|
1545
1545
|
def get_template_for_campaign_message(id, opts = {})
|
1546
1546
|
data, _status_code, _headers = get_template_for_campaign_message_with_http_info(id, opts)
|
@@ -1554,7 +1554,7 @@ module KlaviyoAPI
|
|
1554
1554
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
|
1555
1555
|
# @param id [String]
|
1556
1556
|
# @param [Hash] opts the optional parameters
|
1557
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
1557
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1558
1558
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1559
1559
|
def get_template_for_campaign_message_with_http_info(id, opts = {})
|
1560
1560
|
if @api_client.config.debugging
|
@@ -1578,7 +1578,7 @@ module KlaviyoAPI
|
|
1578
1578
|
# header parameters
|
1579
1579
|
header_params = opts[:header_params] || {}
|
1580
1580
|
# klaviyo api revision
|
1581
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1581
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1582
1582
|
# HTTP header 'Accept' (if needed)
|
1583
1583
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1584
1584
|
|
@@ -1649,7 +1649,7 @@ module KlaviyoAPI
|
|
1649
1649
|
# header parameters
|
1650
1650
|
header_params = opts[:header_params] || {}
|
1651
1651
|
# klaviyo api revision
|
1652
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1652
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1653
1653
|
# HTTP header 'Accept' (if needed)
|
1654
1654
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1655
1655
|
|
@@ -1720,7 +1720,7 @@ module KlaviyoAPI
|
|
1720
1720
|
# header parameters
|
1721
1721
|
header_params = opts[:header_params] || {}
|
1722
1722
|
# klaviyo api revision
|
1723
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1723
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1724
1724
|
# HTTP header 'Accept' (if needed)
|
1725
1725
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1726
1726
|
# HTTP header 'Content-Type'
|
@@ -1796,7 +1796,7 @@ module KlaviyoAPI
|
|
1796
1796
|
# header parameters
|
1797
1797
|
header_params = opts[:header_params] || {}
|
1798
1798
|
# klaviyo api revision
|
1799
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1799
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1800
1800
|
# HTTP header 'Accept' (if needed)
|
1801
1801
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1802
1802
|
# HTTP header 'Content-Type'
|
@@ -1875,7 +1875,7 @@ module KlaviyoAPI
|
|
1875
1875
|
# header parameters
|
1876
1876
|
header_params = opts[:header_params] || {}
|
1877
1877
|
# klaviyo api revision
|
1878
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1878
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1879
1879
|
# HTTP header 'Accept' (if needed)
|
1880
1880
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1881
1881
|
# HTTP header 'Content-Type'
|
@@ -1951,7 +1951,7 @@ module KlaviyoAPI
|
|
1951
1951
|
# header parameters
|
1952
1952
|
header_params = opts[:header_params] || {}
|
1953
1953
|
# klaviyo api revision
|
1954
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1954
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1955
1955
|
# HTTP header 'Accept' (if needed)
|
1956
1956
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1957
1957
|
# HTTP header 'Content-Type'
|
@@ -2030,7 +2030,7 @@ module KlaviyoAPI
|
|
2030
2030
|
# header parameters
|
2031
2031
|
header_params = opts[:header_params] || {}
|
2032
2032
|
# klaviyo api revision
|
2033
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2033
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2034
2034
|
# HTTP header 'Accept' (if needed)
|
2035
2035
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2036
2036
|
# HTTP header 'Content-Type'
|