@knocklabs/cli 0.1.23 → 0.2.1

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.
@@ -7,7 +7,7 @@
7
7
  "service-token": {
8
8
  "env": "KNOCK_SERVICE_TOKEN",
9
9
  "name": "service-token",
10
- "required": true,
10
+ "required": false,
11
11
  "summary": "The service token to authenticate with.",
12
12
  "hasDynamicHelp": false,
13
13
  "multiple": false,
@@ -38,6 +38,80 @@
38
38
  "knock.js"
39
39
  ]
40
40
  },
41
+ "login": {
42
+ "aliases": [],
43
+ "args": {},
44
+ "flags": {
45
+ "service-token": {
46
+ "env": "KNOCK_SERVICE_TOKEN",
47
+ "name": "service-token",
48
+ "required": false,
49
+ "summary": "The service token to authenticate with.",
50
+ "hasDynamicHelp": false,
51
+ "multiple": false,
52
+ "type": "option"
53
+ },
54
+ "api-origin": {
55
+ "hidden": true,
56
+ "name": "api-origin",
57
+ "required": false,
58
+ "hasDynamicHelp": false,
59
+ "multiple": false,
60
+ "type": "option"
61
+ }
62
+ },
63
+ "hasDynamicHelp": false,
64
+ "hiddenAliases": [],
65
+ "id": "login",
66
+ "pluginAlias": "@knocklabs/cli",
67
+ "pluginName": "@knocklabs/cli",
68
+ "pluginType": "core",
69
+ "strict": true,
70
+ "enableJsonFlag": false,
71
+ "isESM": false,
72
+ "relativePath": [
73
+ "dist",
74
+ "commands",
75
+ "login.js"
76
+ ]
77
+ },
78
+ "logout": {
79
+ "aliases": [],
80
+ "args": {},
81
+ "flags": {
82
+ "service-token": {
83
+ "env": "KNOCK_SERVICE_TOKEN",
84
+ "name": "service-token",
85
+ "required": false,
86
+ "summary": "The service token to authenticate with.",
87
+ "hasDynamicHelp": false,
88
+ "multiple": false,
89
+ "type": "option"
90
+ },
91
+ "api-origin": {
92
+ "hidden": true,
93
+ "name": "api-origin",
94
+ "required": false,
95
+ "hasDynamicHelp": false,
96
+ "multiple": false,
97
+ "type": "option"
98
+ }
99
+ },
100
+ "hasDynamicHelp": false,
101
+ "hiddenAliases": [],
102
+ "id": "logout",
103
+ "pluginAlias": "@knocklabs/cli",
104
+ "pluginName": "@knocklabs/cli",
105
+ "pluginType": "core",
106
+ "strict": true,
107
+ "enableJsonFlag": false,
108
+ "isESM": false,
109
+ "relativePath": [
110
+ "dist",
111
+ "commands",
112
+ "logout.js"
113
+ ]
114
+ },
41
115
  "ping": {
42
116
  "aliases": [],
43
117
  "args": {},
@@ -45,7 +119,7 @@
45
119
  "service-token": {
46
120
  "env": "KNOCK_SERVICE_TOKEN",
47
121
  "name": "service-token",
48
- "required": true,
122
+ "required": false,
49
123
  "summary": "The service token to authenticate with.",
50
124
  "hasDynamicHelp": false,
51
125
  "multiple": false,
@@ -83,7 +157,7 @@
83
157
  "service-token": {
84
158
  "env": "KNOCK_SERVICE_TOKEN",
85
159
  "name": "service-token",
86
- "required": true,
160
+ "required": false,
87
161
  "summary": "The service token to authenticate with.",
88
162
  "hasDynamicHelp": false,
89
163
  "multiple": false,
@@ -149,7 +223,7 @@
149
223
  "service-token": {
150
224
  "env": "KNOCK_SERVICE_TOKEN",
151
225
  "name": "service-token",
152
- "required": true,
226
+ "required": false,
153
227
  "summary": "The service token to authenticate with.",
154
228
  "hasDynamicHelp": false,
155
229
  "multiple": false,
@@ -230,7 +304,7 @@
230
304
  "service-token": {
231
305
  "env": "KNOCK_SERVICE_TOKEN",
232
306
  "name": "service-token",
233
- "required": true,
307
+ "required": false,
234
308
  "summary": "The service token to authenticate with.",
235
309
  "hasDynamicHelp": false,
236
310
  "multiple": false,
@@ -261,6 +335,179 @@
261
335
  "whoami.js"
262
336
  ]
263
337
  },
338
+ "branch:create": {
339
+ "aliases": [],
340
+ "args": {
341
+ "slug": {
342
+ "description": "The slug for the new branch",
343
+ "name": "slug",
344
+ "required": true
345
+ }
346
+ },
347
+ "flags": {
348
+ "json": {
349
+ "description": "Format output as json.",
350
+ "helpGroup": "GLOBAL",
351
+ "name": "json",
352
+ "allowNo": false,
353
+ "type": "boolean"
354
+ },
355
+ "service-token": {
356
+ "env": "KNOCK_SERVICE_TOKEN",
357
+ "name": "service-token",
358
+ "required": false,
359
+ "summary": "The service token to authenticate with.",
360
+ "hasDynamicHelp": false,
361
+ "multiple": false,
362
+ "type": "option"
363
+ },
364
+ "api-origin": {
365
+ "hidden": true,
366
+ "name": "api-origin",
367
+ "required": false,
368
+ "hasDynamicHelp": false,
369
+ "multiple": false,
370
+ "type": "option"
371
+ }
372
+ },
373
+ "hasDynamicHelp": false,
374
+ "hidden": true,
375
+ "hiddenAliases": [],
376
+ "id": "branch:create",
377
+ "pluginAlias": "@knocklabs/cli",
378
+ "pluginName": "@knocklabs/cli",
379
+ "pluginType": "core",
380
+ "strict": true,
381
+ "summary": "Creates a new branch off of the development environment.",
382
+ "enableJsonFlag": true,
383
+ "isESM": false,
384
+ "relativePath": [
385
+ "dist",
386
+ "commands",
387
+ "branch",
388
+ "create.js"
389
+ ]
390
+ },
391
+ "branch:delete": {
392
+ "aliases": [],
393
+ "args": {
394
+ "slug": {
395
+ "description": "The slug of the branch to delete",
396
+ "name": "slug",
397
+ "required": true
398
+ }
399
+ },
400
+ "flags": {
401
+ "service-token": {
402
+ "env": "KNOCK_SERVICE_TOKEN",
403
+ "name": "service-token",
404
+ "required": false,
405
+ "summary": "The service token to authenticate with.",
406
+ "hasDynamicHelp": false,
407
+ "multiple": false,
408
+ "type": "option"
409
+ },
410
+ "api-origin": {
411
+ "hidden": true,
412
+ "name": "api-origin",
413
+ "required": false,
414
+ "hasDynamicHelp": false,
415
+ "multiple": false,
416
+ "type": "option"
417
+ },
418
+ "force": {
419
+ "name": "force",
420
+ "summary": "Remove the confirmation prompt.",
421
+ "allowNo": false,
422
+ "type": "boolean"
423
+ }
424
+ },
425
+ "hasDynamicHelp": false,
426
+ "hidden": true,
427
+ "hiddenAliases": [],
428
+ "id": "branch:delete",
429
+ "pluginAlias": "@knocklabs/cli",
430
+ "pluginName": "@knocklabs/cli",
431
+ "pluginType": "core",
432
+ "strict": true,
433
+ "summary": "Deletes an existing branch with the given slug.",
434
+ "enableJsonFlag": false,
435
+ "isESM": false,
436
+ "relativePath": [
437
+ "dist",
438
+ "commands",
439
+ "branch",
440
+ "delete.js"
441
+ ]
442
+ },
443
+ "branch:list": {
444
+ "aliases": [],
445
+ "args": {},
446
+ "flags": {
447
+ "json": {
448
+ "description": "Format output as json.",
449
+ "helpGroup": "GLOBAL",
450
+ "name": "json",
451
+ "allowNo": false,
452
+ "type": "boolean"
453
+ },
454
+ "service-token": {
455
+ "env": "KNOCK_SERVICE_TOKEN",
456
+ "name": "service-token",
457
+ "required": false,
458
+ "summary": "The service token to authenticate with.",
459
+ "hasDynamicHelp": false,
460
+ "multiple": false,
461
+ "type": "option"
462
+ },
463
+ "api-origin": {
464
+ "hidden": true,
465
+ "name": "api-origin",
466
+ "required": false,
467
+ "hasDynamicHelp": false,
468
+ "multiple": false,
469
+ "type": "option"
470
+ },
471
+ "after": {
472
+ "name": "after",
473
+ "summary": "The cursor after which to fetch the next page.",
474
+ "hasDynamicHelp": false,
475
+ "multiple": false,
476
+ "type": "option"
477
+ },
478
+ "before": {
479
+ "name": "before",
480
+ "summary": "The cursor before which to fetch the previous page.",
481
+ "hasDynamicHelp": false,
482
+ "multiple": false,
483
+ "type": "option"
484
+ },
485
+ "limit": {
486
+ "name": "limit",
487
+ "summary": "The total number of entries to fetch per page.",
488
+ "hasDynamicHelp": false,
489
+ "multiple": false,
490
+ "type": "option"
491
+ }
492
+ },
493
+ "hasDynamicHelp": false,
494
+ "hidden": true,
495
+ "hiddenAliases": [],
496
+ "id": "branch:list",
497
+ "pluginAlias": "@knocklabs/cli",
498
+ "pluginName": "@knocklabs/cli",
499
+ "pluginType": "core",
500
+ "strict": true,
501
+ "summary": "Display all existing branches off of the development environment.",
502
+ "enableJsonFlag": true,
503
+ "isESM": false,
504
+ "relativePath": [
505
+ "dist",
506
+ "commands",
507
+ "branch",
508
+ "list.js"
509
+ ]
510
+ },
264
511
  "commit:get": {
265
512
  "aliases": [],
266
513
  "args": {
@@ -280,7 +527,7 @@
280
527
  "service-token": {
281
528
  "env": "KNOCK_SERVICE_TOKEN",
282
529
  "name": "service-token",
283
- "required": true,
530
+ "required": false,
284
531
  "summary": "The service token to authenticate with.",
285
532
  "hasDynamicHelp": false,
286
533
  "multiple": false,
@@ -319,7 +566,7 @@
319
566
  "service-token": {
320
567
  "env": "KNOCK_SERVICE_TOKEN",
321
568
  "name": "service-token",
322
- "required": true,
569
+ "required": false,
323
570
  "summary": "The service token to authenticate with.",
324
571
  "hasDynamicHelp": false,
325
572
  "multiple": false,
@@ -390,7 +637,7 @@
390
637
  "service-token": {
391
638
  "env": "KNOCK_SERVICE_TOKEN",
392
639
  "name": "service-token",
393
- "required": true,
640
+ "required": false,
394
641
  "summary": "The service token to authenticate with.",
395
642
  "hasDynamicHelp": false,
396
643
  "multiple": false,
@@ -486,7 +733,7 @@
486
733
  "service-token": {
487
734
  "env": "KNOCK_SERVICE_TOKEN",
488
735
  "name": "service-token",
489
- "required": true,
736
+ "required": false,
490
737
  "summary": "The service token to authenticate with.",
491
738
  "hasDynamicHelp": false,
492
739
  "multiple": false,
@@ -551,7 +798,7 @@
551
798
  "service-token": {
552
799
  "env": "KNOCK_SERVICE_TOKEN",
553
800
  "name": "service-token",
554
- "required": true,
801
+ "required": false,
555
802
  "summary": "The service token to authenticate with.",
556
803
  "hasDynamicHelp": false,
557
804
  "multiple": false,
@@ -640,7 +887,7 @@
640
887
  "service-token": {
641
888
  "env": "KNOCK_SERVICE_TOKEN",
642
889
  "name": "service-token",
643
- "required": true,
890
+ "required": false,
644
891
  "summary": "The service token to authenticate with.",
645
892
  "hasDynamicHelp": false,
646
893
  "multiple": false,
@@ -706,7 +953,7 @@
706
953
  "service-token": {
707
954
  "env": "KNOCK_SERVICE_TOKEN",
708
955
  "name": "service-token",
709
- "required": true,
956
+ "required": false,
710
957
  "summary": "The service token to authenticate with.",
711
958
  "hasDynamicHelp": false,
712
959
  "multiple": false,
@@ -767,7 +1014,7 @@
767
1014
  "service-token": {
768
1015
  "env": "KNOCK_SERVICE_TOKEN",
769
1016
  "name": "service-token",
770
- "required": true,
1017
+ "required": false,
771
1018
  "summary": "The service token to authenticate with.",
772
1019
  "hasDynamicHelp": false,
773
1020
  "multiple": false,
@@ -847,7 +1094,7 @@
847
1094
  "service-token": {
848
1095
  "env": "KNOCK_SERVICE_TOKEN",
849
1096
  "name": "service-token",
850
- "required": true,
1097
+ "required": false,
851
1098
  "summary": "The service token to authenticate with.",
852
1099
  "hasDynamicHelp": false,
853
1100
  "multiple": false,
@@ -928,7 +1175,7 @@
928
1175
  "service-token": {
929
1176
  "env": "KNOCK_SERVICE_TOKEN",
930
1177
  "name": "service-token",
931
- "required": true,
1178
+ "required": false,
932
1179
  "summary": "The service token to authenticate with.",
933
1180
  "hasDynamicHelp": false,
934
1181
  "multiple": false,
@@ -1017,7 +1264,7 @@
1017
1264
  "service-token": {
1018
1265
  "env": "KNOCK_SERVICE_TOKEN",
1019
1266
  "name": "service-token",
1020
- "required": true,
1267
+ "required": false,
1021
1268
  "summary": "The service token to authenticate with.",
1022
1269
  "hasDynamicHelp": false,
1023
1270
  "multiple": false,
@@ -1077,11 +1324,11 @@
1077
1324
  "validate.js"
1078
1325
  ]
1079
1326
  },
1080
- "message-type:get": {
1327
+ "layout:get": {
1081
1328
  "aliases": [],
1082
1329
  "args": {
1083
- "messageTypeKey": {
1084
- "name": "messageTypeKey",
1330
+ "emailLayoutKey": {
1331
+ "name": "emailLayoutKey",
1085
1332
  "required": true
1086
1333
  }
1087
1334
  },
@@ -1096,7 +1343,7 @@
1096
1343
  "service-token": {
1097
1344
  "env": "KNOCK_SERVICE_TOKEN",
1098
1345
  "name": "service-token",
1099
- "required": true,
1346
+ "required": false,
1100
1347
  "summary": "The service token to authenticate with.",
1101
1348
  "hasDynamicHelp": false,
1102
1349
  "multiple": false,
@@ -1126,24 +1373,23 @@
1126
1373
  }
1127
1374
  },
1128
1375
  "hasDynamicHelp": false,
1129
- "hidden": true,
1130
1376
  "hiddenAliases": [],
1131
- "id": "message-type:get",
1377
+ "id": "layout:get",
1132
1378
  "pluginAlias": "@knocklabs/cli",
1133
1379
  "pluginName": "@knocklabs/cli",
1134
1380
  "pluginType": "core",
1135
1381
  "strict": true,
1136
- "summary": "Display a single in-app message type from an environment.",
1382
+ "summary": "Display a single email layout from an environment.",
1137
1383
  "enableJsonFlag": true,
1138
1384
  "isESM": false,
1139
1385
  "relativePath": [
1140
1386
  "dist",
1141
1387
  "commands",
1142
- "message-type",
1388
+ "layout",
1143
1389
  "get.js"
1144
1390
  ]
1145
1391
  },
1146
- "message-type:list": {
1392
+ "layout:list": {
1147
1393
  "aliases": [],
1148
1394
  "args": {},
1149
1395
  "flags": {
@@ -1157,7 +1403,7 @@
1157
1403
  "service-token": {
1158
1404
  "env": "KNOCK_SERVICE_TOKEN",
1159
1405
  "name": "service-token",
1160
- "required": true,
1406
+ "required": false,
1161
1407
  "summary": "The service token to authenticate with.",
1162
1408
  "hasDynamicHelp": false,
1163
1409
  "multiple": false,
@@ -1208,28 +1454,27 @@
1208
1454
  }
1209
1455
  },
1210
1456
  "hasDynamicHelp": false,
1211
- "hidden": true,
1212
1457
  "hiddenAliases": [],
1213
- "id": "message-type:list",
1458
+ "id": "layout:list",
1214
1459
  "pluginAlias": "@knocklabs/cli",
1215
1460
  "pluginName": "@knocklabs/cli",
1216
1461
  "pluginType": "core",
1217
1462
  "strict": true,
1218
- "summary": "Display all in-app message types for an environment.",
1463
+ "summary": "Display all email layouts for an environment.",
1219
1464
  "enableJsonFlag": true,
1220
1465
  "isESM": false,
1221
1466
  "relativePath": [
1222
1467
  "dist",
1223
1468
  "commands",
1224
- "message-type",
1469
+ "layout",
1225
1470
  "list.js"
1226
1471
  ]
1227
1472
  },
1228
- "message-type:pull": {
1473
+ "layout:pull": {
1229
1474
  "aliases": [],
1230
1475
  "args": {
1231
- "messageTypeKey": {
1232
- "name": "messageTypeKey",
1476
+ "emailLayoutKey": {
1477
+ "name": "emailLayoutKey",
1233
1478
  "required": false
1234
1479
  }
1235
1480
  },
@@ -1237,7 +1482,7 @@
1237
1482
  "service-token": {
1238
1483
  "env": "KNOCK_SERVICE_TOKEN",
1239
1484
  "name": "service-token",
1240
- "required": true,
1485
+ "required": false,
1241
1486
  "summary": "The service token to authenticate with.",
1242
1487
  "hasDynamicHelp": false,
1243
1488
  "multiple": false,
@@ -1261,16 +1506,19 @@
1261
1506
  },
1262
1507
  "all": {
1263
1508
  "name": "all",
1264
- "summary": "Whether to pull all in-app message types from the specified environment.",
1509
+ "summary": "Whether to pull all email layouts from the specified environment.",
1265
1510
  "allowNo": false,
1266
1511
  "type": "boolean"
1267
1512
  },
1268
- "message-types-dir": {
1513
+ "layouts-dir": {
1514
+ "aliases": [
1515
+ "email-layouts-dir"
1516
+ ],
1269
1517
  "dependsOn": [
1270
1518
  "all"
1271
1519
  ],
1272
- "name": "message-types-dir",
1273
- "summary": "The target directory path to pull all in-app message types into.",
1520
+ "name": "layouts-dir",
1521
+ "summary": "The target directory path to pull all email layouts into.",
1274
1522
  "hasDynamicHelp": false,
1275
1523
  "multiple": false,
1276
1524
  "type": "option"
@@ -1289,28 +1537,27 @@
1289
1537
  }
1290
1538
  },
1291
1539
  "hasDynamicHelp": false,
1292
- "hidden": true,
1293
1540
  "hiddenAliases": [],
1294
- "id": "message-type:pull",
1541
+ "id": "layout:pull",
1295
1542
  "pluginAlias": "@knocklabs/cli",
1296
1543
  "pluginName": "@knocklabs/cli",
1297
1544
  "pluginType": "core",
1298
1545
  "strict": true,
1299
- "summary": "Pull one or more in-app message types from an environment into a local file system.",
1546
+ "summary": "Pull one or more email layouts from an environment into a local file system.",
1300
1547
  "enableJsonFlag": false,
1301
1548
  "isESM": false,
1302
1549
  "relativePath": [
1303
1550
  "dist",
1304
1551
  "commands",
1305
- "message-type",
1552
+ "layout",
1306
1553
  "pull.js"
1307
1554
  ]
1308
1555
  },
1309
- "message-type:push": {
1556
+ "layout:push": {
1310
1557
  "aliases": [],
1311
1558
  "args": {
1312
- "messageTypeKey": {
1313
- "name": "messageTypeKey",
1559
+ "emailLayoutKey": {
1560
+ "name": "emailLayoutKey",
1314
1561
  "required": false
1315
1562
  }
1316
1563
  },
@@ -1318,7 +1565,7 @@
1318
1565
  "service-token": {
1319
1566
  "env": "KNOCK_SERVICE_TOKEN",
1320
1567
  "name": "service-token",
1321
- "required": true,
1568
+ "required": false,
1322
1569
  "summary": "The service token to authenticate with.",
1323
1570
  "hasDynamicHelp": false,
1324
1571
  "multiple": false,
@@ -1334,7 +1581,7 @@
1334
1581
  },
1335
1582
  "environment": {
1336
1583
  "name": "environment",
1337
- "summary": "Pushing a message type is only allowed in the development environment",
1584
+ "summary": "Pushing an email layout is only allowed in the development environment",
1338
1585
  "default": "development",
1339
1586
  "hasDynamicHelp": false,
1340
1587
  "multiple": false,
@@ -1345,23 +1592,26 @@
1345
1592
  },
1346
1593
  "all": {
1347
1594
  "name": "all",
1348
- "summary": "Whether to push all message types from the target directory.",
1595
+ "summary": "Whether to push all layouts from the target directory.",
1349
1596
  "allowNo": false,
1350
1597
  "type": "boolean"
1351
1598
  },
1352
- "message-types-dir": {
1599
+ "layouts-dir": {
1600
+ "aliases": [
1601
+ "email-layouts-dir"
1602
+ ],
1353
1603
  "dependsOn": [
1354
1604
  "all"
1355
1605
  ],
1356
- "name": "message-types-dir",
1357
- "summary": "The target directory path to find all message types to push.",
1606
+ "name": "layouts-dir",
1607
+ "summary": "The target directory path to find all layouts to push.",
1358
1608
  "hasDynamicHelp": false,
1359
1609
  "multiple": false,
1360
1610
  "type": "option"
1361
1611
  },
1362
1612
  "commit": {
1363
1613
  "name": "commit",
1364
- "summary": "Push and commit the message type(s) at the same time",
1614
+ "summary": "Push and commit the layout(s) at the same time",
1365
1615
  "allowNo": false,
1366
1616
  "type": "boolean"
1367
1617
  },
@@ -1378,28 +1628,27 @@
1378
1628
  }
1379
1629
  },
1380
1630
  "hasDynamicHelp": false,
1381
- "hidden": true,
1382
1631
  "hiddenAliases": [],
1383
- "id": "message-type:push",
1632
+ "id": "layout:push",
1384
1633
  "pluginAlias": "@knocklabs/cli",
1385
1634
  "pluginName": "@knocklabs/cli",
1386
1635
  "pluginType": "core",
1387
1636
  "strict": true,
1388
- "summary": "Push one or more message types from a local file system to Knock.",
1637
+ "summary": "Push one or more email layouts from a local file system to Knock.",
1389
1638
  "enableJsonFlag": false,
1390
1639
  "isESM": false,
1391
1640
  "relativePath": [
1392
1641
  "dist",
1393
1642
  "commands",
1394
- "message-type",
1643
+ "layout",
1395
1644
  "push.js"
1396
1645
  ]
1397
1646
  },
1398
- "message-type:validate": {
1647
+ "layout:validate": {
1399
1648
  "aliases": [],
1400
1649
  "args": {
1401
- "messageTypeKey": {
1402
- "name": "messageTypeKey",
1650
+ "emailLayoutKey": {
1651
+ "name": "emailLayoutKey",
1403
1652
  "required": false
1404
1653
  }
1405
1654
  },
@@ -1407,7 +1656,7 @@
1407
1656
  "service-token": {
1408
1657
  "env": "KNOCK_SERVICE_TOKEN",
1409
1658
  "name": "service-token",
1410
- "required": true,
1659
+ "required": false,
1411
1660
  "summary": "The service token to authenticate with.",
1412
1661
  "hasDynamicHelp": false,
1413
1662
  "multiple": false,
@@ -1423,7 +1672,7 @@
1423
1672
  },
1424
1673
  "environment": {
1425
1674
  "name": "environment",
1426
- "summary": "Validating a message type is only done in the development environment",
1675
+ "summary": "Validating a layout is only done in the development environment",
1427
1676
  "default": "development",
1428
1677
  "hasDynamicHelp": false,
1429
1678
  "multiple": false,
@@ -1434,44 +1683,46 @@
1434
1683
  },
1435
1684
  "all": {
1436
1685
  "name": "all",
1437
- "summary": "Whether to validate all message types from the target directory.",
1686
+ "summary": "Whether to validate all layouts from the target directory.",
1438
1687
  "allowNo": false,
1439
1688
  "type": "boolean"
1440
1689
  },
1441
- "message-types-dir": {
1690
+ "layouts-dir": {
1691
+ "aliases": [
1692
+ "email-layouts-dir"
1693
+ ],
1442
1694
  "dependsOn": [
1443
1695
  "all"
1444
1696
  ],
1445
- "name": "message-types-dir",
1446
- "summary": "The target directory path to find all message types to validate.",
1697
+ "name": "layouts-dir",
1698
+ "summary": "The target directory path to find all layouts to validate.",
1447
1699
  "hasDynamicHelp": false,
1448
1700
  "multiple": false,
1449
1701
  "type": "option"
1450
1702
  }
1451
1703
  },
1452
1704
  "hasDynamicHelp": false,
1453
- "hidden": true,
1454
1705
  "hiddenAliases": [],
1455
- "id": "message-type:validate",
1706
+ "id": "layout:validate",
1456
1707
  "pluginAlias": "@knocklabs/cli",
1457
1708
  "pluginName": "@knocklabs/cli",
1458
1709
  "pluginType": "core",
1459
1710
  "strict": true,
1460
- "summary": "Validate one or more message types from a local file system.",
1711
+ "summary": "Validate one or more layouts from a local file system.",
1461
1712
  "enableJsonFlag": false,
1462
1713
  "isESM": false,
1463
1714
  "relativePath": [
1464
1715
  "dist",
1465
1716
  "commands",
1466
- "message-type",
1717
+ "layout",
1467
1718
  "validate.js"
1468
1719
  ]
1469
1720
  },
1470
- "layout:get": {
1721
+ "message-type:get": {
1471
1722
  "aliases": [],
1472
1723
  "args": {
1473
- "emailLayoutKey": {
1474
- "name": "emailLayoutKey",
1724
+ "messageTypeKey": {
1725
+ "name": "messageTypeKey",
1475
1726
  "required": true
1476
1727
  }
1477
1728
  },
@@ -1486,7 +1737,7 @@
1486
1737
  "service-token": {
1487
1738
  "env": "KNOCK_SERVICE_TOKEN",
1488
1739
  "name": "service-token",
1489
- "required": true,
1740
+ "required": false,
1490
1741
  "summary": "The service token to authenticate with.",
1491
1742
  "hasDynamicHelp": false,
1492
1743
  "multiple": false,
@@ -1516,23 +1767,24 @@
1516
1767
  }
1517
1768
  },
1518
1769
  "hasDynamicHelp": false,
1770
+ "hidden": true,
1519
1771
  "hiddenAliases": [],
1520
- "id": "layout:get",
1772
+ "id": "message-type:get",
1521
1773
  "pluginAlias": "@knocklabs/cli",
1522
1774
  "pluginName": "@knocklabs/cli",
1523
1775
  "pluginType": "core",
1524
1776
  "strict": true,
1525
- "summary": "Display a single email layout from an environment.",
1777
+ "summary": "Display a single in-app message type from an environment.",
1526
1778
  "enableJsonFlag": true,
1527
1779
  "isESM": false,
1528
1780
  "relativePath": [
1529
1781
  "dist",
1530
1782
  "commands",
1531
- "layout",
1783
+ "message-type",
1532
1784
  "get.js"
1533
1785
  ]
1534
1786
  },
1535
- "layout:list": {
1787
+ "message-type:list": {
1536
1788
  "aliases": [],
1537
1789
  "args": {},
1538
1790
  "flags": {
@@ -1546,7 +1798,7 @@
1546
1798
  "service-token": {
1547
1799
  "env": "KNOCK_SERVICE_TOKEN",
1548
1800
  "name": "service-token",
1549
- "required": true,
1801
+ "required": false,
1550
1802
  "summary": "The service token to authenticate with.",
1551
1803
  "hasDynamicHelp": false,
1552
1804
  "multiple": false,
@@ -1597,27 +1849,28 @@
1597
1849
  }
1598
1850
  },
1599
1851
  "hasDynamicHelp": false,
1852
+ "hidden": true,
1600
1853
  "hiddenAliases": [],
1601
- "id": "layout:list",
1854
+ "id": "message-type:list",
1602
1855
  "pluginAlias": "@knocklabs/cli",
1603
1856
  "pluginName": "@knocklabs/cli",
1604
1857
  "pluginType": "core",
1605
1858
  "strict": true,
1606
- "summary": "Display all email layouts for an environment.",
1859
+ "summary": "Display all in-app message types for an environment.",
1607
1860
  "enableJsonFlag": true,
1608
1861
  "isESM": false,
1609
1862
  "relativePath": [
1610
1863
  "dist",
1611
1864
  "commands",
1612
- "layout",
1865
+ "message-type",
1613
1866
  "list.js"
1614
1867
  ]
1615
1868
  },
1616
- "layout:pull": {
1869
+ "message-type:pull": {
1617
1870
  "aliases": [],
1618
1871
  "args": {
1619
- "emailLayoutKey": {
1620
- "name": "emailLayoutKey",
1872
+ "messageTypeKey": {
1873
+ "name": "messageTypeKey",
1621
1874
  "required": false
1622
1875
  }
1623
1876
  },
@@ -1625,7 +1878,7 @@
1625
1878
  "service-token": {
1626
1879
  "env": "KNOCK_SERVICE_TOKEN",
1627
1880
  "name": "service-token",
1628
- "required": true,
1881
+ "required": false,
1629
1882
  "summary": "The service token to authenticate with.",
1630
1883
  "hasDynamicHelp": false,
1631
1884
  "multiple": false,
@@ -1649,19 +1902,16 @@
1649
1902
  },
1650
1903
  "all": {
1651
1904
  "name": "all",
1652
- "summary": "Whether to pull all email layouts from the specified environment.",
1905
+ "summary": "Whether to pull all in-app message types from the specified environment.",
1653
1906
  "allowNo": false,
1654
1907
  "type": "boolean"
1655
1908
  },
1656
- "layouts-dir": {
1657
- "aliases": [
1658
- "email-layouts-dir"
1659
- ],
1909
+ "message-types-dir": {
1660
1910
  "dependsOn": [
1661
1911
  "all"
1662
1912
  ],
1663
- "name": "layouts-dir",
1664
- "summary": "The target directory path to pull all email layouts into.",
1913
+ "name": "message-types-dir",
1914
+ "summary": "The target directory path to pull all in-app message types into.",
1665
1915
  "hasDynamicHelp": false,
1666
1916
  "multiple": false,
1667
1917
  "type": "option"
@@ -1680,27 +1930,28 @@
1680
1930
  }
1681
1931
  },
1682
1932
  "hasDynamicHelp": false,
1933
+ "hidden": true,
1683
1934
  "hiddenAliases": [],
1684
- "id": "layout:pull",
1935
+ "id": "message-type:pull",
1685
1936
  "pluginAlias": "@knocklabs/cli",
1686
1937
  "pluginName": "@knocklabs/cli",
1687
1938
  "pluginType": "core",
1688
1939
  "strict": true,
1689
- "summary": "Pull one or more email layouts from an environment into a local file system.",
1940
+ "summary": "Pull one or more in-app message types from an environment into a local file system.",
1690
1941
  "enableJsonFlag": false,
1691
1942
  "isESM": false,
1692
1943
  "relativePath": [
1693
1944
  "dist",
1694
1945
  "commands",
1695
- "layout",
1946
+ "message-type",
1696
1947
  "pull.js"
1697
1948
  ]
1698
1949
  },
1699
- "layout:push": {
1950
+ "message-type:push": {
1700
1951
  "aliases": [],
1701
1952
  "args": {
1702
- "emailLayoutKey": {
1703
- "name": "emailLayoutKey",
1953
+ "messageTypeKey": {
1954
+ "name": "messageTypeKey",
1704
1955
  "required": false
1705
1956
  }
1706
1957
  },
@@ -1708,7 +1959,7 @@
1708
1959
  "service-token": {
1709
1960
  "env": "KNOCK_SERVICE_TOKEN",
1710
1961
  "name": "service-token",
1711
- "required": true,
1962
+ "required": false,
1712
1963
  "summary": "The service token to authenticate with.",
1713
1964
  "hasDynamicHelp": false,
1714
1965
  "multiple": false,
@@ -1724,7 +1975,7 @@
1724
1975
  },
1725
1976
  "environment": {
1726
1977
  "name": "environment",
1727
- "summary": "Pushing an email layout is only allowed in the development environment",
1978
+ "summary": "Pushing a message type is only allowed in the development environment",
1728
1979
  "default": "development",
1729
1980
  "hasDynamicHelp": false,
1730
1981
  "multiple": false,
@@ -1735,26 +1986,23 @@
1735
1986
  },
1736
1987
  "all": {
1737
1988
  "name": "all",
1738
- "summary": "Whether to push all layouts from the target directory.",
1989
+ "summary": "Whether to push all message types from the target directory.",
1739
1990
  "allowNo": false,
1740
1991
  "type": "boolean"
1741
1992
  },
1742
- "layouts-dir": {
1743
- "aliases": [
1744
- "email-layouts-dir"
1745
- ],
1993
+ "message-types-dir": {
1746
1994
  "dependsOn": [
1747
1995
  "all"
1748
1996
  ],
1749
- "name": "layouts-dir",
1750
- "summary": "The target directory path to find all layouts to push.",
1997
+ "name": "message-types-dir",
1998
+ "summary": "The target directory path to find all message types to push.",
1751
1999
  "hasDynamicHelp": false,
1752
2000
  "multiple": false,
1753
2001
  "type": "option"
1754
2002
  },
1755
2003
  "commit": {
1756
2004
  "name": "commit",
1757
- "summary": "Push and commit the layout(s) at the same time",
2005
+ "summary": "Push and commit the message type(s) at the same time",
1758
2006
  "allowNo": false,
1759
2007
  "type": "boolean"
1760
2008
  },
@@ -1771,27 +2019,28 @@
1771
2019
  }
1772
2020
  },
1773
2021
  "hasDynamicHelp": false,
2022
+ "hidden": true,
1774
2023
  "hiddenAliases": [],
1775
- "id": "layout:push",
2024
+ "id": "message-type:push",
1776
2025
  "pluginAlias": "@knocklabs/cli",
1777
2026
  "pluginName": "@knocklabs/cli",
1778
2027
  "pluginType": "core",
1779
2028
  "strict": true,
1780
- "summary": "Push one or more email layouts from a local file system to Knock.",
2029
+ "summary": "Push one or more message types from a local file system to Knock.",
1781
2030
  "enableJsonFlag": false,
1782
2031
  "isESM": false,
1783
2032
  "relativePath": [
1784
2033
  "dist",
1785
2034
  "commands",
1786
- "layout",
2035
+ "message-type",
1787
2036
  "push.js"
1788
2037
  ]
1789
2038
  },
1790
- "layout:validate": {
2039
+ "message-type:validate": {
1791
2040
  "aliases": [],
1792
2041
  "args": {
1793
- "emailLayoutKey": {
1794
- "name": "emailLayoutKey",
2042
+ "messageTypeKey": {
2043
+ "name": "messageTypeKey",
1795
2044
  "required": false
1796
2045
  }
1797
2046
  },
@@ -1799,7 +2048,7 @@
1799
2048
  "service-token": {
1800
2049
  "env": "KNOCK_SERVICE_TOKEN",
1801
2050
  "name": "service-token",
1802
- "required": true,
2051
+ "required": false,
1803
2052
  "summary": "The service token to authenticate with.",
1804
2053
  "hasDynamicHelp": false,
1805
2054
  "multiple": false,
@@ -1815,7 +2064,7 @@
1815
2064
  },
1816
2065
  "environment": {
1817
2066
  "name": "environment",
1818
- "summary": "Validating a layout is only done in the development environment",
2067
+ "summary": "Validating a message type is only done in the development environment",
1819
2068
  "default": "development",
1820
2069
  "hasDynamicHelp": false,
1821
2070
  "multiple": false,
@@ -1826,38 +2075,36 @@
1826
2075
  },
1827
2076
  "all": {
1828
2077
  "name": "all",
1829
- "summary": "Whether to validate all layouts from the target directory.",
2078
+ "summary": "Whether to validate all message types from the target directory.",
1830
2079
  "allowNo": false,
1831
2080
  "type": "boolean"
1832
2081
  },
1833
- "layouts-dir": {
1834
- "aliases": [
1835
- "email-layouts-dir"
1836
- ],
2082
+ "message-types-dir": {
1837
2083
  "dependsOn": [
1838
2084
  "all"
1839
2085
  ],
1840
- "name": "layouts-dir",
1841
- "summary": "The target directory path to find all layouts to validate.",
2086
+ "name": "message-types-dir",
2087
+ "summary": "The target directory path to find all message types to validate.",
1842
2088
  "hasDynamicHelp": false,
1843
2089
  "multiple": false,
1844
2090
  "type": "option"
1845
2091
  }
1846
2092
  },
1847
2093
  "hasDynamicHelp": false,
2094
+ "hidden": true,
1848
2095
  "hiddenAliases": [],
1849
- "id": "layout:validate",
2096
+ "id": "message-type:validate",
1850
2097
  "pluginAlias": "@knocklabs/cli",
1851
2098
  "pluginName": "@knocklabs/cli",
1852
2099
  "pluginType": "core",
1853
2100
  "strict": true,
1854
- "summary": "Validate one or more layouts from a local file system.",
2101
+ "summary": "Validate one or more message types from a local file system.",
1855
2102
  "enableJsonFlag": false,
1856
2103
  "isESM": false,
1857
2104
  "relativePath": [
1858
2105
  "dist",
1859
2106
  "commands",
1860
- "layout",
2107
+ "message-type",
1861
2108
  "validate.js"
1862
2109
  ]
1863
2110
  },
@@ -1880,7 +2127,7 @@
1880
2127
  "service-token": {
1881
2128
  "env": "KNOCK_SERVICE_TOKEN",
1882
2129
  "name": "service-token",
1883
- "required": true,
2130
+ "required": false,
1884
2131
  "summary": "The service token to authenticate with.",
1885
2132
  "hasDynamicHelp": false,
1886
2133
  "multiple": false,
@@ -1940,7 +2187,7 @@
1940
2187
  "service-token": {
1941
2188
  "env": "KNOCK_SERVICE_TOKEN",
1942
2189
  "name": "service-token",
1943
- "required": true,
2190
+ "required": false,
1944
2191
  "summary": "The service token to authenticate with.",
1945
2192
  "hasDynamicHelp": false,
1946
2193
  "multiple": false,
@@ -2019,7 +2266,7 @@
2019
2266
  "service-token": {
2020
2267
  "env": "KNOCK_SERVICE_TOKEN",
2021
2268
  "name": "service-token",
2022
- "required": true,
2269
+ "required": false,
2023
2270
  "summary": "The service token to authenticate with.",
2024
2271
  "hasDynamicHelp": false,
2025
2272
  "multiple": false,
@@ -2099,7 +2346,7 @@
2099
2346
  "service-token": {
2100
2347
  "env": "KNOCK_SERVICE_TOKEN",
2101
2348
  "name": "service-token",
2102
- "required": true,
2349
+ "required": false,
2103
2350
  "summary": "The service token to authenticate with.",
2104
2351
  "hasDynamicHelp": false,
2105
2352
  "multiple": false,
@@ -2187,7 +2434,7 @@
2187
2434
  "service-token": {
2188
2435
  "env": "KNOCK_SERVICE_TOKEN",
2189
2436
  "name": "service-token",
2190
- "required": true,
2437
+ "required": false,
2191
2438
  "summary": "The service token to authenticate with.",
2192
2439
  "hasDynamicHelp": false,
2193
2440
  "multiple": false,
@@ -2266,7 +2513,7 @@
2266
2513
  "service-token": {
2267
2514
  "env": "KNOCK_SERVICE_TOKEN",
2268
2515
  "name": "service-token",
2269
- "required": true,
2516
+ "required": false,
2270
2517
  "summary": "The service token to authenticate with.",
2271
2518
  "hasDynamicHelp": false,
2272
2519
  "multiple": false,
@@ -2338,7 +2585,7 @@
2338
2585
  "service-token": {
2339
2586
  "env": "KNOCK_SERVICE_TOKEN",
2340
2587
  "name": "service-token",
2341
- "required": true,
2588
+ "required": false,
2342
2589
  "summary": "The service token to authenticate with.",
2343
2590
  "hasDynamicHelp": false,
2344
2591
  "multiple": false,
@@ -2418,7 +2665,7 @@
2418
2665
  "service-token": {
2419
2666
  "env": "KNOCK_SERVICE_TOKEN",
2420
2667
  "name": "service-token",
2421
- "required": true,
2668
+ "required": false,
2422
2669
  "summary": "The service token to authenticate with.",
2423
2670
  "hasDynamicHelp": false,
2424
2671
  "multiple": false,
@@ -2511,7 +2758,7 @@
2511
2758
  "service-token": {
2512
2759
  "env": "KNOCK_SERVICE_TOKEN",
2513
2760
  "name": "service-token",
2514
- "required": true,
2761
+ "required": false,
2515
2762
  "summary": "The service token to authenticate with.",
2516
2763
  "hasDynamicHelp": false,
2517
2764
  "multiple": false,
@@ -2600,7 +2847,7 @@
2600
2847
  "service-token": {
2601
2848
  "env": "KNOCK_SERVICE_TOKEN",
2602
2849
  "name": "service-token",
2603
- "required": true,
2850
+ "required": false,
2604
2851
  "summary": "The service token to authenticate with.",
2605
2852
  "hasDynamicHelp": false,
2606
2853
  "multiple": false,
@@ -2672,7 +2919,7 @@
2672
2919
  "service-token": {
2673
2920
  "env": "KNOCK_SERVICE_TOKEN",
2674
2921
  "name": "service-token",
2675
- "required": true,
2922
+ "required": false,
2676
2923
  "summary": "The service token to authenticate with.",
2677
2924
  "hasDynamicHelp": false,
2678
2925
  "multiple": false,
@@ -2738,7 +2985,7 @@
2738
2985
  "service-token": {
2739
2986
  "env": "KNOCK_SERVICE_TOKEN",
2740
2987
  "name": "service-token",
2741
- "required": true,
2988
+ "required": false,
2742
2989
  "summary": "The service token to authenticate with.",
2743
2990
  "hasDynamicHelp": false,
2744
2991
  "multiple": false,
@@ -2804,7 +3051,7 @@
2804
3051
  "service-token": {
2805
3052
  "env": "KNOCK_SERVICE_TOKEN",
2806
3053
  "name": "service-token",
2807
- "required": true,
3054
+ "required": false,
2808
3055
  "summary": "The service token to authenticate with.",
2809
3056
  "hasDynamicHelp": false,
2810
3057
  "multiple": false,
@@ -2864,7 +3111,7 @@
2864
3111
  "service-token": {
2865
3112
  "env": "KNOCK_SERVICE_TOKEN",
2866
3113
  "name": "service-token",
2867
- "required": true,
3114
+ "required": false,
2868
3115
  "summary": "The service token to authenticate with.",
2869
3116
  "hasDynamicHelp": false,
2870
3117
  "multiple": false,
@@ -2943,7 +3190,7 @@
2943
3190
  "service-token": {
2944
3191
  "env": "KNOCK_SERVICE_TOKEN",
2945
3192
  "name": "service-token",
2946
- "required": true,
3193
+ "required": false,
2947
3194
  "summary": "The service token to authenticate with.",
2948
3195
  "hasDynamicHelp": false,
2949
3196
  "multiple": false,
@@ -3001,7 +3248,7 @@
3001
3248
  "service-token": {
3002
3249
  "env": "KNOCK_SERVICE_TOKEN",
3003
3250
  "name": "service-token",
3004
- "required": true,
3251
+ "required": false,
3005
3252
  "summary": "The service token to authenticate with.",
3006
3253
  "hasDynamicHelp": false,
3007
3254
  "multiple": false,
@@ -3081,7 +3328,7 @@
3081
3328
  "service-token": {
3082
3329
  "env": "KNOCK_SERVICE_TOKEN",
3083
3330
  "name": "service-token",
3084
- "required": true,
3331
+ "required": false,
3085
3332
  "summary": "The service token to authenticate with.",
3086
3333
  "hasDynamicHelp": false,
3087
3334
  "multiple": false,
@@ -3169,7 +3416,7 @@
3169
3416
  "service-token": {
3170
3417
  "env": "KNOCK_SERVICE_TOKEN",
3171
3418
  "name": "service-token",
3172
- "required": true,
3419
+ "required": false,
3173
3420
  "summary": "The service token to authenticate with.",
3174
3421
  "hasDynamicHelp": false,
3175
3422
  "multiple": false,
@@ -3253,7 +3500,7 @@
3253
3500
  "service-token": {
3254
3501
  "env": "KNOCK_SERVICE_TOKEN",
3255
3502
  "name": "service-token",
3256
- "required": true,
3503
+ "required": false,
3257
3504
  "summary": "The service token to authenticate with.",
3258
3505
  "hasDynamicHelp": false,
3259
3506
  "multiple": false,
@@ -3313,5 +3560,5 @@
3313
3560
  ]
3314
3561
  }
3315
3562
  },
3316
- "version": "0.1.23"
3563
+ "version": "0.2.1"
3317
3564
  }