klaviyo-api-sdk 8.0.0 → 9.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +260 -0
- data/README.md +269 -3
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +174 -0
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +20 -2
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +6 -0
- data/lib/klaviyo-api-sdk/api/events_api.rb +7 -1
- data/lib/klaviyo-api-sdk/api/forms_api.rb +24 -0
- data/lib/klaviyo-api-sdk/api/images_api.rb +12 -0
- data/lib/klaviyo-api-sdk/api/lists_api.rb +13 -1
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +8 -2
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +87 -3
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +18 -0
- data/lib/klaviyo-api-sdk/api/segments_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/tags_api.rb +24 -0
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- metadata +7 -7
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version:
|
3
|
+
- SDK version: 9.0.0
|
4
4
|
- API revision: 2024-07-15
|
5
5
|
|
6
6
|
## Helpful Resources
|
@@ -102,13 +102,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
102
102
|
Then install the gem locally:
|
103
103
|
|
104
104
|
```shell
|
105
|
-
gem install ./klaviyo-api-sdk-
|
105
|
+
gem install ./klaviyo-api-sdk-9.0.0.gem
|
106
106
|
```
|
107
107
|
|
108
108
|
|
109
109
|
Finally add this to the Gemfile:
|
110
110
|
|
111
|
-
gem 'klaviyo-api-sdk', '~>
|
111
|
+
gem 'klaviyo-api-sdk', '~> 9.0.0'
|
112
112
|
|
113
113
|
To install directly from rubygems:
|
114
114
|
|
@@ -116,6 +116,16 @@ To install directly from rubygems:
|
|
116
116
|
gem install klaviyo-api-sdk
|
117
117
|
```
|
118
118
|
|
119
|
+
### For macOS developers
|
120
|
+
|
121
|
+
To avoid compatability issues between macOS and the underlying HTTP client library (Typhoeus), add the following to your local bash file:
|
122
|
+
|
123
|
+
```
|
124
|
+
export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
|
125
|
+
```
|
126
|
+
|
127
|
+
As the issue only affects macOS, it should not affect your production environment. Check [this thread](https://github.com/rails/rails/issues/38560) for more information.
|
128
|
+
|
119
129
|
## Usage Example
|
120
130
|
|
121
131
|
### To load the gem
|
@@ -773,6 +783,10 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
773
783
|
```ruby
|
774
784
|
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
775
785
|
```
|
786
|
+
##### Method alias:
|
787
|
+
```ruby
|
788
|
+
KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body)
|
789
|
+
```
|
776
790
|
|
777
791
|
|
778
792
|
|
@@ -793,6 +807,10 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
793
807
|
```ruby
|
794
808
|
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
795
809
|
```
|
810
|
+
##### Method alias:
|
811
|
+
```ruby
|
812
|
+
KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body)
|
813
|
+
```
|
796
814
|
|
797
815
|
|
798
816
|
|
@@ -973,6 +991,10 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
973
991
|
```ruby
|
974
992
|
KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
975
993
|
```
|
994
|
+
##### Method alias:
|
995
|
+
```ruby
|
996
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts)
|
997
|
+
```
|
976
998
|
|
977
999
|
|
978
1000
|
|
@@ -983,6 +1005,10 @@ KlaviyoAPI::Catalogs.get_create_categories_job(job_id, opts)
|
|
983
1005
|
```ruby
|
984
1006
|
KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
985
1007
|
```
|
1008
|
+
##### Method alias:
|
1009
|
+
```ruby
|
1010
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts)
|
1011
|
+
```
|
986
1012
|
|
987
1013
|
|
988
1014
|
|
@@ -993,6 +1019,10 @@ KlaviyoAPI::Catalogs.get_create_categories_jobs(opts)
|
|
993
1019
|
```ruby
|
994
1020
|
KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
995
1021
|
```
|
1022
|
+
##### Method alias:
|
1023
|
+
```ruby
|
1024
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts)
|
1025
|
+
```
|
996
1026
|
|
997
1027
|
|
998
1028
|
|
@@ -1003,6 +1033,10 @@ KlaviyoAPI::Catalogs.get_create_items_job(job_id, opts)
|
|
1003
1033
|
```ruby
|
1004
1034
|
KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
1005
1035
|
```
|
1036
|
+
##### Method alias:
|
1037
|
+
```ruby
|
1038
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts)
|
1039
|
+
```
|
1006
1040
|
|
1007
1041
|
|
1008
1042
|
|
@@ -1013,6 +1047,10 @@ KlaviyoAPI::Catalogs.get_create_items_jobs(opts)
|
|
1013
1047
|
```ruby
|
1014
1048
|
KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
1015
1049
|
```
|
1050
|
+
##### Method alias:
|
1051
|
+
```ruby
|
1052
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts)
|
1053
|
+
```
|
1016
1054
|
|
1017
1055
|
|
1018
1056
|
|
@@ -1023,6 +1061,10 @@ KlaviyoAPI::Catalogs.get_create_variants_job(job_id, opts)
|
|
1023
1061
|
```ruby
|
1024
1062
|
KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
1025
1063
|
```
|
1064
|
+
##### Method alias:
|
1065
|
+
```ruby
|
1066
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts)
|
1067
|
+
```
|
1026
1068
|
|
1027
1069
|
|
1028
1070
|
|
@@ -1033,6 +1075,10 @@ KlaviyoAPI::Catalogs.get_create_variants_jobs(opts)
|
|
1033
1075
|
```ruby
|
1034
1076
|
KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
1035
1077
|
```
|
1078
|
+
##### Method alias:
|
1079
|
+
```ruby
|
1080
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts)
|
1081
|
+
```
|
1036
1082
|
|
1037
1083
|
|
1038
1084
|
|
@@ -1043,6 +1089,10 @@ KlaviyoAPI::Catalogs.get_delete_categories_job(job_id, opts)
|
|
1043
1089
|
```ruby
|
1044
1090
|
KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
1045
1091
|
```
|
1092
|
+
##### Method alias:
|
1093
|
+
```ruby
|
1094
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts)
|
1095
|
+
```
|
1046
1096
|
|
1047
1097
|
|
1048
1098
|
|
@@ -1053,6 +1103,10 @@ KlaviyoAPI::Catalogs.get_delete_categories_jobs(opts)
|
|
1053
1103
|
```ruby
|
1054
1104
|
KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
1055
1105
|
```
|
1106
|
+
##### Method alias:
|
1107
|
+
```ruby
|
1108
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts)
|
1109
|
+
```
|
1056
1110
|
|
1057
1111
|
|
1058
1112
|
|
@@ -1063,6 +1117,10 @@ KlaviyoAPI::Catalogs.get_delete_items_job(job_id, opts)
|
|
1063
1117
|
```ruby
|
1064
1118
|
KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
1065
1119
|
```
|
1120
|
+
##### Method alias:
|
1121
|
+
```ruby
|
1122
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts)
|
1123
|
+
```
|
1066
1124
|
|
1067
1125
|
|
1068
1126
|
|
@@ -1073,6 +1131,10 @@ KlaviyoAPI::Catalogs.get_delete_items_jobs(opts)
|
|
1073
1131
|
```ruby
|
1074
1132
|
KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
1075
1133
|
```
|
1134
|
+
##### Method alias:
|
1135
|
+
```ruby
|
1136
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts)
|
1137
|
+
```
|
1076
1138
|
|
1077
1139
|
|
1078
1140
|
|
@@ -1083,6 +1145,10 @@ KlaviyoAPI::Catalogs.get_delete_variants_job(job_id, opts)
|
|
1083
1145
|
```ruby
|
1084
1146
|
KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
1085
1147
|
```
|
1148
|
+
##### Method alias:
|
1149
|
+
```ruby
|
1150
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts)
|
1151
|
+
```
|
1086
1152
|
|
1087
1153
|
|
1088
1154
|
|
@@ -1093,6 +1159,10 @@ KlaviyoAPI::Catalogs.get_delete_variants_jobs(opts)
|
|
1093
1159
|
```ruby
|
1094
1160
|
KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
1095
1161
|
```
|
1162
|
+
##### Method alias:
|
1163
|
+
```ruby
|
1164
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts)
|
1165
|
+
```
|
1096
1166
|
|
1097
1167
|
|
1098
1168
|
|
@@ -1103,6 +1173,10 @@ KlaviyoAPI::Catalogs.get_update_categories_job(job_id, opts)
|
|
1103
1173
|
```ruby
|
1104
1174
|
KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
1105
1175
|
```
|
1176
|
+
##### Method alias:
|
1177
|
+
```ruby
|
1178
|
+
KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts)
|
1179
|
+
```
|
1106
1180
|
|
1107
1181
|
|
1108
1182
|
|
@@ -1113,6 +1187,10 @@ KlaviyoAPI::Catalogs.get_update_categories_jobs(opts)
|
|
1113
1187
|
```ruby
|
1114
1188
|
KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
1115
1189
|
```
|
1190
|
+
##### Method alias:
|
1191
|
+
```ruby
|
1192
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts)
|
1193
|
+
```
|
1116
1194
|
|
1117
1195
|
|
1118
1196
|
|
@@ -1123,6 +1201,10 @@ KlaviyoAPI::Catalogs.get_update_items_job(job_id, opts)
|
|
1123
1201
|
```ruby
|
1124
1202
|
KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
1125
1203
|
```
|
1204
|
+
##### Method alias:
|
1205
|
+
```ruby
|
1206
|
+
KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts)
|
1207
|
+
```
|
1126
1208
|
|
1127
1209
|
|
1128
1210
|
|
@@ -1133,6 +1215,10 @@ KlaviyoAPI::Catalogs.get_update_items_jobs(opts)
|
|
1133
1215
|
```ruby
|
1134
1216
|
KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
1135
1217
|
```
|
1218
|
+
##### Method alias:
|
1219
|
+
```ruby
|
1220
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts)
|
1221
|
+
```
|
1136
1222
|
|
1137
1223
|
|
1138
1224
|
|
@@ -1143,6 +1229,10 @@ KlaviyoAPI::Catalogs.get_update_variants_job(job_id, opts)
|
|
1143
1229
|
```ruby
|
1144
1230
|
KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
1145
1231
|
```
|
1232
|
+
##### Method alias:
|
1233
|
+
```ruby
|
1234
|
+
KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts)
|
1235
|
+
```
|
1146
1236
|
|
1147
1237
|
|
1148
1238
|
|
@@ -1153,6 +1243,10 @@ KlaviyoAPI::Catalogs.get_update_variants_jobs(opts)
|
|
1153
1243
|
```ruby
|
1154
1244
|
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
1155
1245
|
```
|
1246
|
+
##### Method alias:
|
1247
|
+
```ruby
|
1248
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body)
|
1249
|
+
```
|
1156
1250
|
|
1157
1251
|
|
1158
1252
|
|
@@ -1163,6 +1257,10 @@ KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
|
1163
1257
|
```ruby
|
1164
1258
|
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
1165
1259
|
```
|
1260
|
+
##### Method alias:
|
1261
|
+
```ruby
|
1262
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body)
|
1263
|
+
```
|
1166
1264
|
|
1167
1265
|
|
1168
1266
|
|
@@ -1173,6 +1271,10 @@ KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
|
1173
1271
|
```ruby
|
1174
1272
|
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
1175
1273
|
```
|
1274
|
+
##### Method alias:
|
1275
|
+
```ruby
|
1276
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body)
|
1277
|
+
```
|
1176
1278
|
|
1177
1279
|
|
1178
1280
|
|
@@ -1183,6 +1285,10 @@ KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
|
1183
1285
|
```ruby
|
1184
1286
|
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
1185
1287
|
```
|
1288
|
+
##### Method alias:
|
1289
|
+
```ruby
|
1290
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body)
|
1291
|
+
```
|
1186
1292
|
|
1187
1293
|
|
1188
1294
|
|
@@ -1193,6 +1299,10 @@ KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
|
1193
1299
|
```ruby
|
1194
1300
|
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
1195
1301
|
```
|
1302
|
+
##### Method alias:
|
1303
|
+
```ruby
|
1304
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body)
|
1305
|
+
```
|
1196
1306
|
|
1197
1307
|
|
1198
1308
|
|
@@ -1203,6 +1313,10 @@ KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
|
1203
1313
|
```ruby
|
1204
1314
|
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
1205
1315
|
```
|
1316
|
+
##### Method alias:
|
1317
|
+
```ruby
|
1318
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body)
|
1319
|
+
```
|
1206
1320
|
|
1207
1321
|
|
1208
1322
|
|
@@ -1213,6 +1327,10 @@ KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
|
1213
1327
|
```ruby
|
1214
1328
|
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
1215
1329
|
```
|
1330
|
+
##### Method alias:
|
1331
|
+
```ruby
|
1332
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body)
|
1333
|
+
```
|
1216
1334
|
|
1217
1335
|
|
1218
1336
|
|
@@ -1223,6 +1341,10 @@ KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
|
1223
1341
|
```ruby
|
1224
1342
|
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
1225
1343
|
```
|
1344
|
+
##### Method alias:
|
1345
|
+
```ruby
|
1346
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body)
|
1347
|
+
```
|
1226
1348
|
|
1227
1349
|
|
1228
1350
|
|
@@ -1233,6 +1355,10 @@ KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
|
1233
1355
|
```ruby
|
1234
1356
|
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
1235
1357
|
```
|
1358
|
+
##### Method alias:
|
1359
|
+
```ruby
|
1360
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body)
|
1361
|
+
```
|
1236
1362
|
|
1237
1363
|
|
1238
1364
|
|
@@ -1397,6 +1523,10 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts)
|
|
1397
1523
|
```ruby
|
1398
1524
|
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
1399
1525
|
```
|
1526
|
+
##### Method alias:
|
1527
|
+
```ruby
|
1528
|
+
KlaviyoAPI::Coupons.get_coupon_coupon_codes(id, opts)
|
1529
|
+
```
|
1400
1530
|
|
1401
1531
|
|
1402
1532
|
|
@@ -1407,6 +1537,10 @@ KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
|
1407
1537
|
```ruby
|
1408
1538
|
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
|
1409
1539
|
```
|
1540
|
+
##### Method alias:
|
1541
|
+
```ruby
|
1542
|
+
KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts)
|
1543
|
+
```
|
1410
1544
|
|
1411
1545
|
|
1412
1546
|
|
@@ -1437,6 +1571,10 @@ KlaviyoAPI::Coupons.get_coupons(opts)
|
|
1437
1571
|
```ruby
|
1438
1572
|
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
|
1439
1573
|
```
|
1574
|
+
##### Method alias:
|
1575
|
+
```ruby
|
1576
|
+
KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body)
|
1577
|
+
```
|
1440
1578
|
|
1441
1579
|
|
1442
1580
|
|
@@ -1471,6 +1609,10 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body)
|
|
1471
1609
|
```ruby
|
1472
1610
|
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
1473
1611
|
```
|
1612
|
+
##### Method alias:
|
1613
|
+
```ruby
|
1614
|
+
KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body)
|
1615
|
+
```
|
1474
1616
|
|
1475
1617
|
|
1476
1618
|
|
@@ -1485,6 +1627,10 @@ KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
|
1485
1627
|
```ruby
|
1486
1628
|
KlaviyoAPI::Events.bulk_create_events(body)
|
1487
1629
|
```
|
1630
|
+
##### Method alias:
|
1631
|
+
```ruby
|
1632
|
+
KlaviyoAPI::Events.create_event_bulk_create_job(body)
|
1633
|
+
```
|
1488
1634
|
|
1489
1635
|
|
1490
1636
|
|
@@ -1763,6 +1909,10 @@ KlaviyoAPI::Forms.get_form(id, opts)
|
|
1763
1909
|
```ruby
|
1764
1910
|
KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
|
1765
1911
|
```
|
1912
|
+
##### Method alias:
|
1913
|
+
```ruby
|
1914
|
+
KlaviyoAPI::Forms.get_form_version_form(id, opts)
|
1915
|
+
```
|
1766
1916
|
|
1767
1917
|
|
1768
1918
|
|
@@ -1773,6 +1923,10 @@ KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
|
|
1773
1923
|
```ruby
|
1774
1924
|
KlaviyoAPI::Forms.get_form_id_for_form_version(id)
|
1775
1925
|
```
|
1926
|
+
##### Method alias:
|
1927
|
+
```ruby
|
1928
|
+
KlaviyoAPI::Forms.get_form_version_relationships_form(id)
|
1929
|
+
```
|
1776
1930
|
|
1777
1931
|
|
1778
1932
|
|
@@ -1803,6 +1957,10 @@ KlaviyoAPI::Forms.get_forms(opts)
|
|
1803
1957
|
```ruby
|
1804
1958
|
KlaviyoAPI::Forms.get_version_ids_for_form(id)
|
1805
1959
|
```
|
1960
|
+
##### Method alias:
|
1961
|
+
```ruby
|
1962
|
+
KlaviyoAPI::Forms.get_form_relationships_form_versions(id)
|
1963
|
+
```
|
1806
1964
|
|
1807
1965
|
|
1808
1966
|
|
@@ -1813,6 +1971,10 @@ KlaviyoAPI::Forms.get_version_ids_for_form(id)
|
|
1813
1971
|
```ruby
|
1814
1972
|
KlaviyoAPI::Forms.get_versions_for_form(id, opts)
|
1815
1973
|
```
|
1974
|
+
##### Method alias:
|
1975
|
+
```ruby
|
1976
|
+
KlaviyoAPI::Forms.get_form_form_versions(id, opts)
|
1977
|
+
```
|
1816
1978
|
|
1817
1979
|
|
1818
1980
|
|
@@ -1857,6 +2019,10 @@ KlaviyoAPI::Images.update_image(id, body)
|
|
1857
2019
|
```ruby
|
1858
2020
|
KlaviyoAPI::Images.upload_image_from_file(file, opts)
|
1859
2021
|
```
|
2022
|
+
##### Method alias:
|
2023
|
+
```ruby
|
2024
|
+
KlaviyoAPI::Images.create_image_upload(file, opts)
|
2025
|
+
```
|
1860
2026
|
|
1861
2027
|
|
1862
2028
|
|
@@ -1867,6 +2033,10 @@ KlaviyoAPI::Images.upload_image_from_file(file, opts)
|
|
1867
2033
|
```ruby
|
1868
2034
|
KlaviyoAPI::Images.upload_image_from_url(body)
|
1869
2035
|
```
|
2036
|
+
##### Method alias:
|
2037
|
+
```ruby
|
2038
|
+
KlaviyoAPI::Images.create_image(body)
|
2039
|
+
```
|
1870
2040
|
|
1871
2041
|
|
1872
2042
|
|
@@ -1891,6 +2061,10 @@ KlaviyoAPI::Lists.create_list(body)
|
|
1891
2061
|
```ruby
|
1892
2062
|
KlaviyoAPI::Lists.create_list_relationships(id, body)
|
1893
2063
|
```
|
2064
|
+
##### Method alias:
|
2065
|
+
```ruby
|
2066
|
+
KlaviyoAPI::Lists.create_list_relationships_profile(id, body)
|
2067
|
+
```
|
1894
2068
|
|
1895
2069
|
|
1896
2070
|
|
@@ -1911,6 +2085,10 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
1911
2085
|
```ruby
|
1912
2086
|
KlaviyoAPI::Lists.delete_list_relationships(id, body)
|
1913
2087
|
```
|
2088
|
+
##### Method alias:
|
2089
|
+
```ruby
|
2090
|
+
KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
|
2091
|
+
```
|
1914
2092
|
|
1915
2093
|
|
1916
2094
|
|
@@ -2015,6 +2193,10 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
2015
2193
|
```ruby
|
2016
2194
|
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
2017
2195
|
```
|
2196
|
+
##### Method alias:
|
2197
|
+
```ruby
|
2198
|
+
KlaviyoAPI::Metrics.create_metric_aggregate(body)
|
2199
|
+
```
|
2018
2200
|
|
2019
2201
|
|
2020
2202
|
|
@@ -2029,6 +2211,10 @@ KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
2029
2211
|
```ruby
|
2030
2212
|
KlaviyoAPI::Profiles.create_or_update_profile(body)
|
2031
2213
|
```
|
2214
|
+
##### Method alias:
|
2215
|
+
```ruby
|
2216
|
+
KlaviyoAPI::Profiles.create_profile_import(body)
|
2217
|
+
```
|
2032
2218
|
|
2033
2219
|
|
2034
2220
|
|
@@ -2059,6 +2245,10 @@ KlaviyoAPI::Profiles.create_push_token(body)
|
|
2059
2245
|
```ruby
|
2060
2246
|
KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
|
2061
2247
|
```
|
2248
|
+
##### Method alias:
|
2249
|
+
```ruby
|
2250
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts)
|
2251
|
+
```
|
2062
2252
|
|
2063
2253
|
|
2064
2254
|
|
@@ -2069,6 +2259,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job(job_id, opts)
|
|
2069
2259
|
```ruby
|
2070
2260
|
KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
|
2071
2261
|
```
|
2262
|
+
##### Method alias:
|
2263
|
+
```ruby
|
2264
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
|
2265
|
+
```
|
2072
2266
|
|
2073
2267
|
|
2074
2268
|
|
@@ -2079,6 +2273,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
|
|
2079
2273
|
```ruby
|
2080
2274
|
KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
|
2081
2275
|
```
|
2276
|
+
##### Method alias:
|
2277
|
+
```ruby
|
2278
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
|
2279
|
+
```
|
2082
2280
|
|
2083
2281
|
|
2084
2282
|
|
@@ -2089,6 +2287,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
|
|
2089
2287
|
```ruby
|
2090
2288
|
KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
|
2091
2289
|
```
|
2290
|
+
##### Method alias:
|
2291
|
+
```ruby
|
2292
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts)
|
2293
|
+
```
|
2092
2294
|
|
2093
2295
|
|
2094
2296
|
|
@@ -2099,6 +2301,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
|
|
2099
2301
|
```ruby
|
2100
2302
|
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
|
2101
2303
|
```
|
2304
|
+
##### Method alias:
|
2305
|
+
```ruby
|
2306
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
|
2307
|
+
```
|
2102
2308
|
|
2103
2309
|
|
2104
2310
|
|
@@ -2109,6 +2315,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
|
|
2109
2315
|
```ruby
|
2110
2316
|
KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts)
|
2111
2317
|
```
|
2318
|
+
##### Method alias:
|
2319
|
+
```ruby
|
2320
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_profiles(id, opts)
|
2321
|
+
```
|
2112
2322
|
|
2113
2323
|
|
2114
2324
|
|
@@ -2119,6 +2329,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts
|
|
2119
2329
|
```ruby
|
2120
2330
|
KlaviyoAPI::Profiles.get_bulk_profile_import_jobs(opts)
|
2121
2331
|
```
|
2332
|
+
##### Method alias:
|
2333
|
+
```ruby
|
2334
|
+
KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts)
|
2335
|
+
```
|
2122
2336
|
|
2123
2337
|
|
2124
2338
|
|
@@ -2189,6 +2403,10 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
2189
2403
|
```ruby
|
2190
2404
|
KlaviyoAPI::Profiles.merge_profiles(body)
|
2191
2405
|
```
|
2406
|
+
##### Method alias:
|
2407
|
+
```ruby
|
2408
|
+
KlaviyoAPI::Profiles.create_profile_merge(body)
|
2409
|
+
```
|
2192
2410
|
|
2193
2411
|
|
2194
2412
|
|
@@ -2199,6 +2417,10 @@ KlaviyoAPI::Profiles.merge_profiles(body)
|
|
2199
2417
|
```ruby
|
2200
2418
|
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
2201
2419
|
```
|
2420
|
+
##### Method alias:
|
2421
|
+
```ruby
|
2422
|
+
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
2423
|
+
```
|
2202
2424
|
|
2203
2425
|
|
2204
2426
|
|
@@ -2209,6 +2431,10 @@ KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
|
2209
2431
|
```ruby
|
2210
2432
|
KlaviyoAPI::Profiles.subscribe_profiles(body)
|
2211
2433
|
```
|
2434
|
+
##### Method alias:
|
2435
|
+
```ruby
|
2436
|
+
KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body)
|
2437
|
+
```
|
2212
2438
|
|
2213
2439
|
|
2214
2440
|
|
@@ -2219,6 +2445,10 @@ KlaviyoAPI::Profiles.subscribe_profiles(body)
|
|
2219
2445
|
```ruby
|
2220
2446
|
KlaviyoAPI::Profiles.suppress_profiles(body)
|
2221
2447
|
```
|
2448
|
+
##### Method alias:
|
2449
|
+
```ruby
|
2450
|
+
KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body)
|
2451
|
+
```
|
2222
2452
|
|
2223
2453
|
|
2224
2454
|
|
@@ -2229,6 +2459,10 @@ KlaviyoAPI::Profiles.suppress_profiles(body)
|
|
2229
2459
|
```ruby
|
2230
2460
|
KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
2231
2461
|
```
|
2462
|
+
##### Method alias:
|
2463
|
+
```ruby
|
2464
|
+
KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body)
|
2465
|
+
```
|
2232
2466
|
|
2233
2467
|
|
2234
2468
|
|
@@ -2239,6 +2473,10 @@ KlaviyoAPI::Profiles.unsubscribe_profiles(body)
|
|
2239
2473
|
```ruby
|
2240
2474
|
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
2241
2475
|
```
|
2476
|
+
##### Method alias:
|
2477
|
+
```ruby
|
2478
|
+
KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body)
|
2479
|
+
```
|
2242
2480
|
|
2243
2481
|
|
2244
2482
|
|
@@ -2263,6 +2501,10 @@ KlaviyoAPI::Profiles.update_profile(id, body)
|
|
2263
2501
|
```ruby
|
2264
2502
|
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
2265
2503
|
```
|
2504
|
+
##### Method alias:
|
2505
|
+
```ruby
|
2506
|
+
KlaviyoAPI::Reporting.create_campaign_value_report(body, opts)
|
2507
|
+
```
|
2266
2508
|
|
2267
2509
|
|
2268
2510
|
|
@@ -2273,6 +2515,10 @@ KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
|
2273
2515
|
```ruby
|
2274
2516
|
KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
2275
2517
|
```
|
2518
|
+
##### Method alias:
|
2519
|
+
```ruby
|
2520
|
+
KlaviyoAPI::Reporting.create_flow_sery_report(body, opts)
|
2521
|
+
```
|
2276
2522
|
|
2277
2523
|
|
2278
2524
|
|
@@ -2283,6 +2529,10 @@ KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
|
2283
2529
|
```ruby
|
2284
2530
|
KlaviyoAPI::Reporting.query_flow_values(body, opts)
|
2285
2531
|
```
|
2532
|
+
##### Method alias:
|
2533
|
+
```ruby
|
2534
|
+
KlaviyoAPI::Reporting.create_flow_value_report(body, opts)
|
2535
|
+
```
|
2286
2536
|
|
2287
2537
|
|
2288
2538
|
|
@@ -2411,6 +2661,10 @@ KlaviyoAPI::Tags.create_tag_group(body)
|
|
2411
2661
|
```ruby
|
2412
2662
|
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
2413
2663
|
```
|
2664
|
+
##### Method alias:
|
2665
|
+
```ruby
|
2666
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body)
|
2667
|
+
```
|
2414
2668
|
|
2415
2669
|
|
2416
2670
|
|
@@ -2421,6 +2675,10 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
|
2421
2675
|
```ruby
|
2422
2676
|
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
2423
2677
|
```
|
2678
|
+
##### Method alias:
|
2679
|
+
```ruby
|
2680
|
+
KlaviyoAPI::Tags.create_tag_relationships_flow(id, body)
|
2681
|
+
```
|
2424
2682
|
|
2425
2683
|
|
2426
2684
|
|
@@ -2431,6 +2689,10 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
|
2431
2689
|
```ruby
|
2432
2690
|
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
2433
2691
|
```
|
2692
|
+
##### Method alias:
|
2693
|
+
```ruby
|
2694
|
+
KlaviyoAPI::Tags.create_tag_relationships_list(id, body)
|
2695
|
+
```
|
2434
2696
|
|
2435
2697
|
|
2436
2698
|
|
@@ -2441,6 +2703,10 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
|
2441
2703
|
```ruby
|
2442
2704
|
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
2443
2705
|
```
|
2706
|
+
##### Method alias:
|
2707
|
+
```ruby
|
2708
|
+
KlaviyoAPI::Tags.create_tag_relationships_segment(id, body)
|
2709
|
+
```
|
2444
2710
|
|
2445
2711
|
|
2446
2712
|
|
data/klaviyo-api-sdk.gemspec
CHANGED
@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
|
|
17
17
|
|
18
18
|
Gem::Specification.new do |s|
|
19
19
|
s.name = "klaviyo-api-sdk"
|
20
|
-
s.version = "
|
20
|
+
s.version = "9.0.0"
|
21
21
|
s.authors = ['Klaviyo Team']
|
22
22
|
s.email = ['libraries@klaviyo.com']
|
23
23
|
s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
|