npm - twilio-taskrouter - Versions diffs - 0.8.2 → 0.8.4 - Mend

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

package/CHANGELOG.md +12 -0
package/dist/docs/Activity.html +525 -131
package/dist/docs/Channel.html +900 -7
package/dist/docs/IncomingTransfer.html +180 -14
package/dist/docs/OutgoingTransfer.html +234 -17
package/dist/docs/Reservation.html +901 -2351
package/dist/docs/Supervisor.html +4385 -0
package/dist/docs/Task.html +1738 -537
package/dist/docs/TaskQueue.html +1021 -5
package/dist/docs/Transfers.html +444 -4
package/dist/docs/Worker.html +1555 -594
package/dist/docs/Workspace.html +159 -913
package/dist/docs/classes.list.html +1823 -14
package/dist/docs/global.html +4755 -0
package/dist/docs/index.html +11 -4
package/dist/docs/quicksearch.html +1 -1
package/dist/index.commonjs2.js +1 -1
package/dist/index.commonjs2.js.LICENSE.txt +1 -1
package/dist/index.window.js +2 -2
package/dist/index.window.js.LICENSE.txt +1 -1
package/package.json +9 -7

package/dist/docs/Workspace.html CHANGED Viewed

@@ -30,14 +30,21 @@
 			<li class="dropdown">
 				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<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>
+					<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>
 				</ul>
 			</li>
 			<li class="dropdown">
 				<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<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>
+					<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>
+				</ul>
+			</li>
+			<li class="dropdown">
+				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
+				<ul class="dropdown-menu ">
+					<li><a href="global.html">Global</a></li>
 				</ul>
 			</li>
@@ -90,7 +97,7 @@
 <hr>
 <dt>
-    <h4 class="name" id="Workspace"><span class="type-signature"></span>new <span style="color: #999">Twilio.TaskRouter.</span>Workspace(jwt [, options], workspaceSid)</h4>
+    <h4 class="name" id="Workspace"><span class="type-signature"></span>new <span style="color: #999">Twilio.TaskRouter.</span>Workspace(jwt [, options] [, workspaceSid])</h4>
 </dt>
@@ -169,7 +176,7 @@
             <td class="type">
-<span class="param-type"><a href="Workspace.html#.Options">Workspace.Options</a></span>
+<span class="param-type"><a href="global.html#WorkspaceOptions">WorkspaceOptions</a></span>
@@ -213,6 +220,8 @@
                 <td class="attributes">
+                    &lt;optional&gt;<br>
@@ -312,6 +321,144 @@
+        <h3 class="subsection-title">Members</h3>
+        <dl>
+<hr>
+<dt class="name" id="workspaceSid">
+    <h4 id="workspaceSid"><span class="type-signature">&lt;readonly&gt; </span>workspaceSid<span class="type-signature"> :string</span></h4>
+</dt>
+<dd>
+        <h5>Type:</h5>
+        <ul>
+            <li>
+<span class="param-type">string</span>
+            </li>
+        </ul>
+<dl class="details">
+</dl>
+</dd>
+<hr>
+<dt class="name" id="workspaceSid">
+    <h4 id="workspaceSid"><span class="type-signature"></span>workspaceSid<span class="type-signature"> :string</span></h4>
+</dt>
+<dd>
+        <h5>Type:</h5>
+        <ul>
+            <li>
+<span class="param-type">string</span>
+            </li>
+        </ul>
+<dl class="details">
+</dl>
+</dd>
+        </dl>
         <h3 class="subsection-title">Methods</h3>
@@ -443,28 +590,9 @@
     <h5>Returns:</h5>
-<div class="param-desc">
-    <ul>
-<li>A task queue with given sid</li>
-</ul>
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;<a href="TaskQueue.html">TaskQueue</a>&gt;</span>
-    </dd>
-</dl>
@@ -474,7 +602,7 @@
 <hr>
 <dt>
-    <h4 class="name" id="fetchTaskQueues"><span class="type-signature"></span>fetchTaskQueues( [options])</h4>
+    <h4 class="name" id="fetchTaskQueues"><span class="type-signature"></span>fetchTaskQueues( [params])</h4>
 </dt>
@@ -519,13 +647,13 @@
         <tr>
-                <td class="name"><code>options</code></td>
+                <td class="name"><code>params</code></td>
             <td class="type">
-<span class="param-type"><a href="Workspace.html#.FetchTaskQueuesParams">Workspace.FetchTaskQueuesParams</a></span>
+<span class="param-type"><a href="global.html#FetchTaskQueuesParams">FetchTaskQueuesParams</a></span>
@@ -609,27 +737,8 @@
     <h5>Returns:</h5>
-<div class="param-desc">
-    <ul>
-<li>A map with the task queues</li>
-</ul>
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;Map.&lt;string, <a href="TaskQueue.html">TaskQueue</a>&gt;&gt;</span>
-    </dd>
-</dl>
@@ -763,28 +872,9 @@
     <h5>Returns:</h5>
-<div class="param-desc">
-    <ul>
-<li>A worker with given sid</li>
-</ul>
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;<a href="Worker.html">Worker</a>&gt;</span>
-    </dd>
-</dl>
@@ -794,7 +884,7 @@
 <hr>
 <dt>
-    <h4 class="name" id="fetchWorkers"><span class="type-signature"></span>fetchWorkers( [options])</h4>
+    <h4 class="name" id="fetchWorkers"><span class="type-signature"></span>fetchWorkers( [params])</h4>
 </dt>
@@ -839,13 +929,13 @@
         <tr>
-                <td class="name"><code>options</code></td>
+                <td class="name"><code>params</code></td>
             <td class="type">
-<span class="param-type"><a href="Workspace.html#.FetchWorkersParams">Workspace.FetchWorkersParams</a></span>
+<span class="param-type"><a href="global.html#FetchWorkersParams">FetchWorkersParams</a></span>
@@ -929,26 +1019,7 @@
     <h5>Returns:</h5>
-<div class="param-desc">
-    <ul>
-<li>A map with the workers</li>
-</ul>
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;Map.&lt;string, <a href="Worker.html">Worker</a>&gt;&gt;</span>
-    </dd>
-</dl>
@@ -1114,831 +1185,6 @@
-        <h3 class="subsection-title">Type Definitions</h3>
-        <dl>
-<hr>
-<dt class="name" id=".FetchTaskQueuesParams">
-    <h4 id=".FetchTaskQueuesParams">FetchTaskQueuesParams</h4>
-</dt>
-<dd>
-        <h5>Type:</h5>
-        <ul>
-            <li>
-<span class="param-type">Object</span>
-            </li>
-        </ul>
-<dl class="details">
-    <h5 class="subsection-title">Properties:</h5>
-    <dl>
-<table class="props table table-striped">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Argument</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>AfterSid</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>FriendlyName</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>Ordering</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-    </tbody>
-</table>
-</dl>
-</dl>
-</dd>
-<hr>
-<dt class="name" id=".FetchWorkersParams">
-    <h4 id=".FetchWorkersParams">FetchWorkersParams</h4>
-</dt>
-<dd>
-        <h5>Type:</h5>
-        <ul>
-            <li>
-<span class="param-type">Object</span>
-            </li>
-        </ul>
-<dl class="details">
-    <h5 class="subsection-title">Properties:</h5>
-    <dl>
-<table class="props table table-striped">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Argument</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>AfterSid</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>FriendlyName</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>ActivitySid</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>ActivityName</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>Ordering</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>TargetWorkersExpression</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-        <tr>
-                <td class="name"><code>maxWorkers</code></td>
-            <td class="type">
-<span class="param-type">number</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    null
-                </td>
-            <td class="description last"></td>
-        </tr>
-    </tbody>
-</table>
-</dl>
-</dl>
-</dd>
-<hr>
-<dt class="name" id=".Options">
-    <h4 id=".Options">Options</h4>
-</dt>
-<dd>
-        <h5>Type:</h5>
-        <ul>
-            <li>
-<span class="param-type">Object</span>
-            </li>
-        </ul>
-<dl class="details">
-    <h5 class="subsection-title">Properties:</h5>
-    <dl>
-<table class="props table table-striped">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Argument</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>region</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>edge</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>the ingress for connections (ex. "sydney")</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>pageSize</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>The number of items returned in each request</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>logLevel</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    'error'
-                </td>
-            <td class="description last"><p>The level of logging to enable
-['error', 'warn', 'info', 'debug', 'trace', 'silent']</p></td>
-        </tr>
-    </tbody>
-</table>
-</dl>
-</dl>
-</dd>
-            </dl>
 </article>
@@ -1983,9 +1229,9 @@
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
-		on 2023-05-09T04:37:13+00:00
+		on 2023-08-01T08:45:21+00:00
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>