@pidgeon-ai/cli 1.0.0 → 1.1.0

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.
@@ -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,6 +631,13 @@ var COMMANDS = [
594
631
  "name": "domain",
595
632
  "kind": "string",
596
633
  "required": true,
634
+ "where": "body",
635
+ "describe": "A domain name you own, or the shared one. An alternative to `domain_id`."
636
+ },
637
+ {
638
+ "name": "inbound_enabled",
639
+ "kind": "boolean",
640
+ "required": false,
597
641
  "where": "body"
598
642
  }
599
643
  ]
@@ -647,6 +691,10 @@ var COMMANDS = [
647
691
  {
648
692
  "name": "template",
649
693
  "kind": "string",
694
+ "choices": [
695
+ "mail",
696
+ "mx"
697
+ ],
650
698
  "required": false,
651
699
  "where": "query"
652
700
  }
@@ -670,7 +718,8 @@ var COMMANDS = [
670
718
  "name": "cursor",
671
719
  "kind": "string",
672
720
  "required": false,
673
- "where": "query"
721
+ "where": "query",
722
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
674
723
  }
675
724
  ]
676
725
  },
@@ -756,55 +805,71 @@ var COMMANDS = [
756
805
  "name": "identity_id",
757
806
  "kind": "string",
758
807
  "required": true,
759
- "where": "body"
808
+ "where": "body",
809
+ "describe": "The address this belongs to."
760
810
  },
761
811
  {
762
812
  "name": "from",
763
813
  "kind": "string",
764
814
  "required": false,
765
- "where": "body"
815
+ "where": "body",
816
+ "describe": "An address on a domain you own, and one this key may send from."
766
817
  },
767
818
  {
768
819
  "name": "to",
769
820
  "kind": "list",
770
821
  "required": false,
771
- "where": "body"
822
+ "where": "body",
823
+ "describe": "One address or several. A string is accepted for the single case."
772
824
  },
773
825
  {
774
826
  "name": "cc",
775
827
  "kind": "list",
776
828
  "required": false,
777
- "where": "body"
829
+ "where": "body",
830
+ "describe": "Copied, and visible to everybody who receives the message."
778
831
  },
779
832
  {
780
833
  "name": "bcc",
781
834
  "kind": "list",
782
835
  "required": false,
783
- "where": "body"
836
+ "where": "body",
837
+ "describe": "Copied, and visible to nobody else."
784
838
  },
785
839
  {
786
840
  "name": "subject",
787
841
  "kind": "string",
788
842
  "required": false,
789
- "where": "body"
843
+ "where": "body",
844
+ "describe": "Left off a reply, where the thread already has one."
790
845
  },
791
846
  {
792
847
  "name": "text",
793
848
  "kind": "string",
794
849
  "required": false,
795
- "where": "body"
850
+ "where": "body",
851
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
796
852
  },
797
853
  {
798
854
  "name": "in_reply_to_message_id",
799
855
  "kind": "string",
800
856
  "required": false,
801
- "where": "body"
857
+ "where": "body",
858
+ "describe": "The same field as `in_reply_to`, under the name this endpoint has always used. Both names work on both endpoints; reach for `in_reply_to`."
859
+ },
860
+ {
861
+ "name": "in_reply_to",
862
+ "kind": "string",
863
+ "required": false,
864
+ "where": "body",
865
+ "describe": "The message being answered. Keeps the conversation together in the recipient\u2019s client too."
802
866
  },
803
867
  {
804
868
  "name": "attachment_ids",
805
869
  "kind": "list",
806
870
  "required": false,
807
- "where": "body"
871
+ "where": "body",
872
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
808
873
  }
809
874
  ]
810
875
  },
@@ -940,43 +1005,50 @@ var COMMANDS = [
940
1005
  "name": "from",
941
1006
  "kind": "string",
942
1007
  "required": false,
943
- "where": "body"
1008
+ "where": "body",
1009
+ "describe": "An address on a domain you own, and one this key may send from."
944
1010
  },
945
1011
  {
946
1012
  "name": "to",
947
1013
  "kind": "list",
948
1014
  "required": false,
949
- "where": "body"
1015
+ "where": "body",
1016
+ "describe": "One address or several. A string is accepted for the single case."
950
1017
  },
951
1018
  {
952
1019
  "name": "cc",
953
1020
  "kind": "list",
954
1021
  "required": false,
955
- "where": "body"
1022
+ "where": "body",
1023
+ "describe": "Copied, and visible to everybody who receives the message."
956
1024
  },
957
1025
  {
958
1026
  "name": "bcc",
959
1027
  "kind": "list",
960
1028
  "required": false,
961
- "where": "body"
1029
+ "where": "body",
1030
+ "describe": "Copied, and visible to nobody else."
962
1031
  },
963
1032
  {
964
1033
  "name": "subject",
965
1034
  "kind": "string",
966
1035
  "required": false,
967
- "where": "body"
1036
+ "where": "body",
1037
+ "describe": "Left off a reply, where the thread already has one."
968
1038
  },
969
1039
  {
970
1040
  "name": "text",
971
1041
  "kind": "string",
972
1042
  "required": false,
973
- "where": "body"
1043
+ "where": "body",
1044
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
974
1045
  },
975
1046
  {
976
1047
  "name": "attachment_ids",
977
1048
  "kind": "list",
978
1049
  "required": false,
979
- "where": "body"
1050
+ "where": "body",
1051
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
980
1052
  }
981
1053
  ]
982
1054
  },
@@ -1014,8 +1086,50 @@ var COMMANDS = [
1014
1086
  "name": "cursor",
1015
1087
  "kind": "string",
1016
1088
  "required": false,
1089
+ "where": "query",
1090
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1091
+ },
1092
+ {
1093
+ "name": "type",
1094
+ "kind": "string",
1095
+ "required": false,
1096
+ "where": "query"
1097
+ },
1098
+ {
1099
+ "name": "identity_id",
1100
+ "kind": "string",
1101
+ "required": false,
1102
+ "where": "query"
1103
+ },
1104
+ {
1105
+ "name": "after",
1106
+ "kind": "string",
1107
+ "required": false,
1108
+ "where": "query"
1109
+ }
1110
+ ]
1111
+ },
1112
+ {
1113
+ "group": "events",
1114
+ "name": "stream",
1115
+ "operationId": "eventsStream",
1116
+ "method": "GET",
1117
+ "path": "/events/stream",
1118
+ "summary": "Stream events as they happen",
1119
+ "flags": [
1120
+ {
1121
+ "name": "limit",
1122
+ "kind": "number",
1123
+ "required": false,
1017
1124
  "where": "query"
1018
1125
  },
1126
+ {
1127
+ "name": "cursor",
1128
+ "kind": "string",
1129
+ "required": false,
1130
+ "where": "query",
1131
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1132
+ },
1019
1133
  {
1020
1134
  "name": "type",
1021
1135
  "kind": "string",
@@ -1071,8 +1185,14 @@ var COMMANDS = [
1071
1185
  {
1072
1186
  "name": "access",
1073
1187
  "kind": "string",
1188
+ "choices": [
1189
+ "read",
1190
+ "send",
1191
+ "admin"
1192
+ ],
1074
1193
  "required": true,
1075
- "where": "body"
1194
+ "where": "body",
1195
+ "describe": "What a key may do. Give an agent the narrowest one that works."
1076
1196
  }
1077
1197
  ]
1078
1198
  },
@@ -1125,50 +1245,96 @@ var COMMANDS = [
1125
1245
  {
1126
1246
  "name": "domain_id",
1127
1247
  "kind": "string",
1128
- "required": true,
1129
- "where": "body"
1248
+ "required": false,
1249
+ "where": "body",
1250
+ "describe": "From `GET /domains`, or the `domain_id` on any address you already have."
1251
+ },
1252
+ {
1253
+ "name": "domain",
1254
+ "kind": "string",
1255
+ "required": false,
1256
+ "where": "body",
1257
+ "describe": "A domain name you own, or the shared one. An alternative to `domain_id`."
1258
+ },
1259
+ {
1260
+ "name": "address",
1261
+ "kind": "string",
1262
+ "required": false,
1263
+ "where": "body",
1264
+ "describe": "A whole address \u2014 the local part and the domain in one. An alternative to the other two."
1130
1265
  },
1131
1266
  {
1132
1267
  "name": "local_part",
1133
1268
  "kind": "string",
1134
- "required": true,
1135
- "where": "body"
1269
+ "required": false,
1270
+ "where": "body",
1271
+ "describe": "Everything before the `@`."
1136
1272
  },
1137
1273
  {
1138
1274
  "name": "display_name",
1139
1275
  "kind": "string",
1140
1276
  "required": false,
1141
- "where": "body"
1277
+ "where": "body",
1278
+ "describe": "The name a recipient sees beside the address."
1279
+ },
1280
+ {
1281
+ "name": "inbox",
1282
+ "kind": "boolean",
1283
+ "required": false,
1284
+ "where": "body",
1285
+ "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
1286
  },
1143
1287
  {
1144
1288
  "name": "type",
1145
1289
  "kind": "string",
1290
+ "choices": [
1291
+ "human",
1292
+ "team",
1293
+ "application",
1294
+ "workflow",
1295
+ "agent"
1296
+ ],
1146
1297
  "required": false,
1147
- "where": "body"
1298
+ "where": "body",
1299
+ "describe": "A label for what this address is for. It does not change what the address can do \u2014 that is `inbox`."
1148
1300
  },
1149
1301
  {
1150
1302
  "name": "mode",
1151
1303
  "kind": "string",
1304
+ "choices": [
1305
+ "human",
1306
+ "automated",
1307
+ "hybrid"
1308
+ ],
1152
1309
  "required": false,
1153
- "where": "body"
1310
+ "where": "body",
1311
+ "describe": "Who answers: a person, software, or both."
1154
1312
  },
1155
1313
  {
1156
1314
  "name": "expires_at",
1157
1315
  "kind": "string",
1158
1316
  "required": false,
1159
- "where": "body"
1317
+ "where": "body",
1318
+ "describe": "When it stops accepting mail. Expiry suspends; it never deletes, so the correspondence survives."
1160
1319
  },
1161
1320
  {
1162
1321
  "name": "send_policy",
1163
1322
  "kind": "string",
1323
+ "choices": [
1324
+ "open",
1325
+ "reply_only",
1326
+ "list"
1327
+ ],
1164
1328
  "required": false,
1165
- "where": "body"
1329
+ "where": "body",
1330
+ "describe": "Who it may write to. `reply_only` makes an address structurally unable to start a conversation with a stranger."
1166
1331
  },
1167
1332
  {
1168
1333
  "name": "tenant_id",
1169
1334
  "kind": "string",
1170
1335
  "required": false,
1171
- "where": "body"
1336
+ "where": "body",
1337
+ "describe": "Your own opaque grouping \u2014 a customer id, whatever your side calls it. Never parsed here."
1172
1338
  }
1173
1339
  ]
1174
1340
  },
@@ -1222,7 +1388,8 @@ var COMMANDS = [
1222
1388
  "name": "cursor",
1223
1389
  "kind": "string",
1224
1390
  "required": false,
1225
- "where": "query"
1391
+ "where": "query",
1392
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1226
1393
  },
1227
1394
  {
1228
1395
  "name": "tenant_id",
@@ -1249,6 +1416,13 @@ var COMMANDS = [
1249
1416
  {
1250
1417
  "name": "action",
1251
1418
  "kind": "string",
1419
+ "choices": [
1420
+ "reject",
1421
+ "spam",
1422
+ "trash",
1423
+ "archive",
1424
+ "inbox"
1425
+ ],
1252
1426
  "required": true,
1253
1427
  "where": "body"
1254
1428
  },
@@ -1315,6 +1489,10 @@ var COMMANDS = [
1315
1489
  {
1316
1490
  "name": "effect",
1317
1491
  "kind": "string",
1492
+ "choices": [
1493
+ "allow",
1494
+ "block"
1495
+ ],
1318
1496
  "required": true,
1319
1497
  "where": "body"
1320
1498
  },
@@ -1398,13 +1576,20 @@ var COMMANDS = [
1398
1576
  "name": "display_name",
1399
1577
  "kind": "string",
1400
1578
  "required": false,
1401
- "where": "body"
1579
+ "where": "body",
1580
+ "describe": "The name a recipient sees beside the address."
1402
1581
  },
1403
1582
  {
1404
1583
  "name": "mode",
1405
1584
  "kind": "string",
1585
+ "choices": [
1586
+ "human",
1587
+ "automated",
1588
+ "hybrid"
1589
+ ],
1406
1590
  "required": false,
1407
- "where": "body"
1591
+ "where": "body",
1592
+ "describe": "Who answers: a person, software, or both."
1408
1593
  },
1409
1594
  {
1410
1595
  "name": "capabilities",
@@ -1415,6 +1600,11 @@ var COMMANDS = [
1415
1600
  {
1416
1601
  "name": "status",
1417
1602
  "kind": "string",
1603
+ "choices": [
1604
+ "active",
1605
+ "suspended",
1606
+ "archived"
1607
+ ],
1418
1608
  "required": false,
1419
1609
  "where": "body"
1420
1610
  },
@@ -1422,19 +1612,27 @@ var COMMANDS = [
1422
1612
  "name": "expires_at",
1423
1613
  "kind": "string",
1424
1614
  "required": false,
1425
- "where": "body"
1615
+ "where": "body",
1616
+ "describe": "When it stops accepting mail. Expiry suspends; it never deletes, so the correspondence survives."
1426
1617
  },
1427
1618
  {
1428
1619
  "name": "send_policy",
1429
1620
  "kind": "string",
1621
+ "choices": [
1622
+ "open",
1623
+ "reply_only",
1624
+ "list"
1625
+ ],
1430
1626
  "required": false,
1431
- "where": "body"
1627
+ "where": "body",
1628
+ "describe": "Who it may write to. `reply_only` makes an address structurally unable to start a conversation with a stranger."
1432
1629
  },
1433
1630
  {
1434
1631
  "name": "tenant_id",
1435
1632
  "kind": "string",
1436
1633
  "required": false,
1437
- "where": "body"
1634
+ "where": "body",
1635
+ "describe": "Your own opaque grouping \u2014 a customer id, whatever your side calls it. Never parsed here."
1438
1636
  }
1439
1637
  ]
1440
1638
  },
@@ -1461,14 +1659,21 @@ var COMMANDS = [
1461
1659
  {
1462
1660
  "name": "access",
1463
1661
  "kind": "string",
1662
+ "choices": [
1663
+ "read",
1664
+ "send",
1665
+ "admin"
1666
+ ],
1464
1667
  "required": false,
1465
- "where": "body"
1668
+ "where": "body",
1669
+ "describe": "What a key may do. Give an agent the narrowest one that works."
1466
1670
  },
1467
1671
  {
1468
1672
  "name": "expires_at",
1469
1673
  "kind": "string",
1470
1674
  "required": false,
1471
- "where": "body"
1675
+ "where": "body",
1676
+ "describe": "When it stops accepting mail. Expiry suspends; it never deletes, so the correspondence survives."
1472
1677
  }
1473
1678
  ]
1474
1679
  },
@@ -1547,7 +1752,8 @@ var COMMANDS = [
1547
1752
  "name": "identity_id",
1548
1753
  "kind": "string",
1549
1754
  "required": true,
1550
- "where": "body"
1755
+ "where": "body",
1756
+ "describe": "The address this belongs to."
1551
1757
  },
1552
1758
  {
1553
1759
  "name": "name",
@@ -1558,6 +1764,16 @@ var COMMANDS = [
1558
1764
  {
1559
1765
  "name": "colour",
1560
1766
  "kind": "string",
1767
+ "choices": [
1768
+ "slate",
1769
+ "red",
1770
+ "amber",
1771
+ "green",
1772
+ "teal",
1773
+ "blue",
1774
+ "violet",
1775
+ "pink"
1776
+ ],
1561
1777
  "required": false,
1562
1778
  "where": "body"
1563
1779
  }
@@ -1618,6 +1834,16 @@ var COMMANDS = [
1618
1834
  {
1619
1835
  "name": "colour",
1620
1836
  "kind": "string",
1837
+ "choices": [
1838
+ "slate",
1839
+ "red",
1840
+ "amber",
1841
+ "green",
1842
+ "teal",
1843
+ "blue",
1844
+ "violet",
1845
+ "pink"
1846
+ ],
1621
1847
  "required": false,
1622
1848
  "where": "body"
1623
1849
  }
@@ -1719,7 +1945,8 @@ var COMMANDS = [
1719
1945
  "name": "cursor",
1720
1946
  "kind": "string",
1721
1947
  "required": false,
1722
- "where": "query"
1948
+ "where": "query",
1949
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1723
1950
  },
1724
1951
  {
1725
1952
  "name": "label_id",
@@ -1729,6 +1956,15 @@ var COMMANDS = [
1729
1956
  }
1730
1957
  ]
1731
1958
  },
1959
+ {
1960
+ "group": "me",
1961
+ "name": "get",
1962
+ "operationId": "meGet",
1963
+ "method": "GET",
1964
+ "path": "/me",
1965
+ "summary": "What this key is, and what it may do",
1966
+ "flags": []
1967
+ },
1732
1968
  {
1733
1969
  "group": "messages",
1734
1970
  "name": "act",
@@ -1746,6 +1982,19 @@ var COMMANDS = [
1746
1982
  {
1747
1983
  "name": "action",
1748
1984
  "kind": "string",
1985
+ "choices": [
1986
+ "read",
1987
+ "unread",
1988
+ "star",
1989
+ "unstar",
1990
+ "archive",
1991
+ "unarchive",
1992
+ "delete",
1993
+ "restore",
1994
+ "spam",
1995
+ "not_spam",
1996
+ "delete_forever"
1997
+ ],
1749
1998
  "required": true,
1750
1999
  "where": "body"
1751
2000
  }
@@ -1769,37 +2018,43 @@ var COMMANDS = [
1769
2018
  "name": "text",
1770
2019
  "kind": "string",
1771
2020
  "required": false,
1772
- "where": "body"
2021
+ "where": "body",
2022
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
1773
2023
  },
1774
2024
  {
1775
2025
  "name": "html",
1776
2026
  "kind": "string",
1777
2027
  "required": false,
1778
- "where": "body"
2028
+ "where": "body",
2029
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
1779
2030
  },
1780
2031
  {
1781
2032
  "name": "to",
1782
2033
  "kind": "list",
1783
2034
  "required": false,
1784
- "where": "body"
2035
+ "where": "body",
2036
+ "describe": "One address or several. A string is accepted for the single case."
1785
2037
  },
1786
2038
  {
1787
2039
  "name": "cc",
1788
2040
  "kind": "list",
1789
2041
  "required": false,
1790
- "where": "body"
2042
+ "where": "body",
2043
+ "describe": "Copied, and visible to everybody who receives the message."
1791
2044
  },
1792
2045
  {
1793
2046
  "name": "bcc",
1794
2047
  "kind": "list",
1795
2048
  "required": false,
1796
- "where": "body"
2049
+ "where": "body",
2050
+ "describe": "Copied, and visible to nobody else."
1797
2051
  },
1798
2052
  {
1799
2053
  "name": "attachment_ids",
1800
2054
  "kind": "list",
1801
2055
  "required": false,
1802
- "where": "body"
2056
+ "where": "body",
2057
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
1803
2058
  }
1804
2059
  ]
1805
2060
  },
@@ -1837,7 +2092,8 @@ var COMMANDS = [
1837
2092
  "name": "cursor",
1838
2093
  "kind": "string",
1839
2094
  "required": false,
1840
- "where": "query"
2095
+ "where": "query",
2096
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
1841
2097
  },
1842
2098
  {
1843
2099
  "name": "thread_id",
@@ -1881,37 +2137,43 @@ var COMMANDS = [
1881
2137
  "name": "text",
1882
2138
  "kind": "string",
1883
2139
  "required": false,
1884
- "where": "body"
2140
+ "where": "body",
2141
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
1885
2142
  },
1886
2143
  {
1887
2144
  "name": "html",
1888
2145
  "kind": "string",
1889
2146
  "required": false,
1890
- "where": "body"
2147
+ "where": "body",
2148
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
1891
2149
  },
1892
2150
  {
1893
2151
  "name": "to",
1894
2152
  "kind": "list",
1895
2153
  "required": false,
1896
- "where": "body"
2154
+ "where": "body",
2155
+ "describe": "One address or several. A string is accepted for the single case."
1897
2156
  },
1898
2157
  {
1899
2158
  "name": "cc",
1900
2159
  "kind": "list",
1901
2160
  "required": false,
1902
- "where": "body"
2161
+ "where": "body",
2162
+ "describe": "Copied, and visible to everybody who receives the message."
1903
2163
  },
1904
2164
  {
1905
2165
  "name": "bcc",
1906
2166
  "kind": "list",
1907
2167
  "required": false,
1908
- "where": "body"
2168
+ "where": "body",
2169
+ "describe": "Copied, and visible to nobody else."
1909
2170
  },
1910
2171
  {
1911
2172
  "name": "attachment_ids",
1912
2173
  "kind": "list",
1913
2174
  "required": false,
1914
- "where": "body"
2175
+ "where": "body",
2176
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
1915
2177
  }
1916
2178
  ]
1917
2179
  },
@@ -1933,37 +2195,43 @@ var COMMANDS = [
1933
2195
  "name": "text",
1934
2196
  "kind": "string",
1935
2197
  "required": false,
1936
- "where": "body"
2198
+ "where": "body",
2199
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
1937
2200
  },
1938
2201
  {
1939
2202
  "name": "html",
1940
2203
  "kind": "string",
1941
2204
  "required": false,
1942
- "where": "body"
2205
+ "where": "body",
2206
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
1943
2207
  },
1944
2208
  {
1945
2209
  "name": "to",
1946
2210
  "kind": "list",
1947
2211
  "required": false,
1948
- "where": "body"
2212
+ "where": "body",
2213
+ "describe": "One address or several. A string is accepted for the single case."
1949
2214
  },
1950
2215
  {
1951
2216
  "name": "cc",
1952
2217
  "kind": "list",
1953
2218
  "required": false,
1954
- "where": "body"
2219
+ "where": "body",
2220
+ "describe": "Copied, and visible to everybody who receives the message."
1955
2221
  },
1956
2222
  {
1957
2223
  "name": "bcc",
1958
2224
  "kind": "list",
1959
2225
  "required": false,
1960
- "where": "body"
2226
+ "where": "body",
2227
+ "describe": "Copied, and visible to nobody else."
1961
2228
  },
1962
2229
  {
1963
2230
  "name": "attachment_ids",
1964
2231
  "kind": "list",
1965
2232
  "required": false,
1966
- "where": "body"
2233
+ "where": "body",
2234
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
1967
2235
  }
1968
2236
  ]
1969
2237
  },
@@ -1984,6 +2252,11 @@ var COMMANDS = [
1984
2252
  {
1985
2253
  "name": "status",
1986
2254
  "kind": "string",
2255
+ "choices": [
2256
+ "accepted",
2257
+ "declined",
2258
+ "tentative"
2259
+ ],
1987
2260
  "required": true,
1988
2261
  "where": "body"
1989
2262
  },
@@ -2001,12 +2274,12 @@ var COMMANDS = [
2001
2274
  "operationId": "messagesSearch",
2002
2275
  "method": "GET",
2003
2276
  "path": "/messages/search",
2004
- "summary": "Search one mailbox",
2277
+ "summary": "Search messages",
2005
2278
  "flags": [
2006
2279
  {
2007
2280
  "name": "identity_id",
2008
2281
  "kind": "string",
2009
- "required": true,
2282
+ "required": false,
2010
2283
  "where": "query"
2011
2284
  },
2012
2285
  {
@@ -2018,6 +2291,18 @@ var COMMANDS = [
2018
2291
  {
2019
2292
  "name": "in",
2020
2293
  "kind": "string",
2294
+ "choices": [
2295
+ "inbox",
2296
+ "starred",
2297
+ "sent",
2298
+ "drafts",
2299
+ "scheduled",
2300
+ "snoozed",
2301
+ "archive",
2302
+ "spam",
2303
+ "trash",
2304
+ "unauthenticated"
2305
+ ],
2021
2306
  "required": false,
2022
2307
  "where": "query"
2023
2308
  },
@@ -2077,55 +2362,71 @@ var COMMANDS = [
2077
2362
  "name": "from",
2078
2363
  "kind": "string",
2079
2364
  "required": true,
2080
- "where": "body"
2365
+ "where": "body",
2366
+ "describe": "An address on a domain you own, and one this key may send from."
2081
2367
  },
2082
2368
  {
2083
2369
  "name": "to",
2084
2370
  "kind": "list",
2085
2371
  "required": true,
2086
- "where": "body"
2372
+ "where": "body",
2373
+ "describe": "One address or several. A string is accepted for the single case."
2087
2374
  },
2088
2375
  {
2089
2376
  "name": "cc",
2090
2377
  "kind": "list",
2091
2378
  "required": false,
2092
- "where": "body"
2379
+ "where": "body",
2380
+ "describe": "Copied, and visible to everybody who receives the message."
2093
2381
  },
2094
2382
  {
2095
2383
  "name": "bcc",
2096
2384
  "kind": "list",
2097
2385
  "required": false,
2098
- "where": "body"
2386
+ "where": "body",
2387
+ "describe": "Copied, and visible to nobody else."
2099
2388
  },
2100
2389
  {
2101
2390
  "name": "subject",
2102
2391
  "kind": "string",
2103
2392
  "required": false,
2104
- "where": "body"
2393
+ "where": "body",
2394
+ "describe": "Left off a reply, where the thread already has one."
2105
2395
  },
2106
2396
  {
2107
2397
  "name": "text",
2108
2398
  "kind": "string",
2109
2399
  "required": false,
2110
- "where": "body"
2400
+ "where": "body",
2401
+ "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
2111
2402
  },
2112
2403
  {
2113
2404
  "name": "html",
2114
2405
  "kind": "string",
2115
2406
  "required": false,
2116
- "where": "body"
2407
+ "where": "body",
2408
+ "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
2117
2409
  },
2118
2410
  {
2119
2411
  "name": "attachment_ids",
2120
2412
  "kind": "list",
2121
2413
  "required": false,
2122
- "where": "body"
2414
+ "where": "body",
2415
+ "describe": "Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20."
2123
2416
  },
2124
2417
  {
2125
2418
  "name": "in_reply_to",
2126
2419
  "kind": "string",
2127
2420
  "required": false,
2128
- "where": "body"
2421
+ "where": "body",
2422
+ "describe": "The message being answered. Keeps the conversation together in the recipient\u2019s client too."
2423
+ },
2424
+ {
2425
+ "name": "in_reply_to_message_id",
2426
+ "kind": "string",
2427
+ "required": false,
2428
+ "where": "body",
2429
+ "describe": "The same field as `in_reply_to`, under the name this endpoint has always used. Both names work on both endpoints; reach for `in_reply_to`."
2129
2430
  }
2130
2431
  ]
2131
2432
  },
@@ -2174,6 +2475,12 @@ var COMMANDS = [
2174
2475
  {
2175
2476
  "name": "folder",
2176
2477
  "kind": "string",
2478
+ "choices": [
2479
+ "inbox",
2480
+ "archive",
2481
+ "spam",
2482
+ "trash"
2483
+ ],
2177
2484
  "required": false,
2178
2485
  "where": "body"
2179
2486
  }
@@ -2259,6 +2566,10 @@ var COMMANDS = [
2259
2566
  {
2260
2567
  "name": "status",
2261
2568
  "kind": "string",
2569
+ "choices": [
2570
+ "active",
2571
+ "disabled"
2572
+ ],
2262
2573
  "required": true,
2263
2574
  "where": "body"
2264
2575
  }
@@ -2358,7 +2669,44 @@ var COMMANDS = [
2358
2669
  "name": "cursor",
2359
2670
  "kind": "string",
2360
2671
  "required": false,
2672
+ "where": "query",
2673
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
2674
+ },
2675
+ {
2676
+ "name": "identity_id",
2677
+ "kind": "string",
2678
+ "required": false,
2361
2679
  "where": "query"
2680
+ },
2681
+ {
2682
+ "name": "status",
2683
+ "kind": "string",
2684
+ "choices": [
2685
+ "open",
2686
+ "waiting",
2687
+ "resolved",
2688
+ "human_review"
2689
+ ],
2690
+ "required": false,
2691
+ "where": "query"
2692
+ },
2693
+ {
2694
+ "name": "owner_type",
2695
+ "kind": "string",
2696
+ "choices": [
2697
+ "human",
2698
+ "automation",
2699
+ "agent"
2700
+ ],
2701
+ "required": false,
2702
+ "where": "query"
2703
+ },
2704
+ {
2705
+ "name": "assignee_id",
2706
+ "kind": "string",
2707
+ "required": false,
2708
+ "where": "query",
2709
+ "describe": "A person\u2019s id, or `unassigned` for the queue nobody has taken."
2362
2710
  }
2363
2711
  ]
2364
2712
  },
@@ -2379,12 +2727,23 @@ var COMMANDS = [
2379
2727
  {
2380
2728
  "name": "status",
2381
2729
  "kind": "string",
2730
+ "choices": [
2731
+ "open",
2732
+ "waiting",
2733
+ "resolved",
2734
+ "human_review"
2735
+ ],
2382
2736
  "required": false,
2383
2737
  "where": "body"
2384
2738
  },
2385
2739
  {
2386
2740
  "name": "owner_type",
2387
2741
  "kind": "string",
2742
+ "choices": [
2743
+ "human",
2744
+ "automation",
2745
+ "agent"
2746
+ ],
2388
2747
  "required": false,
2389
2748
  "where": "body"
2390
2749
  },
@@ -2408,13 +2767,15 @@ var COMMANDS = [
2408
2767
  "name": "url",
2409
2768
  "kind": "string",
2410
2769
  "required": true,
2411
- "where": "body"
2770
+ "where": "body",
2771
+ "describe": "Where we POST. HTTPS, and it has to answer within a few seconds."
2412
2772
  },
2413
2773
  {
2414
2774
  "name": "identity_id",
2415
2775
  "kind": "string",
2416
2776
  "required": false,
2417
- "where": "body"
2777
+ "where": "body",
2778
+ "describe": "The address this belongs to."
2418
2779
  },
2419
2780
  {
2420
2781
  "name": "event_types",
@@ -2512,7 +2873,8 @@ var COMMANDS = [
2512
2873
  "name": "cursor",
2513
2874
  "kind": "string",
2514
2875
  "required": false,
2515
- "where": "query"
2876
+ "where": "query",
2877
+ "describe": "From a previous page\u2019s `next_cursor`. Opaque \u2014 do not parse it."
2516
2878
  }
2517
2879
  ]
2518
2880
  },
@@ -2549,6 +2911,10 @@ var COMMANDS = [
2549
2911
  {
2550
2912
  "name": "status",
2551
2913
  "kind": "string",
2914
+ "choices": [
2915
+ "active",
2916
+ "disabled"
2917
+ ],
2552
2918
  "required": true,
2553
2919
  "where": "body"
2554
2920
  }
@@ -2600,4 +2966,4 @@ export {
2600
2966
  __export,
2601
2967
  COMMANDS
2602
2968
  };
2603
- //# sourceMappingURL=chunk-Z2RNBVEN.js.map
2969
+ //# sourceMappingURL=chunk-QJTSUFF2.js.map