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
 
@@ -147,7 +154,7 @@
147
154
  <td class="type">
148
155
 
149
156
 
150
- <span class="param-type">Object</span>
157
+ <span class="param-type">Record.&lt;any, any&gt;</span>
151
158
 
152
159
 
153
160
 
@@ -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
 
@@ -195,7 +202,7 @@
195
202
  <td class="type">
196
203
 
197
204
 
198
- <span class="param-type">Object</span>
205
+ <span class="param-type">Record.&lt;any, any&gt;</span>
199
206
 
200
207
 
201
208
 
@@ -267,7 +274,7 @@
267
274
  <td class="type">
268
275
 
269
276
 
270
- <span class="param-type">int</span>
277
+ <span class="param-type">number</span>
271
278
 
272
279
 
273
280
 
@@ -422,7 +429,7 @@
422
429
 
423
430
 
424
431
 
425
- <td class="description last"><p>The status of the <a href="Task.html">Task</a>. Options: ['reserved', 'assigned', 'canceled', 'wrapping', 'completed', 'transferring']</p></td>
432
+ <td class="description last"><p>The status of the <a href="Task.html">Task</a>. Options: ['pending', 'reserved', 'assigned', 'canceled', 'completed', 'wrapping']</p></td>
426
433
  </tr>
427
434
 
428
435
 
@@ -483,7 +490,7 @@
483
490
  <td class="type">
484
491
 
485
492
 
486
- <span class="param-type">int</span>
493
+ <span class="param-type">number</span>
487
494
 
488
495
 
489
496
 
@@ -594,6 +601,30 @@
594
601
  </tr>
595
602
 
596
603
 
604
+
605
+ <tr>
606
+
607
+ <td class="name"><code>reservationSid</code></td>
608
+
609
+
610
+ <td class="type">
611
+
612
+
613
+ <span class="param-type">string</span>
614
+
615
+
616
+
617
+
618
+ </td>
619
+
620
+
621
+
622
+
623
+
624
+ <td class="description last"><p>The sid of <a href="Reservation.html">Reservation</a></p></td>
625
+ </tr>
626
+
627
+
597
628
  </tbody>
598
629
  </table>
599
630
  </dl>
@@ -645,13 +676,13 @@
645
676
 
646
677
  <li><a href="Task.html#event:completed">Task#event:completed</a></li>
647
678
 
648
- <li>Task#event:transferAttemptFailed</li>
679
+ <li><a href="Task.html#event:transferAttemptFailed">Task#event:transferAttemptFailed</a></li>
649
680
 
650
- <li>Task#event:transferCanceled</li>
681
+ <li><a href="Task.html#event:transferCanceled">Task#event:transferCanceled</a></li>
651
682
 
652
- <li>Task#event:transferCompleted</li>
683
+ <li><a href="Task.html#event:transferCompleted">Task#event:transferCompleted</a></li>
653
684
 
654
- <li>Task#event:transferFailed</li>
685
+ <li><a href="Task.html#event:transferFailed">Task#event:transferFailed</a></li>
655
686
 
656
687
  <li><a href="Task.html#event:transferInitiated">Task#event:transferInitiated</a></li>
657
688
 
@@ -676,6 +707,15 @@
676
707
  </div>
677
708
 
678
709
 
710
+ <h3 class="subsection-title">Extends</h3>
711
+
712
+
713
+
714
+
715
+ <ul>
716
+ <li>EventEmitter</li>
717
+ </ul>
718
+
679
719
 
680
720
 
681
721
 
@@ -688,79 +728,97 @@
688
728
 
689
729
 
690
730
 
691
- <h3 class="subsection-title">Methods</h3>
731
+ <h3 class="subsection-title">Members</h3>
692
732
 
693
733
  <dl>
694
734
 
695
735
  <hr>
696
- <dt>
697
- <h4 class="name" id="complete"><span class="type-signature"></span>complete(reason)</h4>
698
-
736
+ <dt class="name" id="addOns">
737
+ <h4 id="addOns"><span class="type-signature">&lt;readonly&gt; </span>addOns<span class="type-signature"> :Record.&lt;any, any&gt;</span></h4>
738
+
699
739
 
700
740
  </dt>
701
741
  <dd>
742
+
702
743
 
703
744
 
704
- <div class="description">
705
- <p>Update the <a href="Task.html">Task</a> status to 'completed'</p>
706
- </div>
745
+ <h5>Type:</h5>
746
+ <ul>
747
+ <li>
748
+
749
+ <span class="param-type">Record.&lt;any, any&gt;</span>
750
+
751
+
752
+
753
+ </li>
754
+ </ul>
755
+
756
+
757
+
758
+ <dl class="details">
707
759
 
708
760
 
761
+
762
+
763
+
764
+
765
+
766
+
709
767
 
710
768
 
711
769
 
712
770
 
713
771
 
772
+
714
773
 
715
- <h5>Parameters:</h5>
716
-
717
774
 
718
- <table class="params table table-striped">
719
- <thead>
720
- <tr>
721
-
722
- <th>Name</th>
723
-
775
+
724
776
 
725
- <th>Type</th>
777
+
726
778
 
727
-
779
+
728
780
 
729
-
781
+
730
782
 
731
- <th class="last">Description</th>
732
- </tr>
733
- </thead>
783
+
734
784
 
735
- <tbody>
736
-
737
785
 
738
- <tr>
739
-
740
- <td class="name"><code>reason</code></td>
741
-
742
786
 
743
- <td class="type">
744
-
745
-
746
- <span class="param-type">string</span>
787
+
747
788
 
789
+
748
790
 
791
+
749
792
 
750
-
751
- </td>
793
+
794
+ </dl>
752
795
 
753
-
754
796
 
797
+
798
+ </dd>
799
+
800
+
755
801
 
802
+ <hr>
803
+ <dt class="name" id="age">
804
+ <h4 id="age"><span class="type-signature">&lt;readonly&gt; </span>age<span class="type-signature"> :number</span></h4>
756
805
 
757
- <td class="description last"><p>The reason for completing the <a href="Task.html">Task</a></p></td>
758
- </tr>
806
+
807
+ </dt>
808
+ <dd>
809
+
759
810
 
760
811
 
761
- </tbody>
762
- </table>
812
+ <h5>Type:</h5>
813
+ <ul>
814
+ <li>
815
+
816
+ <span class="param-type">number</span>
817
+
763
818
 
819
+
820
+ </li>
821
+ </ul>
764
822
 
765
823
 
766
824
 
@@ -804,42 +862,71 @@
804
862
 
805
863
 
806
864
 
865
+ </dd>
866
+
867
+
868
+
869
+ <hr>
870
+ <dt class="name" id="attributes">
871
+ <h4 id="attributes"><span class="type-signature">&lt;readonly&gt; </span>attributes<span class="type-signature"> :Record.&lt;any, any&gt;</span></h4>
872
+
873
+
874
+ </dt>
875
+ <dd>
876
+
807
877
 
808
878
 
879
+ <h5>Type:</h5>
880
+ <ul>
881
+ <li>
882
+
883
+ <span class="param-type">Record.&lt;any, any&gt;</span>
884
+
809
885
 
886
+
887
+ </li>
888
+ </ul>
810
889
 
811
890
 
812
891
 
892
+ <dl class="details">
893
+
894
+
895
+
896
+
897
+
898
+
899
+
813
900
 
814
901
 
815
902
 
816
903
 
817
- <h5>Returns:</h5>
904
+
905
+
906
+
818
907
 
819
-
820
- <div class="param-desc">
821
- <ul>
822
- <li>Rejected if the <a href="Task.html">Task</a> state could not be updated to 'completed'</li>
823
- </ul>
824
- </div>
825
908
 
909
+
826
910
 
911
+
827
912
 
828
- <dl>
829
- <dt>
830
- Type
831
- </dt>
832
- <dd>
833
-
834
- <span class="param-type">Promise.&lt;this&gt;</span>
913
+
835
914
 
915
+
836
916
 
917
+
837
918
 
838
- </dd>
839
- </dl>
840
919
 
841
920
 
842
-
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+ </dl>
929
+
843
930
 
844
931
 
845
932
  </dd>
@@ -847,24 +934,25 @@
847
934
 
848
935
 
849
936
  <hr>
850
- <dt>
851
- <h4 class="name" id="fetchLatestVersion"><span class="type-signature"></span>fetchLatestVersion()</h4>
852
-
937
+ <dt class="name" id="dateCreated">
938
+ <h4 id="dateCreated"><span class="type-signature">&lt;readonly&gt; </span>dateCreated<span class="type-signature"> :Date</span></h4>
939
+
853
940
 
854
941
  </dt>
855
942
  <dd>
856
-
857
-
858
- <div class="description">
859
- <p>Fetch the last version of this <a href="Task.html">Task</a></p>
860
- </div>
861
943
 
862
944
 
863
945
 
946
+ <h5>Type:</h5>
947
+ <ul>
948
+ <li>
949
+
950
+ <span class="param-type">Date</span>
864
951
 
865
-
866
952
 
867
-
953
+
954
+ </li>
955
+ </ul>
868
956
 
869
957
 
870
958
 
@@ -908,62 +996,1375 @@
908
996
 
909
997
 
910
998
 
999
+ </dd>
911
1000
 
912
-
913
-
914
-
1001
+
1002
+
1003
+ <hr>
1004
+ <dt class="name" id="dateUpdated">
1005
+ <h4 id="dateUpdated"><span class="type-signature">&lt;readonly&gt; </span>dateUpdated<span class="type-signature"> :Date</span></h4>
915
1006
 
916
1007
 
917
-
1008
+ </dt>
1009
+ <dd>
918
1010
 
919
1011
 
920
1012
 
921
- <h5>Returns:</h5>
922
-
923
-
1013
+ <h5>Type:</h5>
1014
+ <ul>
1015
+ <li>
1016
+
1017
+ <span class="param-type">Date</span>
924
1018
 
925
1019
 
926
- <dl>
927
- <dt>
928
- Type
929
- </dt>
930
- <dd>
931
-
932
- <span class="param-type">Promise.&lt;<a href="Task.html">Task</a>&gt;</span>
933
1020
 
1021
+ </li>
1022
+ </ul>
1023
+
934
1024
 
1025
+
1026
+ <dl class="details">
1027
+
935
1028
 
936
- </dd>
937
- </dl>
1029
+
938
1030
 
1031
+
939
1032
 
940
-
1033
+
941
1034
 
942
1035
 
943
- </dd>
944
1036
 
945
-
946
-
947
- <hr>
948
- <dt>
949
- <h4 class="name" id="hold"><span class="type-signature"></span>hold(targetWorkerSid, onHold [, options])</h4>
950
1037
 
951
-
952
- </dt>
953
- <dd>
954
1038
 
955
1039
 
956
- <div class="description">
957
- <p>Hold the worker's call leg in the Conference associated to this <a href="Task.html">Task</a> and specified TargetWorkerSid</p>
958
- </div>
959
-
960
1040
 
961
1041
 
962
1042
 
963
-
1043
+
964
1044
 
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+ </dl>
1063
+
1064
+
1065
+
1066
+ </dd>
1067
+
1068
+
1069
+
1070
+ <hr>
1071
+ <dt class="name" id="priority">
1072
+ <h4 id="priority"><span class="type-signature">&lt;readonly&gt; </span>priority<span class="type-signature"> :number</span></h4>
1073
+
1074
+
1075
+ </dt>
1076
+ <dd>
1077
+
1078
+
1079
+
1080
+ <h5>Type:</h5>
1081
+ <ul>
1082
+ <li>
1083
+
1084
+ <span class="param-type">number</span>
1085
+
1086
+
1087
+
1088
+ </li>
1089
+ </ul>
1090
+
1091
+
1092
+
1093
+ <dl class="details">
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+
1111
+
1112
+
1113
+
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+ </dl>
1130
+
1131
+
1132
+
1133
+ </dd>
1134
+
1135
+
1136
+
1137
+ <hr>
1138
+ <dt class="name" id="queueName">
1139
+ <h4 id="queueName"><span class="type-signature">&lt;readonly&gt; </span>queueName<span class="type-signature"> :string</span></h4>
1140
+
1141
+
1142
+ </dt>
1143
+ <dd>
1144
+
1145
+
1146
+
1147
+ <h5>Type:</h5>
1148
+ <ul>
1149
+ <li>
1150
+
1151
+ <span class="param-type">string</span>
1152
+
1153
+
1154
+
1155
+ </li>
1156
+ </ul>
1157
+
1158
+
1159
+
1160
+ <dl class="details">
1161
+
1162
+
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+
1171
+
1172
+
1173
+
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+ </dl>
1197
+
1198
+
1199
+
1200
+ </dd>
1201
+
1202
+
1203
+
1204
+ <hr>
1205
+ <dt class="name" id="queueSid">
1206
+ <h4 id="queueSid"><span class="type-signature">&lt;readonly&gt; </span>queueSid<span class="type-signature"> :string</span></h4>
1207
+
1208
+
1209
+ </dt>
1210
+ <dd>
1211
+
1212
+
1213
+
1214
+ <h5>Type:</h5>
1215
+ <ul>
1216
+ <li>
1217
+
1218
+ <span class="param-type">string</span>
1219
+
1220
+
1221
+
1222
+ </li>
1223
+ </ul>
1224
+
1225
+
1226
+
1227
+ <dl class="details">
1228
+
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+ </dl>
1264
+
1265
+
1266
+
1267
+ </dd>
1268
+
1269
+
1270
+
1271
+ <hr>
1272
+ <dt class="name" id="reason">
1273
+ <h4 id="reason"><span class="type-signature">&lt;readonly&gt; </span>reason<span class="type-signature"> :string</span></h4>
1274
+
1275
+
1276
+ </dt>
1277
+ <dd>
1278
+
1279
+
1280
+
1281
+ <h5>Type:</h5>
1282
+ <ul>
1283
+ <li>
1284
+
1285
+ <span class="param-type">string</span>
1286
+
1287
+
1288
+
1289
+ </li>
1290
+ </ul>
1291
+
1292
+
1293
+
1294
+ <dl class="details">
1295
+
1296
+
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+
1307
+
1308
+
1309
+
1310
+
1311
+
1312
+
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+
1328
+
1329
+
1330
+ </dl>
1331
+
1332
+
1333
+
1334
+ </dd>
1335
+
1336
+
1337
+
1338
+ <hr>
1339
+ <dt class="name" id="reservationSid">
1340
+ <h4 id="reservationSid"><span class="type-signature">&lt;readonly&gt; </span>reservationSid<span class="type-signature"> :string</span></h4>
1341
+
1342
+
1343
+ </dt>
1344
+ <dd>
1345
+
1346
+
1347
+
1348
+ <h5>Type:</h5>
1349
+ <ul>
1350
+ <li>
1351
+
1352
+ <span class="param-type">string</span>
1353
+
1354
+
1355
+
1356
+ </li>
1357
+ </ul>
1358
+
1359
+
1360
+
1361
+ <dl class="details">
1362
+
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+
1384
+
1385
+
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+ </dl>
1398
+
1399
+
1400
+
1401
+ </dd>
1402
+
1403
+
1404
+
1405
+ <hr>
1406
+ <dt class="name" id="routingTarget">
1407
+ <h4 id="routingTarget"><span class="type-signature">&lt;readonly&gt; </span>routingTarget<span class="type-signature"> :string</span></h4>
1408
+
1409
+
1410
+ </dt>
1411
+ <dd>
1412
+
1413
+
1414
+
1415
+ <h5>Type:</h5>
1416
+ <ul>
1417
+ <li>
1418
+
1419
+ <span class="param-type">string</span>
1420
+
1421
+
1422
+
1423
+ </li>
1424
+ </ul>
1425
+
1426
+
1427
+
1428
+ <dl class="details">
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+
1455
+
1456
+
1457
+
1458
+
1459
+
1460
+
1461
+
1462
+
1463
+
1464
+ </dl>
1465
+
1466
+
1467
+
1468
+ </dd>
1469
+
1470
+
1471
+
1472
+ <hr>
1473
+ <dt class="name" id="sid">
1474
+ <h4 id="sid"><span class="type-signature">&lt;readonly&gt; </span>sid<span class="type-signature"> :string</span></h4>
1475
+
1476
+
1477
+ </dt>
1478
+ <dd>
1479
+
1480
+
1481
+
1482
+ <h5>Type:</h5>
1483
+ <ul>
1484
+ <li>
1485
+
1486
+ <span class="param-type">string</span>
1487
+
1488
+
1489
+
1490
+ </li>
1491
+ </ul>
1492
+
1493
+
1494
+
1495
+ <dl class="details">
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+
1516
+
1517
+
1518
+
1519
+
1520
+
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+
1528
+
1529
+
1530
+
1531
+ </dl>
1532
+
1533
+
1534
+
1535
+ </dd>
1536
+
1537
+
1538
+
1539
+ <hr>
1540
+ <dt class="name" id="status">
1541
+ <h4 id="status"><span class="type-signature">&lt;readonly&gt; </span>status<span class="type-signature"> :'pending'|'reserved'|'assigned'|'canceled'|'completed'|'wrapping'</span></h4>
1542
+
1543
+
1544
+ </dt>
1545
+ <dd>
1546
+
1547
+
1548
+
1549
+ <h5>Type:</h5>
1550
+ <ul>
1551
+ <li>
1552
+
1553
+ <span class="param-type">'pending'</span>
1554
+ |
1555
+
1556
+ <span class="param-type">'reserved'</span>
1557
+ |
1558
+
1559
+ <span class="param-type">'assigned'</span>
1560
+ |
1561
+
1562
+ <span class="param-type">'canceled'</span>
1563
+ |
1564
+
1565
+ <span class="param-type">'completed'</span>
1566
+ |
1567
+
1568
+ <span class="param-type">'wrapping'</span>
1569
+
1570
+
1571
+
1572
+ </li>
1573
+ </ul>
1574
+
1575
+
1576
+
1577
+ <dl class="details">
1578
+
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+
1591
+
1592
+
1593
+
1594
+
1595
+
1596
+
1597
+
1598
+
1599
+
1600
+
1601
+
1602
+
1603
+
1604
+
1605
+
1606
+
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+ </dl>
1614
+
1615
+
1616
+
1617
+ </dd>
1618
+
1619
+
1620
+
1621
+ <hr>
1622
+ <dt class="name" id="taskChannelSid">
1623
+ <h4 id="taskChannelSid"><span class="type-signature">&lt;readonly&gt; </span>taskChannelSid<span class="type-signature"> :string</span></h4>
1624
+
1625
+
1626
+ </dt>
1627
+ <dd>
1628
+
1629
+
1630
+
1631
+ <h5>Type:</h5>
1632
+ <ul>
1633
+ <li>
1634
+
1635
+ <span class="param-type">string</span>
1636
+
1637
+
1638
+
1639
+ </li>
1640
+ </ul>
1641
+
1642
+
1643
+
1644
+ <dl class="details">
1645
+
1646
+
1647
+
1648
+
1649
+
1650
+
1651
+
1652
+
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+
1659
+
1660
+
1661
+
1662
+
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+
1672
+
1673
+
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+
1680
+ </dl>
1681
+
1682
+
1683
+
1684
+ </dd>
1685
+
1686
+
1687
+
1688
+ <hr>
1689
+ <dt class="name" id="taskChannelUniqueName">
1690
+ <h4 id="taskChannelUniqueName"><span class="type-signature">&lt;readonly&gt; </span>taskChannelUniqueName<span class="type-signature"> :string</span></h4>
1691
+
1692
+
1693
+ </dt>
1694
+ <dd>
1695
+
1696
+
1697
+
1698
+ <h5>Type:</h5>
1699
+ <ul>
1700
+ <li>
1701
+
1702
+ <span class="param-type">string</span>
1703
+
1704
+
1705
+
1706
+ </li>
1707
+ </ul>
1708
+
1709
+
1710
+
1711
+ <dl class="details">
1712
+
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+
1733
+
1734
+
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+
1744
+
1745
+
1746
+
1747
+ </dl>
1748
+
1749
+
1750
+
1751
+ </dd>
1752
+
1753
+
1754
+
1755
+ <hr>
1756
+ <dt class="name" id="timeout">
1757
+ <h4 id="timeout"><span class="type-signature">&lt;readonly&gt; </span>timeout<span class="type-signature"> :number</span></h4>
1758
+
1759
+
1760
+ </dt>
1761
+ <dd>
1762
+
1763
+
1764
+
1765
+ <h5>Type:</h5>
1766
+ <ul>
1767
+ <li>
1768
+
1769
+ <span class="param-type">number</span>
1770
+
1771
+
1772
+
1773
+ </li>
1774
+ </ul>
1775
+
1776
+
1777
+
1778
+ <dl class="details">
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+
1791
+
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+
1809
+
1810
+
1811
+
1812
+
1813
+
1814
+ </dl>
1815
+
1816
+
1817
+
1818
+ </dd>
1819
+
1820
+
1821
+
1822
+ <hr>
1823
+ <dt class="name" id="transfers">
1824
+ <h4 id="transfers"><span class="type-signature">&lt;readonly&gt; </span>transfers<span class="type-signature"> :<a href="Transfers.html">Transfers</a></span></h4>
1825
+
1826
+
1827
+ </dt>
1828
+ <dd>
1829
+
1830
+
1831
+
1832
+ <h5>Type:</h5>
1833
+ <ul>
1834
+ <li>
1835
+
1836
+ <span class="param-type"><a href="Transfers.html">Transfers</a></span>
1837
+
1838
+
1839
+
1840
+ </li>
1841
+ </ul>
1842
+
1843
+
1844
+
1845
+ <dl class="details">
1846
+
1847
+
1848
+
1849
+
1850
+
1851
+
1852
+
1853
+
1854
+
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+
1868
+
1869
+
1870
+
1871
+
1872
+
1873
+
1874
+
1875
+
1876
+
1877
+
1878
+
1879
+
1880
+
1881
+ </dl>
1882
+
1883
+
1884
+
1885
+ </dd>
1886
+
1887
+
1888
+
1889
+ <hr>
1890
+ <dt class="name" id="version">
1891
+ <h4 id="version"><span class="type-signature">&lt;readonly&gt; </span>version<span class="type-signature"> :string</span></h4>
1892
+
1893
+
1894
+ </dt>
1895
+ <dd>
1896
+
1897
+
1898
+
1899
+ <h5>Type:</h5>
1900
+ <ul>
1901
+ <li>
1902
+
1903
+ <span class="param-type">string</span>
1904
+
1905
+
1906
+
1907
+ </li>
1908
+ </ul>
1909
+
1910
+
1911
+
1912
+ <dl class="details">
1913
+
1914
+
1915
+
1916
+
1917
+
1918
+
1919
+
1920
+
1921
+
1922
+
1923
+
1924
+
1925
+
1926
+
1927
+
1928
+
1929
+
1930
+
1931
+
1932
+
1933
+
1934
+
1935
+
1936
+
1937
+
1938
+
1939
+
1940
+
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+
1947
+
1948
+ </dl>
1949
+
1950
+
1951
+
1952
+ </dd>
1953
+
1954
+
1955
+
1956
+ <hr>
1957
+ <dt class="name" id="workflowName">
1958
+ <h4 id="workflowName"><span class="type-signature">&lt;readonly&gt; </span>workflowName<span class="type-signature"> :string</span></h4>
1959
+
1960
+
1961
+ </dt>
1962
+ <dd>
1963
+
1964
+
1965
+
1966
+ <h5>Type:</h5>
1967
+ <ul>
1968
+ <li>
1969
+
1970
+ <span class="param-type">string</span>
1971
+
1972
+
1973
+
1974
+ </li>
1975
+ </ul>
1976
+
1977
+
1978
+
1979
+ <dl class="details">
1980
+
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+
2014
+
2015
+ </dl>
2016
+
2017
+
2018
+
2019
+ </dd>
2020
+
2021
+
2022
+
2023
+ <hr>
2024
+ <dt class="name" id="workflowSid">
2025
+ <h4 id="workflowSid"><span class="type-signature">&lt;readonly&gt; </span>workflowSid<span class="type-signature"> :string</span></h4>
2026
+
2027
+
2028
+ </dt>
2029
+ <dd>
2030
+
2031
+
2032
+
2033
+ <h5>Type:</h5>
2034
+ <ul>
2035
+ <li>
2036
+
2037
+ <span class="param-type">string</span>
2038
+
2039
+
2040
+
2041
+ </li>
2042
+ </ul>
2043
+
2044
+
2045
+
2046
+ <dl class="details">
2047
+
2048
+
2049
+
2050
+
2051
+
2052
+
2053
+
2054
+
2055
+
2056
+
2057
+
2058
+
2059
+
2060
+
2061
+
2062
+
2063
+
2064
+
2065
+
2066
+
2067
+
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+
2074
+
2075
+
2076
+
2077
+
2078
+
2079
+
2080
+
2081
+
2082
+ </dl>
2083
+
2084
+
2085
+
2086
+ </dd>
2087
+
2088
+ </dl>
2089
+
2090
+
2091
+
2092
+ <h3 class="subsection-title">Methods</h3>
2093
+
2094
+ <dl>
2095
+
2096
+ <hr>
2097
+ <dt>
2098
+ <h4 class="name" id="complete"><span class="type-signature"></span>complete(reason)</h4>
2099
+
2100
+
2101
+ </dt>
2102
+ <dd>
2103
+
2104
+
2105
+ <div class="description">
2106
+ <p>Update the <a href="Task.html">Task</a> status to 'completed'</p>
2107
+ </div>
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+ <h5>Parameters:</h5>
2117
+
2118
+
2119
+ <table class="params table table-striped">
2120
+ <thead>
2121
+ <tr>
2122
+
2123
+ <th>Name</th>
2124
+
2125
+
2126
+ <th>Type</th>
2127
+
2128
+
2129
+
2130
+
2131
+
2132
+ <th class="last">Description</th>
2133
+ </tr>
2134
+ </thead>
2135
+
2136
+ <tbody>
2137
+
2138
+
2139
+ <tr>
2140
+
2141
+ <td class="name"><code>reason</code></td>
2142
+
2143
+
2144
+ <td class="type">
2145
+
2146
+
2147
+ <span class="param-type">string</span>
2148
+
2149
+
2150
+
2151
+
2152
+ </td>
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+ <td class="description last"><p>The reason for completing the <a href="Task.html">Task</a></p></td>
2159
+ </tr>
2160
+
2161
+
2162
+ </tbody>
2163
+ </table>
2164
+
2165
+
2166
+
2167
+
2168
+ <dl class="details">
2169
+
2170
+
2171
+
2172
+
2173
+
2174
+
2175
+
2176
+
2177
+
2178
+
2179
+
2180
+
2181
+
2182
+
2183
+
2184
+
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+
2191
+
2192
+
2193
+
2194
+
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+ </dl>
2205
+
2206
+
2207
+
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+
2214
+
2215
+
2216
+
2217
+
2218
+ <h5>Returns:</h5>
2219
+
2220
+
2221
+ <div class="param-desc">
2222
+ <ul>
2223
+ <li>Rejected if the <a href="Task.html">Task</a> state could not be updated to 'completed'</li>
2224
+ </ul>
2225
+ </div>
2226
+
2227
+
2228
+
2229
+ <dl>
2230
+ <dt>
2231
+ Type
2232
+ </dt>
2233
+ <dd>
2234
+
2235
+ <span class="param-type">Promise.&lt;this&gt;</span>
2236
+
2237
+
2238
+
2239
+ </dd>
2240
+ </dl>
2241
+
2242
+
2243
+
2244
+
2245
+
2246
+ </dd>
2247
+
2248
+
2249
+
2250
+ <hr>
2251
+ <dt>
2252
+ <h4 class="name" id="fetchLatestVersion"><span class="type-signature"></span>fetchLatestVersion()</h4>
2253
+
2254
+
2255
+ </dt>
2256
+ <dd>
2257
+
2258
+
2259
+ <div class="description">
2260
+ <p>Fetch the last version of this <a href="Task.html">Task</a></p>
2261
+ </div>
2262
+
2263
+
2264
+
2265
+
2266
+
2267
+
2268
+
2269
+
2270
+
2271
+
2272
+ <dl class="details">
2273
+
2274
+
2275
+
2276
+
2277
+
2278
+
2279
+
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+
2286
+
2287
+
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+
2296
+
2297
+
2298
+
2299
+
2300
+
2301
+
2302
+
2303
+
2304
+
2305
+
2306
+
2307
+
2308
+ </dl>
2309
+
2310
+
2311
+
2312
+
2313
+
2314
+
2315
+
2316
+
2317
+
2318
+
2319
+
2320
+
2321
+
2322
+ <h5>Returns:</h5>
2323
+
2324
+
2325
+
2326
+
2327
+ <dl>
2328
+ <dt>
2329
+ Type
2330
+ </dt>
2331
+ <dd>
2332
+
2333
+ <span class="param-type">Promise.&lt;<a href="Task.html">Task</a>&gt;</span>
2334
+
2335
+
2336
+
2337
+ </dd>
2338
+ </dl>
2339
+
2340
+
2341
+
2342
+
2343
+
2344
+ </dd>
2345
+
2346
+
2347
+
2348
+ <hr>
2349
+ <dt>
2350
+ <h4 class="name" id="hold"><span class="type-signature"></span>hold(targetWorkerSid, onHold, options)</h4>
2351
+
2352
+
2353
+ </dt>
2354
+ <dd>
2355
+
2356
+
2357
+ <div class="description">
2358
+ <p>Hold the worker's call leg in the Conference associated to this <a href="Task.html">Task</a> and specified TargetWorkerSid</p>
2359
+ </div>
2360
+
2361
+
2362
+
2363
+
2364
+
2365
+
2366
+
965
2367
 
966
-
967
2368
  <h5>Parameters:</h5>
968
2369
 
969
2370
 
@@ -977,8 +2378,6 @@
977
2378
  <th>Type</th>
978
2379
 
979
2380
 
980
- <th>Argument</th>
981
-
982
2381
 
983
2382
 
984
2383
 
@@ -1005,14 +2404,6 @@
1005
2404
  </td>
1006
2405
 
1007
2406
 
1008
- <td class="attributes">
1009
-
1010
-
1011
-
1012
-
1013
-
1014
- </td>
1015
-
1016
2407
 
1017
2408
 
1018
2409
 
@@ -1037,14 +2428,6 @@
1037
2428
  </td>
1038
2429
 
1039
2430
 
1040
- <td class="attributes">
1041
-
1042
-
1043
-
1044
-
1045
-
1046
- </td>
1047
-
1048
2431
 
1049
2432
 
1050
2433
 
@@ -1061,7 +2444,7 @@
1061
2444
  <td class="type">
1062
2445
 
1063
2446
 
1064
- <span class="param-type"><a href="Task.html#.HoldOptions">Task.HoldOptions</a></span>
2447
+ <span class="param-type"><a href="global.html#HoldOptions">HoldOptions</a></span>
1065
2448
 
1066
2449
 
1067
2450
 
@@ -1069,16 +2452,6 @@
1069
2452
  </td>
1070
2453
 
1071
2454
 
1072
- <td class="attributes">
1073
-
1074
- &lt;optional&gt;<br>
1075
-
1076
-
1077
-
1078
-
1079
-
1080
- </td>
1081
-
1082
2455
 
1083
2456
 
1084
2457
 
@@ -1142,6 +2515,26 @@
1142
2515
 
1143
2516
 
1144
2517
 
2518
+ <h5>Returns:</h5>
2519
+
2520
+
2521
+
2522
+
2523
+ <dl>
2524
+ <dt>
2525
+ Type
2526
+ </dt>
2527
+ <dd>
2528
+
2529
+ <span class="param-type">Promise.&lt;this&gt;</span>
2530
+
2531
+
2532
+
2533
+ </dd>
2534
+ </dl>
2535
+
2536
+
2537
+
1145
2538
 
1146
2539
 
1147
2540
  </dd>
@@ -1353,7 +2746,7 @@
1353
2746
  <td class="type">
1354
2747
 
1355
2748
 
1356
- <span class="param-type">Object</span>
2749
+ <span class="param-type">Record.&lt;any, any&gt;</span>
1357
2750
 
1358
2751
 
1359
2752
 
@@ -1458,7 +2851,7 @@
1458
2851
 
1459
2852
  <hr>
1460
2853
  <dt>
1461
- <h4 class="name" id="transfer"><span class="type-signature"></span>transfer(to [, options])</h4>
2854
+ <h4 class="name" id="transfer"><span class="type-signature">&lt;async&gt; </span>transfer(to [, options])</h4>
1462
2855
 
1463
2856
 
1464
2857
  </dt>
@@ -1541,7 +2934,7 @@
1541
2934
  <td class="type">
1542
2935
 
1543
2936
 
1544
- <span class="param-type"><a href="Task.html#.TransferOptions">Task.TransferOptions</a></span>
2937
+ <span class="param-type"><a href="global.html#TransferOptions">TransferOptions</a></span>
1545
2938
 
1546
2939
 
1547
2940
 
@@ -1650,7 +3043,7 @@
1650
3043
 
1651
3044
  <hr>
1652
3045
  <dt>
1653
- <h4 class="name" id="updateParticipant"><span class="type-signature"></span>updateParticipant( [options])</h4>
3046
+ <h4 class="name" id="updateParticipant"><span class="type-signature"></span>updateParticipant(options)</h4>
1654
3047
 
1655
3048
 
1656
3049
  </dt>
@@ -1681,8 +3074,6 @@
1681
3074
  <th>Type</th>
1682
3075
 
1683
3076
 
1684
- <th>Argument</th>
1685
-
1686
3077
 
1687
3078
 
1688
3079
 
@@ -1698,26 +3089,16 @@
1698
3089
  <td class="name"><code>options</code></td>
1699
3090
 
1700
3091
 
1701
- <td class="type">
1702
-
1703
-
1704
- <span class="param-type"><a href="Task.html#.ParticipantOptions">Task.ParticipantOptions</a></span>
1705
-
1706
-
1707
-
1708
-
1709
- </td>
1710
-
1711
-
1712
- <td class="attributes">
1713
-
1714
- &lt;optional&gt;<br>
1715
-
1716
-
3092
+ <td class="type">
3093
+
1717
3094
 
3095
+ <span class="param-type"><a href="global.html#TaskParticipantOptions">TaskParticipantOptions</a></span>
3096
+
3097
+
3098
+
3099
+
3100
+ </td>
1718
3101
 
1719
-
1720
- </td>
1721
3102
 
1722
3103
 
1723
3104
 
@@ -1787,7 +3168,7 @@
1787
3168
 
1788
3169
  <div class="param-desc">
1789
3170
  <ul>
1790
- <li>Rejected if unable to update the Customers's leg in the Conference tied to the <a href="Task.html">Task</a></li>
3171
+ <li>Rejected if unable to update the Customers' leg in the Conference tied to the <a href="Task.html">Task</a></li>
1791
3172
  </ul>
1792
3173
  </div>
1793
3174
 
@@ -1816,7 +3197,7 @@
1816
3197
 
1817
3198
  <hr>
1818
3199
  <dt>
1819
- <h4 class="name" id="wrapUp"><span class="type-signature"></span>wrapUp()</h4>
3200
+ <h4 class="name" id="wrapUp"><span class="type-signature"></span>wrapUp(options)</h4>
1820
3201
 
1821
3202
 
1822
3203
  </dt>
@@ -1834,6 +3215,56 @@
1834
3215
 
1835
3216
 
1836
3217
 
3218
+ <h5>Parameters:</h5>
3219
+
3220
+
3221
+ <table class="params table table-striped">
3222
+ <thead>
3223
+ <tr>
3224
+
3225
+ <th>Name</th>
3226
+
3227
+
3228
+ <th>Type</th>
3229
+
3230
+
3231
+
3232
+
3233
+
3234
+ <th class="last">Description</th>
3235
+ </tr>
3236
+ </thead>
3237
+
3238
+ <tbody>
3239
+
3240
+
3241
+ <tr>
3242
+
3243
+ <td class="name"><code>options</code></td>
3244
+
3245
+
3246
+ <td class="type">
3247
+
3248
+
3249
+ <span class="param-type"><a href="global.html#WrappingOptions">WrappingOptions</a></span>
3250
+
3251
+
3252
+
3253
+
3254
+ </td>
3255
+
3256
+
3257
+
3258
+
3259
+
3260
+ <td class="description last"></td>
3261
+ </tr>
3262
+
3263
+
3264
+ </tbody>
3265
+ </table>
3266
+
3267
+
1837
3268
 
1838
3269
 
1839
3270
  <dl class="details">
@@ -1920,41 +3351,36 @@
1920
3351
 
1921
3352
 
1922
3353
 
1923
- <h3 class="subsection-title">Type Definitions</h3>
3354
+
3355
+
3356
+ <h3 class="subsection-title">Events</h3>
1924
3357
 
1925
3358
  <dl>
1926
-
3359
+
1927
3360
  <hr>
1928
- <dt class="name" id=".HoldOptions">
1929
- <h4 id=".HoldOptions">HoldOptions</h4>
1930
-
3361
+ <dt>
3362
+ <h4 class="name" id="event:canceled">canceled</h4>
3363
+
1931
3364
 
1932
3365
  </dt>
1933
3366
  <dd>
1934
-
1935
3367
 
1936
3368
 
1937
- <h5>Type:</h5>
1938
- <ul>
1939
- <li>
1940
-
1941
- <span class="param-type">Object</span>
1942
-
3369
+ <div class="description">
3370
+ <p>The <a href="Task.html">Task</a> was canceled</p>
3371
+ </div>
3372
+
1943
3373
 
3374
+
1944
3375
 
1945
- </li>
1946
- </ul>
1947
3376
 
1948
3377
 
1949
3378
 
1950
- <dl class="details">
1951
3379
 
3380
+ <h5>Parameters:</h5>
3381
+
1952
3382
 
1953
- <h5 class="subsection-title">Properties:</h5>
1954
-
1955
- <dl>
1956
-
1957
- <table class="props table table-striped">
3383
+ <table class="params table table-striped">
1958
3384
  <thead>
1959
3385
  <tr>
1960
3386
 
@@ -1964,12 +3390,8 @@
1964
3390
  <th>Type</th>
1965
3391
 
1966
3392
 
1967
- <th>Argument</th>
1968
-
1969
3393
 
1970
3394
 
1971
- <th>Default</th>
1972
-
1973
3395
 
1974
3396
  <th class="last">Description</th>
1975
3397
  </tr>
@@ -1980,51 +3402,13 @@
1980
3402
 
1981
3403
  <tr>
1982
3404
 
1983
- <td class="name"><code>holdUrl</code></td>
1984
-
1985
-
1986
- <td class="type">
1987
-
1988
-
1989
- <span class="param-type">string</span>
1990
-
1991
-
1992
-
1993
-
1994
- </td>
1995
-
1996
-
1997
- <td class="attributes">
1998
-
1999
- &lt;optional&gt;<br>
2000
-
2001
-
2002
-
2003
- </td>
2004
-
2005
-
2006
-
2007
- <td class="default">
2008
-
2009
- default Twilio hold music
2010
-
2011
- </td>
2012
-
2013
-
2014
- <td class="description last"><p>The URL endpoint to play when participant is on hold.</p></td>
2015
- </tr>
2016
-
2017
-
2018
-
2019
- <tr>
2020
-
2021
- <td class="name"><code>holdMethod</code></td>
3405
+ <td class="name"><code>task</code></td>
2022
3406
 
2023
3407
 
2024
3408
  <td class="type">
2025
3409
 
2026
3410
 
2027
- <span class="param-type">string</span>
3411
+ <span class="param-type"><a href="Task.html">Task</a></span>
2028
3412
 
2029
3413
 
2030
3414
 
@@ -2032,33 +3416,22 @@
2032
3416
  </td>
2033
3417
 
2034
3418
 
2035
- <td class="attributes">
2036
-
2037
- &lt;optional&gt;<br>
2038
-
2039
-
2040
-
2041
- </td>
2042
-
2043
3419
 
2044
3420
 
2045
- <td class="default">
2046
-
2047
- 'GET'
2048
-
2049
- </td>
2050
-
2051
3421
 
2052
- <td class="description last"><p>The HTTP method for the hold URL.</p></td>
3422
+ <td class="description last"><p>The <a href="Task.html">Task</a> who was canceled</p></td>
2053
3423
  </tr>
2054
3424
 
2055
3425
 
2056
3426
  </tbody>
2057
3427
  </table>
2058
- </dl>
2059
3428
 
2060
3429
 
2061
3430
 
3431
+
3432
+ <dl class="details">
3433
+
3434
+
2062
3435
 
2063
3436
 
2064
3437
 
@@ -2096,149 +3469,74 @@
2096
3469
 
2097
3470
 
2098
3471
 
2099
- </dd>
2100
3472
 
2101
-
2102
-
2103
- <hr>
2104
- <dt class="name" id=".ParticipantOptions">
2105
- <h4 id=".ParticipantOptions">ParticipantOptions</h4>
3473
+
2106
3474
 
2107
3475
 
2108
- </dt>
2109
- <dd>
3476
+
2110
3477
 
2111
3478
 
2112
3479
 
2113
- <h5>Type:</h5>
2114
- <ul>
2115
- <li>
2116
-
2117
- <span class="param-type">Object</span>
2118
3480
 
3481
+
2119
3482
 
3483
+
3484
+ </dd>
2120
3485
 
2121
- </li>
2122
- </ul>
3486
+
3487
+
3488
+ <hr>
3489
+ <dt>
3490
+ <h4 class="name" id="event:completed">completed</h4>
3491
+
2123
3492
 
3493
+ </dt>
3494
+ <dd>
2124
3495
 
2125
3496
 
2126
- <dl class="details">
3497
+ <div class="description">
3498
+ <p>The <a href="Task.html">Task</a> was completed</p>
3499
+ </div>
2127
3500
 
2128
3501
 
2129
- <h5 class="subsection-title">Properties:</h5>
3502
+
2130
3503
 
2131
- <dl>
3504
+
2132
3505
 
2133
- <table class="props table table-striped">
3506
+
3507
+
3508
+ <h5>Parameters:</h5>
3509
+
3510
+
3511
+ <table class="params table table-striped">
2134
3512
  <thead>
2135
3513
  <tr>
2136
3514
 
2137
3515
  <th>Name</th>
2138
3516
 
2139
3517
 
2140
- <th>Type</th>
2141
-
2142
-
2143
- <th>Argument</th>
2144
-
2145
-
2146
-
2147
- <th>Default</th>
2148
-
2149
-
2150
- <th class="last">Description</th>
2151
- </tr>
2152
- </thead>
2153
-
2154
- <tbody>
2155
-
2156
-
2157
- <tr>
2158
-
2159
- <td class="name"><code>hold</code></td>
2160
-
2161
-
2162
- <td class="type">
2163
-
2164
-
2165
- <span class="param-type">boolean</span>
2166
-
2167
-
2168
-
2169
-
2170
- </td>
2171
-
2172
-
2173
- <td class="attributes">
2174
-
2175
- &lt;optional&gt;<br>
2176
-
2177
-
2178
-
2179
- </td>
2180
-
2181
-
2182
-
2183
- <td class="default">
2184
-
2185
- null
2186
-
2187
- </td>
2188
-
2189
-
2190
- <td class="description last"><p>Whether to hold the customer leg of the Conference referenced by the <a href="Task.html">Task</a></p></td>
2191
- </tr>
2192
-
2193
-
2194
-
2195
- <tr>
2196
-
2197
- <td class="name"><code>holdUrl</code></td>
2198
-
2199
-
2200
- <td class="type">
2201
-
2202
-
2203
- <span class="param-type">string</span>
2204
-
2205
-
2206
-
2207
-
2208
- </td>
2209
-
2210
-
2211
- <td class="attributes">
2212
-
2213
- &lt;optional&gt;<br>
2214
-
3518
+ <th>Type</th>
2215
3519
 
2216
-
2217
- </td>
2218
-
3520
+
2219
3521
 
2220
-
2221
- <td class="default">
2222
-
2223
- default Twilio hold music
2224
-
2225
- </td>
2226
-
3522
+
2227
3523
 
2228
- <td class="description last"><p>The URL endpoint to play when participant is on hold.</p></td>
2229
- </tr>
3524
+ <th class="last">Description</th>
3525
+ </tr>
3526
+ </thead>
2230
3527
 
3528
+ <tbody>
2231
3529
 
2232
3530
 
2233
3531
  <tr>
2234
3532
 
2235
- <td class="name"><code>holdMethod</code></td>
3533
+ <td class="name"><code>task</code></td>
2236
3534
 
2237
3535
 
2238
3536
  <td class="type">
2239
3537
 
2240
3538
 
2241
- <span class="param-type">string</span>
3539
+ <span class="param-type"><a href="Task.html">Task</a></span>
2242
3540
 
2243
3541
 
2244
3542
 
@@ -2246,33 +3544,22 @@
2246
3544
  </td>
2247
3545
 
2248
3546
 
2249
- <td class="attributes">
2250
-
2251
- &lt;optional&gt;<br>
2252
-
2253
-
2254
-
2255
- </td>
2256
-
2257
3547
 
2258
3548
 
2259
- <td class="default">
2260
-
2261
- 'GET'
2262
-
2263
- </td>
2264
-
2265
3549
 
2266
- <td class="description last"><p>The HTTP method for the hold URL.</p></td>
3550
+ <td class="description last"><p>The <a href="Task.html">Task</a> who was completed</p></td>
2267
3551
  </tr>
2268
3552
 
2269
3553
 
2270
3554
  </tbody>
2271
3555
  </table>
2272
- </dl>
2273
3556
 
2274
3557
 
2275
3558
 
3559
+
3560
+ <dl class="details">
3561
+
3562
+
2276
3563
 
2277
3564
 
2278
3565
 
@@ -2310,41 +3597,46 @@
2310
3597
 
2311
3598
 
2312
3599
 
2313
- </dd>
2314
3600
 
2315
-
2316
-
2317
- <hr>
2318
- <dt class="name" id=".TransferOptions">
2319
- <h4 id=".TransferOptions">TransferOptions</h4>
3601
+
2320
3602
 
2321
3603
 
2322
- </dt>
2323
- <dd>
3604
+
2324
3605
 
2325
3606
 
2326
3607
 
2327
- <h5>Type:</h5>
2328
- <ul>
2329
- <li>
2330
-
2331
- <span class="param-type">Object</span>
2332
3608
 
3609
+
2333
3610
 
3611
+
3612
+ </dd>
2334
3613
 
2335
- </li>
2336
- </ul>
3614
+
3615
+
3616
+ <hr>
3617
+ <dt>
3618
+ <h4 class="name" id="event:transferAttemptFailed">transferAttemptFailed</h4>
2337
3619
 
3620
+
3621
+ </dt>
3622
+ <dd>
2338
3623
 
2339
3624
 
2340
- <dl class="details">
3625
+ <div class="description">
3626
+ <p>An <a href="OutgoingTransfer.html">OutgoingTransfer</a> attempt has been failed for <a href="Task.html">Task</a></p>
3627
+ </div>
2341
3628
 
2342
3629
 
2343
- <h5 class="subsection-title">Properties:</h5>
3630
+
2344
3631
 
2345
- <dl>
3632
+
2346
3633
 
2347
- <table class="props table table-striped">
3634
+
3635
+
3636
+ <h5>Parameters:</h5>
3637
+
3638
+
3639
+ <table class="params table table-striped">
2348
3640
  <thead>
2349
3641
  <tr>
2350
3642
 
@@ -2354,12 +3646,8 @@
2354
3646
  <th>Type</th>
2355
3647
 
2356
3648
 
2357
- <th>Argument</th>
2358
-
2359
3649
 
2360
3650
 
2361
- <th>Default</th>
2362
-
2363
3651
 
2364
3652
  <th class="last">Description</th>
2365
3653
  </tr>
@@ -2370,13 +3658,13 @@
2370
3658
 
2371
3659
  <tr>
2372
3660
 
2373
- <td class="name"><code>attributes</code></td>
3661
+ <td class="name"><code>outgoingTransfer</code></td>
2374
3662
 
2375
3663
 
2376
3664
  <td class="type">
2377
3665
 
2378
3666
 
2379
- <span class="param-type">Object</span>
3667
+ <span class="param-type"><a href="OutgoingTransfer.html">OutgoingTransfer</a></span>
2380
3668
 
2381
3669
 
2382
3670
 
@@ -2384,103 +3672,20 @@
2384
3672
  </td>
2385
3673
 
2386
3674
 
2387
- <td class="attributes">
2388
-
2389
- &lt;optional&gt;<br>
2390
-
2391
-
2392
-
2393
- </td>
2394
-
2395
3675
 
2396
3676
 
2397
- <td class="default">
2398
-
2399
- </td>
2400
-
2401
3677
 
2402
- <td class="description last"><p>Updated attributes for the task</p></td>
3678
+ <td class="description last"><p>The currently in process <a href="OutgoingTransfer.html">OutgoingTransfer</a></p></td>
2403
3679
  </tr>
2404
3680
 
2405
3681
 
2406
-
2407
- <tr>
2408
-
2409
- <td class="name"><code>mode</code></td>
2410
-
2411
-
2412
- <td class="type">
2413
-
2414
-
2415
- <span class="param-type">string</span>
2416
-
2417
-
2418
-
2419
-
2420
- </td>
2421
-
2422
-
2423
- <td class="attributes">
2424
-
2425
- &lt;optional&gt;<br>
2426
-
2427
-
2428
-
2429
- </td>
2430
-
2431
-
2432
-
2433
- <td class="default">
2434
-
2435
- 'WARM'
2436
-
2437
- </td>
2438
-
2439
-
2440
- <td class="description last"><p>'WARM' or 'COLD'</p></td>
2441
- </tr>
3682
+ </tbody>
3683
+ </table>
2442
3684
 
2443
3685
 
2444
3686
 
2445
- <tr>
2446
-
2447
- <td class="name"><code>priority</code></td>
2448
-
2449
-
2450
- <td class="type">
2451
-
2452
-
2453
- <span class="param-type">number</span>
2454
-
2455
-
2456
-
2457
-
2458
- </td>
2459
-
2460
-
2461
- <td class="attributes">
2462
-
2463
- &lt;optional&gt;<br>
2464
-
2465
-
2466
-
2467
- </td>
2468
-
2469
-
2470
-
2471
- <td class="default">
2472
-
2473
- </td>
2474
-
2475
-
2476
- <td class="description last"><p>Updated priority for the task</p></td>
2477
- </tr>
2478
-
2479
3687
 
2480
- </tbody>
2481
- </table>
2482
- </dl>
2483
-
3688
+ <dl class="details">
2484
3689
 
2485
3690
 
2486
3691
 
@@ -2520,41 +3725,46 @@
2520
3725
 
2521
3726
 
2522
3727
 
2523
- </dd>
2524
3728
 
2525
-
2526
-
2527
- <hr>
2528
- <dt class="name" id=".WrappingOptions">
2529
- <h4 id=".WrappingOptions">WrappingOptions</h4>
3729
+
2530
3730
 
2531
3731
 
2532
- </dt>
2533
- <dd>
3732
+
2534
3733
 
2535
3734
 
2536
3735
 
2537
- <h5>Type:</h5>
2538
- <ul>
2539
- <li>
2540
-
2541
- <span class="param-type">Object</span>
2542
3736
 
3737
+
2543
3738
 
3739
+
3740
+ </dd>
2544
3741
 
2545
- </li>
2546
- </ul>
3742
+
3743
+
3744
+ <hr>
3745
+ <dt>
3746
+ <h4 class="name" id="event:transferCanceled">transferCanceled</h4>
3747
+
2547
3748
 
3749
+ </dt>
3750
+ <dd>
2548
3751
 
2549
3752
 
2550
- <dl class="details">
3753
+ <div class="description">
3754
+ <p>An <a href="OutgoingTransfer.html">OutgoingTransfer</a> has been canceled for <a href="Task.html">Task</a></p>
3755
+ </div>
2551
3756
 
2552
3757
 
2553
- <h5 class="subsection-title">Properties:</h5>
3758
+
2554
3759
 
2555
- <dl>
3760
+
2556
3761
 
2557
- <table class="props table table-striped">
3762
+
3763
+
3764
+ <h5>Parameters:</h5>
3765
+
3766
+
3767
+ <table class="params table table-striped">
2558
3768
  <thead>
2559
3769
  <tr>
2560
3770
 
@@ -2564,12 +3774,8 @@
2564
3774
  <th>Type</th>
2565
3775
 
2566
3776
 
2567
- <th>Argument</th>
2568
-
2569
3777
 
2570
3778
 
2571
- <th>Default</th>
2572
-
2573
3779
 
2574
3780
  <th class="last">Description</th>
2575
3781
  </tr>
@@ -2580,13 +3786,13 @@
2580
3786
 
2581
3787
  <tr>
2582
3788
 
2583
- <td class="name"><code>reason</code></td>
3789
+ <td class="name"><code>outgoingTransfer</code></td>
2584
3790
 
2585
3791
 
2586
3792
  <td class="type">
2587
3793
 
2588
3794
 
2589
- <span class="param-type">string</span>
3795
+ <span class="param-type"><a href="OutgoingTransfer.html">OutgoingTransfer</a></span>
2590
3796
 
2591
3797
 
2592
3798
 
@@ -2594,33 +3800,22 @@
2594
3800
  </td>
2595
3801
 
2596
3802
 
2597
- <td class="attributes">
2598
-
2599
- &lt;optional&gt;<br>
2600
-
2601
-
2602
-
2603
- </td>
2604
-
2605
3803
 
2606
3804
 
2607
- <td class="default">
2608
-
2609
- null
2610
-
2611
- </td>
2612
-
2613
3805
 
2614
- <td class="description last"><p>The reason for wrapping up the <a href="Task.html">Task</a></p></td>
3806
+ <td class="description last"><p>The currently in process <a href="OutgoingTransfer.html">OutgoingTransfer</a></p></td>
2615
3807
  </tr>
2616
3808
 
2617
3809
 
2618
3810
  </tbody>
2619
3811
  </table>
2620
- </dl>
2621
3812
 
2622
3813
 
2623
3814
 
3815
+
3816
+ <dl class="details">
3817
+
3818
+
2624
3819
 
2625
3820
 
2626
3821
 
@@ -2658,19 +3853,25 @@
2658
3853
 
2659
3854
 
2660
3855
 
2661
- </dd>
2662
3856
 
2663
- </dl>
2664
3857
 
2665
3858
 
2666
3859
 
2667
- <h3 class="subsection-title">Events</h3>
2668
3860
 
2669
- <dl>
3861
+
3862
+
3863
+
3864
+
3865
+
3866
+
3867
+
3868
+ </dd>
3869
+
3870
+
2670
3871
 
2671
3872
  <hr>
2672
3873
  <dt>
2673
- <h4 class="name" id="event:canceled">canceled</h4>
3874
+ <h4 class="name" id="event:transferCompleted">transferCompleted</h4>
2674
3875
 
2675
3876
 
2676
3877
  </dt>
@@ -2678,7 +3879,7 @@
2678
3879
 
2679
3880
 
2680
3881
  <div class="description">
2681
- <p>The <a href="Task.html">Task</a> was canceled</p>
3882
+ <p>An <a href="OutgoingTransfer.html">OutgoingTransfer</a> has been competed for <a href="Task.html">Task</a></p>
2682
3883
  </div>
2683
3884
 
2684
3885
 
@@ -2713,13 +3914,13 @@
2713
3914
 
2714
3915
  <tr>
2715
3916
 
2716
- <td class="name"><code>task</code></td>
3917
+ <td class="name"><code>outgoingTransfer</code></td>
2717
3918
 
2718
3919
 
2719
3920
  <td class="type">
2720
3921
 
2721
3922
 
2722
- <span class="param-type"><a href="Task.html">Task</a></span>
3923
+ <span class="param-type"><a href="OutgoingTransfer.html">OutgoingTransfer</a></span>
2723
3924
 
2724
3925
 
2725
3926
 
@@ -2730,7 +3931,7 @@
2730
3931
 
2731
3932
 
2732
3933
 
2733
- <td class="description last"><p>The <a href="Task.html">Task</a> who was canceled</p></td>
3934
+ <td class="description last"><p>The currently in process <a href="OutgoingTransfer.html">OutgoingTransfer</a></p></td>
2734
3935
  </tr>
2735
3936
 
2736
3937
 
@@ -2798,7 +3999,7 @@
2798
3999
 
2799
4000
  <hr>
2800
4001
  <dt>
2801
- <h4 class="name" id="event:completed">completed</h4>
4002
+ <h4 class="name" id="event:transferFailed">transferFailed</h4>
2802
4003
 
2803
4004
 
2804
4005
  </dt>
@@ -2806,7 +4007,7 @@
2806
4007
 
2807
4008
 
2808
4009
  <div class="description">
2809
- <p>The <a href="Task.html">Task</a> was completed</p>
4010
+ <p>An <a href="OutgoingTransfer.html">OutgoingTransfer</a> has been failed for <a href="Task.html">Task</a></p>
2810
4011
  </div>
2811
4012
 
2812
4013
 
@@ -2841,13 +4042,13 @@
2841
4042
 
2842
4043
  <tr>
2843
4044
 
2844
- <td class="name"><code>task</code></td>
4045
+ <td class="name"><code>outgoingTransfer</code></td>
2845
4046
 
2846
4047
 
2847
4048
  <td class="type">
2848
4049
 
2849
4050
 
2850
- <span class="param-type"><a href="Task.html">Task</a></span>
4051
+ <span class="param-type"><a href="OutgoingTransfer.html">OutgoingTransfer</a></span>
2851
4052
 
2852
4053
 
2853
4054
 
@@ -2858,7 +4059,7 @@
2858
4059
 
2859
4060
 
2860
4061
 
2861
- <td class="description last"><p>The <a href="Task.html">Task</a> who was completed</p></td>
4062
+ <td class="description last"><p>The currently in process <a href="OutgoingTransfer.html">OutgoingTransfer</a></p></td>
2862
4063
  </tr>
2863
4064
 
2864
4065
 
@@ -3350,9 +4551,9 @@
3350
4551
 
3351
4552
 
3352
4553
  <span class="jsdoc-message">
3353
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
4554
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
3354
4555
 
3355
- on 2023-05-09T04:37:13+00:00
4556
+ on 2023-08-01T08:45:21+00:00
3356
4557
 
3357
4558
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
3358
4559
  </span>