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.
Files changed (21) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/docs/Activity.html +525 -131
  3. package/dist/docs/Channel.html +900 -7
  4. package/dist/docs/IncomingTransfer.html +180 -14
  5. package/dist/docs/OutgoingTransfer.html +234 -17
  6. package/dist/docs/Reservation.html +901 -2351
  7. package/dist/docs/Supervisor.html +4385 -0
  8. package/dist/docs/Task.html +1738 -537
  9. package/dist/docs/TaskQueue.html +1021 -5
  10. package/dist/docs/Transfers.html +444 -4
  11. package/dist/docs/Worker.html +1555 -594
  12. package/dist/docs/Workspace.html +159 -913
  13. package/dist/docs/classes.list.html +1823 -14
  14. package/dist/docs/global.html +4755 -0
  15. package/dist/docs/index.html +11 -4
  16. package/dist/docs/quicksearch.html +1 -1
  17. package/dist/index.commonjs2.js +1 -1
  18. package/dist/index.commonjs2.js.LICENSE.txt +1 -1
  19. package/dist/index.window.js +2 -2
  20. package/dist/index.window.js.LICENSE.txt +1 -1
  21. package/package.json +9 -7
package/dist/docs/OutgoingTransfer.html CHANGED
@@ -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
 
@@ -129,6 +136,8 @@
129
136
  <th>Type</th>
130
137
 
131
138
 
139
+ <th>Argument</th>
140
+
132
141
 
133
142
 
134
143
 
@@ -155,10 +164,16 @@
155
164
  </td>
156
165
 
157
166
 
167
+ <td class="attributes">
168
+
169
+
170
+
171
+ </td>
172
+
158
173
 
159
174
 
160
175
 
161
- <td class="description last"><p>The timestamp when this <a href="OutgoingTransfer.html">OutgoingTransfer</a> was created</p></td>
176
+ <td class="description last"><p>The timestamp when this Transfer was created</p></td>
162
177
  </tr>
163
178
 
164
179
 
@@ -179,10 +194,16 @@
179
194
  </td>
180
195
 
181
196
 
197
+ <td class="attributes">
198
+
199
+
200
+
201
+ </td>
202
+
182
203
 
183
204
 
184
205
 
185
- <td class="description last"><p>The timestamp when this <a href="OutgoingTransfer.html">OutgoingTransfer</a> was last updated</p></td>
206
+ <td class="description last"><p>The timestamp when this Transfer was last updated</p></td>
186
207
  </tr>
187
208
 
188
209
 
@@ -203,6 +224,12 @@
203
224
  </td>
204
225
 
205
226
 
227
+ <td class="attributes">
228
+
229
+
230
+
231
+ </td>
232
+
206
233
 
207
234
 
208
235
 
@@ -211,6 +238,36 @@
211
238
 
212
239
 
213
240
 
241
+ <tr>
242
+
243
+ <td class="name"><code>queueSid</code></td>
244
+
245
+
246
+ <td class="type">
247
+
248
+
249
+ <span class="param-type">string</span>
250
+
251
+
252
+
253
+
254
+ </td>
255
+
256
+
257
+ <td class="attributes">
258
+
259
+
260
+
261
+ </td>
262
+
263
+
264
+
265
+
266
+ <td class="description last"><p>The Sid of the TaskQueue the <a href="Task.html">Task</a> belongs to</p></td>
267
+ </tr>
268
+
269
+
270
+
214
271
  <tr>
215
272
 
216
273
  <td class="name"><code>reservationSid</code></td>
@@ -227,17 +284,23 @@
227
284
  </td>
228
285
 
229
286
 
287
+ <td class="attributes">
288
+
289
+
290
+
291
+ </td>
292
+
230
293
 
231
294
 
232
295
 
233
- <td class="description last"><p>The sid of the initiating <a href="Reservation.html">Reservation</a>.</p></td>
296
+ <td class="description last"><p>The Sid of the initiating <a href="Reservation.html">Reservation</a>.</p></td>
234
297
  </tr>
235
298
 
236
299
 
237
300
 
238
301
  <tr>
239
302
 
240
- <td class="name"><code>sid</code></td>
303
+ <td class="name"><code>to</code></td>
241
304
 
242
305
 
243
306
  <td class="type">
@@ -251,17 +314,23 @@
251
314
  </td>
252
315
 
253
316
 
317
+ <td class="attributes">
318
+
319
+
320
+
321
+ </td>
322
+
254
323
 
255
324
 
256
325
 
257
- <td class="description last"><p>The sid of this <a href="OutgoingTransfer.html">OutgoingTransfer</a></p></td>
326
+ <td class="description last"><p>The sid of the <a href="Worker.html">Worker</a> or TaskQueue this Transfer is intended for</p></td>
258
327
  </tr>
259
328
 
260
329
 
261
330
 
262
331
  <tr>
263
332
 
264
- <td class="name"><code>status</code></td>
333
+ <td class="name"><code>transferFailedReason</code></td>
265
334
 
266
335
 
267
336
  <td class="type">
@@ -275,17 +344,25 @@
275
344
  </td>
276
345
 
277
346
 
347
+ <td class="attributes">
348
+
349
+ &lt;optional&gt;<br>
350
+
351
+
352
+
353
+ </td>
354
+
278
355
 
279
356
 
280
357
 
281
- <td class="description last"><p>['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED']</p></td>
358
+ <td class="description last"><p>The reason, if applicable, for why a transfer failed</p></td>
282
359
  </tr>
283
360
 
284
361
 
285
362
 
286
363
  <tr>
287
364
 
288
- <td class="name"><code>to</code></td>
365
+ <td class="name"><code>type</code></td>
289
366
 
290
367
 
291
368
  <td class="type">
@@ -299,17 +376,23 @@
299
376
  </td>
300
377
 
301
378
 
379
+ <td class="attributes">
380
+
381
+
382
+
383
+ </td>
384
+
302
385
 
303
386
 
304
387
 
305
- <td class="description last"><p>The sid of the <a href="Worker.html">Worker</a> or TaskQueue this <a href="OutgoingTransfer.html">OutgoingTransfer</a> is intended for</p></td>
388
+ <td class="description last"><p>The transfer type ['QUEUE', 'WORKER']</p></td>
306
389
  </tr>
307
390
 
308
391
 
309
392
 
310
393
  <tr>
311
394
 
312
- <td class="name"><code>transferFailedReason</code></td>
395
+ <td class="name"><code>sid</code></td>
313
396
 
314
397
 
315
398
  <td class="type">
@@ -323,17 +406,23 @@
323
406
  </td>
324
407
 
325
408
 
409
+ <td class="attributes">
410
+
411
+
412
+
413
+ </td>
414
+
326
415
 
327
416
 
328
417
 
329
- <td class="description last"><p>The reason, if applicable, for why the transfer failed</p></td>
418
+ <td class="description last"><p>The sid of this Transfer</p></td>
330
419
  </tr>
331
420
 
332
421
 
333
422
 
334
423
  <tr>
335
424
 
336
- <td class="name"><code>type</code></td>
425
+ <td class="name"><code>status</code></td>
337
426
 
338
427
 
339
428
  <td class="type">
@@ -347,10 +436,16 @@
347
436
  </td>
348
437
 
349
438
 
439
+ <td class="attributes">
440
+
350
441
 
442
+
443
+ </td>
351
444
 
352
445
 
353
- <td class="description last"><p>The transfer type ['QUEUE', 'WORKER']</p></td>
446
+
447
+
448
+ <td class="description last"><p>['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED']</p></td>
354
449
  </tr>
355
450
 
356
451
 
@@ -371,6 +466,12 @@
371
466
  </td>
372
467
 
373
468
 
469
+ <td class="attributes">
470
+
471
+
472
+
473
+ </td>
474
+
374
475
 
375
476
 
376
477
 
@@ -378,6 +479,36 @@
378
479
  </tr>
379
480
 
380
481
 
482
+
483
+ <tr>
484
+
485
+ <td class="name"><code>workflowSid</code></td>
486
+
487
+
488
+ <td class="type">
489
+
490
+
491
+ <span class="param-type">string</span>
492
+
493
+
494
+
495
+
496
+ </td>
497
+
498
+
499
+ <td class="attributes">
500
+
501
+
502
+
503
+ </td>
504
+
505
+
506
+
507
+
508
+ <td class="description last"><p>The Sid of the Workflow the <a href="Task.html">Task</a> was created against</p></td>
509
+ </tr>
510
+
511
+
381
512
  </tbody>
382
513
  </table>
383
514
  </dl>
@@ -439,15 +570,101 @@
439
570
  </div>
440
571
 
441
572
 
573
+ <h3 class="subsection-title">Extends</h3>
574
+
575
+
576
+
577
+
578
+ <ul>
579
+ <li>Transfer</li>
580
+ </ul>
581
+
582
+
583
+
584
+
585
+
586
+
587
+
442
588
 
443
589
 
444
590
 
445
591
 
446
592
 
447
593
 
594
+ <h3 class="subsection-title">Members</h3>
595
+
596
+ <dl>
597
+
598
+ <hr>
599
+ <dt class="name" id="taskSid">
600
+ <h4 id="taskSid"><span class="type-signature"></span>taskSid<span class="type-signature"> :string</span></h4>
448
601
 
449
602
 
603
+ </dt>
604
+ <dd>
605
+
606
+ <div class="description">
607
+ <p>taskSid</p>
608
+ </div>
609
+
610
+
611
+
612
+ <h5>Type:</h5>
613
+ <ul>
614
+ <li>
615
+
616
+ <span class="param-type">string</span>
617
+
618
+
450
619
 
620
+ </li>
621
+ </ul>
622
+
623
+
624
+
625
+ <dl class="details">
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+ </dl>
662
+
663
+
664
+
665
+ </dd>
666
+
667
+ </dl>
451
668
 
452
669
 
453
670
 
@@ -1122,9 +1339,9 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
1122
1339
 
1123
1340
 
1124
1341
  <span class="jsdoc-message">
1125
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
1342
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
1126
1343
 
1127
- on 2023-05-09T04:37:13+00:00
1344
+ on 2023-08-01T08:45:21+00:00
1128
1345
 
1129
1346
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1130
1347
  </span>