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/IncomingTransfer.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
+
158
169
 
170
+
171
+ </td>
159
172
 
160
173
 
161
- <td class="description last"><p>The timestamp when this <a href="IncomingTransfer.html">IncomingTransfer</a> was created</p></td>
174
+
175
+
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="IncomingTransfer.html">IncomingTransfer</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
 
@@ -213,7 +240,7 @@
213
240
 
214
241
  <tr>
215
242
 
216
- <td class="name"><code>reservationSid</code></td>
243
+ <td class="name"><code>queueSid</code></td>
217
244
 
218
245
 
219
246
  <td class="type">
@@ -227,17 +254,23 @@
227
254
  </td>
228
255
 
229
256
 
257
+ <td class="attributes">
258
+
230
259
 
260
+
261
+ </td>
231
262
 
232
263
 
233
- <td class="description last"><p>The sid of the initiating <a href="Reservation.html">Reservation</a>.</p></td>
264
+
265
+
266
+ <td class="description last"><p>The Sid of the TaskQueue the <a href="Task.html">Task</a> belongs to</p></td>
234
267
  </tr>
235
268
 
236
269
 
237
270
 
238
271
  <tr>
239
272
 
240
- <td class="name"><code>sid</code></td>
273
+ <td class="name"><code>reservationSid</code></td>
241
274
 
242
275
 
243
276
  <td class="type">
@@ -251,17 +284,23 @@
251
284
  </td>
252
285
 
253
286
 
287
+ <td class="attributes">
288
+
289
+
290
+
291
+ </td>
292
+
254
293
 
255
294
 
256
295
 
257
- <td class="description last"><p>The sid of this <a href="IncomingTransfer.html">IncomingTransfer</a></p></td>
296
+ <td class="description last"><p>The Sid of the initiating <a href="Reservation.html">Reservation</a>.</p></td>
258
297
  </tr>
259
298
 
260
299
 
261
300
 
262
301
  <tr>
263
302
 
264
- <td class="name"><code>status</code></td>
303
+ <td class="name"><code>to</code></td>
265
304
 
266
305
 
267
306
  <td class="type">
@@ -275,17 +314,23 @@
275
314
  </td>
276
315
 
277
316
 
317
+ <td class="attributes">
318
+
319
+
320
+
321
+ </td>
322
+
278
323
 
279
324
 
280
325
 
281
- <td class="description last"><p>['INITIATED', 'FAILED', 'COMPLETE', 'CANCELED']</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>
282
327
  </tr>
283
328
 
284
329
 
285
330
 
286
331
  <tr>
287
332
 
288
- <td class="name"><code>to</code></td>
333
+ <td class="name"><code>transferFailedReason</code></td>
289
334
 
290
335
 
291
336
  <td class="type">
@@ -299,10 +344,18 @@
299
344
  </td>
300
345
 
301
346
 
347
+ <td class="attributes">
348
+
349
+ &lt;optional&gt;<br>
350
+
302
351
 
352
+
353
+ </td>
303
354
 
304
355
 
305
- <td class="description last"><p>The sid of the <a href="Worker.html">Worker</a> or TaskQueue this <a href="IncomingTransfer.html">IncomingTransfer</a> is intended for</p></td>
356
+
357
+
358
+ <td class="description last"><p>The reason, if applicable, for why a transfer failed</p></td>
306
359
  </tr>
307
360
 
308
361
 
@@ -323,6 +376,12 @@
323
376
  </td>
324
377
 
325
378
 
379
+ <td class="attributes">
380
+
381
+
382
+
383
+ </td>
384
+
326
385
 
327
386
 
328
387
 
@@ -331,6 +390,66 @@
331
390
 
332
391
 
333
392
 
393
+ <tr>
394
+
395
+ <td class="name"><code>sid</code></td>
396
+
397
+
398
+ <td class="type">
399
+
400
+
401
+ <span class="param-type">string</span>
402
+
403
+
404
+
405
+
406
+ </td>
407
+
408
+
409
+ <td class="attributes">
410
+
411
+
412
+
413
+ </td>
414
+
415
+
416
+
417
+
418
+ <td class="description last"><p>The sid of this Transfer</p></td>
419
+ </tr>
420
+
421
+
422
+
423
+ <tr>
424
+
425
+ <td class="name"><code>status</code></td>
426
+
427
+
428
+ <td class="type">
429
+
430
+
431
+ <span class="param-type">string</span>
432
+
433
+
434
+
435
+
436
+ </td>
437
+
438
+
439
+ <td class="attributes">
440
+
441
+
442
+
443
+ </td>
444
+
445
+
446
+
447
+
448
+ <td class="description last"><p>['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED']</p></td>
449
+ </tr>
450
+
451
+
452
+
334
453
  <tr>
335
454
 
336
455
  <td class="name"><code>workerSid</code></td>
@@ -347,6 +466,12 @@
347
466
  </td>
348
467
 
349
468
 
469
+ <td class="attributes">
470
+
471
+
472
+
473
+ </td>
474
+
350
475
 
351
476
 
352
477
 
@@ -354,6 +479,36 @@
354
479
  </tr>
355
480
 
356
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
+
357
512
  </tbody>
358
513
  </table>
359
514
  </dl>
@@ -415,6 +570,17 @@
415
570
  </div>
416
571
 
417
572
 
573
+ <h3 class="subsection-title">Extends</h3>
574
+
575
+
576
+
577
+
578
+ <ul>
579
+ <li>Transfer</li>
580
+ </ul>
581
+
582
+
583
+
418
584
 
419
585
 
420
586
 
@@ -473,9 +639,9 @@
473
639
 
474
640
 
475
641
  <span class="jsdoc-message">
476
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
642
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
477
643
 
478
- on 2023-05-09T04:37:13+00:00
644
+ on 2023-08-01T08:45:21+00:00
479
645
 
480
646
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
481
647
  </span>