Richardcho/correlationid answeredby (Azure#30314)

* update swagger

* update swagger

* update client

* updated

* fix linting

* add pylint ignore

* fix linting

---------

Co-authored-by: juntuchen <[email protected]>

Author: richardcho-msft

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

@@ -31,7 +31,8 @@
     get_repeatability_guid,
     get_repeatability_timestamp,
     serialize_phone_identifier,
-    serialize_identifier
+    serialize_identifier,
+    serialize_communication_user_identifier
 )
 if TYPE_CHECKING:
     from ._models  import (
@@ -125,6 +126,7 @@ def from_connection_string(
 
         return cls(endpoint, access_key, **kwargs)
 
+    @distributed_trace
     def get_call_connection(
         self,
         call_connection_id: str,
@@ -184,7 +186,7 @@ def create_call(
             source_caller_id_number=serialize_phone_identifier(
                 target_participant.source_caller_id_number) if target_participant.source_caller_id_number else None,
             source_display_name=target_participant.source_display_name,
-            source_identity=serialize_identifier(
+            source_identity=serialize_communication_user_identifier(
                 self.source_identity) if self.source_identity else None,
             operation_context=operation_context,
             media_streaming_configuration=media_streaming_configuration.to_generated(
@@ -281,6 +283,7 @@ def answer_call(
         *,
         media_streaming_configuration: Optional['MediaStreamingConfiguration'] = None,
         azure_cognitive_services_endpoint_url: Optional[str] = None,
+        operation_context: Optional[str] = None,
         **kwargs
     ) -> CallConnectionProperties:
         """Answer incoming call with Azure Communication Service's IncomingCall event
@@ -295,7 +298,9 @@ def answer_call(
         :paramtype media_streaming_configuration: ~azure.communication.callautomation.MediaStreamingConfiguration
         :keyword azure_cognitive_services_endpoint_url:
          The endpoint url of the Azure Cognitive Services resource attached.
-         :paramtype azure_cognitive_services_endpoint_url: str
+        :paramtype azure_cognitive_services_endpoint_url: str
+        :keyword operation_context: The operation context.
+        :paramtype operation_context: str
         :return: CallConnectionProperties
         :rtype: ~azure.communication.callautomation.CallConnectionProperties
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -306,8 +311,9 @@ def answer_call(
             media_streaming_configuration=media_streaming_configuration.to_generated(
             ) if media_streaming_configuration else None,
             azure_cognitive_services_endpoint_url=azure_cognitive_services_endpoint_url,
-            answered_by_identifier=serialize_identifier(
-                self.source_identity) if self.source_identity else None
+            answered_by_identifier=serialize_communication_user_identifier(
+                self.source_identity) if self.source_identity else None,
+            operation_context=operation_context
         )
 
         result = self._client.answer_call(

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

@@ -132,6 +132,7 @@ def _from_callautomation_client(
         """Internal constructor for sharing the pipeline with CallAutomationClient."""
         return cls(None, None, call_connection_id, _callautomation_client=callautomation_client)
 
+    @distributed_trace
     def get_call_properties(self, **kwargs) -> CallConnectionProperties:
         """Get the latest properties of this call.
 

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_generated/models/__init__.py

@@ -19,6 +19,7 @@
 from ._models import CallParticipant
 from ._models import CallTransferAccepted
 from ._models import CallTransferFailed
+from ._models import ChannelAffinity
 from ._models import Choice
 from ._models import ChoiceResult
 from ._models import CollectTonesResult
@@ -113,6 +114,7 @@
     "CallParticipant",
     "CallTransferAccepted",
     "CallTransferFailed",
+    "ChannelAffinity",
     "Choice",
     "ChoiceResult",
     "CollectTonesResult",

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

@@ -276,15 +276,18 @@ class AnswerCallRequest(_serialization.Model):
     :vartype incoming_call_context: str
     :ivar callback_uri: The callback uri. Required.
     :vartype callback_uri: str
+    :ivar operation_context: A customer set value used to track the answering of a call.
+    :vartype operation_context: str
     :ivar media_streaming_configuration: Media Streaming Configuration.
     :vartype media_streaming_configuration:
      ~azure.communication.callautomation.models.MediaStreamingConfiguration
     :ivar azure_cognitive_services_endpoint_url: The endpoint URL of the Azure Cognitive Services
      resource attached.
     :vartype azure_cognitive_services_endpoint_url: str
-    :ivar answered_by_identifier: The identifier of the contoso app which answers the call.
+    :ivar answered_by_identifier: The identifier of the call automation entity which answers the
+     call.
     :vartype answered_by_identifier:
-     ~azure.communication.callautomation.models.CommunicationIdentifierModel
+     ~azure.communication.callautomation.models.CommunicationUserIdentifierModel
     """
 
     _validation = {
@@ -295,39 +298,45 @@ class AnswerCallRequest(_serialization.Model):
     _attribute_map = {
         "incoming_call_context": {"key": "incomingCallContext", "type": "str"},
         "callback_uri": {"key": "callbackUri", "type": "str"},
+        "operation_context": {"key": "operationContext", "type": "str"},
         "media_streaming_configuration": {"key": "mediaStreamingConfiguration", "type": "MediaStreamingConfiguration"},
         "azure_cognitive_services_endpoint_url": {"key": "azureCognitiveServicesEndpointUrl", "type": "str"},
-        "answered_by_identifier": {"key": "answeredByIdentifier", "type": "CommunicationIdentifierModel"},
+        "answered_by_identifier": {"key": "answeredByIdentifier", "type": "CommunicationUserIdentifierModel"},
     }
 
     def __init__(
         self,
         *,
         incoming_call_context: str,
         callback_uri: str,
+        operation_context: Optional[str] = None,
         media_streaming_configuration: Optional["_models.MediaStreamingConfiguration"] = None,
         azure_cognitive_services_endpoint_url: Optional[str] = None,
-        answered_by_identifier: Optional["_models.CommunicationIdentifierModel"] = None,
+        answered_by_identifier: Optional["_models.CommunicationUserIdentifierModel"] = None,
         **kwargs: Any
     ) -> None:
         """
         :keyword incoming_call_context: The context associated with the call. Required.
         :paramtype incoming_call_context: str
         :keyword callback_uri: The callback uri. Required.
         :paramtype callback_uri: str
+        :keyword operation_context: A customer set value used to track the answering of a call.
+        :paramtype operation_context: str
         :keyword media_streaming_configuration: Media Streaming Configuration.
         :paramtype media_streaming_configuration:
          ~azure.communication.callautomation.models.MediaStreamingConfiguration
         :keyword azure_cognitive_services_endpoint_url: The endpoint URL of the Azure Cognitive
          Services resource attached.
         :paramtype azure_cognitive_services_endpoint_url: str
-        :keyword answered_by_identifier: The identifier of the contoso app which answers the call.
+        :keyword answered_by_identifier: The identifier of the call automation entity which answers the
+         call.
         :paramtype answered_by_identifier:
-         ~azure.communication.callautomation.models.CommunicationIdentifierModel
+         ~azure.communication.callautomation.models.CommunicationUserIdentifierModel
         """
         super().__init__(**kwargs)
         self.incoming_call_context = incoming_call_context
         self.callback_uri = callback_uri
+        self.operation_context = operation_context
         self.media_streaming_configuration = media_streaming_configuration
         self.azure_cognitive_services_endpoint_url = azure_cognitive_services_endpoint_url
         self.answered_by_identifier = answered_by_identifier
@@ -409,7 +418,7 @@ def __init__(
         self.operation_context = operation_context
 
 
-class CallConnectionProperties(_serialization.Model):
+class CallConnectionProperties(_serialization.Model):  # pylint: disable=too-many-instance-attributes
     """Properties of a call connection.
 
     :ivar call_connection_id: The call connection id.
@@ -437,6 +446,12 @@ class CallConnectionProperties(_serialization.Model):
     :ivar source_identity: Source identity.
     :vartype source_identity:
      ~azure.communication.callautomation.models.CommunicationIdentifierModel
+    :ivar correlation_id: The correlation ID.
+    :vartype correlation_id: str
+    :ivar answered_by_identifier: Identity of the answering entity. Only populated when identity is
+     provided in the request.
+    :vartype answered_by_identifier:
+     ~azure.communication.callautomation.models.CommunicationUserIdentifierModel
     """
 
     _attribute_map = {
@@ -449,6 +464,8 @@ class CallConnectionProperties(_serialization.Model):
         "source_caller_id_number": {"key": "sourceCallerIdNumber", "type": "PhoneNumberIdentifierModel"},
         "source_display_name": {"key": "sourceDisplayName", "type": "str"},
         "source_identity": {"key": "sourceIdentity", "type": "CommunicationIdentifierModel"},
+        "correlation_id": {"key": "correlationId", "type": "str"},
+        "answered_by_identifier": {"key": "answeredByIdentifier", "type": "CommunicationUserIdentifierModel"},
     }
 
     def __init__(
@@ -463,6 +480,8 @@ def __init__(
         source_caller_id_number: Optional["_models.PhoneNumberIdentifierModel"] = None,
         source_display_name: Optional[str] = None,
         source_identity: Optional["_models.CommunicationIdentifierModel"] = None,
+        correlation_id: Optional[str] = None,
+        answered_by_identifier: Optional["_models.CommunicationUserIdentifierModel"] = None,
         **kwargs: Any
     ) -> None:
         """
@@ -492,6 +511,12 @@ def __init__(
         :keyword source_identity: Source identity.
         :paramtype source_identity:
          ~azure.communication.callautomation.models.CommunicationIdentifierModel
+        :keyword correlation_id: The correlation ID.
+        :paramtype correlation_id: str
+        :keyword answered_by_identifier: Identity of the answering entity. Only populated when identity
+         is provided in the request.
+        :paramtype answered_by_identifier:
+         ~azure.communication.callautomation.models.CommunicationUserIdentifierModel
         """
         super().__init__(**kwargs)
         self.call_connection_id = call_connection_id
@@ -503,6 +528,8 @@ def __init__(
         self.source_caller_id_number = source_caller_id_number
         self.source_display_name = source_display_name
         self.source_identity = source_identity
+        self.correlation_id = correlation_id
+        self.answered_by_identifier = answered_by_identifier
 
 
 class CallDisconnected(_serialization.Model):
@@ -746,6 +773,46 @@ def __init__(
         self.result_information = result_information
 
 
+class ChannelAffinity(_serialization.Model):
+    """Channel affinity for a participant.
+
+    All required parameters must be populated in order to send to Azure.
+
+    :ivar channel: Channel number to which bitstream from a particular participant will be written.
+    :vartype channel: int
+    :ivar participant: The identifier for the participant whose bitstream will be written to the
+     channel
+     represented by the channel number. Required.
+    :vartype participant: ~azure.communication.callautomation.models.CommunicationIdentifierModel
+    """
+
+    _validation = {
+        "channel": {"maximum": 4, "minimum": 0},
+        "participant": {"required": True},
+    }
+
+    _attribute_map = {
+        "channel": {"key": "channel", "type": "int"},
+        "participant": {"key": "participant", "type": "CommunicationIdentifierModel"},
+    }
+
+    def __init__(
+        self, *, participant: "_models.CommunicationIdentifierModel", channel: Optional[int] = None, **kwargs: Any
+    ) -> None:
+        """
+        :keyword channel: Channel number to which bitstream from a particular participant will be
+         written.
+        :paramtype channel: int
+        :keyword participant: The identifier for the participant whose bitstream will be written to the
+         channel
+         represented by the channel number. Required.
+        :paramtype participant: ~azure.communication.callautomation.models.CommunicationIdentifierModel
+        """
+        super().__init__(**kwargs)
+        self.channel = channel
+        self.participant = participant
+
+
 class Choice(_serialization.Model):
     """Choice.
 
@@ -1232,7 +1299,7 @@ class CreateCallRequest(_serialization.Model):
     :vartype source_display_name: str
     :ivar source_identity: The identifier of the source of the call.
     :vartype source_identity:
-     ~azure.communication.callautomation.models.CommunicationIdentifierModel
+     ~azure.communication.callautomation.models.CommunicationUserIdentifierModel
     :ivar operation_context: A customer set value used to track the answering of a call.
     :vartype operation_context: str
     :ivar callback_uri: The callback URI. Required.
@@ -1256,7 +1323,7 @@ class CreateCallRequest(_serialization.Model):
         "targets": {"key": "targets", "type": "[CommunicationIdentifierModel]"},
         "source_caller_id_number": {"key": "sourceCallerIdNumber", "type": "PhoneNumberIdentifierModel"},
         "source_display_name": {"key": "sourceDisplayName", "type": "str"},
-        "source_identity": {"key": "sourceIdentity", "type": "CommunicationIdentifierModel"},
+        "source_identity": {"key": "sourceIdentity", "type": "CommunicationUserIdentifierModel"},
         "operation_context": {"key": "operationContext", "type": "str"},
         "callback_uri": {"key": "callbackUri", "type": "str"},
         "media_streaming_configuration": {"key": "mediaStreamingConfiguration", "type": "MediaStreamingConfiguration"},
@@ -1271,7 +1338,7 @@ def __init__(
         callback_uri: str,
         source_caller_id_number: Optional["_models.PhoneNumberIdentifierModel"] = None,
         source_display_name: Optional[str] = None,
-        source_identity: Optional["_models.CommunicationIdentifierModel"] = None,
+        source_identity: Optional["_models.CommunicationUserIdentifierModel"] = None,
         operation_context: Optional[str] = None,
         media_streaming_configuration: Optional["_models.MediaStreamingConfiguration"] = None,
         azure_cognitive_services_endpoint_url: Optional[str] = None,
@@ -1291,7 +1358,7 @@ def __init__(
         :paramtype source_display_name: str
         :keyword source_identity: The identifier of the source of the call.
         :paramtype source_identity:
-         ~azure.communication.callautomation.models.CommunicationIdentifierModel
+         ~azure.communication.callautomation.models.CommunicationUserIdentifierModel
         :keyword operation_context: A customer set value used to track the answering of a call.
         :paramtype operation_context: str
         :keyword callback_uri: The callback URI. Required.
@@ -3117,6 +3184,12 @@ class StartCallRecordingRequest(_serialization.Model):
      of the recording.
     :vartype audio_channel_participant_ordering:
      list[~azure.communication.callautomation.models.CommunicationIdentifierModel]
+    :ivar channel_affinity: The channel affinity of call recording
+     When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified,
+     'channel' will be automatically assigned.
+     Channel-Participant mapping details can be found in the metadata of the recording.
+     ///.
+    :vartype channel_affinity: list[~azure.communication.callautomation.models.ChannelAffinity]
     :ivar external_storage: Optional property to specify location where recording will be stored.
     :vartype external_storage: ~azure.communication.callautomation.models.ExternalStorage
     """
@@ -3135,6 +3208,7 @@ class StartCallRecordingRequest(_serialization.Model):
             "key": "audioChannelParticipantOrdering",
             "type": "[CommunicationIdentifierModel]",
         },
+        "channel_affinity": {"key": "channelAffinity", "type": "[ChannelAffinity]"},
         "external_storage": {"key": "externalStorage", "type": "ExternalStorage"},
     }
 
@@ -3147,6 +3221,7 @@ def __init__(
         recording_channel_type: Optional[Union[str, "_models.RecordingChannel"]] = None,
         recording_format_type: Optional[Union[str, "_models.RecordingFormat"]] = None,
         audio_channel_participant_ordering: Optional[List["_models.CommunicationIdentifierModel"]] = None,
+        channel_affinity: Optional[List["_models.ChannelAffinity"]] = None,
         external_storage: Optional["_models.ExternalStorage"] = None,
         **kwargs: Any
     ) -> None:
@@ -3177,6 +3252,12 @@ def __init__(
          of the recording.
         :paramtype audio_channel_participant_ordering:
          list[~azure.communication.callautomation.models.CommunicationIdentifierModel]
+        :keyword channel_affinity: The channel affinity of call recording
+         When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified,
+         'channel' will be automatically assigned.
+         Channel-Participant mapping details can be found in the metadata of the recording.
+         ///.
+        :paramtype channel_affinity: list[~azure.communication.callautomation.models.ChannelAffinity]
         :keyword external_storage: Optional property to specify location where recording will be
          stored.
         :paramtype external_storage: ~azure.communication.callautomation.models.ExternalStorage
@@ -3188,6 +3269,7 @@ def __init__(
         self.recording_channel_type = recording_channel_type
         self.recording_format_type = recording_format_type
         self.audio_channel_participant_ordering = audio_channel_participant_ordering
+        self.channel_affinity = channel_affinity
         self.external_storage = external_storage