klaviyo_sdk 1.0.1.20220329 → 1.0.2.20220329
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 +6 -0
- data/README.md +99 -99
- data/docs/Campaign.md +2 -2
- data/docs/CampaignsApi.md +37 -37
- data/docs/CheckMembershipRequest.md +2 -2
- data/docs/DataPrivacyApi.md +5 -5
- data/docs/DeleteEmail.md +2 -2
- data/docs/DeletePerson.md +2 -2
- data/docs/DeletePhone.md +2 -2
- data/docs/DeprecatedGetListResponse.md +2 -2
- data/docs/DeprecatedGetListResponseData.md +2 -2
- data/docs/GlobalExclusionResponseData.md +2 -2
- data/docs/IdentifyPayload.md +2 -2
- data/docs/IdentifyPayloadProperties.md +2 -2
- data/docs/InlineObject.md +2 -2
- data/docs/InlineObject3.md +2 -2
- data/docs/InlineObject4.md +2 -2
- data/docs/InlineObject5.md +2 -2
- data/docs/ListsSegmentsApi.md +71 -71
- data/docs/Metric.md +2 -2
- data/docs/MetricExport.md +2 -2
- data/docs/MetricTimeline.md +2 -2
- data/docs/MetricTimelineData.md +2 -2
- data/docs/MetricsApi.md +17 -17
- data/docs/Person.md +2 -2
- data/docs/PrivacyEmail.md +2 -2
- data/docs/PrivacyId.md +2 -2
- data/docs/PrivacyPhone.md +2 -2
- data/docs/ProfilesApi.md +22 -22
- data/docs/RenderedTemplate.md +2 -2
- data/docs/Template.md +2 -2
- data/docs/TemplatesApi.md +29 -29
- data/docs/TrackIdentifyApi.md +13 -13
- data/docs/TrackPayload.md +2 -2
- data/docs/TrackPayloadCustomerProperties.md +2 -2
- data/docs/TrackPayloadProperties.md +2 -2
- data/klaviyo_sdk.gemspec +1 -1
- data/lib/klaviyo_sdk/api/campaigns_api.rb +1 -1
- data/lib/klaviyo_sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo_sdk/api/lists_segments_api.rb +1 -1
- data/lib/klaviyo_sdk/api/metrics_api.rb +1 -1
- data/lib/klaviyo_sdk/api/profiles_api.rb +1 -1
- data/lib/klaviyo_sdk/api/templates_api.rb +1 -1
- data/lib/klaviyo_sdk/api/track_identify_api.rb +1 -1
- data/lib/klaviyo_sdk/api_client.rb +2 -2
- data/lib/klaviyo_sdk/api_error.rb +1 -1
- data/lib/klaviyo_sdk/configuration.rb +1 -1
- data/lib/klaviyo_sdk/models/campaign.rb +4 -4
- data/lib/klaviyo_sdk/models/check_membership_request.rb +4 -4
- data/lib/klaviyo_sdk/models/delete_email.rb +4 -4
- data/lib/klaviyo_sdk/models/delete_person.rb +4 -4
- data/lib/klaviyo_sdk/models/delete_phone.rb +4 -4
- data/lib/klaviyo_sdk/models/deprecated_get_list_response.rb +4 -4
- data/lib/klaviyo_sdk/models/deprecated_get_list_response_data.rb +4 -4
- data/lib/klaviyo_sdk/models/global_exclusion_response_data.rb +4 -4
- data/lib/klaviyo_sdk/models/identify_payload.rb +4 -4
- data/lib/klaviyo_sdk/models/identify_payload_properties.rb +4 -4
- data/lib/klaviyo_sdk/models/inline_object.rb +4 -4
- data/lib/klaviyo_sdk/models/inline_object3.rb +4 -4
- data/lib/klaviyo_sdk/models/inline_object4.rb +4 -4
- data/lib/klaviyo_sdk/models/inline_object5.rb +4 -4
- data/lib/klaviyo_sdk/models/metric.rb +4 -4
- data/lib/klaviyo_sdk/models/metric_export.rb +4 -4
- data/lib/klaviyo_sdk/models/metric_timeline.rb +4 -4
- data/lib/klaviyo_sdk/models/metric_timeline_data.rb +4 -4
- data/lib/klaviyo_sdk/models/person.rb +4 -4
- data/lib/klaviyo_sdk/models/person.rb.bak +4 -4
- data/lib/klaviyo_sdk/models/privacy_email.rb +4 -4
- data/lib/klaviyo_sdk/models/privacy_id.rb +4 -4
- data/lib/klaviyo_sdk/models/privacy_phone.rb +4 -4
- data/lib/klaviyo_sdk/models/rendered_template.rb +4 -4
- data/lib/klaviyo_sdk/models/template.rb +4 -4
- data/lib/klaviyo_sdk/models/track_payload.rb +4 -4
- data/lib/klaviyo_sdk/models/track_payload_customer_properties.rb +4 -4
- data/lib/klaviyo_sdk/models/track_payload_properties.rb +4 -4
- data/lib/klaviyo_sdk/version.rb +1 -1
- data/lib/klaviyo_sdk.rb +7 -7
- data/spec/api/campaigns_api_spec.rb +3 -3
- data/spec/api/data_privacy_api_spec.rb +3 -3
- data/spec/api/lists_segments_api_spec.rb +3 -3
- data/spec/api/metrics_api_spec.rb +3 -3
- data/spec/api/profiles_api_spec.rb +3 -3
- data/spec/api/templates_api_spec.rb +3 -3
- data/spec/api/track_identify_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +29 -29
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/campaign_spec.rb +4 -4
- data/spec/models/check_membership_request_spec.rb +4 -4
- data/spec/models/delete_email_spec.rb +4 -4
- data/spec/models/delete_person_spec.rb +4 -4
- data/spec/models/delete_phone_spec.rb +4 -4
- data/spec/models/deprecated_get_list_response_data_spec.rb +4 -4
- data/spec/models/deprecated_get_list_response_spec.rb +4 -4
- data/spec/models/global_exclusion_response_data_spec.rb +4 -4
- data/spec/models/identify_payload_properties_spec.rb +4 -4
- data/spec/models/identify_payload_spec.rb +4 -4
- data/spec/models/inline_object3_spec.rb +4 -4
- data/spec/models/inline_object4_spec.rb +4 -4
- data/spec/models/inline_object5_spec.rb +4 -4
- data/spec/models/inline_object_spec.rb +4 -4
- data/spec/models/metric_export_spec.rb +4 -4
- data/spec/models/metric_spec.rb +4 -4
- data/spec/models/metric_timeline_data_spec.rb +4 -4
- data/spec/models/metric_timeline_spec.rb +4 -4
- data/spec/models/person_spec.rb +4 -4
- data/spec/models/privacy_email_spec.rb +4 -4
- data/spec/models/privacy_id_spec.rb +4 -4
- data/spec/models/privacy_phone_spec.rb +4 -4
- data/spec/models/rendered_template_spec.rb +4 -4
- data/spec/models/template_spec.rb +4 -4
- data/spec/models/track_payload_customer_properties_spec.rb +4 -4
- data/spec/models/track_payload_properties_spec.rb +4 -4
- data/spec/models/track_payload_spec.rb +4 -4
- metadata +2 -3
- data/klaviyo_sdk-1.0.0.20220329.gem +0 -0
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version: 1.0.
|
3
|
+
- SDK version: 1.0.2.20220329
|
4
4
|
|
5
5
|
## Helpful Resources
|
6
6
|
|
@@ -60,13 +60,13 @@ gem build klaviyo_sdk.gemspec
|
|
60
60
|
Then install the gem locally:
|
61
61
|
|
62
62
|
```shell
|
63
|
-
gem install ./klaviyo_sdk-1.0.
|
63
|
+
gem install ./klaviyo_sdk-1.0.2.20220329.gem
|
64
64
|
```
|
65
65
|
|
66
66
|
|
67
67
|
Finally add this to the Gemfile:
|
68
68
|
|
69
|
-
gem 'klaviyo_sdk', '~> 1.0.
|
69
|
+
gem 'klaviyo_sdk', '~> 1.0.2.20220329'
|
70
70
|
|
71
71
|
To install directly from rubygems:
|
72
72
|
|
@@ -83,7 +83,7 @@ gem install klaviyo_sdk
|
|
83
83
|
require 'klaviyo_sdk'
|
84
84
|
|
85
85
|
# Setup authorization
|
86
|
-
|
86
|
+
Klaviyo.configure do |config|
|
87
87
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
88
88
|
#config.max_retries = 5 # optional
|
89
89
|
#config.max_delay = 60 # optional
|
@@ -102,7 +102,7 @@ metric_id = 'METRIC_ID'
|
|
102
102
|
count = 100
|
103
103
|
|
104
104
|
begin
|
105
|
-
result =
|
105
|
+
result = Klaviyo::Metrics.metric_export(metric_id, count=count)
|
106
106
|
end
|
107
107
|
```
|
108
108
|
|
@@ -114,8 +114,8 @@ metric_id = 'METRIC_ID'
|
|
114
114
|
count = 100
|
115
115
|
|
116
116
|
begin
|
117
|
-
result =
|
118
|
-
rescue
|
117
|
+
result = Klaviyo::Metrics.metric_export(metric_id, count=count)
|
118
|
+
rescue Klaviyo::ApiError => e
|
119
119
|
puts "Error when calling Metrics.metric_export #{e}"
|
120
120
|
end
|
121
121
|
```
|
@@ -136,14 +136,14 @@ _**NOTE:**_
|
|
136
136
|
#### [Cancel a Campaign](https://developers.klaviyo.com/en/reference/cancel-campaign)
|
137
137
|
|
138
138
|
```ruby
|
139
|
-
|
139
|
+
Klaviyo::Campaigns.cancel_campaign(campaign_id)
|
140
140
|
```
|
141
141
|
|
142
142
|
#### Example:
|
143
143
|
|
144
144
|
```ruby
|
145
145
|
campaign_id = 'CAMPAIGN_ID'
|
146
|
-
response =
|
146
|
+
response = Klaviyo::Campaigns.cancel_campaign(campaign_id)
|
147
147
|
```
|
148
148
|
|
149
149
|
|
@@ -153,7 +153,7 @@ response = Client::Campaigns.cancel_campaign(campaign_id)
|
|
153
153
|
#### [Clone a Campaign](https://developers.klaviyo.com/en/reference/clone-campaign)
|
154
154
|
|
155
155
|
```ruby
|
156
|
-
|
156
|
+
Klaviyo::Campaigns.clone_campaign(campaign_id, name, list_id)
|
157
157
|
```
|
158
158
|
|
159
159
|
#### Example:
|
@@ -162,7 +162,7 @@ campaign_id = 'CAMPAIGN_ID'
|
|
162
162
|
name = 'CLONED_CAMPAIGN'
|
163
163
|
list_id = 'LIST_ID'
|
164
164
|
|
165
|
-
response =
|
165
|
+
response = Klaviyo::Campaigns.clone_campaign(campaign_id, name, list_id)
|
166
166
|
```
|
167
167
|
|
168
168
|
|
@@ -172,7 +172,7 @@ response = Client::Campaigns.clone_campaign(campaign_id, name, list_id)
|
|
172
172
|
#### [Create New Campaign](https://developers.klaviyo.com/en/reference/create-campaign)
|
173
173
|
|
174
174
|
```ruby
|
175
|
-
|
175
|
+
Klaviyo::Campaigns.create_campaign(list_id, template_id, from_email, from_name, subject, opts)
|
176
176
|
```
|
177
177
|
|
178
178
|
#### Example:
|
@@ -189,7 +189,7 @@ opts = {
|
|
189
189
|
'name': 'Campaign Name',
|
190
190
|
}
|
191
191
|
|
192
|
-
response =
|
192
|
+
response = Klaviyo::Campaigns.create_campaign(list_id, template_id, from_email, from_name, subject, opts)
|
193
193
|
```
|
194
194
|
|
195
195
|
|
@@ -198,14 +198,14 @@ response = Client::Campaigns.create_campaign(list_id, template_id, from_email, f
|
|
198
198
|
#### [Get Campaign Info](https://developers.klaviyo.com/en/reference/get-campaign-info)
|
199
199
|
|
200
200
|
```ruby
|
201
|
-
|
201
|
+
Klaviyo::Campaigns.get_campaign_info(campaign_id)
|
202
202
|
```
|
203
203
|
|
204
204
|
#### Example:
|
205
205
|
```ruby
|
206
206
|
campaign_id = 'CAMPAIGN_ID'
|
207
207
|
|
208
|
-
response =
|
208
|
+
response = Klaviyo::Campaigns.get_campaign_info(campaign_id)
|
209
209
|
```
|
210
210
|
|
211
211
|
|
@@ -214,7 +214,7 @@ response = Client::Campaigns.get_campaign_info(campaign_id)
|
|
214
214
|
#### [Get Campaign Recipients](https://developers.klaviyo.com/en/reference/get-campaign-recipients)
|
215
215
|
|
216
216
|
```ruby
|
217
|
-
|
217
|
+
Klaviyo::Campaigns.get_campaign_recipients(campaign_id, opts)
|
218
218
|
```
|
219
219
|
|
220
220
|
#### Example:
|
@@ -228,7 +228,7 @@ opts = {
|
|
228
228
|
# offset: 'offset'
|
229
229
|
}
|
230
230
|
|
231
|
-
response =
|
231
|
+
response = Klaviyo::Campaigns.get_campaign_recipients(campaign_id, opts)
|
232
232
|
```
|
233
233
|
|
234
234
|
|
@@ -237,7 +237,7 @@ response = Client::Campaigns.get_campaign_recipients(campaign_id, opts)
|
|
237
237
|
#### [Get Campaigns](https://developers.klaviyo.com/en/reference/get-campaigns)
|
238
238
|
|
239
239
|
```ruby
|
240
|
-
|
240
|
+
Klaviyo::Campaigns.get_campaigns(opts)
|
241
241
|
```
|
242
242
|
|
243
243
|
#### Example:
|
@@ -247,7 +247,7 @@ opts = {
|
|
247
247
|
'count': 1
|
248
248
|
}
|
249
249
|
|
250
|
-
response =
|
250
|
+
response = Klaviyo::Campaigns.get_campaigns(opts)
|
251
251
|
```
|
252
252
|
|
253
253
|
|
@@ -256,7 +256,7 @@ response = Client::Campaigns.get_campaigns(opts)
|
|
256
256
|
#### [Schedule a Campaign](https://developers.klaviyo.com/en/reference/schedule-campaign)
|
257
257
|
|
258
258
|
```ruby
|
259
|
-
|
259
|
+
Klaviyo::Campaigns.schedule_campaign(campaign_id, send_time)
|
260
260
|
```
|
261
261
|
|
262
262
|
#### Example:
|
@@ -264,7 +264,7 @@ Client::Campaigns.schedule_campaign(campaign_id, send_time)
|
|
264
264
|
campaign_id = 'CAMPAIGN_ID'
|
265
265
|
send_time = '2030-01-13 00:00:00'
|
266
266
|
|
267
|
-
response =
|
267
|
+
response = Klaviyo::Campaigns.schedule_campaign(campaign_id, send_time)
|
268
268
|
```
|
269
269
|
|
270
270
|
|
@@ -273,14 +273,14 @@ response = Client::Campaigns.schedule_campaign(campaign_id, send_time)
|
|
273
273
|
#### [Send a Campaign Immediately](https://developers.klaviyo.com/en/reference/send-campaign)
|
274
274
|
|
275
275
|
```ruby
|
276
|
-
|
276
|
+
Klaviyo::Campaigns.send_campaign(campaign_id)
|
277
277
|
```
|
278
278
|
|
279
279
|
#### Example:
|
280
280
|
```ruby
|
281
281
|
campaign_id = 'CAMPAIGN_ID'
|
282
282
|
|
283
|
-
response =
|
283
|
+
response = Klaviyo::Campaigns.send_campaign(campaign_id)
|
284
284
|
|
285
285
|
```
|
286
286
|
|
@@ -290,7 +290,7 @@ response = Client::Campaigns.send_campaign(campaign_id)
|
|
290
290
|
#### [Update Campaign](https://developers.klaviyo.com/en/reference/update-campaign)
|
291
291
|
|
292
292
|
```ruby
|
293
|
-
|
293
|
+
Klaviyo::Campaigns.update_campaign(campaign_id, opts)
|
294
294
|
```
|
295
295
|
|
296
296
|
#### Example:
|
@@ -308,7 +308,7 @@ opts = {
|
|
308
308
|
'add_google_analytics': false
|
309
309
|
}
|
310
310
|
|
311
|
-
response =
|
311
|
+
response = Klaviyo::Campaigns.update_campaign(campaign_id, opts)
|
312
312
|
|
313
313
|
```
|
314
314
|
|
@@ -322,7 +322,7 @@ response = Client::Campaigns.update_campaign(campaign_id, opts)
|
|
322
322
|
#### [Request a Deletion](https://developers.klaviyo.com/en/reference/request-deletion)
|
323
323
|
|
324
324
|
```ruby
|
325
|
-
|
325
|
+
Klaviyo::DataPrivacy.request_deletion(opts)
|
326
326
|
```
|
327
327
|
|
328
328
|
#### Example:
|
@@ -333,7 +333,7 @@ opts = {
|
|
333
333
|
}
|
334
334
|
}
|
335
335
|
|
336
|
-
response =
|
336
|
+
response = Klaviyo::DataPrivacy.request_deletion(opts)
|
337
337
|
```
|
338
338
|
|
339
339
|
|
@@ -346,7 +346,7 @@ response = Client::DataPrivacy.request_deletion(opts)
|
|
346
346
|
#### [Add Members to a List](https://developers.klaviyo.com/en/reference/add-members)
|
347
347
|
|
348
348
|
```ruby
|
349
|
-
|
349
|
+
Klaviyo::ListsSegments.add_members(list_id, opts)
|
350
350
|
```
|
351
351
|
|
352
352
|
#### Example:
|
@@ -362,7 +362,7 @@ opts = {
|
|
362
362
|
}
|
363
363
|
}
|
364
364
|
|
365
|
-
response =
|
365
|
+
response = Klaviyo::ListsSegments.add_members(list_id, opts)
|
366
366
|
```
|
367
367
|
|
368
368
|
|
@@ -371,14 +371,14 @@ response = Client::ListsSegments.add_members(list_id, opts)
|
|
371
371
|
#### [Create List](https://developers.klaviyo.com/en/reference/create-list)
|
372
372
|
|
373
373
|
```ruby
|
374
|
-
|
374
|
+
Klaviyo::ListsSegments.create_list(list_name)
|
375
375
|
```
|
376
376
|
|
377
377
|
#### Example:
|
378
378
|
```ruby
|
379
379
|
list_name = 'MyNewList'
|
380
380
|
|
381
|
-
response =
|
381
|
+
response = Klaviyo::ListsSegments.create_list(list_name)
|
382
382
|
```
|
383
383
|
|
384
384
|
|
@@ -387,14 +387,14 @@ response = Client::ListsSegments.create_list(list_name)
|
|
387
387
|
#### [Delete List](https://developers.klaviyo.com/en/reference/delete-list)
|
388
388
|
|
389
389
|
```ruby
|
390
|
-
|
390
|
+
Klaviyo::ListsSegments.delete_list(list_id)
|
391
391
|
```
|
392
392
|
|
393
393
|
#### Example:
|
394
394
|
```ruby
|
395
395
|
list_id = 'LIST_ID'
|
396
396
|
|
397
|
-
response =
|
397
|
+
response = Klaviyo::ListsSegments.delete_list(list_id)
|
398
398
|
```
|
399
399
|
|
400
400
|
|
@@ -403,14 +403,14 @@ response = Client::ListsSegments.delete_list(list_id)
|
|
403
403
|
#### [Exclude Profile From All Email](https://developers.klaviyo.com/en/reference/exclude-globally)
|
404
404
|
|
405
405
|
```ruby
|
406
|
-
|
406
|
+
Klaviyo::ListsSegments.exclude_globally(email)
|
407
407
|
```
|
408
408
|
|
409
409
|
#### Example:
|
410
410
|
```ruby
|
411
411
|
email = 'george.washington@klaviyo.com'
|
412
412
|
|
413
|
-
response =
|
413
|
+
response = Klaviyo::ListsSegments.exclude_globally(email)
|
414
414
|
```
|
415
415
|
|
416
416
|
|
@@ -419,7 +419,7 @@ response = Client::ListsSegments.exclude_globally(email)
|
|
419
419
|
#### [Get Global Exclusions & Unsubscribes](https://developers.klaviyo.com/en/reference/get-global-exclusions)
|
420
420
|
|
421
421
|
```ruby
|
422
|
-
|
422
|
+
Klaviyo::ListsSegments.get_global_exclusions(opts)
|
423
423
|
```
|
424
424
|
|
425
425
|
#### Example:
|
@@ -433,7 +433,7 @@ opts = {
|
|
433
433
|
}
|
434
434
|
}
|
435
435
|
|
436
|
-
response =
|
436
|
+
response = Klaviyo::ListsSegments.get_global_exclusions(opts)
|
437
437
|
```
|
438
438
|
|
439
439
|
|
@@ -442,7 +442,7 @@ response = Client::ListsSegments.get_global_exclusions(opts)
|
|
442
442
|
#### [Get All Exclusions for a List](https://developers.klaviyo.com/en/reference/get-list-exclusions)
|
443
443
|
|
444
444
|
```ruby
|
445
|
-
|
445
|
+
Klaviyo::ListsSegments.get_list_exclusions(list_id, opts)
|
446
446
|
```
|
447
447
|
|
448
448
|
#### Example:
|
@@ -455,7 +455,7 @@ opts = {
|
|
455
455
|
}
|
456
456
|
}
|
457
457
|
|
458
|
-
response =
|
458
|
+
response = Klaviyo::ListsSegments.get_list_exclusions(list_id, opts)
|
459
459
|
```
|
460
460
|
|
461
461
|
|
@@ -464,14 +464,14 @@ response = Client::ListsSegments.get_list_exclusions(list_id, opts)
|
|
464
464
|
#### [Get List Info](https://developers.klaviyo.com/en/reference/get-list-info)
|
465
465
|
|
466
466
|
```ruby
|
467
|
-
|
467
|
+
Klaviyo::ListsSegments.get_list_info(list_id)
|
468
468
|
```
|
469
469
|
|
470
470
|
#### Example:
|
471
471
|
```ruby
|
472
472
|
list_id = 'LIST_ID'
|
473
473
|
|
474
|
-
response =
|
474
|
+
response = Klaviyo::ListsSegments.get_list_info(list_id)
|
475
475
|
```
|
476
476
|
|
477
477
|
|
@@ -480,7 +480,7 @@ response = Client::ListsSegments.get_list_info(list_id)
|
|
480
480
|
#### [Check if Profiles Are in a List](https://developers.klaviyo.com/en/reference/get-list-members)
|
481
481
|
|
482
482
|
```ruby
|
483
|
-
|
483
|
+
Klaviyo::ListsSegments.get_list_members(list_id, opts)
|
484
484
|
```
|
485
485
|
|
486
486
|
#### Example:
|
@@ -495,7 +495,7 @@ opts = {
|
|
495
495
|
}
|
496
496
|
}
|
497
497
|
|
498
|
-
response =
|
498
|
+
response = Klaviyo::ListsSegments.get_list_members(list_id, opts)
|
499
499
|
```
|
500
500
|
|
501
501
|
|
@@ -504,7 +504,7 @@ response = Client::ListsSegments.get_list_members(list_id, opts)
|
|
504
504
|
#### [Check if Profiles Are in a List and not Suppressed](https://developers.klaviyo.com/en/reference/get-list-subscriptions)
|
505
505
|
|
506
506
|
```ruby
|
507
|
-
|
507
|
+
Klaviyo::ListsSegments.get_list_subscriptions(list_id, opts)
|
508
508
|
```
|
509
509
|
|
510
510
|
#### Example:
|
@@ -515,7 +515,7 @@ opts = {
|
|
515
515
|
body: {'emails': ['george.washington@klaviyo.com']}
|
516
516
|
}
|
517
517
|
|
518
|
-
response =
|
518
|
+
response = Klaviyo::ListsSegments.get_list_subscriptions(list_id, opts)
|
519
519
|
```
|
520
520
|
|
521
521
|
|
@@ -524,12 +524,12 @@ response = Client::ListsSegments.get_list_subscriptions(list_id, opts)
|
|
524
524
|
#### [Get Lists](https://developers.klaviyo.com/en/reference/get-lists)
|
525
525
|
|
526
526
|
```ruby
|
527
|
-
|
527
|
+
Klaviyo::ListsSegments.get_lists
|
528
528
|
```
|
529
529
|
|
530
530
|
#### Example:
|
531
531
|
```ruby
|
532
|
-
response =
|
532
|
+
response = Klaviyo::ListsSegments.get_lists
|
533
533
|
```
|
534
534
|
|
535
535
|
|
@@ -538,7 +538,7 @@ response = Client::ListsSegments.get_lists
|
|
538
538
|
#### [Get List and Segment Members](https://developers.klaviyo.com/en/reference/get-members)
|
539
539
|
|
540
540
|
```ruby
|
541
|
-
|
541
|
+
Klaviyo::ListsSegments.get_members(list_or_segment_id, opts)
|
542
542
|
```
|
543
543
|
|
544
544
|
#### Example:
|
@@ -550,7 +550,7 @@ opts = {
|
|
550
550
|
# marker: 12345
|
551
551
|
}
|
552
552
|
}
|
553
|
-
response =
|
553
|
+
response = Klaviyo::ListsSegments.get_members(list_id)
|
554
554
|
```
|
555
555
|
|
556
556
|
|
@@ -559,7 +559,7 @@ response = Client::ListsSegments.get_members(list_id)
|
|
559
559
|
#### [Check if Profiles Are in a Segment](https://developers.klaviyo.com/en/reference/get-segment-members)
|
560
560
|
|
561
561
|
```ruby
|
562
|
-
|
562
|
+
Klaviyo::ListsSegments.get_segment_members(segment_id, opts)
|
563
563
|
```
|
564
564
|
|
565
565
|
#### Example:
|
@@ -569,7 +569,7 @@ segment_id = 'SEGMENT_ID'
|
|
569
569
|
opts = {
|
570
570
|
body: {'emails': ['george.washington@klaviyo.com']}
|
571
571
|
}
|
572
|
-
response =
|
572
|
+
response = Klaviyo::ListsSegments.get_segment_members(segment_id, opts)
|
573
573
|
```
|
574
574
|
|
575
575
|
|
@@ -578,7 +578,7 @@ response = Client::ListsSegments.get_segment_members(segment_id, opts)
|
|
578
578
|
#### [Remove Profiles From List](https://developers.klaviyo.com/en/reference/remove-members)
|
579
579
|
|
580
580
|
```ruby
|
581
|
-
|
581
|
+
Klaviyo::ListsSegments.remove_members(list_id, opts)
|
582
582
|
```
|
583
583
|
|
584
584
|
#### Example:
|
@@ -589,7 +589,7 @@ opts = {
|
|
589
589
|
body: {'emails': ['george.washington@klaviyo.com']}
|
590
590
|
}
|
591
591
|
|
592
|
-
response =
|
592
|
+
response = Klaviyo::ListsSegments.remove_members(list_id, opts)
|
593
593
|
```
|
594
594
|
|
595
595
|
|
@@ -598,7 +598,7 @@ response = Client::ListsSegments.remove_members(list_id, opts)
|
|
598
598
|
#### [Subscribe Profiles to List](https://developers.klaviyo.com/en/reference/subscribe)
|
599
599
|
|
600
600
|
```ruby
|
601
|
-
|
601
|
+
Klaviyo::ListsSegments.subscribe(list_id, opts)
|
602
602
|
```
|
603
603
|
|
604
604
|
#### Example:
|
@@ -615,7 +615,7 @@ opts = {
|
|
615
615
|
}
|
616
616
|
}
|
617
617
|
|
618
|
-
response =
|
618
|
+
response = Klaviyo::ListsSegmentsApi.new.subscribe(list_id, opts)
|
619
619
|
```
|
620
620
|
|
621
621
|
|
@@ -624,7 +624,7 @@ response = Client::ListsSegmentsApi.new.subscribe(list_id, opts)
|
|
624
624
|
#### [Unsubscribe Profiles From List](https://developers.klaviyo.com/en/reference/unsubscribe)
|
625
625
|
|
626
626
|
```ruby
|
627
|
-
|
627
|
+
Klaviyo::ListsSegments.unsubscribe(list_id, opts)
|
628
628
|
```
|
629
629
|
|
630
630
|
#### Example:
|
@@ -638,7 +638,7 @@ opts = {
|
|
638
638
|
]
|
639
639
|
}
|
640
640
|
}
|
641
|
-
response =
|
641
|
+
response = Klaviyo::ListsSegments.unsubscribe(list_id, opts)
|
642
642
|
```
|
643
643
|
|
644
644
|
|
@@ -647,7 +647,7 @@ response = Client::ListsSegments.unsubscribe(list_id, opts)
|
|
647
647
|
#### [Update List Name](https://developers.klaviyo.com/en/reference/update-list-name)
|
648
648
|
|
649
649
|
```ruby
|
650
|
-
|
650
|
+
Klaviyo::ListsSegments.update_list_name(list_id, list_name)
|
651
651
|
```
|
652
652
|
|
653
653
|
#### Example:
|
@@ -655,7 +655,7 @@ Client::ListsSegments.update_list_name(list_id, list_name)
|
|
655
655
|
list_id = 'LIST_ID'
|
656
656
|
list_name = 'MyRenamedList'
|
657
657
|
|
658
|
-
response =
|
658
|
+
response = Klaviyo::ListsSegments.update_list_name(list_id, list_name)
|
659
659
|
```
|
660
660
|
|
661
661
|
|
@@ -668,7 +668,7 @@ response = Client::ListsSegments.update_list_name(list_id, list_name)
|
|
668
668
|
#### [Get Metrics Info](https://developers.klaviyo.com/en/reference/get-metrics)
|
669
669
|
|
670
670
|
```ruby
|
671
|
-
|
671
|
+
Klaviyo::Metrics.get_metrics(opts)
|
672
672
|
```
|
673
673
|
|
674
674
|
#### Example:
|
@@ -680,7 +680,7 @@ opts = {
|
|
680
680
|
}
|
681
681
|
}
|
682
682
|
|
683
|
-
response =
|
683
|
+
response = Klaviyo::Metrics.get_metrics(opts)
|
684
684
|
```
|
685
685
|
|
686
686
|
|
@@ -689,7 +689,7 @@ response = Client::Metrics.get_metrics(opts)
|
|
689
689
|
#### [Query Event Data](https://developers.klaviyo.com/en/reference/metric-export)
|
690
690
|
|
691
691
|
```ruby
|
692
|
-
|
692
|
+
Klaviyo::Metrics.metric_export(metric_id, opts)
|
693
693
|
```
|
694
694
|
|
695
695
|
#### Example:
|
@@ -703,7 +703,7 @@ opts = {
|
|
703
703
|
}
|
704
704
|
}
|
705
705
|
|
706
|
-
response =
|
706
|
+
response = Klaviyo::Metrics.metric_export(metric_id, opts)
|
707
707
|
```
|
708
708
|
|
709
709
|
|
@@ -712,7 +712,7 @@ response = Client::Metrics.metric_export(metric_id, opts)
|
|
712
712
|
#### [Get Events for a Specific Metric](https://developers.klaviyo.com/en/reference/metric-timeline)
|
713
713
|
|
714
714
|
```ruby
|
715
|
-
|
715
|
+
Klaviyo::Metrics.metric_timeline(metric_id, opts)
|
716
716
|
```
|
717
717
|
|
718
718
|
#### Example:
|
@@ -727,7 +727,7 @@ opts = {
|
|
727
727
|
}
|
728
728
|
}
|
729
729
|
|
730
|
-
response =
|
730
|
+
response = Klaviyo::Metrics.metric_timeline(metric_id, opts)
|
731
731
|
```
|
732
732
|
|
733
733
|
|
@@ -736,7 +736,7 @@ response = Client::Metrics.metric_timeline(metric_id, opts)
|
|
736
736
|
#### [Get Events for All Metrics](https://developers.klaviyo.com/en/reference/metrics-timeline)
|
737
737
|
|
738
738
|
```ruby
|
739
|
-
|
739
|
+
Klaviyo::Metrics.metrics_timeline(opts)
|
740
740
|
```
|
741
741
|
|
742
742
|
#### Example:
|
@@ -748,7 +748,7 @@ opts = {
|
|
748
748
|
sort: 'asc'
|
749
749
|
}
|
750
750
|
}
|
751
|
-
response =
|
751
|
+
response = Klaviyo::Metrics.metrics_timeline(opts)
|
752
752
|
```
|
753
753
|
|
754
754
|
|
@@ -761,7 +761,7 @@ response = Client::Metrics.metrics_timeline(opts)
|
|
761
761
|
#### [Exchange ID for Profile ID](https://developers.klaviyo.com/en/reference/exchange)
|
762
762
|
|
763
763
|
```ruby
|
764
|
-
|
764
|
+
Klaviyo::Profiles.exchange(opts)
|
765
765
|
```
|
766
766
|
|
767
767
|
#### Example:
|
@@ -770,7 +770,7 @@ opts = {
|
|
770
770
|
body: {'exchange_id': 'EXCHANGE_ID'}
|
771
771
|
}
|
772
772
|
|
773
|
-
response =
|
773
|
+
response = Klaviyo::Profiles.exchange(opts)
|
774
774
|
```
|
775
775
|
|
776
776
|
|
@@ -779,14 +779,14 @@ response = Client::Profiles.exchange(opts)
|
|
779
779
|
#### [Get Profile](https://developers.klaviyo.com/en/reference/get-profile)
|
780
780
|
|
781
781
|
```ruby
|
782
|
-
|
782
|
+
Klaviyo::Profiles.get_profile(person_id)
|
783
783
|
```
|
784
784
|
|
785
785
|
#### Example:
|
786
786
|
```ruby
|
787
787
|
person_id = 'PERSON_ID'
|
788
788
|
|
789
|
-
response =
|
789
|
+
response = Klaviyo::Profiles.get_profile(person_id)
|
790
790
|
```
|
791
791
|
|
792
792
|
|
@@ -795,7 +795,7 @@ response = Client::Profiles.get_profile(person_id)
|
|
795
795
|
#### [Get Profile's Events for a Specific Metric](https://developers.klaviyo.com/en/reference/profile-metric-timeline)
|
796
796
|
|
797
797
|
```ruby
|
798
|
-
|
798
|
+
Klaviyo::Profiles.profile_metric_timeline(person_id, metric_id, opts)
|
799
799
|
```
|
800
800
|
|
801
801
|
#### Example:
|
@@ -811,7 +811,7 @@ opts = {
|
|
811
811
|
}
|
812
812
|
}
|
813
813
|
|
814
|
-
response =
|
814
|
+
response = Klaviyo::Profiles.profile_metric_timeline(person_id, metric_id, opts)
|
815
815
|
```
|
816
816
|
|
817
817
|
|
@@ -820,7 +820,7 @@ response = Client::Profiles.profile_metric_timeline(person_id, metric_id, opts)
|
|
820
820
|
#### [Get Profile's Events for all Metrics](https://developers.klaviyo.com/en/reference/profile-metrics-timeline)
|
821
821
|
|
822
822
|
```ruby
|
823
|
-
|
823
|
+
Klaviyo::Profiles.profile_metrics_timeline(person_id, opts)
|
824
824
|
```
|
825
825
|
|
826
826
|
#### Example:
|
@@ -835,7 +835,7 @@ opts = {
|
|
835
835
|
}
|
836
836
|
}
|
837
837
|
|
838
|
-
response =
|
838
|
+
response = Klaviyo::Profiles.profile_metrics_timeline(person_id, opts)
|
839
839
|
```
|
840
840
|
|
841
841
|
|
@@ -844,7 +844,7 @@ response = Client::Profiles.profile_metrics_timeline(person_id, opts)
|
|
844
844
|
#### [Update Profile](https://developers.klaviyo.com/en/reference/update-profile)
|
845
845
|
|
846
846
|
```ruby
|
847
|
-
|
847
|
+
Klaviyo::Profiles.update_profile(person_id, opts)
|
848
848
|
```
|
849
849
|
|
850
850
|
#### Example:
|
@@ -855,7 +855,7 @@ opts = {
|
|
855
855
|
query_params: {'$email': 'george.washington@klaviyo.com'}
|
856
856
|
}
|
857
857
|
|
858
|
-
response =
|
858
|
+
response = Klaviyo::Profiles.update_profile(person_id, opts)
|
859
859
|
```
|
860
860
|
|
861
861
|
|
@@ -868,7 +868,7 @@ response = Client::Profiles.update_profile(person_id, opts)
|
|
868
868
|
#### [Clone Template](https://developers.klaviyo.com/en/reference/clone-template)
|
869
869
|
|
870
870
|
```ruby
|
871
|
-
|
871
|
+
Klaviyo::Templates.clone_template(template_id, name)
|
872
872
|
```
|
873
873
|
|
874
874
|
#### Example:
|
@@ -876,7 +876,7 @@ Client::Templates.clone_template(template_id, name)
|
|
876
876
|
template_id = 'TEMPLATE_ID'
|
877
877
|
name = 'My Cloned Template'
|
878
878
|
|
879
|
-
response =
|
879
|
+
response = Klaviyo::Templates.clone_template(template_id, name)
|
880
880
|
```
|
881
881
|
|
882
882
|
|
@@ -885,7 +885,7 @@ response = Client::Templates.clone_template(template_id, name)
|
|
885
885
|
#### [Create New Template](https://developers.klaviyo.com/en/reference/create-template)
|
886
886
|
|
887
887
|
```ruby
|
888
|
-
|
888
|
+
Klaviyo::Templates.create_template(name, html)
|
889
889
|
```
|
890
890
|
|
891
891
|
#### Example:
|
@@ -893,7 +893,7 @@ Client::Templates.create_template(name, html)
|
|
893
893
|
name = 'New Template Name'
|
894
894
|
html = '<html><body><p>This is an email for {{ email }}.</p></body></html>'
|
895
895
|
|
896
|
-
response =
|
896
|
+
response = Klaviyo::Templates.create_template(name, html)
|
897
897
|
```
|
898
898
|
|
899
899
|
|
@@ -902,14 +902,14 @@ response = Client::Templates.create_template(name, html)
|
|
902
902
|
#### [Delete Template](https://developers.klaviyo.com/en/reference/delete-template)
|
903
903
|
|
904
904
|
```ruby
|
905
|
-
|
905
|
+
Klaviyo::Templates.delete_template(template_id)
|
906
906
|
```
|
907
907
|
|
908
908
|
#### Example:
|
909
909
|
```ruby
|
910
910
|
template_id = 'TEMPLATE_ID'
|
911
911
|
|
912
|
-
response =
|
912
|
+
response = Klaviyo::Templates.delete_template(template_id)
|
913
913
|
```
|
914
914
|
|
915
915
|
|
@@ -918,12 +918,12 @@ response = Client::Templates.delete_template(template_id)
|
|
918
918
|
#### [Get All Templates](https://developers.klaviyo.com/en/reference/get-templates)
|
919
919
|
|
920
920
|
```ruby
|
921
|
-
|
921
|
+
Klaviyo::Templates.get_templates
|
922
922
|
```
|
923
923
|
|
924
924
|
#### Example:
|
925
925
|
```ruby
|
926
|
-
response =
|
926
|
+
response = Klaviyo::Templates.get_templates
|
927
927
|
```
|
928
928
|
|
929
929
|
|
@@ -932,7 +932,7 @@ response = Client::Templates.get_templates
|
|
932
932
|
#### [Render Template](https://developers.klaviyo.com/en/reference/render-template)
|
933
933
|
|
934
934
|
```ruby
|
935
|
-
|
935
|
+
Klaviyo::Templates.render_template(template_id, opts)
|
936
936
|
```
|
937
937
|
|
938
938
|
#### Example:
|
@@ -946,7 +946,7 @@ opts = {
|
|
946
946
|
}
|
947
947
|
}
|
948
948
|
|
949
|
-
response =
|
949
|
+
response = Klaviyo::Templates.render_template(template_id, opts)
|
950
950
|
```
|
951
951
|
|
952
952
|
|
@@ -955,7 +955,7 @@ response = Client::Templates.render_template(template_id, opts)
|
|
955
955
|
#### [Render and Send Template](https://developers.klaviyo.com/en/reference/send-template)
|
956
956
|
|
957
957
|
```ruby
|
958
|
-
|
958
|
+
Klaviyo::Templates.send_template(template_id, from_email, from_name, subject, to, opts)
|
959
959
|
```
|
960
960
|
|
961
961
|
#### Example:
|
@@ -973,7 +973,7 @@ opts = {
|
|
973
973
|
}
|
974
974
|
}
|
975
975
|
|
976
|
-
response =
|
976
|
+
response = Klaviyo::Templates.send_template(template_id, from_email, from_name, subject, to, opts)
|
977
977
|
```
|
978
978
|
|
979
979
|
|
@@ -982,7 +982,7 @@ response = Client::Templates.send_template(template_id, from_email, from_name, s
|
|
982
982
|
#### [Update Template](https://developers.klaviyo.com/en/reference/update-template)
|
983
983
|
|
984
984
|
```ruby
|
985
|
-
|
985
|
+
Klaviyo::Templates.update_template(template_id, opts)
|
986
986
|
```
|
987
987
|
|
988
988
|
#### Example:
|
@@ -995,7 +995,7 @@ opts = {
|
|
995
995
|
}
|
996
996
|
}
|
997
997
|
|
998
|
-
response =
|
998
|
+
response = Klaviyo::Templates.update_template(template_id, opts)
|
999
999
|
```
|
1000
1000
|
|
1001
1001
|
|
@@ -1008,7 +1008,7 @@ response = Client::Templates.update_template(template_id, opts)
|
|
1008
1008
|
#### [Identify Profile (Legacy)](https://developers.klaviyo.com/en/reference/identify-get)
|
1009
1009
|
|
1010
1010
|
```ruby
|
1011
|
-
|
1011
|
+
Klaviyo::TrackIdentify.identify_get(data)
|
1012
1012
|
```
|
1013
1013
|
|
1014
1014
|
#### Example:
|
@@ -1026,7 +1026,7 @@ identify_payload = {
|
|
1026
1026
|
}
|
1027
1027
|
|
1028
1028
|
encoded_payload = Base64.encode64(identify_payload.to_json).encode(Encoding::UTF_8)
|
1029
|
-
response =
|
1029
|
+
response = Klaviyo::TrackIdentify.identify_get(encoded_payload)
|
1030
1030
|
```
|
1031
1031
|
|
1032
1032
|
|
@@ -1035,7 +1035,7 @@ response = Client::TrackIdentify.identify_get(encoded_payload)
|
|
1035
1035
|
#### [Identify Profile](https://developers.klaviyo.com/en/reference/identify-post)
|
1036
1036
|
|
1037
1037
|
```ruby
|
1038
|
-
|
1038
|
+
Klaviyo::TrackIdentify.identify_post(data)
|
1039
1039
|
```
|
1040
1040
|
|
1041
1041
|
#### Example:
|
@@ -1052,7 +1052,7 @@ identify_payload = {
|
|
1052
1052
|
}
|
1053
1053
|
|
1054
1054
|
data = identify_payload.to_json
|
1055
|
-
response =
|
1055
|
+
response = Klaviyo::TrackIdentify.identify_post(data)
|
1056
1056
|
```
|
1057
1057
|
|
1058
1058
|
|
@@ -1061,7 +1061,7 @@ response = Client::TrackIdentify.identify_post(data)
|
|
1061
1061
|
#### [Track Profile Activity (Legacy)](https://developers.klaviyo.com/en/reference/track-get)
|
1062
1062
|
|
1063
1063
|
```ruby
|
1064
|
-
|
1064
|
+
Klaviyo::TrackIdentify.track_get(data)
|
1065
1065
|
```
|
1066
1066
|
|
1067
1067
|
#### Example:
|
@@ -1080,7 +1080,7 @@ track_payload = {
|
|
1080
1080
|
}
|
1081
1081
|
|
1082
1082
|
encoded_payload = Base64.encode64(track_payload.to_json).encode(Encoding::UTF_8)
|
1083
|
-
response =
|
1083
|
+
response = Klaviyo::TrackIdentify.track_get(encoded_payload)
|
1084
1084
|
```
|
1085
1085
|
|
1086
1086
|
|
@@ -1089,7 +1089,7 @@ response = Client::TrackIdentify.track_get(encoded_payload)
|
|
1089
1089
|
#### [Track Profile Activity](https://developers.klaviyo.com/en/reference/track-post)
|
1090
1090
|
|
1091
1091
|
```ruby
|
1092
|
-
|
1092
|
+
Klaviyo::TrackIdentify.track_post(data)
|
1093
1093
|
```
|
1094
1094
|
|
1095
1095
|
#### Example:
|
@@ -1108,7 +1108,7 @@ track_payload = {
|
|
1108
1108
|
}
|
1109
1109
|
|
1110
1110
|
data = track_payload.to_json
|
1111
|
-
response =
|
1111
|
+
response = Klaviyo::TrackIdentify.track_post(data)
|
1112
1112
|
```
|
1113
1113
|
|
1114
1114
|
|