npm - twilio-taskrouter - Versions diffs - 2.0.11 → 2.0.13 - Mend

twilio-taskrouter 2.0.11 → 2.0.13

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 (22) hide show

package/CHANGELOG.md +20 -0
package/dist/docs/Activity.html +1 -1
package/dist/docs/Channel.html +1 -1
package/dist/docs/IncomingTransfer.html +1 -1
package/dist/docs/OutgoingTransfer.html +1 -1
package/dist/docs/Reservation.html +1 -1
package/dist/docs/Supervisor.html +1 -1
package/dist/docs/Task.html +1 -1
package/dist/docs/TaskQueue.html +1 -1
package/dist/docs/Transfers.html +1 -1
package/dist/docs/Worker.html +1 -1
package/dist/docs/Workspace.html +474 -1
package/dist/docs/classes.list.html +1 -1
package/dist/docs/global.html +738 -98
package/dist/docs/index.html +1 -1
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/dist/types.d.ts +27 -0
package/package.json +5 -3

package/dist/docs/global.html CHANGED Viewed

@@ -2494,6 +2494,73 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
+</dl>
+</dd>
+<hr>
+<dt class="name" id="FetchWorkerInfoParams">
+    <h4 id="FetchWorkerInfoParams">FetchWorkerInfoParams</h4>
+</dt>
+<dd>
+        <h5>Type:</h5>
+        <ul>
+            <li>
+<span class="param-type"><a href="global.html#FetchWorkersParams">FetchWorkersParams</a></span>
+            </li>
+        </ul>
+<dl class="details">
@@ -2817,6 +2884,15 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
+	<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
+    <dd class="yes-def tag-deprecated">
+        <ul class="dummy">
+            <li>Yes</li>
+        </ul>
+    </dd>
@@ -3828,6 +3904,8 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
         <th>Type</th>
+        <th>Argument</th>
@@ -3854,6 +3932,12 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
             </td>
+                <td class="attributes">
+                </td>
@@ -3878,6 +3962,44 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
             </td>
+                <td class="attributes">
+                </td>
+            <td class="description last"></td>
+        </tr>
+        <tr>
+                <td class="name"><code>GraphQLSignaling</code></td>
+            <td class="type">
+<span class="param-type">GraphQLSignaling</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional&gt;<br>
+                </td>
@@ -3933,8 +4055,8 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
 <hr>
-<dt class="name" id="WorkerOptions">
-    <h4 id="WorkerOptions">WorkerOptions</h4>
+<dt class="name" id="WorkerInfo">
+    <h4 id="WorkerInfo">WorkerInfo</h4>
 </dt>
@@ -3972,12 +4094,8 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
         <th>Type</th>
-        <th>Argument</th>
-        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -3988,7 +4106,7 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
         <tr>
-                <td class="name"><code>connectActivitySid</code></td>
+                <td class="name"><code>accountSid</code></td>
             <td class="type">
@@ -4002,37 +4120,47 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
             </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
+            <td class="description last"><p>The SID of the owning account of the Worker</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>activityName</code></td>
+            <td class="type">
-                <td class="default">
-                    ''
-                </td>
+<span class="param-type">string</span>
+            </td>
-            <td class="description last"><p>The <a href="Activity.html">Activity</a> state of the Worker upon connect</p></td>
+            <td class="description last"><p>The name of the current activity</p></td>
         </tr>
         <tr>
-                <td class="name"><code>closeExistingSessions</code></td>
+                <td class="name"><code>activitySid</code></td>
             <td class="type">
-<span class="param-type">boolean</span>
+<span class="param-type">string</span>
@@ -4040,34 +4168,41 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
             </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
+            <td class="description last"><p>The SID of the current activity</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>attributes</code></td>
+            <td class="type">
-                <td class="default">
-                    false
-                </td>
+<span class="param-type">Object</span>
+            </td>
-            <td class="description last"><ul>
-<li>Whether other open sessions of this <a href="Worker.html">Worker</a>
-should be terminated</li>
-</ul></td>
+            <td class="description last"><p>Custom attributes describing the Worker</p></td>
         </tr>
         <tr>
-                <td class="name"><code>setWorkerOfflineIfDisconnected</code></td>
+                <td class="name"><code>available</code></td>
             <td class="type">
@@ -4081,37 +4216,23 @@ should be terminated</li>
             </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                    true
-                </td>
-            <td class="description last"><p>A boolean defining whether if <a href="Worker.html">Worker</a> availability set as Offline when the connection is terminated</p></td>
+            <td class="description last"><p>Whether the Worker is available to take on Tasks</p></td>
         </tr>
         <tr>
-                <td class="name"><code>logLevel</code></td>
+                <td class="name"><code>dateCreated</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">Date</span>
@@ -4119,38 +4240,23 @@ should be terminated</li>
             </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>
+            <td class="description last"><p>When the Worker was created</p></td>
         </tr>
         <tr>
-                <td class="name"><code>region</code></td>
+                <td class="name"><code>dateStatusChanged</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">Date</span>
@@ -4158,35 +4264,23 @@ should be terminated</li>
             </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
+            <td class="description last"><p>When the Worker’s state last changed</p></td>
         </tr>
         <tr>
-                <td class="name"><code>enableVersionCheck</code></td>
+                <td class="name"><code>dateUpdated</code></td>
             <td class="type">
-<span class="param-type">boolean</span>
+<span class="param-type">Date</span>
@@ -4194,24 +4288,570 @@ should be terminated</li>
             </td>
-                <td class="attributes">
-                    &lt;optional&gt;<br>
-                </td>
+            <td class="description last"><p>When the Worker was last updated</p></td>
+        </tr>
+        <tr>
-                <td class="default">
-                    false
-                </td>
+                <td class="name"><code>name</code></td>
-            <td class="description last"><p>To avoid accidentally overwriting objects with outdated data</p></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The friendly name of the Worker</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>sid</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The SID of the Worker</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>workspaceSid</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The SID of the Workspace the Worker belongs to</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>version</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The version of this Worker</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>workerSid</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>[Duplicate] sid of the Worker</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>workerActivitySid</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>[Duplicate] activitySid of the Worker</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>dateActivityChanged</code></td>
+            <td class="type">
+<span class="param-type">Date</span>
+            </td>
+            <td class="description last"><p>[Duplicate] dateStatusChanged of the Worker</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>friendlyName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>[Duplicate] name of the Worker</p></td>
+        </tr>
+    </tbody>
+</table>
+</dl>
+</dl>
+</dd>
+<hr>
+<dt class="name" id="WorkerOptions">
+    <h4 id="WorkerOptions">WorkerOptions</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>connectActivitySid</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional&gt;<br>
+                </td>
+                <td class="default">
+                    ''
+                </td>
+            <td class="description last"><p>The <a href="Activity.html">Activity</a> state of the Worker upon connect</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>closeExistingSessions</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional&gt;<br>
+                </td>
+                <td class="default">
+                    false
+                </td>
+            <td class="description last"><ul>
+<li>Whether other open sessions of this <a href="Worker.html">Worker</a>
+should be terminated</li>
+</ul></td>
+        </tr>
+        <tr>
+                <td class="name"><code>setWorkerOfflineIfDisconnected</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional&gt;<br>
+                </td>
+                <td class="default">
+                    true
+                </td>
+            <td class="description last"><p>A boolean defining whether if <a href="Worker.html">Worker</a> availability set as Offline when the connection is terminated</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>
+        <tr>
+                <td class="name"><code>region</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional&gt;<br>
+                </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>enableVersionCheck</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional&gt;<br>
+                </td>
+                <td class="default">
+                    false
+                </td>
+            <td class="description last"><p>To avoid accidentally overwriting objects with outdated data</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>useGraphQL</code></td>
+            <td class="type">
+<span class="param-type">boolean</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional&gt;<br>
+                </td>
+                <td class="default">
+                    false
+                </td>
+            <td class="description last"><p>Subscribe to worker events using GraphQL subscriptions</p></td>
         </tr>
@@ -4903,7 +5543,7 @@ provided, defaults to dateCreated.</p></td>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
-		on 2024-08-24T14:56:30+00:00
+		on 2025-05-07T16:55:18+00:00
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>