@iterable/cli 0.3.4 → 0.3.5
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.
- package/COMMANDS.md +90 -22
- package/package.json +2 -2
package/COMMANDS.md
CHANGED
|
@@ -1268,17 +1268,28 @@ iterable templates update-email <templateId>
|
|
|
1268
1268
|
| Option | Type | Required | Description |
|
|
1269
1269
|
|--------|------|----------|-------------|
|
|
1270
1270
|
| `templateId` | number | **yes** | Template ID to update |
|
|
1271
|
+
| `--bccEmails` | string[] | no | BCC emails |
|
|
1272
|
+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
|
|
1271
1273
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1272
1274
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1275
|
+
| `--ccEmails` | string[] | no | CC emails |
|
|
1273
1276
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1274
|
-
| `--
|
|
1277
|
+
| `--dataFeedId` | number | no | [Deprecated - use dataFeedIds instead] ID for data feed used in template rendering |
|
|
1278
|
+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
|
|
1279
|
+
| `--fromEmail` | string | no | From email (must be an authorized sender) |
|
|
1275
1280
|
| `--fromName` | string | no | From name |
|
|
1276
|
-
| `--
|
|
1281
|
+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
|
|
1282
|
+
| `--html` | string | no | HTML contents |
|
|
1283
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1284
|
+
| `--linkParams` | json[] | no | Parameters to append to each URL in html contents |
|
|
1277
1285
|
| `--locale` | string | no | Template locale |
|
|
1286
|
+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
|
|
1278
1287
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1279
1288
|
| `--name` | string | no | Template name |
|
|
1280
|
-
| `--plainText` | string | no | Plain text
|
|
1281
|
-
| `--
|
|
1289
|
+
| `--plainText` | string | no | Plain text contents |
|
|
1290
|
+
| `--preheaderText` | string | no | Preheader text |
|
|
1291
|
+
| `--replyToEmail` | string | no | Reply to email |
|
|
1292
|
+
| `--subject` | string | no | Subject |
|
|
1282
1293
|
|
|
1283
1294
|
### update-inapp
|
|
1284
1295
|
|
|
@@ -1294,10 +1305,17 @@ iterable templates update-inapp <templateId>
|
|
|
1294
1305
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1295
1306
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1296
1307
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1297
|
-
| `--
|
|
1308
|
+
| `--expirationDateTime` | string | no | The in-app message's absolute expiration time. Format is YYYY-MM-DD HH:MM:SS (UTC timestamp, time zones not allowed) |
|
|
1309
|
+
| `--expirationDuration` | string | no | The in-app message's expiration time, relative to its send time. Should be an expression such as now+90d |
|
|
1310
|
+
| `--html` | string | no | Html of the in-app notification |
|
|
1311
|
+
| `--inAppDisplaySettings` | json | no | Display settings |
|
|
1312
|
+
| `--inboxMetadata` | json | no | Title, subtitle, and thumbnail |
|
|
1313
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1298
1314
|
| `--locale` | string | no | Template locale |
|
|
1299
1315
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1300
1316
|
| `--name` | string | no | Template name |
|
|
1317
|
+
| `--payload` | json | no | Payload |
|
|
1318
|
+
| `--webInAppDisplaySettings` | json | no | Web In-app Display settings |
|
|
1301
1319
|
|
|
1302
1320
|
### update-push
|
|
1303
1321
|
|
|
@@ -1310,17 +1328,28 @@ iterable templates update-push <templateId>
|
|
|
1310
1328
|
| Option | Type | Required | Description |
|
|
1311
1329
|
|--------|------|----------|-------------|
|
|
1312
1330
|
| `templateId` | number | **yes** | Template ID to update |
|
|
1313
|
-
| `--badge` |
|
|
1331
|
+
| `--badge` | string | no | Badge to set for push notification |
|
|
1332
|
+
| `--buttons` | json[] | no | Array of buttons that appear to respond to the push. Max of 3 |
|
|
1333
|
+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
|
|
1314
1334
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1315
1335
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1316
1336
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1337
|
+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
|
|
1338
|
+
| `--deeplink` | json | no | Deep Link. A mapping that accepts two optional properties: 'ios' & 'android' and their respective deep link values |
|
|
1339
|
+
| `--interruptionLevel` | `passive` \| `active` \| `time-sensitive` \| `critical` | no | An interruption level helps iOS determine when to alert a user about the arrival of a push notification |
|
|
1340
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1341
|
+
| `--isSilentPush` | boolean | no | Whether or not this is a silent push notification template |
|
|
1317
1342
|
| `--locale` | string | no | Template locale |
|
|
1318
|
-
| `--
|
|
1343
|
+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
|
|
1344
|
+
| `--message` | string | no | Push message |
|
|
1319
1345
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1320
1346
|
| `--name` | string | no | Template name |
|
|
1321
|
-
| `--payload` | json | no |
|
|
1322
|
-
| `--
|
|
1323
|
-
| `--
|
|
1347
|
+
| `--payload` | json | no | Payload to send with push notification |
|
|
1348
|
+
| `--relevanceScore` | number | no | Relevance score for iOS notifications on iOS 15+. Number is clamped between 0 and 1.0 |
|
|
1349
|
+
| `--richMedia` | json | no | Rich Media URL. A mapping that accepts two optional properties: 'ios' & 'android' and their respective rich media url values |
|
|
1350
|
+
| `--sound` | string | no | Sound |
|
|
1351
|
+
| `--title` | string | no | Push message title |
|
|
1352
|
+
| `--wake` | boolean | no | Set the content-available flag on iOS notifications, which will wake the app in the background |
|
|
1324
1353
|
|
|
1325
1354
|
### update-sms
|
|
1326
1355
|
|
|
@@ -1336,10 +1365,15 @@ iterable templates update-sms <templateId>
|
|
|
1336
1365
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1337
1366
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1338
1367
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1368
|
+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
|
|
1369
|
+
| `--imageUrl` | string | no | Image URL |
|
|
1370
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1371
|
+
| `--linkParams` | json[] | no | Parameters to append to each URL in contents |
|
|
1339
1372
|
| `--locale` | string | no | Template locale |
|
|
1340
|
-
| `--message` | string | no | SMS message
|
|
1373
|
+
| `--message` | string | no | SMS message |
|
|
1341
1374
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1342
1375
|
| `--name` | string | no | Template name |
|
|
1376
|
+
| `--trackingDomain` | string | no | Tracking Domain |
|
|
1343
1377
|
|
|
1344
1378
|
### upsert-email
|
|
1345
1379
|
|
|
@@ -1352,17 +1386,28 @@ iterable templates upsert-email <clientTemplateId>
|
|
|
1352
1386
|
| Option | Type | Required | Description |
|
|
1353
1387
|
|--------|------|----------|-------------|
|
|
1354
1388
|
| `clientTemplateId` | string | **yes** | Client template ID |
|
|
1389
|
+
| `--bccEmails` | string[] | no | BCC emails |
|
|
1390
|
+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
|
|
1355
1391
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1356
1392
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1393
|
+
| `--ccEmails` | string[] | no | CC emails |
|
|
1357
1394
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1358
|
-
| `--
|
|
1395
|
+
| `--dataFeedId` | number | no | [Deprecated - use dataFeedIds instead] ID for data feed used in template rendering |
|
|
1396
|
+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
|
|
1397
|
+
| `--fromEmail` | string | no | From email (must be an authorized sender) |
|
|
1359
1398
|
| `--fromName` | string | no | From name |
|
|
1360
|
-
| `--
|
|
1399
|
+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
|
|
1400
|
+
| `--html` | string | no | HTML contents |
|
|
1401
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1402
|
+
| `--linkParams` | json[] | no | Parameters to append to each URL in html contents |
|
|
1361
1403
|
| `--locale` | string | no | Template locale |
|
|
1404
|
+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
|
|
1362
1405
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1363
1406
|
| `--name` | string | no | Template name |
|
|
1364
|
-
| `--plainText` | string | no | Plain text
|
|
1365
|
-
| `--
|
|
1407
|
+
| `--plainText` | string | no | Plain text contents |
|
|
1408
|
+
| `--preheaderText` | string | no | Preheader text |
|
|
1409
|
+
| `--replyToEmail` | string | no | Reply to email |
|
|
1410
|
+
| `--subject` | string | no | Subject |
|
|
1366
1411
|
|
|
1367
1412
|
### upsert-inapp
|
|
1368
1413
|
|
|
@@ -1378,10 +1423,17 @@ iterable templates upsert-inapp <clientTemplateId>
|
|
|
1378
1423
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1379
1424
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1380
1425
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1381
|
-
| `--
|
|
1426
|
+
| `--expirationDateTime` | string | no | The in-app message's absolute expiration time. Format is YYYY-MM-DD HH:MM:SS (UTC timestamp, time zones not allowed) |
|
|
1427
|
+
| `--expirationDuration` | string | no | The in-app message's expiration time, relative to its send time. Should be an expression such as now+90d |
|
|
1428
|
+
| `--html` | string | no | Html of the in-app notification |
|
|
1429
|
+
| `--inAppDisplaySettings` | json | no | Display settings |
|
|
1430
|
+
| `--inboxMetadata` | json | no | Title, subtitle, and thumbnail |
|
|
1431
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1382
1432
|
| `--locale` | string | no | Template locale |
|
|
1383
1433
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1384
1434
|
| `--name` | string | no | Template name |
|
|
1435
|
+
| `--payload` | json | no | Payload |
|
|
1436
|
+
| `--webInAppDisplaySettings` | json | no | Web In-app Display settings |
|
|
1385
1437
|
|
|
1386
1438
|
### upsert-push
|
|
1387
1439
|
|
|
@@ -1394,17 +1446,28 @@ iterable templates upsert-push <clientTemplateId>
|
|
|
1394
1446
|
| Option | Type | Required | Description |
|
|
1395
1447
|
|--------|------|----------|-------------|
|
|
1396
1448
|
| `clientTemplateId` | string | **yes** | Client template ID |
|
|
1397
|
-
| `--badge` |
|
|
1449
|
+
| `--badge` | string | no | Badge to set for push notification |
|
|
1450
|
+
| `--buttons` | json[] | no | Array of buttons that appear to respond to the push. Max of 3 |
|
|
1451
|
+
| `--cacheDataFeed` | boolean | no | Cache data feed lookups for 1 hour |
|
|
1398
1452
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1399
1453
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1400
1454
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1455
|
+
| `--dataFeedIds` | number[] | no | Ids for data feeds used in template rendering |
|
|
1456
|
+
| `--deeplink` | json | no | Deep Link. A mapping that accepts two optional properties: 'ios' & 'android' and their respective deep link values |
|
|
1457
|
+
| `--interruptionLevel` | `passive` \| `active` \| `time-sensitive` \| `critical` | no | An interruption level helps iOS determine when to alert a user about the arrival of a push notification |
|
|
1458
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1459
|
+
| `--isSilentPush` | boolean | no | Whether or not this is a silent push notification template |
|
|
1401
1460
|
| `--locale` | string | no | Template locale |
|
|
1402
|
-
| `--
|
|
1461
|
+
| `--mergeDataFeedContext` | boolean | no | Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]] |
|
|
1462
|
+
| `--message` | string | no | Push message |
|
|
1403
1463
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1404
1464
|
| `--name` | string | no | Template name |
|
|
1405
|
-
| `--payload` | json | no |
|
|
1406
|
-
| `--
|
|
1407
|
-
| `--
|
|
1465
|
+
| `--payload` | json | no | Payload to send with push notification |
|
|
1466
|
+
| `--relevanceScore` | number | no | Relevance score for iOS notifications on iOS 15+. Number is clamped between 0 and 1.0 |
|
|
1467
|
+
| `--richMedia` | json | no | Rich Media URL. A mapping that accepts two optional properties: 'ios' & 'android' and their respective rich media url values |
|
|
1468
|
+
| `--sound` | string | no | Sound |
|
|
1469
|
+
| `--title` | string | no | Push message title |
|
|
1470
|
+
| `--wake` | boolean | no | Set the content-available flag on iOS notifications, which will wake the app in the background |
|
|
1408
1471
|
|
|
1409
1472
|
### upsert-sms
|
|
1410
1473
|
|
|
@@ -1420,10 +1483,15 @@ iterable templates upsert-sms <clientTemplateId>
|
|
|
1420
1483
|
| `--campaignDataFields` | json | no | Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. |
|
|
1421
1484
|
| `--campaignId` | number | no | Associated campaign ID |
|
|
1422
1485
|
| `--creatorUserId` | string | no | Creator user ID |
|
|
1486
|
+
| `--googleAnalyticsCampaignName` | string | no | Google analytics utm_campaign value |
|
|
1487
|
+
| `--imageUrl` | string | no | Image URL |
|
|
1488
|
+
| `--isDefaultLocale` | boolean | no | Sets the locale associated with the request content as the template's default |
|
|
1489
|
+
| `--linkParams` | json[] | no | Parameters to append to each URL in contents |
|
|
1423
1490
|
| `--locale` | string | no | Template locale |
|
|
1424
|
-
| `--message` | string | no | SMS message
|
|
1491
|
+
| `--message` | string | no | SMS message |
|
|
1425
1492
|
| `--messageTypeId` | number | no | Message type ID |
|
|
1426
1493
|
| `--name` | string | no | Template name |
|
|
1494
|
+
| `--trackingDomain` | string | no | Tracking Domain |
|
|
1427
1495
|
|
|
1428
1496
|
|
|
1429
1497
|
## users (13)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iterable/cli",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.5",
|
|
4
4
|
"description": "Command-line interface for the Iterable API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"iterable",
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
"update-commands": "node scripts/update-commands.js"
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@iterable/api": "0.
|
|
62
|
+
"@iterable/api": "0.11.1",
|
|
63
63
|
"@primno/dpapi": "2.0.1",
|
|
64
64
|
"boxen": "8.0.1",
|
|
65
65
|
"chalk": "5.6.2",
|