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
@@ -50,7 +50,7 @@ module KlaviyoAPI
|
|
50
50
|
# header parameters
|
51
51
|
header_params = opts[:header_params] || {}
|
52
52
|
# klaviyo api revision
|
53
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
53
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
54
54
|
# HTTP header 'Accept' (if needed)
|
55
55
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
56
56
|
|
@@ -87,9 +87,9 @@ module KlaviyoAPI
|
|
87
87
|
# Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
88
88
|
# @param id [String] The ID of the form
|
89
89
|
# @param [Hash] opts the optional parameters
|
90
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-
|
91
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-
|
92
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
90
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
91
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
92
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
93
93
|
# @return [Hash<String, Object>]
|
94
94
|
def get_form(id, opts = {})
|
95
95
|
data, _status_code, _headers = get_form_with_http_info(id, opts)
|
@@ -100,9 +100,9 @@ module KlaviyoAPI
|
|
100
100
|
# Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
101
101
|
# @param id [String] The ID of the form
|
102
102
|
# @param [Hash] opts the optional parameters
|
103
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-
|
104
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-
|
105
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
103
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
104
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
105
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
106
106
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
107
107
|
def get_form_with_http_info(id, opts = {})
|
108
108
|
if @api_client.config.debugging
|
@@ -136,7 +136,7 @@ module KlaviyoAPI
|
|
136
136
|
# header parameters
|
137
137
|
header_params = opts[:header_params] || {}
|
138
138
|
# klaviyo api revision
|
139
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
139
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
140
140
|
# HTTP header 'Accept' (if needed)
|
141
141
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
142
142
|
|
@@ -173,7 +173,7 @@ module KlaviyoAPI
|
|
173
173
|
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
174
174
|
# @param id [String] The ID of the form version
|
175
175
|
# @param [Hash] opts the optional parameters
|
176
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-
|
176
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
177
177
|
# @return [Hash<String, Object>]
|
178
178
|
def get_form_for_form_version(id, opts = {})
|
179
179
|
data, _status_code, _headers = get_form_for_form_version_with_http_info(id, opts)
|
@@ -187,7 +187,7 @@ module KlaviyoAPI
|
|
187
187
|
# Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
188
188
|
# @param id [String] The ID of the form version
|
189
189
|
# @param [Hash] opts the optional parameters
|
190
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-
|
190
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
191
191
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
192
192
|
def get_form_for_form_version_with_http_info(id, opts = {})
|
193
193
|
if @api_client.config.debugging
|
@@ -211,7 +211,7 @@ module KlaviyoAPI
|
|
211
211
|
# header parameters
|
212
212
|
header_params = opts[:header_params] || {}
|
213
213
|
# klaviyo api revision
|
214
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
214
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
215
215
|
# HTTP header 'Accept' (if needed)
|
216
216
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
217
217
|
|
@@ -282,7 +282,7 @@ module KlaviyoAPI
|
|
282
282
|
# header parameters
|
283
283
|
header_params = opts[:header_params] || {}
|
284
284
|
# klaviyo api revision
|
285
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
285
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
286
286
|
# HTTP header 'Accept' (if needed)
|
287
287
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
288
288
|
|
@@ -322,7 +322,7 @@ module KlaviyoAPI
|
|
322
322
|
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
323
323
|
# @param id [String] The ID of the form version
|
324
324
|
# @param [Hash] opts the optional parameters
|
325
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-
|
325
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
326
326
|
# @return [Hash<String, Object>]
|
327
327
|
def get_form_version(id, opts = {})
|
328
328
|
data, _status_code, _headers = get_form_version_with_http_info(id, opts)
|
@@ -333,7 +333,7 @@ module KlaviyoAPI
|
|
333
333
|
# Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
334
334
|
# @param id [String] The ID of the form version
|
335
335
|
# @param [Hash] opts the optional parameters
|
336
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-
|
336
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
337
337
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
338
338
|
def get_form_version_with_http_info(id, opts = {})
|
339
339
|
if @api_client.config.debugging
|
@@ -357,7 +357,7 @@ module KlaviyoAPI
|
|
357
357
|
# header parameters
|
358
358
|
header_params = opts[:header_params] || {}
|
359
359
|
# klaviyo api revision
|
360
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
360
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
361
361
|
# HTTP header 'Accept' (if needed)
|
362
362
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
363
363
|
|
@@ -393,11 +393,11 @@ module KlaviyoAPI
|
|
393
393
|
# Get Forms
|
394
394
|
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
395
395
|
# @param [Hash] opts the optional parameters
|
396
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-
|
397
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
398
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
396
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
397
|
+
# @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`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`
|
398
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
399
399
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
400
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
400
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
401
401
|
# @return [Hash<String, Object>]
|
402
402
|
def get_forms(opts = {})
|
403
403
|
data, _status_code, _headers = get_forms_with_http_info(opts)
|
@@ -407,11 +407,11 @@ module KlaviyoAPI
|
|
407
407
|
# Get Forms
|
408
408
|
# Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
409
409
|
# @param [Hash] opts the optional parameters
|
410
|
-
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-
|
411
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
412
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
410
|
+
# @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
411
|
+
# @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`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`
|
412
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
413
413
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
414
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
414
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
415
415
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
416
416
|
def get_forms_with_http_info(opts = {})
|
417
417
|
if @api_client.config.debugging
|
@@ -447,7 +447,7 @@ module KlaviyoAPI
|
|
447
447
|
# header parameters
|
448
448
|
header_params = opts[:header_params] || {}
|
449
449
|
# klaviyo api revision
|
450
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
450
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
451
451
|
# HTTP header 'Accept' (if needed)
|
452
452
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
453
453
|
|
@@ -484,10 +484,10 @@ module KlaviyoAPI
|
|
484
484
|
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
485
485
|
# @param id [String] The ID of the form
|
486
486
|
# @param [Hash] opts the optional parameters
|
487
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
488
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
487
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
488
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
489
489
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
490
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
490
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
491
491
|
# @return [Hash<String, Object>]
|
492
492
|
def get_version_ids_for_form(id, opts = {})
|
493
493
|
data, _status_code, _headers = get_version_ids_for_form_with_http_info(id, opts)
|
@@ -504,10 +504,10 @@ module KlaviyoAPI
|
|
504
504
|
# Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
505
505
|
# @param id [String] The ID of the form
|
506
506
|
# @param [Hash] opts the optional parameters
|
507
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
508
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
507
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
508
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
509
509
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
510
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
510
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
511
511
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
512
512
|
def get_version_ids_for_form_with_http_info(id, opts = {})
|
513
513
|
if @api_client.config.debugging
|
@@ -538,7 +538,7 @@ module KlaviyoAPI
|
|
538
538
|
# header parameters
|
539
539
|
header_params = opts[:header_params] || {}
|
540
540
|
# klaviyo api revision
|
541
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
541
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
542
542
|
# HTTP header 'Accept' (if needed)
|
543
543
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
544
544
|
|
@@ -581,11 +581,11 @@ module KlaviyoAPI
|
|
581
581
|
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
582
582
|
# @param id [String] The ID of the form
|
583
583
|
# @param [Hash] opts the optional parameters
|
584
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-
|
585
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
586
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
584
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
585
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
586
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
587
587
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
588
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
588
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
589
589
|
# @return [Hash<String, Object>]
|
590
590
|
def get_versions_for_form(id, opts = {})
|
591
591
|
data, _status_code, _headers = get_versions_for_form_with_http_info(id, opts)
|
@@ -602,11 +602,11 @@ module KlaviyoAPI
|
|
602
602
|
# Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
|
603
603
|
# @param id [String] The ID of the form
|
604
604
|
# @param [Hash] opts the optional parameters
|
605
|
-
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-
|
606
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
607
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
605
|
+
# @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
606
|
+
# @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>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
607
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
608
608
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
609
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
609
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
610
610
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
611
611
|
def get_versions_for_form_with_http_info(id, opts = {})
|
612
612
|
if @api_client.config.debugging
|
@@ -642,7 +642,7 @@ module KlaviyoAPI
|
|
642
642
|
# header parameters
|
643
643
|
header_params = opts[:header_params] || {}
|
644
644
|
# klaviyo api revision
|
645
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
645
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
646
646
|
# HTTP header 'Accept' (if needed)
|
647
647
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
648
648
|
|
@@ -22,7 +22,7 @@ module KlaviyoAPI
|
|
22
22
|
# Get the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
|
23
23
|
# @param id [String] The ID of the image
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
25
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
26
26
|
# @return [Hash<String, Object>]
|
27
27
|
def get_image(id, opts = {})
|
28
28
|
data, _status_code, _headers = get_image_with_http_info(id, opts)
|
@@ -33,7 +33,7 @@ module KlaviyoAPI
|
|
33
33
|
# Get the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
|
34
34
|
# @param id [String] The ID of the image
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
36
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
37
37
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
38
38
|
def get_image_with_http_info(id, opts = {})
|
39
39
|
if @api_client.config.debugging
|
@@ -57,7 +57,7 @@ module KlaviyoAPI
|
|
57
57
|
# header parameters
|
58
58
|
header_params = opts[:header_params] || {}
|
59
59
|
# klaviyo api revision
|
60
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
60
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
61
61
|
# HTTP header 'Accept' (if needed)
|
62
62
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
63
63
|
|
@@ -93,11 +93,11 @@ module KlaviyoAPI
|
|
93
93
|
# Get Images
|
94
94
|
# Get all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
|
95
95
|
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
97
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
98
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
96
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
97
|
+
# @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`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`
|
98
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
99
99
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
100
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
100
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
101
101
|
# @return [Hash<String, Object>]
|
102
102
|
def get_images(opts = {})
|
103
103
|
data, _status_code, _headers = get_images_with_http_info(opts)
|
@@ -107,11 +107,11 @@ module KlaviyoAPI
|
|
107
107
|
# Get Images
|
108
108
|
# Get all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
|
109
109
|
# @param [Hash] opts the optional parameters
|
110
|
-
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-
|
111
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
112
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
110
|
+
# @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
111
|
+
# @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`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`
|
112
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
113
113
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
114
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
114
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
115
115
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
116
116
|
def get_images_with_http_info(opts = {})
|
117
117
|
if @api_client.config.debugging
|
@@ -147,7 +147,7 @@ module KlaviyoAPI
|
|
147
147
|
# header parameters
|
148
148
|
header_params = opts[:header_params] || {}
|
149
149
|
# klaviyo api revision
|
150
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
150
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
151
151
|
# HTTP header 'Accept' (if needed)
|
152
152
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
153
153
|
|
@@ -218,7 +218,7 @@ module KlaviyoAPI
|
|
218
218
|
# header parameters
|
219
219
|
header_params = opts[:header_params] || {}
|
220
220
|
# klaviyo api revision
|
221
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
221
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
222
222
|
# HTTP header 'Accept' (if needed)
|
223
223
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
224
224
|
# HTTP header 'Content-Type'
|
@@ -295,7 +295,7 @@ module KlaviyoAPI
|
|
295
295
|
# header parameters
|
296
296
|
header_params = opts[:header_params] || {}
|
297
297
|
# klaviyo api revision
|
298
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
298
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
299
299
|
# HTTP header 'Accept' (if needed)
|
300
300
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
301
301
|
# HTTP header 'Content-Type'
|
@@ -374,7 +374,7 @@ module KlaviyoAPI
|
|
374
374
|
# header parameters
|
375
375
|
header_params = opts[:header_params] || {}
|
376
376
|
# klaviyo api revision
|
377
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
377
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
378
378
|
# HTTP header 'Accept' (if needed)
|
379
379
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
380
380
|
# HTTP header 'Content-Type'
|