diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 32939512c10b..89f712b701b8 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -106,6 +106,9 @@ # PRLabel: %Communication - SMS /sdk/communication/azure-communication-sms/ @DimaKolomiiets @gfeitosa-msft @besh2014 @phermanov-msft @ilyapaliakou-msft +# PRLabel: %Communication - Messages +/sdk/communication/azure-communication-messages/ @shamkh + # PRLabel: %Communication - Identity /sdk/communication/azure-communication-identity/ @Azure/acs-identity-sdk @AikoBB @maximrytych-ms @mjafferi-msft diff --git a/sdk/communication/azure-communication-messages/CHANGELOG.md b/sdk/communication/azure-communication-messages/CHANGELOG.md new file mode 100644 index 000000000000..f7283cd41edf --- /dev/null +++ b/sdk/communication/azure-communication-messages/CHANGELOG.md @@ -0,0 +1,16 @@ +# Release History + +## 1.0.0 (2024-02-01) + +This is the GA release of Azure Communication Messages Python SDK. For more information, please see the [README][read_me]. + +### Features Added +- Using `NotificationMessagesClient` + - Send Text messages + - Send Template messages + - Send Media messages +- Using `MessageTemplateClient` + - Get list of all WhatsApp templates. + + +[read_me]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-messages/README.md \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/LICENSE b/sdk/communication/azure-communication-messages/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/communication/azure-communication-messages/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/MANIFEST.in b/sdk/communication/azure-communication-messages/MANIFEST.in new file mode 100644 index 000000000000..0808b8a6a118 --- /dev/null +++ b/sdk/communication/azure-communication-messages/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/communication/messages/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/communication/__init__.py \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/README.md b/sdk/communication/azure-communication-messages/README.md new file mode 100644 index 000000000000..6f4db6da72cd --- /dev/null +++ b/sdk/communication/azure-communication-messages/README.md @@ -0,0 +1,104 @@ +# Azure Communication Messages Package client library for Python + +This package contains a Python SDK for Azure Communication Services for Messages(Advanced Messaging). +Read more about Azure Communication Services [here][product_docs] + +[Source code][source] | [Package (Pypi)][pypi] | [Product documentation][product_docs] + +## _Disclaimer_ + +_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_ + +## Getting started + +### Prequisites + +- Python 3.8 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Communication Messages instance. + +## Key concepts + +Azure Communication Services enables you to send and receive WhatsApp messages using the Azure Communication Services Messages SDK. It can be used to send out messages like appointment reminders, shipping updates, two-factor authentication, and other notification scenarios. + +### Installating the package + +```bash +python -m pip install azure-communication-messages +``` + +### Create with an Azure Active Directory Credential + +To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], +provide an instance of the desired credential type obtained from the +[azure-identity][azure_identity_credentials] library. + +To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] + +After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. +As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client: + +Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` + +Use the returned token credential to authenticate the client: + +```python +>>> from azure.communication.messages import NotificationMessagesClient +>>> from azure.identity import DefaultAzureCredential +>>> client = NotificationMessagesClient(endpoint='', credential=DefaultAzureCredential()) +``` + +### Examples + +```python +>>> from azure.communication.messages import NotificationMessagesClient +>>> from azure.identity import DefaultAzureCredential +>>> from azure.core.exceptions import HttpResponseError + +>>> client = NotificationMessagesClient(endpoint='', credential=DefaultAzureCredential()) +>>> try: + # write test code here + except HttpResponseError as e: + print('service responds error: {}'.format(e.response.json())) + +``` + +## Troubleshooting + +Running into issues? This section should contain details as to what to do there. + +## Next steps + +- [Read more about Azure Communication Services Messages][nextsteps] + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com + +[source]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-messages +[product_docs]: https://docs.microsoft.com/azure/communication-services/overview +[pypi]: https://pypi.org +[nextsteps]: https://learn.microsoft.com/azure/communication-services/concepts/advanced-messaging/whatsapp/whatsapp-overview diff --git a/sdk/communication/azure-communication-messages/assets.json b/sdk/communication/azure-communication-messages/assets.json new file mode 100644 index 000000000000..29fbe8eb70f6 --- /dev/null +++ b/sdk/communication/azure-communication-messages/assets.json @@ -0,0 +1,6 @@ +{ + "AssetsRepo": "Azure/azure-sdk-assets", + "AssetsRepoPrefixPath": "python", + "TagPrefix": "python/communication/azure-communication-messages", + "Tag": "python/communication/azure-communication-messages_1c6b0f13ac" +} diff --git a/sdk/communication/azure-communication-messages/azure/__init__.py b/sdk/communication/azure-communication-messages/azure/__init__.py new file mode 100644 index 000000000000..0d1f7edf5dc6 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__('pkgutil').extend_path(__path__, __name__) # type: ignore diff --git a/sdk/communication/azure-communication-messages/azure/communication/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/__init__.py new file mode 100644 index 000000000000..0d1f7edf5dc6 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/__init__.py @@ -0,0 +1 @@ +__path__ = __import__('pkgutil').extend_path(__path__, __name__) # type: ignore diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py new file mode 100644 index 000000000000..12815161d8d6 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py @@ -0,0 +1,27 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import NotificationMessagesClient +from ._client import MessageTemplateClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk +__all__ = [ + 'NotificationMessagesClient', + 'MessageTemplateClient', +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_api_versions.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_api_versions.py new file mode 100644 index 000000000000..97f1f0cc4095 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_api_versions.py @@ -0,0 +1,15 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta): + V2023_08_24_PREVIEW = "2023-08-24-preview" + V2024_02_01 = "2024-02-01" + + +DEFAULT_VERSION = ApiVersion.V2024_02_01.value diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_client.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_client.py new file mode 100644 index 000000000000..6007feaa0ca9 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_client.py @@ -0,0 +1,183 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING, Union + +from azure.core import PipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import MessageTemplateClientConfiguration, NotificationMessagesClientConfiguration +from ._operations import MessageTemplateClientOperationsMixin, NotificationMessagesClientOperationsMixin +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 + """NotificationMessagesClient. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential 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-02-01". + 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: + _endpoint = '{endpoint}' + self._config = NotificationMessagesClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop('policies', None) + if _policies is None: + _policies = [policies.RequestIdPolicy(**kwargs),self._config.headers_policy, + self._config.user_agent_policy,self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy,self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy,self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + + def send_request( + self, + request: HttpRequest, *, stream: bool = False, + **kwargs: Any + ) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "NotificationMessagesClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) +class MessageTemplateClient(MessageTemplateClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """MessageTemplateClient. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential 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-02-01". + 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: + _endpoint = '{endpoint}' + self._config = MessageTemplateClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop('policies', None) + if _policies is None: + _policies = [policies.RequestIdPolicy(**kwargs),self._config.headers_policy,self._config.user_agent_policy, + self._config.proxy_policy,policies.ContentDecodePolicy(**kwargs),self._config.redirect_policy, + self._config.retry_policy,self._config.authentication_policy,self._config.custom_hook_policy, + self._config.logging_policy,policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + + def send_request( + self, + request: HttpRequest, *, stream: bool = False, + **kwargs: Any + ) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> "MessageTemplateClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py new file mode 100644 index 000000000000..c2a1df548b8b --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py @@ -0,0 +1,142 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING, Union + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +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 + """Configuration for NotificationMessagesClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential 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-02-01". + 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-02-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) + kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if hasattr(self.credential, 'get_token'): + return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure( + self, + **kwargs: Any + ) -> None: + self.user_agent_policy = kwargs.get('user_agent_policy') or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get('headers_policy') or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get('proxy_policy') or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get('logging_policy') or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get('http_logging_policy') or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get('custom_hook_policy') or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get('redirect_policy') or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get('retry_policy') or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get('authentication_policy') + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) +class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for MessageTemplateClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential 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-02-01". + 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-02-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) + kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if hasattr(self.credential, 'get_token'): + return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure( + self, + **kwargs: Any + ) -> None: + self.user_agent_policy = kwargs.get('user_agent_policy') or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get('headers_policy') or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get('proxy_policy') or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get('logging_policy') or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get('http_logging_policy') or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get('custom_hook_policy') or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get('redirect_policy') or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get('retry_policy') or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get('authentication_policy') + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_model_base.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_model_base.py new file mode 100644 index 000000000000..ebf9c5fcb0dd --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_model_base.py @@ -0,0 +1,886 @@ +# 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 + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, type) + } + module_end = module_name.rsplit(".", 1)[0] + models.update({ + k: v + for k, v in sys.modules[module_end].__dict__.items() + if isinstance(v, type) + }) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + 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 + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + 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 + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next(rf for rf in self._attr_to_rest_field.values() + if rf._rest_name == k)._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)( + Model._as_dict_value(x, exclude_readonly=exclude_readonly) + for x in v + ) + if isinstance(v, dict): + return { + dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) + for dk, dv in v.items() + } + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return { + k: _deserialize(value_deserializer, v, module) + for k, v in obj.items() + } + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input) + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py new file mode 100644 index 000000000000..b610e644f4c2 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py @@ -0,0 +1,20 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import NotificationMessagesClientOperationsMixin +from ._operations import MessageTemplateClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-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__]) +_patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_operations.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_operations.py new file mode 100644 index 000000000000..691900b9f8eb --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_operations.py @@ -0,0 +1,696 @@ +# pylint: disable=too-many-lines,too-many-statements +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Iterable, Iterator, List, Optional, TypeVar, Union, overload +import urllib.parse +import uuid + +from azure.core.exceptions import (ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import MessageTemplateClientMixinABC, NotificationMessagesClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar('T') +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_notification_messages_send_request( + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop('content_type', _headers.pop('Content-Type', None)) + api_version: str = kwargs.pop('api_version', _params.pop('api-version', "2024-02-01")) + accept = _headers.pop('Accept', "application/json") + + # Construct URL + _url = "/messages/notifications:send" + + # Construct parameters + _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + + # Construct headers + if "Repeatability-Request-ID" not in _headers: + _headers["Repeatability-Request-ID"] = str(uuid.uuid4()) + if "Repeatability-First-Sent" not in _headers: + _headers["Repeatability-First-Sent"] = _SERIALIZER.serialize_data( + datetime.datetime.now(datetime.timezone.utc), "rfc-1123") + _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + if content_type is not None: + _headers['Content-Type'] = _SERIALIZER.header("content_type", content_type, 'str') + + return HttpRequest( + method="POST", + url=_url, + params=_params, + headers=_headers, + **kwargs + ) + + +def build_notification_messages_download_media_request( # pylint: disable=name-too-long + id: str, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop('api_version', _params.pop('api-version', "2024-02-01")) + accept = _headers.pop('Accept', "application/octet-stream") + + # Construct URL + _url = "/messages/streams/{id}" + path_format_arguments = { + "id": _SERIALIZER.url("id", id, 'str'), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + + # Construct headers + _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + + return HttpRequest( + method="GET", + url=_url, + params=_params, + headers=_headers, + **kwargs + ) + + +def build_message_template_list_templates_request( # pylint: disable=name-too-long + channel_id: str, + *, + maxpagesize: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop('api_version', _params.pop('api-version', "2024-02-01")) + accept = _headers.pop('Accept', "application/json") + + # Construct URL + _url = "/messages/channels/{channelId}/templates" + path_format_arguments = { + "channelId": _SERIALIZER.url("channel_id", channel_id, 'str'), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + if maxpagesize is not None: + _params['maxpagesize'] = _SERIALIZER.query("maxpagesize", maxpagesize, 'int') + + # Construct headers + _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + + return HttpRequest( + method="GET", + url=_url, + params=_params, + headers=_headers, + **kwargs + ) + +class NotificationMessagesClientOperationsMixin( # pylint: disable=name-too-long + NotificationMessagesClientMixinABC +): + + @overload + def send( + self, + body: _models.NotificationContent, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SendMessageResult: + # pylint: disable=line-too-long + """Sends a notification message from Business to User. + + :param body: Required. + :type body: ~azure.communication.messages.models.NotificationContent + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "image": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "image", + "mediaUri": "str", # A media url for the file. Required if the type is one + of the supported media types, e.g. image. Required. + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ], + "content": "str" # Optional. Optional text content. + } + + # JSON input template for discriminator value "template": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "template", + "template": { + "language": "str", # The template's language, in the ISO 639 format, + consist of a two-letter language code followed by an optional two-letter + country code, e.g., 'en' or 'en_US'. Required. + "name": "str", # Name of the template. Required. + "bindings": message_template_bindings, + "values": [ + message_template_value + ] + }, + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template for discriminator value "whatsApp": + message_template_bindings = { + "kind": "whatsApp", + "body": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "buttons": [ + { + "refValue": "str", # The name of the referenced item in the + template values. Required. + "subType": "str" # The WhatsApp button sub type. Required. + Known values are: "quickReply" and "url". + } + ], + "footer": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "header": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ] + } + + # JSON input template for discriminator value "text": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "content": "str", # Message content. Required. + "kind": "text", + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template you can fill out and use as your body input. + body = notification_content + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + + @overload + def send( + self, + body: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SendMessageResult: + """Sends a notification message from Business to User. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + + @overload + def send( + self, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SendMessageResult: + """Sends a notification message from Business to User. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + + + @distributed_trace + def send( + self, + body: Union[_models.NotificationContent, JSON, IO[bytes]], + **kwargs: Any + ) -> _models.SendMessageResult: + # pylint: disable=line-too-long + """Sends a notification message from Business to User. + + :param body: Is one of the following types: NotificationContent, JSON, IO[bytes] Required. + :type body: ~azure.communication.messages.models.NotificationContent or JSON or IO[bytes] + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "image": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "image", + "mediaUri": "str", # A media url for the file. Required if the type is one + of the supported media types, e.g. image. Required. + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ], + "content": "str" # Optional. Optional text content. + } + + # JSON input template for discriminator value "template": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "template", + "template": { + "language": "str", # The template's language, in the ISO 639 format, + consist of a two-letter language code followed by an optional two-letter + country code, e.g., 'en' or 'en_US'. Required. + "name": "str", # Name of the template. Required. + "bindings": message_template_bindings, + "values": [ + message_template_value + ] + }, + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template for discriminator value "whatsApp": + message_template_bindings = { + "kind": "whatsApp", + "body": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "buttons": [ + { + "refValue": "str", # The name of the referenced item in the + template values. Required. + "subType": "str" # The WhatsApp button sub type. Required. + Known values are: "quickReply" and "url". + } + ], + "footer": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "header": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ] + } + + # JSON input template for discriminator value "text": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "content": "str", # Message content. Required. + "kind": "text", + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template you can fill out and use as your body input. + body = notification_content + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop('content_type', _headers.pop('Content-Type', None)) + cls: ClsType[_models.SendMessageResult] = kwargs.pop( + 'cls', None + ) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_notification_messages_send_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, + stream=_stream, + **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers['Repeatability-Result']=self._deserialize('str', response.headers.get('Repeatability-Result')) + response_headers['x-ms-client-request-id']=self._deserialize('str', response.headers.get('x-ms-client-request-id')) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize( + _models.SendMessageResult, + response.json() + ) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + + + @distributed_trace + def download_media( + self, + id: str, + **kwargs: Any + ) -> Iterator[bytes]: + """Download the Media payload from a User to Business message. + + :param id: The stream ID. Required. + :type id: str + :return: Iterator[bytes] + :rtype: Iterator[bytes] + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[Iterator[bytes]] = kwargs.pop( + 'cls', None + ) + + _request = build_notification_messages_download_media_request( + id=id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", True) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, + stream=_stream, + **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers['x-ms-client-request-id']=self._deserialize('str', + response.headers.get('x-ms-client-request-id')) + + deserialized = response.iter_bytes() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + +class MessageTemplateClientOperationsMixin( + MessageTemplateClientMixinABC +): + + @distributed_trace + def list_templates( + self, + channel_id: str, + **kwargs: Any + ) -> Iterable["_models.MessageTemplateItem"]: + # pylint: disable=line-too-long + """List all templates for given Azure Communication Services channel. + + :param channel_id: The registration ID of the channel. Required. + :type channel_id: str + :return: An iterator like instance of MessageTemplateItem + :rtype: ~azure.core.paging.ItemPaged[~azure.communication.messages.models.MessageTemplateItem] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "whatsApp": + message_template_item = { + "kind": "whatsApp", + "language": "str", # The template's language, in the ISO 639 format, consist + of a two-letter language code followed by an optional two-letter country code, + e.g., 'en' or 'en_US'. Required. + "name": "str", # The template's name. Required. + "status": "str", # The aggregated template status. Required. Known values + are: "approved", "rejected", "pending", and "paused". + "content": {} # Optional. WhatsApp platform's template content. This is the + payload returned from WhatsApp API. + } + + # response body for status code(s): 200 + response == message_template_item + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.MessageTemplateItem]] = kwargs.pop( + 'cls', None + ) + + error_map = { + 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + def prepare_request(next_link=None): + if not next_link: + _request = build_message_template_list_templates_request( + channel_id=channel_id, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict({ + key: [urllib.parse.quote(v) for v in value] for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()}) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest("GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.MessageTemplateItem], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, + stream=_stream, + **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + + return ItemPaged( + get_next, extract_data + ) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_patch.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_patch.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_patch.py new file mode 100644 index 000000000000..6692bfbb6a9b --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_patch.py @@ -0,0 +1,138 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import ( + List, + Any, + Union +) +from urllib.parse import urlparse +from azure.core.credentials import TokenCredential, AzureKeyCredential +from ._shared.utils import parse_connection_str +from ._client import ( + NotificationMessagesClient as NotificationMessagesClientGenerated, + MessageTemplateClient as MessageTemplateClientGenerated, +) +from ._shared.auth_policy_utils import get_authentication_policy +from ._api_versions import DEFAULT_VERSION + +class NotificationMessagesClient(NotificationMessagesClientGenerated): + """A client to interact with the AzureCommunicationService Messaging service. + + This client provides operations to create and update jobs, policies and workers. + + :param str endpoint: + The endpoint of the Azure Communication resource. + :param Union[TokenCredential, AsyncTokenCredential] credential: + The credentials with which to authenticate + + :keyword api_version: Azure Communication Messaging API version. + Default value is "2023-11-01". + Note that overriding this default value may result in unsupported behavior. + """ + + def __init__(self, endpoint: str, credential: Union[TokenCredential, AzureKeyCredential], **kwargs: Any) -> None: + if not credential: + raise ValueError("credential can not be None") + + try: + if not endpoint.lower().startswith("http"): + endpoint = "https://" + endpoint + except AttributeError: + raise ValueError("Host URL must be a string") # pylint:disable=raise-missing-from + + parsed_url = urlparse(endpoint.rstrip("/")) + if not parsed_url.netloc: + raise ValueError("Invalid URL: {}".format(endpoint)) + + self._endpoint = endpoint + self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) + self._authentication_policy = get_authentication_policy(endpoint, credential) + self._credential = credential + super().__init__( + self._endpoint, + self._credential, + authentication_policy=self._authentication_policy, + api_version=self._api_version, + **kwargs + ) + @classmethod + def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "NotificationMessagesClient": + """Create NotificationMessagesClient from a Connection String. + :param conn_str: Azure communication service connection string. Required. + :type conn_str: str + :return: instance of NotificationMessagesClient + :rtype: + ~azure.communication.messages.NotificationMessagesClient + """ + endpoint, access_key = parse_connection_str(conn_str) + return cls(endpoint, AzureKeyCredential(access_key), **kwargs) + +class MessageTemplateClient(MessageTemplateClientGenerated): + """A client to interact with the AzureCommunicationService Messaging service. + + This client provides Advanced Messaging. + + :param str endpoint: + The endpoint of the Azure Communication resource. + :param Union[TokenCredential, AsyncTokenCredential] credential: + The credentials with which to authenticate + + :keyword api_version: Azure Communication Messages API version. Default value is "2024-02-01". + 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": + if not credential: + raise ValueError("credential can not be None") + + try: + if not endpoint.lower().startswith("http"): + endpoint = "https://" + endpoint + except AttributeError: + raise ValueError("Host URL must be a string") # pylint: disable=raise-missing-from + + parsed_url = urlparse(endpoint.rstrip("/")) + if not parsed_url.netloc: + raise ValueError("Invalid URL: {}".format(endpoint)) + + self._endpoint = endpoint + self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) + self._authentication_policy = get_authentication_policy(endpoint, credential) + self._credential = credential + super().__init__( + self._endpoint, self._credential, + authentication_policy=self._authentication_policy, + api_version=self._api_version, **kwargs + ) + + @classmethod + def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "MessageTemplateClient": + """Create MessageTemplateClient from a Connection String. + :param conn_str: Azure communication service connection string. Required. + :type conn_str: str + :return: instance of MessageTemplateClient + :rtype: + ~azure.communication.messages.messagetemplateclient + """ + endpoint, access_key = parse_connection_str(conn_str) + return cls(endpoint, AzureKeyCredential(access_key), **kwargs) + +__all__: List[str] = [ + "NotificationMessagesClient", + "MessageTemplateClient", +] # Add all objects you want publicly available to users at this package level + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_serialization.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_serialization.py new file mode 100644 index 000000000000..75e26c415d2c --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_serialization.py @@ -0,0 +1,2004 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[ + [str, Dict[str, Any], Any], Any + ] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]]=None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get('skip_quote', False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get('do_quote', False): + serialized = [ + '' if s is None else quote(str(s), safe='') + for s + in serialized + ] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]]=None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/__init__.py new file mode 100644 index 000000000000..5b396cd202e8 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/__init__.py @@ -0,0 +1,5 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py new file mode 100644 index 000000000000..c5172309c831 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py @@ -0,0 +1,53 @@ +# ------------------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# ------------------------------------------------------------------------- + +from typing import Union +from azure.core.credentials import TokenCredential, AzureKeyCredential +from azure.core.credentials_async import AsyncTokenCredential +from azure.core.pipeline.policies import ( + AsyncBearerTokenCredentialPolicy, + BearerTokenCredentialPolicy, +) +from .._shared.policy import HMACCredentialsPolicy + + +def get_authentication_policy( + endpoint: str, + credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str], + decode_url: bool = False, + is_async: bool = False, +): + # type: (...) -> Union[AsyncBearerTokenCredentialPolicy, BearerTokenCredentialPolicy, HMACCredentialsPolicy] + """Returns the correct authentication policy based on which credential is being passed. + + :param endpoint: The endpoint to which we are authenticating to. + :type endpoint: str + :param credential: The credential we use to authenticate to the service + :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] + :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` + :param bool is_async: For async clients there is a need to decode the url + + :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~azure.communication.messages.shared.policy.HMACCredentialsPolicy + """ + + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + if hasattr(credential, "get_token"): + if is_async: + return AsyncBearerTokenCredentialPolicy( + credential, "https://communication.azure.com//.default" # type: ignore + ) + return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + if isinstance(credential, (AzureKeyCredential, str)): + return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) + + raise TypeError( + f"Unsupported credential: {format(type(credential))}. Use an access token string to use HMACCredentialsPolicy" + "or a token credential from azure.identity" + ) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py new file mode 100644 index 000000000000..7b646472045c --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py @@ -0,0 +1,402 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +from enum import Enum +import warnings +from typing import Mapping, Optional, Union, Any, cast +from typing_extensions import Literal, TypedDict, Protocol, runtime_checkable + +from azure.core import CaseInsensitiveEnumMeta + + +class DeprecatedEnumMeta(CaseInsensitiveEnumMeta): + + def __getattribute__(cls, item): + if item.upper() == "MICROSOFT_BOT": + warnings.warn("MICROSOFT_BOT is deprecated and has been replaced by \ + MICROSOFT_TEAMS_APP identifier.", DeprecationWarning) + item = "MICROSOFT_TEAMS_APP" + return super().__getattribute__(item) + + +class CommunicationIdentifierKind(str, Enum, metaclass=DeprecatedEnumMeta): + """Communication Identifier Kind. + + For checking yet unknown identifiers it is better to rely on the presence of the `raw_id` property, + as new or existing distinct type identifiers always contain the `raw_id` property. + It is not advisable to rely on the `kind` property with a value `unknown`, + as it could become a new or existing distinct type in the future. + """ + + UNKNOWN = "unknown" + COMMUNICATION_USER = "communication_user" + PHONE_NUMBER = "phone_number" + MICROSOFT_TEAMS_USER = "microsoft_teams_user" + MICROSOFT_TEAMS_APP = "microsoft_teams_app" + + +class CommunicationCloudEnvironment(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The cloud environment that the identifier belongs to""" + + PUBLIC = "PUBLIC" + DOD = "DOD" + GCCH = "GCCH" + + +@runtime_checkable +class CommunicationIdentifier(Protocol): + """Communication Identifier.""" + @property + def raw_id(self) -> str: + """The raw ID of the identifier.""" + ... + @property + def kind(self) -> CommunicationIdentifierKind: + """The type of identifier.""" + ... + @property + def properties(self) -> Mapping[str, Any]: + """The properties of the identifier.""" + ... + + +PHONE_NUMBER_PREFIX = "4:" +BOT_PREFIX = "28:" +BOT_PUBLIC_CLOUD_PREFIX = "28:orgid:" +BOT_DOD_CLOUD_PREFIX = "28:dod:" +BOT_DOD_CLOUD_GLOBAL_PREFIX = "28:dod-global:" +BOT_GCCH_CLOUD_PREFIX = "28:gcch:" +BOT_GCCH_CLOUD_GLOBAL_PREFIX = "28:gcch-global:" +TEAMS_APP_PUBLIC_CLOUD_PREFIX = "28:orgid:" +TEAMS_APP_DOD_CLOUD_PREFIX = "28:dod:" +TEAMS_APP_GCCH_CLOUD_PREFIX = "28:gcch:" +TEAMS_USER_ANONYMOUS_PREFIX = "8:teamsvisitor:" +TEAMS_USER_PUBLIC_CLOUD_PREFIX = "8:orgid:" +TEAMS_USER_DOD_CLOUD_PREFIX = "8:dod:" +TEAMS_USER_GCCH_CLOUD_PREFIX = "8:gcch:" +ACS_USER_PREFIX = "8:acs:" +ACS_USER_DOD_CLOUD_PREFIX = "8:dod-acs:" +ACS_USER_GCCH_CLOUD_PREFIX = "8:gcch-acs:" +SPOOL_USER_PREFIX = "8:spool:" + + +class CommunicationUserProperties(TypedDict): + """Dictionary of properties for a CommunicationUserIdentifier.""" + id: str + """ID of the Communication user as returned from Azure Communication Identity.""" + + +class CommunicationUserIdentifier: + """Represents a user in Azure Communication Service.""" + kind: Literal[CommunicationIdentifierKind.COMMUNICATION_USER] = CommunicationIdentifierKind.COMMUNICATION_USER + """The type of identifier.""" + properties: CommunicationUserProperties + """The properties of the identifier.""" + raw_id: str + """The raw ID of the identifier.""" + + def __init__(self, id: str, **kwargs: Any) -> None: + """ + :param str id: ID of the Communication user as returned from Azure Communication Identity. + :keyword str raw_id: The raw ID of the identifier. If not specified, the 'id' value will be used. + """ + self.properties = CommunicationUserProperties(id=id) + raw_id: Optional[str] = kwargs.get("raw_id") + self.raw_id = raw_id if raw_id is not None else id + + def __eq__(self, other): + try: + if other.raw_id: + return self.raw_id == other.raw_id + return self.raw_id == other.properties["id"] + except Exception: # pylint: disable=broad-except + return False + + +class PhoneNumberProperties(TypedDict): + """Dictionary of properties for a PhoneNumberIdentifier.""" + value: str + """The phone number in E.164 format.""" + + +class PhoneNumberIdentifier: + """Represents a phone number.""" + kind: Literal[CommunicationIdentifierKind.PHONE_NUMBER] = CommunicationIdentifierKind.PHONE_NUMBER + """The type of identifier.""" + properties: PhoneNumberProperties + """The properties of the identifier.""" + raw_id: str + """The raw ID of the identifier.""" + + def __init__(self, value: str, **kwargs: Any) -> None: + """ + :param str value: The phone number. + :keyword str raw_id: The raw ID of the identifier. If not specified, this will be constructed from + the 'value' parameter. + """ + self.properties = PhoneNumberProperties(value=value) + raw_id: Optional[str] = kwargs.get("raw_id") + self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) + + def __eq__(self, other): + try: + if other.raw_id: + return self.raw_id == other.raw_id + return self.raw_id == self._format_raw_id(other.properties) + except Exception: # pylint:disable=broad-except + return False + + def _format_raw_id(self, properties: PhoneNumberProperties) -> str: + # We just assume correct E.164 format here because + # validation should only happen server-side, not client-side. + value = properties["value"] + return f"{PHONE_NUMBER_PREFIX}{value}" + + +class UnknownIdentifier: + """Represents an identifier of an unknown type. + + It will be encountered in communications with endpoints that are not + identifiable by this version of the SDK. + + For checking yet unknown identifiers it is better to rely on the presence of the `raw_id` property, + as new or existing distinct type identifiers always contain the `raw_id` property. + It is not advisable to rely on the `kind` property with a value `unknown`, + as it could become a new or existing distinct type in the future. + """ + kind: Literal[CommunicationIdentifierKind.UNKNOWN] = CommunicationIdentifierKind.UNKNOWN + """The type of identifier.""" + properties: Mapping[str, Any] + """The properties of the identifier.""" + raw_id: str + """The raw ID of the identifier.""" + + def __init__(self, identifier: str) -> None: + """ + :param str identifier: The ID of the identifier. + """ + self.raw_id = identifier + self.properties = {} + + def __eq__(self, other): + try: + return self.raw_id == other.raw_id + except AttributeError: + return False + + +class MicrosoftTeamsUserProperties(TypedDict): + """Dictionary of properties for a MicrosoftTeamsUserIdentifier.""" + user_id: str + """The id of the Microsoft Teams user. If the user isn't anonymous, the id is the AAD object id of the user.""" + is_anonymous: bool + """Set this to true if the user is anonymous for example when joining a meeting with a share link.""" + cloud: Union[CommunicationCloudEnvironment, str] + """Cloud environment that this identifier belongs to.""" + + +class MicrosoftTeamsUserIdentifier: + """Represents an identifier for a Microsoft Teams user.""" + kind: Literal[CommunicationIdentifierKind.MICROSOFT_TEAMS_USER] = CommunicationIdentifierKind.MICROSOFT_TEAMS_USER + """The type of identifier.""" + properties: MicrosoftTeamsUserProperties + """The properties of the identifier.""" + raw_id: str + """The raw ID of the identifier.""" + + def __init__(self, user_id: str, **kwargs: Any) -> None: + """ + :param str user_id: Microsoft Teams user id. + :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. + :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. + :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment + :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from + the other properties. + """ + self.properties = MicrosoftTeamsUserProperties( + user_id=user_id, + is_anonymous=kwargs.get("is_anonymous", False), + cloud=kwargs.get("cloud") or CommunicationCloudEnvironment.PUBLIC, + ) + raw_id: Optional[str] = kwargs.get("raw_id") + self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) + + def __eq__(self, other): + try: + if other.raw_id: + return self.raw_id == other.raw_id + return self.raw_id == self._format_raw_id(other.properties) + except Exception: # pylint: disable=broad-except + return False + + def _format_raw_id(self, properties: MicrosoftTeamsUserProperties) -> str: + user_id = properties["user_id"] + if properties["is_anonymous"]: + return f"{TEAMS_USER_ANONYMOUS_PREFIX}{user_id}" + cloud = properties["cloud"] + if cloud == CommunicationCloudEnvironment.DOD: + return f"{TEAMS_USER_DOD_CLOUD_PREFIX}{user_id}" + if cloud == CommunicationCloudEnvironment.GCCH: + return f"{TEAMS_USER_GCCH_CLOUD_PREFIX}{user_id}" + if cloud == CommunicationCloudEnvironment.PUBLIC: + return f"{TEAMS_USER_PUBLIC_CLOUD_PREFIX}{user_id}" + return f"{TEAMS_USER_PUBLIC_CLOUD_PREFIX}{user_id}" + + +class MicrosoftTeamsAppProperties(TypedDict): + """Dictionary of properties for a MicrosoftTeamsAppIdentifier.""" + app_id: str + """The id of the Microsoft Teams application.""" + cloud: Union[CommunicationCloudEnvironment, str] + """Cloud environment that this identifier belongs to.""" + + +class _botbackcompatdict(dict): + """Backwards compatible properties.""" + def __getitem__(self, __key: Any) -> Any: + try: + return super().__getitem__(__key) + except KeyError: + if __key == "bot_id": + return super().__getitem__("app_id") + if __key == "is_resource_account_configured": + return True + raise + + +class MicrosoftTeamsAppIdentifier: + """Represents an identifier for a Microsoft Teams application.""" + kind: Literal[CommunicationIdentifierKind.MICROSOFT_TEAMS_APP] = CommunicationIdentifierKind.MICROSOFT_TEAMS_APP + """The type of identifier.""" + properties: MicrosoftTeamsAppProperties + """The properties of the identifier.""" + raw_id: str + """The raw ID of the identifier.""" + + def __init__(self, app_id: str, **kwargs: Any) -> None: + """ + :param str app_id: Microsoft Teams application id. + :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. + :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment + :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed + from the other properties. + """ + self.properties = cast(MicrosoftTeamsAppProperties, _botbackcompatdict( + app_id=app_id, + cloud=kwargs.get("cloud") or CommunicationCloudEnvironment.PUBLIC, + )) + raw_id: Optional[str] = kwargs.get("raw_id") + self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) + + def __eq__(self, other): + try: + if other.raw_id: + return self.raw_id == other.raw_id + return self.raw_id == self._format_raw_id(other.properties) + except Exception: # pylint: disable=broad-except + return False + + def _format_raw_id(self, properties: MicrosoftTeamsAppProperties) -> str: + app_id = properties["app_id"] + cloud = properties["cloud"] + if cloud == CommunicationCloudEnvironment.DOD: + return f"{TEAMS_APP_DOD_CLOUD_PREFIX}{app_id}" + if cloud == CommunicationCloudEnvironment.GCCH: + return f"{TEAMS_APP_GCCH_CLOUD_PREFIX}{app_id}" + return f"{TEAMS_APP_PUBLIC_CLOUD_PREFIX}{app_id}" + + +class _MicrosoftBotIdentifier(MicrosoftTeamsAppIdentifier): + """Represents an identifier for a Microsoft bot. + + DEPRECATED. Only used in cases of backwards compatibility. + """ + + def __init__(self, bot_id, **kwargs): + """ + :param str bot_id: Microsoft bot id. + :keyword bool is_resource_account_configured: `False` if the identifier is global. + Default value is `True` for tennantzed bots. + :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. + :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment + """ + warnings.warn( + "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", + DeprecationWarning + ) + super().__init__(bot_id, **kwargs) + + +def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements + """ + Creates a CommunicationIdentifier from a given raw ID. + + When storing raw IDs use this function to restore the identifier that was encoded in the raw ID. + + :param str raw_id: A raw ID to construct the CommunicationIdentifier from. + :return: The CommunicationIdentifier parsed from the raw_id. + :rtype: CommunicationIdentifier + """ + if raw_id.startswith(PHONE_NUMBER_PREFIX): + return PhoneNumberIdentifier( + value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id + ) + + segments = raw_id.split(":", maxsplit=2) + if len(segments) < 3: + return UnknownIdentifier(identifier=raw_id) + + prefix = f"{segments[0]}:{segments[1]}:" + suffix = segments[2] + if prefix == TEAMS_USER_ANONYMOUS_PREFIX: + return MicrosoftTeamsUserIdentifier( + user_id=suffix, is_anonymous=True, raw_id=raw_id + ) + if prefix == TEAMS_USER_PUBLIC_CLOUD_PREFIX: + return MicrosoftTeamsUserIdentifier( + user_id=suffix, + is_anonymous=False, + cloud=CommunicationCloudEnvironment.PUBLIC, + raw_id=raw_id, + ) + if prefix == TEAMS_USER_DOD_CLOUD_PREFIX: + return MicrosoftTeamsUserIdentifier( + user_id=suffix, + is_anonymous=False, + cloud=CommunicationCloudEnvironment.DOD, + raw_id=raw_id, + ) + if prefix == TEAMS_USER_GCCH_CLOUD_PREFIX: + return MicrosoftTeamsUserIdentifier( + user_id=suffix, + is_anonymous=False, + cloud=CommunicationCloudEnvironment.GCCH, + raw_id=raw_id, + ) + if prefix == TEAMS_APP_PUBLIC_CLOUD_PREFIX: + return MicrosoftTeamsAppIdentifier( + app_id=suffix, + cloud=CommunicationCloudEnvironment.PUBLIC, + raw_id=raw_id, + ) + if prefix == TEAMS_APP_DOD_CLOUD_PREFIX: + return MicrosoftTeamsAppIdentifier( + app_id=suffix, + cloud=CommunicationCloudEnvironment.DOD, + raw_id=raw_id, + ) + if prefix == TEAMS_APP_GCCH_CLOUD_PREFIX: + return MicrosoftTeamsAppIdentifier( + app_id=suffix, + cloud=CommunicationCloudEnvironment.GCCH, + raw_id=raw_id, + ) + if prefix in [ + ACS_USER_PREFIX, + ACS_USER_DOD_CLOUD_PREFIX, + ACS_USER_GCCH_CLOUD_PREFIX, + SPOOL_USER_PREFIX, + ]: + return CommunicationUserIdentifier(id=raw_id, raw_id=raw_id) + return UnknownIdentifier(identifier=raw_id) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py new file mode 100644 index 000000000000..79aa48136fd3 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py @@ -0,0 +1,121 @@ +# ------------------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# ------------------------------------------------------------------------- + +import hashlib +import urllib +import base64 +import hmac +from urllib.parse import ParseResult, urlparse +from typing import Union +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline.policies import SansIOHTTPPolicy +from .utils import get_current_utc_time + + +class HMACCredentialsPolicy(SansIOHTTPPolicy): + """Implementation of HMAC authentication policy. + + :param str host: The host of the endpoint url for Azure Communication Service resource + :param access_key: The access key we use to authenticate to the service + :type access_key: str or AzureKeyCredential + :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` + """ + + def __init__( + self, + host, # type: str + access_key, # type: Union[str, AzureKeyCredential] + decode_url=False, # type: bool + ): + # type: (...) -> None + super(HMACCredentialsPolicy, self).__init__() + + if host.startswith("https://"): + self._host = host.replace("https://", "") + + if host.startswith("http://"): + self._host = host.replace("http://", "") + + self._access_key = access_key + self._decode_url = decode_url + + def _compute_hmac( + self, value # type: str + ): + if isinstance(self._access_key, AzureKeyCredential): + decoded_secret = base64.b64decode(self._access_key.key) + else: + decoded_secret = base64.b64decode(self._access_key) + + digest = hmac.new(decoded_secret, value.encode("utf-8"), hashlib.sha256).digest() + + return base64.b64encode(digest).decode("utf-8") + + def _sign_request(self, request): + verb = request.http_request.method.upper() + + # Get the path and query from url, which looks like https://host/path/query + parsed_url: ParseResult = urlparse(request.http_request.url) + query_url = parsed_url.path + + if parsed_url.query: + query_url += "?" + parsed_url.query + + # Need URL() to get a correct encoded key value, from "%3A" to ":", when transport is in type AioHttpTransport. + # There's a similar scenario in azure-storage-blob and azure-appconfiguration, the check logic is from there. + try: + from yarl import URL + from azure.core.pipeline.transport import ( # pylint:disable=non-abstract-transport-import + AioHttpTransport, + ) + + if ( + isinstance(request.context.transport, AioHttpTransport) + or isinstance( + getattr(request.context.transport, "_transport", None), + AioHttpTransport, + ) + or isinstance( + getattr( + getattr(request.context.transport, "_transport", None), + "_transport", + None, + ), + AioHttpTransport, + ) + ): + query_url = str(URL(query_url)) + except (ImportError, TypeError): + pass + + if self._decode_url: + query_url = urllib.parse.unquote(query_url) + + signed_headers = "x-ms-date;host;x-ms-content-sha256" + + utc_now = get_current_utc_time() + if request.http_request.body is None: + request.http_request.body = "" + content_digest = hashlib.sha256((request.http_request.body.encode("utf-8"))).digest() + content_hash = base64.b64encode(content_digest).decode("utf-8") + + string_to_sign = verb + "\n" + query_url + "\n" + utc_now + ";" + self._host + ";" + content_hash + + signature = self._compute_hmac(string_to_sign) + + signature_header = { + "x-ms-date": utc_now, + "x-ms-content-sha256": content_hash, + "x-ms-return-client-request-id": "true", + "Authorization": "HMAC-SHA256 SignedHeaders=" + signed_headers + "&Signature=" + signature, + } + + request.http_request.headers.update(signature_header) + + return request + + def on_request(self, request): + self._sign_request(request) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py new file mode 100644 index 000000000000..54603e7b32ce --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py @@ -0,0 +1,143 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +from threading import Lock, Condition, Timer, TIMEOUT_MAX, Event +from datetime import timedelta +from typing import Any + +from .utils import get_current_utc_as_int +from .utils import create_access_token + + +class CommunicationTokenCredential(object): + """Credential type used for authenticating to an Azure Communication service. + :param str token: The token used to authenticate to an Azure Communication service. + :keyword token_refresher: The sync token refresher to provide capacity to fetch a fresh token. + The returned token must be valid (expiration date must be in the future). + :paramtype token_refresher: Callable[[], AccessToken] + :keyword bool proactive_refresh: Whether to refresh the token proactively or not. + If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use + a background thread to attempt to refresh the token within 10 minutes before the cached token expires, + the proactive refresh will request a new token by calling the 'token_refresher' callback. + When 'proactive_refresh' is enabled, the Credential object must be either run within a context manager + or the 'close' method must be called once the object usage has been finished. + :raises: TypeError if paramater 'token' is not a string + :raises: ValueError if the 'proactive_refresh' is enabled without providing the 'token_refresher' callable. + """ + + _ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2 + _DEFAULT_AUTOREFRESH_INTERVAL_MINUTES = 10 + + def __init__(self, token: str, **kwargs: Any): + if not isinstance(token, str): + raise TypeError("Token must be a string.") + self._token = create_access_token(token) + self._token_refresher = kwargs.pop("token_refresher", None) + self._proactive_refresh = kwargs.pop("proactive_refresh", False) + if self._proactive_refresh and self._token_refresher is None: + raise ValueError("When 'proactive_refresh' is True, 'token_refresher' must not be None.") + self._timer = None + self._lock = Condition(Lock()) + self._some_thread_refreshing = False + self._is_closed = Event() + + def get_token(self, *scopes, **kwargs): # pylint: disable=unused-argument + # type (*str, **Any) -> AccessToken + """The value of the configured token. + :param any scopes: Scopes to be added to the token. + :return: AccessToken + :rtype: ~azure.core.credentials.AccessToken + """ + if self._proactive_refresh and self._is_closed.is_set(): + raise RuntimeError("An instance of CommunicationTokenCredential cannot be reused once it has been closed.") + + if not self._token_refresher or not self._is_token_expiring_soon(self._token): + return self._token + self._update_token_and_reschedule() + return self._token + + def _update_token_and_reschedule(self): + should_this_thread_refresh = False + with self._lock: + while self._is_token_expiring_soon(self._token): + if self._some_thread_refreshing: + if self._is_token_valid(self._token): + return self._token + self._wait_till_lock_owner_finishes_refreshing() + else: + should_this_thread_refresh = True + self._some_thread_refreshing = True + break + + if should_this_thread_refresh: + try: + new_token = self._token_refresher() + if not self._is_token_valid(new_token): + raise ValueError("The token returned from the token_refresher is expired.") + with self._lock: + self._token = new_token + self._some_thread_refreshing = False + self._lock.notify_all() + except: + with self._lock: + self._some_thread_refreshing = False + self._lock.notify_all() + raise + if self._proactive_refresh: + self._schedule_refresh() + return self._token + + def _schedule_refresh(self): + if self._is_closed.is_set(): + return + if self._timer is not None: + self._timer.cancel() + + token_ttl = self._token.expires_on - get_current_utc_as_int() + + if self._is_token_expiring_soon(self._token): + # Schedule the next refresh for when it reaches a certain percentage of the remaining lifetime. + timespan = token_ttl // 2 + else: + # Schedule the next refresh for when it gets in to the soon-to-expire window. + timespan = token_ttl - timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES).total_seconds() + if timespan <= TIMEOUT_MAX: + self._timer = Timer(timespan, self._update_token_and_reschedule) + self._timer.daemon = True + self._timer.start() + + def _wait_till_lock_owner_finishes_refreshing(self): + self._lock.release() + self._lock.acquire() + + def _is_token_expiring_soon(self, token): + if self._proactive_refresh: + interval = timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES) + else: + interval = timedelta(minutes=self._ON_DEMAND_REFRESHING_INTERVAL_MINUTES) + return (token.expires_on - get_current_utc_as_int()) < interval.total_seconds() + + @classmethod + def _is_token_valid(cls, token): + return get_current_utc_as_int() < token.expires_on + + def __enter__(self): + if self._proactive_refresh: + if self._is_closed.is_set(): + raise RuntimeError( + "An instance of CommunicationTokenCredential cannot be reused once it has been closed." + ) + self._schedule_refresh() + return self + + def __exit__(self, *args): + self.close() + + def close(self) -> None: + if self._timer is not None: + self._timer.cancel() + self._timer = None + self._is_closed.set() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py new file mode 100644 index 000000000000..15ad17da1a8c --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py @@ -0,0 +1,148 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +from asyncio import Condition, Lock, Event +from datetime import timedelta +from typing import Any +import sys + +from .utils import get_current_utc_as_int +from .utils import create_access_token +from .utils_async import AsyncTimer + + +class CommunicationTokenCredential(object): + """Credential type used for authenticating to an Azure Communication service. + :param str token: The token used to authenticate to an Azure Communication service. + :keyword token_refresher: The async token refresher to provide capacity to fetch a fresh token. + The returned token must be valid (expiration date must be in the future). + :paramtype token_refresher: Callable[[], Awaitable[AccessToken]] + :keyword bool proactive_refresh: Whether to refresh the token proactively or not. + If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use + a background thread to attempt to refresh the token within 10 minutes before the cached token expires, + the proactive refresh will request a new token by calling the 'token_refresher' callback. + When 'proactive_refresh is enabled', the Credential object must be either run within a context manager + or the 'close' method must be called once the object usage has been finished. + :raises: TypeError if paramater 'token' is not a string + :raises: ValueError if the 'proactive_refresh' is enabled without providing the 'token_refresher' function. + """ + + _ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2 + _DEFAULT_AUTOREFRESH_INTERVAL_MINUTES = 10 + + def __init__(self, token: str, **kwargs: Any): + if not isinstance(token, str): + raise TypeError("Token must be a string.") + self._token = create_access_token(token) + self._token_refresher = kwargs.pop("token_refresher", None) + self._proactive_refresh = kwargs.pop("proactive_refresh", False) + if self._proactive_refresh and self._token_refresher is None: + raise ValueError("When 'proactive_refresh' is True, 'token_refresher' must not be None.") + self._timer = None + self._async_mutex = Lock() + if sys.version_info[:3] == (3, 10, 0): + # Workaround for Python 3.10 bug(https://bugs.python.org/issue45416): + getattr(self._async_mutex, "_get_loop", lambda: None)() + self._lock = Condition(self._async_mutex) + self._some_thread_refreshing = False + self._is_closed = Event() + + async def get_token(self, *scopes, **kwargs): # pylint: disable=unused-argument + # type (*str, **Any) -> AccessToken + """The value of the configured token. + :param any scopes: Scopes to be added to the token. + :return: AccessToken + :rtype: ~azure.core.credentials.AccessToken + """ + if self._proactive_refresh and self._is_closed.is_set(): + raise RuntimeError("An instance of CommunicationTokenCredential cannot be reused once it has been closed.") + + if not self._token_refresher or not self._is_token_expiring_soon(self._token): + return self._token + await self._update_token_and_reschedule() + return self._token + + async def _update_token_and_reschedule(self): + should_this_thread_refresh = False + async with self._lock: + while self._is_token_expiring_soon(self._token): + if self._some_thread_refreshing: + if self._is_token_valid(self._token): + return self._token + await self._wait_till_lock_owner_finishes_refreshing() + else: + should_this_thread_refresh = True + self._some_thread_refreshing = True + break + + if should_this_thread_refresh: + try: + new_token = await self._token_refresher() + if not self._is_token_valid(new_token): + raise ValueError("The token returned from the token_refresher is expired.") + async with self._lock: + self._token = new_token + self._some_thread_refreshing = False + self._lock.notify_all() + except: + async with self._lock: + self._some_thread_refreshing = False + self._lock.notify_all() + raise + if self._proactive_refresh: + self._schedule_refresh() + return self._token + + def _schedule_refresh(self): + if self._is_closed.is_set(): + return + if self._timer is not None: + self._timer.cancel() + + token_ttl = self._token.expires_on - get_current_utc_as_int() + + if self._is_token_expiring_soon(self._token): + # Schedule the next refresh for when it reaches a certain percentage of the remaining lifetime. + timespan = token_ttl // 2 + else: + # Schedule the next refresh for when it gets in to the soon-to-expire window. + timespan = token_ttl - timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES).total_seconds() + + self._timer = AsyncTimer(timespan, self._update_token_and_reschedule) + self._timer.start() + + async def _wait_till_lock_owner_finishes_refreshing(self): + self._lock.release() + await self._lock.acquire() + + def _is_token_expiring_soon(self, token): + if self._proactive_refresh: + interval = timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES) + else: + interval = timedelta(minutes=self._ON_DEMAND_REFRESHING_INTERVAL_MINUTES) + return (token.expires_on - get_current_utc_as_int()) < interval.total_seconds() + + @classmethod + def _is_token_valid(cls, token): + return get_current_utc_as_int() < token.expires_on + + async def __aenter__(self): + if self._proactive_refresh: + if self._is_closed.is_set(): + raise RuntimeError( + "An instance of CommunicationTokenCredential cannot be reused once it has been closed." + ) + self._schedule_refresh() + return self + + async def __aexit__(self, *args): + await self.close() + + async def close(self) -> None: + if self._timer is not None: + self._timer.cancel() + self._timer = None + self._is_closed.set() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils.py new file mode 100644 index 000000000000..8576c31ddc56 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils.py @@ -0,0 +1,93 @@ +# ------------------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# ------------------------------------------------------------------------- + +import base64 +import json +import calendar +from typing import cast, Tuple, Optional +from datetime import datetime +from azure.core.serialization import TZ_UTC +from azure.core.credentials import AccessToken + + +def _convert_datetime_to_utc_int(input_datetime) -> int: + """ + Converts DateTime in local time to the Epoch in UTC in second. + + :param input_datetime: Input datetime + :type input_datetime: datetime + :return: Integer + :rtype: int + """ + return int(calendar.timegm(input_datetime.utctimetuple())) + + +def parse_connection_str(conn_str): + # type: (Optional[str]) -> Tuple[str, str] + if conn_str is None: + raise ValueError("Connection string is undefined.") + endpoint = None + shared_access_key = None + for element in conn_str.split(";"): + key, _, value = element.partition("=") + if key.lower() == "endpoint": + endpoint = value.rstrip("/") + elif key.lower() == "accesskey": + shared_access_key = value + if not all([endpoint, shared_access_key]): + raise ValueError( + "Invalid connection string. You can get the connection string from your resource page in the Azure Portal. " + "The format should be as follows: endpoint=https:///;accesskey=" + ) + left_slash_pos = cast(str, endpoint).find("//") + if left_slash_pos != -1: + host = cast(str, endpoint)[left_slash_pos + 2 :] + else: + host = str(endpoint) + + return host, str(shared_access_key) + + +def get_current_utc_time(): + # type: () -> str + return str(datetime.now(tz=TZ_UTC).strftime("%a, %d %b %Y %H:%M:%S ")) + "GMT" + + +def get_current_utc_as_int(): + # type: () -> int + current_utc_datetime = datetime.utcnow() + return _convert_datetime_to_utc_int(current_utc_datetime) + + +def create_access_token(token): + # type: (str) -> AccessToken + """Creates an instance of azure.core.credentials.AccessToken from a + string token. The input string is jwt token in the following form: + .. + This method looks into the token_payload which is a json and extracts the expiry time + for that token and creates a tuple of type azure.core.credentials.AccessToken + (, ) + :param token: User token + :type token: str + :return: Instance of azure.core.credentials.AccessToken - token and expiry date of it + :rtype: ~azure.core.credentials.AccessToken + """ + + token_parse_err_msg = "Token is not formatted correctly" + parts = token.split(".") + + if len(parts) < 3: + raise ValueError(token_parse_err_msg) + + try: + padded_base64_payload = base64.b64decode(parts[1] + "==").decode("ascii") + payload = json.loads(padded_base64_payload) + return AccessToken( + token, + _convert_datetime_to_utc_int(datetime.fromtimestamp(payload["exp"], TZ_UTC)), + ) + except ValueError as val_error: + raise ValueError(token_parse_err_msg) from val_error diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py new file mode 100644 index 000000000000..86e0e04d273c --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py @@ -0,0 +1,31 @@ +# ------------------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# ------------------------------------------------------------------------- + +import asyncio + + +class AsyncTimer: + """A non-blocking timer, that calls a function after a specified number of seconds: + :param int interval: time interval in seconds + :param callable callback: function to be called after the interval has elapsed + """ + + def __init__(self, interval, callback): + self._interval = interval + self._callback = callback + self._task = None + + def start(self): + self._task = asyncio.ensure_future(self._job()) + + async def _job(self): + await asyncio.sleep(self._interval) + await self._callback() + + def cancel(self): + if self._task is not None: + self._task.cancel() + self._task = None diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_types.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_types.py new file mode 100644 index 000000000000..c4a9e104060d --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_types.py @@ -0,0 +1,11 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Literal +RepeatabilityResult = Literal["accepted", "rejected"] diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_vendor.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_vendor.py new file mode 100644 index 000000000000..69423791b491 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_vendor.py @@ -0,0 +1,34 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import MessageTemplateClientConfiguration, NotificationMessagesClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + +class NotificationMessagesClientMixinABC( + ABC +): + """DO NOT use this class. It is for internal typing use only.""" + _client: "PipelineClient" + _config: NotificationMessagesClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" +class MessageTemplateClientMixinABC( + ABC +): + """DO NOT use this class. It is for internal typing use only.""" + _client: "PipelineClient" + _config: MessageTemplateClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_version.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_version.py new file mode 100644 index 000000000000..0ec13ea52bbf --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_version.py @@ -0,0 +1,9 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/__init__.py new file mode 100644 index 000000000000..6d57d158f591 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/__init__.py @@ -0,0 +1,24 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import NotificationMessagesClient +from ._client import MessageTemplateClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk +__all__ = [ + 'NotificationMessagesClient', + 'MessageTemplateClient', +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_client.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_client.py new file mode 100644 index 000000000000..1e83e764793a --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_client.py @@ -0,0 +1,184 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, TYPE_CHECKING, Union + +from azure.core import AsyncPipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import MessageTemplateClientConfiguration, NotificationMessagesClientConfiguration +from ._operations import MessageTemplateClientOperationsMixin, NotificationMessagesClientOperationsMixin + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + +class NotificationMessagesClient(NotificationMessagesClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """NotificationMessagesClient. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential type or a AzureKeyCredential type. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential or + ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + endpoint: str, + credential: Union["AsyncTokenCredential", AzureKeyCredential], + **kwargs: Any + ) -> None: + _endpoint = '{endpoint}' + self._config = NotificationMessagesClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop('policies', None) + if _policies is None: + _policies = [policies.RequestIdPolicy(**kwargs), + self._config.headers_policy,self._config.user_agent_policy, + self._config.proxy_policy,policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy,self._config.retry_policy,self._config.authentication_policy, + self._config.custom_hook_policy,self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + + def send_request( + self, + request: HttpRequest, *, stream: bool = False, + **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "NotificationMessagesClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) +class MessageTemplateClient(MessageTemplateClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """MessageTemplateClient. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential type or a AzureKeyCredential type. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential or + ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + endpoint: str, + credential: Union["AsyncTokenCredential", AzureKeyCredential], + **kwargs: Any + ) -> None: + _endpoint = '{endpoint}' + self._config = MessageTemplateClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop('policies', None) + if _policies is None: + _policies = [policies.RequestIdPolicy(**kwargs),self._config.headers_policy, + self._config.user_agent_policy,self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs),self._config.redirect_policy, + self._config.retry_policy,self._config.authentication_policy, + self._config.custom_hook_policy,self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + + def send_request( + self, + request: HttpRequest, *, stream: bool = False, + **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "MessageTemplateClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_configuration.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_configuration.py new file mode 100644 index 000000000000..5308b452aca6 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_configuration.py @@ -0,0 +1,142 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING, Union + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class NotificationMessagesClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for NotificationMessagesClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential type or a AzureKeyCredential type. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential or + ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + endpoint: str, + credential: Union["AsyncTokenCredential", AzureKeyCredential], + **kwargs: Any + ) -> None: + api_version: str = kwargs.pop('api_version', "2024-02-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) + kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if hasattr(self.credential, 'get_token'): + return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure( + self, + **kwargs: Any + ) -> None: + self.user_agent_policy = kwargs.get('user_agent_policy') or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get('headers_policy') or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get('proxy_policy') or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get('logging_policy') or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get('http_logging_policy') or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get('custom_hook_policy') or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get('redirect_policy') or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get('retry_policy') or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get('authentication_policy') + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) +class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for MessageTemplateClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: The communication resource, for example + https://my-resource.communication.azure.com. Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Is either a + TokenCredential type or a AzureKeyCredential type. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential or + ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for this operation. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, + endpoint: str, + credential: Union["AsyncTokenCredential", AzureKeyCredential], + **kwargs: Any + ) -> None: + api_version: str = kwargs.pop('api_version', "2024-02-01") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) + kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if hasattr(self.credential, 'get_token'): + return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure( + self, + **kwargs: Any + ) -> None: + self.user_agent_policy = kwargs.get('user_agent_policy') or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get('headers_policy') or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get('proxy_policy') or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get('logging_policy') or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get('http_logging_policy') or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get('custom_hook_policy') or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get('redirect_policy') or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get('retry_policy') or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get('authentication_policy') + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/__init__.py new file mode 100644 index 000000000000..b610e644f4c2 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/__init__.py @@ -0,0 +1,20 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import NotificationMessagesClientOperationsMixin +from ._operations import MessageTemplateClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-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__]) +_patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_operations.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_operations.py new file mode 100644 index 000000000000..68dc602a8c96 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_operations.py @@ -0,0 +1,590 @@ +# pylint: disable=too-many-lines,too-many-statements +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from io import IOBase +import json +import sys +from typing import Any, AsyncIterable, AsyncIterator, Callable, Dict, IO, List, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import (ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ..._operations._operations import (build_message_template_list_templates_request, + build_notification_messages_download_media_request, + build_notification_messages_send_request) +from .._vendor import MessageTemplateClientMixinABC, NotificationMessagesClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar('T') +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + +class NotificationMessagesClientOperationsMixin( # pylint: disable=name-too-long + NotificationMessagesClientMixinABC +): + + @overload + async def send( + self, + body: _models.NotificationContent, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SendMessageResult: + # pylint: disable=line-too-long + """Sends a notification message from Business to User. + + :param body: Required. + :type body: ~azure.communication.messages.models.NotificationContent + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "image": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "image", + "mediaUri": "str", # A media url for the file. Required if the type is one + of the supported media types, e.g. image. Required. + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ], + "content": "str" # Optional. Optional text content. + } + + # JSON input template for discriminator value "template": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "template", + "template": { + "language": "str", # The template's language, in the ISO 639 format, + consist of a two-letter language code followed by an optional two-letter + country code, e.g., 'en' or 'en_US'. Required. + "name": "str", # Name of the template. Required. + "bindings": message_template_bindings, + "values": [ + message_template_value + ] + }, + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template for discriminator value "whatsApp": + message_template_bindings = { + "kind": "whatsApp", + "body": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "buttons": [ + { + "refValue": "str", # The name of the referenced item in the + template values. Required. + "subType": "str" # The WhatsApp button sub type. Required. + Known values are: "quickReply" and "url". + } + ], + "footer": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "header": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ] + } + + # JSON input template for discriminator value "text": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "content": "str", # Message content. Required. + "kind": "text", + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template you can fill out and use as your body input. + body = notification_content + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + + @overload + async def send( + self, + body: JSON, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SendMessageResult: + """Sends a notification message from Business to User. + + :param body: Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + + @overload + async def send( + self, + body: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.SendMessageResult: + """Sends a notification message from Business to User. + + :param body: Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + + + @distributed_trace_async + async def send( + self, + body: Union[_models.NotificationContent, JSON, IO[bytes]], + **kwargs: Any + ) -> _models.SendMessageResult: + # pylint: disable=line-too-long + """Sends a notification message from Business to User. + + :param body: Is one of the following types: NotificationContent, JSON, IO[bytes] Required. + :type body: ~azure.communication.messages.models.NotificationContent or JSON or IO[bytes] + :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping + :rtype: ~azure.communication.messages.models.SendMessageResult + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # The input is polymorphic. The following are possible polymorphic inputs based off + discriminator "kind": + + # JSON input template for discriminator value "image": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "image", + "mediaUri": "str", # A media url for the file. Required if the type is one + of the supported media types, e.g. image. Required. + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ], + "content": "str" # Optional. Optional text content. + } + + # JSON input template for discriminator value "template": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "kind": "template", + "template": { + "language": "str", # The template's language, in the ISO 639 format, + consist of a two-letter language code followed by an optional two-letter + country code, e.g., 'en' or 'en_US'. Required. + "name": "str", # Name of the template. Required. + "bindings": message_template_bindings, + "values": [ + message_template_value + ] + }, + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template for discriminator value "whatsApp": + message_template_bindings = { + "kind": "whatsApp", + "body": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "buttons": [ + { + "refValue": "str", # The name of the referenced item in the + template values. Required. + "subType": "str" # The WhatsApp button sub type. Required. + Known values are: "quickReply" and "url". + } + ], + "footer": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ], + "header": [ + { + "refValue": "str" # The name of the referenced item in the + template values. Required. + } + ] + } + + # JSON input template for discriminator value "text": + notification_content = { + "channelRegistrationId": "str", # The Channel Registration ID for the + Business Identifier. Required. + "content": "str", # Message content. Required. + "kind": "text", + "to": [ + "str" # The native external platform user identifiers of the + recipient. Required. + ] + } + + # JSON input template you can fill out and use as your body input. + body = notification_content + + # response body for status code(s): 202 + response == { + "receipts": [ + { + "messageId": "str", # The message id. Required. + "to": "str" # The native external platform user identifier + of the recipient. Required. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop('content_type', _headers.pop('Content-Type', None)) + cls: ClsType[_models.SendMessageResult] = kwargs.pop( + 'cls', None + ) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_notification_messages_send_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, + stream=_stream, + **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers['Repeatability-Result']=self._deserialize('str', response.headers.get('Repeatability-Result')) + response_headers['x-ms-client-request-id']=self._deserialize('str', response.headers.get('x-ms-client-request-id')) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize( + _models.SendMessageResult, + response.json() + ) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + + + @distributed_trace_async + async def download_media( + self, + id: str, + **kwargs: Any + ) -> AsyncIterator[bytes]: + """Download the Media payload from a User to Business message. + + :param id: The stream ID. Required. + :type id: str + :return: AsyncIterator[bytes] + :rtype: AsyncIterator[bytes] + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop( + 'cls', None + ) + + _request = build_notification_messages_download_media_request( + id=id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", True) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, + stream=_stream, + **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers['x-ms-client-request-id']=self._deserialize('str', + response.headers.get('x-ms-client-request-id')) + + deserialized = response.iter_bytes() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + +class MessageTemplateClientOperationsMixin( + MessageTemplateClientMixinABC +): + + @distributed_trace + def list_templates( + self, + channel_id: str, + **kwargs: Any + ) -> AsyncIterable["_models.MessageTemplateItem"]: + # pylint: disable=line-too-long + """List all templates for given Azure Communication Services channel. + + :param channel_id: The registration ID of the channel. Required. + :type channel_id: str + :return: An iterator like instance of MessageTemplateItem + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.communication.messages.models.MessageTemplateItem] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + # The response is polymorphic. The following are possible polymorphic responses based + off discriminator "kind": + + # JSON input template for discriminator value "whatsApp": + message_template_item = { + "kind": "whatsApp", + "language": "str", # The template's language, in the ISO 639 format, consist + of a two-letter language code followed by an optional two-letter country code, + e.g., 'en' or 'en_US'. Required. + "name": "str", # The template's name. Required. + "status": "str", # The aggregated template status. Required. Known values + are: "approved", "rejected", "pending", and "paused". + "content": {} # Optional. WhatsApp platform's template content. This is the + payload returned from WhatsApp API. + } + + # response body for status code(s): 200 + response == message_template_item + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.MessageTemplateItem]] = kwargs.pop( + 'cls', None + ) + + error_map = { + 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + } + error_map.update(kwargs.pop('error_map', {}) or {}) + def prepare_request(next_link=None): + if not next_link: + _request = build_message_template_list_templates_request( + channel_id=channel_id, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict({ + key: [urllib.parse.quote(v) for v in value] for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()}) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest("GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.MessageTemplateItem], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, + stream=_stream, + **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + + return AsyncItemPaged( + get_next, extract_data + ) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_patch.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_patch.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_patch.py new file mode 100644 index 000000000000..c8480be8d240 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_patch.py @@ -0,0 +1,138 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import ( + List, + Any, + Union, +) +from urllib.parse import urlparse +from azure.core.credentials import AzureKeyCredential +from azure.core.credentials_async import AsyncTokenCredential +from .._shared.utils import parse_connection_str +from ._client import ( + NotificationMessagesClient as NotificationMessagesClientGenerated, + MessageTemplateClient as MessageTemplateClientGenerated, +) +from .._api_versions import DEFAULT_VERSION +from .._shared.auth_policy_utils import get_authentication_policy + +class NotificationMessagesClient(NotificationMessagesClientGenerated): + """A client to interact with the AzureCommunicationService Messaging service. + + This client allows you to send and receive WhatsApp template messages using the + Azure Communication Services Messaging SDK. + + :param str endpoint: + The endpoint of the Azure Communication resource. + :param ~azure.core.credentials.AzureKeyCredential credential: + The credentials with which to authenticate + :keyword api_version: Azure Communication Messaging API version. + Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + """ + + def __init__(self, endpoint: str, + credential: Union[AsyncTokenCredential, AzureKeyCredential], **kwargs: Any) -> None: + if not credential: + raise ValueError("credential can not be None") + + try: + if not endpoint.lower().startswith("http"): + endpoint = "https://" + endpoint + except AttributeError: + raise ValueError("Host URL must be a string") # pylint:disable=raise-missing-from + + parsed_url = urlparse(endpoint.rstrip("/")) + if not parsed_url.netloc: + raise ValueError("Invalid URL: {}".format(endpoint)) + + self._endpoint = endpoint + self._credential = credential + self._authentication_policy = get_authentication_policy(endpoint, credential) + self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) + super().__init__( + self._endpoint, self._credential, + authentication_policy=self._authentication_policy, api_version=self._api_version, **kwargs + ) + + @classmethod + def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "NotificationMessagesClient": + """Create NotificationMessagesClient from a Connection String. + :param conn_str: Azure Communication Service endpoint. Required. + :type conn_str: str + :return: instance of NotificationMessagesClient. + :rtype:~azure.communication.message.notificationmessagesclient + """ + endpoint, access_key = parse_connection_str(conn_str) + return cls(endpoint, AzureKeyCredential(key=access_key), **kwargs) + +class MessageTemplateClient(MessageTemplateClientGenerated): + """A client to interact with the AzureCommunicationService Messaging service. + + This client allows you to send and receive WhatsApp template + messages using the Azure Communication Services Messaging SDK. + + :param str endpoint: + The endpoint of the Azure Communication resource. + :param ~azure.core.credentials.AzureKeyCredential credential: + The credentials with which to authenticate + :keyword api_version: Azure Communication Messaging API version. Default value is "2024-02-01". + Note that overriding this default value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: Union[AsyncTokenCredential, + AzureKeyCredential], **kwargs: Any) -> "None": + if not credential: + raise ValueError("credential can not be None") + + try: + if not endpoint.lower().startswith("http"): + endpoint = "https://" + endpoint + except AttributeError: + raise ValueError("Host URL must be a string") # pylint: disable=raise-missing-from + + parsed_url = urlparse(endpoint.rstrip("/")) + if not parsed_url.netloc: + raise ValueError("Invalid URL: {}".format(endpoint)) + + self._endpoint = endpoint + self._credential = credential + self._authentication_policy = get_authentication_policy(endpoint, credential) + self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) + super().__init__( + self._endpoint, self._credential, + authentication_policy=self._authentication_policy, + api_version=self._api_version, + **kwargs + ) + + @classmethod + def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "MessageTemplateClient": + """Create MessageTemplateClient from a Connection String. + :param conn_str: Azure Communication Service endpoint. Required. + :type conn_str: str + :return: instance of MessageTemplateClient. + :rtype:~azure.communication.message.messagetemplateclient + """ + endpoint, access_key = parse_connection_str(conn_str) + return cls(endpoint, AzureKeyCredential(access_key), **kwargs) + +__all__: List[str] = [ + "NotificationMessagesClient", + "MessageTemplateClient", +] # Add all objects you want publicly available to users at this package level + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_vendor.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_vendor.py new file mode 100644 index 000000000000..8181c1e90e24 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_vendor.py @@ -0,0 +1,34 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import MessageTemplateClientConfiguration, NotificationMessagesClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + +class NotificationMessagesClientMixinABC( + ABC +): + """DO NOT use this class. It is for internal typing use only.""" + _client: "AsyncPipelineClient" + _config: NotificationMessagesClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" +class MessageTemplateClientMixinABC( + ABC +): + """DO NOT use this class. It is for internal typing use only.""" + _client: "AsyncPipelineClient" + _config: MessageTemplateClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/models/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/models/__init__.py new file mode 100644 index 000000000000..033c45805634 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/models/__init__.py @@ -0,0 +1,70 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import ImageNotificationContent +from ._models import MessageReceipt +from ._models import MessageTemplate +from ._models import MessageTemplateBindings +from ._models import MessageTemplateDocument +from ._models import MessageTemplateImage +from ._models import MessageTemplateItem +from ._models import MessageTemplateLocation +from ._models import MessageTemplateQuickAction +from ._models import MessageTemplateText +from ._models import MessageTemplateValue +from ._models import MessageTemplateVideo +from ._models import NotificationContent +from ._models import SendMessageResult +from ._models import TemplateNotificationContent +from ._models import TextNotificationContent +from ._models import WhatsAppMessageTemplateBindings +from ._models import WhatsAppMessageTemplateBindingsButton +from ._models import WhatsAppMessageTemplateBindingsComponent +from ._models import WhatsAppMessageTemplateItem + +from ._enums import CommunicationMessageKind +from ._enums import CommunicationMessagesChannel +from ._enums import MessageTemplateBindingsKind +from ._enums import MessageTemplateStatus +from ._enums import MessageTemplateValueKind +from ._enums import RepeatabilityResult +from ._enums import WhatsAppMessageButtonSubType +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk +__all__ = [ + 'ImageNotificationContent', + 'MessageReceipt', + 'MessageTemplate', + 'MessageTemplateBindings', + 'MessageTemplateDocument', + 'MessageTemplateImage', + 'MessageTemplateItem', + 'MessageTemplateLocation', + 'MessageTemplateQuickAction', + 'MessageTemplateText', + 'MessageTemplateValue', + 'MessageTemplateVideo', + 'NotificationContent', + 'SendMessageResult', + 'TemplateNotificationContent', + 'TextNotificationContent', + 'WhatsAppMessageTemplateBindings', + 'WhatsAppMessageTemplateBindingsButton', + 'WhatsAppMessageTemplateBindingsComponent', + 'WhatsAppMessageTemplateItem', + 'CommunicationMessageKind', + 'CommunicationMessagesChannel', + 'MessageTemplateBindingsKind', + 'MessageTemplateStatus', + 'MessageTemplateValueKind', + 'RepeatabilityResult', + 'WhatsAppMessageButtonSubType', +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/models/_enums.py b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_enums.py new file mode 100644 index 000000000000..ba0b05de2243 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_enums.py @@ -0,0 +1,88 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class CommunicationMessageKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of message. Supports text, image, template. + """ + + TEXT = "text" + """Text message type.""" + IMAGE = "image" + """Image message type.""" + TEMPLATE = "template" + """Template message type.""" + +class CommunicationMessagesChannel(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the communication messages channel. + """ + + WHATSAPP = "whatsApp" + """The WhatsApp communication messages channel type.""" + +class MessageTemplateBindingsKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the message template. + """ + + WHATSAPP = "whatsApp" + """The WhatsApp template type.""" + +class MessageTemplateStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The aggregated template status. + """ + + APPROVED = "approved" + """Message template is approved.""" + REJECTED = "rejected" + """Message template is rejected.""" + PENDING = "pending" + """Message template is pending.""" + PAUSED = "paused" + """Message template is paused.""" + +class MessageTemplateValueKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of the template parameter. + """ + + TEXT = "text" + """The text template parameter type.""" + IMAGE = "image" + """The image template parameter type.""" + DOCUMENT = "document" + """The document template parameter type.""" + VIDEO = "video" + """The video template parameter type.""" + LOCATION = "location" + """The location template parameter type.""" + QUICK_ACTION = "quickAction" + """The quick action template parameter type.""" + +class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Repeatability Result header options. + """ + + ACCEPTED = "accepted" + """If the request was accepted and the server guarantees that the server state reflects a single + execution of the operation.""" + REJECTED = "rejected" + """If the request was rejected because the combination of Repeatability-First-Sent and + Repeatability-Request-ID were invalid + or because the Repeatability-First-Sent value was outside the range of values held by the + server.""" + +class WhatsAppMessageButtonSubType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The WhatsApp button sub type. + """ + + QUICK_REPLY = "quickReply" + """The WhatsApp button sub type is quick reply.""" + URL = "url" + """The WhatsApp button sub type is url.""" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/models/_models.py b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_models.py new file mode 100644 index 000000000000..635dfc839741 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_models.py @@ -0,0 +1,916 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, Dict, List, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_discriminator, rest_field +from ._enums import (CommunicationMessageKind, + CommunicationMessagesChannel, + MessageTemplateBindingsKind, + MessageTemplateValueKind) + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class NotificationContent(_model_base.Model): + """Details of the message to send. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + ImageNotificationContent, TemplateNotificationContent, TextNotificationContent + + All required parameters must be populated in order to send to server. + + :ivar channel_registration_id: The Channel Registration ID for the Business Identifier. + Required. + :vartype channel_registration_id: str + :ivar to: The native external platform user identifiers of the recipient. Required. + :vartype to: list[str] + :ivar kind: The type discriminator describing a notification type. Required. Known values are: + "text", "image", and "template". + :vartype kind: str or ~azure.communication.messages.models.CommunicationMessageKind + """ + + __mapping__: Dict[str, _model_base.Model] = {} + channel_registration_id: str = rest_field(name="channelRegistrationId") + """The Channel Registration ID for the Business Identifier. Required.""" + to: List[str] = rest_field() + """The native external platform user identifiers of the recipient. Required.""" + kind: str = rest_discriminator(name="kind") + """The type discriminator describing a notification type. Required. Known values are: \"text\", + \"image\", and \"template\".""" + + + @overload + def __init__( + self, + *, + channel_registration_id: str, + to: List[str], + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ImageNotificationContent(NotificationContent, discriminator='image'): + """A request to send a media image notification. + + All required parameters must be populated in order to send to server. + + :ivar channel_registration_id: The Channel Registration ID for the Business Identifier. + Required. + :vartype channel_registration_id: str + :ivar to: The native external platform user identifiers of the recipient. Required. + :vartype to: list[str] + :ivar kind: Message notification type is image. Required. Image message type. + :vartype kind: str or ~azure.communication.messages.models.IMAGE + :ivar content: Optional text content. + :vartype content: str + :ivar media_uri: A media url for the image file. Required if the type is one of the supported media + types, e.g. image. Required. + :vartype media_uri: str + """ + + kind: Literal[CommunicationMessageKind.IMAGE] = rest_discriminator(name="kind") # type: ignore + """Message notification type is image. Required. Image message type.""" + content: Optional[str] = rest_field() + """Optional text content.""" + media_uri: str = rest_field(name="mediaUri") + """A media url for the file. Required if the type is one of the supported media types, e.g. image. + Required.""" + + + @overload + def __init__( + self, + *, + channel_registration_id: str, + to: List[str], + media_uri: str, + content: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=CommunicationMessageKind.IMAGE, **kwargs) + + +class MessageReceipt(_model_base.Model): + """Receipt of the sending one message. + + All required parameters must be populated in order to send to server. + + :ivar message_id: The message id. Required. + :vartype message_id: str + :ivar to: The native external platform user identifier of the recipient. Required. + :vartype to: str + """ + + message_id: str = rest_field(name="messageId") + """The message id. Required.""" + to: str = rest_field() + """The native external platform user identifier of the recipient. Required.""" + + + @overload + def __init__( + self, + *, + message_id: str, + to: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MessageTemplate(_model_base.Model): + """The template object used to create templates. + + All required parameters must be populated in order to send to server. + + :ivar name: Name of the template. Required. + :vartype name: str + :ivar language: The template's language, in the ISO 639 format, consist of a two-letter + language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required. + :vartype language: str + :ivar template_values: The template values. + :vartype template_values: list[~azure.communication.messages.models.MessageTemplateValue] + :ivar bindings: The binding object to link values to the template specific locations. + :vartype bindings: ~azure.communication.messages.models.MessageTemplateBindings + """ + + name: str = rest_field() + """Name of the template. Required.""" + language: str = rest_field() + """The template's language, in the ISO 639 format, consist of a two-letter language code followed + by an optional two-letter country code, e.g., 'en' or 'en_US'. Required.""" + template_values: Optional[List["_models.MessageTemplateValue"]] = rest_field(name="values") + """The template values.""" + bindings: Optional["_models.MessageTemplateBindings"] = rest_field() + """The binding object to link values to the template specific locations.""" + + + @overload + def __init__( + self, + *, + name: str, + language: str, + template_values: Optional[List["_models.MessageTemplateValue"]] = None, + bindings: Optional["_models.MessageTemplateBindings"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MessageTemplateBindings(_model_base.Model): + """The binding object to link values to the template specific locations. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + WhatsAppMessageTemplateBindings + + All required parameters must be populated in order to send to server. + + :ivar kind: The type discriminator describing a template bindings type. Required. "whatsApp" + :vartype kind: str or ~azure.communication.messages.models.MessageTemplateBindingsKind + """ + + __mapping__: Dict[str, _model_base.Model] = {} + kind: str = rest_discriminator(name="kind") + """The type discriminator describing a template bindings type. Required. \"whatsApp\"""" + + + @overload + def __init__( + self, + *, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MessageTemplateValue(_model_base.Model): + """The class describes a parameter of a template. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + MessageTemplateDocument, MessageTemplateImage, MessageTemplateLocation, + MessageTemplateQuickAction, MessageTemplateText, MessageTemplateVideo + + All required parameters must be populated in order to send to server. + + :ivar name: Template binding reference name. Required. + :vartype name: str + :ivar kind: The type discriminator describing a template parameter type. Required. Known values + are: "text", "image", "document", "video", "location", and "quickAction". + :vartype kind: str or ~azure.communication.messages.models.MessageTemplateValueKind + """ + + __mapping__: Dict[str, _model_base.Model] = {} + name: str = rest_field() + """Template binding reference name. Required.""" + kind: str = rest_discriminator(name="kind") + """The type discriminator describing a template parameter type. Required. Known values are: + \"text\", \"image\", \"document\", \"video\", \"location\", and \"quickAction\".""" + + + @overload + def __init__( + self, + *, + name: str, + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MessageTemplateDocument(MessageTemplateValue, discriminator='document'): + """The message template's document value information. + + All required parameters must be populated in order to send to server. + + :ivar name: Template binding reference name. Required. + :vartype name: str + :ivar kind: Message parameter type is document. Required. The document template parameter type. + :vartype kind: str or ~azure.communication.messages.models.DOCUMENT + :ivar url: The (public) URL of the media. Required. + :vartype url: str + :ivar caption: The [optional] caption of the media object. + :vartype caption: str + :ivar file_name: The [optional] filename of the media file. + :vartype file_name: str + """ + + kind: Literal[MessageTemplateValueKind.DOCUMENT] = rest_discriminator(name="kind") # type: ignore + """Message parameter type is document. Required. The document template parameter type.""" + url: str = rest_field() + """The (public) URL of the media. Required.""" + caption: Optional[str] = rest_field() + """The [optional] caption of the media object.""" + file_name: Optional[str] = rest_field(name="fileName") + """The [optional] filename of the media file.""" + + + @overload + def __init__( + self, + *, + name: str, + url: str, + caption: Optional[str] = None, + file_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateValueKind.DOCUMENT, **kwargs) + + +class MessageTemplateImage(MessageTemplateValue, discriminator='image'): + """The message template's image value information. + + All required parameters must be populated in order to send to server. + + :ivar name: Template binding reference name. Required. + :vartype name: str + :ivar kind: Message parameter type is image. Required. The image template parameter type. + :vartype kind: str or ~azure.communication.messages.models.IMAGE + :ivar url: The (public) URL of the media. Required. + :vartype url: str + :ivar caption: The [optional] caption of the media object. + :vartype caption: str + :ivar file_name: The [optional] filename of the media file. + :vartype file_name: str + """ + + kind: Literal[MessageTemplateValueKind.IMAGE] = rest_discriminator(name="kind") # type: ignore + """Message parameter type is image. Required. The image template parameter type.""" + url: str = rest_field() + """The (public) URL of the media. Required.""" + caption: Optional[str] = rest_field() + """The [optional] caption of the media object.""" + file_name: Optional[str] = rest_field(name="fileName") + """The [optional] filename of the media file.""" + + + @overload + def __init__( + self, + *, + name: str, + url: str, + caption: Optional[str] = None, + file_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateValueKind.IMAGE, **kwargs) + +class MessageTemplateItem(_model_base.Model): + """The message template as returned from the service. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + WhatsAppMessageTemplateItem + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar name: The template's name. Required. + :vartype name: str + :ivar language: The template's language, in the ISO 639 format, consist of a two-letter + language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required. + :vartype language: str + :ivar status: The aggregated template status. Required. Known values are: "approved", + "rejected", "pending", and "paused". + :vartype status: str or ~azure.communication.messages.models.MessageTemplateStatus + :ivar kind: The type discriminator describing a template type. Required. "whatsApp" + :vartype kind: str or ~azure.communication.messages.models.CommunicationMessagesChannel + """ + + __mapping__: Dict[str, _model_base.Model] = {} + name: str = rest_field(visibility=["read"]) + """The template's name. Required.""" + language: str = rest_field() + """The template's language, in the ISO 639 format, consist of a two-letter language code followed + by an optional two-letter country code, e.g., 'en' or 'en_US'. Required.""" + status: Union[str, "_models.MessageTemplateStatus"] = rest_field() + """The aggregated template status. Required. Known values are: \"approved\", \"rejected\", + \"pending\", and \"paused\".""" + kind: str = rest_discriminator(name="kind") + """The type discriminator describing a template type. Required. \"whatsApp\"""" + + + @overload + def __init__( + self, + *, + language: str, + status: Union[str, "_models.MessageTemplateStatus"], + kind: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MessageTemplateLocation(MessageTemplateValue, discriminator='location'): + """The message template's location value information. + + All required parameters must be populated in order to send to server. + + :ivar name: Template binding reference name. Required. + :vartype name: str + :ivar kind: Message parameter type is location. Required. The location template parameter type. + :vartype kind: str or ~azure.communication.messages.models.LOCATION + :ivar location_name: The [Optional] name of the location. + :vartype location_name: str + :ivar address: The [Optional] address of the location. + :vartype address: str + :ivar latitude: The latitude of the location. Required. + :vartype latitude: float + :ivar longitude: The longitude of the location. Required. + :vartype longitude: float + """ + + kind: Literal[MessageTemplateValueKind.LOCATION] = rest_discriminator(name="kind") # type: ignore + """Message parameter type is location. Required. The location template parameter type.""" + location_name: Optional[str] = rest_field(name="locationName") + """The [Optional] name of the location.""" + address: Optional[str] = rest_field() + """The [Optional] address of the location.""" + latitude: float = rest_field() + """The latitude of the location. Required.""" + longitude: float = rest_field() + """The longitude of the location. Required.""" + + + @overload + def __init__( + self, + *, + name: str, + latitude: float, + longitude: float, + location_name: Optional[str] = None, + address: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateValueKind.LOCATION, **kwargs) + + +class MessageTemplateQuickAction(MessageTemplateValue, discriminator='quickAction'): + """The message template's quick action value information. + + All required parameters must be populated in order to send to server. + + :ivar name: Template binding reference name. Required. + :vartype name: str + :ivar kind: Message parameter type is quick action. Required. The quick action template + parameter type. + :vartype kind: str or ~azure.communication.messages.models.QUICK_ACTION + :ivar text: The [Optional] quick action text. + :vartype text: str + :ivar payload: The [Optional] quick action payload. + :vartype payload: str + """ + + kind: Literal[MessageTemplateValueKind.QUICK_ACTION] = rest_discriminator(name="kind") # type: ignore + """Message parameter type is quick action. Required. The quick action template parameter type.""" + text: Optional[str] = rest_field() + """The [Optional] quick action text.""" + payload: Optional[str] = rest_field() + """The [Optional] quick action payload.""" + + + @overload + def __init__( + self, + *, + name: str, + text: Optional[str] = None, + payload: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateValueKind.QUICK_ACTION, **kwargs) + + +class MessageTemplateText(MessageTemplateValue, discriminator='text'): + """The message template's text value information. + + All required parameters must be populated in order to send to server. + + :ivar name: Template binding reference name. Required. + :vartype name: str + :ivar kind: Message parameter type is text. Required. The text template parameter type. + :vartype kind: str or ~azure.communication.messages.models.TEXT + :ivar text: The text value. Required. + :vartype text: str + """ + + kind: Literal[MessageTemplateValueKind.TEXT] = rest_discriminator(name="kind") # type: ignore + """Message parameter type is text. Required. The text template parameter type.""" + text: str = rest_field() + """The text value. Required.""" + + + @overload + def __init__( + self, + *, + name: str, + text: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateValueKind.TEXT, **kwargs) + + +class MessageTemplateVideo(MessageTemplateValue, discriminator='video'): + """The message template's video value information. + + All required parameters must be populated in order to send to server. + + :ivar name: Template binding reference name. Required. + :vartype name: str + :ivar kind: Message parameter type is video. Required. The video template parameter type. + :vartype kind: str or ~azure.communication.messages.models.VIDEO + :ivar url: The (public) URL of the media. Required. + :vartype url: str + :ivar caption: The [optional] caption of the media object. + :vartype caption: str + :ivar file_name: The [optional] filename of the media file. + :vartype file_name: str + """ + + kind: Literal[MessageTemplateValueKind.VIDEO] = rest_discriminator(name="kind") # type: ignore + """Message parameter type is video. Required. The video template parameter type.""" + url: str = rest_field() + """The (public) URL of the media. Required.""" + caption: Optional[str] = rest_field() + """The [optional] caption of the media object.""" + file_name: Optional[str] = rest_field(name="fileName") + """The [optional] filename of the media file.""" + + + @overload + def __init__( + self, + *, + name: str, + url: str, + caption: Optional[str] = None, + file_name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateValueKind.VIDEO, **kwargs) + + +class SendMessageResult(_model_base.Model): + """Result of the send message operation. + + All required parameters must be populated in order to send to server. + + :ivar receipts: Receipts of the send message operation. Required. + :vartype receipts: list[~azure.communication.messages.models.MessageReceipt] + """ + + receipts: List["_models.MessageReceipt"] = rest_field() + """Receipts of the send message operation. Required.""" + + + @overload + def __init__( + self, + *, + receipts: List["_models.MessageReceipt"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TemplateNotificationContent(NotificationContent, discriminator='template'): + """A request to send a template notification. + + All required parameters must be populated in order to send to server. + + :ivar channel_registration_id: The Channel Registration ID for the Business Identifier. + Required. + :vartype channel_registration_id: str + :ivar to: The native external platform user identifiers of the recipient. Required. + :vartype to: list[str] + :ivar kind: Message notification type is template. Required. Template message type. + :vartype kind: str or ~azure.communication.messages.models.TEMPLATE + :ivar template: The template object used to create templates. Required. + :vartype template: ~azure.communication.messages.models.MessageTemplate + """ + + kind: Literal[CommunicationMessageKind.TEMPLATE] = rest_discriminator(name="kind") # type: ignore + """Message notification type is template. Required. Template message type.""" + template: "_models.MessageTemplate" = rest_field() + """The template object used to create templates. Required.""" + + + @overload + def __init__( + self, + *, + channel_registration_id: str, + to: List[str], + template: "_models.MessageTemplate", + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=CommunicationMessageKind.TEMPLATE, **kwargs) + + +class TextNotificationContent(NotificationContent, discriminator='text'): + """A request to send a text notification. + + All required parameters must be populated in order to send to server. + + :ivar channel_registration_id: The Channel Registration ID for the Business Identifier. + Required. + :vartype channel_registration_id: str + :ivar to: The native external platform user identifiers of the recipient. Required. + :vartype to: list[str] + :ivar kind: Message notification type is text. Required. Text message type. + :vartype kind: str or ~azure.communication.messages.models.TEXT + :ivar content: Message content. Required. + :vartype content: str + """ + + kind: Literal[CommunicationMessageKind.TEXT] = rest_discriminator(name="kind") # type: ignore + """Message notification type is text. Required. Text message type.""" + content: str = rest_field() + """Message content. Required.""" + + + @overload + def __init__( + self, + *, + channel_registration_id: str, + to: List[str], + content: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=CommunicationMessageKind.TEXT, **kwargs) + +class WhatsAppMessageTemplateBindings(MessageTemplateBindings, discriminator='whatsApp'): + """The template bindings for WhatsApp. + + All required parameters must be populated in order to send to server. + + :ivar kind: MessageTemplateBindings is whatsApp. Required. The WhatsApp template type. + :vartype kind: str or ~azure.communication.messages.models.WHATSAPP + :ivar header: The header template bindings. + :vartype header: + list[~azure.communication.messages.models.WhatsAppMessageTemplateBindingsComponent] + :ivar body: The body template bindings. + :vartype body: + list[~azure.communication.messages.models.WhatsAppMessageTemplateBindingsComponent] + :ivar footer: The footer template bindings. + :vartype footer: + list[~azure.communication.messages.models.WhatsAppMessageTemplateBindingsComponent] + :ivar buttons: The button template bindings. + :vartype buttons: + list[~azure.communication.messages.models.WhatsAppMessageTemplateBindingsButton] + """ + + kind: Literal[MessageTemplateBindingsKind.WHATSAPP] = rest_discriminator(name="kind") # type: ignore + """MessageTemplateBindings is whatsApp. Required. The WhatsApp template type.""" + header: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = rest_field() + """The header template bindings.""" + body: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = rest_field() + """The body template bindings.""" + footer: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = rest_field() + """The footer template bindings.""" + buttons: Optional[List["_models.WhatsAppMessageTemplateBindingsButton"]] = rest_field() + """The button template bindings.""" + + + @overload + def __init__( + self, + *, + header: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = None, + body: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = None, + footer: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = None, + buttons: Optional[List["_models.WhatsAppMessageTemplateBindingsButton"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateBindingsKind.WHATSAPP, **kwargs) + +class WhatsAppMessageTemplateBindingsButton(_model_base.Model): + """The template bindings component button for WhatsApp. + + All required parameters must be populated in order to send to server. + + :ivar sub_type: The WhatsApp button sub type. Required. Known values are: "quickReply" and + "url". + :vartype sub_type: str or ~azure.communication.messages.models.WhatsAppMessageButtonSubType + :ivar ref_value: The name of the referenced item in the template values. Required. + :vartype ref_value: str + """ + + sub_type: Union[str, "_models.WhatsAppMessageButtonSubType"] = rest_field(name="subType") + """The WhatsApp button sub type. Required. Known values are: \"quickReply\" and \"url\".""" + ref_value: str = rest_field(name="refValue") + """The name of the referenced item in the template values. Required.""" + + + @overload + def __init__( + self, + *, + sub_type: Union[str, "_models.WhatsAppMessageButtonSubType"], + ref_value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + +class WhatsAppMessageTemplateBindingsComponent(_model_base.Model): + """The template bindings component for WhatsApp. + + All required parameters must be populated in order to send to server. + + :ivar ref_value: The name of the referenced item in the template values. Required. + :vartype ref_value: str + """ + + ref_value: str = rest_field(name="refValue") + """The name of the referenced item in the template values. Required.""" + + + @overload + def __init__( + self, + *, + ref_value: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + +class WhatsAppMessageTemplateItem(MessageTemplateItem, discriminator='whatsApp'): + """The WhatsApp-specific template response contract. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar name: The template's name. Required. + :vartype name: str + :ivar language: The template's language, in the ISO 639 format, consist of a two-letter + language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required. + :vartype language: str + :ivar status: The aggregated template status. Required. Known values are: "approved", + "rejected", "pending", and "paused". + :vartype status: str or ~azure.communication.messages.models.MessageTemplateStatus + :ivar content: WhatsApp platform's template content. This is the payload returned from WhatsApp + API. + :vartype content: any + :ivar kind: Message template response type is whatsApp. Required. The WhatsApp communication + messages channel type. + :vartype kind: str or ~azure.communication.messages.models.WHATSAPP + """ + + content: Optional[Any] = rest_field() + """WhatsApp platform's template content. This is the payload returned from WhatsApp API.""" + kind: Literal[CommunicationMessagesChannel.WHATSAPP] = rest_discriminator(name="kind") # type: ignore + """Message template response type is whatsApp. Required. The WhatsApp communication messages + channel type.""" + + + @overload + def __init__( + self, + *, + language: str, + status: Union[str, "_models.MessageTemplateStatus"], + content: Optional[Any] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + super().__init__(*args, kind=CommunicationMessagesChannel.WHATSAPP, **kwargs) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/models/_patch.py b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/py.typed b/sdk/communication/azure-communication-messages/azure/communication/messages/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/dev_requirements.txt b/sdk/communication/azure-communication-messages/dev_requirements.txt new file mode 100644 index 000000000000..9222a2a6b95b --- /dev/null +++ b/sdk/communication/azure-communication-messages/dev_requirements.txt @@ -0,0 +1,8 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp +aiounittest>=1.4 +pytest-tornasync==0.6.0.post2 +retry>=0.9.2 \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/pyproject.toml b/sdk/communication/azure-communication-messages/pyproject.toml new file mode 100644 index 000000000000..7e21996d4317 --- /dev/null +++ b/sdk/communication/azure-communication-messages/pyproject.toml @@ -0,0 +1,4 @@ +[tool.azure-sdk-build] +pyright = false +type_check_samples = false +verifytypes = false diff --git a/sdk/communication/azure-communication-messages/pytest.ini b/sdk/communication/azure-communication-messages/pytest.ini new file mode 100644 index 000000000000..d280de047e8d --- /dev/null +++ b/sdk/communication/azure-communication-messages/pytest.ini @@ -0,0 +1,2 @@ +[pytest] +asyncio_mode = auto \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/samples/get_templates_list.py b/sdk/communication/azure-communication-messages/samples/get_templates_list.py new file mode 100644 index 000000000000..7c8f71b12f51 --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/get_templates_list.py @@ -0,0 +1,49 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: get_templates_list.py + +DESCRIPTION: + This sample demonstrates fetching WhatsApp templates created in your WhatsApp Business account. The NotificationMessageClient is + authenticated using a connection string. +USAGE: + python get_templates_list.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import os +import sys + +sys.path.append("..") + +class GetTemplatesSample(object): + + connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") + channel_id = os.getenv("WHATSAPP_CHANNEL_ID") + + def get_templates_list(self): + + from azure.communication.messages import MessageTemplateClient + from azure.communication.messages.models import ( TextNotificationContent ) + + message_template_client = MessageTemplateClient.from_connection_string(self.connection_string) + + # calling send() with whatsapp message details + template_list = message_template_client.list_templates(self.channel_id) + + count_templates = len(list(template_list)) + print("Successfully retrieved {} templates from channel_id {}." + .format(count_templates, self.channel_id)) + +if __name__ == '__main__': + sample = GetTemplatesSample() + sample.get_templates_list() diff --git a/sdk/communication/azure-communication-messages/samples/get_templates_list_async.py b/sdk/communication/azure-communication-messages/samples/get_templates_list_async.py new file mode 100644 index 000000000000..4114851b5a75 --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/get_templates_list_async.py @@ -0,0 +1,53 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: get_templates_list_async.py + +DESCRIPTION: + This sample demonstrates fetching WhatsApp templates created in your WhatsApp Business account. The NotificationMessageClient is + authenticated using a connection string. +USAGE: + python get_templates_list_async.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import asyncio +import os +import sys + +sys.path.append("..") + +class GetTemplatesSampleAsync(object): + + connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") + channel_id = os.getenv("WHATSAPP_CHANNEL_ID") + + async def get_templates_list_async(self): + + from azure.communication.messages.aio import MessageTemplateClient + + message_template_client = MessageTemplateClient.from_connection_string(self.connection_string) + + # calling send() with whatsapp message details + async with message_template_client: + template_list = message_template_client.list_templates(self.channel_id) + async_list_data = [x async for x in template_list] + count_templates = len(list(async_list_data)) + print("Successfully retrieved {} templates from channel_id {}." + .format(count_templates, self.channel_id)) + +async def main(): + sample = GetTemplatesSampleAsync() + await sample.get_templates_list_async() + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_image_notification_messages.py b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages.py new file mode 100644 index 000000000000..5f2b10fd0f08 --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages.py @@ -0,0 +1,57 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: send_image_notification_messages.py + +DESCRIPTION: + This sample demonstrates sending an Whatsapp message with image from business phone number to a single user. The NotificationMessageClient is + authenticated using a connection string. +USAGE: + python send_image_notification_messages.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities. Use list for recipient phone number. + 3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import os +import sys + +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_image_send_message(self): + + from azure.communication.messages import NotificationMessagesClient + from azure.communication.messages.models import ImageNotificationContent + + messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string) + + image_options = ImageNotificationContent( + channel_registration_id=self.channel_id, + to=[self.phone_number], + content="Hello World via Notification Messaging SDK.", + media_uri="https://aka.ms/acsicon1" + ) + + # calling send() with whatsapp message details + message_responses = messaging_client.send(image_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_image_send_message() diff --git a/sdk/communication/azure-communication-messages/samples/send_image_notification_messages_async.py b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages_async.py new file mode 100644 index 000000000000..e1260c87e171 --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages_async.py @@ -0,0 +1,64 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: send_image_notification_messages_async.py + +DESCRIPTION: + This sample demonstrates sending an Whatsapp message with image from business phone number to a single user. The NotificationMessageClient is + authenticated using a connection string. + +USAGE: + python send_image_notification_messages_async.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities + 3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import asyncio +import os +import sys + +sys.path.append("..") + +class SendWhatsAppMessageSampleAsync(object): + + connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") + phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") + channel_id = os.getenv("WHATSAPP_CHANNEL_ID") + + async def send_image_send_message_async(self): + from azure.communication.messages.aio import NotificationMessagesClient + from azure.communication.messages.models import ImageNotificationContent + + # client creation + messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string) + + image_options = ImageNotificationContent( + channel_registration_id=self.channel_id, + to= [self.phone_number], + content="Hello World via Notification Messaging SDK.", + media_uri="https://aka.ms/acsicon1" + ) + + # calling send() with whatsapp message details + async with messaging_client: + message_responses = await messaging_client.send(image_options) + response = message_responses.receipts[0] + print("Message with message id {} was successful sent to {}" + .format(response.message_id, response.to)) + +async def main(): + sample = SendWhatsAppMessageSampleAsync() + await sample.send_image_send_message_async() + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_template_notification_messages.py b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages.py new file mode 100644 index 000000000000..cc96ca387ccc --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages.py @@ -0,0 +1,61 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: send_template_notification_messages.py + +DESCRIPTION: + This sample demonstrates sending an Whatsapp template message from business phone number to a single user. + Template to be used in the sample needs to be created in WhatsApp Business account first. + Follow the instructions in the Meta Business Help Center at https://www.facebook.com/business/help/2055875911147364?id=2129163877102343. + The NotificationMessageClient is authenticated using a connection string. +USAGE: + python send_template_notification_messages.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities. Use list for recipient phone number. + 3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import os +import sys + +sys.path.append("..") + +class SendWhatsAppTemplateMessageSample(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_template_send_message(self): + + from azure.communication.messages import NotificationMessagesClient + from azure.communication.messages.models import TemplateNotificationContent, MessageTemplate + + messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string) + + # Setting template options + input_template: MessageTemplate = MessageTemplate( + name="gathering_invitation", # Name of the WhatsApp Template + language="ca") # Language of the WhatsApp Template + template_options = TemplateNotificationContent( + channel_registration_id= self.channel_id, + to=[self.phone_number], + template=input_template) + + # calling send() with whatsapp message details + message_responses = messaging_client.send(template_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 = SendWhatsAppTemplateMessageSample() + sample.send_template_send_message() diff --git a/sdk/communication/azure-communication-messages/samples/send_template_notification_messages_async.py b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages_async.py new file mode 100644 index 000000000000..43412257e225 --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages_async.py @@ -0,0 +1,66 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: send_template_notification_messages_async.py + +DESCRIPTION: + This sample demonstrates sending an Whatsapp template message from business phone number to a single user. + Template to be used in the sample needs to be created in WhatsApp Business account first. + Follow the instructions in the Meta Business Help Center at https://www.facebook.com/business/help/2055875911147364?id=2129163877102343. + The NotificationMessageClient is authenticated using a connection string. +USAGE: + python send_template_notification_messages_async.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities. Use list for recipient phone number. + 3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import asyncio +import os +import sys + +sys.path.append("..") + +class SendWhatsAppTemplateMessageSampleAsync(object): + + connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") + phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") + channel_id = os.getenv("WHATSAPP_CHANNEL_ID") + + async def send_template_send_message_async(self): + from azure.communication.messages.aio import NotificationMessagesClient + from azure.communication.messages.models import TemplateNotificationContent, MessageTemplate + + messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string) + + # Setting template options + input_template: MessageTemplate = MessageTemplate( + name="gathering_invitation", # Name of the WhatsApp Template + language="ca") # Language of the WhatsApp Template + template_options = TemplateNotificationContent( + channel_registration_id= self.channel_id, + to=[self.phone_number], + template=input_template) + + # calling send() with whatsapp message details + async with messaging_client: + message_responses =await messaging_client.send(template_options) + response = message_responses.receipts[0] + print("Message with message id {} was successful sent to {}" + .format(response.message_id, response.to)) + + +async def main(): + sample = SendWhatsAppTemplateMessageSampleAsync() + await sample.send_template_send_message_async() + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages.py b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages.py new file mode 100644 index 000000000000..cb229b4e3fab --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages.py @@ -0,0 +1,56 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: send_text_notification_messages.py + +DESCRIPTION: + This sample demonstrates sending an Whatsapp message from business phone number to a single user. The NotificationMessageClient is + authenticated using a connection string. +USAGE: + python send_text_notification_messages.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities. Use list for recipient phone number. + 3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import os +import sys + +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 + + messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string) + + 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() diff --git a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_async.py b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_async.py new file mode 100644 index 000000000000..3669995e623a --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_async.py @@ -0,0 +1,64 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: send_text_notification_messages_async.py + +DESCRIPTION: + This sample demonstrates sending an Whatsapp message from business phone number to a single user. The NotificationMessageClient is + authenticated using a connection string. + +USAGE: + python send_text_notification_messages_async.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities + 3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. +""" + +import asyncio +import os +import sys + +sys.path.append("..") + +class SendWhatsAppMessageSampleAsync(object): + + connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") + phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") + channel_id = os.getenv("WHATSAPP_CHANNEL_ID") + + async def send_text_send_message_async(self): + from azure.communication.messages.aio import NotificationMessagesClient + from azure.communication.messages.models import TextNotificationContent + + # client creation + messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string) + + 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 + async with messaging_client: + message_responses = await 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)) + + +async def main(): + sample = SendWhatsAppMessageSampleAsync() + await sample.send_text_send_message_async() + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_with_token_credentials.py b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_with_token_credentials.py new file mode 100644 index 000000000000..0e67babf40a7 --- /dev/null +++ b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_with_token_credentials.py @@ -0,0 +1,66 @@ +# 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. +# -------------------------------------------------------------------------- + +""" +FILE: send_text_notification_messages_with_token_credentials.py + +DESCRIPTION: + This sample demonstrates sending an Whatsapp message from business phone number to a single user. The NotificationMessageClient is + authenticated using Bearer TokenCredentials with azureidentity. + More information here: https://learn.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python +USAGE: + python send_text_notification_messages_with_token_credentials.py + + Set the environment variable with your own value before running the sample: + 1) COMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource + 2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities. Use list for recipient phone number. + 3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging. + 4) Follow defining environment variables for DefaultAzureCredentials as give here: + https://learn.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python#environment-variables + https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal + Variable name Value + AZURE_CLIENT_ID ID of a Microsoft Entra application + AZURE_TENANT_ID ID of the application's Microsoft Entra tenant + AZURE_CLIENT_SECRET one of the application's client secrets +""" + +import os +import sys + +sys.path.append("..") + +class SendWhatsAppMessageSample(object): + + endpoint_string = os.getenv("COMMUNICATION_SAMPLES_ENDPOINT_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 using Token credentials.", + ) + + # 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() diff --git a/sdk/communication/azure-communication-messages/sdk_packaging.toml b/sdk/communication/azure-communication-messages/sdk_packaging.toml new file mode 100644 index 000000000000..cd3aeef0db35 --- /dev/null +++ b/sdk/communication/azure-communication-messages/sdk_packaging.toml @@ -0,0 +1,7 @@ +[packaging] +auto_update = false +package_name = "azure-communication-messages" +package_pprint_name = "Communication Messages" +package_doc_id = "communication-messages" +is_stable = false +is_arm = false diff --git a/sdk/communication/azure-communication-messages/setup.py b/sdk/communication/azure-communication-messages/setup.py new file mode 100644 index 000000000000..7429140abb45 --- /dev/null +++ b/sdk/communication/azure-communication-messages/setup.py @@ -0,0 +1,71 @@ +# 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. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-communication-messages" +PACKAGE_PPRINT_NAME = "Communication Messages" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.communication", + ] + ), + include_package_data=True, + package_data={ + "azure.communication.messages": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.8", +) diff --git a/sdk/communication/azure-communication-messages/tests/_decorators_async.py b/sdk/communication/azure-communication-messages/tests/_decorators_async.py new file mode 100644 index 000000000000..c7514f1ed993 --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_decorators_async.py @@ -0,0 +1,42 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +import os +from typing import Callable, Any + +from devtools_testutils import is_live, is_live_and_not_recording, trim_kwargs_from_test_function +from azure.communication.messages._shared.utils import parse_connection_str + +class MessagesPreparersAsync(object): + + @staticmethod + def messages_test_decorator_async(func: Callable[[], object], **kwargs: Any): + async def wrapper(self, *args, **kwargs): + if is_live() or is_live_and_not_recording(): + self.connection_string = os.getenv("COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING") + endpoint, _ = parse_connection_str(self.connection_string) + self.resource_name = endpoint.split(".")[0] + + else: + self.connection_string = "endpoint=https://sanitized.unitedstates.communication.azure.com/;accesskey=fake===" + self.resource_name = "sanitized" + + return await func(self, *args, **kwargs) + + return wrapper + + @staticmethod + def messages_test_decorator_for_token_async(func: Callable[[], object], **kwargs: Any): + async def wrapper(self, *args, **kwargs): + breakpoint + if is_live() or is_live_and_not_recording(): + self.endpoint_str = os.getenv("COMMUNICATION_LIVETEST_DYNAMIC_ENDPOINT") + else: + self.endpoint = "sanitized.unitedstates.communication.azure.com" + + return await func(self, *args, **kwargs) + + return wrapper diff --git a/sdk/communication/azure-communication-messages/tests/_messages_test_case_async.py b/sdk/communication/azure-communication-messages/tests/_messages_test_case_async.py new file mode 100644 index 000000000000..5951f64a48bf --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_messages_test_case_async.py @@ -0,0 +1,36 @@ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +import asyncio +from abc import abstractmethod +from retry import retry +import warnings +from _shared.utils import get_http_logging_policy +from azure.communication.messages.aio import ( + NotificationMessagesClient, + MessageTemplateClient, +) +from devtools_testutils import AzureRecordedTestCase + +class AsyncMessagesRecordedTestCase(AzureRecordedTestCase): + + def create_notification_message_client(self) -> NotificationMessagesClient: + return NotificationMessagesClient.from_connection_string( + conn_str=self.connection_string, http_logging_policy=get_http_logging_policy() + ) + + def create_notification_message_client_from_token(self) -> NotificationMessagesClient: + return NotificationMessagesClient.from_token_credentials( + endpoint=self.endpoint_str, http_logging_policy=get_http_logging_policy() + ) + + def create_message_template_client(self) -> MessageTemplateClient: + return MessageTemplateClient.from_connection_string( + conn_str=self.connection_string, http_logging_policy=get_http_logging_policy() + ) + + def create_message_template_client_from_token(self) -> MessageTemplateClient: + return MessageTemplateClient.from_token_credentials( + endpoint=self.endpoint_str, http_logging_policy=get_http_logging_policy() + ) \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/tests/_shared/__init__.py b/sdk/communication/azure-communication-messages/tests/_shared/__init__.py new file mode 100644 index 000000000000..3b0cfe17e031 --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_shared/__init__.py @@ -0,0 +1,6 @@ +# 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. +# -------------------------------------------------------------------------- diff --git a/sdk/communication/azure-communication-messages/tests/_shared/async_fake_token_credential.py b/sdk/communication/azure-communication-messages/tests/_shared/async_fake_token_credential.py new file mode 100644 index 000000000000..b75e41256ff1 --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_shared/async_fake_token_credential.py @@ -0,0 +1,14 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +from azure.core.credentials import AccessToken + + +class AsyncFakeTokenCredential(object): + def __init__(self): + self.token = AccessToken("Fake Token", 0) + + async def get_token(self, *args, **kwargs): + return self.token diff --git a/sdk/communication/azure-communication-messages/tests/_shared/communication_service_preparer.py b/sdk/communication/azure-communication-messages/tests/_shared/communication_service_preparer.py new file mode 100644 index 000000000000..2502a4713a88 --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_shared/communication_service_preparer.py @@ -0,0 +1,13 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +import functools +from devtools_testutils import PowerShellPreparer + +CommunicationPreparer = functools.partial( + PowerShellPreparer, + "communication", + communication_livetest_dynamic_connection_string="endpoint=https://sanitized.communication.azure.com/;accesskey=fake===", +) diff --git a/sdk/communication/azure-communication-messages/tests/_shared/fake_token_credential.py b/sdk/communication/azure-communication-messages/tests/_shared/fake_token_credential.py new file mode 100644 index 000000000000..e4fc300141ac --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_shared/fake_token_credential.py @@ -0,0 +1,14 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +from azure.core.credentials import AccessToken + + +class FakeTokenCredential(object): + def __init__(self): + self.token = AccessToken("Fake Token", 0) + + def get_token(self, *args, **kwargs): + return self.token diff --git a/sdk/communication/azure-communication-messages/tests/_shared/helper.py b/sdk/communication/azure-communication-messages/tests/_shared/helper.py new file mode 100644 index 000000000000..efb530ff2a77 --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_shared/helper.py @@ -0,0 +1,19 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +import base64 +from datetime import datetime, timedelta + + +def generate_token_with_custom_expiry(valid_for_seconds): + return generate_token_with_custom_expiry_epoch((datetime.now() + timedelta(seconds=valid_for_seconds)).timestamp()) + + +def generate_token_with_custom_expiry_epoch(expires_on_epoch): + expiry_json = f'{{"exp": {str(expires_on_epoch)} }}' + base64expiry = base64.b64encode(expiry_json.encode("utf-8")).decode("utf-8").rstrip("=") + token_template = f"""eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. + {base64expiry}.adM-ddBZZlQ1WlN3pdPBOF5G4Wh9iZpxNP_fSvpF4cWs""" + return token_template diff --git a/sdk/communication/azure-communication-messages/tests/_shared/utils.py b/sdk/communication/azure-communication-messages/tests/_shared/utils.py new file mode 100644 index 000000000000..536e680d8fed --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/_shared/utils.py @@ -0,0 +1,79 @@ +# ------------------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# ------------------------------------------------------------------------- +import os +from typing import ( # pylint: disable=unused-import + cast, + Tuple, +) +from azure.core.pipeline.policies import HttpLoggingPolicy, HeadersPolicy + + +def create_token_credential(): + # type: () -> AsyncFakeTokenCredential or DefaultAzureCredential + from devtools_testutils import is_live + + if not is_live(): + from .fake_token_credential import FakeTokenCredential + + return FakeTokenCredential() + from azure.identity import DefaultAzureCredential + + return DefaultAzureCredential() + + +def async_create_token_credential(): + # type: () -> AsyncFakeTokenCredential or DefaultAzureCredential + + from devtools_testutils import is_live + + if not is_live(): + from .async_fake_token_credential import AsyncFakeTokenCredential + + return AsyncFakeTokenCredential() + from azure.identity.aio import DefaultAzureCredential + + return DefaultAzureCredential() + + +def get_http_logging_policy(**kwargs): + http_logging_policy = HttpLoggingPolicy(**kwargs) + http_logging_policy.allowed_header_names.update({"MS-CV"}) + return http_logging_policy + + +def get_header_policy(**kwargs): + header_policy = HeadersPolicy(**kwargs) + + useragent = os.getenv("AZURE_USERAGENT_OVERRIDE") + if useragent: + header_policy.add_header("x-ms-useragent", useragent) + + return header_policy + + +def parse_connection_str(conn_str:str) -> Tuple[str, str]: + if conn_str is None: + raise ValueError("Connection string is undefined.") + endpoint = None + shared_access_key = None + for element in conn_str.split(";"): + key, _, value = element.partition("=") + if key.lower() == "endpoint": + endpoint = value.rstrip("/") + elif key.lower() == "accesskey": + shared_access_key = value + if not all([endpoint, shared_access_key]): + raise ValueError( + "Invalid connection string. You can get the connection string from your resource page in the Azure Portal. " + "The format should be as follows: endpoint=https:///;accesskey=" + ) + left_slash_pos = cast(str, endpoint).find("//") + if left_slash_pos != -1: + host = cast(str, endpoint)[left_slash_pos + 2 :] + else: + host = str(endpoint) + + return host, str(shared_access_key) diff --git a/sdk/communication/azure-communication-messages/tests/conftest.py b/sdk/communication/azure-communication-messages/tests/conftest.py new file mode 100644 index 000000000000..57c030fe834b --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/conftest.py @@ -0,0 +1,91 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# cSpell:ignore ests +import pytest +import os +from devtools_testutils import ( + test_proxy, + add_header_regex_sanitizer, + set_default_session_settings, + add_body_key_sanitizer, + add_oauth_response_sanitizer, + add_general_string_sanitizer, + add_general_regex_sanitizer) +from azure.communication.messages._shared.utils import parse_connection_str + +# autouse=True will trigger this fixture on each pytest run, even if it's not explicitly used by a test method +@pytest.fixture(scope="session", autouse=True) +def start_proxy(test_proxy): + set_default_session_settings() + add_oauth_response_sanitizer() + + FAKE_CONNECTION_STRING = "endpoint=https://sanitized.unitedstates.communication.azure.com/;accesskey=fake===" + FAKE_ENDPOINT = "sanitized.unitedstates.communication.azure.com" + connection_str = os.environ.get('COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING', FAKE_CONNECTION_STRING) + if connection_str is not None: + endpoint, _ = parse_connection_str(connection_str) + resource_name = endpoint.split(".")[0] + add_general_string_sanitizer(target=resource_name, value="sanitized") + add_general_regex_sanitizer(regex=connection_str, value=FAKE_CONNECTION_STRING) + add_general_regex_sanitizer(regex=endpoint, value=FAKE_ENDPOINT) + + add_body_key_sanitizer(json_path="channel_registration_id", value="sanitized") + add_body_key_sanitizer(json_path="*.channel_registration_id", value="sanitized") + add_body_key_sanitizer(json_path="*..channel_registration_id", value="sanitized") + add_body_key_sanitizer(json_path="to", value="sanitized") + add_body_key_sanitizer(json_path="*.to", value="sanitized") + add_body_key_sanitizer(json_path="*..to", value="sanitized") + add_body_key_sanitizer(json_path="content", value="sanitized") + add_body_key_sanitizer(json_path="*.content", value="sanitized") + add_body_key_sanitizer(json_path="*..content", value="sanitized") + add_body_key_sanitizer(json_path="media_uri", value="sanitized") + add_body_key_sanitizer(json_path="*.media_uri", value="sanitized") + add_body_key_sanitizer(json_path="*..media_uri", value="sanitized") + add_body_key_sanitizer(json_path="repeatability-request-id", value="sanitized") + add_body_key_sanitizer(json_path="*.repeatability-request-id", value="sanitized") + add_body_key_sanitizer(json_path="*..repeatability-request-id", value="sanitized") + add_body_key_sanitizer(json_path="repeatability-first-sent", value="sanitized") + add_body_key_sanitizer(json_path="*.repeatability-first-sent", value="sanitized") + add_body_key_sanitizer(json_path="*..repeatability-first-sent", value="sanitized") + + + add_header_regex_sanitizer(key="P3P", value="sanitized") + add_header_regex_sanitizer(key="Set-Cookie", value="sanitized") + add_header_regex_sanitizer(key="Date", value="sanitized") + add_header_regex_sanitizer(key="Cookie", value="sanitized") + add_header_regex_sanitizer(key="client-request-id", value="sanitized") + add_header_regex_sanitizer(key="MS-CV", value="sanitized") + add_header_regex_sanitizer(key="X-Azure-Ref", value="sanitized") + add_header_regex_sanitizer(key="x-ms-content-sha256", value="sanitized") + add_header_regex_sanitizer(key="x-ms-client-request-id", value="sanitized") + add_header_regex_sanitizer(key="x-ms-date", value="sanitized") + add_header_regex_sanitizer(key="x-ms-ests-server", value="sanitized") + add_header_regex_sanitizer(key="x-ms-request-id", value="sanitized") + add_header_regex_sanitizer(key="Content-Security-Policy-Report-Only", value="sanitized") + add_header_regex_sanitizer(key="repeatability-first-sent", value="sanitized") + add_header_regex_sanitizer(key="repeatability-request-id", value="sanitized") + return \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/tests/test_messages_client_async.py b/sdk/communication/azure-communication-messages/tests/test_messages_client_async.py new file mode 100644 index 000000000000..5fcc64ac816a --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/test_messages_client_async.py @@ -0,0 +1,169 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +import os +import asyncio +from typing import List +from devtools_testutils.aio import recorded_by_proxy_async +from _decorators_async import MessagesPreparersAsync +from azure.core.credentials import AccessToken +from azure.communication.messages.aio import NotificationMessagesClient +from azure.communication.messages.models import ( + TextNotificationContent, + ImageNotificationContent, + TemplateNotificationContent, + MessageReceipt, + MessageTemplate, + MessageTemplateText, + MessageTemplateBindings, + MessageTemplateValue, + WhatsAppMessageTemplateBindings, + WhatsAppMessageTemplateBindingsComponent + ) +from _shared.utils import get_http_logging_policy +from _messages_test_case_async import AsyncMessagesRecordedTestCase +from azure.communication.messages._shared.utils import parse_connection_str + +class TestNotificationMessageClientForTextAsync(AsyncMessagesRecordedTestCase): + + @MessagesPreparersAsync.messages_test_decorator_async + @recorded_by_proxy_async + async def test_text_send_message_async(self): + phone_number: str = "+14254360097" + raised = False + + text_options = TextNotificationContent( + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", + to= [phone_number], + content="Thanks for your feedback Hello.") + + message_response : MessageReceipt = None + message_client: NotificationMessagesClient = self.create_notification_message_client() + + try: + async with message_client: + message_responses = await message_client.send(text_options) + message_response = message_responses.receipts[0] + except: + raised = True + raise + assert raised is False + assert message_response.message_id is not None + assert message_response.to is not None + + + @MessagesPreparersAsync.messages_test_decorator_async + @recorded_by_proxy_async + async def test_template_send_message_async(self): + phone_number: str = "+14254360097" + input_template: MessageTemplate = MessageTemplate( + name="gathering_invitation", + language="ca") + raised = False + + message_client: NotificationMessagesClient = self.create_notification_message_client() + + template_options = TemplateNotificationContent( + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", + to=[phone_number], + template=input_template) + + message_response : MessageReceipt = None + + try: + async with message_client: + message_responses = await message_client.send(template_options) + message_response = message_responses.receipts[0] + except: + raised = True + raise + assert raised is False + assert message_response.message_id is not None + assert message_response.to is not None + + + @MessagesPreparersAsync.messages_test_decorator_async + @recorded_by_proxy_async + async def test_template_with_parameters_send_message_async(self): + + phone_number: str = "+14254360097" + parammeter1 = MessageTemplateText ( + name="first", + text="11-18-2024" + ) + + input_template: MessageTemplate = MessageTemplate( + name="gathering_invitation", + language="en_US", + template_values= [parammeter1], + bindings=WhatsAppMessageTemplateBindings + ( + body= [ WhatsAppMessageTemplateBindingsComponent(ref_value="first")] + ) + ) + raised = False + + template_options = TemplateNotificationContent( + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", + to=[phone_number], + template=input_template) + + message_response : MessageReceipt = None + message_client: NotificationMessagesClient = self.create_notification_message_client() + + try: + async with message_client: + message_responses = await message_client.send(template_options) + message_response = message_responses.receipts[0] + except: + raised = True + raise + assert raised is False + assert message_response.message_id is not None + assert message_response.to is not None + + @MessagesPreparersAsync.messages_test_decorator_async + @recorded_by_proxy_async + async def test_image_send_message_async(self): + phone_number: str = "+14254360097" + input_media_uri: str = "https://aka.ms/acsicon1" + raised = False + + template_options = ImageNotificationContent( + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", + to=[phone_number], + media_uri=input_media_uri) + + message_response : MessageReceipt = None + message_client: NotificationMessagesClient = self.create_notification_message_client() + + try: + async with message_client: + message_responses = await message_client.send(template_options) + message_response = message_responses.receipts[0] + except: + raised = True + raise + assert raised is False + assert message_response.message_id is not None + assert message_response.to is not None + + + @MessagesPreparersAsync.messages_test_decorator_async + @recorded_by_proxy_async + async def test_download_media_async(self): + phone_number: str = "+14254360097" + input_media_id: str = "315a0b04-d80d-4573-bcf1-1ce33d3f19f0" + raised = False + message_client: NotificationMessagesClient = self.create_notification_message_client() + try: + async with message_client: + media_stream = await message_client.download_media(input_media_id) + except: + raised = True + raise + assert raised is False + assert media_stream is not None \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/tests/test_messages_template_client_async.py b/sdk/communication/azure-communication-messages/tests/test_messages_template_client_async.py new file mode 100644 index 000000000000..070494a878bd --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/test_messages_template_client_async.py @@ -0,0 +1,38 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +from devtools_testutils.aio import recorded_by_proxy_async +from _decorators_async import MessagesPreparersAsync +from azure.communication.messages.models import ( + MessageTemplateItem, + MessageTemplate + ) +from _shared.utils import get_http_logging_policy +from _messages_test_case_async import AsyncMessagesRecordedTestCase +from azure.communication.messages._shared.utils import parse_connection_str + +class TestMessageTemplateClientToGetTemplatesAsync(AsyncMessagesRecordedTestCase): + + @MessagesPreparersAsync.messages_test_decorator_async + @recorded_by_proxy_async + async def test_get_templates_async(self): + channel_id = "b045be8c-45cd-492a-b2a2-47bae7c36959" + raised = False + + message_template_client = self.create_message_template_client() + + try: + async with message_template_client: + message_template_item_list = message_template_client.list_templates(channel_id) + except: + raised = True + raise + + assert raised is False + assert message_template_item_list is not None + + + diff --git a/sdk/communication/azure-communication-messages/tests/unittest_helpers.py b/sdk/communication/azure-communication-messages/tests/unittest_helpers.py new file mode 100644 index 000000000000..9d24a0aa86eb --- /dev/null +++ b/sdk/communication/azure-communication-messages/tests/unittest_helpers.py @@ -0,0 +1,20 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +import json + +from unittest import mock + +def mock_response(status_code=200, headers=None, json_payload=None): + response = mock.Mock(status_code=status_code, headers=headers or {}) + if json_payload is not None: + response.text = lambda encoding=None: json.dumps(json_payload) + response.headers["content-type"] = "application/json" + response.content_type = "application/json" + else: + response.text = lambda encoding=None: "" + response.headers["content-type"] = "text/plain" + response.content_type = "text/plain" + return response diff --git a/sdk/communication/azure-communication-messages/tsp-location.yaml b/sdk/communication/azure-communication-messages/tsp-location.yaml new file mode 100644 index 000000000000..e8d5cb2bd4a1 --- /dev/null +++ b/sdk/communication/azure-communication-messages/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/communication/Communication.Messages +commit: 392938969db1bb682734600b9a5c0f0a30a95f58 +repo: Azure/azure-rest-api-specs +additionalDirectories: [] diff --git a/sdk/communication/ci.yml b/sdk/communication/ci.yml index 2c0acd5ed7df..512b572d04d0 100644 --- a/sdk/communication/ci.yml +++ b/sdk/communication/ci.yml @@ -51,4 +51,6 @@ extends: - name: azure-communication-jobrouter safeName: azurecommunicationjobrouter - name: azure-communication-callautomation - safeName: azurecommunicationcallautomation \ No newline at end of file + safeName: azurecommunicationcallautomation + - name: azure-communication-messages + safeName: azurecommunicationmessages \ No newline at end of file