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
@@ -0,0 +1,384 @@
|
|
1
|
+
=begin
|
2
|
+
#Klaviyo API
|
3
|
+
|
4
|
+
#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
|
5
|
+
|
6
|
+
Contact: developers@klaviyo.com
|
7
|
+
Generated by: https://openapi-generator.tech
|
8
|
+
OpenAPI Generator version: 6.2.1
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require 'cgi'
|
13
|
+
|
14
|
+
module KlaviyoAPI
|
15
|
+
class CustomObjectsApi
|
16
|
+
attr_accessor :api_client
|
17
|
+
|
18
|
+
def initialize(api_client = ApiClient.default)
|
19
|
+
@api_client = api_client
|
20
|
+
end
|
21
|
+
# Bulk Create Data Source Records
|
22
|
+
# Create a data source record job.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m` **Scopes:** `custom-objects:write`
|
23
|
+
# @param data_source_record_bulk_create_job_create_query [DataSourceRecordBulkCreateJobCreateQuery] Create a data source record job
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [nil]
|
26
|
+
def bulk_create_data_source_records(data_source_record_bulk_create_job_create_query, opts = {})
|
27
|
+
bulk_create_data_source_records_with_http_info(data_source_record_bulk_create_job_create_query, opts)
|
28
|
+
nil
|
29
|
+
end
|
30
|
+
|
31
|
+
# alias of `bulk_create_data_source_records`
|
32
|
+
alias create_data_source_record_bulk_create_job bulk_create_data_source_records
|
33
|
+
|
34
|
+
# Bulk Create Data Source Records
|
35
|
+
# Create a data source record job.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `15/m` **Scopes:** `custom-objects:write`
|
36
|
+
# @param data_source_record_bulk_create_job_create_query [DataSourceRecordBulkCreateJobCreateQuery] Create a data source record job
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
39
|
+
def bulk_create_data_source_records_with_http_info(data_source_record_bulk_create_job_create_query, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: CustomObjectsApi.bulk_create_data_source_records ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'data_source_record_bulk_create_job_create_query' is set
|
44
|
+
if @api_client.config.client_side_validation && data_source_record_bulk_create_job_create_query.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'data_source_record_bulk_create_job_create_query' when calling CustomObjectsApi.bulk_create_data_source_records"
|
46
|
+
end
|
47
|
+
# resource path
|
48
|
+
local_var_path = '/api/data-source-record-bulk-create-jobs'
|
49
|
+
|
50
|
+
# query parameters
|
51
|
+
query_params = opts[:query_params] || {}
|
52
|
+
|
53
|
+
# header parameters
|
54
|
+
header_params = opts[:header_params] || {}
|
55
|
+
# klaviyo api revision
|
56
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
57
|
+
# HTTP header 'Accept' (if needed)
|
58
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
59
|
+
# HTTP header 'Content-Type'
|
60
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
61
|
+
if !content_type.nil?
|
62
|
+
header_params['Content-Type'] = content_type
|
63
|
+
end
|
64
|
+
|
65
|
+
# form parameters
|
66
|
+
form_params = opts[:form_params] || {}
|
67
|
+
|
68
|
+
# http body (model)
|
69
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(data_source_record_bulk_create_job_create_query)
|
70
|
+
|
71
|
+
# return_type
|
72
|
+
return_type = opts[:debug_return_type]
|
73
|
+
|
74
|
+
# auth_names
|
75
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
76
|
+
|
77
|
+
new_options = opts.merge(
|
78
|
+
:operation => :"CustomObjectsApi.bulk_create_data_source_records",
|
79
|
+
:header_params => header_params,
|
80
|
+
:query_params => query_params,
|
81
|
+
:form_params => form_params,
|
82
|
+
:body => post_body,
|
83
|
+
:auth_names => auth_names,
|
84
|
+
:return_type => return_type
|
85
|
+
)
|
86
|
+
|
87
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
88
|
+
if @api_client.config.debugging
|
89
|
+
@api_client.config.logger.debug "API called: CustomObjectsApi#bulk_create_data_source_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
90
|
+
end
|
91
|
+
return data, status_code, headers
|
92
|
+
end
|
93
|
+
|
94
|
+
# alias of `bulk_create_data_source_records_with_http_info`
|
95
|
+
alias create_data_source_record_bulk_create_job_with_http_info bulk_create_data_source_records_with_http_info
|
96
|
+
|
97
|
+
# Create Data Source
|
98
|
+
# Create a new data source in an account<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write`
|
99
|
+
# @param data_source_create_query [DataSourceCreateQuery] Create data source
|
100
|
+
# @param [Hash] opts the optional parameters
|
101
|
+
# @return [Hash<String, Object>]
|
102
|
+
def create_data_source(data_source_create_query, opts = {})
|
103
|
+
data, _status_code, _headers = create_data_source_with_http_info(data_source_create_query, opts)
|
104
|
+
data
|
105
|
+
end
|
106
|
+
|
107
|
+
# Create Data Source
|
108
|
+
# Create a new data source in an account<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write`
|
109
|
+
# @param data_source_create_query [DataSourceCreateQuery] Create data source
|
110
|
+
# @param [Hash] opts the optional parameters
|
111
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
112
|
+
def create_data_source_with_http_info(data_source_create_query, opts = {})
|
113
|
+
if @api_client.config.debugging
|
114
|
+
@api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_data_source ...'
|
115
|
+
end
|
116
|
+
# verify the required parameter 'data_source_create_query' is set
|
117
|
+
if @api_client.config.client_side_validation && data_source_create_query.nil?
|
118
|
+
fail ArgumentError, "Missing the required parameter 'data_source_create_query' when calling CustomObjectsApi.create_data_source"
|
119
|
+
end
|
120
|
+
# resource path
|
121
|
+
local_var_path = '/api/data-sources'
|
122
|
+
|
123
|
+
# query parameters
|
124
|
+
query_params = opts[:query_params] || {}
|
125
|
+
|
126
|
+
# header parameters
|
127
|
+
header_params = opts[:header_params] || {}
|
128
|
+
# klaviyo api revision
|
129
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
130
|
+
# HTTP header 'Accept' (if needed)
|
131
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
132
|
+
# HTTP header 'Content-Type'
|
133
|
+
content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
|
134
|
+
if !content_type.nil?
|
135
|
+
header_params['Content-Type'] = content_type
|
136
|
+
end
|
137
|
+
|
138
|
+
# form parameters
|
139
|
+
form_params = opts[:form_params] || {}
|
140
|
+
|
141
|
+
# http body (model)
|
142
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(data_source_create_query)
|
143
|
+
|
144
|
+
# return_type
|
145
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
146
|
+
|
147
|
+
# auth_names
|
148
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
149
|
+
|
150
|
+
new_options = opts.merge(
|
151
|
+
:operation => :"CustomObjectsApi.create_data_source",
|
152
|
+
:header_params => header_params,
|
153
|
+
:query_params => query_params,
|
154
|
+
:form_params => form_params,
|
155
|
+
:body => post_body,
|
156
|
+
:auth_names => auth_names,
|
157
|
+
:return_type => return_type
|
158
|
+
)
|
159
|
+
|
160
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
161
|
+
if @api_client.config.debugging
|
162
|
+
@api_client.config.logger.debug "API called: CustomObjectsApi#create_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
163
|
+
end
|
164
|
+
return data, status_code, headers
|
165
|
+
end
|
166
|
+
|
167
|
+
# Delete Data Source
|
168
|
+
# Delete a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write`
|
169
|
+
# @param id [String] The ID of the data source to delete
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @return [nil]
|
172
|
+
def delete_data_source(id, opts = {})
|
173
|
+
delete_data_source_with_http_info(id, opts)
|
174
|
+
nil
|
175
|
+
end
|
176
|
+
|
177
|
+
# Delete Data Source
|
178
|
+
# Delete a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:write`
|
179
|
+
# @param id [String] The ID of the data source to delete
|
180
|
+
# @param [Hash] opts the optional parameters
|
181
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
182
|
+
def delete_data_source_with_http_info(id, opts = {})
|
183
|
+
if @api_client.config.debugging
|
184
|
+
@api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_data_source ...'
|
185
|
+
end
|
186
|
+
# verify the required parameter 'id' is set
|
187
|
+
if @api_client.config.client_side_validation && id.nil?
|
188
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.delete_data_source"
|
189
|
+
end
|
190
|
+
# resource path
|
191
|
+
local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
192
|
+
|
193
|
+
# query parameters
|
194
|
+
query_params = opts[:query_params] || {}
|
195
|
+
|
196
|
+
# header parameters
|
197
|
+
header_params = opts[:header_params] || {}
|
198
|
+
# klaviyo api revision
|
199
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
200
|
+
# HTTP header 'Accept' (if needed)
|
201
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
202
|
+
|
203
|
+
# form parameters
|
204
|
+
form_params = opts[:form_params] || {}
|
205
|
+
|
206
|
+
# http body (model)
|
207
|
+
post_body = opts[:debug_body]
|
208
|
+
|
209
|
+
# return_type
|
210
|
+
return_type = opts[:debug_return_type]
|
211
|
+
|
212
|
+
# auth_names
|
213
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
214
|
+
|
215
|
+
new_options = opts.merge(
|
216
|
+
:operation => :"CustomObjectsApi.delete_data_source",
|
217
|
+
:header_params => header_params,
|
218
|
+
:query_params => query_params,
|
219
|
+
:form_params => form_params,
|
220
|
+
:body => post_body,
|
221
|
+
:auth_names => auth_names,
|
222
|
+
:return_type => return_type
|
223
|
+
)
|
224
|
+
|
225
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
226
|
+
if @api_client.config.debugging
|
227
|
+
@api_client.config.logger.debug "API called: CustomObjectsApi#delete_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
228
|
+
end
|
229
|
+
return data, status_code, headers
|
230
|
+
end
|
231
|
+
|
232
|
+
# Get Data Source
|
233
|
+
# Retrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read`
|
234
|
+
# @param id [String] The ID of the data source
|
235
|
+
# @param [Hash] opts the optional parameters
|
236
|
+
# @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
237
|
+
# @return [Hash<String, Object>]
|
238
|
+
def get_data_source(id, opts = {})
|
239
|
+
data, _status_code, _headers = get_data_source_with_http_info(id, opts)
|
240
|
+
data
|
241
|
+
end
|
242
|
+
|
243
|
+
# Get Data Source
|
244
|
+
# Retrieve a data source in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read`
|
245
|
+
# @param id [String] The ID of the data source
|
246
|
+
# @param [Hash] opts the optional parameters
|
247
|
+
# @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
248
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
249
|
+
def get_data_source_with_http_info(id, opts = {})
|
250
|
+
if @api_client.config.debugging
|
251
|
+
@api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_source ...'
|
252
|
+
end
|
253
|
+
# verify the required parameter 'id' is set
|
254
|
+
if @api_client.config.client_side_validation && id.nil?
|
255
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_data_source"
|
256
|
+
end
|
257
|
+
allowable_values = ["title", "visibility", "description"]
|
258
|
+
if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
|
259
|
+
fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
|
260
|
+
end
|
261
|
+
# resource path
|
262
|
+
local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
263
|
+
|
264
|
+
# query parameters
|
265
|
+
query_params = opts[:query_params] || {}
|
266
|
+
query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
|
267
|
+
|
268
|
+
# header parameters
|
269
|
+
header_params = opts[:header_params] || {}
|
270
|
+
# klaviyo api revision
|
271
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
272
|
+
# HTTP header 'Accept' (if needed)
|
273
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
274
|
+
|
275
|
+
# form parameters
|
276
|
+
form_params = opts[:form_params] || {}
|
277
|
+
|
278
|
+
# http body (model)
|
279
|
+
post_body = opts[:debug_body]
|
280
|
+
|
281
|
+
# return_type
|
282
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
283
|
+
|
284
|
+
# auth_names
|
285
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
286
|
+
|
287
|
+
new_options = opts.merge(
|
288
|
+
:operation => :"CustomObjectsApi.get_data_source",
|
289
|
+
:header_params => header_params,
|
290
|
+
:query_params => query_params,
|
291
|
+
:form_params => form_params,
|
292
|
+
:body => post_body,
|
293
|
+
:auth_names => auth_names,
|
294
|
+
:return_type => return_type
|
295
|
+
)
|
296
|
+
|
297
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
298
|
+
if @api_client.config.debugging
|
299
|
+
@api_client.config.logger.debug "API called: CustomObjectsApi#get_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
300
|
+
end
|
301
|
+
return data, status_code, headers
|
302
|
+
end
|
303
|
+
|
304
|
+
# Get Data Sources
|
305
|
+
# Get all data sources in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read`
|
306
|
+
# @param [Hash] opts the optional parameters
|
307
|
+
# @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
308
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
309
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
310
|
+
# @return [Hash<String, Object>]
|
311
|
+
def get_data_sources(opts = {})
|
312
|
+
data, _status_code, _headers = get_data_sources_with_http_info(opts)
|
313
|
+
data
|
314
|
+
end
|
315
|
+
|
316
|
+
# Get Data Sources
|
317
|
+
# Get all data sources in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `custom-objects:read`
|
318
|
+
# @param [Hash] opts the optional parameters
|
319
|
+
# @option opts [Array<String>] :fields_data_source For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
320
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
321
|
+
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
322
|
+
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
323
|
+
def get_data_sources_with_http_info(opts = {})
|
324
|
+
if @api_client.config.debugging
|
325
|
+
@api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_sources ...'
|
326
|
+
end
|
327
|
+
allowable_values = ["title", "visibility", "description"]
|
328
|
+
if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
|
329
|
+
fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
|
330
|
+
end
|
331
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
332
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be smaller than or equal to 100.'
|
333
|
+
end
|
334
|
+
|
335
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
336
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be greater than or equal to 1.'
|
337
|
+
end
|
338
|
+
|
339
|
+
# resource path
|
340
|
+
local_var_path = '/api/data-sources'
|
341
|
+
|
342
|
+
# query parameters
|
343
|
+
query_params = opts[:query_params] || {}
|
344
|
+
query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
|
345
|
+
query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
|
346
|
+
query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
347
|
+
|
348
|
+
# header parameters
|
349
|
+
header_params = opts[:header_params] || {}
|
350
|
+
# klaviyo api revision
|
351
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
352
|
+
# HTTP header 'Accept' (if needed)
|
353
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
354
|
+
|
355
|
+
# form parameters
|
356
|
+
form_params = opts[:form_params] || {}
|
357
|
+
|
358
|
+
# http body (model)
|
359
|
+
post_body = opts[:debug_body]
|
360
|
+
|
361
|
+
# return_type
|
362
|
+
return_type = opts[:debug_return_type] || 'Hash<String, Object>'
|
363
|
+
|
364
|
+
# auth_names
|
365
|
+
auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
|
366
|
+
|
367
|
+
new_options = opts.merge(
|
368
|
+
:operation => :"CustomObjectsApi.get_data_sources",
|
369
|
+
:header_params => header_params,
|
370
|
+
:query_params => query_params,
|
371
|
+
:form_params => form_params,
|
372
|
+
:body => post_body,
|
373
|
+
:auth_names => auth_names,
|
374
|
+
:return_type => return_type
|
375
|
+
)
|
376
|
+
|
377
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
378
|
+
if @api_client.config.debugging
|
379
|
+
@api_client.config.logger.debug "API called: CustomObjectsApi#get_data_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
380
|
+
end
|
381
|
+
return data, status_code, headers
|
382
|
+
end
|
383
|
+
end
|
384
|
+
end
|
@@ -53,7 +53,7 @@ module KlaviyoAPI
|
|
53
53
|
# header parameters
|
54
54
|
header_params = opts[:header_params] || {}
|
55
55
|
# klaviyo api revision
|
56
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
56
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
57
57
|
# HTTP header 'Accept' (if needed)
|
58
58
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
59
59
|
# HTTP header 'Content-Type'
|
@@ -53,7 +53,7 @@ module KlaviyoAPI
|
|
53
53
|
# header parameters
|
54
54
|
header_params = opts[:header_params] || {}
|
55
55
|
# klaviyo api revision
|
56
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
56
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
57
57
|
# HTTP header 'Accept' (if needed)
|
58
58
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
59
59
|
# HTTP header 'Content-Type'
|
@@ -126,7 +126,7 @@ module KlaviyoAPI
|
|
126
126
|
# header parameters
|
127
127
|
header_params = opts[:header_params] || {}
|
128
128
|
# klaviyo api revision
|
129
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
129
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
130
130
|
# HTTP header 'Accept' (if needed)
|
131
131
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
132
132
|
# HTTP header 'Content-Type'
|
@@ -168,10 +168,10 @@ module KlaviyoAPI
|
|
168
168
|
# Get an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `events:read`
|
169
169
|
# @param id [String] ID of the event
|
170
170
|
# @param [Hash] opts the optional parameters
|
171
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-
|
172
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-
|
173
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
174
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
171
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
172
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
173
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
174
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
175
175
|
# @return [Hash<String, Object>]
|
176
176
|
def get_event(id, opts = {})
|
177
177
|
data, _status_code, _headers = get_event_with_http_info(id, opts)
|
@@ -182,10 +182,10 @@ module KlaviyoAPI
|
|
182
182
|
# Get an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `events:read`
|
183
183
|
# @param id [String] ID of the event
|
184
184
|
# @param [Hash] opts the optional parameters
|
185
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-
|
186
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-
|
187
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
188
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
185
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
186
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
187
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
188
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
189
189
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
190
190
|
def get_event_with_http_info(id, opts = {})
|
191
191
|
if @api_client.config.debugging
|
@@ -224,7 +224,7 @@ module KlaviyoAPI
|
|
224
224
|
# header parameters
|
225
225
|
header_params = opts[:header_params] || {}
|
226
226
|
# klaviyo api revision
|
227
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
227
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
228
228
|
# HTTP header 'Accept' (if needed)
|
229
229
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
230
230
|
|
@@ -260,13 +260,13 @@ module KlaviyoAPI
|
|
260
260
|
# Get Events
|
261
261
|
# Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` [Custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview) are not supported in the `metric_id` filter. Returns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read`
|
262
262
|
# @param [Hash] opts the optional parameters
|
263
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-
|
264
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-
|
265
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
266
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
267
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
268
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
269
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
263
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
264
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
265
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
266
|
+
# @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>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
267
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
268
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
269
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
270
270
|
# @return [Hash<String, Object>]
|
271
271
|
def get_events(opts = {})
|
272
272
|
data, _status_code, _headers = get_events_with_http_info(opts)
|
@@ -276,13 +276,13 @@ module KlaviyoAPI
|
|
276
276
|
# Get Events
|
277
277
|
# Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` [Custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview) are not supported in the `metric_id` filter. Returns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read`
|
278
278
|
# @param [Hash] opts the optional parameters
|
279
|
-
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-
|
280
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-
|
281
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
282
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
283
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
284
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
285
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
279
|
+
# @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
280
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
281
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
282
|
+
# @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>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
283
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
284
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
285
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
286
286
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
287
287
|
def get_events_with_http_info(opts = {})
|
288
288
|
if @api_client.config.debugging
|
@@ -324,7 +324,7 @@ module KlaviyoAPI
|
|
324
324
|
# header parameters
|
325
325
|
header_params = opts[:header_params] || {}
|
326
326
|
# klaviyo api revision
|
327
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
327
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
328
328
|
# HTTP header 'Accept' (if needed)
|
329
329
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
330
330
|
|
@@ -361,7 +361,7 @@ module KlaviyoAPI
|
|
361
361
|
# Get the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read`
|
362
362
|
# @param id [String] ID of the event
|
363
363
|
# @param [Hash] opts the optional parameters
|
364
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-
|
364
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
365
365
|
# @return [Hash<String, Object>]
|
366
366
|
def get_metric_for_event(id, opts = {})
|
367
367
|
data, _status_code, _headers = get_metric_for_event_with_http_info(id, opts)
|
@@ -375,7 +375,7 @@ module KlaviyoAPI
|
|
375
375
|
# Get the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read`
|
376
376
|
# @param id [String] ID of the event
|
377
377
|
# @param [Hash] opts the optional parameters
|
378
|
-
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-
|
378
|
+
# @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
379
379
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
380
380
|
def get_metric_for_event_with_http_info(id, opts = {})
|
381
381
|
if @api_client.config.debugging
|
@@ -399,7 +399,7 @@ module KlaviyoAPI
|
|
399
399
|
# header parameters
|
400
400
|
header_params = opts[:header_params] || {}
|
401
401
|
# klaviyo api revision
|
402
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
402
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
403
403
|
# HTTP header 'Accept' (if needed)
|
404
404
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
405
405
|
|
@@ -470,7 +470,7 @@ module KlaviyoAPI
|
|
470
470
|
# header parameters
|
471
471
|
header_params = opts[:header_params] || {}
|
472
472
|
# klaviyo api revision
|
473
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
473
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
474
474
|
# HTTP header 'Accept' (if needed)
|
475
475
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
476
476
|
|
@@ -511,7 +511,7 @@ module KlaviyoAPI
|
|
511
511
|
# @param id [String] ID of the event
|
512
512
|
# @param [Hash] opts the optional parameters
|
513
513
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
514
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
514
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
515
515
|
# @return [Hash<String, Object>]
|
516
516
|
def get_profile_for_event(id, opts = {})
|
517
517
|
data, _status_code, _headers = get_profile_for_event_with_http_info(id, opts)
|
@@ -526,7 +526,7 @@ module KlaviyoAPI
|
|
526
526
|
# @param id [String] ID of the event
|
527
527
|
# @param [Hash] opts the optional parameters
|
528
528
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
529
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
529
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
530
530
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
531
531
|
def get_profile_for_event_with_http_info(id, opts = {})
|
532
532
|
if @api_client.config.debugging
|
@@ -555,7 +555,7 @@ module KlaviyoAPI
|
|
555
555
|
# header parameters
|
556
556
|
header_params = opts[:header_params] || {}
|
557
557
|
# klaviyo api revision
|
558
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
558
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
559
559
|
# HTTP header 'Accept' (if needed)
|
560
560
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
561
561
|
|
@@ -626,7 +626,7 @@ module KlaviyoAPI
|
|
626
626
|
# header parameters
|
627
627
|
header_params = opts[:header_params] || {}
|
628
628
|
# klaviyo api revision
|
629
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
629
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
630
630
|
# HTTP header 'Accept' (if needed)
|
631
631
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
632
632
|
|