Add WorkerSid as accepted param for getTaskQueues

twilio · Nov 21, 2023 · ba884fb · ba884fb
1 parent 701ac61
commit ba884fb
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/lib/Workspace.js b/lib/Workspace.js
@@ -173,4 +173,5 @@ export default Workspace;
  * @property {string} [AfterSid]
  * @property {string} [FriendlyName]
  * @property {"DateUpdated:asc" | "DateUpdated:desc"} [Ordering]
+ * @property {string} [WorkerSid]
  */
diff --git a/lib/data/WorkspaceEntity.js b/lib/data/WorkspaceEntity.js
@@ -244,7 +244,7 @@ export default class WorkspaceEntity {
             PageSize: this._pageSize
         };
 
-        const keys = ['AfterSid', 'FriendlyName', 'Ordering', 'NextToken'];
+        const keys = ['AfterSid', 'FriendlyName', 'Ordering', 'NextToken', 'WorkerSid'];
         keys.forEach(key => {
             if (args[key]) {
                 requestParam[key] = args[key];

diff --git a/test/integration/spec/Workspace.js b/test/integration/spec/Workspace.js
@@ -31,10 +31,10 @@ describe('Workspace', () => {
     describe('#fetchTaskQueues', () => {
         let taskQueueSids = [];
 
-        const createTaskQueues = async(friendlyNames = []) => {
+        const createTaskQueues = async(friendlyNames = [], targetWorkers = '1==1') => {
             const taskQueueSids = [];
             for (const name of friendlyNames) {
-                const queue = await envTwilio.createTaskQueue(workspace.workspaceSid, { friendlyName: name });
+                const queue = await envTwilio.createTaskQueue(workspace.workspaceSid, { friendlyName: name, targetWorkers });
                 taskQueueSids.push(queue.sid);
             }
 
@@ -117,6 +117,28 @@ describe('Workspace', () => {
             }
         }).timeout(5000);
 
+        describe('WorkerSid filter', () => {
+            before(async() => {
+                await createTaskQueues(['notBob'], 'missingAttribute = "foo"');
+            });
+
+            it('should not filter by default', async() => {
+                const queuesMap = await workspace.fetchTaskQueues();
+                assert.equal(queuesMap.size, 4);
+            }).timeout(5000);
+
+            it('should filter by selected WorkerSid', async() => {
+                let workerSid = credentials.multiTaskBobSid;
+
+                const queuesMap = await workspace.fetchTaskQueues({ WorkerSid: workerSid });
+                assert.equal(queuesMap.size, 3);
+            }).timeout(5000);
+
+            after(async() => {
+                await deleteTaskQueues(['notBob']);
+            });
+        });
+
         it('should paginate with ordering param', async() => {
             workspace = new Workspace(adminToken, { ...options, pageSize: 1 });
             const queuesMap = await workspace.fetchTaskQueues({ Ordering: 'DateUpdated:asc' });

diff --git a/types.d.ts b/types.d.ts
@@ -187,6 +187,7 @@ type FetchTaskQueuesParams = {
     AfterSid?: string;
     FriendlyName?: string;
     Ordering?: "DateUpdated:asc" | "DateUpdated:desc"
+    WorkerSid?: string;
 }
 
 type FetchWorkersParams = {