@webex/plugin-meetings 2.60.0-next.9 → 2.60.1

package/dist/members/util.d.ts

@@ -1,215 +1,2 @@
-import { RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape } from './types';
-declare const MembersUtil: {
-    /**
-     * @param {Object} invitee with emailAddress, email or phoneNumber
-     * @param {String} locusUrl
-     * @param {Boolean} alertIfActive
-     * @returns {Object} the format object
-     */
-    generateAddMemberOptions: (invitee: object, locusUrl: string, alertIfActive: boolean) => {
-        invitee: object;
-        locusUrl: string;
-        alertIfActive: boolean;
-    };
-    /**
-     * @param {Array} memberIds
-     * @param {String} locusUrl
-     * @returns {Object} the format object
-     */
-    generateAdmitMemberOptions: (memberIds: Array<any>, locusUrl: string) => {
-        locusUrl: string;
-        memberIds: any[];
-    };
-    /**
-     * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
-     * @returns {Object} with {invitees: [{address}], alertIfActive}
-     */
-    getAddMemberBody: (options: any) => {
-        invitees: {
-            address: any;
-        }[];
-        alertIfActive: any;
-    };
-    /**
-     * @param {Object} options with {memberIds, authorizingLocusUrl}
-     * @returns {Object} admit with {memberIds}
-     */
-    getAdmitMemberRequestBody: (options: any) => any;
-    /**
-     * @param {Object} format with {memberIds, locusUrl, sessionLocusUrls}
-     * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
-     * if a host/cohost is in a breakout session, the locus url should be the main session locus url
-     */
-    getAdmitMemberRequestParams: (format: any) => {
-        method: string;
-        uri: string;
-        body: any;
-    };
-    /**
-     * @param {Object} format with {invitee {emailAddress, email, phoneNumber}, locusUrl, alertIfActive}
-     * @returns {Object} the request parameters (method, uri, body) needed to make a addMember request
-     */
-    getAddMemberRequestParams: (format: any) => {
-        method: string;
-        uri: any;
-        body: {
-            invitees: {
-                address: any;
-            }[];
-            alertIfActive: any;
-        };
-    };
-    isInvalidInvitee: (invitee: any) => boolean;
-    getRemoveMemberRequestParams: (options: any) => {
-        method: string;
-        uri: string;
-        body: {
-            reason: any;
-        };
-    };
-    generateTransferHostMemberOptions: (transfer: any, moderator: any, locusUrl: any) => {
-        moderator: any;
-        locusUrl: any;
-        memberId: any;
-    };
-    generateRemoveMemberOptions: (removal: any, locusUrl: any) => {
-        reason: string;
-        memberId: any;
-        locusUrl: any;
-    };
-    generateMuteMemberOptions: (memberId: any, status: any, locusUrl: any, isAudio: any) => {
-        memberId: any;
-        muted: any;
-        locusUrl: any;
-        isAudio: any;
-    };
-    generateRaiseHandMemberOptions: (memberId: any, status: any, locusUrl: any) => {
-        memberId: any;
-        raised: any;
-        locusUrl: any;
-    };
-    /**
-     * @param {String} memberId
-     * @param {[ServerRoleShape]} roles
-     * @param {String} locusUrl
-     * @returns {RoleAssignmentOptions}
-     */
-    generateRoleAssignmentMemberOptions: (memberId: string, roles: Array<ServerRoleShape>, locusUrl: string) => RoleAssignmentOptions;
-    generateLowerAllHandsMemberOptions: (requestingParticipantId: any, locusUrl: any) => {
-        requestingParticipantId: any;
-        locusUrl: any;
-    };
-    /**
-     * @param {String} memberId id of the participant who is receiving request
-     * @param {String} requestingParticipantId id of the participant who is sending request (optional)
-     * @param {String} alias alias name
-     * @param {String} locusUrl url
-     * @returns {Object} consists of {memberID: string, requestingParticipantId: string, alias: string, locusUrl: string}
-     */
-    generateEditDisplayNameMemberOptions: (memberId: any, requestingParticipantId: any, alias: any, locusUrl: any) => {
-        memberId: any;
-        requestingParticipantId: any;
-        alias: any;
-        locusUrl: any;
-    };
-    getMuteMemberRequestParams: (options: any) => {
-        method: string;
-        uri: string;
-        body: {
-            [x: string]: {
-                muted: any;
-            };
-        };
-    };
-    /**
-     * @param {ServerRoleShape} role
-     * @returns {ServerRoleShape} the role shape to be added to the body
-     */
-    getAddedRoleShape: (role: ServerRoleShape) => ServerRoleShape;
-    /**
-     * @param {RoleAssignmentOptions} options
-     * @returns {RoleAssignmentRequest} the request parameters (method, uri, body) needed to make a addMember request
-     */
-    getRoleAssignmentMemberRequestParams: (options: RoleAssignmentOptions) => RoleAssignmentRequest;
-    getRaiseHandMemberRequestParams: (options: any) => {
-        method: string;
-        uri: string;
-        body: {
-            hand: {
-                raised: any;
-            };
-        };
-    };
-    getLowerAllHandsMemberRequestParams: (options: any) => {
-        method: string;
-        uri: string;
-        body: {
-            hand: {
-                raised: boolean;
-            };
-            requestingParticipantId: any;
-        };
-    };
-    /**
-     * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
-     * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
-     */
-    editDisplayNameMemberRequestParams: (options: any) => {
-        method: string;
-        uri: string;
-        body: {
-            aliasValue: any;
-            requestingParticipantId: any;
-        };
-    };
-    getTransferHostToMemberRequestParams: (options: any) => {
-        method: string;
-        uri: string;
-        body: {
-            role: {
-                moderator: any;
-            };
-        };
-    };
-    genderateSendDTMFOptions: (url: any, tones: any, memberId: any, locusUrl: any) => {
-        url: any;
-        tones: any;
-        memberId: any;
-        locusUrl: any;
-    };
-    generateSendDTMFRequestParams: ({ url, tones, memberId, locusUrl }: {
-        url: any;
-        tones: any;
-        memberId: any;
-        locusUrl: any;
-    }) => {
-        method: string;
-        uri: string;
-        body: {
-            device: {
-                url: any;
-            };
-            memberId: any;
-            dtmf: {
-                correlationId: string;
-                tones: any;
-                direction: string;
-            };
-        };
-    };
-    cancelPhoneInviteOptions: (invitee: any, locusUrl: any) => {
-        invitee: any;
-        locusUrl: any;
-    };
-    generateCancelInviteRequestParams: (options: any) => {
-        method: string;
-        uri: any;
-        body: {
-            actionType: string;
-            invitees: {
-                address: any;
-            }[];
-        };
-    };
-};
+declare const MembersUtil: any;
 export default MembersUtil;