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
@@ -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
|
# HTTP header 'Content-Type'
|
@@ -127,7 +127,7 @@ module KlaviyoAPI
|
|
127
127
|
# header parameters
|
128
128
|
header_params = opts[:header_params] || {}
|
129
129
|
# klaviyo api revision
|
130
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
130
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
131
131
|
# HTTP header 'Accept' (if needed)
|
132
132
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
133
133
|
|
@@ -164,7 +164,7 @@ module KlaviyoAPI
|
|
164
164
|
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
165
165
|
# @param id [String]
|
166
166
|
# @param [Hash] opts the optional parameters
|
167
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
167
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
168
168
|
# @return [Hash<String, Object>]
|
169
169
|
def get_action_for_flow_message(id, opts = {})
|
170
170
|
data, _status_code, _headers = get_action_for_flow_message_with_http_info(id, opts)
|
@@ -178,7 +178,7 @@ module KlaviyoAPI
|
|
178
178
|
# Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
179
179
|
# @param id [String]
|
180
180
|
# @param [Hash] opts the optional parameters
|
181
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
181
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
182
182
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
183
183
|
def get_action_for_flow_message_with_http_info(id, opts = {})
|
184
184
|
if @api_client.config.debugging
|
@@ -202,7 +202,7 @@ module KlaviyoAPI
|
|
202
202
|
# header parameters
|
203
203
|
header_params = opts[:header_params] || {}
|
204
204
|
# klaviyo api revision
|
205
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
205
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
206
206
|
# HTTP header 'Accept' (if needed)
|
207
207
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
208
208
|
|
@@ -273,7 +273,7 @@ module KlaviyoAPI
|
|
273
273
|
# header parameters
|
274
274
|
header_params = opts[:header_params] || {}
|
275
275
|
# klaviyo api revision
|
276
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
276
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
277
277
|
# HTTP header 'Accept' (if needed)
|
278
278
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
279
279
|
|
@@ -313,10 +313,10 @@ module KlaviyoAPI
|
|
313
313
|
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
314
314
|
# @param id [String]
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
317
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
316
|
+
# @option opts [String] :filter 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>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
317
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
318
318
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
319
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
319
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
320
320
|
# @return [Hash<String, Object>]
|
321
321
|
def get_action_ids_for_flow(id, opts = {})
|
322
322
|
data, _status_code, _headers = get_action_ids_for_flow_with_http_info(id, opts)
|
@@ -333,10 +333,10 @@ module KlaviyoAPI
|
|
333
333
|
# Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Returns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
334
334
|
# @param id [String]
|
335
335
|
# @param [Hash] opts the optional parameters
|
336
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
337
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
336
|
+
# @option opts [String] :filter 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>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
337
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
338
338
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
339
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
339
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
340
340
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
341
341
|
def get_action_ids_for_flow_with_http_info(id, opts = {})
|
342
342
|
if @api_client.config.debugging
|
@@ -371,7 +371,7 @@ module KlaviyoAPI
|
|
371
371
|
# header parameters
|
372
372
|
header_params = opts[:header_params] || {}
|
373
373
|
# klaviyo api revision
|
374
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
374
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
375
375
|
# HTTP header 'Accept' (if needed)
|
376
376
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
377
377
|
|
@@ -414,11 +414,11 @@ module KlaviyoAPI
|
|
414
414
|
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
415
415
|
# @param id [String]
|
416
416
|
# @param [Hash] opts the optional parameters
|
417
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
418
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
419
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
417
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
418
|
+
# @option opts [String] :filter 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>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
419
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
420
420
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
421
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
421
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
422
422
|
# @return [Hash<String, Object>]
|
423
423
|
def get_actions_for_flow(id, opts = {})
|
424
424
|
data, _status_code, _headers = get_actions_for_flow_with_http_info(id, opts)
|
@@ -435,11 +435,11 @@ module KlaviyoAPI
|
|
435
435
|
# Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
436
436
|
# @param id [String]
|
437
437
|
# @param [Hash] opts the optional parameters
|
438
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
439
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
440
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
438
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
439
|
+
# @option opts [String] :filter 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>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
440
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
441
441
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
442
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
442
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
443
443
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
444
444
|
def get_actions_for_flow_with_http_info(id, opts = {})
|
445
445
|
if @api_client.config.debugging
|
@@ -479,7 +479,7 @@ module KlaviyoAPI
|
|
479
479
|
# header parameters
|
480
480
|
header_params = opts[:header_params] || {}
|
481
481
|
# klaviyo api revision
|
482
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
482
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
483
483
|
# HTTP header 'Accept' (if needed)
|
484
484
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
485
485
|
|
@@ -523,10 +523,10 @@ module KlaviyoAPI
|
|
523
523
|
# @param id [String]
|
524
524
|
# @param [Hash] opts the optional parameters
|
525
525
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
526
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
527
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
528
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
529
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
526
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
527
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
528
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
529
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
530
530
|
# @return [Hash<String, Object>]
|
531
531
|
def get_flow(id, opts = {})
|
532
532
|
data, _status_code, _headers = get_flow_with_http_info(id, opts)
|
@@ -538,10 +538,10 @@ module KlaviyoAPI
|
|
538
538
|
# @param id [String]
|
539
539
|
# @param [Hash] opts the optional parameters
|
540
540
|
# @option opts [Array<String>] :additional_fields_flow Request additional fields not included by default in the response. Supported values: 'definition'
|
541
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
542
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
543
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
544
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
541
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
542
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
543
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
544
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
545
545
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
546
546
|
def get_flow_with_http_info(id, opts = {})
|
547
547
|
if @api_client.config.debugging
|
@@ -585,7 +585,7 @@ module KlaviyoAPI
|
|
585
585
|
# header parameters
|
586
586
|
header_params = opts[:header_params] || {}
|
587
587
|
# klaviyo api revision
|
588
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
588
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
589
589
|
# HTTP header 'Accept' (if needed)
|
590
590
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
591
591
|
|
@@ -622,10 +622,10 @@ module KlaviyoAPI
|
|
622
622
|
# Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
623
623
|
# @param id [String]
|
624
624
|
# @param [Hash] opts the optional parameters
|
625
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
626
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
627
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
628
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
625
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
626
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
627
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
628
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
629
629
|
# @return [Hash<String, Object>]
|
630
630
|
def get_flow_action(id, opts = {})
|
631
631
|
data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
|
@@ -636,10 +636,10 @@ module KlaviyoAPI
|
|
636
636
|
# Get a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
637
637
|
# @param id [String]
|
638
638
|
# @param [Hash] opts the optional parameters
|
639
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
640
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
641
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
642
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
639
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
640
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
641
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
642
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
643
643
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
644
644
|
def get_flow_action_with_http_info(id, opts = {})
|
645
645
|
if @api_client.config.debugging
|
@@ -678,7 +678,7 @@ module KlaviyoAPI
|
|
678
678
|
# header parameters
|
679
679
|
header_params = opts[:header_params] || {}
|
680
680
|
# klaviyo api revision
|
681
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
681
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
682
682
|
# HTTP header 'Accept' (if needed)
|
683
683
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
684
684
|
|
@@ -715,11 +715,11 @@ module KlaviyoAPI
|
|
715
715
|
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
716
716
|
# @param id [String]
|
717
717
|
# @param [Hash] opts the optional parameters
|
718
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
719
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
720
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
718
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
719
|
+
# @option opts [String] :filter 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>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
720
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
721
721
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
722
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
722
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
723
723
|
# @return [Hash<String, Object>]
|
724
724
|
def get_flow_action_messages(id, opts = {})
|
725
725
|
data, _status_code, _headers = get_flow_action_messages_with_http_info(id, opts)
|
@@ -733,11 +733,11 @@ module KlaviyoAPI
|
|
733
733
|
# Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
734
734
|
# @param id [String]
|
735
735
|
# @param [Hash] opts the optional parameters
|
736
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
737
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
738
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
736
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
737
|
+
# @option opts [String] :filter 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>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
738
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
739
739
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
740
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
740
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
741
741
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
742
742
|
def get_flow_action_messages_with_http_info(id, opts = {})
|
743
743
|
if @api_client.config.debugging
|
@@ -777,7 +777,7 @@ module KlaviyoAPI
|
|
777
777
|
# header parameters
|
778
778
|
header_params = opts[:header_params] || {}
|
779
779
|
# klaviyo api revision
|
780
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
780
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
781
781
|
# HTTP header 'Accept' (if needed)
|
782
782
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
783
783
|
|
@@ -817,7 +817,7 @@ module KlaviyoAPI
|
|
817
817
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
818
818
|
# @param id [String]
|
819
819
|
# @param [Hash] opts the optional parameters
|
820
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
820
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
821
821
|
# @return [Hash<String, Object>]
|
822
822
|
def get_flow_for_flow_action(id, opts = {})
|
823
823
|
data, _status_code, _headers = get_flow_for_flow_action_with_http_info(id, opts)
|
@@ -831,7 +831,7 @@ module KlaviyoAPI
|
|
831
831
|
# Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
832
832
|
# @param id [String]
|
833
833
|
# @param [Hash] opts the optional parameters
|
834
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
834
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
835
835
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
836
836
|
def get_flow_for_flow_action_with_http_info(id, opts = {})
|
837
837
|
if @api_client.config.debugging
|
@@ -855,7 +855,7 @@ module KlaviyoAPI
|
|
855
855
|
# header parameters
|
856
856
|
header_params = opts[:header_params] || {}
|
857
857
|
# klaviyo api revision
|
858
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
858
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
859
859
|
# HTTP header 'Accept' (if needed)
|
860
860
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
861
861
|
|
@@ -926,7 +926,7 @@ module KlaviyoAPI
|
|
926
926
|
# header parameters
|
927
927
|
header_params = opts[:header_params] || {}
|
928
928
|
# klaviyo api revision
|
929
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
929
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
930
930
|
# HTTP header 'Accept' (if needed)
|
931
931
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
932
932
|
|
@@ -966,10 +966,10 @@ module KlaviyoAPI
|
|
966
966
|
# Get the flow message of a flow with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
967
967
|
# @param id [String]
|
968
968
|
# @param [Hash] opts the optional parameters
|
969
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
970
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
971
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
972
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
969
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
970
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
971
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
972
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
973
973
|
# @return [Hash<String, Object>]
|
974
974
|
def get_flow_message(id, opts = {})
|
975
975
|
data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
|
@@ -980,10 +980,10 @@ module KlaviyoAPI
|
|
980
980
|
# Get the flow message of a flow with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
981
981
|
# @param id [String]
|
982
982
|
# @param [Hash] opts the optional parameters
|
983
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
984
|
-
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-
|
985
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
986
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
983
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
984
|
+
# @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
985
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
986
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
987
987
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
988
988
|
def get_flow_message_with_http_info(id, opts = {})
|
989
989
|
if @api_client.config.debugging
|
@@ -1022,7 +1022,7 @@ module KlaviyoAPI
|
|
1022
1022
|
# header parameters
|
1023
1023
|
header_params = opts[:header_params] || {}
|
1024
1024
|
# klaviyo api revision
|
1025
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1025
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1026
1026
|
# HTTP header 'Accept' (if needed)
|
1027
1027
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1028
1028
|
|
@@ -1058,14 +1058,14 @@ module KlaviyoAPI
|
|
1058
1058
|
# Get Flows
|
1059
1059
|
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1060
1060
|
# @param [Hash] opts the optional parameters
|
1061
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
1062
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
1063
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
1064
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1065
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1066
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1061
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1062
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1063
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1064
|
+
# @option opts [String] :filter 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>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
1065
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
1066
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1067
1067
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1068
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1068
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1069
1069
|
# @return [Hash<String, Object>]
|
1070
1070
|
def get_flows(opts = {})
|
1071
1071
|
data, _status_code, _headers = get_flows_with_http_info(opts)
|
@@ -1075,14 +1075,14 @@ module KlaviyoAPI
|
|
1075
1075
|
# Get Flows
|
1076
1076
|
# Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1077
1077
|
# @param [Hash] opts the optional parameters
|
1078
|
-
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-
|
1079
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
1080
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
1081
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1082
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1083
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1078
|
+
# @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1079
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1080
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1081
|
+
# @option opts [String] :filter 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>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals`
|
1082
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
1083
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1084
1084
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1085
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1085
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1086
1086
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1087
1087
|
def get_flows_with_http_info(opts = {})
|
1088
1088
|
if @api_client.config.debugging
|
@@ -1133,7 +1133,7 @@ module KlaviyoAPI
|
|
1133
1133
|
# header parameters
|
1134
1134
|
header_params = opts[:header_params] || {}
|
1135
1135
|
# klaviyo api revision
|
1136
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1136
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1137
1137
|
# HTTP header 'Accept' (if needed)
|
1138
1138
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1139
1139
|
|
@@ -1170,10 +1170,10 @@ module KlaviyoAPI
|
|
1170
1170
|
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1171
1171
|
# @param id [String]
|
1172
1172
|
# @param [Hash] opts the optional parameters
|
1173
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1174
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1173
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1174
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1175
1175
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1176
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1176
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1177
1177
|
# @return [Hash<String, Object>]
|
1178
1178
|
def get_message_ids_for_flow_action(id, opts = {})
|
1179
1179
|
data, _status_code, _headers = get_message_ids_for_flow_action_with_http_info(id, opts)
|
@@ -1187,10 +1187,10 @@ module KlaviyoAPI
|
|
1187
1187
|
# Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
|
1188
1188
|
# @param id [String]
|
1189
1189
|
# @param [Hash] opts the optional parameters
|
1190
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1191
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1190
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
1191
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1192
1192
|
# @option opts [Integer] :page_size Default: 50. Min: 1. Max: 50. (default to 50)
|
1193
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1193
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1194
1194
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1195
1195
|
def get_message_ids_for_flow_action_with_http_info(id, opts = {})
|
1196
1196
|
if @api_client.config.debugging
|
@@ -1225,7 +1225,7 @@ module KlaviyoAPI
|
|
1225
1225
|
# header parameters
|
1226
1226
|
header_params = opts[:header_params] || {}
|
1227
1227
|
# klaviyo api revision
|
1228
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1228
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1229
1229
|
# HTTP header 'Accept' (if needed)
|
1230
1230
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1231
1231
|
|
@@ -1296,7 +1296,7 @@ module KlaviyoAPI
|
|
1296
1296
|
# header parameters
|
1297
1297
|
header_params = opts[:header_params] || {}
|
1298
1298
|
# klaviyo api revision
|
1299
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1299
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1300
1300
|
# HTTP header 'Accept' (if needed)
|
1301
1301
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1302
1302
|
|
@@ -1336,7 +1336,7 @@ module KlaviyoAPI
|
|
1336
1336
|
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1337
1337
|
# @param id [String]
|
1338
1338
|
# @param [Hash] opts the optional parameters
|
1339
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
1339
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1340
1340
|
# @return [Hash<String, Object>]
|
1341
1341
|
def get_tags_for_flow(id, opts = {})
|
1342
1342
|
data, _status_code, _headers = get_tags_for_flow_with_http_info(id, opts)
|
@@ -1350,7 +1350,7 @@ module KlaviyoAPI
|
|
1350
1350
|
# Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
|
1351
1351
|
# @param id [String]
|
1352
1352
|
# @param [Hash] opts the optional parameters
|
1353
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
1353
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1354
1354
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1355
1355
|
def get_tags_for_flow_with_http_info(id, opts = {})
|
1356
1356
|
if @api_client.config.debugging
|
@@ -1374,7 +1374,7 @@ module KlaviyoAPI
|
|
1374
1374
|
# header parameters
|
1375
1375
|
header_params = opts[:header_params] || {}
|
1376
1376
|
# klaviyo api revision
|
1377
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1377
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1378
1378
|
# HTTP header 'Accept' (if needed)
|
1379
1379
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1380
1380
|
|
@@ -1414,7 +1414,7 @@ module KlaviyoAPI
|
|
1414
1414
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1415
1415
|
# @param id [String]
|
1416
1416
|
# @param [Hash] opts the optional parameters
|
1417
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
1417
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1418
1418
|
# @return [Hash<String, Object>]
|
1419
1419
|
def get_template_for_flow_message(id, opts = {})
|
1420
1420
|
data, _status_code, _headers = get_template_for_flow_message_with_http_info(id, opts)
|
@@ -1428,7 +1428,7 @@ module KlaviyoAPI
|
|
1428
1428
|
# Return the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
|
1429
1429
|
# @param id [String]
|
1430
1430
|
# @param [Hash] opts the optional parameters
|
1431
|
-
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-
|
1431
|
+
# @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1432
1432
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1433
1433
|
def get_template_for_flow_message_with_http_info(id, opts = {})
|
1434
1434
|
if @api_client.config.debugging
|
@@ -1452,7 +1452,7 @@ module KlaviyoAPI
|
|
1452
1452
|
# header parameters
|
1453
1453
|
header_params = opts[:header_params] || {}
|
1454
1454
|
# klaviyo api revision
|
1455
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1455
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1456
1456
|
# HTTP header 'Accept' (if needed)
|
1457
1457
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1458
1458
|
|
@@ -1523,7 +1523,7 @@ module KlaviyoAPI
|
|
1523
1523
|
# header parameters
|
1524
1524
|
header_params = opts[:header_params] || {}
|
1525
1525
|
# klaviyo api revision
|
1526
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1526
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1527
1527
|
# HTTP header 'Accept' (if needed)
|
1528
1528
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1529
1529
|
|
@@ -1597,7 +1597,7 @@ module KlaviyoAPI
|
|
1597
1597
|
# header parameters
|
1598
1598
|
header_params = opts[:header_params] || {}
|
1599
1599
|
# klaviyo api revision
|
1600
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1600
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1601
1601
|
# HTTP header 'Accept' (if needed)
|
1602
1602
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1603
1603
|
# HTTP header 'Content-Type'
|