FRIDGE-516 Update TaskHoldOptions (#392)

Author: andreasonny83

lib/Task.js

@@ -365,7 +365,7 @@ class Task extends EventEmitter {
      * Hold the worker's call leg in the Conference associated to this {@link Task} and specified TargetWorkerSid
      * @param {String } targetWorkerSid - The target worker's sid which should be put onhold or unhold
      * @param {boolean} onHold - Whether to hold or unhold the specified worker's call leg in the Conference referenced by the {@link Task}
-     * @param {HoldOptions} options
+     * @param {TaskHoldOptions} options
      * @returns {Promise<this>}
      */
     hold(targetWorkerSid, onHold, options) {
@@ -605,7 +605,7 @@ export default Task;
  */
 
 /**
- * @typedef {Object} HoldOptions
- * @property {string} holdUrl - The URL endpoint to play when participant is on hold.
- * @property {'GET'} holdMethod - The HTTP method for the hold URL.
+ * @typedef {Object} TaskHoldOptions
+ * @property {string} [holdUrl] - The URL endpoint to play when participant is on hold.
+ * @property {'GET'} [holdMethod] - The HTTP method for the hold URL.
  */

test/unit/spec/Task.js

@@ -463,6 +463,13 @@ describe('Task', () => {
             sandbox.restore();
         });
 
+        it('should use default holdMethod and holdUrl props when not provided', () => {
+            (() => {
+                const task = new Task(worker, new Request(config), reservationSid, assignedTaskDescriptor);
+                task.updateParticipant();
+            }).should.not.throw();
+        });
+
         it('should return an error if the optional params fail type check', () => {
             (() => {
                 const task = new Task(worker, new Request(config), reservationSid, assignedTaskDescriptor);

types.d.ts

@@ -304,12 +304,7 @@ export interface TransferOptions {
     priority?: number;
 }
 
-export interface HoldOptions {
-    holdUrl: string;
-    holdMethod: "GET"
-}
-
-export interface TaskParticipantOptions extends HoldOptions {
+export interface TaskParticipantOptions extends TaskHoldOptions {
     hold: boolean;
 }