@webex/plugin-meetings 3.0.0-beta.28 → 3.0.0-beta.280

package/src/members/request.ts

@@ -5,12 +5,26 @@ import {MEETINGS} from '../constants';
 import ParameterError from '../common/errors/parameter';
 
 import MembersUtil from './util';
+import MeetingUtil from '../meeting/util';
 
 /**
  * @class MembersRequest
  */
 export default class MembersRequest extends StatelessWebexPlugin {
   namespace = MEETINGS;
+  locusDeltaRequest: (options: object) => Promise<any>;
+
+  /**
+   * Constructor
+   * @param {Object} attrs
+   * @param {Object} options
+   */
+  constructor(attrs: {meeting: any}, options: object) {
+    const {meeting, ...otherAttrs} = attrs;
+    super(otherAttrs, options);
+
+    this.locusDeltaRequest = MeetingUtil.generateLocusDeltaRequest(meeting);
+  }
 
   /**
    *
@@ -36,8 +50,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
     }
     const requestParams = MembersUtil.getAddMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
   /**
@@ -55,10 +68,16 @@ export default class MembersRequest extends StatelessWebexPlugin {
     }
     const requestParams = MembersUtil.getAdmitMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to remove a member
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @returns {Promise}
+   */
   removeMember(options) {
     if (!options || !options.locusUrl || !options.memberId) {
       throw new ParameterError(
@@ -68,10 +87,16 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getRemoveMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to mute a member
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @returns {Promise}
+   */
   muteMember(options) {
     if (!options || !options.locusUrl || !options.memberId) {
       throw new ParameterError(
@@ -82,9 +107,35 @@ export default class MembersRequest extends StatelessWebexPlugin {
     const requestParams = MembersUtil.getMuteMemberRequestParams(options);
 
     // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
+  }
+
+  /**
+   * Sends a request to the DTMF endpoint to send tones
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of PSTN user
+   * @returns {Promise}
+   */
+  assignRolesMember(options: any) {
+    if (!options || !options.locusUrl || !options.memberId) {
+      throw new ParameterError(
+        'memberId must be defined, and the associated locus url for this meeting object must be defined.'
+      );
+    }
+
+    const requestParams = MembersUtil.getRoleAssignmentMemberRequestParams(options);
+
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to raise or lower a member's hand
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @returns {Promise}
+   */
   raiseOrLowerHandMember(options) {
     if (!options || !options.locusUrl || !options.memberId) {
       throw new ParameterError(
@@ -94,10 +145,16 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getRaiseHandMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to lower all hands
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.requestingParticipantId ID of requesting participant
+   * @returns {Promise}
+   */
   lowerAllHandsMember(options) {
     if (!options || !options.locusUrl || !options.requestingParticipantId) {
       throw new ParameterError(
@@ -107,10 +164,36 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getLowerAllHandsMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
+  }
+
+  /**
+   *
+   * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
+   * @returns {Promise}
+   * @throws {Error} if the options are not valid and complete, must have requestingParticipantId AND locusUrl
+   * @memberof MembersRequest
+   */
+  editDisplayNameMember(options: {locusUrl: string; requestingParticipantId: string}) {
+    if (!options || !options.locusUrl || !options.requestingParticipantId) {
+      throw new ParameterError(
+        'requestingParticipantId must be defined, and the associated locus url for this meeting object must be defined.'
+      );
+    }
+
+    const requestParams = MembersUtil.editDisplayNameMemberRequestParams(options);
+
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to raise or lower a member's hand
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @param {String} options.moderator ID of moderator
+   * @returns {Promise}
+   */
   transferHostToMember(options) {
     if (!options || !options.locusUrl || !options.memberId || !options.moderator) {
       throw new ParameterError(
@@ -120,8 +203,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getTransferHostToMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
   /**
@@ -150,8 +232,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.generateSendDTMFRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
   /**
@@ -169,7 +250,6 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.generateCancelInviteRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 }

package/src/members/types.ts

@@ -0,0 +1,28 @@
+export enum ServerRoles {
+  Cohost = 'COHOST',
+  Moderator = 'MODERATOR',
+  Presenter = 'PRESENTER',
+}
+
+export type ServerRoleShape = {
+  type: ServerRoles;
+  hasRole: boolean;
+};
+
+export type RoleAssignmentOptions = {
+  roles: Array<ServerRoleShape>;
+  locusUrl: string;
+  memberId: string;
+};
+
+export type RoleAssignmentBody = {
+  role: {
+    roles: Array<ServerRoleShape>;
+  };
+};
+
+export type RoleAssignmentRequest = {
+  method: string;
+  uri: string;
+  body: RoleAssignmentBody;
+};