klaviyo_sdk 1.0.1.20220329 → 1.0.2.20220329
Sign up to get free protection for your applications and to get access to all the features.
- 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/docs/ListsSegmentsApi.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# Klaviyo::ListsSegmentsApi
|
2
2
|
|
3
3
|
All URIs are relative to *https://a.klaviyo.com/api*
|
4
4
|
|
@@ -36,24 +36,24 @@ Adds profiles to a list. This endpoint is functionally equivalent to adding prof
|
|
36
36
|
require 'time'
|
37
37
|
require 'klaviyo_sdk'
|
38
38
|
# setup authorization
|
39
|
-
|
39
|
+
Klaviyo.configure do |config|
|
40
40
|
# Configure API key authorization: ApiKeyAuth
|
41
41
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
42
42
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
43
43
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
44
44
|
end
|
45
45
|
|
46
|
-
api_instance =
|
46
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
47
47
|
list_id = 'LIST_ID' # String |
|
48
48
|
opts = {
|
49
|
-
inline_object4:
|
49
|
+
inline_object4: Klaviyo::InlineObject4.new({profiles: [{"email": "george.washington@klaviyo.com"}, {"phone_number": "+13239169023"}]}) # InlineObject4 |
|
50
50
|
}
|
51
51
|
|
52
52
|
begin
|
53
53
|
# Add Members to a List
|
54
54
|
result = api_instance.add_members(list_id, opts)
|
55
55
|
p result
|
56
|
-
rescue
|
56
|
+
rescue Klaviyo::ApiError => e
|
57
57
|
puts "Error when calling ListsSegmentsApi->add_members: #{e}"
|
58
58
|
end
|
59
59
|
```
|
@@ -71,7 +71,7 @@ begin
|
|
71
71
|
p status_code # => 2xx
|
72
72
|
p headers # => { ... }
|
73
73
|
p data # => Array<Hash<String, Object>>
|
74
|
-
rescue
|
74
|
+
rescue Klaviyo::ApiError => e
|
75
75
|
puts "Error when calling ListsSegmentsApi->add_members_with_http_info: #{e}"
|
76
76
|
end
|
77
77
|
```
|
@@ -111,21 +111,21 @@ Creates a new list.
|
|
111
111
|
require 'time'
|
112
112
|
require 'klaviyo_sdk'
|
113
113
|
# setup authorization
|
114
|
-
|
114
|
+
Klaviyo.configure do |config|
|
115
115
|
# Configure API key authorization: ApiKeyAuth
|
116
116
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
117
117
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
118
118
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
119
119
|
end
|
120
120
|
|
121
|
-
api_instance =
|
121
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
122
122
|
list_name = 'list_name_example' # String |
|
123
123
|
|
124
124
|
begin
|
125
125
|
# Create List
|
126
126
|
result = api_instance.create_list(list_name)
|
127
127
|
p result
|
128
|
-
rescue
|
128
|
+
rescue Klaviyo::ApiError => e
|
129
129
|
puts "Error when calling ListsSegmentsApi->create_list: #{e}"
|
130
130
|
end
|
131
131
|
```
|
@@ -143,7 +143,7 @@ begin
|
|
143
143
|
p status_code # => 2xx
|
144
144
|
p headers # => { ... }
|
145
145
|
p data # => Hash<String, Object>
|
146
|
-
rescue
|
146
|
+
rescue Klaviyo::ApiError => e
|
147
147
|
puts "Error when calling ListsSegmentsApi->create_list_with_http_info: #{e}"
|
148
148
|
end
|
149
149
|
```
|
@@ -182,20 +182,20 @@ Deletes a list from an account. This is a destructive operation and cannot be un
|
|
182
182
|
require 'time'
|
183
183
|
require 'klaviyo_sdk'
|
184
184
|
# setup authorization
|
185
|
-
|
185
|
+
Klaviyo.configure do |config|
|
186
186
|
# Configure API key authorization: ApiKeyAuth
|
187
187
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
188
188
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
189
189
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
190
190
|
end
|
191
191
|
|
192
|
-
api_instance =
|
192
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
193
193
|
list_id = 'LIST_ID' # String |
|
194
194
|
|
195
195
|
begin
|
196
196
|
# Delete List
|
197
197
|
api_instance.delete_list(list_id)
|
198
|
-
rescue
|
198
|
+
rescue Klaviyo::ApiError => e
|
199
199
|
puts "Error when calling ListsSegmentsApi->delete_list: #{e}"
|
200
200
|
end
|
201
201
|
```
|
@@ -213,7 +213,7 @@ begin
|
|
213
213
|
p status_code # => 2xx
|
214
214
|
p headers # => { ... }
|
215
215
|
p data # => nil
|
216
|
-
rescue
|
216
|
+
rescue Klaviyo::ApiError => e
|
217
217
|
puts "Error when calling ListsSegmentsApi->delete_list_with_http_info: #{e}"
|
218
218
|
end
|
219
219
|
```
|
@@ -252,21 +252,21 @@ Marks a person as excluded from all email. This works the same way as manually e
|
|
252
252
|
require 'time'
|
253
253
|
require 'klaviyo_sdk'
|
254
254
|
# setup authorization
|
255
|
-
|
255
|
+
Klaviyo.configure do |config|
|
256
256
|
# Configure API key authorization: ApiKeyAuth
|
257
257
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
258
258
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
259
259
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
260
260
|
end
|
261
261
|
|
262
|
-
api_instance =
|
262
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
263
263
|
email = 'email_example' # String |
|
264
264
|
|
265
265
|
begin
|
266
266
|
# Exclude Profile From All Email
|
267
267
|
result = api_instance.exclude_globally(email)
|
268
268
|
p result
|
269
|
-
rescue
|
269
|
+
rescue Klaviyo::ApiError => e
|
270
270
|
puts "Error when calling ListsSegmentsApi->exclude_globally: #{e}"
|
271
271
|
end
|
272
272
|
```
|
@@ -284,7 +284,7 @@ begin
|
|
284
284
|
p status_code # => 2xx
|
285
285
|
p headers # => { ... }
|
286
286
|
p data # => Hash<String, Object>
|
287
|
-
rescue
|
287
|
+
rescue Klaviyo::ApiError => e
|
288
288
|
puts "Error when calling ListsSegmentsApi->exclude_globally_with_http_info: #{e}"
|
289
289
|
end
|
290
290
|
```
|
@@ -323,14 +323,14 @@ Returns global exclusions/unsubscribes. Global exclusions are distinct from list
|
|
323
323
|
require 'time'
|
324
324
|
require 'klaviyo_sdk'
|
325
325
|
# setup authorization
|
326
|
-
|
326
|
+
Klaviyo.configure do |config|
|
327
327
|
# Configure API key authorization: ApiKeyAuth
|
328
328
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
329
329
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
330
330
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
331
331
|
end
|
332
332
|
|
333
|
-
api_instance =
|
333
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
334
334
|
opts = {
|
335
335
|
reason: 'reason_example', # String | Filter results based on the reason for someone being excluded. The possible values are `unsubscribed`, `bounced`, `invalid_email`, `reported_spam` and `manually_excluded`. Only a single value may be specified at a time. Defaults to return all profiles regardless of reason.
|
336
336
|
sort: 'asc', # String | Sort order to apply to results, either ascending or descending. Valid values are `asc` or `desc`. Defaults to `asc`.
|
@@ -342,7 +342,7 @@ begin
|
|
342
342
|
# Get Global Exclusions & Unsubscribes
|
343
343
|
result = api_instance.get_global_exclusions(opts)
|
344
344
|
p result
|
345
|
-
rescue
|
345
|
+
rescue Klaviyo::ApiError => e
|
346
346
|
puts "Error when calling ListsSegmentsApi->get_global_exclusions: #{e}"
|
347
347
|
end
|
348
348
|
```
|
@@ -360,7 +360,7 @@ begin
|
|
360
360
|
p status_code # => 2xx
|
361
361
|
p headers # => { ... }
|
362
362
|
p data # => <GlobalExclusionResponseData>
|
363
|
-
rescue
|
363
|
+
rescue Klaviyo::ApiError => e
|
364
364
|
puts "Error when calling ListsSegmentsApi->get_global_exclusions_with_http_info: #{e}"
|
365
365
|
end
|
366
366
|
```
|
@@ -402,14 +402,14 @@ Gets all of the emails and phone numbers that have been excluded from a list alo
|
|
402
402
|
require 'time'
|
403
403
|
require 'klaviyo_sdk'
|
404
404
|
# setup authorization
|
405
|
-
|
405
|
+
Klaviyo.configure do |config|
|
406
406
|
# Configure API key authorization: ApiKeyAuth
|
407
407
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
408
408
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
409
409
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
410
410
|
end
|
411
411
|
|
412
|
-
api_instance =
|
412
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
413
413
|
list_id = 'LIST_ID' # String |
|
414
414
|
opts = {
|
415
415
|
marker: 123456 # Integer | A marker value returned by a previous GET call. Use this to grab the next batch of records.
|
@@ -419,7 +419,7 @@ begin
|
|
419
419
|
# Get All Exclusions for a List
|
420
420
|
result = api_instance.get_list_exclusions(list_id, opts)
|
421
421
|
p result
|
422
|
-
rescue
|
422
|
+
rescue Klaviyo::ApiError => e
|
423
423
|
puts "Error when calling ListsSegmentsApi->get_list_exclusions: #{e}"
|
424
424
|
end
|
425
425
|
```
|
@@ -437,7 +437,7 @@ begin
|
|
437
437
|
p status_code # => 2xx
|
438
438
|
p headers # => { ... }
|
439
439
|
p data # => Hash<String, Object>
|
440
|
-
rescue
|
440
|
+
rescue Klaviyo::ApiError => e
|
441
441
|
puts "Error when calling ListsSegmentsApi->get_list_exclusions_with_http_info: #{e}"
|
442
442
|
end
|
443
443
|
```
|
@@ -477,21 +477,21 @@ Returns information about a list.
|
|
477
477
|
require 'time'
|
478
478
|
require 'klaviyo_sdk'
|
479
479
|
# setup authorization
|
480
|
-
|
480
|
+
Klaviyo.configure do |config|
|
481
481
|
# Configure API key authorization: ApiKeyAuth
|
482
482
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
483
483
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
484
484
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
485
485
|
end
|
486
486
|
|
487
|
-
api_instance =
|
487
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
488
488
|
list_id = 'LIST_ID' # String |
|
489
489
|
|
490
490
|
begin
|
491
491
|
# Get List Info
|
492
492
|
result = api_instance.get_list_info(list_id)
|
493
493
|
p result
|
494
|
-
rescue
|
494
|
+
rescue Klaviyo::ApiError => e
|
495
495
|
puts "Error when calling ListsSegmentsApi->get_list_info: #{e}"
|
496
496
|
end
|
497
497
|
```
|
@@ -509,7 +509,7 @@ begin
|
|
509
509
|
p status_code # => 2xx
|
510
510
|
p headers # => { ... }
|
511
511
|
p data # => Hash<String, Object>
|
512
|
-
rescue
|
512
|
+
rescue Klaviyo::ApiError => e
|
513
513
|
puts "Error when calling ListsSegmentsApi->get_list_info_with_http_info: #{e}"
|
514
514
|
end
|
515
515
|
```
|
@@ -548,24 +548,24 @@ Checks if one or more emails, phone numbers, or push tokens are in a given list.
|
|
548
548
|
require 'time'
|
549
549
|
require 'klaviyo_sdk'
|
550
550
|
# setup authorization
|
551
|
-
|
551
|
+
Klaviyo.configure do |config|
|
552
552
|
# Configure API key authorization: ApiKeyAuth
|
553
553
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
554
554
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
555
555
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
556
556
|
end
|
557
557
|
|
558
|
-
api_instance =
|
558
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
559
559
|
list_id = 'LIST_ID' # String |
|
560
560
|
opts = {
|
561
|
-
check_membership_request:
|
561
|
+
check_membership_request: Klaviyo::CheckMembershipRequest.new # CheckMembershipRequest |
|
562
562
|
}
|
563
563
|
|
564
564
|
begin
|
565
565
|
# Check if Profiles Are in a List
|
566
566
|
result = api_instance.get_list_members(list_id, opts)
|
567
567
|
p result
|
568
|
-
rescue
|
568
|
+
rescue Klaviyo::ApiError => e
|
569
569
|
puts "Error when calling ListsSegmentsApi->get_list_members: #{e}"
|
570
570
|
end
|
571
571
|
```
|
@@ -583,7 +583,7 @@ begin
|
|
583
583
|
p status_code # => 2xx
|
584
584
|
p headers # => { ... }
|
585
585
|
p data # => Array<Hash<String, Object>>
|
586
|
-
rescue
|
586
|
+
rescue Klaviyo::ApiError => e
|
587
587
|
puts "Error when calling ListsSegmentsApi->get_list_members_with_http_info: #{e}"
|
588
588
|
end
|
589
589
|
```
|
@@ -623,24 +623,24 @@ Checks if one or more emails are in a given list and not suppressed. No distinct
|
|
623
623
|
require 'time'
|
624
624
|
require 'klaviyo_sdk'
|
625
625
|
# setup authorization
|
626
|
-
|
626
|
+
Klaviyo.configure do |config|
|
627
627
|
# Configure API key authorization: ApiKeyAuth
|
628
628
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
629
629
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
630
630
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
631
631
|
end
|
632
632
|
|
633
|
-
api_instance =
|
633
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
634
634
|
list_id = 'LIST_ID' # String |
|
635
635
|
opts = {
|
636
|
-
check_membership_request:
|
636
|
+
check_membership_request: Klaviyo::CheckMembershipRequest.new # CheckMembershipRequest |
|
637
637
|
}
|
638
638
|
|
639
639
|
begin
|
640
640
|
# Check if Profiles Are in a List and not Suppressed
|
641
641
|
result = api_instance.get_list_subscriptions(list_id, opts)
|
642
642
|
p result
|
643
|
-
rescue
|
643
|
+
rescue Klaviyo::ApiError => e
|
644
644
|
puts "Error when calling ListsSegmentsApi->get_list_subscriptions: #{e}"
|
645
645
|
end
|
646
646
|
```
|
@@ -658,7 +658,7 @@ begin
|
|
658
658
|
p status_code # => 2xx
|
659
659
|
p headers # => { ... }
|
660
660
|
p data # => Array<Hash<String, Object>>
|
661
|
-
rescue
|
661
|
+
rescue Klaviyo::ApiError => e
|
662
662
|
puts "Error when calling ListsSegmentsApi->get_list_subscriptions_with_http_info: #{e}"
|
663
663
|
end
|
664
664
|
```
|
@@ -698,20 +698,20 @@ Returns a listing of all of the lists in an account.
|
|
698
698
|
require 'time'
|
699
699
|
require 'klaviyo_sdk'
|
700
700
|
# setup authorization
|
701
|
-
|
701
|
+
Klaviyo.configure do |config|
|
702
702
|
# Configure API key authorization: ApiKeyAuth
|
703
703
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
704
704
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
705
705
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
706
706
|
end
|
707
707
|
|
708
|
-
api_instance =
|
708
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
709
709
|
|
710
710
|
begin
|
711
711
|
# Get Lists
|
712
712
|
result = api_instance.get_lists
|
713
713
|
p result
|
714
|
-
rescue
|
714
|
+
rescue Klaviyo::ApiError => e
|
715
715
|
puts "Error when calling ListsSegmentsApi->get_lists: #{e}"
|
716
716
|
end
|
717
717
|
```
|
@@ -729,7 +729,7 @@ begin
|
|
729
729
|
p status_code # => 2xx
|
730
730
|
p headers # => { ... }
|
731
731
|
p data # => Array<Hash<String, Object>>
|
732
|
-
rescue
|
732
|
+
rescue Klaviyo::ApiError => e
|
733
733
|
puts "Error when calling ListsSegmentsApi->get_lists_with_http_info: #{e}"
|
734
734
|
end
|
735
735
|
```
|
@@ -766,14 +766,14 @@ Gets all of the emails, phone numbers, and push tokens for profiles in a given l
|
|
766
766
|
require 'time'
|
767
767
|
require 'klaviyo_sdk'
|
768
768
|
# setup authorization
|
769
|
-
|
769
|
+
Klaviyo.configure do |config|
|
770
770
|
# Configure API key authorization: ApiKeyAuth
|
771
771
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
772
772
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
773
773
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
774
774
|
end
|
775
775
|
|
776
|
-
api_instance =
|
776
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
777
777
|
list_or_segment_id = 'LIST_OR_SEGMENT_ID' # String |
|
778
778
|
opts = {
|
779
779
|
marker: 123456 # Integer | A marker value returned by a previous GET call. Use this to grab the next batch of records.
|
@@ -783,7 +783,7 @@ begin
|
|
783
783
|
# Get List and Segment Members
|
784
784
|
result = api_instance.get_members(list_or_segment_id, opts)
|
785
785
|
p result
|
786
|
-
rescue
|
786
|
+
rescue Klaviyo::ApiError => e
|
787
787
|
puts "Error when calling ListsSegmentsApi->get_members: #{e}"
|
788
788
|
end
|
789
789
|
```
|
@@ -801,7 +801,7 @@ begin
|
|
801
801
|
p status_code # => 2xx
|
802
802
|
p headers # => { ... }
|
803
803
|
p data # => Hash<String, Object>
|
804
|
-
rescue
|
804
|
+
rescue Klaviyo::ApiError => e
|
805
805
|
puts "Error when calling ListsSegmentsApi->get_members_with_http_info: #{e}"
|
806
806
|
end
|
807
807
|
```
|
@@ -841,24 +841,24 @@ Checks if one or more emails, phone numbers, or push tokens are in a given segme
|
|
841
841
|
require 'time'
|
842
842
|
require 'klaviyo_sdk'
|
843
843
|
# setup authorization
|
844
|
-
|
844
|
+
Klaviyo.configure do |config|
|
845
845
|
# Configure API key authorization: ApiKeyAuth
|
846
846
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
847
847
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
848
848
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
849
849
|
end
|
850
850
|
|
851
|
-
api_instance =
|
851
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
852
852
|
segment_id = 'SEGMENT_ID' # String |
|
853
853
|
opts = {
|
854
|
-
check_membership_request:
|
854
|
+
check_membership_request: Klaviyo::CheckMembershipRequest.new # CheckMembershipRequest |
|
855
855
|
}
|
856
856
|
|
857
857
|
begin
|
858
858
|
# Check if Profiles Are in a Segment
|
859
859
|
result = api_instance.get_segment_members(segment_id, opts)
|
860
860
|
p result
|
861
|
-
rescue
|
861
|
+
rescue Klaviyo::ApiError => e
|
862
862
|
puts "Error when calling ListsSegmentsApi->get_segment_members: #{e}"
|
863
863
|
end
|
864
864
|
```
|
@@ -876,7 +876,7 @@ begin
|
|
876
876
|
p status_code # => 2xx
|
877
877
|
p headers # => { ... }
|
878
878
|
p data # => Array<Hash<String, Object>>
|
879
|
-
rescue
|
879
|
+
rescue Klaviyo::ApiError => e
|
880
880
|
puts "Error when calling ListsSegmentsApi->get_segment_members_with_http_info: #{e}"
|
881
881
|
end
|
882
882
|
```
|
@@ -916,23 +916,23 @@ Removes profiles from a list.
|
|
916
916
|
require 'time'
|
917
917
|
require 'klaviyo_sdk'
|
918
918
|
# setup authorization
|
919
|
-
|
919
|
+
Klaviyo.configure do |config|
|
920
920
|
# Configure API key authorization: ApiKeyAuth
|
921
921
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
922
922
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
923
923
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
924
924
|
end
|
925
925
|
|
926
|
-
api_instance =
|
926
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
927
927
|
list_id = 'LIST_ID' # String |
|
928
928
|
opts = {
|
929
|
-
inline_object5:
|
929
|
+
inline_object5: Klaviyo::InlineObject5.new # InlineObject5 |
|
930
930
|
}
|
931
931
|
|
932
932
|
begin
|
933
933
|
# Remove Profiles From List
|
934
934
|
api_instance.remove_members(list_id, opts)
|
935
|
-
rescue
|
935
|
+
rescue Klaviyo::ApiError => e
|
936
936
|
puts "Error when calling ListsSegmentsApi->remove_members: #{e}"
|
937
937
|
end
|
938
938
|
```
|
@@ -950,7 +950,7 @@ begin
|
|
950
950
|
p status_code # => 2xx
|
951
951
|
p headers # => { ... }
|
952
952
|
p data # => nil
|
953
|
-
rescue
|
953
|
+
rescue Klaviyo::ApiError => e
|
954
954
|
puts "Error when calling ListsSegmentsApi->remove_members_with_http_info: #{e}"
|
955
955
|
end
|
956
956
|
```
|
@@ -990,24 +990,24 @@ Subscribes profiles to a list. Profiles will be single or double opted into the
|
|
990
990
|
require 'time'
|
991
991
|
require 'klaviyo_sdk'
|
992
992
|
# setup authorization
|
993
|
-
|
993
|
+
Klaviyo.configure do |config|
|
994
994
|
# Configure API key authorization: ApiKeyAuth
|
995
995
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
996
996
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
997
997
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
998
998
|
end
|
999
999
|
|
1000
|
-
api_instance =
|
1000
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
1001
1001
|
list_id = 'LIST_ID' # String |
|
1002
1002
|
opts = {
|
1003
|
-
inline_object3:
|
1003
|
+
inline_object3: Klaviyo::InlineObject3.new({profiles: [{"email": "george.washington@klaviyo.com"}, {"phone_number": "+13239169023", "sms_consent": true}]}) # InlineObject3 |
|
1004
1004
|
}
|
1005
1005
|
|
1006
1006
|
begin
|
1007
1007
|
# Subscribe Profiles to List
|
1008
1008
|
result = api_instance.subscribe(list_id, opts)
|
1009
1009
|
p result
|
1010
|
-
rescue
|
1010
|
+
rescue Klaviyo::ApiError => e
|
1011
1011
|
puts "Error when calling ListsSegmentsApi->subscribe: #{e}"
|
1012
1012
|
end
|
1013
1013
|
```
|
@@ -1025,7 +1025,7 @@ begin
|
|
1025
1025
|
p status_code # => 2xx
|
1026
1026
|
p headers # => { ... }
|
1027
1027
|
p data # => Array<Object>
|
1028
|
-
rescue
|
1028
|
+
rescue Klaviyo::ApiError => e
|
1029
1029
|
puts "Error when calling ListsSegmentsApi->subscribe_with_http_info: #{e}"
|
1030
1030
|
end
|
1031
1031
|
```
|
@@ -1065,14 +1065,14 @@ Unsubscribes and removes profiles from a list.
|
|
1065
1065
|
require 'time'
|
1066
1066
|
require 'klaviyo_sdk'
|
1067
1067
|
# setup authorization
|
1068
|
-
|
1068
|
+
Klaviyo.configure do |config|
|
1069
1069
|
# Configure API key authorization: ApiKeyAuth
|
1070
1070
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
1071
1071
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1072
1072
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
1073
1073
|
end
|
1074
1074
|
|
1075
|
-
api_instance =
|
1075
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
1076
1076
|
list_id = 'LIST_ID' # String |
|
1077
1077
|
opts = {
|
1078
1078
|
request_body: { key: 3.56} # Hash<String, Object> | Unsubscribe and remove profiles from a list.
|
@@ -1081,7 +1081,7 @@ opts = {
|
|
1081
1081
|
begin
|
1082
1082
|
# Unsubscribe Profiles From List
|
1083
1083
|
api_instance.unsubscribe(list_id, opts)
|
1084
|
-
rescue
|
1084
|
+
rescue Klaviyo::ApiError => e
|
1085
1085
|
puts "Error when calling ListsSegmentsApi->unsubscribe: #{e}"
|
1086
1086
|
end
|
1087
1087
|
```
|
@@ -1099,7 +1099,7 @@ begin
|
|
1099
1099
|
p status_code # => 2xx
|
1100
1100
|
p headers # => { ... }
|
1101
1101
|
p data # => nil
|
1102
|
-
rescue
|
1102
|
+
rescue Klaviyo::ApiError => e
|
1103
1103
|
puts "Error when calling ListsSegmentsApi->unsubscribe_with_http_info: #{e}"
|
1104
1104
|
end
|
1105
1105
|
```
|
@@ -1139,21 +1139,21 @@ Updates a list's name.
|
|
1139
1139
|
require 'time'
|
1140
1140
|
require 'klaviyo_sdk'
|
1141
1141
|
# setup authorization
|
1142
|
-
|
1142
|
+
Klaviyo.configure do |config|
|
1143
1143
|
# Configure API key authorization: ApiKeyAuth
|
1144
1144
|
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
|
1145
1145
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1146
1146
|
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
|
1147
1147
|
end
|
1148
1148
|
|
1149
|
-
api_instance =
|
1149
|
+
api_instance = Klaviyo::ListsSegmentsApi.new
|
1150
1150
|
list_id = 'LIST_ID' # String |
|
1151
1151
|
list_name = 'list_name_example' # String |
|
1152
1152
|
|
1153
1153
|
begin
|
1154
1154
|
# Update List Name
|
1155
1155
|
api_instance.update_list_name(list_id, list_name)
|
1156
|
-
rescue
|
1156
|
+
rescue Klaviyo::ApiError => e
|
1157
1157
|
puts "Error when calling ListsSegmentsApi->update_list_name: #{e}"
|
1158
1158
|
end
|
1159
1159
|
```
|
@@ -1171,7 +1171,7 @@ begin
|
|
1171
1171
|
p status_code # => 2xx
|
1172
1172
|
p headers # => { ... }
|
1173
1173
|
p data # => nil
|
1174
|
-
rescue
|
1174
|
+
rescue Klaviyo::ApiError => e
|
1175
1175
|
puts "Error when calling ListsSegmentsApi->update_list_name_with_http_info: #{e}"
|
1176
1176
|
end
|
1177
1177
|
```
|
data/docs/Metric.md
CHANGED
data/docs/MetricExport.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# Klaviyo::MetricExport
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -18,7 +18,7 @@
|
|
18
18
|
```ruby
|
19
19
|
require 'klaviyo_sdk'
|
20
20
|
|
21
|
-
instance =
|
21
|
+
instance = Klaviyo::MetricExport.new(
|
22
22
|
metric: null,
|
23
23
|
start_date: null,
|
24
24
|
end_date: null,
|
data/docs/MetricTimeline.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# Klaviyo::MetricTimeline
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -14,7 +14,7 @@
|
|
14
14
|
```ruby
|
15
15
|
require 'klaviyo_sdk'
|
16
16
|
|
17
|
-
instance =
|
17
|
+
instance = Klaviyo::MetricTimeline.new(
|
18
18
|
object: null,
|
19
19
|
count: null,
|
20
20
|
data: null,
|
data/docs/MetricTimelineData.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# Klaviyo::MetricTimelineData
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -19,7 +19,7 @@
|
|
19
19
|
```ruby
|
20
20
|
require 'klaviyo_sdk'
|
21
21
|
|
22
|
-
instance =
|
22
|
+
instance = Klaviyo::MetricTimelineData.new(
|
23
23
|
object: null,
|
24
24
|
id: null,
|
25
25
|
statistic_id: null,
|