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
@@ -65,7 +65,7 @@ module KlaviyoAPI
|
|
65
65
|
# header parameters
|
66
66
|
header_params = opts[:header_params] || {}
|
67
67
|
# klaviyo api revision
|
68
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
68
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
69
69
|
# HTTP header 'Accept' (if needed)
|
70
70
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
71
71
|
# HTTP header 'Content-Type'
|
@@ -144,7 +144,7 @@ module KlaviyoAPI
|
|
144
144
|
# header parameters
|
145
145
|
header_params = opts[:header_params] || {}
|
146
146
|
# klaviyo api revision
|
147
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
147
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
148
148
|
# HTTP header 'Accept' (if needed)
|
149
149
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
150
150
|
# HTTP header 'Content-Type'
|
@@ -214,7 +214,7 @@ module KlaviyoAPI
|
|
214
214
|
# header parameters
|
215
215
|
header_params = opts[:header_params] || {}
|
216
216
|
# klaviyo api revision
|
217
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
217
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
218
218
|
# HTTP header 'Accept' (if needed)
|
219
219
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
220
220
|
|
@@ -251,7 +251,7 @@ module KlaviyoAPI
|
|
251
251
|
# Get all flows where the given list ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `lists:read`
|
252
252
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
253
253
|
# @param [Hash] opts the optional parameters
|
254
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
254
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
255
255
|
# @return [Hash<String, Object>]
|
256
256
|
def get_flows_triggered_by_list(id, opts = {})
|
257
257
|
data, _status_code, _headers = get_flows_triggered_by_list_with_http_info(id, opts)
|
@@ -268,7 +268,7 @@ module KlaviyoAPI
|
|
268
268
|
# Get all flows where the given list ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `lists:read`
|
269
269
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
270
270
|
# @param [Hash] opts the optional parameters
|
271
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
271
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
272
272
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
273
273
|
def get_flows_triggered_by_list_with_http_info(id, opts = {})
|
274
274
|
if @api_client.config.debugging
|
@@ -292,7 +292,7 @@ module KlaviyoAPI
|
|
292
292
|
# header parameters
|
293
293
|
header_params = opts[:header_params] || {}
|
294
294
|
# klaviyo api revision
|
295
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
295
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
296
296
|
# HTTP header 'Accept' (if needed)
|
297
297
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
298
298
|
|
@@ -369,7 +369,7 @@ module KlaviyoAPI
|
|
369
369
|
# header parameters
|
370
370
|
header_params = opts[:header_params] || {}
|
371
371
|
# klaviyo api revision
|
372
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
372
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
373
373
|
# HTTP header 'Accept' (if needed)
|
374
374
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
375
375
|
|
@@ -409,14 +409,14 @@ module KlaviyoAPI
|
|
409
409
|
alias get_list_relationships_flow_triggers_with_http_info get_ids_for_flows_triggered_by_list_with_http_info
|
410
410
|
|
411
411
|
# Get List
|
412
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
412
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read`
|
413
413
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
414
414
|
# @param [Hash] opts the optional parameters
|
415
415
|
# @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: 'profile_count'
|
416
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
417
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
418
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
419
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
416
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
417
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
418
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
419
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
420
420
|
# @return [Hash<String, Object>]
|
421
421
|
def get_list(id, opts = {})
|
422
422
|
data, _status_code, _headers = get_list_with_http_info(id, opts)
|
@@ -424,14 +424,14 @@ module KlaviyoAPI
|
|
424
424
|
end
|
425
425
|
|
426
426
|
# Get List
|
427
|
-
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
427
|
+
# Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read`
|
428
428
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
429
429
|
# @param [Hash] opts the optional parameters
|
430
430
|
# @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: 'profile_count'
|
431
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
432
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
433
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
434
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
431
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
432
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
433
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
434
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
435
435
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
436
436
|
def get_list_with_http_info(id, opts = {})
|
437
437
|
if @api_client.config.debugging
|
@@ -475,7 +475,7 @@ module KlaviyoAPI
|
|
475
475
|
# header parameters
|
476
476
|
header_params = opts[:header_params] || {}
|
477
477
|
# klaviyo api revision
|
478
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
478
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
479
479
|
# HTTP header 'Accept' (if needed)
|
480
480
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
481
481
|
|
@@ -511,13 +511,13 @@ module KlaviyoAPI
|
|
511
511
|
# Get Lists
|
512
512
|
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read`
|
513
513
|
# @param [Hash] opts the optional parameters
|
514
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
515
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
516
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
517
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
518
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
519
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
520
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
514
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
515
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
516
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
517
|
+
# @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`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
518
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
519
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
520
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
521
521
|
# @return [Hash<String, Object>]
|
522
522
|
def get_lists(opts = {})
|
523
523
|
data, _status_code, _headers = get_lists_with_http_info(opts)
|
@@ -527,13 +527,13 @@ module KlaviyoAPI
|
|
527
527
|
# Get Lists
|
528
528
|
# Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read`
|
529
529
|
# @param [Hash] opts the optional parameters
|
530
|
-
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-
|
531
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
532
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
533
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
534
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
535
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
536
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
530
|
+
# @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
531
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
532
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
533
|
+
# @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`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
|
534
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
535
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
536
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
537
537
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
538
538
|
def get_lists_with_http_info(opts = {})
|
539
539
|
if @api_client.config.debugging
|
@@ -575,7 +575,7 @@ module KlaviyoAPI
|
|
575
575
|
# header parameters
|
576
576
|
header_params = opts[:header_params] || {}
|
577
577
|
# klaviyo api revision
|
578
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
578
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
579
579
|
# HTTP header 'Accept' (if needed)
|
580
580
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
581
581
|
|
@@ -609,13 +609,13 @@ module KlaviyoAPI
|
|
609
609
|
end
|
610
610
|
|
611
611
|
# Get Profile IDs for List
|
612
|
-
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
612
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
|
613
613
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
614
614
|
# @param [Hash] opts the optional parameters
|
615
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
616
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
615
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
616
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
617
617
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
618
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
618
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
619
619
|
# @return [Hash<String, Object>]
|
620
620
|
def get_profile_ids_for_list(id, opts = {})
|
621
621
|
data, _status_code, _headers = get_profile_ids_for_list_with_http_info(id, opts)
|
@@ -626,13 +626,13 @@ module KlaviyoAPI
|
|
626
626
|
alias get_list_relationships_profiles get_profile_ids_for_list
|
627
627
|
|
628
628
|
# Get Profile IDs for List
|
629
|
-
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
629
|
+
# Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
|
630
630
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
631
631
|
# @param [Hash] opts the optional parameters
|
632
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
633
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
632
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
633
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
634
634
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
635
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
635
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
636
636
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
637
637
|
def get_profile_ids_for_list_with_http_info(id, opts = {})
|
638
638
|
if @api_client.config.debugging
|
@@ -667,7 +667,7 @@ module KlaviyoAPI
|
|
667
667
|
# header parameters
|
668
668
|
header_params = opts[:header_params] || {}
|
669
669
|
# klaviyo api revision
|
670
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
670
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
671
671
|
# HTTP header 'Accept' (if needed)
|
672
672
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
673
673
|
|
@@ -704,15 +704,15 @@ module KlaviyoAPI
|
|
704
704
|
alias get_list_relationships_profiles_with_http_info get_profile_ids_for_list_with_http_info
|
705
705
|
|
706
706
|
# Get Profiles for List
|
707
|
-
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
707
|
+
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
|
708
708
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
709
709
|
# @param [Hash] opts the optional parameters
|
710
710
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
711
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
712
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
713
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
711
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
712
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
713
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
714
714
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
715
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
715
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
716
716
|
# @return [Hash<String, Object>]
|
717
717
|
def get_profiles_for_list(id, opts = {})
|
718
718
|
data, _status_code, _headers = get_profiles_for_list_with_http_info(id, opts)
|
@@ -723,15 +723,15 @@ module KlaviyoAPI
|
|
723
723
|
alias get_list_profiles get_profiles_for_list
|
724
724
|
|
725
725
|
# Get Profiles for List
|
726
|
-
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
726
|
+
# Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
|
727
727
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
728
728
|
# @param [Hash] opts the optional parameters
|
729
729
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
730
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
731
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
732
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
730
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
731
|
+
# @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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
732
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
733
733
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
734
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
734
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
735
735
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
736
736
|
def get_profiles_for_list_with_http_info(id, opts = {})
|
737
737
|
if @api_client.config.debugging
|
@@ -776,7 +776,7 @@ module KlaviyoAPI
|
|
776
776
|
# header parameters
|
777
777
|
header_params = opts[:header_params] || {}
|
778
778
|
# klaviyo api revision
|
779
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
779
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
780
780
|
# HTTP header 'Accept' (if needed)
|
781
781
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
782
782
|
|
@@ -847,7 +847,7 @@ module KlaviyoAPI
|
|
847
847
|
# header parameters
|
848
848
|
header_params = opts[:header_params] || {}
|
849
849
|
# klaviyo api revision
|
850
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
850
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
851
851
|
# HTTP header 'Accept' (if needed)
|
852
852
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
853
853
|
|
@@ -887,7 +887,7 @@ module KlaviyoAPI
|
|
887
887
|
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
888
888
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
889
889
|
# @param [Hash] opts the optional parameters
|
890
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
890
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
891
891
|
# @return [Hash<String, Object>]
|
892
892
|
def get_tags_for_list(id, opts = {})
|
893
893
|
data, _status_code, _headers = get_tags_for_list_with_http_info(id, opts)
|
@@ -901,7 +901,7 @@ module KlaviyoAPI
|
|
901
901
|
# Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
|
902
902
|
# @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
|
903
903
|
# @param [Hash] opts the optional parameters
|
904
|
-
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-
|
904
|
+
# @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
905
905
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
906
906
|
def get_tags_for_list_with_http_info(id, opts = {})
|
907
907
|
if @api_client.config.debugging
|
@@ -925,7 +925,7 @@ module KlaviyoAPI
|
|
925
925
|
# header parameters
|
926
926
|
header_params = opts[:header_params] || {}
|
927
927
|
# klaviyo api revision
|
928
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
928
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
929
929
|
# HTTP header 'Accept' (if needed)
|
930
930
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
931
931
|
|
@@ -1005,7 +1005,7 @@ module KlaviyoAPI
|
|
1005
1005
|
# header parameters
|
1006
1006
|
header_params = opts[:header_params] || {}
|
1007
1007
|
# klaviyo api revision
|
1008
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1008
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1009
1009
|
# HTTP header 'Accept' (if needed)
|
1010
1010
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1011
1011
|
# HTTP header 'Content-Type'
|
@@ -1087,7 +1087,7 @@ module KlaviyoAPI
|
|
1087
1087
|
# header parameters
|
1088
1088
|
header_params = opts[:header_params] || {}
|
1089
1089
|
# klaviyo api revision
|
1090
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1090
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1091
1091
|
# HTTP header 'Accept' (if needed)
|
1092
1092
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1093
1093
|
# HTTP header 'Content-Type'
|