@pidgeon-ai/cli 1.0.0 → 1.0.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.
Files changed (11) hide show
  1. package/dist/{chunk-Z2RNBVEN.js → chunk-75GJTRBD.js} +356 -81
  2. package/dist/chunk-75GJTRBD.js.map +1 -0
  3. package/dist/{chunk-ODQKQOJ7.js → chunk-VCNNUD25.js} +6 -4
  4. package/dist/chunk-VCNNUD25.js.map +1 -0
  5. package/dist/cli.js +2 -2
  6. package/dist/commands.gen.d.ts +2 -0
  7. package/dist/commands.gen.js +1 -1
  8. package/dist/index.js +2 -2
  9. package/package.json +2 -2
  10. package/dist/chunk-ODQKQOJ7.js.map +0 -1
  11. package/dist/chunk-Z2RNBVEN.js.map +0 -1
package/dist/{chunk-Z2RNBVEN.js → chunk-75GJTRBD.js} RENAMED
@@ -19,13 +19,15 @@ var COMMANDS = [
19
19
  "name": "signup_id",
20
20
  "kind": "string",
21
21
  "required": true,
22
- "where": "body"
22
+ "where": "body",
23
+ "describe": "From the signup this is finishing."
23
24
  },
24
25
  {
25
26
  "name": "human_email",
26
27
  "kind": "string",
27
28
  "required": true,
28
- "where": "body"
29
+ "where": "body",
30
+ "describe": "A person who can be reached. They receive the code that finishes the signup."
29
31
  }
30
32
  ]
31
33
  },
@@ -41,13 +43,15 @@ var COMMANDS = [
41
43
  "name": "username",
42
44
  "kind": "string",
43
45
  "required": true,
44
- "where": "body"
46
+ "where": "body",
47
+ "describe": "The local part you want on the shared domain."
45
48
  },
46
49
  {
47
50
  "name": "human_email",
48
51
  "kind": "string",
49
52
  "required": true,
50
- "where": "body"
53
+ "where": "body",
54
+ "describe": "A person who can be reached. They receive the code that finishes the signup."
51
55
  },
52
56
  {
53
57
  "name": "source",
@@ -69,7 +73,8 @@ var COMMANDS = [
69
73
  "name": "signup_id",
70
74
  "kind": "string",
71
75
  "required": true,
72
- "where": "body"
76
+ "where": "body",
77
+ "describe": "From the signup this is finishing."
73
78
  },
74
79
  {
75
80
  "name": "code",
@@ -91,7 +96,8 @@ var COMMANDS = [
91
96
  "name": "identity_id",
92
97
  "kind": "string",
93
98
  "required": true,
94
- "where": "body"
99
+ "where": "body",
100
+ "describe": "The address this belongs to."
95
101
  },
96
102
  {
97
103
  "name": "name",
@@ -194,7 +200,8 @@ var COMMANDS = [
194
200
  "name": "timezone",
195
201
  "kind": "string",
196
202
  "required": false,
197
- "where": "body"
203
+ "where": "body",
204
+ "describe": "An IANA name, like `Europe/Lisbon`. The times above are read in it."
198
205
  },
199
206
  {
200
207
  "name": "all_day",
@@ -217,6 +224,11 @@ var COMMANDS = [
217
224
  {
218
225
  "name": "status",
219
226
  "kind": "string",
227
+ "choices": [
228
+ "confirmed",
229
+ "tentative",
230
+ "cancelled"
231
+ ],
220
232
  "required": false,
221
233
  "where": "body"
222
234
  },
@@ -269,6 +281,10 @@ var COMMANDS = [
269
281
  {
270
282
  "name": "mode",
271
283
  "kind": "string",
284
+ "choices": [
285
+ "single",
286
+ "future"
287
+ ],
272
288
  "required": false,
273
289
  "where": "query"
274
290
  }
@@ -319,6 +335,10 @@ var COMMANDS = [
319
335
  {
320
336
  "name": "include_overlapping",
321
337
  "kind": "string",
338
+ "choices": [
339
+ "true",
340
+ "false"
341
+ ],
322
342
  "required": false,
323
343
  "where": "query"
324
344
  },
@@ -416,7 +436,8 @@ var COMMANDS = [
416
436
  "name": "cursor",
417
437
  "kind": "string",
418
438
  "required": false,
419
- "where": "query"
439
+ "where": "query",
440
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
420
441
  }
421
442
  ]
422
443
  },
@@ -443,6 +464,11 @@ var COMMANDS = [
443
464
  {
444
465
  "name": "status",
445
466
  "kind": "string",
467
+ "choices": [
468
+ "accepted",
469
+ "declined",
470
+ "tentative"
471
+ ],
446
472
  "required": true,
447
473
  "where": "body"
448
474
  },
@@ -478,7 +504,8 @@ var COMMANDS = [
478
504
  "name": "timezone",
479
505
  "kind": "string",
480
506
  "required": true,
481
- "where": "body"
507
+ "where": "body",
508
+ "describe": "An IANA name, like `Europe/Lisbon`. The times above are read in it."
482
509
  }
483
510
  ]
484
511
  },
@@ -505,6 +532,10 @@ var COMMANDS = [
505
532
  {
506
533
  "name": "mode",
507
534
  "kind": "string",
535
+ "choices": [
536
+ "single",
537
+ "future"
538
+ ],
508
539
  "required": false,
509
540
  "where": "query"
510
541
  },
@@ -530,7 +561,8 @@ var COMMANDS = [
530
561
  "name": "timezone",
531
562
  "kind": "string",
532
563
  "required": false,
533
- "where": "body"
564
+ "where": "body",
565
+ "describe": "An IANA name, like `Europe/Lisbon`. The times above are read in it."
534
566
  },
535
567
  {
536
568
  "name": "all_day",
@@ -553,6 +585,11 @@ var COMMANDS = [
553
585
  {
554
586
  "name": "status",
555
587
  "kind": "string",
588
+ "choices": [
589
+ "confirmed",
590
+ "tentative",
591
+ "cancelled"
592
+ ],
556
593
  "required": false,
557
594
  "where": "body"
558
595
  },
@@ -594,7 +631,8 @@ var COMMANDS = [
594
631
  "name": "domain",
595
632
  "kind": "string",
596
633
  "required": true,
597
- "where": "body"
634
+ "where": "body",
635
+ "describe": "A domain name you own, or the shared one. An alternative to `domain_id`."
598
636
  }
599
637
  ]
600
638
  },
@@ -647,6 +685,10 @@ var COMMANDS = [
647
685
  {
648
686
  "name": "template",
649
687
  "kind": "string",
688
+ "choices": [
689
+ "mail",
690
+ "mx"
691
+ ],
650
692
  "required": false,
651
693
  "where": "query"
652
694
  }
@@ -670,7 +712,8 @@ var COMMANDS = [
670
712
  "name": "cursor",
671
713
  "kind": "string",
672
714
  "required": false,
673
- "where": "query"
715
+ "where": "query",
716
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
674
717
  }
675
718
  ]
676
719
  },
@@ -756,43 +799,50 @@ var COMMANDS = [
756
799
  "name": "identity_id",
757
800
  "kind": "string",
758
801
  "required": true,
759
- "where": "body"
802
+ "where": "body",
803
+ "describe": "The address this belongs to."
760
804
  },
761
805
  {
762
806
  "name": "from",
763
807
  "kind": "string",
764
808
  "required": false,
765
- "where": "body"
809
+ "where": "body",
810
+ "describe": "An address on a domain you own, and one this key may send from."
766
811
  },
767
812
  {
768
813
  "name": "to",
769
814
  "kind": "list",
770
815
  "required": false,
771
- "where": "body"
816
+ "where": "body",
817
+ "describe": "One address or several. A string is accepted for the single case."
772
818
  },
773
819
  {
774
820
  "name": "cc",
775
821
  "kind": "list",
776
822
  "required": false,
777
- "where": "body"
823
+ "where": "body",
824
+ "describe": "Copied, and visible to everybody who receives the message."
778
825
  },
779
826
  {
780
827
  "name": "bcc",
781
828
  "kind": "list",
782
829
  "required": false,
783
- "where": "body"
830
+ "where": "body",
831
+ "describe": "Copied, and visible to nobody else."
784
832
  },
785
833
  {
786
834
  "name": "subject",
787
835
  "kind": "string",
788
836
  "required": false,
789
- "where": "body"
837
+ "where": "body",
838
+ "describe": "Left off a reply, where the thread already has one."
790
839
  },
791
840
  {
792
841
  "name": "text",
793
842
  "kind": "string",
794
843
  "required": false,
795
- "where": "body"
844
+ "where": "body",
845
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
796
846
  },
797
847
  {
798
848
  "name": "in_reply_to_message_id",
@@ -804,7 +854,8 @@ var COMMANDS = [
804
854
  "name": "attachment_ids",
805
855
  "kind": "list",
806
856
  "required": false,
807
- "where": "body"
857
+ "where": "body",
858
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
808
859
  }
809
860
  ]
810
861
  },
@@ -940,43 +991,50 @@ var COMMANDS = [
940
991
  "name": "from",
941
992
  "kind": "string",
942
993
  "required": false,
943
- "where": "body"
994
+ "where": "body",
995
+ "describe": "An address on a domain you own, and one this key may send from."
944
996
  },
945
997
  {
946
998
  "name": "to",
947
999
  "kind": "list",
948
1000
  "required": false,
949
- "where": "body"
1001
+ "where": "body",
1002
+ "describe": "One address or several. A string is accepted for the single case."
950
1003
  },
951
1004
  {
952
1005
  "name": "cc",
953
1006
  "kind": "list",
954
1007
  "required": false,
955
- "where": "body"
1008
+ "where": "body",
1009
+ "describe": "Copied, and visible to everybody who receives the message."
956
1010
  },
957
1011
  {
958
1012
  "name": "bcc",
959
1013
  "kind": "list",
960
1014
  "required": false,
961
- "where": "body"
1015
+ "where": "body",
1016
+ "describe": "Copied, and visible to nobody else."
962
1017
  },
963
1018
  {
964
1019
  "name": "subject",
965
1020
  "kind": "string",
966
1021
  "required": false,
967
- "where": "body"
1022
+ "where": "body",
1023
+ "describe": "Left off a reply, where the thread already has one."
968
1024
  },
969
1025
  {
970
1026
  "name": "text",
971
1027
  "kind": "string",
972
1028
  "required": false,
973
- "where": "body"
1029
+ "where": "body",
1030
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
974
1031
  },
975
1032
  {
976
1033
  "name": "attachment_ids",
977
1034
  "kind": "list",
978
1035
  "required": false,
979
- "where": "body"
1036
+ "where": "body",
1037
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
980
1038
  }
981
1039
  ]
982
1040
  },
@@ -1014,7 +1072,8 @@ var COMMANDS = [
1014
1072
  "name": "cursor",
1015
1073
  "kind": "string",
1016
1074
  "required": false,
1017
- "where": "query"
1075
+ "where": "query",
1076
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1018
1077
  },
1019
1078
  {
1020
1079
  "name": "type",
@@ -1071,8 +1130,14 @@ var COMMANDS = [
1071
1130
  {
1072
1131
  "name": "access",
1073
1132
  "kind": "string",
1133
+ "choices": [
1134
+ "read",
1135
+ "send",
1136
+ "admin"
1137
+ ],
1074
1138
  "required": true,
1075
- "where": "body"
1139
+ "where": "body",
1140
+ "describe": "What a key may do. Give an agent the narrowest one that works."
1076
1141
  }
1077
1142
  ]
1078
1143
  },
@@ -1125,50 +1190,96 @@ var COMMANDS = [
1125
1190
  {
1126
1191
  "name": "domain_id",
1127
1192
  "kind": "string",
1128
- "required": true,
1129
- "where": "body"
1193
+ "required": false,
1194
+ "where": "body",
1195
+ "describe": "From `GET /domains`, or the `domain_id` on any address you already have."
1196
+ },
1197
+ {
1198
+ "name": "domain",
1199
+ "kind": "string",
1200
+ "required": false,
1201
+ "where": "body",
1202
+ "describe": "A domain name you own, or the shared one. An alternative to `domain_id`."
1203
+ },
1204
+ {
1205
+ "name": "address",
1206
+ "kind": "string",
1207
+ "required": false,
1208
+ "where": "body",
1209
+ "describe": "A whole address \u2014 the local part and the domain in one. An alternative to the other two."
1130
1210
  },
1131
1211
  {
1132
1212
  "name": "local_part",
1133
1213
  "kind": "string",
1134
- "required": true,
1135
- "where": "body"
1214
+ "required": false,
1215
+ "where": "body",
1216
+ "describe": "Everything before the `@`."
1136
1217
  },
1137
1218
  {
1138
1219
  "name": "display_name",
1139
1220
  "kind": "string",
1140
1221
  "required": false,
1141
- "where": "body"
1222
+ "where": "body",
1223
+ "describe": "The name a recipient sees beside the address."
1224
+ },
1225
+ {
1226
+ "name": "inbox",
1227
+ "kind": "boolean",
1228
+ "required": false,
1229
+ "where": "body",
1230
+ "describe": "Whether it keeps mail. With an inbox what arrives is stored and a person can open it; without one it becomes an event and your webhook fires. Defaults from `type`."
1142
1231
  },
1143
1232
  {
1144
1233
  "name": "type",
1145
1234
  "kind": "string",
1235
+ "choices": [
1236
+ "human",
1237
+ "team",
1238
+ "application",
1239
+ "workflow",
1240
+ "agent"
1241
+ ],
1146
1242
  "required": false,
1147
- "where": "body"
1243
+ "where": "body",
1244
+ "describe": "A label for what this address is for. It does not change what the address can do \u2014 that is `inbox`."
1148
1245
  },
1149
1246
  {
1150
1247
  "name": "mode",
1151
1248
  "kind": "string",
1249
+ "choices": [
1250
+ "human",
1251
+ "automated",
1252
+ "hybrid"
1253
+ ],
1152
1254
  "required": false,
1153
- "where": "body"
1255
+ "where": "body",
1256
+ "describe": "Who answers: a person, software, or both."
1154
1257
  },
1155
1258
  {
1156
1259
  "name": "expires_at",
1157
1260
  "kind": "string",
1158
1261
  "required": false,
1159
- "where": "body"
1262
+ "where": "body",
1263
+ "describe": "When it stops accepting mail. Expiry suspends; it never deletes, so the correspondence survives."
1160
1264
  },
1161
1265
  {
1162
1266
  "name": "send_policy",
1163
1267
  "kind": "string",
1268
+ "choices": [
1269
+ "open",
1270
+ "reply_only",
1271
+ "list"
1272
+ ],
1164
1273
  "required": false,
1165
- "where": "body"
1274
+ "where": "body",
1275
+ "describe": "Who it may write to. `reply_only` makes an address structurally unable to start a conversation with a stranger."
1166
1276
  },
1167
1277
  {
1168
1278
  "name": "tenant_id",
1169
1279
  "kind": "string",
1170
1280
  "required": false,
1171
- "where": "body"
1281
+ "where": "body",
1282
+ "describe": "Your own opaque grouping \u2014 a customer id, whatever your side calls it. Never parsed here."
1172
1283
  }
1173
1284
  ]
1174
1285
  },
@@ -1222,7 +1333,8 @@ var COMMANDS = [
1222
1333
  "name": "cursor",
1223
1334
  "kind": "string",
1224
1335
  "required": false,
1225
- "where": "query"
1336
+ "where": "query",
1337
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1226
1338
  },
1227
1339
  {
1228
1340
  "name": "tenant_id",
@@ -1249,6 +1361,13 @@ var COMMANDS = [
1249
1361
  {
1250
1362
  "name": "action",
1251
1363
  "kind": "string",
1364
+ "choices": [
1365
+ "reject",
1366
+ "spam",
1367
+ "trash",
1368
+ "archive",
1369
+ "inbox"
1370
+ ],
1252
1371
  "required": true,
1253
1372
  "where": "body"
1254
1373
  },
@@ -1315,6 +1434,10 @@ var COMMANDS = [
1315
1434
  {
1316
1435
  "name": "effect",
1317
1436
  "kind": "string",
1437
+ "choices": [
1438
+ "allow",
1439
+ "block"
1440
+ ],
1318
1441
  "required": true,
1319
1442
  "where": "body"
1320
1443
  },
@@ -1398,13 +1521,20 @@ var COMMANDS = [
1398
1521
  "name": "display_name",
1399
1522
  "kind": "string",
1400
1523
  "required": false,
1401
- "where": "body"
1524
+ "where": "body",
1525
+ "describe": "The name a recipient sees beside the address."
1402
1526
  },
1403
1527
  {
1404
1528
  "name": "mode",
1405
1529
  "kind": "string",
1530
+ "choices": [
1531
+ "human",
1532
+ "automated",
1533
+ "hybrid"
1534
+ ],
1406
1535
  "required": false,
1407
- "where": "body"
1536
+ "where": "body",
1537
+ "describe": "Who answers: a person, software, or both."
1408
1538
  },
1409
1539
  {
1410
1540
  "name": "capabilities",
@@ -1415,6 +1545,11 @@ var COMMANDS = [
1415
1545
  {
1416
1546
  "name": "status",
1417
1547
  "kind": "string",
1548
+ "choices": [
1549
+ "active",
1550
+ "suspended",
1551
+ "archived"
1552
+ ],
1418
1553
  "required": false,
1419
1554
  "where": "body"
1420
1555
  },
@@ -1422,19 +1557,27 @@ var COMMANDS = [
1422
1557
  "name": "expires_at",
1423
1558
  "kind": "string",
1424
1559
  "required": false,
1425
- "where": "body"
1560
+ "where": "body",
1561
+ "describe": "When it stops accepting mail. Expiry suspends; it never deletes, so the correspondence survives."
1426
1562
  },
1427
1563
  {
1428
1564
  "name": "send_policy",
1429
1565
  "kind": "string",
1566
+ "choices": [
1567
+ "open",
1568
+ "reply_only",
1569
+ "list"
1570
+ ],
1430
1571
  "required": false,
1431
- "where": "body"
1572
+ "where": "body",
1573
+ "describe": "Who it may write to. `reply_only` makes an address structurally unable to start a conversation with a stranger."
1432
1574
  },
1433
1575
  {
1434
1576
  "name": "tenant_id",
1435
1577
  "kind": "string",
1436
1578
  "required": false,
1437
- "where": "body"
1579
+ "where": "body",
1580
+ "describe": "Your own opaque grouping \u2014 a customer id, whatever your side calls it. Never parsed here."
1438
1581
  }
1439
1582
  ]
1440
1583
  },
@@ -1461,14 +1604,21 @@ var COMMANDS = [
1461
1604
  {
1462
1605
  "name": "access",
1463
1606
  "kind": "string",
1607
+ "choices": [
1608
+ "read",
1609
+ "send",
1610
+ "admin"
1611
+ ],
1464
1612
  "required": false,
1465
- "where": "body"
1613
+ "where": "body",
1614
+ "describe": "What a key may do. Give an agent the narrowest one that works."
1466
1615
  },
1467
1616
  {
1468
1617
  "name": "expires_at",
1469
1618
  "kind": "string",
1470
1619
  "required": false,
1471
- "where": "body"
1620
+ "where": "body",
1621
+ "describe": "When it stops accepting mail. Expiry suspends; it never deletes, so the correspondence survives."
1472
1622
  }
1473
1623
  ]
1474
1624
  },
@@ -1547,7 +1697,8 @@ var COMMANDS = [
1547
1697
  "name": "identity_id",
1548
1698
  "kind": "string",
1549
1699
  "required": true,
1550
- "where": "body"
1700
+ "where": "body",
1701
+ "describe": "The address this belongs to."
1551
1702
  },
1552
1703
  {
1553
1704
  "name": "name",
@@ -1719,7 +1870,8 @@ var COMMANDS = [
1719
1870
  "name": "cursor",
1720
1871
  "kind": "string",
1721
1872
  "required": false,
1722
- "where": "query"
1873
+ "where": "query",
1874
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1723
1875
  },
1724
1876
  {
1725
1877
  "name": "label_id",
@@ -1746,6 +1898,19 @@ var COMMANDS = [
1746
1898
  {
1747
1899
  "name": "action",
1748
1900
  "kind": "string",
1901
+ "choices": [
1902
+ "read",
1903
+ "unread",
1904
+ "star",
1905
+ "unstar",
1906
+ "archive",
1907
+ "unarchive",
1908
+ "delete",
1909
+ "restore",
1910
+ "spam",
1911
+ "not_spam",
1912
+ "delete_forever"
1913
+ ],
1749
1914
  "required": true,
1750
1915
  "where": "body"
1751
1916
  }
@@ -1769,37 +1934,43 @@ var COMMANDS = [
1769
1934
  "name": "text",
1770
1935
  "kind": "string",
1771
1936
  "required": false,
1772
- "where": "body"
1937
+ "where": "body",
1938
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
1773
1939
  },
1774
1940
  {
1775
1941
  "name": "html",
1776
1942
  "kind": "string",
1777
1943
  "required": false,
1778
- "where": "body"
1944
+ "where": "body",
1945
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
1779
1946
  },
1780
1947
  {
1781
1948
  "name": "to",
1782
1949
  "kind": "list",
1783
1950
  "required": false,
1784
- "where": "body"
1951
+ "where": "body",
1952
+ "describe": "One address or several. A string is accepted for the single case."
1785
1953
  },
1786
1954
  {
1787
1955
  "name": "cc",
1788
1956
  "kind": "list",
1789
1957
  "required": false,
1790
- "where": "body"
1958
+ "where": "body",
1959
+ "describe": "Copied, and visible to everybody who receives the message."
1791
1960
  },
1792
1961
  {
1793
1962
  "name": "bcc",
1794
1963
  "kind": "list",
1795
1964
  "required": false,
1796
- "where": "body"
1965
+ "where": "body",
1966
+ "describe": "Copied, and visible to nobody else."
1797
1967
  },
1798
1968
  {
1799
1969
  "name": "attachment_ids",
1800
1970
  "kind": "list",
1801
1971
  "required": false,
1802
- "where": "body"
1972
+ "where": "body",
1973
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
1803
1974
  }
1804
1975
  ]
1805
1976
  },
@@ -1837,7 +2008,8 @@ var COMMANDS = [
1837
2008
  "name": "cursor",
1838
2009
  "kind": "string",
1839
2010
  "required": false,
1840
- "where": "query"
2011
+ "where": "query",
2012
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1841
2013
  },
1842
2014
  {
1843
2015
  "name": "thread_id",
@@ -1881,37 +2053,43 @@ var COMMANDS = [
1881
2053
  "name": "text",
1882
2054
  "kind": "string",
1883
2055
  "required": false,
1884
- "where": "body"
2056
+ "where": "body",
2057
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
1885
2058
  },
1886
2059
  {
1887
2060
  "name": "html",
1888
2061
  "kind": "string",
1889
2062
  "required": false,
1890
- "where": "body"
2063
+ "where": "body",
2064
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
1891
2065
  },
1892
2066
  {
1893
2067
  "name": "to",
1894
2068
  "kind": "list",
1895
2069
  "required": false,
1896
- "where": "body"
2070
+ "where": "body",
2071
+ "describe": "One address or several. A string is accepted for the single case."
1897
2072
  },
1898
2073
  {
1899
2074
  "name": "cc",
1900
2075
  "kind": "list",
1901
2076
  "required": false,
1902
- "where": "body"
2077
+ "where": "body",
2078
+ "describe": "Copied, and visible to everybody who receives the message."
1903
2079
  },
1904
2080
  {
1905
2081
  "name": "bcc",
1906
2082
  "kind": "list",
1907
2083
  "required": false,
1908
- "where": "body"
2084
+ "where": "body",
2085
+ "describe": "Copied, and visible to nobody else."
1909
2086
  },
1910
2087
  {
1911
2088
  "name": "attachment_ids",
1912
2089
  "kind": "list",
1913
2090
  "required": false,
1914
- "where": "body"
2091
+ "where": "body",
2092
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
1915
2093
  }
1916
2094
  ]
1917
2095
  },
@@ -1933,37 +2111,43 @@ var COMMANDS = [
1933
2111
  "name": "text",
1934
2112
  "kind": "string",
1935
2113
  "required": false,
1936
- "where": "body"
2114
+ "where": "body",
2115
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
1937
2116
  },
1938
2117
  {
1939
2118
  "name": "html",
1940
2119
  "kind": "string",
1941
2120
  "required": false,
1942
- "where": "body"
2121
+ "where": "body",
2122
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
1943
2123
  },
1944
2124
  {
1945
2125
  "name": "to",
1946
2126
  "kind": "list",
1947
2127
  "required": false,
1948
- "where": "body"
2128
+ "where": "body",
2129
+ "describe": "One address or several. A string is accepted for the single case."
1949
2130
  },
1950
2131
  {
1951
2132
  "name": "cc",
1952
2133
  "kind": "list",
1953
2134
  "required": false,
1954
- "where": "body"
2135
+ "where": "body",
2136
+ "describe": "Copied, and visible to everybody who receives the message."
1955
2137
  },
1956
2138
  {
1957
2139
  "name": "bcc",
1958
2140
  "kind": "list",
1959
2141
  "required": false,
1960
- "where": "body"
2142
+ "where": "body",
2143
+ "describe": "Copied, and visible to nobody else."
1961
2144
  },
1962
2145
  {
1963
2146
  "name": "attachment_ids",
1964
2147
  "kind": "list",
1965
2148
  "required": false,
1966
- "where": "body"
2149
+ "where": "body",
2150
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
1967
2151
  }
1968
2152
  ]
1969
2153
  },
@@ -1984,6 +2168,11 @@ var COMMANDS = [
1984
2168
  {
1985
2169
  "name": "status",
1986
2170
  "kind": "string",
2171
+ "choices": [
2172
+ "accepted",
2173
+ "declined",
2174
+ "tentative"
2175
+ ],
1987
2176
  "required": true,
1988
2177
  "where": "body"
1989
2178
  },
@@ -2018,6 +2207,18 @@ var COMMANDS = [
2018
2207
  {
2019
2208
  "name": "in",
2020
2209
  "kind": "string",
2210
+ "choices": [
2211
+ "inbox",
2212
+ "starred",
2213
+ "sent",
2214
+ "drafts",
2215
+ "scheduled",
2216
+ "snoozed",
2217
+ "archive",
2218
+ "spam",
2219
+ "trash",
2220
+ "unauthenticated"
2221
+ ],
2021
2222
  "required": false,
2022
2223
  "where": "query"
2023
2224
  },
@@ -2077,55 +2278,64 @@ var COMMANDS = [
2077
2278
  "name": "from",
2078
2279
  "kind": "string",
2079
2280
  "required": true,
2080
- "where": "body"
2281
+ "where": "body",
2282
+ "describe": "An address on a domain you own, and one this key may send from."
2081
2283
  },
2082
2284
  {
2083
2285
  "name": "to",
2084
2286
  "kind": "list",
2085
2287
  "required": true,
2086
- "where": "body"
2288
+ "where": "body",
2289
+ "describe": "One address or several. A string is accepted for the single case."
2087
2290
  },
2088
2291
  {
2089
2292
  "name": "cc",
2090
2293
  "kind": "list",
2091
2294
  "required": false,
2092
- "where": "body"
2295
+ "where": "body",
2296
+ "describe": "Copied, and visible to everybody who receives the message."
2093
2297
  },
2094
2298
  {
2095
2299
  "name": "bcc",
2096
2300
  "kind": "list",
2097
2301
  "required": false,
2098
- "where": "body"
2302
+ "where": "body",
2303
+ "describe": "Copied, and visible to nobody else."
2099
2304
  },
2100
2305
  {
2101
2306
  "name": "subject",
2102
2307
  "kind": "string",
2103
2308
  "required": false,
2104
- "where": "body"
2309
+ "where": "body",
2310
+ "describe": "Left off a reply, where the thread already has one."
2105
2311
  },
2106
2312
  {
2107
2313
  "name": "text",
2108
2314
  "kind": "string",
2109
2315
  "required": false,
2110
- "where": "body"
2316
+ "where": "body",
2317
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
2111
2318
  },
2112
2319
  {
2113
2320
  "name": "html",
2114
2321
  "kind": "string",
2115
2322
  "required": false,
2116
- "where": "body"
2323
+ "where": "body",
2324
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
2117
2325
  },
2118
2326
  {
2119
2327
  "name": "attachment_ids",
2120
2328
  "kind": "list",
2121
2329
  "required": false,
2122
- "where": "body"
2330
+ "where": "body",
2331
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
2123
2332
  },
2124
2333
  {
2125
2334
  "name": "in_reply_to",
2126
2335
  "kind": "string",
2127
2336
  "required": false,
2128
- "where": "body"
2337
+ "where": "body",
2338
+ "describe": "The message being answered. Keeps the conversation together in the recipient\u2019s client too."
2129
2339
  }
2130
2340
  ]
2131
2341
  },
@@ -2174,6 +2384,12 @@ var COMMANDS = [
2174
2384
  {
2175
2385
  "name": "folder",
2176
2386
  "kind": "string",
2387
+ "choices": [
2388
+ "inbox",
2389
+ "archive",
2390
+ "spam",
2391
+ "trash"
2392
+ ],
2177
2393
  "required": false,
2178
2394
  "where": "body"
2179
2395
  }
@@ -2259,6 +2475,10 @@ var COMMANDS = [
2259
2475
  {
2260
2476
  "name": "status",
2261
2477
  "kind": "string",
2478
+ "choices": [
2479
+ "active",
2480
+ "disabled"
2481
+ ],
2262
2482
  "required": true,
2263
2483
  "where": "body"
2264
2484
  }
@@ -2358,7 +2578,44 @@ var COMMANDS = [
2358
2578
  "name": "cursor",
2359
2579
  "kind": "string",
2360
2580
  "required": false,
2581
+ "where": "query",
2582
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
2583
+ },
2584
+ {
2585
+ "name": "identity_id",
2586
+ "kind": "string",
2587
+ "required": false,
2588
+ "where": "query"
2589
+ },
2590
+ {
2591
+ "name": "status",
2592
+ "kind": "string",
2593
+ "choices": [
2594
+ "open",
2595
+ "waiting",
2596
+ "resolved",
2597
+ "human_review"
2598
+ ],
2599
+ "required": false,
2361
2600
  "where": "query"
2601
+ },
2602
+ {
2603
+ "name": "owner_type",
2604
+ "kind": "string",
2605
+ "choices": [
2606
+ "human",
2607
+ "automation",
2608
+ "agent"
2609
+ ],
2610
+ "required": false,
2611
+ "where": "query"
2612
+ },
2613
+ {
2614
+ "name": "assignee_id",
2615
+ "kind": "string",
2616
+ "required": false,
2617
+ "where": "query",
2618
+ "describe": "A person\u2019s id, or `unassigned` for the queue nobody has taken."
2362
2619
  }
2363
2620
  ]
2364
2621
  },
@@ -2379,12 +2636,23 @@ var COMMANDS = [
2379
2636
  {
2380
2637
  "name": "status",
2381
2638
  "kind": "string",
2639
+ "choices": [
2640
+ "open",
2641
+ "waiting",
2642
+ "resolved",
2643
+ "human_review"
2644
+ ],
2382
2645
  "required": false,
2383
2646
  "where": "body"
2384
2647
  },
2385
2648
  {
2386
2649
  "name": "owner_type",
2387
2650
  "kind": "string",
2651
+ "choices": [
2652
+ "human",
2653
+ "automation",
2654
+ "agent"
2655
+ ],
2388
2656
  "required": false,
2389
2657
  "where": "body"
2390
2658
  },
@@ -2408,13 +2676,15 @@ var COMMANDS = [
2408
2676
  "name": "url",
2409
2677
  "kind": "string",
2410
2678
  "required": true,
2411
- "where": "body"
2679
+ "where": "body",
2680
+ "describe": "Where we POST. HTTPS, and it has to answer within a few seconds."
2412
2681
  },
2413
2682
  {
2414
2683
  "name": "identity_id",
2415
2684
  "kind": "string",
2416
2685
  "required": false,
2417
- "where": "body"
2686
+ "where": "body",
2687
+ "describe": "The address this belongs to."
2418
2688
  },
2419
2689
  {
2420
2690
  "name": "event_types",
@@ -2512,7 +2782,8 @@ var COMMANDS = [
2512
2782
  "name": "cursor",
2513
2783
  "kind": "string",
2514
2784
  "required": false,
2515
- "where": "query"
2785
+ "where": "query",
2786
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
2516
2787
  }
2517
2788
  ]
2518
2789
  },
@@ -2549,6 +2820,10 @@ var COMMANDS = [
2549
2820
  {
2550
2821
  "name": "status",
2551
2822
  "kind": "string",
2823
+ "choices": [
2824
+ "active",
2825
+ "disabled"
2826
+ ],
2552
2827
  "required": true,
2553
2828
  "where": "body"
2554
2829
  }
@@ -2600,4 +2875,4 @@ export {
2600
2875
  __export,
2601
2876
  COMMANDS
2602
2877
  };
2603
- //# sourceMappingURL=chunk-Z2RNBVEN.js.map
2878
+ //# sourceMappingURL=chunk-75GJTRBD.js.map