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
 
@@ -97,8 +104,6 @@
97
104
  <dd>
98
105
 
99
106
 
100
-
101
-
102
107
 
103
108
 
104
109
 
@@ -131,6 +136,8 @@
131
136
  <th>Type</th>
132
137
 
133
138
 
139
+ <th>Argument</th>
140
+
134
141
 
135
142
 
136
143
 
@@ -157,6 +164,12 @@
157
164
  </td>
158
165
 
159
166
 
167
+ <td class="attributes">
168
+
169
+
170
+
171
+ </td>
172
+
160
173
 
161
174
 
162
175
 
@@ -181,6 +194,12 @@
181
194
  </td>
182
195
 
183
196
 
197
+ <td class="attributes">
198
+
199
+
200
+
201
+ </td>
202
+
184
203
 
185
204
 
186
205
 
@@ -205,6 +224,12 @@
205
224
  </td>
206
225
 
207
226
 
227
+ <td class="attributes">
228
+
229
+
230
+
231
+ </td>
232
+
208
233
 
209
234
 
210
235
 
@@ -221,7 +246,7 @@
221
246
  <td class="type">
222
247
 
223
248
 
224
- <span class="param-type">int</span>
249
+ <span class="param-type">number</span>
225
250
 
226
251
 
227
252
 
@@ -229,6 +254,14 @@
229
254
  </td>
230
255
 
231
256
 
257
+ <td class="attributes">
258
+
259
+ &lt;optional&gt;<br>
260
+
261
+
262
+
263
+ </td>
264
+
232
265
 
233
266
 
234
267
 
@@ -253,6 +286,12 @@
253
286
  </td>
254
287
 
255
288
 
289
+ <td class="attributes">
290
+
291
+
292
+
293
+ </td>
294
+
256
295
 
257
296
 
258
297
 
@@ -277,6 +316,12 @@
277
316
  </td>
278
317
 
279
318
 
319
+ <td class="attributes">
320
+
321
+
322
+
323
+ </td>
324
+
280
325
 
281
326
 
282
327
 
@@ -302,6 +347,14 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
302
347
  </td>
303
348
 
304
349
 
350
+ <td class="attributes">
351
+
352
+ &lt;optional&gt;<br>
353
+
354
+
355
+
356
+ </td>
357
+
305
358
 
306
359
 
307
360
 
@@ -310,6 +363,38 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
310
363
 
311
364
 
312
365
 
366
+ <tr>
367
+
368
+ <td class="name"><code>transfer</code></td>
369
+
370
+
371
+ <td class="type">
372
+
373
+
374
+ <span class="param-type"><a href="IncomingTransfer.html">IncomingTransfer</a></span>
375
+
376
+
377
+
378
+
379
+ </td>
380
+
381
+
382
+ <td class="attributes">
383
+
384
+ &lt;optional&gt;<br>
385
+
386
+
387
+
388
+ </td>
389
+
390
+
391
+
392
+
393
+ <td class="description last"><p>the <a href="IncomingTransfer.html">IncomingTransfer</a> tied to the <a href="Reservation.html">Reservation</a></p></td>
394
+ </tr>
395
+
396
+
397
+
313
398
  <tr>
314
399
 
315
400
  <td class="name"><code>timeout</code></td>
@@ -318,7 +403,7 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
318
403
  <td class="type">
319
404
 
320
405
 
321
- <span class="param-type">int</span>
406
+ <span class="param-type">number</span>
322
407
 
323
408
 
324
409
 
@@ -326,6 +411,12 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
326
411
  </td>
327
412
 
328
413
 
414
+ <td class="attributes">
415
+
416
+
417
+
418
+ </td>
419
+
329
420
 
330
421
 
331
422
 
@@ -350,6 +441,12 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
350
441
  </td>
351
442
 
352
443
 
444
+ <td class="attributes">
445
+
446
+
447
+
448
+ </td>
449
+
353
450
 
354
451
 
355
452
 
@@ -374,6 +471,12 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
374
471
  </td>
375
472
 
376
473
 
474
+ <td class="attributes">
475
+
476
+
477
+
478
+ </td>
479
+
377
480
 
378
481
 
379
482
 
@@ -398,6 +501,12 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
398
501
  </td>
399
502
 
400
503
 
504
+ <td class="attributes">
505
+
506
+
507
+
508
+ </td>
509
+
401
510
 
402
511
 
403
512
 
@@ -483,6 +592,15 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
483
592
  </div>
484
593
 
485
594
 
595
+ <h3 class="subsection-title">Extends</h3>
596
+
597
+
598
+
599
+
600
+ <ul>
601
+ <li>EventEmitter</li>
602
+ </ul>
603
+
486
604
 
487
605
 
488
606
 
@@ -495,29 +613,30 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
495
613
 
496
614
 
497
615
 
498
- <h3 class="subsection-title">Methods</h3>
616
+ <h3 class="subsection-title">Members</h3>
499
617
 
500
618
  <dl>
501
619
 
502
620
  <hr>
503
- <dt>
504
- <h4 class="name" id="accept"><span class="type-signature"></span>accept()</h4>
505
-
621
+ <dt class="name" id="accountSid">
622
+ <h4 id="accountSid"><span class="type-signature">&lt;readonly&gt; </span>accountSid<span class="type-signature"> :string</span></h4>
623
+
506
624
 
507
625
  </dt>
508
626
  <dd>
509
-
510
-
511
- <div class="description">
512
- <p>Accept the <a href="Reservation.html">Reservation</a></p>
513
- </div>
514
627
 
515
628
 
516
629
 
630
+ <h5>Type:</h5>
631
+ <ul>
632
+ <li>
633
+
634
+ <span class="param-type">string</span>
517
635
 
518
-
519
636
 
520
-
637
+
638
+ </li>
639
+ </ul>
521
640
 
522
641
 
523
642
 
@@ -561,42 +680,74 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
561
680
 
562
681
 
563
682
 
683
+ </dd>
684
+
685
+
686
+
687
+ <hr>
688
+ <dt class="name" id="canceledReasonCode">
689
+ <h4 id="canceledReasonCode"><span class="type-signature">&lt;readonly&gt; </span>canceledReasonCode<span class="type-signature"> :number|undefined</span></h4>
690
+
691
+
692
+ </dt>
693
+ <dd>
694
+
695
+
696
+
697
+ <h5>Type:</h5>
698
+ <ul>
699
+ <li>
700
+
701
+ <span class="param-type">number</span>
702
+ |
703
+
704
+ <span class="param-type">undefined</span>
564
705
 
706
+
707
+
708
+ </li>
709
+ </ul>
565
710
 
566
711
 
567
712
 
713
+ <dl class="details">
714
+
715
+
716
+
717
+
718
+
719
+
720
+
568
721
 
569
722
 
570
723
 
571
724
 
572
725
 
573
726
 
574
- <h5>Returns:</h5>
727
+
575
728
 
576
-
577
- <div class="param-desc">
578
- <ul>
579
- <li>Rejected if unable to issue Accept instruction on the <a href="Reservation.html">Reservation</a></li>
580
- </ul>
581
- </div>
582
729
 
730
+
583
731
 
732
+
584
733
 
585
- <dl>
586
- <dt>
587
- Type
588
- </dt>
589
- <dd>
590
-
591
- <span class="param-type">Promise.&lt;this&gt;</span>
734
+
592
735
 
736
+
593
737
 
738
+
594
739
 
595
- </dd>
596
- </dl>
597
740
 
598
741
 
599
-
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+ </dl>
750
+
600
751
 
601
752
 
602
753
  </dd>
@@ -604,150 +755,159 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
604
755
 
605
756
 
606
757
  <hr>
607
- <dt>
608
- <h4 class="name" id="call"><span class="type-signature"></span>call(from, url [, options])</h4>
609
-
758
+ <dt class="name" id="dateCreated">
759
+ <h4 id="dateCreated"><span class="type-signature">&lt;readonly&gt; </span>dateCreated<span class="type-signature"> :Date</span></h4>
760
+
610
761
 
611
762
  </dt>
612
763
  <dd>
613
-
614
-
615
- <div class="description">
616
- <p>Issue a Call to a <a href="Worker.html">Worker</a></p>
617
- </div>
618
764
 
619
765
 
620
766
 
767
+ <h5>Type:</h5>
768
+ <ul>
769
+ <li>
770
+
771
+ <span class="param-type">Date</span>
772
+
773
+
621
774
 
775
+ </li>
776
+ </ul>
622
777
 
623
778
 
624
779
 
780
+ <dl class="details">
625
781
 
626
- <h5>Parameters:</h5>
627
-
628
782
 
629
- <table class="params table table-striped">
630
- <thead>
631
- <tr>
632
-
633
- <th>Name</th>
634
-
783
+
635
784
 
636
- <th>Type</th>
785
+
637
786
 
638
-
639
- <th>Argument</th>
640
-
787
+
641
788
 
642
-
789
+
643
790
 
644
- <th class="last">Description</th>
645
- </tr>
646
- </thead>
791
+
647
792
 
648
- <tbody>
649
793
 
650
794
 
651
- <tr>
652
-
653
- <td class="name"><code>from</code></td>
654
-
795
+
655
796
 
656
- <td class="type">
657
-
658
-
659
- <span class="param-type">string</span>
797
+
660
798
 
799
+
661
800
 
801
+
662
802
 
663
-
664
- </td>
803
+
665
804
 
666
-
667
- <td class="attributes">
668
-
805
+
669
806
 
670
-
671
807
 
672
-
673
- </td>
674
-
675
808
 
676
-
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+ </dl>
677
817
 
678
- <td class="description last"><p>The caller id for the call to a <a href="Worker.html">Worker</a></p></td>
679
- </tr>
680
818
 
681
819
 
820
+ </dd>
682
821
 
683
- <tr>
684
-
685
- <td class="name"><code>url</code></td>
822
+
686
823
 
824
+ <hr>
825
+ <dt class="name" id="dateUpdated">
826
+ <h4 id="dateUpdated"><span class="type-signature">&lt;readonly&gt; </span>dateUpdated<span class="type-signature"> :Date</span></h4>
687
827
 
688
- <td class="type">
689
-
828
+
829
+ </dt>
830
+ <dd>
831
+
832
+
833
+
834
+ <h5>Type:</h5>
835
+ <ul>
836
+ <li>
690
837
 
691
- <span class="param-type">string</span>
838
+ <span class="param-type">Date</span>
692
839
 
693
840
 
694
841
 
695
-
696
- </td>
842
+ </li>
843
+ </ul>
844
+
697
845
 
698
-
699
- <td class="attributes">
700
-
846
+
847
+ <dl class="details">
848
+
701
849
 
702
-
850
+
703
851
 
704
-
705
- </td>
706
-
852
+
707
853
 
708
-
854
+
709
855
 
710
- <td class="description last"><p>A valid TwiML URI that is executed on the answering Worker's leg</p></td>
711
- </tr>
856
+
712
857
 
713
858
 
714
859
 
715
- <tr>
716
-
717
- <td class="name"><code>options</code></td>
718
-
860
+
719
861
 
720
- <td class="type">
721
-
722
-
723
- <span class="param-type"><a href="Reservation.html#.CallOptions">Reservation.CallOptions</a></span>
862
+
724
863
 
864
+
725
865
 
866
+
726
867
 
727
-
728
- </td>
868
+
729
869
 
730
-
731
- <td class="attributes">
732
-
733
- &lt;optional&gt;<br>
734
-
870
+
735
871
 
736
-
872
+
873
+
874
+
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+ </dl>
737
884
 
738
-
739
- </td>
740
-
741
885
 
886
+
887
+ </dd>
888
+
889
+
742
890
 
891
+ <hr>
892
+ <dt class="name" id="sid">
893
+ <h4 id="sid"><span class="type-signature">&lt;readonly&gt; </span>sid<span class="type-signature"> :string</span></h4>
743
894
 
744
- <td class="description last"></td>
745
- </tr>
895
+
896
+ </dt>
897
+ <dd>
898
+
746
899
 
747
900
 
748
- </tbody>
749
- </table>
901
+ <h5>Type:</h5>
902
+ <ul>
903
+ <li>
904
+
905
+ <span class="param-type">string</span>
906
+
907
+
750
908
 
909
+ </li>
910
+ </ul>
751
911
 
752
912
 
753
913
 
@@ -791,42 +951,92 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
791
951
 
792
952
 
793
953
 
954
+ </dd>
955
+
956
+
957
+
958
+ <hr>
959
+ <dt class="name" id="status">
960
+ <h4 id="status"><span class="type-signature">&lt;readonly&gt; </span>status<span class="type-signature"> :"pending"|"accepted"|"rejected"|"timeout"|"canceled"|"rescinded"|"wrapping"|"completed"</span></h4>
961
+
962
+
963
+ </dt>
964
+ <dd>
965
+
966
+
967
+
968
+ <h5>Type:</h5>
969
+ <ul>
970
+ <li>
971
+
972
+ <span class="param-type">"pending"</span>
973
+ |
974
+
975
+ <span class="param-type">"accepted"</span>
976
+ |
977
+
978
+ <span class="param-type">"rejected"</span>
979
+ |
980
+
981
+ <span class="param-type">"timeout"</span>
982
+ |
983
+
984
+ <span class="param-type">"canceled"</span>
985
+ |
986
+
987
+ <span class="param-type">"rescinded"</span>
988
+ |
989
+
990
+ <span class="param-type">"wrapping"</span>
991
+ |
992
+
993
+ <span class="param-type">"completed"</span>
794
994
 
995
+
996
+
997
+ </li>
998
+ </ul>
795
999
 
796
1000
 
797
1001
 
1002
+ <dl class="details">
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
798
1010
 
799
1011
 
800
1012
 
801
1013
 
802
1014
 
803
1015
 
804
- <h5>Returns:</h5>
1016
+
805
1017
 
806
-
807
- <div class="param-desc">
808
- <ul>
809
- <li>Rejected if unable to issue Call instruction on the <a href="Reservation.html">Reservation</a></li>
810
- </ul>
811
- </div>
812
1018
 
1019
+
813
1020
 
1021
+
814
1022
 
815
- <dl>
816
- <dt>
817
- Type
818
- </dt>
819
- <dd>
820
-
821
- <span class="param-type">Promise.&lt;this&gt;</span>
1023
+
822
1024
 
1025
+
823
1026
 
1027
+
824
1028
 
825
- </dd>
826
- </dl>
827
1029
 
828
1030
 
829
-
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+ </dl>
1039
+
830
1040
 
831
1041
 
832
1042
  </dd>
@@ -834,24 +1044,28 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
834
1044
 
835
1045
 
836
1046
  <hr>
837
- <dt>
838
- <h4 class="name" id="complete"><span class="type-signature"></span>complete()</h4>
839
-
1047
+ <dt class="name" id="task">
1048
+ <h4 id="task"><span class="type-signature">&lt;readonly&gt; </span>task<span class="type-signature"> :<a href="Task.html">Task</a>|Object</span></h4>
1049
+
840
1050
 
841
1051
  </dt>
842
1052
  <dd>
843
-
844
-
845
- <div class="description">
846
- <p>Complete the <a href="Reservation.html">Reservation</a></p>
847
- </div>
848
1053
 
849
1054
 
850
1055
 
1056
+ <h5>Type:</h5>
1057
+ <ul>
1058
+ <li>
1059
+
1060
+ <span class="param-type"><a href="Task.html">Task</a></span>
1061
+ |
851
1062
 
852
-
1063
+ <span class="param-type">Object</span>
853
1064
 
854
-
1065
+
1066
+
1067
+ </li>
1068
+ </ul>
855
1069
 
856
1070
 
857
1071
 
@@ -895,42 +1109,71 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
895
1109
 
896
1110
 
897
1111
 
1112
+ </dd>
898
1113
 
899
-
1114
+
1115
+
1116
+ <hr>
1117
+ <dt class="name" id="timeout">
1118
+ <h4 id="timeout"><span class="type-signature">&lt;readonly&gt; </span>timeout<span class="type-signature"> :number</span></h4>
900
1119
 
901
1120
 
1121
+ </dt>
1122
+ <dd>
1123
+
902
1124
 
903
1125
 
1126
+ <h5>Type:</h5>
1127
+ <ul>
1128
+ <li>
1129
+
1130
+ <span class="param-type">number</span>
1131
+
904
1132
 
1133
+
1134
+ </li>
1135
+ </ul>
905
1136
 
906
1137
 
907
1138
 
908
- <h5>Returns:</h5>
1139
+ <dl class="details">
909
1140
 
910
-
911
- <div class="param-desc">
912
- <ul>
913
- <li>Rejected if unable to issue Complete instruction on the <a href="Reservation.html">Reservation</a></li>
914
- </ul>
915
- </div>
916
1141
 
1142
+
917
1143
 
1144
+
918
1145
 
919
- <dl>
920
- <dt>
921
- Type
922
- </dt>
923
- <dd>
924
-
925
- <span class="param-type">Promise.&lt;this&gt;</span>
1146
+
926
1147
 
1148
+
927
1149
 
1150
+
928
1151
 
929
- </dd>
930
- </dl>
1152
+
931
1153
 
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+
1171
+
1172
+
1173
+
1174
+
1175
+ </dl>
932
1176
 
933
-
934
1177
 
935
1178
 
936
1179
  </dd>
@@ -938,86 +1181,95 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
938
1181
 
939
1182
 
940
1183
  <hr>
941
- <dt>
942
- <h4 class="name" id="conference"><span class="type-signature"></span>conference( [options])</h4>
943
-
1184
+ <dt class="name" id="transfer">
1185
+ <h4 id="transfer"><span class="type-signature">&lt;readonly&gt; </span>transfer<span class="type-signature"> :<a href="IncomingTransfer.html">IncomingTransfer</a>|Object</span></h4>
1186
+
944
1187
 
945
1188
  </dt>
946
1189
  <dd>
1190
+
947
1191
 
948
1192
 
949
- <div class="description">
950
- <p>Conference the active Call tied to this <a href="Reservation.html">Reservation</a> to the <a href="Worker.html">Worker</a></p>
951
- </div>
1193
+ <h5>Type:</h5>
1194
+ <ul>
1195
+ <li>
1196
+
1197
+ <span class="param-type"><a href="IncomingTransfer.html">IncomingTransfer</a></span>
1198
+ |
1199
+
1200
+ <span class="param-type">Object</span>
1201
+
1202
+
1203
+
1204
+ </li>
1205
+ </ul>
952
1206
 
953
1207
 
954
1208
 
1209
+ <dl class="details">
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+
955
1217
 
956
1218
 
957
1219
 
958
1220
 
1221
+
959
1222
 
960
- <h5>Parameters:</h5>
961
-
962
1223
 
963
- <table class="params table table-striped">
964
- <thead>
965
- <tr>
966
-
967
- <th>Name</th>
968
-
1224
+
969
1225
 
970
- <th>Type</th>
1226
+
971
1227
 
972
-
973
- <th>Argument</th>
974
-
1228
+
975
1229
 
976
-
1230
+
977
1231
 
978
- <th class="last">Description</th>
979
- </tr>
980
- </thead>
1232
+
981
1233
 
982
- <tbody>
983
-
1234
+
984
1235
 
985
- <tr>
986
-
987
- <td class="name"><code>options</code></td>
988
-
989
1236
 
990
- <td class="type">
991
-
992
-
993
- <span class="param-type"><a href="Reservation.html#.ConferenceOptions">Reservation.ConferenceOptions</a></span>
994
1237
 
1238
+
995
1239
 
1240
+
996
1241
 
997
-
998
- </td>
1242
+
999
1243
 
1000
-
1001
- <td class="attributes">
1002
-
1003
- &lt;optional&gt;<br>
1004
-
1244
+
1245
+ </dl>
1005
1246
 
1006
-
1007
1247
 
1008
-
1009
- </td>
1010
-
1248
+
1249
+ </dd>
1011
1250
 
1251
+
1012
1252
 
1253
+ <hr>
1254
+ <dt class="name" id="version">
1255
+ <h4 id="version"><span class="type-signature">&lt;readonly&gt; </span>version<span class="type-signature"> :string</span></h4>
1013
1256
 
1014
- <td class="description last"></td>
1015
- </tr>
1257
+
1258
+ </dt>
1259
+ <dd>
1260
+
1016
1261
 
1017
1262
 
1018
- </tbody>
1019
- </table>
1263
+ <h5>Type:</h5>
1264
+ <ul>
1265
+ <li>
1266
+
1267
+ <span class="param-type">string</span>
1268
+
1269
+
1020
1270
 
1271
+ </li>
1272
+ </ul>
1021
1273
 
1022
1274
 
1023
1275
 
@@ -1061,131 +1313,97 @@ Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded',
1061
1313
 
1062
1314
 
1063
1315
 
1316
+ </dd>
1064
1317
 
1065
-
1066
-
1067
-
1318
+
1319
+
1320
+ <hr>
1321
+ <dt class="name" id="workerSid">
1322
+ <h4 id="workerSid"><span class="type-signature">&lt;readonly&gt; </span>workerSid<span class="type-signature"> :string</span></h4>
1068
1323
 
1069
1324
 
1070
-
1325
+ </dt>
1326
+ <dd>
1071
1327
 
1072
1328
 
1073
1329
 
1074
- <h5>Returns:</h5>
1075
-
1076
-
1077
- <div class="param-desc">
1078
- <ul>
1079
- <li>Rejected if unable to issue Conference instruction on the link <a href="Reservation.html">Reservation</a></li>
1080
- </ul>
1081
- </div>
1082
-
1330
+ <h5>Type:</h5>
1331
+ <ul>
1332
+ <li>
1333
+
1334
+ <span class="param-type">string</span>
1083
1335
 
1084
1336
 
1085
- <dl>
1086
- <dt>
1087
- Type
1088
- </dt>
1089
- <dd>
1090
-
1091
- <span class="param-type">Promise.&lt;this&gt;</span>
1092
1337
 
1338
+ </li>
1339
+ </ul>
1340
+
1093
1341
 
1342
+
1343
+ <dl class="details">
1344
+
1094
1345
 
1095
- </dd>
1096
- </dl>
1346
+
1097
1347
 
1348
+
1098
1349
 
1099
-
1350
+
1100
1351
 
1101
1352
 
1102
- </dd>
1103
1353
 
1104
-
1105
-
1106
- <hr>
1107
- <dt>
1108
- <h4 class="name" id="dequeue"><span class="type-signature"></span>dequeue( [options])</h4>
1109
-
1110
1354
 
1111
- </dt>
1112
- <dd>
1113
1355
 
1114
1356
 
1115
- <div class="description">
1116
- <p>Dequeue the <a href="Reservation.html">Reservation</a> to the <a href="Worker.html">Worker</a>. This will perform telephony to dequeue a
1117
- <a href="Task.html">Task</a> that was enqueued using the Enqueue TwiML verb. A contact_uri must exist
1118
- in the <a href="Worker.html">Worker</a>'s attributes for this call to go through.</p>
1119
- </div>
1120
-
1121
1357
 
1122
1358
 
1123
1359
 
1124
-
1360
+
1125
1361
 
1126
-
1127
-
1128
- <h5>Parameters:</h5>
1129
-
1362
+
1130
1363
 
1131
- <table class="params table table-striped">
1132
- <thead>
1133
- <tr>
1134
-
1135
- <th>Name</th>
1136
-
1364
+
1137
1365
 
1138
- <th>Type</th>
1366
+
1139
1367
 
1140
-
1141
- <th>Argument</th>
1142
-
1368
+
1143
1369
 
1144
-
1145
1370
 
1146
- <th class="last">Description</th>
1147
- </tr>
1148
- </thead>
1149
1371
 
1150
- <tbody>
1151
-
1372
+
1152
1373
 
1153
- <tr>
1154
-
1155
- <td class="name"><code>options</code></td>
1156
-
1374
+
1157
1375
 
1158
- <td class="type">
1159
-
1160
-
1161
- <span class="param-type"><a href="Reservation.html#.DequeueOptions">Reservation.DequeueOptions</a></span>
1376
+
1162
1377
 
1378
+
1379
+ </dl>
1163
1380
 
1164
1381
 
1165
-
1166
- </td>
1382
+
1383
+ </dd>
1167
1384
 
1385
+
1168
1386
 
1169
- <td class="attributes">
1170
-
1171
- &lt;optional&gt;<br>
1172
-
1387
+ <hr>
1388
+ <dt class="name" id="workspaceSid">
1389
+ <h4 id="workspaceSid"><span class="type-signature">&lt;readonly&gt; </span>workspaceSid<span class="type-signature"> :string</span></h4>
1173
1390
 
1174
-
1391
+
1392
+ </dt>
1393
+ <dd>
1394
+
1175
1395
 
1396
+
1397
+ <h5>Type:</h5>
1398
+ <ul>
1399
+ <li>
1176
1400
 
1177
- </td>
1178
-
1179
-
1180
-
1401
+ <span class="param-type">string</span>
1181
1402
 
1182
- <td class="description last"></td>
1183
- </tr>
1184
1403
 
1185
-
1186
- </tbody>
1187
- </table>
1188
1404
 
1405
+ </li>
1406
+ </ul>
1189
1407
 
1190
1408
 
1191
1409
 
@@ -1229,59 +1447,27 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1229
1447
 
1230
1448
 
1231
1449
 
1450
+ </dd>
1232
1451
 
1452
+ </dl>
1233
1453
 
1234
1454
 
1235
1455
 
1456
+ <h3 class="subsection-title">Methods</h3>
1236
1457
 
1458
+ <dl>
1459
+
1460
+ <hr>
1461
+ <dt>
1462
+ <h4 class="name" id="accept"><span class="type-signature"></span>accept()</h4>
1237
1463
 
1238
-
1239
1464
 
1240
-
1241
-
1242
- <h5>Returns:</h5>
1243
-
1244
-
1245
- <div class="param-desc">
1246
- <ul>
1247
- <li>Rejected if unable to issue Dequeue instruction on the <a href="Reservation.html">Reservation</a></li>
1248
- </ul>
1249
- </div>
1250
-
1251
-
1252
-
1253
- <dl>
1254
- <dt>
1255
- Type
1256
- </dt>
1257
- <dd>
1258
-
1259
- <span class="param-type">Promise.&lt;this&gt;</span>
1260
-
1261
-
1262
-
1263
- </dd>
1264
- </dl>
1265
-
1266
-
1267
-
1268
-
1269
-
1270
- </dd>
1271
-
1272
-
1273
-
1274
- <hr>
1275
- <dt>
1276
- <h4 class="name" id="fetchLatestVersion"><span class="type-signature"></span>fetchLatestVersion()</h4>
1277
-
1278
-
1279
- </dt>
1280
- <dd>
1465
+ </dt>
1466
+ <dd>
1281
1467
 
1282
1468
 
1283
1469
  <div class="description">
1284
- <p>Fetch the last version of this <a href="Reservation.html">Reservation</a></p>
1470
+ <p>Accept the <a href="Reservation.html">Reservation</a></p>
1285
1471
  </div>
1286
1472
 
1287
1473
 
@@ -1346,6 +1532,12 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1346
1532
  <h5>Returns:</h5>
1347
1533
 
1348
1534
 
1535
+ <div class="param-desc">
1536
+ <ul>
1537
+ <li>Rejected if unable to issue Accept instruction on the <a href="Reservation.html">Reservation</a></li>
1538
+ </ul>
1539
+ </div>
1540
+
1349
1541
 
1350
1542
 
1351
1543
  <dl>
@@ -1354,7 +1546,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1354
1546
  </dt>
1355
1547
  <dd>
1356
1548
 
1357
- <span class="param-type">Promise.&lt;<a href="Reservation.html">Reservation</a>&gt;</span>
1549
+ <span class="param-type">Promise.&lt;this&gt;</span>
1358
1550
 
1359
1551
 
1360
1552
 
@@ -1371,7 +1563,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1371
1563
 
1372
1564
  <hr>
1373
1565
  <dt>
1374
- <h4 class="name" id="redirect"><span class="type-signature"></span>redirect(callSid, url [, options])</h4>
1566
+ <h4 class="name" id="call"><span class="type-signature"></span>call(from, url [, options])</h4>
1375
1567
 
1376
1568
 
1377
1569
  </dt>
@@ -1379,7 +1571,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1379
1571
 
1380
1572
 
1381
1573
  <div class="description">
1382
- <p>Redirect the active Call tied to this <a href="Reservation.html">Reservation</a></p>
1574
+ <p>Issue a Call to a <a href="Worker.html">Worker</a></p>
1383
1575
  </div>
1384
1576
 
1385
1577
 
@@ -1416,7 +1608,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1416
1608
 
1417
1609
  <tr>
1418
1610
 
1419
- <td class="name"><code>callSid</code></td>
1611
+ <td class="name"><code>from</code></td>
1420
1612
 
1421
1613
 
1422
1614
  <td class="type">
@@ -1441,7 +1633,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1441
1633
 
1442
1634
 
1443
1635
 
1444
- <td class="description last"><p>The sid of the Call to redirect</p></td>
1636
+ <td class="description last"><p>The caller id for the call to a <a href="Worker.html">Worker</a></p></td>
1445
1637
  </tr>
1446
1638
 
1447
1639
 
@@ -1473,7 +1665,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1473
1665
 
1474
1666
 
1475
1667
 
1476
- <td class="description last"><p>A valid TwiML URI that is executed on the Caller's leg upon redirecting</p></td>
1668
+ <td class="description last"><p>A valid TwiML URI that is executed on the answering Worker's leg</p></td>
1477
1669
  </tr>
1478
1670
 
1479
1671
 
@@ -1486,7 +1678,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1486
1678
  <td class="type">
1487
1679
 
1488
1680
 
1489
- <span class="param-type"><a href="Reservation.html#.RedirectOptions">Reservation.RedirectOptions</a></span>
1681
+ <span class="param-type"><a href="global.html#CallOptions">CallOptions</a></span>
1490
1682
 
1491
1683
 
1492
1684
 
@@ -1572,7 +1764,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1572
1764
 
1573
1765
  <div class="param-desc">
1574
1766
  <ul>
1575
- <li>Rejected if unable to issue Redirect instruction on the <a href="Reservation.html">Reservation</a></li>
1767
+ <li>Rejected if unable to issue Call instruction on the <a href="Reservation.html">Reservation</a></li>
1576
1768
  </ul>
1577
1769
  </div>
1578
1770
 
@@ -1601,7 +1793,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1601
1793
 
1602
1794
  <hr>
1603
1795
  <dt>
1604
- <h4 class="name" id="reject"><span class="type-signature"></span>reject( [options])</h4>
1796
+ <h4 class="name" id="complete"><span class="type-signature"></span>complete()</h4>
1605
1797
 
1606
1798
 
1607
1799
  </dt>
@@ -1609,7 +1801,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1609
1801
 
1610
1802
 
1611
1803
  <div class="description">
1612
- <p>Reject the <a href="Reservation.html">Reservation</a></p>
1804
+ <p>Complete the <a href="Reservation.html">Reservation</a></p>
1613
1805
  </div>
1614
1806
 
1615
1807
 
@@ -1619,68 +1811,6 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1619
1811
 
1620
1812
 
1621
1813
 
1622
- <h5>Parameters:</h5>
1623
-
1624
-
1625
- <table class="params table table-striped">
1626
- <thead>
1627
- <tr>
1628
-
1629
- <th>Name</th>
1630
-
1631
-
1632
- <th>Type</th>
1633
-
1634
-
1635
- <th>Argument</th>
1636
-
1637
-
1638
-
1639
-
1640
- <th class="last">Description</th>
1641
- </tr>
1642
- </thead>
1643
-
1644
- <tbody>
1645
-
1646
-
1647
- <tr>
1648
-
1649
- <td class="name"><code>options</code></td>
1650
-
1651
-
1652
- <td class="type">
1653
-
1654
-
1655
- <span class="param-type"><a href="Reservation.html#.RejectOptions">Reservation.RejectOptions</a></span>
1656
-
1657
-
1658
-
1659
-
1660
- </td>
1661
-
1662
-
1663
- <td class="attributes">
1664
-
1665
- &lt;optional&gt;<br>
1666
-
1667
-
1668
-
1669
-
1670
-
1671
- </td>
1672
-
1673
-
1674
-
1675
-
1676
- <td class="description last"></td>
1677
- </tr>
1678
-
1679
-
1680
- </tbody>
1681
- </table>
1682
-
1683
-
1684
1814
 
1685
1815
 
1686
1816
  <dl class="details">
@@ -1738,7 +1868,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1738
1868
 
1739
1869
  <div class="param-desc">
1740
1870
  <ul>
1741
- <li>Rejected if unable to issue Reject instruction on the <a href="Reservation.html">Reservation</a></li>
1871
+ <li>Rejected if unable to issue Complete instruction on the <a href="Reservation.html">Reservation</a></li>
1742
1872
  </ul>
1743
1873
  </div>
1744
1874
 
@@ -1767,7 +1897,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1767
1897
 
1768
1898
  <hr>
1769
1899
  <dt>
1770
- <h4 class="name" id="updateParticipant"><span class="type-signature"></span>updateParticipant( [options])</h4>
1900
+ <h4 class="name" id="conference"><span class="type-signature"></span>conference( [options])</h4>
1771
1901
 
1772
1902
 
1773
1903
  </dt>
@@ -1775,7 +1905,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1775
1905
 
1776
1906
 
1777
1907
  <div class="description">
1778
- <p>Update the <a href="Worker.html">Worker</a>'s leg in the Conference associated to this <a href="Reservation.html">Reservation</a></p>
1908
+ <p>Conference the active Call tied to this <a href="Reservation.html">Reservation</a> to the <a href="Worker.html">Worker</a></p>
1779
1909
  </div>
1780
1910
 
1781
1911
 
@@ -1818,7 +1948,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1818
1948
  <td class="type">
1819
1949
 
1820
1950
 
1821
- <span class="param-type"><a href="Reservation.html#.ParticipantOptions">Reservation.ParticipantOptions</a></span>
1951
+ <span class="param-type"><a href="global.html#ConferenceOptions">ConferenceOptions</a></span>
1822
1952
 
1823
1953
 
1824
1954
 
@@ -1904,7 +2034,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1904
2034
 
1905
2035
  <div class="param-desc">
1906
2036
  <ul>
1907
- <li>Rejected if unable to update the Worker's leg in the Conference tied to the <a href="Reservation.html">Reservation</a></li>
2037
+ <li>Rejected if unable to issue Conference instruction on the link <a href="Reservation.html">Reservation</a></li>
1908
2038
  </ul>
1909
2039
  </div>
1910
2040
 
@@ -1933,7 +2063,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1933
2063
 
1934
2064
  <hr>
1935
2065
  <dt>
1936
- <h4 class="name" id="wrap"><span class="type-signature"></span>wrap()</h4>
2066
+ <h4 class="name" id="dequeue"><span class="type-signature"></span>dequeue( [options])</h4>
1937
2067
 
1938
2068
 
1939
2069
  </dt>
@@ -1941,7 +2071,9 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1941
2071
 
1942
2072
 
1943
2073
  <div class="description">
1944
- <p>Wrap the <a href="Reservation.html">Reservation</a></p>
2074
+ <p>Dequeue the <a href="Reservation.html">Reservation</a> to the <a href="Worker.html">Worker</a>. This will perform telephony to dequeue a
2075
+ <a href="Task.html">Task</a> that was enqueued using the Enqueue TwiML verb. A contact_uri must exist
2076
+ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through.</p>
1945
2077
  </div>
1946
2078
 
1947
2079
 
@@ -1951,6 +2083,68 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
1951
2083
 
1952
2084
 
1953
2085
 
2086
+ <h5>Parameters:</h5>
2087
+
2088
+
2089
+ <table class="params table table-striped">
2090
+ <thead>
2091
+ <tr>
2092
+
2093
+ <th>Name</th>
2094
+
2095
+
2096
+ <th>Type</th>
2097
+
2098
+
2099
+ <th>Argument</th>
2100
+
2101
+
2102
+
2103
+
2104
+ <th class="last">Description</th>
2105
+ </tr>
2106
+ </thead>
2107
+
2108
+ <tbody>
2109
+
2110
+
2111
+ <tr>
2112
+
2113
+ <td class="name"><code>options</code></td>
2114
+
2115
+
2116
+ <td class="type">
2117
+
2118
+
2119
+ <span class="param-type"><a href="global.html#DequeueOptions">DequeueOptions</a></span>
2120
+
2121
+
2122
+
2123
+
2124
+ </td>
2125
+
2126
+
2127
+ <td class="attributes">
2128
+
2129
+ &lt;optional&gt;<br>
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+ </td>
2136
+
2137
+
2138
+
2139
+
2140
+ <td class="description last"></td>
2141
+ </tr>
2142
+
2143
+
2144
+ </tbody>
2145
+ </table>
2146
+
2147
+
1954
2148
 
1955
2149
 
1956
2150
  <dl class="details">
@@ -2008,7 +2202,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
2008
2202
 
2009
2203
  <div class="param-desc">
2010
2204
  <ul>
2011
- <li>Rejected if unable to issue Wrap instruction on the <a href="Reservation.html">Reservation</a></li>
2205
+ <li>Rejected if unable to issue Dequeue instruction on the <a href="Reservation.html">Reservation</a></li>
2012
2206
  </ul>
2013
2207
  </div>
2014
2208
 
@@ -2033,1532 +2227,46 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
2033
2227
 
2034
2228
  </dd>
2035
2229
 
2036
- </dl>
2037
-
2038
-
2039
-
2040
- <h3 class="subsection-title">Type Definitions</h3>
2041
-
2042
- <dl>
2043
-
2230
+
2231
+
2044
2232
  <hr>
2045
- <dt class="name" id=".CallOptions">
2046
- <h4 id=".CallOptions">CallOptions</h4>
2047
-
2233
+ <dt>
2234
+ <h4 class="name" id="fetchLatestVersion"><span class="type-signature"></span>fetchLatestVersion()</h4>
2235
+
2048
2236
 
2049
2237
  </dt>
2050
2238
  <dd>
2051
-
2052
2239
 
2053
2240
 
2054
- <h5>Type:</h5>
2055
- <ul>
2056
- <li>
2057
-
2058
- <span class="param-type">Object</span>
2241
+ <div class="description">
2242
+ <p>Fetch the last version of this <a href="Reservation.html">Reservation</a></p>
2243
+ </div>
2244
+
2059
2245
 
2246
+
2060
2247
 
2248
+
2061
2249
 
2062
- </li>
2063
- </ul>
2250
+
2064
2251
 
2065
2252
 
2066
2253
 
2067
2254
  <dl class="details">
2068
2255
 
2069
2256
 
2070
- <h5 class="subsection-title">Properties:</h5>
2257
+
2071
2258
 
2072
- <dl>
2259
+
2073
2260
 
2074
- <table class="props table table-striped">
2075
- <thead>
2076
- <tr>
2077
-
2078
- <th>Name</th>
2079
-
2261
+
2080
2262
 
2081
- <th>Type</th>
2263
+
2082
2264
 
2083
-
2084
- <th>Argument</th>
2085
-
2265
+
2086
2266
 
2087
-
2088
- <th>Default</th>
2089
-
2267
+
2090
2268
 
2091
- <th class="last">Description</th>
2092
- </tr>
2093
- </thead>
2094
-
2095
- <tbody>
2096
-
2097
-
2098
- <tr>
2099
-
2100
- <td class="name"><code>accept</code></td>
2101
-
2102
-
2103
- <td class="type">
2104
-
2105
-
2106
- <span class="param-type">boolean</span>
2107
-
2108
-
2109
-
2110
-
2111
- </td>
2112
-
2113
-
2114
- <td class="attributes">
2115
-
2116
- &lt;optional&gt;<br>
2117
-
2118
-
2119
-
2120
- </td>
2121
-
2122
-
2123
-
2124
- <td class="default">
2125
-
2126
- false
2127
-
2128
- </td>
2129
-
2130
-
2131
- <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
2132
- accepted before initiating the call</p></td>
2133
- </tr>
2134
-
2135
-
2136
-
2137
- <tr>
2138
-
2139
- <td class="name"><code>record</code></td>
2140
-
2141
-
2142
- <td class="type">
2143
-
2144
-
2145
- <span class="param-type">string</span>
2146
-
2147
-
2148
-
2149
-
2150
- </td>
2151
-
2152
-
2153
- <td class="attributes">
2154
-
2155
- &lt;optional&gt;<br>
2156
-
2157
-
2158
-
2159
- </td>
2160
-
2161
-
2162
-
2163
- <td class="default">
2164
-
2165
- 'do-not-record'
2166
-
2167
- </td>
2168
-
2169
-
2170
- <td class="description last"><p>To record the call or not</p></td>
2171
- </tr>
2172
-
2173
-
2174
-
2175
- <tr>
2176
-
2177
- <td class="name"><code>statusCallbackUrl</code></td>
2178
-
2179
-
2180
- <td class="type">
2181
-
2182
-
2183
- <span class="param-type">string</span>
2184
-
2185
-
2186
-
2187
-
2188
- </td>
2189
-
2190
-
2191
- <td class="attributes">
2192
-
2193
- &lt;optional&gt;<br>
2194
-
2195
-
2196
-
2197
- </td>
2198
-
2199
-
2200
-
2201
- <td class="default">
2202
-
2203
- null
2204
-
2205
- </td>
2206
-
2207
-
2208
- <td class="description last"><p>A valid status status callback url</p></td>
2209
- </tr>
2210
-
2211
-
2212
-
2213
- <tr>
2214
-
2215
- <td class="name"><code>to</code></td>
2216
-
2217
-
2218
- <td class="type">
2219
-
2220
-
2221
- <span class="param-type">string</span>
2222
-
2223
-
2224
-
2225
-
2226
- </td>
2227
-
2228
-
2229
- <td class="attributes">
2230
-
2231
- &lt;optional&gt;<br>
2232
-
2233
-
2234
-
2235
- </td>
2236
-
2237
-
2238
-
2239
- <td class="default">
2240
-
2241
- null
2242
-
2243
- </td>
2244
-
2245
-
2246
- <td class="description last"><p>The number or endpoint that should be called.
2247
- If not provided, the contact_uri defined in the <a href="Worker.html">Worker</a> attributes will be used</p></td>
2248
- </tr>
2249
-
2250
-
2251
-
2252
- <tr>
2253
-
2254
- <td class="name"><code>timeout</code></td>
2255
-
2256
-
2257
- <td class="type">
2258
-
2259
-
2260
- <span class="param-type">number</span>
2261
-
2262
-
2263
-
2264
-
2265
- </td>
2266
-
2267
-
2268
- <td class="attributes">
2269
-
2270
- &lt;optional&gt;<br>
2271
-
2272
-
2273
-
2274
- </td>
2275
-
2276
-
2277
-
2278
- <td class="default">
2279
-
2280
- 60
2281
-
2282
- </td>
2283
-
2284
-
2285
- <td class="description last"><p>The integer number of seconds Twilio should allow the phone associated to "contact_uri" to ring</p></td>
2286
- </tr>
2287
-
2288
-
2289
- </tbody>
2290
- </table>
2291
- </dl>
2292
-
2293
-
2294
-
2295
-
2296
-
2297
-
2298
-
2299
-
2300
-
2301
-
2302
-
2303
-
2304
-
2305
-
2306
-
2307
-
2308
-
2309
-
2310
-
2311
-
2312
-
2313
-
2314
-
2315
-
2316
-
2317
-
2318
-
2319
-
2320
-
2321
-
2322
-
2323
-
2324
-
2325
-
2326
-
2327
-
2328
- </dl>
2329
-
2330
-
2331
-
2332
- </dd>
2333
-
2334
-
2335
-
2336
- <hr>
2337
- <dt class="name" id=".ConferenceOptions">
2338
- <h4 id=".ConferenceOptions">ConferenceOptions</h4>
2339
-
2340
-
2341
- </dt>
2342
- <dd>
2343
-
2344
-
2345
-
2346
- <h5>Type:</h5>
2347
- <ul>
2348
- <li>
2349
-
2350
- <span class="param-type">Object</span>
2351
-
2352
-
2353
-
2354
- </li>
2355
- </ul>
2356
-
2357
-
2358
-
2359
- <dl class="details">
2360
-
2361
-
2362
- <h5 class="subsection-title">Properties:</h5>
2363
-
2364
- <dl>
2365
-
2366
- <table class="props table table-striped">
2367
- <thead>
2368
- <tr>
2369
-
2370
- <th>Name</th>
2371
-
2372
-
2373
- <th>Type</th>
2374
-
2375
-
2376
- <th>Argument</th>
2377
-
2378
-
2379
-
2380
- <th>Default</th>
2381
-
2382
-
2383
- <th class="last">Description</th>
2384
- </tr>
2385
- </thead>
2386
-
2387
- <tbody>
2388
-
2389
-
2390
- <tr>
2391
-
2392
- <td class="name"><code>to</code></td>
2393
-
2394
-
2395
- <td class="type">
2396
-
2397
-
2398
- <span class="param-type">string</span>
2399
-
2400
-
2401
-
2402
-
2403
- </td>
2404
-
2405
-
2406
- <td class="attributes">
2407
-
2408
- &lt;optional&gt;<br>
2409
-
2410
-
2411
-
2412
- </td>
2413
-
2414
-
2415
-
2416
- <td class="default">
2417
-
2418
- null
2419
-
2420
- </td>
2421
-
2422
-
2423
- <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>; can be a phone
2424
- number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>'s attributes.</p></td>
2425
- </tr>
2426
-
2427
-
2428
-
2429
- <tr>
2430
-
2431
- <td class="name"><code>from</code></td>
2432
-
2433
-
2434
- <td class="type">
2435
-
2436
-
2437
- <span class="param-type">string</span>
2438
-
2439
-
2440
-
2441
-
2442
- </td>
2443
-
2444
-
2445
- <td class="attributes">
2446
-
2447
- &lt;optional&gt;<br>
2448
-
2449
-
2450
-
2451
- </td>
2452
-
2453
-
2454
-
2455
- <td class="default">
2456
-
2457
- null
2458
-
2459
- </td>
2460
-
2461
-
2462
- <td class="description last"><p>The caller id for the call to the <a href="Worker.html">Worker</a>.
2463
- Must be a verified Twilio number.</p></td>
2464
- </tr>
2465
-
2466
-
2467
-
2468
- <tr>
2469
-
2470
- <td class="name"><code>timeout</code></td>
2471
-
2472
-
2473
- <td class="type">
2474
-
2475
-
2476
- <span class="param-type">int</span>
2477
-
2478
-
2479
-
2480
-
2481
- </td>
2482
-
2483
-
2484
- <td class="attributes">
2485
-
2486
- &lt;optional&gt;<br>
2487
-
2488
-
2489
-
2490
- </td>
2491
-
2492
-
2493
-
2494
- <td class="default">
2495
-
2496
- 60
2497
-
2498
- </td>
2499
-
2500
-
2501
- <td class="description last"><p>The integer number of seconds that
2502
- Twilio should allow the call to ring before assuming there is no answer.</p></td>
2503
- </tr>
2504
-
2505
-
2506
-
2507
- <tr>
2508
-
2509
- <td class="name"><code>statusCallback</code></td>
2510
-
2511
-
2512
- <td class="type">
2513
-
2514
-
2515
- <span class="param-type">string</span>
2516
-
2517
-
2518
-
2519
-
2520
- </td>
2521
-
2522
-
2523
- <td class="attributes">
2524
-
2525
- &lt;optional&gt;<br>
2526
-
2527
-
2528
-
2529
- </td>
2530
-
2531
-
2532
-
2533
- <td class="default">
2534
-
2535
- null
2536
-
2537
- </td>
2538
-
2539
-
2540
- <td class="description last"><p>The URL endpoint to receive call status events of the Worker leg.</p></td>
2541
- </tr>
2542
-
2543
-
2544
-
2545
- <tr>
2546
-
2547
- <td class="name"><code>statusCallbackMethod</code></td>
2548
-
2549
-
2550
- <td class="type">
2551
-
2552
-
2553
- <span class="param-type">string</span>
2554
-
2555
-
2556
-
2557
-
2558
- </td>
2559
-
2560
-
2561
- <td class="attributes">
2562
-
2563
- &lt;optional&gt;<br>
2564
-
2565
-
2566
-
2567
- </td>
2568
-
2569
-
2570
-
2571
- <td class="default">
2572
-
2573
- 'POST'
2574
-
2575
- </td>
2576
-
2577
-
2578
- <td class="description last"><p>The HTTP method for the Status Callback URL.</p></td>
2579
- </tr>
2580
-
2581
-
2582
-
2583
- <tr>
2584
-
2585
- <td class="name"><code>statusCallbackEvent</code></td>
2586
-
2587
-
2588
- <td class="type">
2589
-
2590
-
2591
- <span class="param-type">string</span>
2592
-
2593
-
2594
-
2595
-
2596
- </td>
2597
-
2598
-
2599
- <td class="attributes">
2600
-
2601
- &lt;optional&gt;<br>
2602
-
2603
-
2604
-
2605
- </td>
2606
-
2607
-
2608
-
2609
- <td class="default">
2610
-
2611
- 'completed'
2612
-
2613
- </td>
2614
-
2615
-
2616
- <td class="description last"><p>A comma separated list of events to subscribe to.
2617
- The possible list of events are: ['initiated', 'ringing', 'answered', 'completed'].</p></td>
2618
- </tr>
2619
-
2620
-
2621
-
2622
- <tr>
2623
-
2624
- <td class="name"><code>record</code></td>
2625
-
2626
-
2627
- <td class="type">
2628
-
2629
-
2630
- <span class="param-type">string</span>
2631
-
2632
-
2633
-
2634
-
2635
- </td>
2636
-
2637
-
2638
- <td class="attributes">
2639
-
2640
- &lt;optional&gt;<br>
2641
-
2642
-
2643
-
2644
- </td>
2645
-
2646
-
2647
-
2648
- <td class="default">
2649
-
2650
- 'do-not-record'
2651
-
2652
- </td>
2653
-
2654
-
2655
- <td class="description last"><p>Whether to record the <a href="Worker.html">Worker</a> leg of the Conference.</p></td>
2656
- </tr>
2657
-
2658
-
2659
-
2660
- <tr>
2661
-
2662
- <td class="name"><code>muted</code></td>
2663
-
2664
-
2665
- <td class="type">
2666
-
2667
-
2668
- <span class="param-type">boolean</span>
2669
-
2670
-
2671
-
2672
-
2673
- </td>
2674
-
2675
-
2676
- <td class="attributes">
2677
-
2678
- &lt;optional&gt;<br>
2679
-
2680
-
2681
-
2682
- </td>
2683
-
2684
-
2685
-
2686
- <td class="default">
2687
-
2688
- false
2689
-
2690
- </td>
2691
-
2692
-
2693
- <td class="description last"><p>Whether the <a href="Worker.html">Worker</a> leg of the Conference is muted.</p></td>
2694
- </tr>
2695
-
2696
-
2697
-
2698
- <tr>
2699
-
2700
- <td class="name"><code>beep</code></td>
2701
-
2702
-
2703
- <td class="type">
2704
-
2705
-
2706
- <span class="param-type">string</span>
2707
- |
2708
-
2709
- <span class="param-type">boolean</span>
2710
-
2711
-
2712
-
2713
-
2714
- </td>
2715
-
2716
-
2717
- <td class="attributes">
2718
-
2719
- &lt;optional&gt;<br>
2720
-
2721
-
2722
-
2723
- </td>
2724
-
2725
-
2726
-
2727
- <td class="default">
2728
-
2729
- true
2730
-
2731
- </td>
2732
-
2733
-
2734
- <td class="description last"><p>Whether the <a href="Worker.html">Worker</a> leg should be when entering the Conference.
2735
- The options for beep are: [true, false, 'onEnter', 'onExit'].</p></td>
2736
- </tr>
2737
-
2738
-
2739
-
2740
- <tr>
2741
-
2742
- <td class="name"><code>startConferenceOnEnter</code></td>
2743
-
2744
-
2745
- <td class="type">
2746
-
2747
-
2748
- <span class="param-type">boolean</span>
2749
-
2750
-
2751
-
2752
-
2753
- </td>
2754
-
2755
-
2756
- <td class="attributes">
2757
-
2758
- &lt;optional&gt;<br>
2759
-
2760
-
2761
-
2762
- </td>
2763
-
2764
-
2765
-
2766
- <td class="default">
2767
-
2768
- true
2769
-
2770
- </td>
2771
-
2772
-
2773
- <td class="description last"><p>Whether the Conference should start when the <a href="Worker.html">Worker</a> leg enters.</p></td>
2774
- </tr>
2775
-
2776
-
2777
-
2778
- <tr>
2779
-
2780
- <td class="name"><code>endConferenceOnExit</code></td>
2781
-
2782
-
2783
- <td class="type">
2784
-
2785
-
2786
- <span class="param-type">boolean</span>
2787
-
2788
-
2789
-
2790
-
2791
- </td>
2792
-
2793
-
2794
- <td class="attributes">
2795
-
2796
- &lt;optional&gt;<br>
2797
-
2798
-
2799
-
2800
- </td>
2801
-
2802
-
2803
-
2804
- <td class="default">
2805
-
2806
- false
2807
-
2808
- </td>
2809
-
2810
-
2811
- <td class="description last"><p>Whether the Conference should end when the <a href="Worker.html">Worker</a> leg exits.</p></td>
2812
- </tr>
2813
-
2814
-
2815
-
2816
- <tr>
2817
-
2818
- <td class="name"><code>endConferenceOnCustomerExit</code></td>
2819
-
2820
-
2821
- <td class="type">
2822
-
2823
-
2824
- <span class="param-type">boolean</span>
2825
-
2826
-
2827
-
2828
-
2829
- </td>
2830
-
2831
-
2832
- <td class="attributes">
2833
-
2834
- &lt;optional&gt;<br>
2835
-
2836
-
2837
-
2838
- </td>
2839
-
2840
-
2841
-
2842
- <td class="default">
2843
-
2844
- false
2845
-
2846
- </td>
2847
-
2848
-
2849
- <td class="description last"><p>Whether the Conference should end when the customer leg exits.</p></td>
2850
- </tr>
2851
-
2852
-
2853
-
2854
- <tr>
2855
-
2856
- <td class="name"><code>beepOnCustomerEntrance</code></td>
2857
-
2858
-
2859
- <td class="type">
2860
-
2861
-
2862
- <span class="param-type">boolean</span>
2863
-
2864
-
2865
-
2866
-
2867
- </td>
2868
-
2869
-
2870
- <td class="attributes">
2871
-
2872
- &lt;optional&gt;<br>
2873
-
2874
-
2875
-
2876
- </td>
2877
-
2878
-
2879
-
2880
- <td class="default">
2881
-
2882
- true
2883
-
2884
- </td>
2885
-
2886
-
2887
- <td class="description last"><p>Whether the Conference should beep when the customer leg enters.</p></td>
2888
- </tr>
2889
-
2890
-
2891
-
2892
- <tr>
2893
-
2894
- <td class="name"><code>waitUrl</code></td>
2895
-
2896
-
2897
- <td class="type">
2898
-
2899
-
2900
- <span class="param-type">string</span>
2901
-
2902
-
2903
-
2904
-
2905
- </td>
2906
-
2907
-
2908
- <td class="attributes">
2909
-
2910
- &lt;optional&gt;<br>
2911
-
2912
-
2913
-
2914
- </td>
2915
-
2916
-
2917
-
2918
- <td class="default">
2919
-
2920
- default Twilio hold music
2921
-
2922
- </td>
2923
-
2924
-
2925
- <td class="description last"><p>The URL endpoint to play when waiting for the Conference to begin.</p></td>
2926
- </tr>
2927
-
2928
-
2929
-
2930
- <tr>
2931
-
2932
- <td class="name"><code>waitMethod</code></td>
2933
-
2934
-
2935
- <td class="type">
2936
-
2937
-
2938
- <span class="param-type">string</span>
2939
-
2940
-
2941
-
2942
-
2943
- </td>
2944
-
2945
-
2946
- <td class="attributes">
2947
-
2948
- &lt;optional&gt;<br>
2949
-
2950
-
2951
-
2952
- </td>
2953
-
2954
-
2955
-
2956
- <td class="default">
2957
-
2958
- 'POST'
2959
-
2960
- </td>
2961
-
2962
-
2963
- <td class="description last"><p>The HTTP method for the Wait URL.</p></td>
2964
- </tr>
2965
-
2966
-
2967
-
2968
- <tr>
2969
-
2970
- <td class="name"><code>earlyMedia</code></td>
2971
-
2972
-
2973
- <td class="type">
2974
-
2975
-
2976
- <span class="param-type">boolean</span>
2977
-
2978
-
2979
-
2980
-
2981
- </td>
2982
-
2983
-
2984
- <td class="attributes">
2985
-
2986
- &lt;optional&gt;<br>
2987
-
2988
-
2989
-
2990
- </td>
2991
-
2992
-
2993
-
2994
- <td class="default">
2995
-
2996
- true
2997
-
2998
- </td>
2999
-
3000
-
3001
- <td class="description last"><p>Whether Twilio should feed early media to be played directly into a Conference.</p></td>
3002
- </tr>
3003
-
3004
-
3005
-
3006
- <tr>
3007
-
3008
- <td class="name"><code>maxParticipants</code></td>
3009
-
3010
-
3011
- <td class="type">
3012
-
3013
-
3014
- <span class="param-type">int</span>
3015
-
3016
-
3017
-
3018
-
3019
- </td>
3020
-
3021
-
3022
- <td class="attributes">
3023
-
3024
- &lt;optional&gt;<br>
3025
-
3026
-
3027
-
3028
- </td>
3029
-
3030
-
3031
-
3032
- <td class="default">
3033
-
3034
- 10
3035
-
3036
- </td>
3037
-
3038
-
3039
- <td class="description last"><p>The number of max participants allowed in a Conference.</p></td>
3040
- </tr>
3041
-
3042
-
3043
-
3044
- <tr>
3045
-
3046
- <td class="name"><code>conferenceStatusCallback</code></td>
3047
-
3048
-
3049
- <td class="type">
3050
-
3051
-
3052
- <span class="param-type">string</span>
3053
-
3054
-
3055
-
3056
-
3057
- </td>
3058
-
3059
-
3060
- <td class="attributes">
3061
-
3062
- &lt;optional&gt;<br>
3063
-
3064
-
3065
-
3066
- </td>
3067
-
3068
-
3069
-
3070
- <td class="default">
3071
-
3072
- null
3073
-
3074
- </td>
3075
-
3076
-
3077
- <td class="description last"><p>The URL endpoint to receive Conference status events.</p></td>
3078
- </tr>
3079
-
3080
-
3081
-
3082
- <tr>
3083
-
3084
- <td class="name"><code>conferenceStatusCallbackMethod</code></td>
3085
-
3086
-
3087
- <td class="type">
3088
-
3089
-
3090
- <span class="param-type">string</span>
3091
-
3092
-
3093
-
3094
-
3095
- </td>
3096
-
3097
-
3098
- <td class="attributes">
3099
-
3100
- &lt;optional&gt;<br>
3101
-
3102
-
3103
-
3104
- </td>
3105
-
3106
-
3107
-
3108
- <td class="default">
3109
-
3110
- 'POST'
3111
-
3112
- </td>
3113
-
3114
-
3115
- <td class="description last"><p>The HTTP method for the Conference Status Callback URL.</p></td>
3116
- </tr>
3117
-
3118
-
3119
-
3120
- <tr>
3121
-
3122
- <td class="name"><code>conferenceStatusCallbackEvent</code></td>
3123
-
3124
-
3125
- <td class="type">
3126
-
3127
-
3128
- <span class="param-type">string</span>
3129
-
3130
-
3131
-
3132
-
3133
- </td>
3134
-
3135
-
3136
- <td class="attributes">
3137
-
3138
- &lt;optional&gt;<br>
3139
-
3140
-
3141
-
3142
- </td>
3143
-
3144
-
3145
-
3146
- <td class="default">
3147
-
3148
- 'start,end'
3149
-
3150
- </td>
3151
-
3152
-
3153
- <td class="description last"><p>A comma separated list of Conference events to subscribe to.
3154
- The possible list of events are: ['start', 'end', 'join', 'leave', 'mute', 'hold', 'speaker'].</p></td>
3155
- </tr>
3156
-
3157
-
3158
-
3159
- <tr>
3160
-
3161
- <td class="name"><code>conferenceRecord</code></td>
3162
-
3163
-
3164
- <td class="type">
3165
-
3166
-
3167
- <span class="param-type">string</span>
3168
- |
3169
-
3170
- <span class="param-type">boolean</span>
3171
-
3172
-
3173
-
3174
-
3175
- </td>
3176
-
3177
-
3178
- <td class="attributes">
3179
-
3180
- &lt;optional&gt;<br>
3181
-
3182
-
3183
-
3184
- </td>
3185
-
3186
-
3187
-
3188
- <td class="default">
3189
-
3190
- false
3191
-
3192
- </td>
3193
-
3194
-
3195
- <td class="description last"><p>Whether the entire Conference should be recorded.
3196
- The possible options for conferenceRecord are: [true, false, 'record-from-start', 'do-not-record'].</p></td>
3197
- </tr>
3198
-
3199
-
3200
-
3201
- <tr>
3202
-
3203
- <td class="name"><code>conferenceTrim</code></td>
3204
-
3205
-
3206
- <td class="type">
3207
-
3208
-
3209
- <span class="param-type">string</span>
3210
-
3211
-
3212
-
3213
-
3214
- </td>
3215
-
3216
-
3217
- <td class="attributes">
3218
-
3219
- &lt;optional&gt;<br>
3220
-
3221
-
3222
-
3223
- </td>
3224
-
3225
-
3226
-
3227
- <td class="default">
3228
-
3229
- 'trim-silence'
3230
-
3231
- </td>
3232
-
3233
-
3234
- <td class="description last"><p>Whether to trim the Conference recording.
3235
- The options for conferenceTrim are: ['trim-silence', 'do-not-trim'].</p></td>
3236
- </tr>
3237
-
3238
-
3239
-
3240
- <tr>
3241
-
3242
- <td class="name"><code>recordingChannels</code></td>
3243
-
3244
-
3245
- <td class="type">
3246
-
3247
-
3248
- <span class="param-type">string</span>
3249
-
3250
-
3251
-
3252
-
3253
- </td>
3254
-
3255
-
3256
- <td class="attributes">
3257
-
3258
- &lt;optional&gt;<br>
3259
-
3260
-
3261
-
3262
- </td>
3263
-
3264
-
3265
-
3266
- <td class="default">
3267
-
3268
- 'mono'
3269
-
3270
- </td>
3271
-
3272
-
3273
- <td class="description last"><p>Which channel of the Conference to record. The options are: ['mono', 'dual'].</p></td>
3274
- </tr>
3275
-
3276
-
3277
-
3278
- <tr>
3279
-
3280
- <td class="name"><code>recordingStatusCallback</code></td>
3281
-
3282
-
3283
- <td class="type">
3284
-
3285
-
3286
- <span class="param-type">string</span>
3287
-
3288
-
3289
-
3290
-
3291
- </td>
3292
-
3293
-
3294
- <td class="attributes">
3295
-
3296
- &lt;optional&gt;<br>
3297
-
3298
-
3299
-
3300
- </td>
3301
-
3302
-
3303
-
3304
- <td class="default">
3305
-
3306
- null
3307
-
3308
- </td>
3309
-
3310
-
3311
- <td class="description last"><p>The URL endpoint to receive recording status events.</p></td>
3312
- </tr>
3313
-
3314
-
3315
-
3316
- <tr>
3317
-
3318
- <td class="name"><code>recordingStatusCallbackMethod</code></td>
3319
-
3320
-
3321
- <td class="type">
3322
-
3323
-
3324
- <span class="param-type">string</span>
3325
-
3326
-
3327
-
3328
-
3329
- </td>
3330
-
3331
-
3332
- <td class="attributes">
3333
-
3334
- &lt;optional&gt;<br>
3335
-
3336
-
3337
-
3338
- </td>
3339
-
3340
-
3341
-
3342
- <td class="default">
3343
-
3344
- 'POST'
3345
-
3346
- </td>
3347
-
3348
-
3349
- <td class="description last"><p>The HTTP method for the Recording Status Callback URL.</p></td>
3350
- </tr>
3351
-
3352
-
3353
-
3354
- <tr>
3355
-
3356
- <td class="name"><code>conferenceRecordingStatusCallback</code></td>
3357
-
3358
-
3359
- <td class="type">
3360
-
3361
-
3362
- <span class="param-type">string</span>
3363
-
3364
-
3365
-
3366
-
3367
- </td>
3368
-
3369
-
3370
- <td class="attributes">
3371
-
3372
- &lt;optional&gt;<br>
3373
-
3374
-
3375
-
3376
- </td>
3377
-
3378
-
3379
-
3380
- <td class="default">
3381
-
3382
- null
3383
-
3384
- </td>
3385
-
3386
-
3387
- <td class="description last"><p>The URl endpoint to receive Conference events.</p></td>
3388
- </tr>
3389
-
3390
-
3391
-
3392
- <tr>
3393
-
3394
- <td class="name"><code>conferenceRecordingStatusCallbackMethod</code></td>
3395
-
3396
-
3397
- <td class="type">
3398
-
3399
-
3400
- <span class="param-type">string</span>
3401
-
3402
-
3403
-
3404
-
3405
- </td>
3406
-
3407
-
3408
- <td class="attributes">
3409
-
3410
- &lt;optional&gt;<br>
3411
-
3412
-
3413
-
3414
- </td>
3415
-
3416
-
3417
-
3418
- <td class="default">
3419
-
3420
- 'POST'
3421
-
3422
- </td>
3423
-
3424
-
3425
- <td class="description last"><p>The HTTP method of the Conference Recording Status Callback.</p></td>
3426
- </tr>
3427
-
3428
-
3429
-
3430
- <tr>
3431
-
3432
- <td class="name"><code>region</code></td>
3433
-
3434
-
3435
- <td class="type">
3436
-
3437
-
3438
- <span class="param-type">string</span>
3439
-
3440
-
3441
-
3442
-
3443
- </td>
3444
-
3445
-
3446
- <td class="attributes">
3447
-
3448
- &lt;optional&gt;<br>
3449
-
3450
-
3451
-
3452
- </td>
3453
-
3454
-
3455
-
3456
- <td class="default">
3457
-
3458
- null
3459
-
3460
- </td>
3461
-
3462
-
3463
- <td class="description last"><p>The specific region. The options for region are: ['us1', 'ie1', 'sg1', 'br1', 'au1', 'jp1'].</p></td>
3464
- </tr>
3465
-
3466
-
3467
-
3468
- <tr>
3469
-
3470
- <td class="name"><code>sipAuthUsername</code></td>
3471
-
3472
-
3473
- <td class="type">
3474
-
3475
-
3476
- <span class="param-type">string</span>
3477
-
3478
-
3479
-
3480
-
3481
- </td>
3482
-
3483
-
3484
- <td class="attributes">
3485
-
3486
- &lt;optional&gt;<br>
3487
-
3488
-
3489
-
3490
- </td>
3491
-
3492
-
3493
-
3494
- <td class="default">
3495
-
3496
- null
3497
-
3498
- </td>
3499
-
3500
-
3501
- <td class="description last"><p>The SIP auth username to use.</p></td>
3502
- </tr>
3503
-
3504
-
3505
-
3506
- <tr>
3507
-
3508
- <td class="name"><code>sipAuthPassword</code></td>
3509
-
3510
-
3511
- <td class="type">
3512
-
3513
-
3514
- <span class="param-type">string</span>
3515
-
3516
-
3517
-
3518
-
3519
- </td>
3520
-
3521
-
3522
- <td class="attributes">
3523
-
3524
- &lt;optional&gt;<br>
3525
-
3526
-
3527
-
3528
- </td>
3529
-
3530
-
3531
-
3532
- <td class="default">
3533
-
3534
- null
3535
-
3536
- </td>
3537
-
3538
-
3539
- <td class="description last"><p>The SIP auth password to use.</p></td>
3540
- </tr>
3541
-
3542
-
3543
- </tbody>
3544
- </table>
3545
- </dl>
3546
-
3547
-
3548
-
3549
-
3550
-
3551
-
3552
-
3553
-
3554
-
3555
-
3556
-
3557
-
3558
-
3559
-
3560
-
3561
-
2269
+
3562
2270
 
3563
2271
 
3564
2272
 
@@ -3578,234 +2286,101 @@ The options for conferenceTrim are: ['trim-silence', 'do-not-trim'].</p></td>
3578
2286
 
3579
2287
 
3580
2288
 
3581
-
3582
- </dl>
3583
-
3584
-
3585
-
3586
- </dd>
3587
-
3588
-
3589
-
3590
- <hr>
3591
- <dt class="name" id=".DequeueOptions">
3592
- <h4 id=".DequeueOptions">DequeueOptions</h4>
3593
-
3594
-
3595
- </dt>
3596
- <dd>
3597
-
3598
-
3599
-
3600
- <h5>Type:</h5>
3601
- <ul>
3602
- <li>
3603
-
3604
- <span class="param-type">Object</span>
3605
-
3606
-
3607
-
3608
- </li>
3609
- </ul>
3610
-
3611
-
3612
-
3613
- <dl class="details">
3614
-
3615
-
3616
- <h5 class="subsection-title">Properties:</h5>
3617
-
3618
- <dl>
3619
-
3620
- <table class="props table table-striped">
3621
- <thead>
3622
- <tr>
3623
-
3624
- <th>Name</th>
3625
-
3626
-
3627
- <th>Type</th>
3628
-
3629
-
3630
- <th>Argument</th>
3631
-
3632
-
3633
-
3634
- <th>Default</th>
3635
-
3636
-
3637
- <th class="last">Description</th>
3638
- </tr>
3639
- </thead>
3640
-
3641
- <tbody>
3642
-
3643
-
3644
- <tr>
3645
-
3646
- <td class="name"><code>from</code></td>
3647
-
3648
-
3649
- <td class="type">
3650
-
3651
-
3652
- <span class="param-type">string</span>
3653
-
3654
-
3655
-
3656
-
3657
- </td>
3658
-
3659
-
3660
- <td class="attributes">
3661
-
3662
- &lt;optional&gt;<br>
3663
-
3664
-
3665
-
3666
- </td>
3667
-
3668
-
3669
-
3670
- <td class="default">
3671
-
3672
- null
3673
-
3674
- </td>
3675
-
3676
-
3677
- <td class="description last"><p>The caller id for the call to the <a href="Worker.html">Worker</a>.
3678
- Must be a verified Twilio number.</p></td>
3679
- </tr>
3680
-
3681
-
3682
-
3683
- <tr>
3684
-
3685
- <td class="name"><code>to</code></td>
3686
-
3687
-
3688
- <td class="type">
3689
-
3690
-
3691
- <span class="param-type">string</span>
3692
-
3693
-
3694
-
3695
-
3696
- </td>
3697
-
3698
-
3699
- <td class="attributes">
3700
-
3701
- &lt;optional&gt;<br>
3702
-
2289
+
2290
+ </dl>
3703
2291
 
3704
-
3705
- </td>
3706
-
3707
2292
 
3708
-
3709
- <td class="default">
3710
-
3711
- null
3712
-
3713
- </td>
3714
-
2293
+
3715
2294
 
3716
- <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>; can be a phone
3717
- number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>'s attributes.</p></td>
3718
- </tr>
2295
+
3719
2296
 
3720
2297
 
3721
2298
 
3722
- <tr>
3723
-
3724
- <td class="name"><code>postWorkActivitySid</code></td>
3725
-
2299
+
3726
2300
 
3727
- <td class="type">
2301
+
2302
+
2303
+
2304
+ <h5>Returns:</h5>
2305
+
3728
2306
 
3729
-
3730
- <span class="param-type">string</span>
3731
2307
 
3732
2308
 
2309
+ <dl>
2310
+ <dt>
2311
+ Type
2312
+ </dt>
2313
+ <dd>
2314
+
2315
+ <span class="param-type">Promise.&lt;<a href="Reservation.html">Reservation</a>&gt;</span>
3733
2316
 
3734
-
3735
- </td>
3736
2317
 
3737
-
3738
- <td class="attributes">
3739
-
3740
- &lt;optional&gt;<br>
3741
-
3742
2318
 
3743
-
3744
- </td>
3745
-
2319
+ </dd>
2320
+ </dl>
3746
2321
 
3747
-
3748
- <td class="default">
3749
-
3750
- null
3751
-
3752
- </td>
3753
-
3754
2322
 
3755
- <td class="description last"><p>The activitySid to update the
3756
- <a href="Worker.html">Worker</a> to after dequeuing the <a href="Reservation.html">Reservation</a>.</p></td>
3757
- </tr>
2323
+
3758
2324
 
3759
2325
 
2326
+ </dd>
3760
2327
 
3761
- <tr>
3762
-
3763
- <td class="name"><code>record</code></td>
2328
+
3764
2329
 
2330
+ <hr>
2331
+ <dt>
2332
+ <h4 class="name" id="redirect"><span class="type-signature"></span>redirect(callSid, url [, options])</h4>
2333
+
2334
+
2335
+ </dt>
2336
+ <dd>
3765
2337
 
3766
- <td class="type">
3767
-
3768
-
3769
- <span class="param-type">string</span>
2338
+
2339
+ <div class="description">
2340
+ <p>Redirect the active Call tied to this <a href="Reservation.html">Reservation</a></p>
2341
+ </div>
2342
+
3770
2343
 
2344
+
3771
2345
 
2346
+
3772
2347
 
3773
-
3774
- </td>
2348
+
2349
+
2350
+ <h5>Parameters:</h5>
2351
+
3775
2352
 
3776
-
3777
- <td class="attributes">
3778
-
3779
- &lt;optional&gt;<br>
3780
-
2353
+ <table class="params table table-striped">
2354
+ <thead>
2355
+ <tr>
2356
+
2357
+ <th>Name</th>
2358
+
3781
2359
 
3782
-
3783
- </td>
3784
-
2360
+ <th>Type</th>
3785
2361
 
3786
-
3787
- <td class="default">
3788
-
3789
- 'do-not-record'
3790
-
3791
- </td>
3792
-
2362
+
2363
+ <th>Argument</th>
2364
+
3793
2365
 
3794
- <td class="description last"><p>Defines which legs of the call
3795
- should be recorded.</p></td>
3796
- </tr>
2366
+
2367
+
2368
+ <th class="last">Description</th>
2369
+ </tr>
2370
+ </thead>
3797
2371
 
2372
+ <tbody>
3798
2373
 
3799
2374
 
3800
2375
  <tr>
3801
2376
 
3802
- <td class="name"><code>timeout</code></td>
2377
+ <td class="name"><code>callSid</code></td>
3803
2378
 
3804
2379
 
3805
2380
  <td class="type">
3806
2381
 
3807
2382
 
3808
- <span class="param-type">int</span>
2383
+ <span class="param-type">string</span>
3809
2384
 
3810
2385
 
3811
2386
 
@@ -3815,7 +2390,7 @@ should be recorded.</p></td>
3815
2390
 
3816
2391
  <td class="attributes">
3817
2392
 
3818
- &lt;optional&gt;<br>
2393
+
3819
2394
 
3820
2395
 
3821
2396
 
@@ -3823,22 +2398,15 @@ should be recorded.</p></td>
3823
2398
 
3824
2399
 
3825
2400
 
3826
- <td class="default">
3827
-
3828
- 60
3829
-
3830
- </td>
3831
-
3832
2401
 
3833
- <td class="description last"><p>The integer number of seconds that
3834
- Twilio should allow the call to ring before assuming there is no answer.</p></td>
2402
+ <td class="description last"><p>The sid of the Call to redirect</p></td>
3835
2403
  </tr>
3836
2404
 
3837
2405
 
3838
2406
 
3839
2407
  <tr>
3840
2408
 
3841
- <td class="name"><code>statusCallbackUrl</code></td>
2409
+ <td class="name"><code>url</code></td>
3842
2410
 
3843
2411
 
3844
2412
  <td class="type">
@@ -3854,7 +2422,7 @@ Twilio should allow the call to ring before assuming there is no answer.</p></td
3854
2422
 
3855
2423
  <td class="attributes">
3856
2424
 
3857
- &lt;optional&gt;<br>
2425
+
3858
2426
 
3859
2427
 
3860
2428
 
@@ -3862,28 +2430,21 @@ Twilio should allow the call to ring before assuming there is no answer.</p></td
3862
2430
 
3863
2431
 
3864
2432
 
3865
- <td class="default">
3866
-
3867
- null
3868
-
3869
- </td>
3870
-
3871
2433
 
3872
- <td class="description last"><p>A URL that Twilio will send
3873
- asynchronous webhook this._request. to on a completed call event.</p></td>
2434
+ <td class="description last"><p>A valid TwiML URI that is executed on the Caller's leg upon redirecting</p></td>
3874
2435
  </tr>
3875
2436
 
3876
2437
 
3877
2438
 
3878
2439
  <tr>
3879
2440
 
3880
- <td class="name"><code>statusCallbackEvents</code></td>
2441
+ <td class="name"><code>options</code></td>
3881
2442
 
3882
2443
 
3883
2444
  <td class="type">
3884
2445
 
3885
2446
 
3886
- <span class="param-type">string</span>
2447
+ <span class="param-type"><a href="global.html#RedirectOptions">RedirectOptions</a></span>
3887
2448
 
3888
2449
 
3889
2450
 
@@ -3897,27 +2458,26 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
3897
2458
 
3898
2459
 
3899
2460
 
3900
- </td>
3901
-
3902
2461
 
3903
-
3904
- <td class="default">
3905
-
3906
- null
3907
2462
 
3908
2463
  </td>
3909
2464
 
3910
2465
 
3911
- <td class="description last"><p>A comma separated string of the events to subscribe to</p></td>
2466
+
2467
+
2468
+ <td class="description last"></td>
3912
2469
  </tr>
3913
2470
 
3914
2471
 
3915
2472
  </tbody>
3916
2473
  </table>
3917
- </dl>
3918
2474
 
3919
2475
 
3920
2476
 
2477
+
2478
+ <dl class="details">
2479
+
2480
+
3921
2481
 
3922
2482
 
3923
2483
 
@@ -3955,149 +2515,102 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
3955
2515
 
3956
2516
 
3957
2517
 
3958
- </dd>
3959
-
3960
-
3961
-
3962
- <hr>
3963
- <dt class="name" id=".ParticipantOptions">
3964
- <h4 id=".ParticipantOptions">ParticipantOptions</h4>
3965
2518
 
3966
2519
 
3967
- </dt>
3968
- <dd>
3969
-
3970
2520
 
3971
2521
 
3972
- <h5>Type:</h5>
3973
- <ul>
3974
- <li>
3975
-
3976
- <span class="param-type">Object</span>
3977
-
3978
2522
 
2523
+
3979
2524
 
3980
- </li>
3981
- </ul>
3982
2525
 
3983
2526
 
3984
2527
 
3985
- <dl class="details">
2528
+ <h5>Returns:</h5>
3986
2529
 
2530
+
2531
+ <div class="param-desc">
2532
+ <ul>
2533
+ <li>Rejected if unable to issue Redirect instruction on the <a href="Reservation.html">Reservation</a></li>
2534
+ </ul>
2535
+ </div>
3987
2536
 
3988
- <h5 class="subsection-title">Properties:</h5>
3989
-
3990
- <dl>
3991
-
3992
- <table class="props table table-striped">
3993
- <thead>
3994
- <tr>
3995
-
3996
- <th>Name</th>
3997
-
3998
-
3999
- <th>Type</th>
4000
2537
 
4001
-
4002
- <th>Argument</th>
4003
-
4004
2538
 
2539
+ <dl>
2540
+ <dt>
2541
+ Type
2542
+ </dt>
2543
+ <dd>
4005
2544
 
4006
- <th>Default</th>
4007
-
4008
-
4009
- <th class="last">Description</th>
4010
- </tr>
4011
- </thead>
4012
-
4013
- <tbody>
4014
-
4015
-
4016
- <tr>
4017
-
4018
- <td class="name"><code>endConferenceOnExit</code></td>
4019
-
2545
+ <span class="param-type">Promise.&lt;this&gt;</span>
4020
2546
 
4021
- <td class="type">
4022
-
4023
-
4024
- <span class="param-type">boolean</span>
4025
2547
 
4026
2548
 
2549
+ </dd>
2550
+ </dl>
4027
2551
 
4028
-
4029
- </td>
4030
2552
 
4031
-
4032
- <td class="attributes">
4033
-
4034
- &lt;optional&gt;<br>
4035
-
2553
+
4036
2554
 
4037
-
4038
- </td>
4039
-
2555
+
2556
+ </dd>
4040
2557
 
2558
+
4041
2559
 
4042
- <td class="default">
4043
-
4044
- null
4045
-
4046
- </td>
4047
-
4048
-
4049
- <td class="description last"><p>Whether the Conference should end when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
4050
- </tr>
4051
-
2560
+ <hr>
2561
+ <dt>
2562
+ <h4 class="name" id="reject"><span class="type-signature"></span>reject( [options])</h4>
2563
+
4052
2564
 
2565
+ </dt>
2566
+ <dd>
4053
2567
 
4054
- <tr>
4055
-
4056
- <td class="name"><code>mute</code></td>
4057
-
2568
+
2569
+ <div class="description">
2570
+ <p>Reject the <a href="Reservation.html">Reservation</a></p>
2571
+ </div>
2572
+
4058
2573
 
4059
- <td class="type">
4060
-
4061
-
4062
- <span class="param-type">boolean</span>
2574
+
4063
2575
 
2576
+
4064
2577
 
2578
+
2579
+
2580
+ <h5>Parameters:</h5>
2581
+
4065
2582
 
4066
-
4067
- </td>
2583
+ <table class="params table table-striped">
2584
+ <thead>
2585
+ <tr>
2586
+
2587
+ <th>Name</th>
2588
+
4068
2589
 
4069
-
4070
- <td class="attributes">
4071
-
4072
- &lt;optional&gt;<br>
4073
-
2590
+ <th>Type</th>
4074
2591
 
4075
-
4076
- </td>
4077
-
2592
+
2593
+ <th>Argument</th>
2594
+
4078
2595
 
4079
-
4080
- <td class="default">
4081
-
4082
- null
4083
-
4084
- </td>
4085
-
2596
+
4086
2597
 
4087
- <td class="description last"><p>Mute or unmute this <a href="Worker.html">Worker</a> participant</p></td>
4088
- </tr>
2598
+ <th class="last">Description</th>
2599
+ </tr>
2600
+ </thead>
4089
2601
 
2602
+ <tbody>
4090
2603
 
4091
2604
 
4092
2605
  <tr>
4093
2606
 
4094
- <td class="name"><code>beepOnExit</code></td>
2607
+ <td class="name"><code>options</code></td>
4095
2608
 
4096
2609
 
4097
2610
  <td class="type">
4098
2611
 
4099
2612
 
4100
- <span class="param-type">boolean</span>
2613
+ <span class="param-type"><a href="global.html#RejectOptions">RejectOptions</a></span>
4101
2614
 
4102
2615
 
4103
2616
 
@@ -4111,27 +2624,26 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
4111
2624
 
4112
2625
 
4113
2626
 
4114
- </td>
4115
-
4116
2627
 
4117
-
4118
- <td class="default">
4119
-
4120
- null
4121
2628
 
4122
2629
  </td>
4123
2630
 
4124
2631
 
4125
- <td class="description last"><p>Whether there should be a beep sound when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
2632
+
2633
+
2634
+ <td class="description last"></td>
4126
2635
  </tr>
4127
2636
 
4128
2637
 
4129
2638
  </tbody>
4130
2639
  </table>
4131
- </dl>
4132
2640
 
4133
2641
 
4134
2642
 
2643
+
2644
+ <dl class="details">
2645
+
2646
+
4135
2647
 
4136
2648
 
4137
2649
 
@@ -4169,41 +2681,72 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
4169
2681
 
4170
2682
 
4171
2683
 
4172
- </dd>
4173
2684
 
4174
-
4175
-
4176
- <hr>
4177
- <dt class="name" id=".RedirectOptions">
4178
- <h4 id=".RedirectOptions">RedirectOptions</h4>
2685
+
4179
2686
 
4180
2687
 
4181
- </dt>
4182
- <dd>
2688
+
4183
2689
 
4184
2690
 
4185
2691
 
4186
- <h5>Type:</h5>
4187
- <ul>
4188
- <li>
4189
-
4190
- <span class="param-type">Object</span>
4191
2692
 
2693
+
2694
+ <h5>Returns:</h5>
2695
+
2696
+
2697
+ <div class="param-desc">
2698
+ <ul>
2699
+ <li>Rejected if unable to issue Reject instruction on the <a href="Reservation.html">Reservation</a></li>
2700
+ </ul>
2701
+ </div>
4192
2702
 
4193
2703
 
4194
- </li>
4195
- </ul>
2704
+
2705
+ <dl>
2706
+ <dt>
2707
+ Type
2708
+ </dt>
2709
+ <dd>
2710
+
2711
+ <span class="param-type">Promise.&lt;this&gt;</span>
2712
+
2713
+
2714
+
2715
+ </dd>
2716
+ </dl>
2717
+
2718
+
2719
+
2720
+
4196
2721
 
2722
+ </dd>
4197
2723
 
2724
+
2725
+
2726
+ <hr>
2727
+ <dt>
2728
+ <h4 class="name" id="updateParticipant"><span class="type-signature"></span>updateParticipant(options)</h4>
4198
2729
 
4199
- <dl class="details">
4200
2730
 
2731
+ </dt>
2732
+ <dd>
4201
2733
 
4202
- <h5 class="subsection-title">Properties:</h5>
2734
+
2735
+ <div class="description">
2736
+ <p>Update the <a href="Worker.html">Worker</a>'s leg in the Conference associated to this <a href="Reservation.html">Reservation</a></p>
2737
+ </div>
2738
+
4203
2739
 
4204
- <dl>
2740
+
4205
2741
 
4206
- <table class="props table table-striped">
2742
+
2743
+
2744
+
2745
+
2746
+ <h5>Parameters:</h5>
2747
+
2748
+
2749
+ <table class="params table table-striped">
4207
2750
  <thead>
4208
2751
  <tr>
4209
2752
 
@@ -4213,12 +2756,8 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
4213
2756
  <th>Type</th>
4214
2757
 
4215
2758
 
4216
- <th>Argument</th>
4217
-
4218
2759
 
4219
2760
 
4220
- <th>Default</th>
4221
-
4222
2761
 
4223
2762
  <th class="last">Description</th>
4224
2763
  </tr>
@@ -4229,13 +2768,13 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
4229
2768
 
4230
2769
  <tr>
4231
2770
 
4232
- <td class="name"><code>accept</code></td>
2771
+ <td class="name"><code>options</code></td>
4233
2772
 
4234
2773
 
4235
2774
  <td class="type">
4236
2775
 
4237
2776
 
4238
- <span class="param-type">boolean</span>
2777
+ <span class="param-type"><a href="global.html#ReservationParticipantOptions">ReservationParticipantOptions</a></span>
4239
2778
 
4240
2779
 
4241
2780
 
@@ -4243,34 +2782,22 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
4243
2782
  </td>
4244
2783
 
4245
2784
 
4246
- <td class="attributes">
4247
-
4248
- &lt;optional&gt;<br>
4249
-
4250
-
4251
-
4252
- </td>
4253
-
4254
2785
 
4255
2786
 
4256
- <td class="default">
4257
-
4258
- false
4259
-
4260
- </td>
4261
-
4262
2787
 
4263
- <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
4264
- accepted before initiating the call</p></td>
2788
+ <td class="description last"></td>
4265
2789
  </tr>
4266
2790
 
4267
2791
 
4268
2792
  </tbody>
4269
2793
  </table>
4270
- </dl>
4271
2794
 
4272
2795
 
4273
2796
 
2797
+
2798
+ <dl class="details">
2799
+
2800
+
4274
2801
 
4275
2802
 
4276
2803
 
@@ -4308,89 +2835,72 @@ accepted before initiating the call</p></td>
4308
2835
 
4309
2836
 
4310
2837
 
4311
- </dd>
4312
-
4313
-
4314
-
4315
- <hr>
4316
- <dt class="name" id=".RejectOptions">
4317
- <h4 id=".RejectOptions">RejectOptions</h4>
4318
2838
 
4319
2839
 
4320
- </dt>
4321
- <dd>
4322
-
4323
2840
 
4324
2841
 
4325
- <h5>Type:</h5>
4326
- <ul>
4327
- <li>
4328
-
4329
- <span class="param-type">Object</span>
4330
-
4331
2842
 
2843
+
4332
2844
 
4333
- </li>
4334
- </ul>
4335
2845
 
4336
2846
 
4337
2847
 
4338
- <dl class="details">
2848
+ <h5>Returns:</h5>
4339
2849
 
2850
+
2851
+ <div class="param-desc">
2852
+ <ul>
2853
+ <li>Rejected if unable to update the Worker's leg in the Conference tied to the <a href="Reservation.html">Reservation</a></li>
2854
+ </ul>
2855
+ </div>
4340
2856
 
4341
- <h5 class="subsection-title">Properties:</h5>
4342
-
4343
- <dl>
4344
-
4345
- <table class="props table table-striped">
4346
- <thead>
4347
- <tr>
4348
-
4349
- <th>Name</th>
4350
-
4351
-
4352
- <th>Type</th>
4353
2857
 
4354
-
4355
2858
 
2859
+ <dl>
2860
+ <dt>
2861
+ Type
2862
+ </dt>
2863
+ <dd>
4356
2864
 
2865
+ <span class="param-type">Promise.&lt;this&gt;</span>
4357
2866
 
4358
- <th class="last">Description</th>
4359
- </tr>
4360
- </thead>
4361
2867
 
4362
- <tbody>
4363
-
4364
2868
 
4365
- <tr>
4366
-
4367
- <td class="name"><code>activitySid</code></td>
4368
-
2869
+ </dd>
2870
+ </dl>
4369
2871
 
4370
- <td class="type">
4371
-
4372
-
4373
- <span class="param-type">string</span>
4374
2872
 
2873
+
4375
2874
 
2875
+
2876
+ </dd>
4376
2877
 
2878
+
4377
2879
 
4378
- </td>
2880
+ <hr>
2881
+ <dt>
2882
+ <h4 class="name" id="wrap"><span class="type-signature"></span>wrap()</h4>
2883
+
2884
+
2885
+ </dt>
2886
+ <dd>
4379
2887
 
4380
-
2888
+
2889
+ <div class="description">
2890
+ <p>Wrap the <a href="Reservation.html">Reservation</a></p>
2891
+ </div>
2892
+
4381
2893
 
4382
-
2894
+
4383
2895
 
4384
- <td class="description last"><p>The sid of the <a href="Activity.html">Activity</a> to update the worker to
4385
- upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
4386
- </tr>
2896
+
4387
2897
 
4388
2898
 
4389
- </tbody>
4390
- </table>
4391
- </dl>
2899
+
4392
2900
 
4393
2901
 
2902
+ <dl class="details">
2903
+
4394
2904
 
4395
2905
 
4396
2906
 
@@ -4429,9 +2939,49 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
4429
2939
 
4430
2940
 
4431
2941
 
2942
+
2943
+
2944
+
2945
+
2946
+
2947
+
2948
+
2949
+
2950
+
2951
+
2952
+ <h5>Returns:</h5>
2953
+
2954
+
2955
+ <div class="param-desc">
2956
+ <ul>
2957
+ <li>Rejected if unable to issue Wrap instruction on the <a href="Reservation.html">Reservation</a></li>
2958
+ </ul>
2959
+ </div>
2960
+
2961
+
2962
+
2963
+ <dl>
2964
+ <dt>
2965
+ Type
2966
+ </dt>
2967
+ <dd>
2968
+
2969
+ <span class="param-type">Promise.&lt;this&gt;</span>
2970
+
2971
+
2972
+
2973
+ </dd>
2974
+ </dl>
2975
+
2976
+
2977
+
2978
+
2979
+
4432
2980
  </dd>
4433
2981
 
4434
- </dl>
2982
+ </dl>
2983
+
2984
+
4435
2985
 
4436
2986
 
4437
2987
 
@@ -5377,9 +3927,9 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
5377
3927
 
5378
3928
 
5379
3929
  <span class="jsdoc-message">
5380
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
3930
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
5381
3931
 
5382
- on 2023-05-09T04:37:13+00:00
3932
+ on 2023-08-01T08:45:21+00:00
5383
3933
 
5384
3934
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
5385
3935
  </span>