Added mute participant SDK method (Azure#30856)

Author: vivekmore-msft

sdk/communication/azure-communication-callautomation/CHANGELOG.md

@@ -16,4 +16,5 @@ Call Automation enables developers to build call workflows. Personalise customer
 - Download recordings.
 - Parse various events happening in the call, such as CallConnected and PlayCompleted event.
 - Start/Stop continuous DTMF recognition by subscribing/unsubscribing to tones.
-- Send DTMF tones to a participant in the call.
+- Send DTMF tones to a participant in the call.
+- Mute participants in the call.

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_call_connection_client.py

@@ -20,7 +20,8 @@
     CallConnectionProperties,
     AddParticipantResult,
     RemoveParticipantResult,
-    TransferCallResult
+    TransferCallResult,
+    MuteParticipantsResult,
 )
 from ._generated._client import AzureCommunicationCallAutomationService
 from ._generated.models import (
@@ -36,6 +37,7 @@
     SpeechOptions,
     PlayOptions,
     RecognizeOptions,
+    MuteParticipantsRequest,
 )
 from ._generated.models._enums import RecognizeInputType
 from ._shared.utils import (
@@ -568,3 +570,33 @@ def send_dtmf(
             self._call_connection_id,
             send_dtmf_request,
             **kwargs)
+
+    @distributed_trace
+    def mute_participants(
+        self,
+        target_participant: 'CommunicationIdentifier',
+        *,
+        operation_context: Optional[str] = None,
+        **kwargs
+    ) -> MuteParticipantsResult:
+        """Mute participants from the call using identifier.
+
+        :param target_participant: Participant to be muted from the call. Only ACS Users are supported. Required.
+        :type target_participant: ~azure.communication.callautomation.CommunicationIdentifier
+        :keyword operation_context: Used by customers when calling mid-call actions to correlate the request to the
+         response event.
+        :paramtype operation_context: str
+        :return: MuteParticipantsResult
+        :rtype: ~azure.communication.callautomation.MuteParticipantsResult
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        mute_participants_request = MuteParticipantsRequest(
+            target_participants=[serialize_identifier(target_participant)],
+            operation_context=operation_context)
+
+        response = self._call_connection_client.mute(
+            self._call_connection_id,
+            mute_participants_request,
+            **kwargs)
+
+        return MuteParticipantsResult._from_generated(response) # pylint:disable=protected-access

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_models.py

@@ -43,6 +43,7 @@
         RemoveParticipantResponse as RemoveParticipantResultRest,
         TransferCallResponse as TransferParticipantResultRest,
         RecordingStateResponse as RecordingStateResultRest,
+        MuteParticipantsResponse as MuteParticipantsResultRest,
     )
 
 class CallInvite(object):
@@ -571,3 +572,22 @@ def __init__(
 
     def _to_generated(self):
         return ChoiceInternal(label=self.label, phrases=self.phrases, tone=self.tone)
+
+class MuteParticipantsResult(object):
+    """The response payload for muting participants from the call.
+
+    :ivar operation_context: The operation context provided by client.
+    :vartype operation_context: str
+    """
+    def __init__(
+        self,
+        *,
+        operation_context: Optional[str] = None,
+        **kwargs
+    ) -> None:
+        super().__init__(**kwargs)
+        self.operation_context = operation_context
+
+    @classmethod
+    def _from_generated(cls, mute_participants_result_generated: 'MuteParticipantsResultRest'):
+        return cls(operation_context=mute_participants_result_generated.operation_context)

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/aio/_call_connection_client_async.py

@@ -21,7 +21,8 @@
     CallConnectionProperties,
     AddParticipantResult,
     RemoveParticipantResult,
-    TransferCallResult
+    TransferCallResult,
+    MuteParticipantsResult,
 )
 from .._generated.aio import AzureCommunicationCallAutomationService
 from .._generated.models import (
@@ -37,6 +38,7 @@
     SpeechOptions,
     PlayOptions,
     RecognizeOptions,
+    MuteParticipantsRequest,
 )
 from .._generated.models._enums import RecognizeInputType
 from .._shared.utils import (
@@ -573,6 +575,36 @@ async def send_dtmf(
             send_dtmf_request,
             **kwargs)
 
+    @distributed_trace_async
+    async def mute_participants(
+        self,
+        target_participant: 'CommunicationIdentifier',
+        *,
+        operation_context: Optional[str] = None,
+        **kwargs
+    ) -> MuteParticipantsResult:
+        """Mute participants from the call using identifier.
+
+        :param target_participant: Participant to be muted from the call. Only ACS Users are supported. Required.
+        :type target_participant: ~azure.communication.callautomation.CommunicationIdentifier
+        :keyword operation_context: Used by customers when calling mid-call actions to correlate the request to the
+         response event.
+        :paramtype operation_context: str
+        :return: MuteParticipantsResult
+        :rtype: ~azure.communication.callautomation.MuteParticipantsResult
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        mute_participants_request = MuteParticipantsRequest(
+            target_participants=[serialize_identifier(target_participant)],
+            operation_context=operation_context)
+
+        response =  await self._call_connection_client.mute(
+            self._call_connection_id,
+            mute_participants_request,
+            **kwargs)
+
+        return MuteParticipantsResult._from_generated(response) # pylint:disable=protected-access
+
     async def __aenter__(self) -> "CallConnectionClient":
         await self._client.__aenter__()
         return self

sdk/communication/azure-communication-callautomation/tests/test_call_connection_client.py

@@ -173,4 +173,26 @@ def mock_send(*_, **__):
             raise
 
         self.assertFalse(raised, 'Expected is no exception raised')
-        self.assertEqual(self.operation_context, response.operation_context)
+        self.assertEqual(self.operation_context, response.operation_context)
+
+    def test_mute_participants(self):
+        raised = False
+
+        def mock_send(*_, **__):
+            return mock_response(status_code=202, json_payload={
+                "operationContext": self.operation_context})
+
+        call_connection = CallConnectionClient(
+            endpoint="https://endpoint",
+            credential=AzureKeyCredential("fakeCredential=="),
+            call_connection_id=self.call_connection_id,
+            transport=Mock(send=mock_send))
+        user = CommunicationUserIdentifier(self.communication_user_id)
+        try:
+            response = call_connection.mute_participants(user)
+        except:
+            raised = True
+            raise
+
+        self.assertFalse(raised, 'Expected is no exception raised')
+        self.assertEqual(self.operation_context, response.operation_context)