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
@@ -56,7 +56,7 @@ module KlaviyoAPI
|
|
56
56
|
# header parameters
|
57
57
|
header_params = opts[:header_params] || {}
|
58
58
|
# klaviyo api revision
|
59
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
59
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
60
60
|
# HTTP header 'Accept' (if needed)
|
61
61
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
62
62
|
# HTTP header 'Content-Type'
|
@@ -132,7 +132,7 @@ module KlaviyoAPI
|
|
132
132
|
# header parameters
|
133
133
|
header_params = opts[:header_params] || {}
|
134
134
|
# klaviyo api revision
|
135
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
135
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
136
136
|
# HTTP header 'Accept' (if needed)
|
137
137
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
138
138
|
# HTTP header 'Content-Type'
|
@@ -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
|
# HTTP header 'Content-Type'
|
@@ -272,7 +272,7 @@ module KlaviyoAPI
|
|
272
272
|
# header parameters
|
273
273
|
header_params = opts[:header_params] || {}
|
274
274
|
# klaviyo api revision
|
275
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
275
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
276
276
|
# HTTP header 'Accept' (if needed)
|
277
277
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
278
278
|
|
@@ -337,7 +337,7 @@ module KlaviyoAPI
|
|
337
337
|
# header parameters
|
338
338
|
header_params = opts[:header_params] || {}
|
339
339
|
# klaviyo api revision
|
340
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
340
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
341
341
|
# HTTP header 'Accept' (if needed)
|
342
342
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
343
343
|
|
@@ -373,9 +373,9 @@ module KlaviyoAPI
|
|
373
373
|
# Get Bulk Create Coupon Code Jobs
|
374
374
|
# Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
375
375
|
# @param [Hash] opts the optional parameters
|
376
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
377
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
378
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
376
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
377
|
+
# @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>`status`: `equals`
|
378
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
379
379
|
# @return [Hash<String, Object>]
|
380
380
|
def get_bulk_create_coupon_code_jobs(opts = {})
|
381
381
|
data, _status_code, _headers = get_bulk_create_coupon_code_jobs_with_http_info(opts)
|
@@ -388,9 +388,9 @@ module KlaviyoAPI
|
|
388
388
|
# Get Bulk Create Coupon Code Jobs
|
389
389
|
# Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
390
390
|
# @param [Hash] opts the optional parameters
|
391
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
392
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
393
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
391
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
392
|
+
# @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>`status`: `equals`
|
393
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
394
394
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
395
395
|
def get_bulk_create_coupon_code_jobs_with_http_info(opts = {})
|
396
396
|
if @api_client.config.debugging
|
@@ -412,7 +412,7 @@ module KlaviyoAPI
|
|
412
412
|
# header parameters
|
413
413
|
header_params = opts[:header_params] || {}
|
414
414
|
# klaviyo api revision
|
415
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
415
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
416
416
|
# HTTP header 'Accept' (if needed)
|
417
417
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
418
418
|
|
@@ -452,9 +452,9 @@ module KlaviyoAPI
|
|
452
452
|
# Get a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
453
453
|
# @param job_id [String] ID of the job to retrieve.
|
454
454
|
# @param [Hash] opts the optional parameters
|
455
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
456
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
457
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
455
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
456
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
457
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
458
458
|
# @return [Hash<String, Object>]
|
459
459
|
def get_bulk_create_coupon_codes_job(job_id, opts = {})
|
460
460
|
data, _status_code, _headers = get_bulk_create_coupon_codes_job_with_http_info(job_id, opts)
|
@@ -468,9 +468,9 @@ module KlaviyoAPI
|
|
468
468
|
# Get a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
469
469
|
# @param job_id [String] ID of the job to retrieve.
|
470
470
|
# @param [Hash] opts the optional parameters
|
471
|
-
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
472
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
473
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
471
|
+
# @option opts [Array<String>] :fields_coupon_code_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
472
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
473
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
474
474
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
475
475
|
def get_bulk_create_coupon_codes_job_with_http_info(job_id, opts = {})
|
476
476
|
if @api_client.config.debugging
|
@@ -504,7 +504,7 @@ module KlaviyoAPI
|
|
504
504
|
# header parameters
|
505
505
|
header_params = opts[:header_params] || {}
|
506
506
|
# klaviyo api revision
|
507
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
507
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
508
508
|
# HTTP header 'Accept' (if needed)
|
509
509
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
510
510
|
|
@@ -544,7 +544,7 @@ module KlaviyoAPI
|
|
544
544
|
# Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
545
545
|
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
546
546
|
# @param [Hash] opts the optional parameters
|
547
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
547
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
548
548
|
# @return [Hash<String, Object>]
|
549
549
|
def get_coupon(id, opts = {})
|
550
550
|
data, _status_code, _headers = get_coupon_with_http_info(id, opts)
|
@@ -555,7 +555,7 @@ module KlaviyoAPI
|
|
555
555
|
# Get a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
556
556
|
# @param id [String] The internal id of a Coupon is equivalent to its external id stored within an integration.
|
557
557
|
# @param [Hash] opts the optional parameters
|
558
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
558
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
559
559
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
560
560
|
def get_coupon_with_http_info(id, opts = {})
|
561
561
|
if @api_client.config.debugging
|
@@ -579,7 +579,7 @@ module KlaviyoAPI
|
|
579
579
|
# header parameters
|
580
580
|
header_params = opts[:header_params] || {}
|
581
581
|
# klaviyo api revision
|
582
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
582
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
583
583
|
# HTTP header 'Accept' (if needed)
|
584
584
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
585
585
|
|
@@ -616,9 +616,9 @@ module KlaviyoAPI
|
|
616
616
|
# Returns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read`
|
617
617
|
# @param id [String] The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
|
618
618
|
# @param [Hash] opts the optional parameters
|
619
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
620
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
621
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
619
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
620
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
621
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
622
622
|
# @return [Hash<String, Object>]
|
623
623
|
def get_coupon_code(id, opts = {})
|
624
624
|
data, _status_code, _headers = get_coupon_code_with_http_info(id, opts)
|
@@ -629,9 +629,9 @@ module KlaviyoAPI
|
|
629
629
|
# Returns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read`
|
630
630
|
# @param id [String] The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
|
631
631
|
# @param [Hash] opts the optional parameters
|
632
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
633
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
634
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
632
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
633
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
634
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
635
635
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
636
636
|
def get_coupon_code_with_http_info(id, opts = {})
|
637
637
|
if @api_client.config.debugging
|
@@ -665,7 +665,7 @@ module KlaviyoAPI
|
|
665
665
|
# header parameters
|
666
666
|
header_params = opts[:header_params] || {}
|
667
667
|
# klaviyo api revision
|
668
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
668
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
669
669
|
# HTTP header 'Accept' (if needed)
|
670
670
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
671
671
|
|
@@ -702,8 +702,8 @@ module KlaviyoAPI
|
|
702
702
|
# Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
703
703
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
704
704
|
# @param [Hash] opts the optional parameters
|
705
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
706
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
705
|
+
# @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>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
706
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
707
707
|
# @return [Hash<String, Object>]
|
708
708
|
def get_coupon_code_ids_for_coupon(id, opts = {})
|
709
709
|
data, _status_code, _headers = get_coupon_code_ids_for_coupon_with_http_info(id, opts)
|
@@ -723,8 +723,8 @@ module KlaviyoAPI
|
|
723
723
|
# Gets a list of coupon code relationships associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
724
724
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
725
725
|
# @param [Hash] opts the optional parameters
|
726
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
727
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
726
|
+
# @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>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
727
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
728
728
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
729
729
|
def get_coupon_code_ids_for_coupon_with_http_info(id, opts = {})
|
730
730
|
if @api_client.config.debugging
|
@@ -745,7 +745,7 @@ module KlaviyoAPI
|
|
745
745
|
# header parameters
|
746
746
|
header_params = opts[:header_params] || {}
|
747
747
|
# klaviyo api revision
|
748
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
748
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
749
749
|
# HTTP header 'Accept' (if needed)
|
750
750
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
751
751
|
|
@@ -789,12 +789,12 @@ module KlaviyoAPI
|
|
789
789
|
|
790
790
|
# Get Coupon Codes
|
791
791
|
# Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a profile/profiles must be provided as required filter params.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read`
|
792
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-
|
792
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
793
793
|
# @param [Hash] opts the optional parameters
|
794
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
795
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
796
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
797
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
794
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
795
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
796
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
797
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
798
798
|
# @return [Hash<String, Object>]
|
799
799
|
def get_coupon_codes(filter, opts = {})
|
800
800
|
data, _status_code, _headers = get_coupon_codes_with_http_info(filter, opts)
|
@@ -803,12 +803,12 @@ module KlaviyoAPI
|
|
803
803
|
|
804
804
|
# Get Coupon Codes
|
805
805
|
# Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a profile/profiles must be provided as required filter params.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read`
|
806
|
-
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-
|
806
|
+
# @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
807
807
|
# @param [Hash] opts the optional parameters
|
808
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
809
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
810
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
811
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
808
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
809
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
810
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
811
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
812
812
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
813
813
|
def get_coupon_codes_with_http_info(filter, opts = {})
|
814
814
|
if @api_client.config.debugging
|
@@ -844,7 +844,7 @@ module KlaviyoAPI
|
|
844
844
|
# header parameters
|
845
845
|
header_params = opts[:header_params] || {}
|
846
846
|
# klaviyo api revision
|
847
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
847
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
848
848
|
# HTTP header 'Accept' (if needed)
|
849
849
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
850
850
|
|
@@ -881,9 +881,9 @@ module KlaviyoAPI
|
|
881
881
|
# Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
882
882
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
883
883
|
# @param [Hash] opts the optional parameters
|
884
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
885
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
886
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
884
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
885
|
+
# @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>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
886
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
887
887
|
# @return [Hash<String, Object>]
|
888
888
|
def get_coupon_codes_for_coupon(id, opts = {})
|
889
889
|
data, _status_code, _headers = get_coupon_codes_for_coupon_with_http_info(id, opts)
|
@@ -900,9 +900,9 @@ module KlaviyoAPI
|
|
900
900
|
# Gets a list of coupon codes associated with the given coupon id<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
|
901
901
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
902
902
|
# @param [Hash] opts the optional parameters
|
903
|
-
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-
|
904
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
905
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
903
|
+
# @option opts [Array<String>] :fields_coupon_code For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
904
|
+
# @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>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
|
905
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
906
906
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
907
907
|
def get_coupon_codes_for_coupon_with_http_info(id, opts = {})
|
908
908
|
if @api_client.config.debugging
|
@@ -928,7 +928,7 @@ module KlaviyoAPI
|
|
928
928
|
# header parameters
|
929
929
|
header_params = opts[:header_params] || {}
|
930
930
|
# klaviyo api revision
|
931
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
931
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
932
932
|
# HTTP header 'Accept' (if needed)
|
933
933
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
934
934
|
|
@@ -971,7 +971,7 @@ module KlaviyoAPI
|
|
971
971
|
# Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
972
972
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
973
973
|
# @param [Hash] opts the optional parameters
|
974
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
974
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
975
975
|
# @return [Hash<String, Object>]
|
976
976
|
def get_coupon_for_coupon_code(id, opts = {})
|
977
977
|
data, _status_code, _headers = get_coupon_for_coupon_code_with_http_info(id, opts)
|
@@ -985,7 +985,7 @@ module KlaviyoAPI
|
|
985
985
|
# Get the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
986
986
|
# @param id [String] The ID of the coupon to look up the relationship of.
|
987
987
|
# @param [Hash] opts the optional parameters
|
988
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
988
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
989
989
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
990
990
|
def get_coupon_for_coupon_code_with_http_info(id, opts = {})
|
991
991
|
if @api_client.config.debugging
|
@@ -1009,7 +1009,7 @@ module KlaviyoAPI
|
|
1009
1009
|
# header parameters
|
1010
1010
|
header_params = opts[:header_params] || {}
|
1011
1011
|
# klaviyo api revision
|
1012
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1012
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1013
1013
|
# HTTP header 'Accept' (if needed)
|
1014
1014
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1015
1015
|
|
@@ -1080,7 +1080,7 @@ module KlaviyoAPI
|
|
1080
1080
|
# header parameters
|
1081
1081
|
header_params = opts[:header_params] || {}
|
1082
1082
|
# klaviyo api revision
|
1083
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1083
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1084
1084
|
# HTTP header 'Accept' (if needed)
|
1085
1085
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1086
1086
|
|
@@ -1119,8 +1119,8 @@ module KlaviyoAPI
|
|
1119
1119
|
# Get Coupons
|
1120
1120
|
# Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
1121
1121
|
# @param [Hash] opts the optional parameters
|
1122
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
1123
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1122
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1123
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1124
1124
|
# @return [Hash<String, Object>]
|
1125
1125
|
def get_coupons(opts = {})
|
1126
1126
|
data, _status_code, _headers = get_coupons_with_http_info(opts)
|
@@ -1130,8 +1130,8 @@ module KlaviyoAPI
|
|
1130
1130
|
# Get Coupons
|
1131
1131
|
# Get all coupons in an account. To learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
|
1132
1132
|
# @param [Hash] opts the optional parameters
|
1133
|
-
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-
|
1134
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1133
|
+
# @option opts [Array<String>] :fields_coupon For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1134
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1135
1135
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1136
1136
|
def get_coupons_with_http_info(opts = {})
|
1137
1137
|
if @api_client.config.debugging
|
@@ -1152,7 +1152,7 @@ module KlaviyoAPI
|
|
1152
1152
|
# header parameters
|
1153
1153
|
header_params = opts[:header_params] || {}
|
1154
1154
|
# klaviyo api revision
|
1155
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1155
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1156
1156
|
# HTTP header 'Accept' (if needed)
|
1157
1157
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1158
1158
|
|
@@ -1223,7 +1223,7 @@ module KlaviyoAPI
|
|
1223
1223
|
# header parameters
|
1224
1224
|
header_params = opts[:header_params] || {}
|
1225
1225
|
# klaviyo api revision
|
1226
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1226
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1227
1227
|
# HTTP header 'Accept' (if needed)
|
1228
1228
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1229
1229
|
# HTTP header 'Content-Type'
|
@@ -1299,7 +1299,7 @@ module KlaviyoAPI
|
|
1299
1299
|
# header parameters
|
1300
1300
|
header_params = opts[:header_params] || {}
|
1301
1301
|
# klaviyo api revision
|
1302
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1302
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1303
1303
|
# HTTP header 'Accept' (if needed)
|
1304
1304
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1305
1305
|
# HTTP header 'Content-Type'
|