twilio-taskrouter 0.8.4 → 2.0.0

package/dist/docs/global.html

@@ -2736,8 +2736,8 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
             
                 
 <hr>
-<dt class="name" id="HoldOptions">
-    <h4 id="HoldOptions">HoldOptions</h4>
+<dt class="name" id="RedirectOptions">
+    <h4 id="RedirectOptions">RedirectOptions</h4>
 
     
 </dt>
@@ -2775,8 +2775,12 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
         <th>Type</th>
 
         
+        <th>Argument</th>
+        
 
         
+        <th>Default</th>
+        
 
         <th class="last">Description</th>
     </tr>
@@ -2787,13 +2791,13 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
 
         <tr>
             
-                <td class="name"><code>holdUrl</code></td>
+                <td class="name"><code>accept</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type">boolean</span>
 
 
 
@@ -2801,34 +2805,25 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
             </td>
 
             
-
-            
-
-            <td class="description last"><p>The URL endpoint to play when participant is on hold.</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>holdMethod</code></td>
-            
-
-            <td class="type">
-            
+                <td class="attributes">
+                
+                    &lt;optional&gt;<br>
                 
-<span class="param-type">'GET'</span>
-
-
 
+                
+                </td>
             
-            </td>
 
             
-
+                <td class="default">
+                
+                    false
+                
+                </td>
             
 
-            <td class="description last"><p>The HTTP method for the hold URL.</p></td>
+            <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
+accepted before initiating the call</p></td>
         </tr>
 
     
@@ -2880,8 +2875,8 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
             
                 
 <hr>
-<dt class="name" id="RedirectOptions">
-    <h4 id="RedirectOptions">RedirectOptions</h4>
+<dt class="name" id="RejectOptions">
+    <h4 id="RejectOptions">RejectOptions</h4>
 
     
 </dt>
@@ -2919,12 +2914,8 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
         <th>Type</th>
 
         
-        <th>Argument</th>
-        
 
         
-        <th>Default</th>
-        
 
         <th class="last">Description</th>
     </tr>
@@ -2935,13 +2926,13 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
 
         <tr>
             
-                <td class="name"><code>accept</code></td>
+                <td class="name"><code>activitySid</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">boolean</span>
+<span class="param-type">string</span>
 
 
 
@@ -2949,25 +2940,11 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
             </td>
 
             
-                <td class="attributes">
-                
-                    &lt;optional&gt;<br>
-                
-
-                
-                </td>
-            
 
             
-                <td class="default">
-                
-                    false
-                
-                </td>
-            
 
-            <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
-accepted before initiating the call</p></td>
+            <td class="description last"><p>The sid of the <a href="Activity.html">Activity</a> to update the worker to
+upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
         </tr>
 
     
@@ -3019,8 +2996,8 @@ accepted before initiating the call</p></td>
             
                 
 <hr>
-<dt class="name" id="RejectOptions">
-    <h4 id="RejectOptions">RejectOptions</h4>
+<dt class="name" id="ReservationParticipantOptions">
+    <h4 id="ReservationParticipantOptions">ReservationParticipantOptions</h4>
 
     
 </dt>
@@ -3070,13 +3047,13 @@ accepted before initiating the call</p></td>
 
         <tr>
             
-                <td class="name"><code>activitySid</code></td>
+                <td class="name"><code>endConferenceOnExit</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type">boolean</span>
 
 
 
@@ -3087,8 +3064,55 @@ accepted before initiating the call</p></td>
 
             
 
-            <td class="description last"><p>The sid of the <a href="Activity.html">Activity</a> to update the worker to
-upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
+            <td class="description last"><p>Whether the Conference should end when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>mute</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>Mute or unmute this <a href="Worker.html">Worker</a> participant</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>beepOnExit</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>Whether there should be a beep sound when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
         </tr>
 
     
@@ -3140,8 +3164,8 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
             
                 
 <hr>
-<dt class="name" id="ReservationParticipantOptions">
-    <h4 id="ReservationParticipantOptions">ReservationParticipantOptions</h4>
+<dt class="name" id="TaskHoldOptions">
+    <h4 id="TaskHoldOptions">TaskHoldOptions</h4>
 
     
 </dt>
@@ -3179,6 +3203,8 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
         <th>Type</th>
 
         
+        <th>Argument</th>
+        
 
         
 
@@ -3191,13 +3217,13 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
 
         <tr>
             
-                <td class="name"><code>endConferenceOnExit</code></td>
+                <td class="name"><code>holdUrl</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">boolean</span>
+<span class="param-type">string</span>
 
 
 
@@ -3205,47 +3231,31 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
             </td>
 
             
-
-            
-
-            <td class="description last"><p>Whether the Conference should end when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>mute</code></td>
-            
-
-            <td class="type">
-            
+                <td class="attributes">
+                
+                    &lt;optional&gt;<br>
                 
-<span class="param-type">boolean</span>
-
-
-
-            
-            </td>
 
+                
+                </td>
             
 
             
 
-            <td class="description last"><p>Mute or unmute this <a href="Worker.html">Worker</a> participant</p></td>
+            <td class="description last"><p>The URL endpoint to play when participant is on hold.</p></td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>beepOnExit</code></td>
+                <td class="name"><code>holdMethod</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">boolean</span>
+<span class="param-type">'GET'</span>
 
 
 
@@ -3253,10 +3263,18 @@ 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>Whether there should be a beep sound when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
+            
+
+            <td class="description last"><p>The HTTP method for the hold URL.</p></td>
         </tr>
 
     
@@ -4661,7 +4679,7 @@ provided, defaults to 'default' channel.</p></td>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/index.html

@@ -97,12 +97,13 @@
 
 
     <section class="readme-section">
-        <article><p><a href="https://travis-ci.org/twilio/twilio-taskrouter.js"><img src="https://travis-ci.org/twilio/twilio-taskrouter.js.svg?branch=master" alt="Build Status"></a>
+        <article><p><a href="https://github.com/twilio/twilio-taskrouter.js/actions/workflows/build.yml"><img src="https://github.com/twilio/twilio-taskrouter.js/actions/workflows/build.yml/badge.svg" alt="build"></a>
+<a href="https://github.com/twilio/twilio-taskrouter.js/actions/workflows/release.yml"><img src="https://github.com/twilio/twilio-taskrouter.js/actions/workflows/release.yml/badge.svg" alt="Release"></a>
 <a href="https://badge.fury.io/js/twilio-taskrouter"><img src="https://badge.fury.io/js/twilio-taskrouter.svg" alt="npm version"></a></p>
 <h1>twilio-taskrouter.js</h1>
+<p><a href="https://badge.fury.io/js/twilio-taskrouter"><img src="https://badge.fury.io/js/twilio-taskrouter.svg" alt="npm version"></a></p>
 <p>TaskRouter is Twilio's skills based routing system. With this library, you can manage your Workers in the browser or view the state of your Workspace.</p>
-<p><strong>NOTE: This SDK is in a Developer Preview Release</strong>. This version of TaskRouter is intended for Twilio Flex. If you are using it outside of Twilio Flex, you may encounter bugs and instability, and
-the underlying APIs available in this release may change in subsequent releases.</p>
+<p>This version of TaskRouter SDK can be used with Twilio Flex and TaskRouter standalone instances.</p>
 <h2>Installation</h2>
 <h3>NPM</h3>
 <pre class="prettyprint source"><code>npm install twilio-taskrouter
@@ -111,58 +112,78 @@ the underlying APIs available in this release may change in subsequent releases.
 <p>The following is a simple example showing a Worker waiting for Reservations.
 For more information, refer to the
 <a href="//twilio.github.io/twilio-taskrouter.js/index.html">API Docs</a>.</p>
-<pre class="prettyprint source lang-js"><code>const TaskRouter = require('twilio-taskrouter');
-const Twilio = require('twilio');
+<pre class="prettyprint source lang-js"><code>const TaskRouter = require("twilio-taskrouter");
+const Twilio = require("twilio");
 const AccessToken = Twilio.jwt.AccessToken;
 const TaskRouterGrant = AccessToken.TaskRouterGrant;
 
-const accountSid = '';
-const signingKeySid = '';
-const signingKeySecret = '';
-const workspaceSid = '';
-const workerSid = '';
-
-const token = createAccessToken(accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid);
+const accountSid = "";
+const signingKeySid = "";
+const signingKeySecret = "";
+const workspaceSid = "";
+const workerSid = "";
+
+const token = createAccessToken(
+  accountSid,
+  signingKeySid,
+  signingKeySecret,
+  workspaceSid,
+  workerSid
+);
 const alice = new TaskRouter.Worker(token);
 
-alice.on('ready', readyAlice =&gt; {
-    console.log(`Worker ${readyAlice.sid} is now ready for work`);
+alice.on("ready", (readyAlice) =&gt; {
+  console.log(`Worker ${readyAlice.sid} is now ready for work`);
 });
 
-alice.on('reservationCreated', reservation =&gt; {
-    console.log(`Reservation ${reservation.sid} has been created for ${alice.sid}`);
-    console.log(`Task attributes are: ${reservation.task.attributes}`);
+alice.on("reservationCreated", (reservation) =&gt; {
+  console.log(
+    `Reservation ${reservation.sid} has been created for ${alice.sid}`
+  );
+  console.log(`Task attributes are: ${reservation.task.attributes}`);
 
-    reservation.on('accepted', acceptedReservation =&gt; {
-      console.log(`Reservation ${acceptedReservation.sid} was accepted.`);
-    });
+  reservation.on("accepted", (acceptedReservation) =&gt; {
+    console.log(`Reservation ${acceptedReservation.sid} was accepted.`);
+  });
 
-    reservation.accept().then(acceptedReservation =&gt; {
+  reservation
+    .accept()
+    .then((acceptedReservation) =&gt; {
       console.log(`Reservation status is ${acceptedReservation.status}`);
-    }).catch((err) =&gt; {
+    })
+    .catch((err) =&gt; {
       console.log(`Error: ${err}`);
     });
 });
 
-function createAccessToken(accountSid, signingKeySid, signingKeySecret, workspaceSid, workerSid) {
-    const taskRouterGrant = new TaskRouterGrant({
-        workerSid: workerSid,
-        workspaceSid: workspaceSid,
-        role: 'worker'
-    });
-
-    const accessToken = new AccessToken(accountSid, signingKeySid, signingKeySecret);
-    accessToken.addGrant(taskRouterGrant);
-    accessToken.identity = 'alice';
-
-    return accessToken.toJwt();
+function createAccessToken(
+  accountSid,
+  signingKeySid,
+  signingKeySecret,
+  workspaceSid,
+  workerSid
+) {
+  const taskRouterGrant = new TaskRouterGrant({
+    workerSid: workerSid,
+    workspaceSid: workspaceSid,
+    role: "worker",
+  });
+
+  const accessToken = new AccessToken(
+    accountSid,
+    signingKeySid,
+    signingKeySecret
+  );
+  accessToken.addGrant(taskRouterGrant);
+  accessToken.identity = "alice";
+
+  return accessToken.toJwt();
 }
-
 </code></pre>
 <h2>Changelog</h2>
-<p>See <a href="https://github.com/twilio/twilio-taskrouter.js/blob/master/CHANGELOG.md">CHANGELOG.md</a>.</p>
+<p>See <a href="https://github.com/twilio/twilio-taskrouter.js/blob/main/CHANGELOG.md">CHANGELOG.md</a>.</p>
 <h2>License</h2>
-<p>See <a href="https://github.com/twilio/twilio-taskrouter.js/blob/master/LICENSE.md">LICENSE.md</a>.</p>
+<p>See <a href="https://github.com/twilio/twilio-taskrouter.js/blob/main/LICENSE.md">LICENSE.md</a>.</p>
 <h2>Building</h2>
 <p>Fork and clone the repository. Use npm to install node 8 (other versions may run into problems).</p>
 <p>Then, install dependencies with:</p>
@@ -182,6 +203,10 @@ function createAccessToken(accountSid, signingKeySid, signingKeySecret, workspac
 <li>set ACCOUNT_SID, AUTH_TOKEN, SIGNING_KEY_SID, SIGNING_KEY_SECRET</li>
 <li>Run ./test/integration_test_setup/RunIntegrationTestLocal.sh this will create everything needed for running E2E tests and run the tests</li>
 </ul>
+<h2>Test with Sample App</h2>
+<ul>
+<li>See <a href="sample-app/README.md">README.md</a></li>
+</ul>
 <h2>Contributing</h2>
 <p>Bug fixes welcome! If you're not familiar with the GitHub pull
 request/contribution process, <a href="https://gun.io/blog/how-to-github-fork-branch-and-pull-request/">this is a nice tutorial</a>.</p></article>
@@ -230,7 +255,7 @@ request/contribution process, <a href="https://gun.io/blog/how-to-github-fork-br
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
 	
-		on 2023-08-01T08:45:21+00:00
+		on 2023-09-28T07:41:55+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>