Adding new Reaction, Sticker and Interactive types of messages. (Azure#38693)

Merging Interactive messages PR on 2/10/2025
* Adding interactive types

* Typespec update commit

* version update

* adding samples to new types.

* Adding working samples:)

* sdk review

* reverting emitter overrites

* updating samples

* asset json update

* fixing pipeline

* build fix

* build fix

* adding new samples

* update to new version

* test updates

* build fix

* build fix

* build fix

* build fix

* build fix

* version update

* merge latest api spec commit.

* readme updates

* build fix

Author: Shamkh

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

@@ -1,14 +1,16 @@
 # Release History
 
-## 1.1.1 (Unreleased)
+## 1.2.0b1 (2025-01-15-preview)
+This is feature addition public preview release.
 
 ### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Using `NotificationMessagesClient`
+  - Send Interactive messages
+    - WhatsApp List Interactive Message
+    - WhatsApp Reply Button Interactive Message
+    - WhatsApp Url Interactive Message
+  - Send Reactions messages
+  - Send Stickers messages
 
 ## 1.1.0 (2024-10-18)
 This is feature addition release.

sdk/communication/azure-communication-messages/README.md

@@ -51,16 +51,43 @@ Use the returned token credential to authenticate the client:
 
 ### Examples
 
+Send Text WhatsApp message using AdvancedMessages python SDK.
 ```python
->>> from azure.communication.messages import NotificationMessagesClient
->>> from azure.identity import DefaultAzureCredential
->>> from azure.core.exceptions import HttpResponseError
+import os
+import sys
 
->>> client = NotificationMessagesClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
->>> try:
-        # write test code here
-    except HttpResponseError as e:
-        print('service responds error: {}'.format(e.response.json()))
+sys.path.append("..")
+
+class SendWhatsAppMessageSample(object):
+
+    connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING")
+    phone_number = os.getenv("RECIPIENT_PHONE_NUMBER")
+    channel_id = os.getenv("WHATSAPP_CHANNEL_ID")
+
+    def send_text_send_message(self):
+
+        from azure.communication.messages import NotificationMessagesClient
+        from azure.communication.messages.models import TextNotificationContent
+        from azure.identity import DefaultAzureCredential
+
+        messaging_client = NotificationMessagesClient(
+            endpoint=self.endpoint_string, credential=DefaultAzureCredential()
+        )
+        text_options = TextNotificationContent(
+            channel_registration_id=self.channel_id,
+            to=[self.phone_number],
+            content="Hello World via Notification Messaging SDK.",
+        )
+
+        # calling send() with whatsapp message details
+        message_responses = messaging_client.send(text_options)
+        response = message_responses.receipts[0]
+        print("Message with message id {} was successful sent to {}".format(response.message_id, response.to))
+
+
+if __name__ == "__main__":
+    sample = SendWhatsAppMessageSample()
+    sample.send_text_send_message()
 
 ```
 
@@ -101,4 +128,4 @@ additional questions or comments.
 [source]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-messages
 [product_docs]: https://learn.microsoft.com/azure/communication-services/overview
 [pypi]: https://pypi.org
-[nextsteps]: https://learn.microsoft.com/azure/communication-services/concepts/advanced-messaging/whatsapp/whatsapp-overview
+[nextsteps]: https://learn.microsoft.com/azure/communication-services/quickstarts/advanced-messaging/whatsapp/get-started

sdk/communication/azure-communication-messages/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/communication/azure-communication-messages",
-  "Tag": "python/communication/azure-communication-messages_302bf9560e"
+  "Tag": "python/communication/azure-communication-messages_25cd70fad7"
 }

sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py

@@ -5,16 +5,22 @@
 # Code generated by Microsoft (R) Python Code Generator.
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
+# pylint: disable=wrong-import-position
 
-from ._client import NotificationMessagesClient
-from ._client import MessageTemplateClient
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._client import NotificationMessagesClient  # type: ignore
+from ._client import MessageTemplateClient  # type: ignore
 from ._version import VERSION
 
 __version__ = VERSION
 
 try:
     from ._patch import __all__ as _patch_all
-    from ._patch import *  # pylint: disable=unused-wildcard-import
+    from ._patch import *
 except ImportError:
     _patch_all = []
 from ._patch import patch_sdk as _patch_sdk
@@ -23,6 +29,6 @@
     "NotificationMessagesClient",
     "MessageTemplateClient",
 ]
-__all__.extend([p for p in _patch_all if p not in __all__])
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
 
 _patch_sdk()

sdk/communication/azure-communication-messages/azure/communication/messages/_api_versions.py

@@ -11,6 +11,7 @@ class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     V2023_08_24_PREVIEW = "2023-08-24-preview"
     V2024_02_01 = "2024-02-01"
     V2024_08_30 = "2024-08-30"
+    V2025_01_15_PREVIEW = "2025-01-15-preview"
 
 
-DEFAULT_VERSION = ApiVersion.V2024_08_30.value
+DEFAULT_VERSION = ApiVersion.V2025_01_15_preview.value

sdk/communication/azure-communication-messages/azure/communication/messages/_client.py

@@ -20,24 +20,22 @@
 from ._serialization import Deserializer, Serializer
 
 if TYPE_CHECKING:
-    # pylint: disable=unused-import,ungrouped-imports
     from azure.core.credentials import TokenCredential
 
 
-class NotificationMessagesClient(
-    NotificationMessagesClientOperationsMixin
-):  # pylint: disable=client-accepts-api-version-keyword
+class NotificationMessagesClient(NotificationMessagesClientOperationsMixin):
     """NotificationMessagesClient.
 
     :param endpoint: The communication resource, for example
      https://my-resource.communication.azure.com. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is either a
-     TokenCredential type or a AzureKeyCredential type. Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a token
+     credential type or a AzureKeyCredential type. Required.
     :type credential: ~azure.core.credentials.TokenCredential or
      ~azure.core.credentials.AzureKeyCredential
-    :keyword api_version: The API version to use for this operation. Default value is "2024-08-30".
-     Note that overriding this default value may result in unsupported behavior.
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2025-01-15-preview". Note that overriding this default value may result in unsupported
+     behavior.
     :paramtype api_version: str
     """
 
@@ -104,18 +102,19 @@ def __exit__(self, *exc_details: Any) -> None:
         self._client.__exit__(*exc_details)
 
 
-class MessageTemplateClient(MessageTemplateClientOperationsMixin):  # pylint: disable=client-accepts-api-version-keyword
+class MessageTemplateClient(MessageTemplateClientOperationsMixin):
     """MessageTemplateClient.
 
     :param endpoint: The communication resource, for example
      https://my-resource.communication.azure.com. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is either a
-     TokenCredential type or a AzureKeyCredential type. Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a token
+     credential type or a AzureKeyCredential type. Required.
     :type credential: ~azure.core.credentials.TokenCredential or
      ~azure.core.credentials.AzureKeyCredential
-    :keyword api_version: The API version to use for this operation. Default value is "2024-08-30".
-     Note that overriding this default value may result in unsupported behavior.
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2025-01-15-preview". Note that overriding this default value may result in unsupported
+     behavior.
     :paramtype api_version: str
     """
 

sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py

@@ -14,11 +14,10 @@
 from ._version import VERSION
 
 if TYPE_CHECKING:
-    # pylint: disable=unused-import,ungrouped-imports
     from azure.core.credentials import TokenCredential
 
 
-class NotificationMessagesClientConfiguration:  # pylint: disable=too-many-instance-attributes,name-too-long
+class NotificationMessagesClientConfiguration:  # pylint: disable=too-many-instance-attributes
     """Configuration for NotificationMessagesClient.
 
     Note that all parameters used to create this instance are saved as instance
@@ -27,17 +26,18 @@ class NotificationMessagesClientConfiguration:  # pylint: disable=too-many-insta
     :param endpoint: The communication resource, for example
      https://my-resource.communication.azure.com. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is either a
-     TokenCredential type or a AzureKeyCredential type. Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a token
+     credential type or a AzureKeyCredential type. Required.
     :type credential: ~azure.core.credentials.TokenCredential or
      ~azure.core.credentials.AzureKeyCredential
-    :keyword api_version: The API version to use for this operation. Default value is "2024-08-30".
-     Note that overriding this default value may result in unsupported behavior.
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2025-01-15-preview". Note that overriding this default value may result in unsupported
+     behavior.
     :paramtype api_version: str
     """
 
     def __init__(self, endpoint: str, credential: Union["TokenCredential", AzureKeyCredential], **kwargs: Any) -> None:
-        api_version: str = kwargs.pop("api_version", "2024-08-30")
+        api_version: str = kwargs.pop("api_version", "2025-01-15-preview")
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")
@@ -73,7 +73,7 @@ def _configure(self, **kwargs: Any) -> None:
             self.authentication_policy = self._infer_policy(**kwargs)
 
 
-class MessageTemplateClientConfiguration:  # pylint: disable=too-many-instance-attributes,name-too-long
+class MessageTemplateClientConfiguration:  # pylint: disable=too-many-instance-attributes
     """Configuration for MessageTemplateClient.
 
     Note that all parameters used to create this instance are saved as instance
@@ -82,17 +82,18 @@ class MessageTemplateClientConfiguration:  # pylint: disable=too-many-instance-a
     :param endpoint: The communication resource, for example
      https://my-resource.communication.azure.com. Required.
     :type endpoint: str
-    :param credential: Credential used to authenticate requests to the service. Is either a
-     TokenCredential type or a AzureKeyCredential type. Required.
+    :param credential: Credential used to authenticate requests to the service. Is either a token
+     credential type or a AzureKeyCredential type. Required.
     :type credential: ~azure.core.credentials.TokenCredential or
      ~azure.core.credentials.AzureKeyCredential
-    :keyword api_version: The API version to use for this operation. Default value is "2024-08-30".
-     Note that overriding this default value may result in unsupported behavior.
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2025-01-15-preview". Note that overriding this default value may result in unsupported
+     behavior.
     :paramtype api_version: str
     """
 
     def __init__(self, endpoint: str, credential: Union["TokenCredential", AzureKeyCredential], **kwargs: Any) -> None:
-        api_version: str = kwargs.pop("api_version", "2024-08-30")
+        api_version: str = kwargs.pop("api_version", "2025-01-15-preview")
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")

sdk/communication/azure-communication-messages/azure/communication/messages/_model_base.py

@@ -1,10 +1,11 @@
+# pylint: disable=too-many-lines
 # coding=utf-8
 # --------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except, too-many-lines
+# pylint: disable=protected-access, broad-except
 
 import copy
 import calendar
@@ -573,7 +574,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
     def copy(self) -> "Model":
         return Model(self.__dict__)
 
-    def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: disable=unused-argument
+    def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:
         if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated:
             # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping',
             # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object'
@@ -584,8 +585,8 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: di
             annotations = {
                 k: v
                 for mro_class in mros
-                if hasattr(mro_class, "__annotations__")  # pylint: disable=no-member
-                for k, v in mro_class.__annotations__.items()  # pylint: disable=no-member
+                if hasattr(mro_class, "__annotations__")
+                for k, v in mro_class.__annotations__.items()
             }
             for attr, rf in attr_to_rest_field.items():
                 rf._module = cls.__module__
@@ -600,8 +601,8 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: di
 
     def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None:
         for base in cls.__bases__:
-            if hasattr(base, "__mapping__"):  # pylint: disable=no-member
-                base.__mapping__[discriminator or cls.__name__] = cls  # type: ignore  # pylint: disable=no-member
+            if hasattr(base, "__mapping__"):
+                base.__mapping__[discriminator or cls.__name__] = cls  # type: ignore
 
     @classmethod
     def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]:
@@ -612,7 +613,7 @@ def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField
 
     @classmethod
     def _deserialize(cls, data, exist_discriminators):
-        if not hasattr(cls, "__mapping__"):  # pylint: disable=no-member
+        if not hasattr(cls, "__mapping__"):
             return cls(data)
         discriminator = cls._get_discriminator(exist_discriminators)
         if discriminator is None:
@@ -632,11 +633,11 @@ def _deserialize(cls, data, exist_discriminators):
                 discriminator_value = data.find(xml_name).text  # pyright: ignore
         else:
             discriminator_value = data.get(discriminator._rest_name)
-        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore # pylint: disable=no-member
+        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore
         return mapped_cls._deserialize(data, exist_discriminators)
 
     def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]:
-        """Return a dict that can be JSONify using json.dump.
+        """Return a dict that can be turned into json using json.dump.
 
         :keyword bool exclude_readonly: Whether to remove the readonly properties.
         :returns: A dict JSON compatible object
@@ -733,7 +734,7 @@ def _sorted_annotations(types: typing.List[typing.Any]) -> typing.List[typing.An
     )
 
 
-def _get_deserialize_callable_from_annotation(  # pylint: disable=R0911, R0915, R0912
+def _get_deserialize_callable_from_annotation(  # pylint: disable=too-many-return-statements, too-many-branches
     annotation: typing.Any,
     module: typing.Optional[str],
     rf: typing.Optional["_RestField"] = None,
@@ -753,7 +754,7 @@ def _get_deserialize_callable_from_annotation(  # pylint: disable=R0911, R0915,
         except AttributeError:
             model_name = annotation
         if module is not None:
-            annotation = _get_model(module, model_name)
+            annotation = _get_model(module, model_name)  # type: ignore
 
     try:
         if module and _is_model(annotation):
@@ -893,6 +894,22 @@ def _deserialize(
     return _deserialize_with_callable(deserializer, value)
 
 
+def _failsafe_deserialize(
+    deserializer: typing.Any,
+    value: typing.Any,
+    module: typing.Optional[str] = None,
+    rf: typing.Optional["_RestField"] = None,
+    format: typing.Optional[str] = None,
+) -> typing.Any:
+    try:
+        return _deserialize(deserializer, value, module, rf, format)
+    except DeserializationError:
+        _LOGGER.warning(
+            "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True
+        )
+        return None
+
+
 class _RestField:
     def __init__(
         self,

sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py

@@ -5,17 +5,23 @@
 # Code generated by Microsoft (R) Python Code Generator.
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
+# pylint: disable=wrong-import-position
 
-from ._operations import NotificationMessagesClientOperationsMixin
-from ._operations import MessageTemplateClientOperationsMixin
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._operations import NotificationMessagesClientOperationsMixin  # type: ignore
+from ._operations import MessageTemplateClientOperationsMixin  # type: ignore
 
 from ._patch import __all__ as _patch_all
-from ._patch import *  # pylint: disable=unused-wildcard-import
+from ._patch import *
 from ._patch import patch_sdk as _patch_sdk
 
 __all__ = [
     "NotificationMessagesClientOperationsMixin",
     "MessageTemplateClientOperationsMixin",
 ]
-__all__.extend([p for p in _patch_all if p not in __all__])
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
 _patch_sdk()