twilio-taskrouter 0.8.2 → 0.8.4

package/dist/docs/Worker.html

@@ -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="Worker"><span class="type-signature"></span>new <span style="color: #999">Twilio.TaskRouter.</span>Worker(token [, options])</h4>
+    <h4 class="name" id="Worker"><span class="type-signature"></span>new <span style="color: #999">Twilio.TaskRouter.</span>Worker(token [, options] [, deps])</h4>
     
     
 </dt>
@@ -169,7 +176,41 @@
             <td class="type">
             
                 
-<span class="param-type"><a href="Worker.html#.Options">Worker.Options</a></span>
+<span class="param-type"><a href="global.html#WorkerOptions">WorkerOptions</a></span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional&gt;<br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>deps</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="global.html#WorkerDeps">WorkerDeps</a></span>
 
 
 
@@ -355,7 +396,7 @@
             <td class="type">
             
                 
-<span class="param-type">Object</span>
+<span class="param-type">Record.&lt;any, any&gt;</span>
 
 
 
@@ -810,6 +851,15 @@
     </div>
 
     
+        <h3 class="subsection-title">Extends</h3>
+
+        
+
+
+    <ul>
+        <li>EventEmitter</li>
+    </ul>
+
 
     
 
@@ -822,219 +872,141 @@
     
 
     
-        <h3 class="subsection-title">Methods</h3>
+        <h3 class="subsection-title">Members</h3>
 
         <dl>
             
 <hr>
-<dt>
-    <h4 class="name" id="createTask"><span class="type-signature"></span>createTask(to, from, workflowSid, taskQueueSid [, options])</h4>
-    
+<dt class="name" id="accountSid">
+    <h4 id="accountSid"><span class="type-signature">&lt;readonly&gt; </span>accountSid<span class="type-signature"> :string</span></h4>
+
     
 </dt>
 <dd>
-
-    
-    <div class="description">
-        <p>Create a Task</p>
-    </div>
     
 
     
+        <h5>Type:</h5>
+        <ul>
+            <li>
+                
+<span class="param-type">string</span>
 
+
+
+            </li>
+        </ul>
     
 
     
+<dl class="details">
     
-        <h5>Parameters:</h5>
-        
-
-<table class="params table table-striped">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
-
-        <th>Type</th>
 
-        
-        <th>Argument</th>
-        
+	
 
-        
+	
 
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+	
 
-    <tbody>
     
 
-        <tr>
-            
-                <td class="name"><code>to</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-
-                
+    
 
-                
-                </td>
-            
+    
 
-            
+    
 
-            <td class="description last"><p>The contact uri of the customer. Stored in the <a href="Task.html">Task</a>'s attributes as "outbound_to"</p></td>
-        </tr>
+	
 
-    
+	
 
-        <tr>
-            
-                <td class="name"><code>from</code></td>
-            
+	
 
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
+	
 
+	
 
 
-            
-            </td>
 
-            
-                <td class="attributes">
-                
+	
 
-                
+	
 
-                
-                </td>
-            
+	
 
-            
+	
+</dl>
 
-            <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>. Stored in the <a href="Task.html">Task</a>'s attributes as "from"</p></td>
-        </tr>
 
     
+</dd>
 
-        <tr>
-            
-                <td class="name"><code>workflowSid</code></td>
-            
-
-            <td class="type">
+        
             
-                
-<span class="param-type">string</span>
-
-
+<hr>
+<dt class="name" id="activities">
+    <h4 id="activities"><span class="type-signature"></span>activities<span class="type-signature"></span></h4>
 
-            
-            </td>
+    
+</dt>
+<dd>
+    
 
-            
-                <td class="attributes">
-                
+    
 
-                
+    
+<dl class="details">
+    
 
-                
-                </td>
-            
+	
 
-            
+	
 
-            <td class="description last"><p>The Sid of the Workflow this Task should belong to</p></td>
-        </tr>
+	
 
     
 
-        <tr>
-            
-                <td class="name"><code>taskQueueSid</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
+    
 
-            
-            </td>
+    
 
-            
-                <td class="attributes">
-                
+    
 
-                
+	
 
-                
-                </td>
-            
+	
 
-            
+	
 
-            <td class="description last"><p>The Sid of the <a href="TaskQueue.html">TaskQueue</a> this Task should belong to, used for reporting
-purposes only</p></td>
-        </tr>
+	
 
-    
+	
 
-        <tr>
-            
-                <td class="name"><code>options</code></td>
-            
 
-            <td class="type">
-            
-                
-<span class="param-type"><a href="Worker.html#.TaskOptions">Worker.TaskOptions</a></span>
 
+	
 
+	
 
-            
-            </td>
+	
 
-            
-                <td class="attributes">
-                
-                    &lt;optional&gt;<br>
-                
+	
+</dl>
 
-                
 
-                
-                </td>
-            
+    
+</dd>
 
+        
             
-
-            <td class="description last"></td>
-        </tr>
+<hr>
+<dt class="name" id="activity">
+    <h4 id="activity"><span class="type-signature">&lt;readonly&gt; </span>activity<span class="type-signature"></span></h4>
 
     
-    </tbody>
-</table>
+</dt>
+<dd>
+    
 
     
 
@@ -1079,68 +1051,30 @@ purposes only</p></td>
 
 
     
+</dd>
 
-    
+        
+            
+<hr>
+<dt class="name" id="attributes">
+    <h4 id="attributes"><span class="type-signature">&lt;readonly&gt; </span>attributes<span class="type-signature"> :Record.&lt;any, any&gt;</span></h4>
 
     
-
-    
-
-    
-
-    
-    <h5>Returns:</h5>
-    
-            
-<div class="param-desc">
-    <ul>
-<li>Rejected if unable to create a Task on behalf of the <a href="Worker.html">Worker</a>. Returns the
-TaskSid of the created Task.</li>
-</ul>
-</div>
-
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">Promise.&lt;String&gt;</span>
-
-
-
-    </dd>
-</dl>
-
-
-        
-
-    
-</dd>
-
-        
-            
-<hr>
-<dt>
-    <h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect()</h4>
-    
-    
 </dt>
 <dd>
-
-    
-    <div class="description">
-        <p>Gracefully disconnect the client.</p>
-    </div>
     
 
     
+        <h5>Type:</h5>
+        <ul>
+            <li>
+                
+<span class="param-type">Record.&lt;any, any&gt;</span>
 
-    
 
-    
+
+            </li>
+        </ul>
     
 
     
@@ -1184,36 +1118,60 @@ TaskSid of the created Task.</li>
 
 
     
+</dd>
+
+        
+            
+<hr>
+<dt class="name" id="channels">
+    <h4 id="channels"><span class="type-signature"></span>channels<span class="type-signature"></span></h4>
+
+    
+</dt>
+<dd>
+    
 
     
 
     
+<dl class="details">
+    
+
+	
+
+	
+
+	
 
     
 
     
 
     
-    <h5>Returns:</h5>
+
     
-            
 
+	
 
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">void</span>
+	
+
+	
 
+	
 
+	
 
-    </dd>
-</dl>
 
 
-        
+	
+
+	
+
+	
+
+	
+</dl>
+
 
     
 </dd>
@@ -1221,24 +1179,25 @@ TaskSid of the created Task.</li>
         
             
 <hr>
-<dt>
-    <h4 class="name" id="fetchLatestVersion"><span class="type-signature"></span>fetchLatestVersion()</h4>
-    
+<dt class="name" id="dateActivityChanged">
+    <h4 id="dateActivityChanged"><span class="type-signature">&lt;readonly&gt; </span>dateActivityChanged<span class="type-signature"> :Date</span></h4>
+
     
 </dt>
 <dd>
-
-    
-    <div class="description">
-        <p>Fetch the last version of this <a href="Worker.html">Worker</a></p>
-    </div>
     
 
     
+        <h5>Type:</h5>
+        <ul>
+            <li>
+                
+<span class="param-type">Date</span>
 
-    
 
-    
+
+            </li>
+        </ul>
     
 
     
@@ -1282,111 +1241,97 @@ TaskSid of the created Task.</li>
 
 
     
+</dd>
 
-    
-
-    
+        
+            
+<hr>
+<dt class="name" id="dateCreated">
+    <h4 id="dateCreated"><span class="type-signature">&lt;readonly&gt; </span>dateCreated<span class="type-signature"> :Date</span></h4>
 
     
-
+</dt>
+<dd>
     
 
     
-    <h5>Returns:</h5>
-    
-            
-
+        <h5>Type:</h5>
+        <ul>
+            <li>
+                
+<span class="param-type">Date</span>
 
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">Promise.&lt;<a href="Worker.html">Worker</a>&gt;</span>
 
 
+            </li>
+        </ul>
+    
 
-    </dd>
-</dl>
+    
+<dl class="details">
+    
 
+	
 
-        
+	
 
-    
-</dd>
+	
 
-        
-            
-<hr>
-<dt>
-    <h4 class="name" id="setAttributes"><span class="type-signature"></span>setAttributes(attributes)</h4>
     
-    
-</dt>
-<dd>
 
     
-    <div class="description">
-        <p>Update attributes</p>
-    </div>
-    
 
     
 
     
 
-    
-    
-        <h5>Parameters:</h5>
-        
+	
 
-<table class="params table table-striped">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
+	
 
-        <th>Type</th>
+	
 
-        
+	
 
-        
+	
 
-        <th class="last">Description</th>
-    </tr>
-    </thead>
 
-    <tbody>
-    
 
-        <tr>
-            
-                <td class="name"><code>attributes</code></td>
-            
+	
 
-            <td class="type">
-            
-                
-<span class="param-type">Object</span>
+	
 
+	
 
+	
+</dl>
 
-            
-            </td>
 
-            
+    
+</dd>
 
+        
             
+<hr>
+<dt class="name" id="dateStatusChanged">
+    <h4 id="dateStatusChanged"><span class="type-signature">&lt;readonly&gt; </span>dateStatusChanged<span class="type-signature"> :Date</span></h4>
 
-            <td class="description last"><p>A JSON describing the Worker's attributes</p></td>
-        </tr>
+    
+</dt>
+<dd>
+    
 
     
-    </tbody>
-</table>
+        <h5>Type:</h5>
+        <ul>
+            <li>
+                
+<span class="param-type">Date</span>
+
 
+
+            </li>
+        </ul>
     
 
     
@@ -1430,27 +1375,1157 @@ TaskSid of the created Task.</li>
 
 
     
+</dd>
 
-    
+        
+            
+<hr>
+<dt class="name" id="dateUpdated">
+    <h4 id="dateUpdated"><span class="type-signature">&lt;readonly&gt; </span>dateUpdated<span class="type-signature"> :Date</span></h4>
 
     
+</dt>
+<dd>
+    
 
     
+        <h5>Type:</h5>
+        <ul>
+            <li>
+                
+<span class="param-type">Date</span>
+
+
 
+            </li>
+        </ul>
     
 
     
-    <h5>Returns:</h5>
+<dl class="details">
     
-            
-<div class="param-desc">
-    <ul>
-<li>Rejected if the attributes cannot be set</li>
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt class="name" id="friendlyName">
+    <h4 id="friendlyName"><span class="type-signature">&lt;readonly&gt; </span>friendlyName<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="name">
+    <h4 id="name"><span class="type-signature">&lt;readonly&gt; </span>name<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="reservations">
+    <h4 id="reservations"><span class="type-signature"></span>reservations<span class="type-signature"></span></h4>
+
+    
+</dt>
+<dd>
+    
+
+    
+
+    
+<dl class="details">
+    
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt class="name" id="sid">
+    <h4 id="sid"><span class="type-signature">&lt;readonly&gt; </span>sid<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="version">
+    <h4 id="version"><span class="type-signature"></span>version<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="workerActivitySid">
+    <h4 id="workerActivitySid"><span class="type-signature">&lt;readonly&gt; </span>workerActivitySid<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="workerSid">
+    <h4 id="workerSid"><span class="type-signature">&lt;readonly&gt; </span>workerSid<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">&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>
+
+        </dl>
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        <dl>
+            
+<hr>
+<dt>
+    <h4 class="name" id="_bumpVersion"><span class="type-signature"></span>_bumpVersion()</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        <p>bumps the worker version</p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+
+    
+<dl class="details">
+    
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="createTask"><span class="type-signature"></span>createTask(to, from, workflowSid, taskQueueSid [, options])</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        <p>Create a Task</p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+        <h5>Parameters:</h5>
+        
+
+<table class="params table table-striped">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+        <th>Argument</th>
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>to</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"><p>The contact uri of the customer. Stored in the <a href="Task.html">Task</a>'s attributes as "outbound_to"</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>from</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>. Stored in the <a href="Task.html">Task</a>'s attributes as "from"</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>workflowSid</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"><p>The Sid of the Workflow this Task should belong to</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>taskQueueSid</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"><p>The Sid of the <a href="TaskQueue.html">TaskQueue</a> this Task should belong to, used for reporting
+purposes only</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>options</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="global.html#WorkerTaskOptions">WorkerTaskOptions</a></span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional&gt;<br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+    
+
+    
+<dl class="details">
+    
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <h5>Returns:</h5>
+    
+            
+<div class="param-desc">
+    <ul>
+<li>Rejected if unable to create a Task on behalf of the <a href="Worker.html">Worker</a>. Returns the
+TaskSid of the created Task.</li>
 </ul>
 </div>
 
 
 
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;string&gt;</span>
+
+
+
+    </dd>
+</dl>
+
+
+        
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect()</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        <p>Gracefully disconnect the client.</p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+
+    
+<dl class="details">
+    
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <h5>Returns:</h5>
+    
+            
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">void</span>
+
+
+
+    </dd>
+</dl>
+
+
+        
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="fetchLatestVersion"><span class="type-signature"></span>fetchLatestVersion()</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        <p>Fetch the last version of this <a href="Worker.html">Worker</a></p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+
+    
+<dl class="details">
+    
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <h5>Returns:</h5>
+    
+            
+
+
 <dl>
     <dt>
         Type
@@ -1474,17 +2549,13 @@ TaskSid of the created Task.</li>
             
 <hr>
 <dt>
-    <h4 class="name" id="updateToken"><span class="type-signature"></span>updateToken(newToken)</h4>
+    <h4 class="name" id="getLogger"><span class="type-signature"></span>getLogger(prefix)</h4>
     
     
 </dt>
 <dd>
 
     
-    <div class="description">
-        <p>Update token</p>
-    </div>
-    
 
     
 
@@ -1517,7 +2588,7 @@ TaskSid of the created Task.</li>
 
         <tr>
             
-                <td class="name"><code>newToken</code></td>
+                <td class="name"><code>prefix</code></td>
             
 
             <td class="type">
@@ -1534,7 +2605,7 @@ TaskSid of the created Task.</li>
 
             
 
-            <td class="description last"><p>The new token that should be used for authentication</p></td>
+            <td class="description last"></td>
         </tr>
 
     
@@ -1597,12 +2668,6 @@ TaskSid of the created Task.</li>
     <h5>Returns:</h5>
     
             
-<div class="param-desc">
-    <ul>
-<li>Emits error if unable to update token</li>
-</ul>
-</div>
-
 
 
 <dl>
@@ -1611,7 +2676,7 @@ TaskSid of the created Task.</li>
     </dt>
     <dd>
         
-<span class="param-type">void</span>
+<span class="param-type">Logger</span>
 
 
 
@@ -1624,229 +2689,154 @@ TaskSid of the created Task.</li>
     
 </dd>
 
-        </dl>
-    
-
-    
-        <h3 class="subsection-title">Type Definitions</h3>
-
-        <dl>
-                
+        
+            
 <hr>
-<dt class="name" id=".Options">
-    <h4 id=".Options">Options</h4>
-
+<dt>
+    <h4 class="name" id="getRoutes"><span class="type-signature"></span>getRoutes()</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>
-            
+	
+</dl>
 
-            <td class="type">
-            
-                
-<span class="param-type">boolean</span>
 
+    
 
+    
 
-            
-            </td>
+    
 
-            
-                <td class="attributes">
-                
-                    &lt;optional&gt;<br>
-                
+    
 
-                
-                </td>
-            
+    
 
+    
+    <h5>Returns:</h5>
+    
             
-                <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>logLevel</code></td>
-            
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Routes</span>
 
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
 
 
+    </dd>
+</dl>
 
-            
-            </td>
 
-            
-                <td class="attributes">
-                
-                    &lt;optional&gt;<br>
-                
+        
 
-                
-                </td>
-            
+    
+</dd>
 
+        
             
-                <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>
+<hr>
+<dt>
+    <h4 class="name" id="setAttributes"><span class="type-signature"></span>setAttributes(attributes)</h4>
+    
+    
+</dt>
+<dd>
 
     
+    <div class="description">
+        <p>Update attributes</p>
+    </div>
+    
 
-        <tr>
-            
-                <td class="name"><code>region</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
+    
 
+    
 
+    
+    
+        <h5>Parameters:</h5>
+        
 
-            
-            </td>
+<table class="params table table-striped">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
 
-            
-                <td class="attributes">
-                
+        <th>Type</th>
 
-                
-                </td>
-            
+        
 
-            
-                <td class="default">
-                
-                </td>
-            
+        
 
-            <td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
-        </tr>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
 
+    <tbody>
     
 
         <tr>
             
-                <td class="name"><code>edge</code></td>
+                <td class="name"><code>attributes</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">string</span>
+<span class="param-type">Record.&lt;any, any&gt;</span>
 
 
 
@@ -1854,29 +2844,22 @@ should be terminated</li>
             </td>
 
             
-                <td class="attributes">
-                
-
-                
-                </td>
-            
 
             
-                <td class="default">
-                
-                </td>
-            
 
-            <td class="description last"><p>the ingress for connections (ex. "sydney")</p></td>
+            <td class="description last"><p>A JSON describing the Worker's attributes</p></td>
         </tr>
 
     
     </tbody>
 </table>
-</dl>
 
     
 
+    
+<dl class="details">
+    
+
 	
 
 	
@@ -1914,41 +2897,72 @@ should be terminated</li>
 
 
     
-</dd>
 
-            
-                
-<hr>
-<dt class="name" id=".TaskOptions">
-    <h4 id=".TaskOptions">TaskOptions</h4>
+    
 
     
-</dt>
-<dd>
+
     
 
     
-        <h5>Type:</h5>
-        <ul>
-            <li>
-                
-<span class="param-type">Object</span>
+
+    
+    <h5>Returns:</h5>
+    
+            
+<div class="param-desc">
+    <ul>
+<li>Rejected if the attributes cannot be set</li>
+</ul>
+</div>
 
 
 
-            </li>
-        </ul>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;this&gt;</span>
+
+
+
+    </dd>
+</dl>
+
+
+        
+
     
+</dd>
 
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="updateToken"><span class="type-signature"></span>updateToken(newToken)</h4>
     
-<dl class="details">
     
+</dt>
+<dd>
 
-    <h5 class="subsection-title">Properties:</h5>
+    
+    <div class="description">
+        <p>Update token</p>
+    </div>
+    
 
-    <dl>
+    
 
-<table class="props table table-striped">
+    
+
+    
+    
+        <h5>Parameters:</h5>
+        
+
+<table class="params table table-striped">
     <thead>
     <tr>
         
@@ -1958,12 +2972,8 @@ should be terminated</li>
         <th>Type</th>
 
         
-        <th>Argument</th>
-        
 
         
-        <th>Default</th>
-        
 
         <th class="last">Description</th>
     </tr>
@@ -1974,13 +2984,13 @@ should be terminated</li>
 
         <tr>
             
-                <td class="name"><code>attributes</code></td>
+                <td class="name"><code>newToken</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">object</span>
+<span class="param-type">string</span>
 
 
 
@@ -1988,118 +2998,57 @@ should be terminated</li>
             </td>
 
             
-                <td class="attributes">
-                
-                    &lt;optional&gt;<br>
-                
-
-                
-                </td>
-            
 
             
-                <td class="default">
-                
-                    null
-                
-                </td>
-            
 
-            <td class="description last"><p>Additional attributes for the <a href="Task.html">Task</a></p></td>
+            <td class="description last"><p>The new token that should be used for authentication</p></td>
         </tr>
 
     
+    </tbody>
+</table>
 
-        <tr>
-            
-                <td class="name"><code>taskChannelUniqueName</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-
-            
-            </td>
+    
 
-            
-                <td class="attributes">
-                
-                    &lt;optional&gt;<br>
-                
+    
+<dl class="details">
+    
 
-                
-                </td>
-            
+	
 
-            
-                <td class="default">
-                
-                    null
-                
-                </td>
-            
+	
 
-            <td class="description last"><p>The friendly name of the <a href="Channel.html">Channel</a> this <a href="Task.html">Task</a>
-belongs to. If not provided, defaults to 'default' channel.</p></td>
-        </tr>
+	
 
     
 
-        <tr>
-            
-                <td class="name"><code>taskChannelSid</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"><p>The Sid of the <a href="Channel.html">Channel</a> this <a href="Task.html">Task</a> belongs to. If not
-provided, defaults to 'default' channel.</p></td>
-        </tr>
 
-    
-    </tbody>
-</table>
-</dl>
 
-    
+	
 
 	
 
 	
 
 	
+</dl>
 
-    
 
     
 
@@ -2107,32 +3056,44 @@ provided, defaults to 'default' channel.</p></td>
 
     
 
-	
-
-	
-
-	
+    
 
-	
+    
 
-	
+    
+    <h5>Returns:</h5>
+    
+            
+<div class="param-desc">
+    <ul>
+<li>Emits error if unable to update token</li>
+</ul>
+</div>
 
 
 
-	
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">void</span>
 
-	
 
-	
 
-	
+    </dd>
 </dl>
 
 
+        
+
     
 </dd>
 
-            </dl>
+        </dl>
+    
+
     
 
     
@@ -3184,9 +4145,9 @@ provided, defaults to 'default' channel.</p></td>
 
 
 <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>