Add Cloud environment for Teams user (#16359)

* Add cloud environment enum

* Add cloud environemnt to CommunicationIdentifierModel

* Rename CommunicationCloudEnvironment

* Add cloud environemtn to serialize/deserialzie

* Rearrange microsoft teams user class position

* Rename the kwarg name

* Add cloud env into tests

* Fix typos in identifier kind enums

* Add cloud to serialize/deserialize tests for teams user

* remove unused import

* Add identifier to the identifier to the microsoft teams user model

* Add idenitifier to the phone number

* Add ids to the tests

* Make id mandatory for deserilize

* Fix lint error

* Add identifier to the doc string

* Throw when identifier type is not supported

* Fix typo in test name

* Add test_serialize_foreign_throws

* Add test for unknown kind

* Fix docstring for serialize method

* Fix the typo in anonymous

* Fix phone number doc string

* Sync model to admin and chat

* Fix the docstring for CommunicationIdentifierModel

* Remove dev-tools

* add mgmt core to setup py for mgmt package

* Update the core dependency in mgmt package.

* Sync models to admin, sms, identity

* Change the exception message

* Add idnetifier check in the test

* sync model to other packages

* Remove unnecessary mgmt dependency

* change identity to identifier in docstrings

* change core forzen requirement  for identity

* Change docstring for sms

* Override shared reqs for core

* Fix forzen requirements for core and sms

* change core dependency version in chat,sms,admin

* Add mgmt core back to the dependency

* Add a new line at the end of file

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

Author: turalf

sdk/communication/azure-communication-administration/azure/communication/administration/_shared/models.py

@@ -2,6 +2,12 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
+# pylint: skip-file
+
+from enum import Enum, EnumMeta
+from six import with_metaclass
+
+import msrest
 
 class CommunicationUserIdentifier(object):
     """
@@ -17,13 +23,14 @@ def __init__(self, identifier):
 class PhoneNumberIdentifier(object):
     """
     Represents a phone number.
-    :ivar value: Value for a phone number.
-    :vartype value: str
-    :param value: Value to initialize PhoneNumberIdentifier.
-    :type value: str
+    :param phone_number: The phone number in E.164 format.
+    :type phone_number: str
+    :param identifier: The full id of the phone number.
+    :type identifier: str
     """
-    def __init__(self, phone_number):
+    def __init__(self, phone_number, identifier=None):
         self.phone_number = phone_number
+        self.identifier = identifier
 
 class UnknownIdentifier(object):
     """
@@ -38,18 +45,102 @@ class UnknownIdentifier(object):
     def __init__(self, identifier):
         self.identifier = identifier
 
+class CommunicationIdentifierModel(msrest.serialization.Model):
+    """Communication Identifier Model.
+
+    All required parameters must be populated in order to send to Azure.
+
+    :param kind: Required. Kind of Communication Identifier.
+    :type kind: CommunicationIdentifierKind
+    :param id: Full id of the identifier.
+    :type id: str
+    :param phone_number: phone number in case the identifier is a phone number.
+    :type phone_number: str
+    :param is_anonymous: True if the identifier is anonymous.
+    :type is_anonymous: bool
+    :param microsoft_teams_user_id: Microsoft Teams user id.
+    :type microsoft_teams_user_id: str
+    :param communication_cloud_environment: Cloud environment that the user belongs to.
+    :type communication_cloud_environment: CommunicationCloudEnvironment
+    """
+
+    _validation = {
+        'kind': {'required': True},
+    }
+
+    _attribute_map = {
+        'kind': {'key': 'kind', 'type': 'str'},
+        'id': {'key': 'id', 'type': 'str'},
+        'phone_number': {'key': 'phoneNumber', 'type': 'str'},
+        'is_anonymous': {'key': 'isAnonymous', 'type': 'bool'},
+        'microsoft_teams_user_id': {'key': 'microsoftTeamsUserId', 'type': 'str'},
+        'communication_cloud_environment': {'key': 'communicationCloudEnvironment', 'type': 'str'},
+    }
+
+    def __init__(
+        self,
+        **kwargs
+    ):
+        super(CommunicationIdentifierModel, self).__init__(**kwargs)
+        self.kind = kwargs['kind']
+        self.id = kwargs.get('id', None)
+        self.phone_number = kwargs.get('phone_number', None)
+        self.is_anonymous = kwargs.get('is_anonymous', None)
+        self.microsoft_teams_user_id = kwargs.get('microsoft_teams_user_id', None)
+        self.communication_cloud_environment = kwargs.get('communication_cloud_environment', None)
+
+class _CaseInsensitiveEnumMeta(EnumMeta):
+    def __getitem__(cls, name):
+        return super().__getitem__(name.upper())
+
+    def __getattr__(cls, name):
+        """Return the enum member matching `name`
+        We use __getattr__ instead of descriptors or inserting into the enum
+        class' __dict__ in order to support `name` and `value` being both
+        properties for enum members (which live in the class' __dict__) and
+        enum members themselves.
+        """
+        try:
+            return cls._member_map_[name.upper()]
+        except KeyError:
+            raise AttributeError(name)
+
+class CommunicationIdentifierKind(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
+    """Communication Identifier Kind.
+    """
+    Unknown = "UNKNOWN"
+    CommunicationUser = "COMMUNICATIONUSER"
+    PhoneNumber = "PHONENUMBER"
+    CallingApplication = "CALLINGAPPLICATION"
+    MicrosoftTeamsUser = "MICROSOFTTEAMSUSER"
+
+class CommunicationCloudEnvironment(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
+    """
+    The cloud enviornment that the identifier belongs to
+    """
+    
+    Public = "PUBLIC"
+    Dod = "DOD"
+    Gcch = "GCCH"
+
 class MicrosoftTeamsUserIdentifier(object):
     """
     Represents an identifier for a Microsoft Teams user.
-    :ivar user_id: the string identifier representing the identity
+    :ivar user_id: The id of the Microsoft Teams user. If the user isn't anonymous, the id is the AAD object id of the user.
     :vartype user_id: str
     :param user_id: Value to initialize MicrosoftTeamsUserIdentifier.
     :type user_id: str
+    :ivar identifier: The full id of the Microsoft Teams User identifier.
+    :vartype identifier: str
+    :ivar cloud: Cloud environment that this identifier belongs to
+    :vartype cloud: CommunicationCloudEnvironment
     :ivar is_anonymous: set this to true if the user is anonymous for example when joining a meeting with a share link
     :vartype is_anonymous: bool
     :param is_anonymous: Value to initialize MicrosoftTeamsUserIdentifier.
     :type is_anonymous: bool
     """
-    def __init__(self, user_id, is_anonymous=False):
+    def __init__(self, user_id, identifier=None, cloud=CommunicationCloudEnvironment.Public, is_anonymous=False):
+        self.identifier = identifier
         self.user_id = user_id
         self.is_anonymous = is_anonymous
+        self.cloud = cloud

sdk/communication/azure-communication-administration/dev_requirements.txt

@@ -1,5 +1,4 @@
 -e ../../../tools/azure-sdk-tools
--e ../../../tools/azure-devtools
 -e ../../identity/azure-identity
 ../../core/azure-core
 ../azure-communication-nspkg

sdk/communication/azure-communication-administration/setup.py

@@ -64,7 +64,7 @@
     ]),
     install_requires=[
         "msrest>=0.6.0",
-        "azure-core<2.0.0,>=1.6.0",
+        "azure-core<2.0.0,>=1.9.0",
     ],
     extras_require={
         ":python_version<'3.0'": ['azure-communication-nspkg'],

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/communication_identifier_serializer.py

@@ -19,10 +19,12 @@ class CommunicationUserIdentifierSerializer(object):
     def serialize(cls, communicationIdentifier):
         """ Serialize the Communication identifier into CommunicationIdentifierModel
 
-        :param identifier: Communication service identifier
-        :type identifier: Union[CommunicationUserIdentifier, CommunicationPhoneNumberIdentifier]
+        :param identifier: Identifier object
+        :type identifier: Union[CommunicationUserIdentifier,
+           PhoneNumberIdentifier, MicrosoftTeamsUserIdentifier, UnknownIdentifier]
         :return: CommunicationIdentifierModel
         :rtype: ~azure.communication.chat.CommunicationIdentifierModel
+        :raises Union[TypeError, ValueError]
         """
         if isinstance(communicationIdentifier, CommunicationUserIdentifier):
             return CommunicationIdentifierModel(
@@ -32,18 +34,24 @@ def serialize(cls, communicationIdentifier):
         if isinstance(communicationIdentifier, PhoneNumberIdentifier):
             return CommunicationIdentifierModel(
                 kind=CommunicationIdentifierKind.PhoneNumber,
-                id=communicationIdentifier.phone_number
+                id=communicationIdentifier.identifier,
+                phone_number=communicationIdentifier.phone_number
             )
         if isinstance(communicationIdentifier, MicrosoftTeamsUserIdentifier):
             return CommunicationIdentifierModel(
                 kind=CommunicationIdentifierKind.MicrosoftTeamsUser,
-                id=communicationIdentifier.user_id
+                id=communicationIdentifier.identifier,
+                microsoft_teams_user_id=communicationIdentifier.user_id,
+                communication_cloud_environment=communicationIdentifier.cloud
             )
 
-        return CommunicationIdentifierModel(
-            kind=CommunicationIdentifierKind.Unknown,
-            id=communicationIdentifier.identifier
-        )
+        if isinstance(communicationIdentifier, UnknownIdentifier):
+            return CommunicationIdentifierModel(
+                kind=CommunicationIdentifierKind.Unknown,
+                id=communicationIdentifier.identifier
+            )
+
+        raise TypeError("Unsupported identifier type " + communicationIdentifier.__class__.__name__)
 
     @classmethod
     def deserialize(cls, identifierModel):
@@ -58,26 +66,27 @@ def deserialize(cls, identifierModel):
         """
 
         identifier, kind = identifierModel.id, identifierModel.kind
+        if not identifier:
+            raise ValueError("Identifier must have a valid id")
 
         if kind == CommunicationIdentifierKind.CommunicationUser:
-            if not identifier:
-                raise ValueError("CommunictionUser must have a valid id")
             return CommunicationUserIdentifier(id)
         if kind == CommunicationIdentifierKind.PhoneNumber:
             if not identifierModel.phone_number:
                 raise ValueError("PhoneNumberIdentifier must have a valid attribute - phone_number")
-            return PhoneNumberIdentifier(identifierModel.phone_number)
+            return PhoneNumberIdentifier(identifierModel.phone_number, identifier=identifier)
         if kind == CommunicationIdentifierKind.MicrosoftTeamsUser:
             if identifierModel.is_anonymous not in [True, False]:
                 raise ValueError("MicrosoftTeamsUser must have a valid attribute - is_anonymous")
             if not identifierModel.microsoft_teams_user_id:
                 raise ValueError("MicrosoftTeamsUser must have a valid attribute - microsoft_teams_user_id")
+            if not identifierModel.communication_cloud_environment:
+                raise ValueError("MicrosoftTeamsUser must have a valid attribute - communication_cloud_environment")
             return MicrosoftTeamsUserIdentifier(
                 identifierModel.microsoft_teams_user_id,
-                is_anonymous=identifierModel.is_anonymous
+                identifier=identifier,
+                is_anonymous=identifierModel.is_anonymous,
+                cloud=identifierModel.communication_cloud_environment
             )
 
-        if not identifier:
-            raise ValueError("UnknownIdentifier must have a valid id")
-
         return UnknownIdentifier(identifier)

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/models.py

@@ -23,13 +23,14 @@ def __init__(self, identifier):
 class PhoneNumberIdentifier(object):
     """
     Represents a phone number.
-    :ivar value: Value for a phone number.
-    :vartype value: str
-    :param value: Value to initialize PhoneNumberIdentifier.
-    :type value: str
+    :param phone_number: The phone number in E.164 format.
+    :type phone_number: str
+    :param identifier: The full id of the phone number.
+    :type identifier: str
     """
-    def __init__(self, phone_number):
+    def __init__(self, phone_number, identifier=None):
         self.phone_number = phone_number
+        self.identifier = identifier
 
 class UnknownIdentifier(object):
     """
@@ -44,37 +45,23 @@ class UnknownIdentifier(object):
     def __init__(self, identifier):
         self.identifier = identifier
 
-class MicrosoftTeamsUserIdentifier(object):
-    """
-    Represents an identifier for a Microsoft Teams user.
-    :ivar user_id: the string identifier representing the identity
-    :vartype user_id: str
-    :param user_id: Value to initialize MicrosoftTeamsUserIdentifier.
-    :type user_id: str
-    :ivar is_anonymous: set this to true if the user is anonymous for example when joining a meeting with a share link
-    :vartype is_anonymous: bool
-    :param is_anonymous: Value to initialize MicrosoftTeamsUserIdentifier.
-    :type is_anonymous: bool
-    """
-    def __init__(self, user_id, is_anonymous=False):
-        self.user_id = user_id
-        self.is_anonymous = is_anonymous
-
 class CommunicationIdentifierModel(msrest.serialization.Model):
     """Communication Identifier Model.
 
     All required parameters must be populated in order to send to Azure.
 
     :param kind: Required. Kind of Communication Identifier.
     :type kind: CommunicationIdentifierKind
-    :param id: identifies the Communication Identitity.
+    :param id: Full id of the identifier.
     :type id: str
-    :param phone_number: phone number in case the identity is phone number.
+    :param phone_number: phone number in case the identifier is a phone number.
     :type phone_number: str
-    :param is_anonymous: is the Microsoft Teams user is anaynimous.
+    :param is_anonymous: True if the identifier is anonymous.
     :type is_anonymous: bool
     :param microsoft_teams_user_id: Microsoft Teams user id.
     :type microsoft_teams_user_id: str
+    :param communication_cloud_environment: Cloud environment that the user belongs to.
+    :type communication_cloud_environment: CommunicationCloudEnvironment
     """
 
     _validation = {
@@ -87,6 +74,7 @@ class CommunicationIdentifierModel(msrest.serialization.Model):
         'phone_number': {'key': 'phoneNumber', 'type': 'str'},
         'is_anonymous': {'key': 'isAnonymous', 'type': 'bool'},
         'microsoft_teams_user_id': {'key': 'microsoftTeamsUserId', 'type': 'str'},
+        'communication_cloud_environment': {'key': 'communicationCloudEnvironment', 'type': 'str'},
     }
 
     def __init__(
@@ -99,7 +87,7 @@ def __init__(
         self.phone_number = kwargs.get('phone_number', None)
         self.is_anonymous = kwargs.get('is_anonymous', None)
         self.microsoft_teams_user_id = kwargs.get('microsoft_teams_user_id', None)
-
+        self.communication_cloud_environment = kwargs.get('communication_cloud_environment', None)
 
 class _CaseInsensitiveEnumMeta(EnumMeta):
     def __getitem__(cls, name):
@@ -121,7 +109,38 @@ class CommunicationIdentifierKind(with_metaclass(_CaseInsensitiveEnumMeta, str,
     """Communication Identifier Kind.
     """
     Unknown = "UNKNOWN"
-    CommunicationUser = "COMMUNICATIONuSER"
-    PhoneNumber = "PHONEnUMBER"
+    CommunicationUser = "COMMUNICATIONUSER"
+    PhoneNumber = "PHONENUMBER"
     CallingApplication = "CALLINGAPPLICATION"
-    MicrosoftTeamsUser = "MICROSOFTTEAMSuSER"
+    MicrosoftTeamsUser = "MICROSOFTTEAMSUSER"
+
+class CommunicationCloudEnvironment(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
+    """
+    The cloud enviornment that the identifier belongs to
+    """
+    
+    Public = "PUBLIC"
+    Dod = "DOD"
+    Gcch = "GCCH"
+
+class MicrosoftTeamsUserIdentifier(object):
+    """
+    Represents an identifier for a Microsoft Teams user.
+    :ivar user_id: The id of the Microsoft Teams user. If the user isn't anonymous, the id is the AAD object id of the user.
+    :vartype user_id: str
+    :param user_id: Value to initialize MicrosoftTeamsUserIdentifier.
+    :type user_id: str
+    :ivar identifier: The full id of the Microsoft Teams User identifier.
+    :vartype identifier: str
+    :ivar cloud: Cloud environment that this identifier belongs to
+    :vartype cloud: CommunicationCloudEnvironment
+    :ivar is_anonymous: set this to true if the user is anonymous for example when joining a meeting with a share link
+    :vartype is_anonymous: bool
+    :param is_anonymous: Value to initialize MicrosoftTeamsUserIdentifier.
+    :type is_anonymous: bool
+    """
+    def __init__(self, user_id, identifier=None, cloud=CommunicationCloudEnvironment.Public, is_anonymous=False):
+        self.identifier = identifier
+        self.user_id = user_id
+        self.is_anonymous = is_anonymous
+        self.cloud = cloud

sdk/communication/azure-communication-chat/dev_requirements.txt

@@ -1,4 +1,3 @@
--e ../../../tools/azure-devtools
 -e ../../../tools/azure-sdk-tools
 ../azure-communication-nspkg
 -e ../azure-communication-identity

sdk/communication/azure-communication-chat/setup.py

@@ -59,7 +59,7 @@
         'azure.communication'
     ]),
     install_requires=[
-        'azure-core<2.0.0,>=1.6.0',
+        'azure-core<2.0.0,>=1.9.0',
         'msrest>=0.6.0',
         'six>=1.6'
     ],