twilio-taskrouter 0.8.2 → 0.8.3

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 (62) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/declarations/Activity.d.ts +17 -0
  3. package/dist/declarations/Channel.d.ts +19 -0
  4. package/dist/declarations/Reservation.d.ts +89 -0
  5. package/dist/declarations/Supervisor.d.ts +7 -0
  6. package/dist/declarations/Task.d.ts +53 -0
  7. package/dist/declarations/TaskQueue.d.ts +20 -0
  8. package/dist/declarations/Worker.d.ts +70 -0
  9. package/dist/declarations/WorkerContainer.d.ts +5 -0
  10. package/dist/declarations/Workspace.d.ts +40 -0
  11. package/dist/declarations/core/transfer/IncomingTransfer.d.ts +5 -0
  12. package/dist/declarations/core/transfer/OutgoingTransfer.d.ts +10 -0
  13. package/dist/declarations/core/transfer/Transfer.d.ts +21 -0
  14. package/dist/declarations/core/transfer/Transfers.d.ts +16 -0
  15. package/dist/declarations/data/ActivitiesEntity.d.ts +19 -0
  16. package/dist/declarations/data/ChannelsEntity.d.ts +20 -0
  17. package/dist/declarations/data/ReservationsEntity.d.ts +26 -0
  18. package/dist/declarations/data/WorkspaceEntity.d.ts +22 -0
  19. package/dist/declarations/descriptors/ActivityDescriptor.d.ts +10 -0
  20. package/dist/declarations/descriptors/ReservationDescriptor.d.ts +17 -0
  21. package/dist/declarations/descriptors/TaskDescriptor.d.ts +23 -0
  22. package/dist/declarations/descriptors/TaskQueueDescriptor.d.ts +18 -0
  23. package/dist/declarations/descriptors/TransferDescriptor.d.ts +15 -0
  24. package/dist/declarations/descriptors/WorkerChannelDescriptor.d.ts +16 -0
  25. package/dist/declarations/descriptors/WorkerDescriptor.d.ts +19 -0
  26. package/dist/declarations/handlers/TaskRouterEventHandler.d.ts +40 -0
  27. package/dist/declarations/index.d.ts +27 -0
  28. package/dist/declarations/signaling/EventBridgeSignaling.d.ts +26 -0
  29. package/dist/declarations/util/BaseRoutes.d.ts +4 -0
  30. package/dist/declarations/util/Configuration.d.ts +22 -0
  31. package/dist/declarations/util/Constants.d.ts +106 -0
  32. package/dist/declarations/util/Heartbeat.d.ts +19 -0
  33. package/dist/declarations/util/Logger.d.ts +17 -0
  34. package/dist/declarations/util/Paginator.d.ts +8 -0
  35. package/dist/declarations/util/Request.d.ts +8 -0
  36. package/dist/declarations/util/Retry.d.ts +7 -0
  37. package/dist/declarations/util/Routes.d.ts +67 -0
  38. package/dist/declarations/util/Tools.d.ts +3 -0
  39. package/dist/declarations/util/TwilioError.d.ts +6 -0
  40. package/dist/declarations/util/WorkspaceRoutes.d.ts +18 -0
  41. package/dist/declarations/util/errors.d.ts +51 -0
  42. package/dist/docs/Activity.html +525 -131
  43. package/dist/docs/Channel.html +900 -7
  44. package/dist/docs/IncomingTransfer.html +180 -14
  45. package/dist/docs/OutgoingTransfer.html +234 -17
  46. package/dist/docs/Reservation.html +901 -2351
  47. package/dist/docs/Supervisor.html +4385 -0
  48. package/dist/docs/Task.html +1738 -537
  49. package/dist/docs/TaskQueue.html +1021 -5
  50. package/dist/docs/Transfers.html +444 -4
  51. package/dist/docs/Worker.html +1555 -594
  52. package/dist/docs/Workspace.html +159 -913
  53. package/dist/docs/classes.list.html +1823 -14
  54. package/dist/docs/global.html +4755 -0
  55. package/dist/docs/index.html +11 -4
  56. package/dist/docs/quicksearch.html +1 -1
  57. package/dist/index.commonjs2.js +1 -1
  58. package/dist/index.commonjs2.js.LICENSE.txt +1 -1
  59. package/dist/index.window.js +2 -2
  60. package/dist/index.window.js.LICENSE.txt +1 -1
  61. package/package.json +10 -9
  62. package/dist/types.d.ts +0 -256
@@ -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
 
@@ -90,7 +97,7 @@
90
97
 
91
98
  <hr>
92
99
  <dt>
93
- <h4 class="name" id="Workspace"><span class="type-signature"></span>new <span style="color: #999">Twilio.TaskRouter.</span>Workspace(jwt [, options], workspaceSid)</h4>
100
+ <h4 class="name" id="Workspace"><span class="type-signature"></span>new <span style="color: #999">Twilio.TaskRouter.</span>Workspace(jwt [, options] [, workspaceSid])</h4>
94
101
 
95
102
 
96
103
  </dt>
@@ -169,7 +176,7 @@
169
176
  <td class="type">
170
177
 
171
178
 
172
- <span class="param-type"><a href="Workspace.html#.Options">Workspace.Options</a></span>
179
+ <span class="param-type"><a href="global.html#WorkspaceOptions">WorkspaceOptions</a></span>
173
180
 
174
181
 
175
182
 
@@ -213,6 +220,8 @@
213
220
 
214
221
  <td class="attributes">
215
222
 
223
+ &lt;optional&gt;<br>
224
+
216
225
 
217
226
 
218
227
 
@@ -312,6 +321,144 @@
312
321
 
313
322
 
314
323
 
324
+ <h3 class="subsection-title">Members</h3>
325
+
326
+ <dl>
327
+
328
+ <hr>
329
+ <dt class="name" id="workspaceSid">
330
+ <h4 id="workspaceSid"><span class="type-signature">&lt;readonly&gt; </span>workspaceSid<span class="type-signature"> :string</span></h4>
331
+
332
+
333
+ </dt>
334
+ <dd>
335
+
336
+
337
+
338
+ <h5>Type:</h5>
339
+ <ul>
340
+ <li>
341
+
342
+ <span class="param-type">string</span>
343
+
344
+
345
+
346
+ </li>
347
+ </ul>
348
+
349
+
350
+
351
+ <dl class="details">
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+ </dl>
388
+
389
+
390
+
391
+ </dd>
392
+
393
+
394
+
395
+ <hr>
396
+ <dt class="name" id="workspaceSid">
397
+ <h4 id="workspaceSid"><span class="type-signature"></span>workspaceSid<span class="type-signature"> :string</span></h4>
398
+
399
+
400
+ </dt>
401
+ <dd>
402
+
403
+
404
+
405
+ <h5>Type:</h5>
406
+ <ul>
407
+ <li>
408
+
409
+ <span class="param-type">string</span>
410
+
411
+
412
+
413
+ </li>
414
+ </ul>
415
+
416
+
417
+
418
+ <dl class="details">
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+ </dl>
455
+
456
+
457
+
458
+ </dd>
459
+
460
+ </dl>
461
+
315
462
 
316
463
 
317
464
  <h3 class="subsection-title">Methods</h3>
@@ -443,28 +590,9 @@
443
590
  <h5>Returns:</h5>
444
591
 
445
592
 
446
- <div class="param-desc">
447
- <ul>
448
- <li>A task queue with given sid</li>
449
- </ul>
450
- </div>
451
593
 
452
594
 
453
595
 
454
- <dl>
455
- <dt>
456
- Type
457
- </dt>
458
- <dd>
459
-
460
- <span class="param-type">Promise.&lt;<a href="TaskQueue.html">TaskQueue</a>&gt;</span>
461
-
462
-
463
-
464
- </dd>
465
- </dl>
466
-
467
-
468
596
 
469
597
 
470
598
 
@@ -474,7 +602,7 @@
474
602
 
475
603
  <hr>
476
604
  <dt>
477
- <h4 class="name" id="fetchTaskQueues"><span class="type-signature"></span>fetchTaskQueues( [options])</h4>
605
+ <h4 class="name" id="fetchTaskQueues"><span class="type-signature"></span>fetchTaskQueues( [params])</h4>
478
606
 
479
607
 
480
608
  </dt>
@@ -519,13 +647,13 @@
519
647
 
520
648
  <tr>
521
649
 
522
- <td class="name"><code>options</code></td>
650
+ <td class="name"><code>params</code></td>
523
651
 
524
652
 
525
653
  <td class="type">
526
654
 
527
655
 
528
- <span class="param-type"><a href="Workspace.html#.FetchTaskQueuesParams">Workspace.FetchTaskQueuesParams</a></span>
656
+ <span class="param-type"><a href="global.html#FetchTaskQueuesParams">FetchTaskQueuesParams</a></span>
529
657
 
530
658
 
531
659
 
@@ -609,27 +737,8 @@
609
737
  <h5>Returns:</h5>
610
738
 
611
739
 
612
- <div class="param-desc">
613
- <ul>
614
- <li>A map with the task queues</li>
615
- </ul>
616
- </div>
617
-
618
-
619
-
620
- <dl>
621
- <dt>
622
- Type
623
- </dt>
624
- <dd>
625
-
626
- <span class="param-type">Promise.&lt;Map.&lt;string, <a href="TaskQueue.html">TaskQueue</a>&gt;&gt;</span>
627
-
628
740
 
629
741
 
630
- </dd>
631
- </dl>
632
-
633
742
 
634
743
 
635
744
 
@@ -763,28 +872,9 @@
763
872
  <h5>Returns:</h5>
764
873
 
765
874
 
766
- <div class="param-desc">
767
- <ul>
768
- <li>A worker with given sid</li>
769
- </ul>
770
- </div>
771
-
772
-
773
-
774
- <dl>
775
- <dt>
776
- Type
777
- </dt>
778
- <dd>
779
-
780
- <span class="param-type">Promise.&lt;<a href="Worker.html">Worker</a>&gt;</span>
781
875
 
782
876
 
783
877
 
784
- </dd>
785
- </dl>
786
-
787
-
788
878
 
789
879
 
790
880
 
@@ -794,7 +884,7 @@
794
884
 
795
885
  <hr>
796
886
  <dt>
797
- <h4 class="name" id="fetchWorkers"><span class="type-signature"></span>fetchWorkers( [options])</h4>
887
+ <h4 class="name" id="fetchWorkers"><span class="type-signature"></span>fetchWorkers( [params])</h4>
798
888
 
799
889
 
800
890
  </dt>
@@ -839,13 +929,13 @@
839
929
 
840
930
  <tr>
841
931
 
842
- <td class="name"><code>options</code></td>
932
+ <td class="name"><code>params</code></td>
843
933
 
844
934
 
845
935
  <td class="type">
846
936
 
847
937
 
848
- <span class="param-type"><a href="Workspace.html#.FetchWorkersParams">Workspace.FetchWorkersParams</a></span>
938
+ <span class="param-type"><a href="global.html#FetchWorkersParams">FetchWorkersParams</a></span>
849
939
 
850
940
 
851
941
 
@@ -929,26 +1019,7 @@
929
1019
  <h5>Returns:</h5>
930
1020
 
931
1021
 
932
- <div class="param-desc">
933
- <ul>
934
- <li>A map with the workers</li>
935
- </ul>
936
- </div>
937
-
938
-
939
-
940
- <dl>
941
- <dt>
942
- Type
943
- </dt>
944
- <dd>
945
-
946
- <span class="param-type">Promise.&lt;Map.&lt;string, <a href="Worker.html">Worker</a>&gt;&gt;</span>
947
-
948
-
949
1022
 
950
- </dd>
951
- </dl>
952
1023
 
953
1024
 
954
1025
 
@@ -1114,831 +1185,6 @@
1114
1185
 
1115
1186
 
1116
1187
 
1117
- <h3 class="subsection-title">Type Definitions</h3>
1118
-
1119
- <dl>
1120
-
1121
- <hr>
1122
- <dt class="name" id=".FetchTaskQueuesParams">
1123
- <h4 id=".FetchTaskQueuesParams">FetchTaskQueuesParams</h4>
1124
-
1125
-
1126
- </dt>
1127
- <dd>
1128
-
1129
-
1130
-
1131
- <h5>Type:</h5>
1132
- <ul>
1133
- <li>
1134
-
1135
- <span class="param-type">Object</span>
1136
-
1137
-
1138
-
1139
- </li>
1140
- </ul>
1141
-
1142
-
1143
-
1144
- <dl class="details">
1145
-
1146
-
1147
- <h5 class="subsection-title">Properties:</h5>
1148
-
1149
- <dl>
1150
-
1151
- <table class="props table table-striped">
1152
- <thead>
1153
- <tr>
1154
-
1155
- <th>Name</th>
1156
-
1157
-
1158
- <th>Type</th>
1159
-
1160
-
1161
- <th>Argument</th>
1162
-
1163
-
1164
-
1165
- <th>Default</th>
1166
-
1167
-
1168
- <th class="last">Description</th>
1169
- </tr>
1170
- </thead>
1171
-
1172
- <tbody>
1173
-
1174
-
1175
- <tr>
1176
-
1177
- <td class="name"><code>AfterSid</code></td>
1178
-
1179
-
1180
- <td class="type">
1181
-
1182
-
1183
- <span class="param-type">string</span>
1184
-
1185
-
1186
-
1187
-
1188
- </td>
1189
-
1190
-
1191
- <td class="attributes">
1192
-
1193
- &lt;optional&gt;<br>
1194
-
1195
-
1196
-
1197
- </td>
1198
-
1199
-
1200
-
1201
- <td class="default">
1202
-
1203
- null
1204
-
1205
- </td>
1206
-
1207
-
1208
- <td class="description last"></td>
1209
- </tr>
1210
-
1211
-
1212
-
1213
- <tr>
1214
-
1215
- <td class="name"><code>FriendlyName</code></td>
1216
-
1217
-
1218
- <td class="type">
1219
-
1220
-
1221
- <span class="param-type">string</span>
1222
-
1223
-
1224
-
1225
-
1226
- </td>
1227
-
1228
-
1229
- <td class="attributes">
1230
-
1231
- &lt;optional&gt;<br>
1232
-
1233
-
1234
-
1235
- </td>
1236
-
1237
-
1238
-
1239
- <td class="default">
1240
-
1241
- null
1242
-
1243
- </td>
1244
-
1245
-
1246
- <td class="description last"></td>
1247
- </tr>
1248
-
1249
-
1250
-
1251
- <tr>
1252
-
1253
- <td class="name"><code>Ordering</code></td>
1254
-
1255
-
1256
- <td class="type">
1257
-
1258
-
1259
- <span class="param-type">string</span>
1260
-
1261
-
1262
-
1263
-
1264
- </td>
1265
-
1266
-
1267
- <td class="attributes">
1268
-
1269
- &lt;optional&gt;<br>
1270
-
1271
-
1272
-
1273
- </td>
1274
-
1275
-
1276
-
1277
- <td class="default">
1278
-
1279
- null
1280
-
1281
- </td>
1282
-
1283
-
1284
- <td class="description last"></td>
1285
- </tr>
1286
-
1287
-
1288
- </tbody>
1289
- </table>
1290
- </dl>
1291
-
1292
-
1293
-
1294
-
1295
-
1296
-
1297
-
1298
-
1299
-
1300
-
1301
-
1302
-
1303
-
1304
-
1305
-
1306
-
1307
-
1308
-
1309
-
1310
-
1311
-
1312
-
1313
-
1314
-
1315
-
1316
-
1317
-
1318
-
1319
-
1320
-
1321
-
1322
-
1323
-
1324
-
1325
-
1326
-
1327
- </dl>
1328
-
1329
-
1330
-
1331
- </dd>
1332
-
1333
-
1334
-
1335
- <hr>
1336
- <dt class="name" id=".FetchWorkersParams">
1337
- <h4 id=".FetchWorkersParams">FetchWorkersParams</h4>
1338
-
1339
-
1340
- </dt>
1341
- <dd>
1342
-
1343
-
1344
-
1345
- <h5>Type:</h5>
1346
- <ul>
1347
- <li>
1348
-
1349
- <span class="param-type">Object</span>
1350
-
1351
-
1352
-
1353
- </li>
1354
- </ul>
1355
-
1356
-
1357
-
1358
- <dl class="details">
1359
-
1360
-
1361
- <h5 class="subsection-title">Properties:</h5>
1362
-
1363
- <dl>
1364
-
1365
- <table class="props table table-striped">
1366
- <thead>
1367
- <tr>
1368
-
1369
- <th>Name</th>
1370
-
1371
-
1372
- <th>Type</th>
1373
-
1374
-
1375
- <th>Argument</th>
1376
-
1377
-
1378
-
1379
- <th>Default</th>
1380
-
1381
-
1382
- <th class="last">Description</th>
1383
- </tr>
1384
- </thead>
1385
-
1386
- <tbody>
1387
-
1388
-
1389
- <tr>
1390
-
1391
- <td class="name"><code>AfterSid</code></td>
1392
-
1393
-
1394
- <td class="type">
1395
-
1396
-
1397
- <span class="param-type">string</span>
1398
-
1399
-
1400
-
1401
-
1402
- </td>
1403
-
1404
-
1405
- <td class="attributes">
1406
-
1407
- &lt;optional&gt;<br>
1408
-
1409
-
1410
-
1411
- </td>
1412
-
1413
-
1414
-
1415
- <td class="default">
1416
-
1417
- null
1418
-
1419
- </td>
1420
-
1421
-
1422
- <td class="description last"></td>
1423
- </tr>
1424
-
1425
-
1426
-
1427
- <tr>
1428
-
1429
- <td class="name"><code>FriendlyName</code></td>
1430
-
1431
-
1432
- <td class="type">
1433
-
1434
-
1435
- <span class="param-type">string</span>
1436
-
1437
-
1438
-
1439
-
1440
- </td>
1441
-
1442
-
1443
- <td class="attributes">
1444
-
1445
- &lt;optional&gt;<br>
1446
-
1447
-
1448
-
1449
- </td>
1450
-
1451
-
1452
-
1453
- <td class="default">
1454
-
1455
- null
1456
-
1457
- </td>
1458
-
1459
-
1460
- <td class="description last"></td>
1461
- </tr>
1462
-
1463
-
1464
-
1465
- <tr>
1466
-
1467
- <td class="name"><code>ActivitySid</code></td>
1468
-
1469
-
1470
- <td class="type">
1471
-
1472
-
1473
- <span class="param-type">string</span>
1474
-
1475
-
1476
-
1477
-
1478
- </td>
1479
-
1480
-
1481
- <td class="attributes">
1482
-
1483
- &lt;optional&gt;<br>
1484
-
1485
-
1486
-
1487
- </td>
1488
-
1489
-
1490
-
1491
- <td class="default">
1492
-
1493
- null
1494
-
1495
- </td>
1496
-
1497
-
1498
- <td class="description last"></td>
1499
- </tr>
1500
-
1501
-
1502
-
1503
- <tr>
1504
-
1505
- <td class="name"><code>ActivityName</code></td>
1506
-
1507
-
1508
- <td class="type">
1509
-
1510
-
1511
- <span class="param-type">string</span>
1512
-
1513
-
1514
-
1515
-
1516
- </td>
1517
-
1518
-
1519
- <td class="attributes">
1520
-
1521
- &lt;optional&gt;<br>
1522
-
1523
-
1524
-
1525
- </td>
1526
-
1527
-
1528
-
1529
- <td class="default">
1530
-
1531
- null
1532
-
1533
- </td>
1534
-
1535
-
1536
- <td class="description last"></td>
1537
- </tr>
1538
-
1539
-
1540
-
1541
- <tr>
1542
-
1543
- <td class="name"><code>Ordering</code></td>
1544
-
1545
-
1546
- <td class="type">
1547
-
1548
-
1549
- <span class="param-type">string</span>
1550
-
1551
-
1552
-
1553
-
1554
- </td>
1555
-
1556
-
1557
- <td class="attributes">
1558
-
1559
- &lt;optional&gt;<br>
1560
-
1561
-
1562
-
1563
- </td>
1564
-
1565
-
1566
-
1567
- <td class="default">
1568
-
1569
- null
1570
-
1571
- </td>
1572
-
1573
-
1574
- <td class="description last"></td>
1575
- </tr>
1576
-
1577
-
1578
-
1579
- <tr>
1580
-
1581
- <td class="name"><code>TargetWorkersExpression</code></td>
1582
-
1583
-
1584
- <td class="type">
1585
-
1586
-
1587
- <span class="param-type">string</span>
1588
-
1589
-
1590
-
1591
-
1592
- </td>
1593
-
1594
-
1595
- <td class="attributes">
1596
-
1597
- &lt;optional&gt;<br>
1598
-
1599
-
1600
-
1601
- </td>
1602
-
1603
-
1604
-
1605
- <td class="default">
1606
-
1607
- null
1608
-
1609
- </td>
1610
-
1611
-
1612
- <td class="description last"></td>
1613
- </tr>
1614
-
1615
-
1616
-
1617
- <tr>
1618
-
1619
- <td class="name"><code>maxWorkers</code></td>
1620
-
1621
-
1622
- <td class="type">
1623
-
1624
-
1625
- <span class="param-type">number</span>
1626
-
1627
-
1628
-
1629
-
1630
- </td>
1631
-
1632
-
1633
- <td class="attributes">
1634
-
1635
- &lt;optional&gt;<br>
1636
-
1637
-
1638
-
1639
- </td>
1640
-
1641
-
1642
-
1643
- <td class="default">
1644
-
1645
- null
1646
-
1647
- </td>
1648
-
1649
-
1650
- <td class="description last"></td>
1651
- </tr>
1652
-
1653
-
1654
- </tbody>
1655
- </table>
1656
- </dl>
1657
-
1658
-
1659
-
1660
-
1661
-
1662
-
1663
-
1664
-
1665
-
1666
-
1667
-
1668
-
1669
-
1670
-
1671
-
1672
-
1673
-
1674
-
1675
-
1676
-
1677
-
1678
-
1679
-
1680
-
1681
-
1682
-
1683
-
1684
-
1685
-
1686
-
1687
-
1688
-
1689
-
1690
-
1691
-
1692
-
1693
- </dl>
1694
-
1695
-
1696
-
1697
- </dd>
1698
-
1699
-
1700
-
1701
- <hr>
1702
- <dt class="name" id=".Options">
1703
- <h4 id=".Options">Options</h4>
1704
-
1705
-
1706
- </dt>
1707
- <dd>
1708
-
1709
-
1710
-
1711
- <h5>Type:</h5>
1712
- <ul>
1713
- <li>
1714
-
1715
- <span class="param-type">Object</span>
1716
-
1717
-
1718
-
1719
- </li>
1720
- </ul>
1721
-
1722
-
1723
-
1724
- <dl class="details">
1725
-
1726
-
1727
- <h5 class="subsection-title">Properties:</h5>
1728
-
1729
- <dl>
1730
-
1731
- <table class="props table table-striped">
1732
- <thead>
1733
- <tr>
1734
-
1735
- <th>Name</th>
1736
-
1737
-
1738
- <th>Type</th>
1739
-
1740
-
1741
- <th>Argument</th>
1742
-
1743
-
1744
-
1745
- <th>Default</th>
1746
-
1747
-
1748
- <th class="last">Description</th>
1749
- </tr>
1750
- </thead>
1751
-
1752
- <tbody>
1753
-
1754
-
1755
- <tr>
1756
-
1757
- <td class="name"><code>region</code></td>
1758
-
1759
-
1760
- <td class="type">
1761
-
1762
-
1763
- <span class="param-type">string</span>
1764
-
1765
-
1766
-
1767
-
1768
- </td>
1769
-
1770
-
1771
- <td class="attributes">
1772
-
1773
-
1774
-
1775
- </td>
1776
-
1777
-
1778
-
1779
- <td class="default">
1780
-
1781
- </td>
1782
-
1783
-
1784
- <td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
1785
- </tr>
1786
-
1787
-
1788
-
1789
- <tr>
1790
-
1791
- <td class="name"><code>edge</code></td>
1792
-
1793
-
1794
- <td class="type">
1795
-
1796
-
1797
- <span class="param-type">string</span>
1798
-
1799
-
1800
-
1801
-
1802
- </td>
1803
-
1804
-
1805
- <td class="attributes">
1806
-
1807
-
1808
-
1809
- </td>
1810
-
1811
-
1812
-
1813
- <td class="default">
1814
-
1815
- </td>
1816
-
1817
-
1818
- <td class="description last"><p>the ingress for connections (ex. "sydney")</p></td>
1819
- </tr>
1820
-
1821
-
1822
-
1823
- <tr>
1824
-
1825
- <td class="name"><code>pageSize</code></td>
1826
-
1827
-
1828
- <td class="type">
1829
-
1830
-
1831
- <span class="param-type">string</span>
1832
-
1833
-
1834
-
1835
-
1836
- </td>
1837
-
1838
-
1839
- <td class="attributes">
1840
-
1841
-
1842
-
1843
- </td>
1844
-
1845
-
1846
-
1847
- <td class="default">
1848
-
1849
- </td>
1850
-
1851
-
1852
- <td class="description last"><p>The number of items returned in each request</p></td>
1853
- </tr>
1854
-
1855
-
1856
-
1857
- <tr>
1858
-
1859
- <td class="name"><code>logLevel</code></td>
1860
-
1861
-
1862
- <td class="type">
1863
-
1864
-
1865
- <span class="param-type">string</span>
1866
-
1867
-
1868
-
1869
-
1870
- </td>
1871
-
1872
-
1873
- <td class="attributes">
1874
-
1875
- &lt;optional&gt;<br>
1876
-
1877
-
1878
-
1879
- </td>
1880
-
1881
-
1882
-
1883
- <td class="default">
1884
-
1885
- 'error'
1886
-
1887
- </td>
1888
-
1889
-
1890
- <td class="description last"><p>The level of logging to enable
1891
- ['error', 'warn', 'info', 'debug', 'trace', 'silent']</p></td>
1892
- </tr>
1893
-
1894
-
1895
- </tbody>
1896
- </table>
1897
- </dl>
1898
-
1899
-
1900
-
1901
-
1902
-
1903
-
1904
-
1905
-
1906
-
1907
-
1908
-
1909
-
1910
-
1911
-
1912
-
1913
-
1914
-
1915
-
1916
-
1917
-
1918
-
1919
-
1920
-
1921
-
1922
-
1923
-
1924
-
1925
-
1926
-
1927
-
1928
-
1929
-
1930
-
1931
-
1932
-
1933
-
1934
- </dl>
1935
-
1936
-
1937
-
1938
- </dd>
1939
-
1940
- </dl>
1941
-
1942
1188
 
1943
1189
 
1944
1190
  </article>
@@ -1983,9 +1229,9 @@
1983
1229
 
1984
1230
 
1985
1231
  <span class="jsdoc-message">
1986
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
1232
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
1987
1233
 
1988
- on 2023-05-09T04:37:13+00:00
1234
+ on 2023-07-28T07:39:46+00:00
1989
1235
 
1990
1236
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1991
1237
  </span>