-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
Copy pathtwilio.ts
1490 lines (1461 loc) · 51.2 KB
/
twilio.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* eslint-disable @withfig/fig-linter/no-useless-insertvalue */
/** A version of Fig.Subcommand with a predictable name prop */
interface TwilioSubcommand extends Fig.Subcommand {
name: string;
// Bad documentation is a bug. Descriptions are required.
description: string;
subcommands?: TwilioSubcommand[];
}
/** Recursively flatten subcommands by joining them with a separator */
function flattenSubcommands(
separator: string,
parents: TwilioSubcommand[],
subcommand: TwilioSubcommand
): TwilioSubcommand[] {
// If this subcommand has children, flatten it further.
if (subcommand.subcommands && subcommand.subcommands.length > 0) {
return subcommand.subcommands.flatMap((child) =>
flattenSubcommands(separator, parents.concat(subcommand), child)
);
}
// This subcommand has no children - join the name of all of its parent
// commands with the separator and set that as the new name.
const name = parents
.map(({ name }) => name)
.concat(subcommand.name)
.join(separator);
return [{ ...subcommand, name }];
}
/**
* Flatten the subcommands array as deep as possible to produce every "final"
* subcommand. These subcommands are hidden. Returns an object with these
* subcommands, and an optional argument with a generator to help build them.
*
* If `generatorShouldInsertSeparator` is true, intermediate suggestions (while
* building the full subcommand) will have their `insertValue` set to the name
* and separator.
*/
function createSeparatedSubcommandTree(
separator: string,
subcommands: TwilioSubcommand[],
options: {
generatorShouldInsertSeparator: boolean;
}
): { subcommands?: TwilioSubcommand[]; args: Fig.Arg } {
const flattened = subcommands.flatMap((subcommand) =>
flattenSubcommands(separator, [], subcommand)
);
// The generated options are only used for the option/argument suggestions so
// we don't have to reimplement the parser. They shouldn't be shown.
for (const subcommand of flattened) {
subcommand.hidden = true;
}
return {
subcommands: flattened,
args: {
name: "command",
isOptional: true,
generators: {
getQueryTerm: separator,
trigger: separator,
custom: async (tokens) => {
// We don't need the final "part" since that's what's being suggested
const parts = tokens[tokens.length - 1].split(separator).slice(0, -1);
let suggest: TwilioSubcommand[] = subcommands;
// Step through each part of the name, finding the relevant subcommand,
// and assign its subcommands to the `suggest` array.
for (const part of parts) {
const result = suggest.find((child) => child.name === part);
if (!result?.subcommands) return [];
suggest = result.subcommands;
}
return suggest.map((subcommand) => {
const suggestion: Fig.Suggestion = { ...subcommand };
suggestion.type ??= "subcommand";
suggestion.insertValue =
options.generatorShouldInsertSeparator && subcommand.subcommands
? subcommand.name + separator
: subcommand.insertValue;
return suggestion;
});
},
},
},
};
}
const logOption: Fig.Option = {
name: "-l",
args: {
name: "level",
description: "Level of logging messages",
default: "info",
suggestions: [
{ name: "debug", icon: "fig://icon?type=string" },
{ name: "info", icon: "fig://icon?type=string" },
{ name: "warn", icon: "fig://icon?type=string" },
{ name: "error", icon: "fig://icon?type=string" },
{ name: "none", icon: "fig://icon?type=string" },
],
},
};
const outputFormatOption: Fig.Option = {
name: "-o",
description: "Format of command output",
args: {
name: "format",
default: "columns",
suggestions: [
{ name: "columns", icon: "fig://icon?type=string" },
{ name: "json", icon: "fig://icon?type=string" },
{ name: "tsv", icon: "fig://icon?type=string" },
{ name: "none", icon: "fig://icon?type=string" },
],
},
};
const silentOption: Fig.Option = {
name: "--silent",
description:
'Suppress output and logs. This is a shorthand for "-l none -o none"',
};
// These options are on subcommands, not on the top level twilio CLI
const persistentOptions = [logOption, outputFormatOption, silentOption];
const configSubcommand: TwilioSubcommand = {
name: "config",
description: "Manage Twilio CLI configurations",
subcommands: [
{
name: "list",
description: "List Twilio CLI configurations",
options: persistentOptions,
},
{
name: "set",
description: "Update Twilio CLI configurations",
options: [
...persistentOptions,
{
name: ["-e", "--edge"],
description: "Sets an Edge configuration",
},
{
name: "--require-profile-input",
exclusiveOn: ["--no-require-profile-input"],
},
{
name: "--no-require-profile-input",
exclusiveOn: ["--require-profile-input"],
},
],
},
],
};
const debuggerSubcommand: TwilioSubcommand = {
name: "debugger",
description: "Show a list of log events for the account",
subcommands: [
{
name: "logs",
description: "Show a list of log events generated for the account",
subcommands: [
{
name: "list",
description: "Show a list of log events generated for the account",
},
],
},
],
};
const emailSubcommand: TwilioSubcommand = {
name: "email",
description:
"Send emails to single or multiple recipients using Twilio SendGrid",
subcommands: [
{
name: "send",
description: "Sends emails to single or multiple recipients",
options: [
...persistentOptions,
{
name: "--attachment",
description: "Path for the file that you want to attach",
args: {
name: "attachment",
template: "filepaths",
},
},
{
name: "--from",
description: "Email address of the sender",
args: {
name: "from",
},
},
{
name: "--no-attachment",
description: "Do not include or prompt for an attachment",
},
{
name: "--subject",
description: "The subject line for an email",
args: {
name: "subject",
},
},
{
name: "--text",
description: "Text to send within the email body",
args: {
name: "text",
},
},
{
name: "--to",
description: "Email address of recipient (comma-separated)",
args: {
name: "to",
},
},
],
},
{
name: "set",
description: "Sets a default sending email address and subject line",
options: [
...persistentOptions,
{
name: "--from",
description: "Email address of the sender",
args: {
name: "from",
},
},
{
name: "--subject",
description: "The subject line for an email",
args: {
name: "subject",
},
},
],
},
],
};
const feedbackSubcommand: TwilioSubcommand = {
name: "feedback",
description: "Provide feedback to the CLI team",
};
const phoneNumbersBuyOptions: Fig.Option[] = [
...persistentOptions,
{
name: "--country-code",
description:
"The ISO-3166-1 country code of the country from which to read phone numbers",
isRequired: true,
args: {
name: "country-code",
// https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
suggestions: [
{ name: "AD - Andorra", insertValue: "AD", icon: "🗺" },
{ name: "AE - United Arab Emirates", insertValue: "AE", icon: "🗺" },
{ name: "AF - Afghanistan", insertValue: "AF", icon: "🗺" },
{ name: "AG - Antigua and Barbuda", insertValue: "AG", icon: "🗺" },
{ name: "AI - Anguilla", insertValue: "AI", icon: "🗺" },
{ name: "AL - Albania", insertValue: "AL", icon: "🗺" },
{ name: "AM - Armenia", insertValue: "AM", icon: "🗺" },
{ name: "AO - Angola", insertValue: "AO", icon: "🗺" },
{ name: "AQ - Antarctica", insertValue: "AQ", icon: "🗺" },
{ name: "AR - Argentina", insertValue: "AR", icon: "🗺" },
{ name: "AS - American Samoa", insertValue: "AS", icon: "🗺" },
{ name: "AT - Austria", insertValue: "AT", icon: "🗺" },
{ name: "AU - Australia", insertValue: "AU", icon: "🗺" },
{ name: "AW - Aruba", insertValue: "AW", icon: "🗺" },
{ name: "AX - Åland Islands", insertValue: "AX", icon: "🗺" },
{ name: "AZ - Azerbaijan", insertValue: "AZ", icon: "🗺" },
{ name: "BA - Bosnia and Herzegovina", insertValue: "BA", icon: "🗺" },
{ name: "BB - Barbados", insertValue: "BB", icon: "🗺" },
{ name: "BD - Bangladesh", insertValue: "BD", icon: "🗺" },
{ name: "BE - Belgium", insertValue: "BE", icon: "🗺" },
{ name: "BF - Burkina Faso", insertValue: "BF", icon: "🗺" },
{ name: "BG - Bulgaria", insertValue: "BG", icon: "🗺" },
{ name: "BH - Bahrain", insertValue: "BH", icon: "🗺" },
{ name: "BI - Burundi", insertValue: "BI", icon: "🗺" },
{ name: "BJ - Benin", insertValue: "BJ", icon: "🗺" },
{ name: "BL - Saint Barthélemy", insertValue: "BL", icon: "🗺" },
{ name: "BM - Bermuda", insertValue: "BM", icon: "🗺" },
{ name: "BN - Brunei Darussalam", insertValue: "BN", icon: "🗺" },
{
name: "BO - Bolivia (Plurinational State of)",
insertValue: "BO",
icon: "🗺",
},
{
name: "BQ - Bonaire, Sint Eustatius and Saba",
insertValue: "BQ",
icon: "🗺",
},
{ name: "BR - Brazil", insertValue: "BR", icon: "🗺" },
{ name: "BS - Bahamas", insertValue: "BS", icon: "🗺" },
{ name: "BT - Bhutan", insertValue: "BT", icon: "🗺" },
{ name: "BV - Bouvet Island", insertValue: "BV", icon: "🗺" },
{ name: "BW - Botswana", insertValue: "BW", icon: "🗺" },
{ name: "BY - Belarus", insertValue: "BY", icon: "🗺" },
{ name: "BZ - Belize", insertValue: "BZ", icon: "🗺" },
{ name: "CA - Canada", insertValue: "CA", icon: "🗺" },
{ name: "CC - Cocos (Keeling) Islands", insertValue: "CC", icon: "🗺" },
{
name: "CD - Congo, Democratic Republic of the",
insertValue: "CD",
icon: "🗺",
},
{
name: "CF - Central African Republic",
insertValue: "CF",
icon: "🗺",
},
{ name: "CG - Congo", insertValue: "CG", icon: "🗺" },
{ name: "CH - Switzerland", insertValue: "CH", icon: "🗺" },
{ name: "CI - Côte d'Ivoire", insertValue: "CI", icon: "🗺" },
{ name: "CK - Cook Islands", insertValue: "CK", icon: "🗺" },
{ name: "CL - Chile", insertValue: "CL", icon: "🗺" },
{ name: "CM - Cameroon", insertValue: "CM", icon: "🗺" },
{ name: "CN - China", insertValue: "CN", icon: "🗺" },
{ name: "CO - Colombia", insertValue: "CO", icon: "🗺" },
{ name: "CR - Costa Rica", insertValue: "CR", icon: "🗺" },
{ name: "CU - Cuba", insertValue: "CU", icon: "🗺" },
{ name: "CV - Cabo Verde", insertValue: "CV", icon: "🗺" },
{ name: "CW - Curaçao", insertValue: "CW", icon: "🗺" },
{ name: "CX - Christmas Island", insertValue: "CX", icon: "🗺" },
{ name: "CY - Cyprus", insertValue: "CY", icon: "🗺" },
{ name: "CZ - Czechia", insertValue: "CZ", icon: "🗺" },
{ name: "DE - Germany", insertValue: "DE", icon: "🗺" },
{ name: "DJ - Djibouti", insertValue: "DJ", icon: "🗺" },
{ name: "DK - Denmark", insertValue: "DK", icon: "🗺" },
{ name: "DM - Dominica", insertValue: "DM", icon: "🗺" },
{ name: "DO - Dominican Republic", insertValue: "DO", icon: "🗺" },
{ name: "DZ - Algeria", insertValue: "DZ", icon: "🗺" },
{ name: "EC - Ecuador", insertValue: "EC", icon: "🗺" },
{ name: "EE - Estonia", insertValue: "EE", icon: "🗺" },
{ name: "EG - Egypt", insertValue: "EG", icon: "🗺" },
{ name: "EH - Western Sahara", insertValue: "EH", icon: "🗺" },
{ name: "ER - Eritrea", insertValue: "ER", icon: "🗺" },
{ name: "ES - Spain", insertValue: "ES", icon: "🗺" },
{ name: "ET - Ethiopia", insertValue: "ET", icon: "🗺" },
{ name: "FI - Finland", insertValue: "FI", icon: "🗺" },
{ name: "FJ - Fiji", insertValue: "FJ", icon: "🗺" },
{
name: "FK - Falkland Islands (Malvinas)",
insertValue: "FK",
icon: "🗺",
},
{
name: "FM - Micronesia (Federated States of)",
insertValue: "FM",
icon: "🗺",
},
{ name: "FO - Faroe Islands", insertValue: "FO", icon: "🗺" },
{ name: "FR - France", insertValue: "FR", icon: "🗺" },
{ name: "GA - Gabon", insertValue: "GA", icon: "🗺" },
{
name: "GB - United Kingdom of Great Britain and Northern Ireland",
insertValue: "GB",
icon: "🗺",
},
{ name: "GD - Grenada", insertValue: "GD", icon: "🗺" },
{ name: "GE - Georgia", insertValue: "GE", icon: "🗺" },
{ name: "GF - French Guiana", insertValue: "GF", icon: "🗺" },
{ name: "GG - Guernsey", insertValue: "GG", icon: "🗺" },
{ name: "GH - Ghana", insertValue: "GH", icon: "🗺" },
{ name: "GI - Gibraltar", insertValue: "GI", icon: "🗺" },
{ name: "GL - Greenland", insertValue: "GL", icon: "🗺" },
{ name: "GM - Gambia", insertValue: "GM", icon: "🗺" },
{ name: "GN - Guinea", insertValue: "GN", icon: "🗺" },
{ name: "GP - Guadeloupe", insertValue: "GP", icon: "🗺" },
{ name: "GQ - Equatorial Guinea", insertValue: "GQ", icon: "🗺" },
{ name: "GR - Greece", insertValue: "GR", icon: "🗺" },
{
name: "GS - South Georgia and the South Sandwich Islands",
insertValue: "GS",
icon: "🗺",
},
{ name: "GT - Guatemala", insertValue: "GT", icon: "🗺" },
{ name: "GU - Guam", insertValue: "GU", icon: "🗺" },
{ name: "GW - Guinea-Bissau", insertValue: "GW", icon: "🗺" },
{ name: "GY - Guyana", insertValue: "GY", icon: "🗺" },
{ name: "HK - Hong Kong", insertValue: "HK", icon: "🗺" },
{
name: "HM - Heard Island and McDonald Islands",
insertValue: "HM",
icon: "🗺",
},
{ name: "HN - Honduras", insertValue: "HN", icon: "🗺" },
{ name: "HR - Croatia", insertValue: "HR", icon: "🗺" },
{ name: "HT - Haiti", insertValue: "HT", icon: "🗺" },
{ name: "HU - Hungary", insertValue: "HU", icon: "🗺" },
{ name: "ID - Indonesia", insertValue: "ID", icon: "🗺" },
{ name: "IE - Ireland", insertValue: "IE", icon: "🗺" },
{ name: "IL - Israel", insertValue: "IL", icon: "🗺" },
{ name: "IM - Isle of Man", insertValue: "IM", icon: "🗺" },
{ name: "IN - India", insertValue: "IN", icon: "🗺" },
{
name: "IO - British Indian Ocean Territory",
insertValue: "IO",
icon: "🗺",
},
{ name: "IQ - Iraq", insertValue: "IQ", icon: "🗺" },
{
name: "IR - Iran (Islamic Republic of)",
insertValue: "IR",
icon: "🗺",
},
{ name: "IS - Iceland", insertValue: "IS", icon: "🗺" },
{ name: "IT - Italy", insertValue: "IT", icon: "🗺" },
{ name: "JE - Jersey", insertValue: "JE", icon: "🗺" },
{ name: "JM - Jamaica", insertValue: "JM", icon: "🗺" },
{ name: "JO - Jordan", insertValue: "JO", icon: "🗺" },
{ name: "JP - Japan", insertValue: "JP", icon: "🗺" },
{ name: "KE - Kenya", insertValue: "KE", icon: "🗺" },
{ name: "KG - Kyrgyzstan", insertValue: "KG", icon: "🗺" },
{ name: "KH - Cambodia", insertValue: "KH", icon: "🗺" },
{ name: "KI - Kiribati", insertValue: "KI", icon: "🗺" },
{ name: "KM - Comoros", insertValue: "KM", icon: "🗺" },
{ name: "KN - Saint Kitts and Nevis", insertValue: "KN", icon: "🗺" },
{
name: "KP - Korea (Democratic People's Republic of)",
insertValue: "KP",
icon: "🗺",
},
{ name: "KR - Korea, Republic of", insertValue: "KR", icon: "🗺" },
{ name: "KW - Kuwait", insertValue: "KW", icon: "🗺" },
{ name: "KY - Cayman Islands", insertValue: "KY", icon: "🗺" },
{ name: "KZ - Kazakhstan", insertValue: "KZ", icon: "🗺" },
{
name: "LA - Lao People's Democratic Republic",
insertValue: "LA",
icon: "🗺",
},
{ name: "LB - Lebanon", insertValue: "LB", icon: "🗺" },
{ name: "LC - Saint Lucia", insertValue: "LC", icon: "🗺" },
{ name: "LI - Liechtenstein", insertValue: "LI", icon: "🗺" },
{ name: "LK - Sri Lanka", insertValue: "LK", icon: "🗺" },
{ name: "LR - Liberia", insertValue: "LR", icon: "🗺" },
{ name: "LS - Lesotho", insertValue: "LS", icon: "🗺" },
{ name: "LT - Lithuania", insertValue: "LT", icon: "🗺" },
{ name: "LU - Luxembourg", insertValue: "LU", icon: "🗺" },
{ name: "LV - Latvia", insertValue: "LV", icon: "🗺" },
{ name: "LY - Libya", insertValue: "LY", icon: "🗺" },
{ name: "MA - Morocco", insertValue: "MA", icon: "🗺" },
{ name: "MC - Monaco", insertValue: "MC", icon: "🗺" },
{ name: "MD - Moldova, Republic of", insertValue: "MD", icon: "🗺" },
{ name: "ME - Montenegro", insertValue: "ME", icon: "🗺" },
{
name: "MF - Saint Martin (French part)",
insertValue: "MF",
icon: "🗺",
},
{ name: "MG - Madagascar", insertValue: "MG", icon: "🗺" },
{ name: "MH - Marshall Islands", insertValue: "MH", icon: "🗺" },
{ name: "MK - North Macedonia", insertValue: "MK", icon: "🗺" },
{ name: "ML - Mali", insertValue: "ML", icon: "🗺" },
{ name: "MM - Myanmar", insertValue: "MM", icon: "🗺" },
{ name: "MN - Mongolia", insertValue: "MN", icon: "🗺" },
{ name: "MO - Macao", insertValue: "MO", icon: "🗺" },
{
name: "MP - Northern Mariana Islands",
insertValue: "MP",
icon: "🗺",
},
{ name: "MQ - Martinique", insertValue: "MQ", icon: "🗺" },
{ name: "MR - Mauritania", insertValue: "MR", icon: "🗺" },
{ name: "MS - Montserrat", insertValue: "MS", icon: "🗺" },
{ name: "MT - Malta", insertValue: "MT", icon: "🗺" },
{ name: "MU - Mauritius", insertValue: "MU", icon: "🗺" },
{ name: "MV - Maldives", insertValue: "MV", icon: "🗺" },
{ name: "MW - Malawi", insertValue: "MW", icon: "🗺" },
{ name: "MX - Mexico", insertValue: "MX", icon: "🗺" },
{ name: "MY - Malaysia", insertValue: "MY", icon: "🗺" },
{ name: "MZ - Mozambique", insertValue: "MZ", icon: "🗺" },
{ name: "NA - Namibia", insertValue: "NA", icon: "🗺" },
{ name: "NC - New Caledonia", insertValue: "NC", icon: "🗺" },
{ name: "NE - Niger", insertValue: "NE", icon: "🗺" },
{ name: "NF - Norfolk Island", insertValue: "NF", icon: "🗺" },
{ name: "NG - Nigeria", insertValue: "NG", icon: "🗺" },
{ name: "NI - Nicaragua", insertValue: "NI", icon: "🗺" },
{ name: "NL - Netherlands", insertValue: "NL", icon: "🗺" },
{ name: "NO - Norway", insertValue: "NO", icon: "🗺" },
{ name: "NP - Nepal", insertValue: "NP", icon: "🗺" },
{ name: "NR - Nauru", insertValue: "NR", icon: "🗺" },
{ name: "NU - Niue", insertValue: "NU", icon: "🗺" },
{ name: "NZ - New Zealand", insertValue: "NZ", icon: "🗺" },
{ name: "OM - Oman", insertValue: "OM", icon: "🗺" },
{ name: "PA - Panama", insertValue: "PA", icon: "🗺" },
{ name: "PE - Peru", insertValue: "PE", icon: "🗺" },
{ name: "PF - French Polynesia", insertValue: "PF", icon: "🗺" },
{ name: "PG - Papua New Guinea", insertValue: "PG", icon: "🗺" },
{ name: "PH - Philippines", insertValue: "PH", icon: "🗺" },
{ name: "PK - Pakistan", insertValue: "PK", icon: "🗺" },
{ name: "PL - Poland", insertValue: "PL", icon: "🗺" },
{
name: "PM - Saint Pierre and Miquelon",
insertValue: "PM",
icon: "🗺",
},
{ name: "PN - Pitcairn", insertValue: "PN", icon: "🗺" },
{ name: "PR - Puerto Rico", insertValue: "PR", icon: "🗺" },
{ name: "PS - Palestine, State of", insertValue: "PS", icon: "🗺" },
{ name: "PT - Portugal", insertValue: "PT", icon: "🗺" },
{ name: "PW - Palau", insertValue: "PW", icon: "🗺" },
{ name: "PY - Paraguay", insertValue: "PY", icon: "🗺" },
{ name: "QA - Qatar", insertValue: "QA", icon: "🗺" },
{ name: "RE - Réunion", insertValue: "RE", icon: "🗺" },
{ name: "RO - Romania", insertValue: "RO", icon: "🗺" },
{ name: "RS - Serbia", insertValue: "RS", icon: "🗺" },
{ name: "RU - Russian Federation", insertValue: "RU", icon: "🗺" },
{ name: "RW - Rwanda", insertValue: "RW", icon: "🗺" },
{ name: "SA - Saudi Arabia", insertValue: "SA", icon: "🗺" },
{ name: "SB - Solomon Islands", insertValue: "SB", icon: "🗺" },
{ name: "SC - Seychelles", insertValue: "SC", icon: "🗺" },
{ name: "SD - Sudan", insertValue: "SD", icon: "🗺" },
{ name: "SE - Sweden", insertValue: "SE", icon: "🗺" },
{ name: "SG - Singapore", insertValue: "SG", icon: "🗺" },
{
name: "SH - Saint Helena, Ascension and Tristan da Cunha",
insertValue: "SH",
icon: "🗺",
},
{ name: "SI - Slovenia", insertValue: "SI", icon: "🗺" },
{ name: "SJ - Svalbard and Jan Mayen", insertValue: "SJ", icon: "🗺" },
{ name: "SK - Slovakia", insertValue: "SK", icon: "🗺" },
{ name: "SL - Sierra Leone", insertValue: "SL", icon: "🗺" },
{ name: "SM - San Marino", insertValue: "SM", icon: "🗺" },
{ name: "SN - Senegal", insertValue: "SN", icon: "🗺" },
{ name: "SO - Somalia", insertValue: "SO", icon: "🗺" },
{ name: "SR - Suriname", insertValue: "SR", icon: "🗺" },
{ name: "SS - South Sudan", insertValue: "SS", icon: "🗺" },
{ name: "ST - Sao Tome and Principe", insertValue: "ST", icon: "🗺" },
{ name: "SV - El Salvador", insertValue: "SV", icon: "🗺" },
{
name: "SX - Sint Maarten (Dutch part)",
insertValue: "SX",
icon: "🗺",
},
{ name: "SY - Syrian Arab Republic", insertValue: "SY", icon: "🗺" },
{ name: "SZ - Eswatini", insertValue: "SZ", icon: "🗺" },
{
name: "TC - Turks and Caicos Islands",
insertValue: "TC",
icon: "🗺",
},
{ name: "TD - Chad", insertValue: "TD", icon: "🗺" },
{
name: "TF - French Southern Territories",
insertValue: "TF",
icon: "🗺",
},
{ name: "TG - Togo", insertValue: "TG", icon: "🗺" },
{ name: "TH - Thailand", insertValue: "TH", icon: "🗺" },
{ name: "TJ - Tajikistan", insertValue: "TJ", icon: "🗺" },
{ name: "TK - Tokelau", insertValue: "TK", icon: "🗺" },
{ name: "TL - Timor-Leste", insertValue: "TL", icon: "🗺" },
{ name: "TM - Turkmenistan", insertValue: "TM", icon: "🗺" },
{ name: "TN - Tunisia", insertValue: "TN", icon: "🗺" },
{ name: "TO - Tonga", insertValue: "TO", icon: "🗺" },
{ name: "TR - Turkey", insertValue: "TR", icon: "🗺" },
{ name: "TT - Trinidad and Tobago", insertValue: "TT", icon: "🗺" },
{ name: "TV - Tuvalu", insertValue: "TV", icon: "🗺" },
{
name: "TW - Taiwan, Province of China",
insertValue: "TW",
icon: "🗺",
},
{
name: "TZ - Tanzania, United Republic of",
insertValue: "TZ",
icon: "🗺",
},
{ name: "UA - Ukraine", insertValue: "UA", icon: "🗺" },
{ name: "UG - Uganda", insertValue: "UG", icon: "🗺" },
{
name: "UM - United States Minor Outlying Islands",
insertValue: "UM",
icon: "🗺",
},
{
name: "US - United States of America",
insertValue: "US",
icon: "🗺",
},
{ name: "UY - Uruguay", insertValue: "UY", icon: "🗺" },
{ name: "UZ - Uzbekistan", insertValue: "UZ", icon: "🗺" },
{ name: "VA - Holy See", insertValue: "VA", icon: "🗺" },
{
name: "VC - Saint Vincent and the Grenadines",
insertValue: "VC",
icon: "🗺",
},
{
name: "VE - Venezuela (Bolivarian Republic of)",
insertValue: "VE",
icon: "🗺",
},
{
name: "VG - Virgin Islands (British)",
insertValue: "VG",
icon: "🗺",
},
{ name: "VI - Virgin Islands (U.S.)", insertValue: "VI", icon: "🗺" },
{ name: "VN - Viet Nam", insertValue: "VN", icon: "🗺" },
{ name: "VU - Vanuatu", insertValue: "VU", icon: "🗺" },
{ name: "WF - Wallis and Futuna", insertValue: "WF", icon: "🗺" },
{ name: "WS - Samoa", insertValue: "WS", icon: "🗺" },
{ name: "YE - Yemen", insertValue: "YE", icon: "🗺" },
{ name: "YT - Mayotte", insertValue: "YT", icon: "🗺" },
{ name: "ZA - South Africa", insertValue: "ZA", icon: "🗺" },
{ name: "ZM - Zambia", insertValue: "ZM", icon: "🗺" },
],
},
},
{
name: "--account-sid",
description:
"The SID of the Account requesting the AvailablePhoneNumber resources",
args: {
name: "account-sid",
},
},
{
name: "--address-sid",
description:
"The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations",
args: {
name: "address-sid",
},
},
{
name: "--api-version",
description:
"The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`",
args: {
name: "api-version",
},
},
{
name: "--area-code",
description:
"The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada",
args: {
name: "area-code",
},
},
{
name: "--beta",
description:
"Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`",
exclusiveOn: ["--no-beta"],
},
{
name: "--no-beta",
description:
"Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`",
exclusiveOn: ["--beta"],
},
{
name: "--bundle-sid",
description:
"The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations",
args: {
name: "bundle-sid",
},
},
{
name: "--contains",
description:
"The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters",
args: {
name: "contains",
},
},
{
name: "--distance",
description:
"The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada",
args: {
name: "distance",
},
},
{
name: "--emergency-address-sid",
description:
"The SID of the emergency address configuration to use for emergency calling from the new phone number",
args: {
name: "emergency-address-sid",
},
},
{
name: "--emergency-status",
description:
"The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country",
args: {
name: "status",
suggestions: [
{ name: "active", icon: "fig://icon?type=string" },
{ name: "inactive", icon: "fig://icon?type=string" },
],
},
},
{
name: "--exclude-all-address-required",
description:
"Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`",
exclusiveOn: ["--no-exclude-all-address-required"],
},
{
name: "--no-exclude-all-address-required",
description:
"Whether to exclude phone numbers that require an Address. Can be: `true` or `false` and the default is `false`",
exclusiveOn: ["--exclude-all-address-required"],
},
{
name: "--exclude-foreign-address-required",
description:
"Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`",
exclusiveOn: ["--no-exclude-foreign-address-required"],
},
{
name: "--no-exclude-foreign-address-required",
description:
"Whether to exclude phone numbers that require a foreign Address. Can be: `true` or `false` and the default is `false`",
exclusiveOn: ["--exclude-foreign-address-required"],
},
{
name: "--exclude-local-address-required",
description:
"Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`",
exclusiveOn: ["--no-exclude-local-address-required"],
},
{
name: "--no-exclude-local-address-required",
description:
"Whether to exclude phone numbers that require a local Address. Can be: `true` or `false` and the default is `false`",
exclusiveOn: ["--exclude-local-address-required"],
},
{
name: "--fax-enabled",
description:
"Whether the phone numbers can receive faxes. Can be: `true` or `false`",
exclusiveOn: ["--no-fax-enabled"],
},
{
name: "--no-fax-enabled",
description:
"Whether the phone numbers can receive faxes. Can be: `true` or `false`",
exclusiveOn: ["--fax-enabled"],
},
{
name: "--friendly-name",
description:
"A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number",
args: {
name: "friendly-name",
},
},
{
name: "--identity-sid",
description:
"The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations",
args: {
name: "identity-sid",
},
},
{
name: "--in-lata",
description:
"Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada",
args: {
name: "in-lata",
},
},
{
name: "--in-locality",
description:
"Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number",
args: {
name: "in-locality",
},
},
{
name: "--in-postal-code",
description:
"Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada",
args: {
name: "in-postal-code",
},
},
{
name: "--in-rate-center",
description:
"Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada",
args: {
name: "in-rate-center",
},
},
{
name: "--in-region",
description:
"Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada",
args: {
name: "in-region",
},
},
{
name: "--limit",
description:
"The maximum number of resources to return. Use '--no-limit' to disable",
args: {
default: "50",
name: "limit",
},
},
{
name: "--mms-enabled",
description:
"Whether the phone numbers can receive MMS messages. Can be: `true` or `false`",
exclusiveOn: ["--no-mms-enabled"],
},
{
name: "--no-mms-enabled",
description:
"Whether the phone numbers can receive MMS messages. Can be: `true` or `false`",
exclusiveOn: ["--mms-enabled"],
},
{
name: "--near-lat-long",
description:
"Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada",
args: {
name: "near-lat-long",
},
},
{
name: "--near-number",
description:
"Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada",
args: {
name: "near-number",
},
},
{
name: "--no-header",
description: "Skip including of headers while listing the data",
},
{
name: "--page-size",
description:
"How many resources to return in each list page. The default is 50, and the maximum is 1000",
args: {
name: "page-size",
},
},
{
name: "--properties",
description:
"The properties you would like to display (JSON output always shows all properties)",
args: {
default: "phoneNumber, region, isoCountry, addressRequirements",
name: "properties",
},
},
{
name: "--sms-application-sid",
description:
"The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application",
args: {
name: "sms-application-sid",
},
},
{
name: "--sms-enabled",
description:
"Whether the phone numbers can receive text messages. Can be: `true` or `false`",
exclusiveOn: ["--no-sms-enabled"],
},
{
name: "--no-sms-enabled",
description:
"Whether the phone numbers can receive text messages. Can be: `true` or `false`",
exclusiveOn: ["--sms-enabled"],
},
{
name: "--sms-fallback-method",
description:
"The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`",
args: {
name: "method",
suggestions: [
{ name: "head", icon: "fig://icon?type=string" },
{ name: "get", icon: "fig://icon?type=string" },
{ name: "post", icon: "fig://icon?type=string" },
{ name: "patch", icon: "fig://icon?type=string" },
{ name: "put", icon: "fig://icon?type=string" },
{ name: "delete", icon: "fig://icon?type=string" },
],
},
},
{
name: "--sms-fallback-url",
description:
"The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`",
args: {
name: "sms-fallback-url",
},
},
{
name: "--sms-method",
description:
"The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`",
args: {
name: "method",
suggestions: [
{ name: "head", icon: "fig://icon?type=string" },
{ name: "get", icon: "fig://icon?type=string" },
{ name: "post", icon: "fig://icon?type=string" },
{ name: "patch", icon: "fig://icon?type=string" },
{ name: "put", icon: "fig://icon?type=string" },
{ name: "delete", icon: "fig://icon?type=string" },
],
},
},
{
name: "--sms-url",
description:
"The URL we should call when the new phone number receives an incoming SMS message",
args: {
name: "sms-url",
},
},
{
name: "--status-callback",
description:
"The URL we should call using the `status_callback_method` to send status information to your application",
args: {
name: "status-callback",
},
},
{
name: "--status-callback-method",
description:
"The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`",
args: {
name: "method",
suggestions: [
{ name: "head", icon: "fig://icon?type=string" },
{ name: "get", icon: "fig://icon?type=string" },
{ name: "post", icon: "fig://icon?type=string" },
{ name: "patch", icon: "fig://icon?type=string" },
{ name: "put", icon: "fig://icon?type=string" },
{ name: "delete", icon: "fig://icon?type=string" },
],
},
},
{
name: "--trunk-sid",
description:
"The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa",
args: {
name: "trunk-sid",
},
},
{
name: "--voice-application-sid",
description:
"The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa",
args: {
name: "voice-application-sid",
},
},
{
name: "--voice-caller-id-lookup",
description:
"Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`",
exclusiveOn: ["--no-voice-caller-id-lookup"],
},
{