twilio-taskrouter 0.5.7 → 0.5.11

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+0.6.0
+==========
+New Features
+----------
+- Add `version` field to TaskRouter resources (Task, Reservation and Worker)
+
+
+0.5.11
+==========
+Bug Fixes
+----------
+- Improved the fix for race condition when initiating task transfer
+
+Maintenance
+----------
+- Upgraded several dependencies to more recents versions
+- Upgraded node engine requirement from 6 to >=12.17.0
+
+
+0.5.10
+==========
+Bug Fixes
+----------
+- Fixed heartbeat attempting to close websocket after it was already closed
+
+Maintenance
+----------
+- Add missing type declarations
+
+0.5.9
+==========
+Bug Fixes
+----------
+- Fixed race condition when initiating task transfer
+
 0.5.7
 ==========
 Maintenance

package/README.md

@@ -111,6 +111,13 @@ Before commits, be sure to validate by running:
 make lint
 ```
 
+Testing
+------------
+- Create a twilio account
+- copy ./test/integration_test_setup/.env.example to ./test/integration_test_setup/.env
+- set ACCOUNT_SID, AUTH_TOKEN, SIGNING_KEY_SID, SIGNING_KEY_SECRET
+- Run ./test/integration_test_setup/RunIntegrationTestLocal.sh this will create everything needed for running E2E tests and run the tests
+
 Contributing
 ------------
 

package/dist/docs/Activity.html

@@ -546,7 +546,7 @@
             
 <div class="param-desc">
     <ul>
-<li>Rejected if the <a href="Worker.html">Worker</a>&apos;s activity state could not be set</li>
+<li>Rejected if the <a href="Worker.html">Worker</a>'s activity state could not be set</li>
 </ul>
 </div>
 
@@ -745,7 +745,7 @@
       <div class="modal-dialog">
         <div class="modal-content">
           <div class="modal-header">
-            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
+            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
             <h4 class="modal-title">Search results</h4>
           </div>
           <div class="modal-body"></div>
@@ -761,9 +761,9 @@
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
 	
-		on 2022-01-26T13:07:07+00:00
+		on 2022-08-10T07:57:17+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Channel.html

@@ -231,7 +231,7 @@
             
 
             <td class="description last"><p>The current available capacity of this <a href="Worker.html">Worker</a> to handle
-  <a href="Task.html">Task</a>s of this <a href="Channel.html">Channel</a> type</p></td>
+<a href="Task.html">Task</a>s of this <a href="Channel.html">Channel</a> type</p></td>
         </tr>
 
     
@@ -821,7 +821,7 @@
       <div class="modal-dialog">
         <div class="modal-content">
           <div class="modal-header">
-            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
+            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
             <h4 class="modal-title">Search results</h4>
           </div>
           <div class="modal-body"></div>
@@ -837,9 +837,9 @@
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
 	
-		on 2022-01-26T13:07:07+00:00
+		on 2022-08-10T07:57:17+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/IncomingTransfer.html

@@ -206,7 +206,7 @@
 
             
 
-            <td class="description last"><p>Transfer mode [&apos;WARM&apos;, &apos;COLD&apos;]</p></td>
+            <td class="description last"><p>Transfer mode ['WARM', 'COLD']</p></td>
         </tr>
 
     
@@ -278,7 +278,7 @@
 
             
 
-            <td class="description last"><p>[&apos;INITIATED&apos;, &apos;FAILED&apos;, &apos;COMPLETE&apos;, &apos;CANCELED&apos;]</p></td>
+            <td class="description last"><p>['INITIATED', 'FAILED', 'COMPLETE', 'CANCELED']</p></td>
         </tr>
 
     
@@ -326,7 +326,7 @@
 
             
 
-            <td class="description last"><p>The transfer type [&apos;QUEUE&apos;, &apos;WORKER&apos;]</p></td>
+            <td class="description last"><p>The transfer type ['QUEUE', 'WORKER']</p></td>
         </tr>
 
     
@@ -457,7 +457,7 @@
       <div class="modal-dialog">
         <div class="modal-content">
           <div class="modal-header">
-            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
+            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
             <h4 class="modal-title">Search results</h4>
           </div>
           <div class="modal-body"></div>
@@ -473,9 +473,9 @@
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
 	
-		on 2022-01-26T13:07:07+00:00
+		on 2022-08-10T07:57:17+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/OutgoingTransfer.html

@@ -206,7 +206,7 @@
 
             
 
-            <td class="description last"><p>Transfer mode [&apos;WARM&apos;, &apos;COLD&apos;]</p></td>
+            <td class="description last"><p>Transfer mode ['WARM', 'COLD']</p></td>
         </tr>
 
     
@@ -278,7 +278,7 @@
 
             
 
-            <td class="description last"><p>[&apos;INITIATED&apos;, &apos;FAILED&apos;, &apos;COMPLETED&apos;, &apos;CANCELED&apos;]</p></td>
+            <td class="description last"><p>['INITIATED', 'FAILED', 'COMPLETED', 'CANCELED']</p></td>
         </tr>
 
     
@@ -350,7 +350,7 @@
 
             
 
-            <td class="description last"><p>The transfer type [&apos;QUEUE&apos;, &apos;WORKER&apos;]</p></td>
+            <td class="description last"><p>The transfer type ['QUEUE', 'WORKER']</p></td>
         </tr>
 
     
@@ -532,7 +532,7 @@
             
 <div class="param-desc">
     <ul>
-<li>Rejected if the <a href="OutgoingTransfer.html">OutgoingTransfer</a> state could not be updated to &apos;canceled&apos;</li>
+<li>Rejected if the <a href="OutgoingTransfer.html">OutgoingTransfer</a> state could not be updated to 'canceled'</li>
 </ul>
 </div>
 
@@ -705,7 +705,7 @@
 
     
     <div class="description">
-        <p>The <a href="Task.html">Task</a>&apos;s current <a href="OutgoingTransfer.html">OutgoingTransfer</a> has successfully been cancelled</p>
+        <p>The <a href="Task.html">Task</a>'s current <a href="OutgoingTransfer.html">OutgoingTransfer</a> has successfully been cancelled</p>
     </div>
     
 
@@ -1106,7 +1106,7 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
       <div class="modal-dialog">
         <div class="modal-content">
           <div class="modal-header">
-            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
+            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
             <h4 class="modal-title">Search results</h4>
           </div>
           <div class="modal-body"></div>
@@ -1122,9 +1122,9 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
 	
-		on 2022-01-26T13:07:07+00:00
+		on 2022-08-10T07:57:17+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/dist/docs/Reservation.html

@@ -281,7 +281,7 @@
             
 
             <td class="description last"><p>The current state of the <a href="Reservation.html">Reservation</a>.
-     Options: [&apos;pending&apos;, &apos;accepted&apos;, &apos;rejected&apos;, &apos;timeout&apos;, &apos;canceled&apos;, &apos;rescinded&apos;, &apos;wrapping&apos;, &apos;completed&apos;].</p></td>
+Options: ['pending', 'accepted', 'rejected', 'timeout', 'canceled', 'rescinded', 'wrapping', 'completed'].</p></td>
         </tr>
 
     
@@ -683,7 +683,7 @@
 
             
 
-            <td class="description last"><p>A valid TwiML URI that is executed on the answering Worker&apos;s leg</p></td>
+            <td class="description last"><p>A valid TwiML URI that is executed on the answering Worker's leg</p></td>
         </tr>
 
     
@@ -1090,8 +1090,8 @@
     
     <div class="description">
         <p>Dequeue the <a href="Reservation.html">Reservation</a> to the <a href="Worker.html">Worker</a>. This will perform telephony to dequeue a
-  <a href="Task.html">Task</a> that was enqueued using the Enqueue TwiML verb. A contact_uri must exist
-  in the <a href="Worker.html">Worker</a>&apos;s attributes for this call to go through.</p>
+<a href="Task.html">Task</a> that was enqueued using the Enqueue TwiML verb. A contact_uri must exist
+in the <a href="Worker.html">Worker</a>'s attributes for this call to go through.</p>
     </div>
     
 
@@ -1351,7 +1351,7 @@
 
             
 
-            <td class="description last"><p>A valid TwiML URI that is executed on the Caller&apos;s leg upon redirecting</p></td>
+            <td class="description last"><p>A valid TwiML URI that is executed on the Caller's leg upon redirecting</p></td>
         </tr>
 
     
@@ -1653,7 +1653,7 @@
 
     
     <div class="description">
-        <p>Update the <a href="Worker.html">Worker</a>&apos;s leg in the Conference associated to this <a href="Reservation.html">Reservation</a></p>
+        <p>Update the <a href="Worker.html">Worker</a>'s leg in the Conference associated to this <a href="Reservation.html">Reservation</a></p>
     </div>
     
 
@@ -1782,7 +1782,7 @@
             
 <div class="param-desc">
     <ul>
-<li>Rejected if unable to update the Worker&apos;s leg in the Conference tied to the <a href="Reservation.html">Reservation</a></li>
+<li>Rejected if unable to update the Worker's leg in the Conference tied to the <a href="Reservation.html">Reservation</a></li>
 </ul>
 </div>
 
@@ -2007,7 +2007,7 @@
             
 
             <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
-  accepted before initiating the call</p></td>
+accepted before initiating the call</p></td>
         </tr>
 
     
@@ -2040,7 +2040,7 @@
             
                 <td class="default">
                 
-                    &apos;do-not-record&apos;
+                    'do-not-record'
                 
                 </td>
             
@@ -2122,7 +2122,7 @@
             
 
             <td class="description last"><p>The number or endpoint that should be called.
-  If not provided, the contact_uri defined in the <a href="Worker.html">Worker</a> attributes will be used</p></td>
+If not provided, the contact_uri defined in the <a href="Worker.html">Worker</a> attributes will be used</p></td>
         </tr>
 
     
@@ -2160,7 +2160,7 @@
                 </td>
             
 
-            <td class="description last"><p>The integer number of seconds Twilio should allow the phone associated to &quot;contact_uri&quot; to ring</p></td>
+            <td class="description last"><p>The integer number of seconds Twilio should allow the phone associated to "contact_uri" to ring</p></td>
         </tr>
 
     
@@ -2299,7 +2299,7 @@
             
 
             <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>; can be a phone
-  number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>&apos;s attributes.</p></td>
+number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>'s attributes.</p></td>
         </tr>
 
     
@@ -2338,7 +2338,7 @@
             
 
             <td class="description last"><p>The caller id for the call to the <a href="Worker.html">Worker</a>.
-  Must be a verified Twilio number.</p></td>
+Must be a verified Twilio number.</p></td>
         </tr>
 
     
@@ -2377,7 +2377,7 @@
             
 
             <td class="description last"><p>The integer number of seconds that
-  Twilio should allow the call to ring before assuming there is no answer.</p></td>
+Twilio should allow the call to ring before assuming there is no answer.</p></td>
         </tr>
 
     
@@ -2448,7 +2448,7 @@
             
                 <td class="default">
                 
-                    &apos;POST&apos;
+                    'POST'
                 
                 </td>
             
@@ -2486,13 +2486,13 @@
             
                 <td class="default">
                 
-                    &apos;completed&apos;
+                    'completed'
                 
                 </td>
             
 
             <td class="description last"><p>A comma separated list of events to subscribe to.
-  The possible list of events are: [&apos;initiated&apos;, &apos;ringing&apos;, &apos;answered&apos;, &apos;completed&apos;].</p></td>
+The possible list of events are: ['initiated', 'ringing', 'answered', 'completed'].</p></td>
         </tr>
 
     
@@ -2525,7 +2525,7 @@
             
                 <td class="default">
                 
-                    &apos;do-not-record&apos;
+                    'do-not-record'
                 
                 </td>
             
@@ -2610,7 +2610,7 @@
             
 
             <td class="description last"><p>Whether the <a href="Worker.html">Worker</a> leg should be when entering the Conference.
-  The options for beep are: [true, false, &apos;onEnter&apos;, &apos;onExit&apos;].</p></td>
+The options for beep are: [true, false, 'onEnter', 'onExit'].</p></td>
         </tr>
 
     
@@ -2833,7 +2833,7 @@
             
                 <td class="default">
                 
-                    &apos;POST&apos;
+                    'POST'
                 
                 </td>
             
@@ -2985,7 +2985,7 @@
             
                 <td class="default">
                 
-                    &apos;POST&apos;
+                    'POST'
                 
                 </td>
             
@@ -3023,13 +3023,13 @@
             
                 <td class="default">
                 
-                    &apos;start,end&apos;
+                    'start,end'
                 
                 </td>
             
 
             <td class="description last"><p>A comma separated list of Conference events to subscribe to.
-  The possible list of events are: [&apos;start&apos;, &apos;end&apos;, &apos;join&apos;, &apos;leave&apos;, &apos;mute&apos;, &apos;hold&apos;, &apos;speaker&apos;].</p></td>
+The possible list of events are: ['start', 'end', 'join', 'leave', 'mute', 'hold', 'speaker'].</p></td>
         </tr>
 
     
@@ -3071,7 +3071,7 @@
             
 
             <td class="description last"><p>Whether the entire Conference should be recorded.
-  The possible options for conferenceRecord are: [true, false, &apos;record-from-start&apos;, &apos;do-not-record&apos;].</p></td>
+The possible options for conferenceRecord are: [true, false, 'record-from-start', 'do-not-record'].</p></td>
         </tr>
 
     
@@ -3104,13 +3104,13 @@
             
                 <td class="default">
                 
-                    &apos;trim-silence&apos;
+                    'trim-silence'
                 
                 </td>
             
 
             <td class="description last"><p>Whether to trim the Conference recording.
-  The options for conferenceTrim are: [&apos;trim-silence&apos;, &apos;do-not-trim&apos;].</p></td>
+The options for conferenceTrim are: ['trim-silence', 'do-not-trim'].</p></td>
         </tr>
 
     
@@ -3143,12 +3143,12 @@
             
                 <td class="default">
                 
-                    &apos;mono&apos;
+                    'mono'
                 
                 </td>
             
 
-            <td class="description last"><p>Which channel of the Conference to record. The options are: [&apos;mono&apos;, &apos;dual&apos;].</p></td>
+            <td class="description last"><p>Which channel of the Conference to record. The options are: ['mono', 'dual'].</p></td>
         </tr>
 
     
@@ -3219,7 +3219,7 @@
             
                 <td class="default">
                 
-                    &apos;POST&apos;
+                    'POST'
                 
                 </td>
             
@@ -3295,7 +3295,7 @@
             
                 <td class="default">
                 
-                    &apos;POST&apos;
+                    'POST'
                 
                 </td>
             
@@ -3338,7 +3338,7 @@
                 </td>
             
 
-            <td class="description last"><p>The specific region. The options for region are: [&apos;us1&apos;, &apos;ie1&apos;, &apos;sg1&apos;, &apos;br1&apos;, &apos;au1&apos;, &apos;jp1&apos;].</p></td>
+            <td class="description last"><p>The specific region. The options for region are: ['us1', 'ie1', 'sg1', 'br1', 'au1', 'jp1'].</p></td>
         </tr>
 
     
@@ -3553,7 +3553,7 @@
             
 
             <td class="description last"><p>The caller id for the call to the <a href="Worker.html">Worker</a>.
-  Must be a verified Twilio number.</p></td>
+Must be a verified Twilio number.</p></td>
         </tr>
 
     
@@ -3592,7 +3592,7 @@
             
 
             <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>; can be a phone
-  number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>&apos;s attributes.</p></td>
+number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>'s attributes.</p></td>
         </tr>
 
     
@@ -3631,7 +3631,7 @@
             
 
             <td class="description last"><p>The activitySid to update the
-  <a href="Worker.html">Worker</a> to after dequeuing the <a href="Reservation.html">Reservation</a>.</p></td>
+<a href="Worker.html">Worker</a> to after dequeuing the <a href="Reservation.html">Reservation</a>.</p></td>
         </tr>
 
     
@@ -3664,13 +3664,13 @@
             
                 <td class="default">
                 
-                    &apos;do-not-record&apos;
+                    'do-not-record'
                 
                 </td>
             
 
             <td class="description last"><p>Defines which legs of the call
-  should be recorded.</p></td>
+should be recorded.</p></td>
         </tr>
 
     
@@ -3709,7 +3709,7 @@
             
 
             <td class="description last"><p>The integer number of seconds that
-  Twilio should allow the call to ring before assuming there is no answer.</p></td>
+Twilio should allow the call to ring before assuming there is no answer.</p></td>
         </tr>
 
     
@@ -3748,7 +3748,7 @@
             
 
             <td class="description last"><p>A URL that Twilio will send
-  asynchronous webhook this._request. to on a completed call event.</p></td>
+asynchronous webhook this._request. to on a completed call event.</p></td>
         </tr>
 
     
@@ -4139,7 +4139,7 @@
             
 
             <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
-  accepted before initiating the call</p></td>
+accepted before initiating the call</p></td>
         </tr>
 
     
@@ -4260,7 +4260,7 @@
             
 
             <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>
+upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
         </tr>
 
     
@@ -5239,7 +5239,7 @@
       <div class="modal-dialog">
         <div class="modal-content">
           <div class="modal-header">
-            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
+            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
             <h4 class="modal-title">Search results</h4>
           </div>
           <div class="modal-body"></div>
@@ -5255,9 +5255,9 @@
 
 
 <span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
+	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
 	
-		on 2022-01-26T13:07:07+00:00
+		on 2022-08-10T07:57:17+00:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>