twilio-taskrouter 0.8.2 → 0.8.4

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.
@@ -30,14 +30,21 @@
30
30
  <li class="dropdown">
31
31
  <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
32
32
  <ul class="dropdown-menu ">
33
- <li><a href="Activity.html">Activity</a></li><li><a href="Channel.html">Channel</a></li><li><a href="IncomingTransfer.html">IncomingTransfer</a></li><li><a href="OutgoingTransfer.html">OutgoingTransfer</a></li><li><a href="Reservation.html">Reservation</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskQueue.html">TaskQueue</a></li><li><a href="Transfers.html">Transfers</a></li><li><a href="Worker.html">Worker</a></li><li><a href="Workspace.html">Workspace</a></li>
33
+ <li><a href="Activity.html">Activity</a></li><li><a href="Channel.html">Channel</a></li><li><a href="IncomingTransfer.html">IncomingTransfer</a></li><li><a href="OutgoingTransfer.html">OutgoingTransfer</a></li><li><a href="Reservation.html">Reservation</a></li><li><a href="Supervisor.html">Supervisor</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskQueue.html">TaskQueue</a></li><li><a href="Transfers.html">Transfers</a></li><li><a href="Worker.html">Worker</a></li><li><a href="Workspace.html">Workspace</a></li>
34
34
  </ul>
35
35
  </li>
36
36
 
37
37
  <li class="dropdown">
38
38
  <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
39
39
  <ul class="dropdown-menu ">
40
- <li><a href="Channel.html#event:availabilityUpdated">Channel#event:availabilityUpdated</a></li><li><a href="Channel.html#event:capacityUpdated">Channel#event:capacityUpdated</a></li><li><a href="OutgoingTransfer.html#event:attemptFailed">OutgoingTransfer#event:attemptFailed</a></li><li><a href="OutgoingTransfer.html#event:canceled">OutgoingTransfer#event:canceled</a></li><li><a href="OutgoingTransfer.html#event:completed">OutgoingTransfer#event:completed</a></li><li><a href="OutgoingTransfer.html#event:failed">OutgoingTransfer#event:failed</a></li><li><a href="Reservation.html#event:accepted">Reservation#event:accepted</a></li><li><a href="Reservation.html#event:canceled">Reservation#event:canceled</a></li><li><a href="Reservation.html#event:completed">Reservation#event:completed</a></li><li><a href="Reservation.html#event:rejected">Reservation#event:rejected</a></li><li><a href="Reservation.html#event:rescinded">Reservation#event:rescinded</a></li><li><a href="Reservation.html#event:timeout">Reservation#event:timeout</a></li><li><a href="Reservation.html#event:wrapup">Reservation#event:wrapup</a></li><li><a href="Task.html#event:canceled">Task#event:canceled</a></li><li><a href="Task.html#event:completed">Task#event:completed</a></li><li><a href="Task.html#event:transferInitiated">Task#event:transferInitiated</a></li><li><a href="Task.html#event:updated">Task#event:updated</a></li><li><a href="Task.html#event:wrapup">Task#event:wrapup</a></li><li><a href="Worker.html#event:activityUpdated">Worker#event:activityUpdated</a></li><li><a href="Worker.html#event:attributesUpdated">Worker#event:attributesUpdated</a></li><li><a href="Worker.html#event:disconnected">Worker#event:disconnected</a></li><li><a href="Worker.html#event:error">Worker#event:error</a></li><li><a href="Worker.html#event:ready">Worker#event:ready</a></li><li><a href="Worker.html#event:reservationCreated">Worker#event:reservationCreated</a></li><li><a href="Worker.html#event:reservationFailed">Worker#event:reservationFailed</a></li><li><a href="Worker.html#event:tokenExpired">Worker#event:tokenExpired</a></li><li><a href="Worker.html#event:tokenUpdated">Worker#event:tokenUpdated</a></li>
40
+ <li><a href="Channel.html#event:availabilityUpdated">Channel#event:availabilityUpdated</a></li><li><a href="Channel.html#event:capacityUpdated">Channel#event:capacityUpdated</a></li><li><a href="OutgoingTransfer.html#event:attemptFailed">OutgoingTransfer#event:attemptFailed</a></li><li><a href="OutgoingTransfer.html#event:canceled">OutgoingTransfer#event:canceled</a></li><li><a href="OutgoingTransfer.html#event:completed">OutgoingTransfer#event:completed</a></li><li><a href="OutgoingTransfer.html#event:failed">OutgoingTransfer#event:failed</a></li><li><a href="Reservation.html#event:accepted">Reservation#event:accepted</a></li><li><a href="Reservation.html#event:canceled">Reservation#event:canceled</a></li><li><a href="Reservation.html#event:completed">Reservation#event:completed</a></li><li><a href="Reservation.html#event:rejected">Reservation#event:rejected</a></li><li><a href="Reservation.html#event:rescinded">Reservation#event:rescinded</a></li><li><a href="Reservation.html#event:timeout">Reservation#event:timeout</a></li><li><a href="Reservation.html#event:wrapup">Reservation#event:wrapup</a></li><li><a href="Supervisor.html#event:activityUpdated">Supervisor#event:activityUpdated</a></li><li><a href="Supervisor.html#event:attributesUpdated">Supervisor#event:attributesUpdated</a></li><li><a href="Supervisor.html#event:disconnected">Supervisor#event:disconnected</a></li><li><a href="Supervisor.html#event:error">Supervisor#event:error</a></li><li><a href="Supervisor.html#event:monitor">Supervisor#event:monitor</a></li><li><a href="Supervisor.html#event:ready">Supervisor#event:ready</a></li><li><a href="Supervisor.html#event:reservationCreated">Supervisor#event:reservationCreated</a></li><li><a href="Supervisor.html#event:reservationFailed">Supervisor#event:reservationFailed</a></li><li><a href="Supervisor.html#event:tokenExpired">Supervisor#event:tokenExpired</a></li><li><a href="Supervisor.html#event:tokenUpdated">Supervisor#event:tokenUpdated</a></li><li><a href="Task.html#event:canceled">Task#event:canceled</a></li><li><a href="Task.html#event:completed">Task#event:completed</a></li><li><a href="Task.html#event:transferAttemptFailed">Task#event:transferAttemptFailed</a></li><li><a href="Task.html#event:transferCanceled">Task#event:transferCanceled</a></li><li><a href="Task.html#event:transferCompleted">Task#event:transferCompleted</a></li><li><a href="Task.html#event:transferFailed">Task#event:transferFailed</a></li><li><a href="Task.html#event:transferInitiated">Task#event:transferInitiated</a></li><li><a href="Task.html#event:updated">Task#event:updated</a></li><li><a href="Task.html#event:wrapup">Task#event:wrapup</a></li><li><a href="Worker.html#event:activityUpdated">Worker#event:activityUpdated</a></li><li><a href="Worker.html#event:attributesUpdated">Worker#event:attributesUpdated</a></li><li><a href="Worker.html#event:disconnected">Worker#event:disconnected</a></li><li><a href="Worker.html#event:error">Worker#event:error</a></li><li><a href="Worker.html#event:ready">Worker#event:ready</a></li><li><a href="Worker.html#event:reservationCreated">Worker#event:reservationCreated</a></li><li><a href="Worker.html#event:reservationFailed">Worker#event:reservationFailed</a></li><li><a href="Worker.html#event:tokenExpired">Worker#event:tokenExpired</a></li><li><a href="Worker.html#event:tokenUpdated">Worker#event:tokenUpdated</a></li>
41
+ </ul>
42
+ </li>
43
+
44
+ <li class="dropdown">
45
+ <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
46
+ <ul class="dropdown-menu ">
47
+ <li><a href="global.html">Global</a></li>
41
48
  </ul>
42
49
  </li>
43
50
 
@@ -171,7 +178,7 @@
171
178
  <td class="type">
172
179
 
173
180
 
174
- <span class="param-type">int</span>
181
+ <span class="param-type">number</span>
175
182
 
176
183
 
177
184
 
@@ -219,7 +226,7 @@
219
226
  <td class="type">
220
227
 
221
228
 
222
- <span class="param-type">int</span>
229
+ <span class="param-type">number</span>
223
230
 
224
231
 
225
232
 
@@ -244,7 +251,7 @@
244
251
  <td class="type">
245
252
 
246
253
 
247
- <span class="param-type">int</span>
254
+ <span class="param-type">number</span>
248
255
 
249
256
 
250
257
 
@@ -519,6 +526,265 @@
519
526
  </div>
520
527
 
521
528
 
529
+ <h3 class="subsection-title">Extends</h3>
530
+
531
+
532
+
533
+
534
+ <ul>
535
+ <li>EventEmitter</li>
536
+ </ul>
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+ <h3 class="subsection-title">Members</h3>
551
+
552
+ <dl>
553
+
554
+ <hr>
555
+ <dt class="name" id="accountSid">
556
+ <h4 id="accountSid"><span class="type-signature">&lt;readonly&gt; </span>accountSid<span class="type-signature"> :string</span></h4>
557
+
558
+
559
+ </dt>
560
+ <dd>
561
+
562
+
563
+
564
+ <h5>Type:</h5>
565
+ <ul>
566
+ <li>
567
+
568
+ <span class="param-type">string</span>
569
+
570
+
571
+
572
+ </li>
573
+ </ul>
574
+
575
+
576
+
577
+ <dl class="details">
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
+ </dl>
614
+
615
+
616
+
617
+ </dd>
618
+
619
+
620
+
621
+ <hr>
622
+ <dt class="name" id="assignedTasks">
623
+ <h4 id="assignedTasks"><span class="type-signature">&lt;readonly&gt; </span>assignedTasks<span class="type-signature"> :number</span></h4>
624
+
625
+
626
+ </dt>
627
+ <dd>
628
+
629
+
630
+
631
+ <h5>Type:</h5>
632
+ <ul>
633
+ <li>
634
+
635
+ <span class="param-type">number</span>
636
+
637
+
638
+
639
+ </li>
640
+ </ul>
641
+
642
+
643
+
644
+ <dl class="details">
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
+ </dl>
681
+
682
+
683
+
684
+ </dd>
685
+
686
+
687
+
688
+ <hr>
689
+ <dt class="name" id="available">
690
+ <h4 id="available"><span class="type-signature">&lt;readonly&gt; </span>available<span class="type-signature"> :boolean</span></h4>
691
+
692
+
693
+ </dt>
694
+ <dd>
695
+
696
+
697
+
698
+ <h5>Type:</h5>
699
+ <ul>
700
+ <li>
701
+
702
+ <span class="param-type">boolean</span>
703
+
704
+
705
+
706
+ </li>
707
+ </ul>
708
+
709
+
710
+
711
+ <dl class="details">
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
+ </dl>
748
+
749
+
750
+
751
+ </dd>
752
+
753
+
754
+
755
+ <hr>
756
+ <dt class="name" id="availableCapacityPercentage">
757
+ <h4 id="availableCapacityPercentage"><span class="type-signature">&lt;readonly&gt; </span>availableCapacityPercentage<span class="type-signature"> :number</span></h4>
758
+
759
+
760
+ </dt>
761
+ <dd>
762
+
763
+
764
+
765
+ <h5>Type:</h5>
766
+ <ul>
767
+ <li>
768
+
769
+ <span class="param-type">number</span>
770
+
771
+
772
+
773
+ </li>
774
+ </ul>
775
+
776
+
777
+
778
+ <dl class="details">
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+
522
788
 
523
789
 
524
790
 
@@ -526,8 +792,635 @@
526
792
 
527
793
 
528
794
 
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+ </dl>
815
+
816
+
529
817
 
818
+ </dd>
530
819
 
820
+
821
+
822
+ <hr>
823
+ <dt class="name" id="capacity">
824
+ <h4 id="capacity"><span class="type-signature">&lt;readonly&gt; </span>capacity<span class="type-signature"> :number</span></h4>
825
+
826
+
827
+ </dt>
828
+ <dd>
829
+
830
+
831
+
832
+ <h5>Type:</h5>
833
+ <ul>
834
+ <li>
835
+
836
+ <span class="param-type">number</span>
837
+
838
+
839
+
840
+ </li>
841
+ </ul>
842
+
843
+
844
+
845
+ <dl class="details">
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
+ </dl>
882
+
883
+
884
+
885
+ </dd>
886
+
887
+
888
+
889
+ <hr>
890
+ <dt class="name" id="dateCreated">
891
+ <h4 id="dateCreated"><span class="type-signature">&lt;readonly&gt; </span>dateCreated<span class="type-signature"> :Date</span></h4>
892
+
893
+
894
+ </dt>
895
+ <dd>
896
+
897
+
898
+
899
+ <h5>Type:</h5>
900
+ <ul>
901
+ <li>
902
+
903
+ <span class="param-type">Date</span>
904
+
905
+
906
+
907
+ </li>
908
+ </ul>
909
+
910
+
911
+
912
+ <dl class="details">
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
+ </dl>
949
+
950
+
951
+
952
+ </dd>
953
+
954
+
955
+
956
+ <hr>
957
+ <dt class="name" id="dateUpdated">
958
+ <h4 id="dateUpdated"><span class="type-signature">&lt;readonly&gt; </span>dateUpdated<span class="type-signature"> :Date</span></h4>
959
+
960
+
961
+ </dt>
962
+ <dd>
963
+
964
+
965
+
966
+ <h5>Type:</h5>
967
+ <ul>
968
+ <li>
969
+
970
+ <span class="param-type">Date</span>
971
+
972
+
973
+
974
+ </li>
975
+ </ul>
976
+
977
+
978
+
979
+ <dl class="details">
980
+
981
+
982
+
983
+
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+ </dl>
1016
+
1017
+
1018
+
1019
+ </dd>
1020
+
1021
+
1022
+
1023
+ <hr>
1024
+ <dt class="name" id="lastReservedTime">
1025
+ <h4 id="lastReservedTime"><span class="type-signature">&lt;readonly&gt; </span>lastReservedTime<span class="type-signature"> :Date</span></h4>
1026
+
1027
+
1028
+ </dt>
1029
+ <dd>
1030
+
1031
+
1032
+
1033
+ <h5>Type:</h5>
1034
+ <ul>
1035
+ <li>
1036
+
1037
+ <span class="param-type">Date</span>
1038
+
1039
+
1040
+
1041
+ </li>
1042
+ </ul>
1043
+
1044
+
1045
+
1046
+ <dl class="details">
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+ </dl>
1083
+
1084
+
1085
+
1086
+ </dd>
1087
+
1088
+
1089
+
1090
+ <hr>
1091
+ <dt class="name" id="sid">
1092
+ <h4 id="sid"><span class="type-signature">&lt;readonly&gt; </span>sid<span class="type-signature"> :string</span></h4>
1093
+
1094
+
1095
+ </dt>
1096
+ <dd>
1097
+
1098
+
1099
+
1100
+ <h5>Type:</h5>
1101
+ <ul>
1102
+ <li>
1103
+
1104
+ <span class="param-type">string</span>
1105
+
1106
+
1107
+
1108
+ </li>
1109
+ </ul>
1110
+
1111
+
1112
+
1113
+ <dl class="details">
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+ </dl>
1150
+
1151
+
1152
+
1153
+ </dd>
1154
+
1155
+
1156
+
1157
+ <hr>
1158
+ <dt class="name" id="taskChannelSid">
1159
+ <h4 id="taskChannelSid"><span class="type-signature">&lt;readonly&gt; </span>taskChannelSid<span class="type-signature"> :string</span></h4>
1160
+
1161
+
1162
+ </dt>
1163
+ <dd>
1164
+
1165
+
1166
+
1167
+ <h5>Type:</h5>
1168
+ <ul>
1169
+ <li>
1170
+
1171
+ <span class="param-type">string</span>
1172
+
1173
+
1174
+
1175
+ </li>
1176
+ </ul>
1177
+
1178
+
1179
+
1180
+ <dl class="details">
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+ </dl>
1217
+
1218
+
1219
+
1220
+ </dd>
1221
+
1222
+
1223
+
1224
+ <hr>
1225
+ <dt class="name" id="taskChannelUniqueName">
1226
+ <h4 id="taskChannelUniqueName"><span class="type-signature">&lt;readonly&gt; </span>taskChannelUniqueName<span class="type-signature"> :string</span></h4>
1227
+
1228
+
1229
+ </dt>
1230
+ <dd>
1231
+
1232
+
1233
+
1234
+ <h5>Type:</h5>
1235
+ <ul>
1236
+ <li>
1237
+
1238
+ <span class="param-type">string</span>
1239
+
1240
+
1241
+
1242
+ </li>
1243
+ </ul>
1244
+
1245
+
1246
+
1247
+ <dl class="details">
1248
+
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+ </dl>
1284
+
1285
+
1286
+
1287
+ </dd>
1288
+
1289
+
1290
+
1291
+ <hr>
1292
+ <dt class="name" id="workerSid">
1293
+ <h4 id="workerSid"><span class="type-signature">&lt;readonly&gt; </span>workerSid<span class="type-signature"> :string</span></h4>
1294
+
1295
+
1296
+ </dt>
1297
+ <dd>
1298
+
1299
+
1300
+
1301
+ <h5>Type:</h5>
1302
+ <ul>
1303
+ <li>
1304
+
1305
+ <span class="param-type">string</span>
1306
+
1307
+
1308
+
1309
+ </li>
1310
+ </ul>
1311
+
1312
+
1313
+
1314
+ <dl class="details">
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+ </dl>
1351
+
1352
+
1353
+
1354
+ </dd>
1355
+
1356
+
1357
+
1358
+ <hr>
1359
+ <dt class="name" id="workspaceSid">
1360
+ <h4 id="workspaceSid"><span class="type-signature">&lt;readonly&gt; </span>workspaceSid<span class="type-signature"> :string</span></h4>
1361
+
1362
+
1363
+ </dt>
1364
+ <dd>
1365
+
1366
+
1367
+
1368
+ <h5>Type:</h5>
1369
+ <ul>
1370
+ <li>
1371
+
1372
+ <span class="param-type">string</span>
1373
+
1374
+
1375
+
1376
+ </li>
1377
+ </ul>
1378
+
1379
+
1380
+
1381
+ <dl class="details">
1382
+
1383
+
1384
+
1385
+
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+
1407
+
1408
+
1409
+
1410
+
1411
+
1412
+
1413
+
1414
+
1415
+
1416
+
1417
+ </dl>
1418
+
1419
+
1420
+
1421
+ </dd>
1422
+
1423
+ </dl>
531
1424
 
532
1425
 
533
1426
 
@@ -837,9 +1730,9 @@
837
1730
 
838
1731
 
839
1732
  <span class="jsdoc-message">
840
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
1733
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
841
1734
 
842
- on 2023-05-09T04:37:13+00:00
1735
+ on 2023-08-01T08:45:21+00:00
843
1736
 
844
1737
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
845
1738
  </span>