diff --git a/sdk/communication/azure-communication-identity/CHANGELOG.md b/sdk/communication/azure-communication-identity/CHANGELOG.md index 26a278bcd6a3..e5b3d02f1713 100644 --- a/sdk/communication/azure-communication-identity/CHANGELOG.md +++ b/sdk/communication/azure-communication-identity/CHANGELOG.md @@ -1,15 +1,25 @@ # Release History -## 1.6.0 (Unreleased) +## 2.0.0 (Unreleased) ### Features Added +- Added support for service API version `2026-09-23`, which is now the default. This version is + functionally equivalent to `2025-06-30`. - Added support for a new communication identifier `TeamsExtensionUserIdentifier`. - New identifier maps rawIds with format `8:acs:{resourceId}_{tenantId}_{userId}`. - With this version, rawId starting with `8:acs` may be either `CommunicationUserIdentifier` or new `TeamsExtensionUserIdentifier`. - Added `IsAnonymous` and `AssertedId` properties to the communication identifier `PhoneNumberIdentifier`. - `IsAnonymous` is used for anonymous numbers with rawId equals to `4:anonymous`. - `AssertedId` is used when the same number is used several times in the same call. It contains value after the last underscore `_` character in the phone number. It is null otherwise. + +### Other Changes + +- The service layer is now generated from TypeSpec instead of Swagger/AutoRest. There are no + changes to the public API surface: method names, parameters, and return types are unchanged, + and `AccessToken.expires_on` continues to carry the expiry string exactly as returned by the + service. + ## 1.5.1 (Unreleased) ### Features Added diff --git a/sdk/communication/azure-communication-identity/MANIFEST.in b/sdk/communication/azure-communication-identity/MANIFEST.in index 7595ab04b9be..29aca041172f 100644 --- a/sdk/communication/azure-communication-identity/MANIFEST.in +++ b/sdk/communication/azure-communication-identity/MANIFEST.in @@ -1,7 +1,7 @@ include *.md -include azure/__init__.py -include azure/communication/__init__.py include LICENSE +include azure/communication/identity/py.typed recursive-include tests *.py recursive-include samples *.py *.md -include azure/communication/identity/py.typed +include azure/__init__.py +include azure/communication/__init__.py diff --git a/sdk/communication/azure-communication-identity/_metadata.json b/sdk/communication/azure-communication-identity/_metadata.json new file mode 100644 index 000000000000..08c05f1241b7 --- /dev/null +++ b/sdk/communication/azure-communication-identity/_metadata.json @@ -0,0 +1,11 @@ +{ + "apiVersion": "2026-09-23", + "apiVersions": { + "Azure.Communication.Identity": "2026-09-23" + }, + "commit": "1893171028aed5a757fc78c2d4aa439c14df4afc", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/communication/data-plane/Identity", + "emitterVersion": "0.63.6", + "httpClientPythonVersion": "^0.37.1" +} \ No newline at end of file diff --git a/sdk/communication/azure-communication-identity/api.md b/sdk/communication/azure-communication-identity/api.md new file mode 100644 index 000000000000..a75bf12c51ad --- /dev/null +++ b/sdk/communication/azure-communication-identity/api.md @@ -0,0 +1,2 @@ +```py +``` \ No newline at end of file diff --git a/sdk/communication/azure-communication-identity/api.metadata.yml b/sdk/communication/azure-communication-identity/api.metadata.yml new file mode 100644 index 000000000000..807cecc73bb7 --- /dev/null +++ b/sdk/communication/azure-communication-identity/api.metadata.yml @@ -0,0 +1,4 @@ +apiMdSha256: 4f975ce96bb34064e16820c7565f93dd884f6d02f76ad1b913a9ed1a8eff2e83 +packageVersion: 1.6.0 +parserVersion: 0.3.31 +pythonVersion: 3.13.15 diff --git a/sdk/communication/azure-communication-identity/apiview-properties.json b/sdk/communication/azure-communication-identity/apiview-properties.json new file mode 100644 index 000000000000..d60c90497e23 --- /dev/null +++ b/sdk/communication/azure-communication-identity/apiview-properties.json @@ -0,0 +1,37 @@ +{ + "CrossLanguagePackageId": "Azure.Communication.Identity", + "CrossLanguageDefinitionId": { + "azure.communication.identity.models.CommunicationError": "Azure.Communication.Identity.CommunicationError", + "azure.communication.identity.models.CommunicationErrorResponse": "Azure.Communication.Identity.CommunicationErrorResponse", + "azure.communication.identity.models.CommunicationIdentity": "Azure.Communication.Identity.CommunicationIdentity", + "azure.communication.identity.models.CommunicationIdentityAccessToken": "Azure.Communication.Identity.CommunicationIdentityAccessToken", + "azure.communication.identity.models.CommunicationIdentityAccessTokenRequest": "Azure.Communication.Identity.CommunicationIdentityAccessTokenRequest", + "azure.communication.identity.models.CommunicationIdentityAccessTokenResult": "Azure.Communication.Identity.CommunicationIdentityAccessTokenResult", + "azure.communication.identity.models.CommunicationIdentityCreateRequest": "Azure.Communication.Identity.CommunicationIdentityCreateRequest", + "azure.communication.identity.models.TeamsExtensionAssignmentCreateOrUpdateRequest": "Azure.Communication.Identity.TeamsExtensionAssignmentCreateOrUpdateRequest", + "azure.communication.identity.models.TeamsExtensionAssignmentResponse": "Azure.Communication.Identity.TeamsExtensionAssignmentResponse", + "azure.communication.identity.models.TeamsExtensionExchangeTokenRequest": "Azure.Communication.Identity.TeamsExtensionExchangeTokenRequest", + "azure.communication.identity.models.TeamsUserExchangeTokenRequest": "Azure.Communication.Identity.TeamsUserExchangeTokenRequest", + "azure.communication.identity.models.CommunicationTokenScope": "Azure.Communication.Identity.CommunicationIdentityTokenScope", + "azure.communication.identity.models.TeamsExtensionPrincipalType": "Azure.Communication.Identity.TeamsExtensionPrincipalType", + "azure.communication.identity.operations.IdentityOperationsOperations.create": "Azure.Communication.Identity.IdentityOperations.create", + "azure.communication.identity.aio.operations.IdentityOperationsOperations.create": "Azure.Communication.Identity.IdentityOperations.create", + "azure.communication.identity.operations.IdentityOperationsOperations.delete": "Azure.Communication.Identity.IdentityOperations.delete", + "azure.communication.identity.aio.operations.IdentityOperationsOperations.delete": "Azure.Communication.Identity.IdentityOperations.delete", + "azure.communication.identity.operations.IdentityOperationsOperations.revoke_access_tokens": "Azure.Communication.Identity.IdentityOperations.revokeAccessTokens", + "azure.communication.identity.aio.operations.IdentityOperationsOperations.revoke_access_tokens": "Azure.Communication.Identity.IdentityOperations.revokeAccessTokens", + "azure.communication.identity.operations.IdentityOperationsOperations.issue_access_token": "Azure.Communication.Identity.IdentityOperations.issueAccessToken", + "azure.communication.identity.aio.operations.IdentityOperationsOperations.issue_access_token": "Azure.Communication.Identity.IdentityOperations.issueAccessToken", + "azure.communication.identity.operations.TeamsUserOperationsOperations.exchange_teams_user_access_token": "Azure.Communication.Identity.TeamsUserOperations.exchangeTeamsUserAccessToken", + "azure.communication.identity.aio.operations.TeamsUserOperationsOperations.exchange_teams_user_access_token": "Azure.Communication.Identity.TeamsUserOperations.exchangeTeamsUserAccessToken", + "azure.communication.identity.operations.TeamsExtensionOperationsOperations.exchange_token": "Azure.Communication.Identity.TeamsExtensionOperations.exchangeToken", + "azure.communication.identity.aio.operations.TeamsExtensionOperationsOperations.exchange_token": "Azure.Communication.Identity.TeamsExtensionOperations.exchangeToken", + "azure.communication.identity.operations.TeamsExtensionOperationsOperations.get_assignment": "Azure.Communication.Identity.TeamsExtensionOperations.getAssignment", + "azure.communication.identity.aio.operations.TeamsExtensionOperationsOperations.get_assignment": "Azure.Communication.Identity.TeamsExtensionOperations.getAssignment", + "azure.communication.identity.operations.TeamsExtensionOperationsOperations.upsert_assignment": "Azure.Communication.Identity.TeamsExtensionOperations.upsertAssignment", + "azure.communication.identity.aio.operations.TeamsExtensionOperationsOperations.upsert_assignment": "Azure.Communication.Identity.TeamsExtensionOperations.upsertAssignment", + "azure.communication.identity.operations.TeamsExtensionOperationsOperations.delete_assignment": "Azure.Communication.Identity.TeamsExtensionOperations.deleteAssignment", + "azure.communication.identity.aio.operations.TeamsExtensionOperationsOperations.delete_assignment": "Azure.Communication.Identity.TeamsExtensionOperations.deleteAssignment" + }, + "CrossLanguageVersion": "6be142630ab4" +} \ No newline at end of file diff --git a/sdk/communication/azure-communication-identity/azure/__init__.py b/sdk/communication/azure-communication-identity/azure/__init__.py index 8db66d3d0f0f..d55ccad1f573 100644 --- a/sdk/communication/azure-communication-identity/azure/__init__.py +++ b/sdk/communication/azure-communication-identity/azure/__init__.py @@ -1 +1 @@ -__path__ = __import__("pkgutil").extend_path(__path__, __name__) +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/communication/azure-communication-identity/azure/communication/__init__.py b/sdk/communication/azure-communication-identity/azure/communication/__init__.py index 8db66d3d0f0f..d55ccad1f573 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/__init__.py +++ b/sdk/communication/azure-communication-identity/azure/communication/__init__.py @@ -1 +1 @@ -__path__ = __import__("pkgutil").extend_path(__path__, __name__) +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_api_versions.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_api_versions.py index 5e6ef85d3a83..3a5a5ac8f13b 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_api_versions.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_api_versions.py @@ -12,6 +12,8 @@ class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta): V2022_06_01 = "2022-06-01" V2022_10_01 = "2022-10-01" V2023_10_01 = "2023-10-01" + V2025_06_30 = "2025-06-30" + V2026_09_23 = "2026-09-23" -DEFAULT_VERSION = ApiVersion.V2023_10_01 +DEFAULT_VERSION = ApiVersion.V2026_09_23 diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_communication_identity_client.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_communication_identity_client.py index ea003e7c564e..2cfc1a97648c 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_communication_identity_client.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_communication_identity_client.py @@ -9,14 +9,21 @@ from azure.core.tracing.decorator import distributed_trace from azure.core.credentials import AccessToken from ._generated._client import ( - CommunicationIdentityClient as CommunicationIdentityClientGen, + IdentityClient as CommunicationIdentityClientGen, ) from ._shared.auth_policy_utils import get_authentication_policy from ._shared.utils import parse_connection_str from ._shared.models import CommunicationUserIdentifier from ._version import SDK_MONIKER from ._api_versions import DEFAULT_VERSION -from ._utils import convert_timedelta_to_mins +from ._utils import ( + _ACCEPT_JSON, + BodylessCreateContentTypePolicy, + build_token_request_body, + extract_create_content_type, + merge_headers, + to_access_token, +) from ._generated.models import CommunicationTokenScope if TYPE_CHECKING: @@ -56,20 +63,19 @@ def __init__( raise ValueError("You need to provide account shared key to authenticate.") self._endpoint = endpoint self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) + per_call_policies = list(kwargs.pop("per_call_policies", None) or []) + per_call_policies.append(BodylessCreateContentTypePolicy()) self._identity_service_client = CommunicationIdentityClientGen( self._endpoint, api_version=self._api_version, authentication_policy=get_authentication_policy(endpoint, credential), sdk_moniker=SDK_MONIKER, + per_call_policies=per_call_policies, **kwargs ) @classmethod - def from_connection_string( - cls, - conn_str: str, - **kwargs: Any - ) -> "CommunicationIdentityClient": + def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "CommunicationIdentityClient": """Create CommunicationIdentityClient from a Connection String. :param str conn_str: A connection string to an Azure Communication Service resource. @@ -89,14 +95,17 @@ def create_user(self, **kwargs) -> CommunicationUserIdentifier: :return: CommunicationUserIdentifier :rtype: ~azure.communication.identity.CommunicationUserIdentifier """ - identity_access_token = self._identity_service_client.communication_identity.create(**kwargs) + identity_access_token = self._identity_service_client.identity_operations.create( + **extract_create_content_type(kwargs) + ) return CommunicationUserIdentifier(identity_access_token.identity.id, raw_id=identity_access_token.identity.id) @distributed_trace def create_user_and_token( self, - scopes: List[Union[str, CommunicationTokenScope]], *, + scopes: List[Union[str, CommunicationTokenScope]], + *, token_expires_in: Optional[timedelta] = None, **kwargs: Any ) -> Tuple[CommunicationUserIdentifier, AccessToken]: @@ -111,30 +120,20 @@ def create_user_and_token( :rtype: tuple of (~azure.communication.identity.CommunicationUserIdentifier, ~azure.core.credentials.AccessToken) """ - request_body = { - "createTokenWithScopes": scopes, - "expiresInMinutes": convert_timedelta_to_mins(token_expires_in), - } - identity_access_token = self._identity_service_client.communication_identity.create( + request_body = build_token_request_body("createTokenWithScopes", scopes, token_expires_in) + identity_access_token = self._identity_service_client.identity_operations.create( body=request_body, **kwargs # type: ignore ) user_identifier = CommunicationUserIdentifier( identity_access_token.identity.id, raw_id=identity_access_token.identity.id ) - access_token = AccessToken( - identity_access_token.access_token.token, - identity_access_token.access_token.expires_on, - ) + access_token = to_access_token(identity_access_token["accessToken"]) return user_identifier, access_token @distributed_trace - def delete_user( - self, - user: CommunicationUserIdentifier, - **kwargs: Any - ) -> None: + def delete_user(self, user: CommunicationUserIdentifier, **kwargs: Any) -> None: """Triggers revocation event for user and deletes all its data. :param user: Azure Communication User to delete @@ -142,13 +141,16 @@ def delete_user( :return: None :rtype: None """ - self._identity_service_client.communication_identity.delete(user.properties["id"], **kwargs) + self._identity_service_client.identity_operations.delete( + user.properties["id"], **merge_headers(kwargs, _ACCEPT_JSON) + ) @distributed_trace def get_token( self, user: CommunicationUserIdentifier, - scopes: List[Union[str, CommunicationTokenScope]], *, + scopes: List[Union[str, CommunicationTokenScope]], + *, token_expires_in: Optional[timedelta] = None, **kwargs: Any ) -> AccessToken: @@ -164,23 +166,16 @@ def get_token( :return: AccessToken :rtype: ~azure.core.credentials.AccessToken """ - request_body = { - "scopes": scopes, - "expiresInMinutes": convert_timedelta_to_mins(token_expires_in), - } + request_body = build_token_request_body("scopes", scopes, token_expires_in) - access_token = self._identity_service_client.communication_identity.issue_access_token( + access_token = self._identity_service_client.identity_operations.issue_access_token( user.properties["id"], body=request_body, **kwargs # type: ignore ) - return AccessToken(access_token.token, access_token.expires_on) + return to_access_token(access_token) @distributed_trace - def revoke_tokens( - self, - user: CommunicationUserIdentifier, - **kwargs: Any - ) -> None: + def revoke_tokens(self, user: CommunicationUserIdentifier, **kwargs: Any) -> None: """Schedule revocation of all tokens of an identity. :param user: Azure Communication User. @@ -188,17 +183,13 @@ def revoke_tokens( :return: None :rtype: None """ - return self._identity_service_client.communication_identity.revoke_access_tokens( - user.properties["id"] if user else None, **kwargs # type: ignore + return self._identity_service_client.identity_operations.revoke_access_tokens( + user.properties["id"] if user else None, **merge_headers(kwargs, _ACCEPT_JSON) # type: ignore ) @distributed_trace def get_token_for_teams_user( - self, - aad_token: str, - client_id: str, - user_object_id: str, - **kwargs: Any + self, aad_token: str, client_id: str, user_object_id: str, **kwargs: Any ) -> AccessToken: """Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token. @@ -220,8 +211,8 @@ def get_token_for_teams_user( "userId": user_object_id, } - access_token = self._identity_service_client.communication_identity.exchange_teams_user_access_token( + access_token = self._identity_service_client.teams_user_operations.exchange_teams_user_access_token( body=request_body, **kwargs # type: ignore ) - return AccessToken(access_token.token, access_token.expires_on) + return to_access_token(access_token) diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/__init__.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/__init__.py index 7d62ac6effd1..d4c9c7017d4c 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/__init__.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/__init__.py @@ -2,22 +2,31 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import CommunicationIdentityClient +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import IdentityClient # type: ignore +from ._version import VERSION + +__version__ = VERSION try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ - "CommunicationIdentityClient", + "IdentityClient", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_client.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_client.py index 45e7da9919ec..dd116886cecc 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_client.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_client.py @@ -2,33 +2,47 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# 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 +import sys from typing import Any from azure.core import PipelineClient +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse -from . import models as _models -from ._configuration import CommunicationIdentityClientConfiguration -from ._serialization import Deserializer, Serializer -from .operations import CommunicationIdentityOperations +from ._configuration import IdentityClientConfiguration +from ._utils.serialization import Deserializer, Serializer +from .operations import IdentityOperationsOperations, TeamsExtensionOperationsOperations, TeamsUserOperationsOperations +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self # type: ignore -class CommunicationIdentityClient: # pylint: disable=client-accepts-api-version-keyword + +class IdentityClient: # pylint: disable=docstring-keyword-should-match-keyword-only """Azure Communication Identity Service. - :ivar communication_identity: CommunicationIdentityOperations operations - :vartype communication_identity: - azure.communication.identity.operations.CommunicationIdentityOperations + :ivar identity_operations: IdentityOperationsOperations operations + :vartype identity_operations: + azure.communication.identity.operations.IdentityOperationsOperations + :ivar teams_user_operations: TeamsUserOperationsOperations operations + :vartype teams_user_operations: + azure.communication.identity.operations.TeamsUserOperationsOperations + :ivar teams_extension_operations: TeamsExtensionOperationsOperations operations + :vartype teams_extension_operations: + azure.communication.identity.operations.TeamsExtensionOperationsOperations :param endpoint: The communication resource, for example - https://my-resource.communication.azure.com. Required. + `https://my-resource.communication.azure.com `_. + Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2023-10-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are "2026-09-23" + and None. Default value is None. If not set, the operation's default API version will be used. + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -36,18 +50,41 @@ def __init__( # pylint: disable=missing-client-constructor-parameter-credential self, endpoint: str, **kwargs: Any ) -> None: _endpoint = "{endpoint}" - self._config = CommunicationIdentityClientConfiguration(endpoint=endpoint, **kwargs) - self._client: PipelineClient = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) - - client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)} - self._serialize = Serializer(client_models) - self._deserialize = Deserializer(client_models) + self._config = IdentityClientConfiguration(endpoint=endpoint, **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 - self.communication_identity = CommunicationIdentityOperations( + self.identity_operations = IdentityOperationsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.teams_user_operations = TeamsUserOperationsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.teams_extension_operations = TeamsExtensionOperationsOperations( self._client, self._config, self._serialize, self._deserialize ) - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + 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 @@ -71,12 +108,12 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore def close(self) -> None: self._client.close() - def __enter__(self) -> "CommunicationIdentityClient": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_configuration.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_configuration.py index 3ba79d8d9d97..8e224fc5e630 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_configuration.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_configuration.py @@ -1,45 +1,45 @@ +# pylint: disable=line-too-long,useless-suppression # 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) AutoRest Code Generator. +# 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 -from azure.core.configuration import Configuration from azure.core.pipeline import policies -VERSION = "unknown" +from ._version import VERSION -class CommunicationIdentityClientConfiguration( # pylint: disable=too-many-instance-attributes,name-too-long - Configuration -): - """Configuration for CommunicationIdentityClient. +class IdentityClientConfiguration: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only + """Configuration for IdentityClient. 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. + `https://my-resource.communication.azure.com `_. + Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2023-10-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are "2026-09-23" + and None. Default value is None. If not set, the operation's default API version will be used. + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, **kwargs: Any) -> None: - super(CommunicationIdentityClientConfiguration, self).__init__(**kwargs) - api_version: str = kwargs.pop("api_version", "2023-10-01") + api_version: str = kwargs.pop("api_version", "2026-09-23") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") self.endpoint = endpoint self.api_version = api_version - kwargs.setdefault("sdk_moniker", "communicationidentityclient/{}".format(VERSION)) + kwargs.setdefault("sdk_moniker", "communication-identity/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -48,7 +48,7 @@ def _configure(self, **kwargs: Any) -> None: 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.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**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") diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_patch.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_patch.py index 17dbc073e01b..ea765788358a 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_patch.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_patch.py @@ -1,32 +1,20 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# # 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. -# +# Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level -# This file is used for handwritten extensions to the generated code. Example: -# https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_code/how-to-patch-sdk-code.md def patch_sdk(): - pass + """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-identity/azure/communication/identity/_generated/_utils/__init__.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# 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. +# -------------------------------------------------------------------------- diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/model_base.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/model_base.py new file mode 100644 index 000000000000..35d5fc024978 --- /dev/null +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/model_base.py @@ -0,0 +1,1787 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +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 + +from azure.core.rest import HttpResponse + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") +_NONE_TYPE = type(None) + + +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_duration(td: timedelta, format: typing.Optional[str] = None): + """Serialize a timedelta to its wire representation. + + For the ``seconds``/``milliseconds`` encodings the value is converted to a + numeric value, otherwise it falls back to an ISO 8601 duration string. + + :param timedelta td: The timedelta to serialize. + :param str format: The duration encoding format. + :rtype: int or float or str + :return: serialized duration + """ + seconds = td.total_seconds() + if format == "duration-seconds-int": + return int(seconds) + if format == "duration-seconds-float": + return seconds + if format == "duration-milliseconds-int": + return int(seconds * 1000) + if format == "duration-milliseconds-float": + return seconds * 1000 + return _timedelta_as_isostr(td) + + +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"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes. + + :param args: Additional positional arguments passed to the base ``JSONEncoder``. + :type args: typing.Any + :keyword exclude_readonly: Whether to exclude readonly properties. Defaults to False. + :paramtype exclude_readonly: bool + :keyword format: The format to use for serialization. Defaults to None. + :paramtype format: typing.Optional[str] + """ + + 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" +) + +_ARRAY_ENCODE_MAPPING = { + "pipeDelimited": "|", + "spaceDelimited": " ", + "commaDelimited": ",", + "newlineDelimited": "\n", +} + + +def _deserialize_array_encoded(delimit: str, attr): + if isinstance(attr, str): + if attr == "": + return [] + return attr.split(delimit) + return attr + + +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 # type: ignore[no-any-return] + + +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) # type: ignore[no-any-return] + + +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_duration_numeric(attr, unit): + if isinstance(attr, timedelta): + return attr + return timedelta(**{unit: float(attr)}) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +def _deserialize_bool_as_str(attr): + if isinstance(attr, bool): + return attr + return attr.lower() == "true" + + +_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, + "duration-seconds-int": functools.partial(_deserialize_duration_numeric, unit="seconds"), + "duration-seconds-float": functools.partial(_deserialize_duration_numeric, unit="seconds"), + "duration-milliseconds-int": functools.partial(_deserialize_duration_numeric, unit="milliseconds"), + "duration-milliseconds-float": functools.partial(_deserialize_duration_numeric, unit="milliseconds"), +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if annotation is bool and rf and rf._format == "str": + return _deserialize_bool_as_str + if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING: + return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format]) + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +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]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + # If this key has been deserialized (for mutable types), we need to handle serialization + if hasattr(self, "_attr_to_rest_field"): + cache_attr = f"_deserialized_{key}" + if hasattr(self, cache_attr): + rf = _get_rest_field(getattr(self, "_attr_to_rest_field"), key) + if rf: + value = self._data.get(key) + if isinstance(value, (dict, list, set)): + # For mutable types, serialize and return + # But also update _data with serialized form and clear flag + # so mutations via this returned value affect _data + serialized = _serialize(value, rf._format) + # If serialized form is same type (no transformation needed), + # return _data directly so mutations work + if isinstance(serialized, type(value)) and serialized == value: + return self._data.get(key) + # Otherwise return serialized copy and clear flag + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + # Store serialized form back + self._data[key] = serialized + return serialized + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + # Clear any cached deserialized value when setting through dictionary access + cache_attr = f"_deserialized_{key}" + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + 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]: + """ + :returns: a set-like object providing a view on the mapping's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on the mapping's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: a set-like object providing a view on the mapping's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: The value for key if key is in the dictionary, else default. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if the dictionary is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from the dictionary. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Update the dictionary from a mapping or an iterable of key-value pairs. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + 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: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Return the value for key if key is in the dictionary; otherwise set the key to + default and return default. + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: The value for key if key is in the dictionary, else default. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + if isinstance(other, _MyMutableMapping): + return self._data == other._data + 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): + if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o): + return _ARRAY_ENCODE_MAPPING[format].join(o) + 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 + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _serialize_duration(o, format) + 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: 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) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +# ============================================================================ +# Fast-path scalar deserializer functions for rest_field(deserializer=...) +# These are referenced from rest_field declarations to bypass the generic +# _deserialize -> _deserialize_with_callable chain. +# Only simple/primitive types — no models or container types. +# ============================================================================ + + +def _xml_deser_str(value): + if isinstance(value, ET.Element): + return value.text or "" + return str(value) if value is not None else None + + +def _xml_deser_int(value): + if isinstance(value, ET.Element): + return int(value.text) if value.text else None + return int(value) if value is not None else None + + +def _xml_deser_float(value): + if isinstance(value, ET.Element): + return float(value.text) if value.text else None + return float(value) if value is not None else None + + +def _xml_deser_bool(value): + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + if text in (True, False): + return text + return text.lower() == "true" + + +# pylint: disable=docstring-missing-param +def _xml_deser_bytes(value): + """Deserialize bytes from XML (base64).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_bytes(text) + + +def _xml_deser_bytes_base64url(value): + """Deserialize bytes from XML (base64url).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_bytes_base64(text) + + +def _xml_deser_datetime(value): + """Deserialize a datetime from XML (ISO 8601 / rfc3339).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime(text) + + +def _xml_deser_datetime_rfc7231(value): + """Deserialize a datetime from XML (RFC7231 format).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime_rfc7231(text) + + +def _xml_deser_datetime_unix_timestamp(value): + """Deserialize a datetime from XML (Unix timestamp).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime_unix_timestamp(float(text)) + + +def _xml_deser_date(value): + """Deserialize a date from XML (ISO 8601).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_date(text) + + +def _xml_deser_time(value): + """Deserialize a time from XML (ISO 8601).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_time(text) + + +def _xml_deser_duration(value): + """Deserialize a timedelta from XML (ISO 8601 duration).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_duration(text) + + +def _xml_deser_decimal(value): + """Deserialize a Decimal from XML.""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_decimal(text) + + +def _xml_deser_enum_or_str(enum_cls, value): + """Deserialize a Union[EnumType, str] from XML.""" + text = value.text if isinstance(value, ET.Element) else value + if text is None: + return None + try: + return enum_cls(text) + except ValueError: + return text + + +def _extract_xml_model_type(rf_type): + """Extract the concrete Model class from a resolved rf._type partial chain. + + Unwraps ``Optional[Model]`` and ``_deserialize_model(Model, ...)`` + wrappers. Only handles Model and Optional[Model] — other composite + types (List, Dict, Union, etc.) return None and fall through to the + generic ``_deserialize`` path at runtime. + """ + if rf_type is None: + return None + if isinstance(rf_type, type) and _is_model(rf_type): + return rf_type + if not isinstance(rf_type, functools.partial): + return None + func = rf_type.func + args = rf_type.args + if func is _deserialize_with_optional and args: + return _extract_xml_model_type(args[0]) + if func is _deserialize_model and args: + cls = args[0] + return cls if isinstance(cls, type) and _is_model(cls) else None + return None + + +def _build_xml_field_plan( # pylint: disable=docstring-missing-return, docstring-missing-rtype, unused-variable + cls, attr_to_rest_field: dict +) -> list: + """Build a precomputed XML field plan for fast _init_from_xml iteration. + + Called once per model class in __new__. Returns a list of tuples: + (rest_name, xml_name, kind, deser, rf_type, is_optional, items_name) + + kind: 0=wrapped, 1=attribute, 2=unwrapped, 3=text + + For Model and Optional[Model] fields that lack a scalar + ``_deserializer``, this function precomputes the Model class as the + deserializer so ``_init_from_xml`` can call ``ModelClass(element)`` + directly instead of going through the expensive + ``_get_deserialize_callable_from_annotation`` chain at runtime. + """ + model_meta = getattr(cls, "_xml", {}) + model_ns = model_meta.get("ns") or model_meta.get("namespace") + plan = [] + + for rf in attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + deser = rf._deserializer + + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + is_optional = rf._is_optional + + # For Model / Optional[Model] fields without a scalar deserializer, + # precompute the Model class as the deserializer. + if deser is None and rf._type is not None: + model_cls = _extract_xml_model_type(rf._type) + if model_cls is not None: + deser = model_cls + + if prop_meta.get("attribute", False): + plan.append((rf._rest_name, xml_name, 1, deser, rf._type, is_optional, None)) + elif prop_meta.get("unwrapped", False): + items_name = prop_meta.get("itemsName") + if items_name: + items_ns = prop_meta.get("itemsNs") + if items_ns is not None: + xml_ns = items_ns + if xml_ns: + items_name = "{" + xml_ns + "}" + items_name + else: + items_name = xml_name + plan.append((rf._rest_name, xml_name, 2, deser, rf._type, is_optional, items_name)) + elif prop_meta.get("text", False): + plan.append((rf._rest_name, xml_name, 3, deser, rf._type, is_optional, None)) + else: + plan.append((rf._rest_name, xml_name, 0, deser, rf._type, is_optional, None)) + + return plan + + +# pylint: enable=docstring-missing-param +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + 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: dict[str, typing.Any] = {} + if args: + if isinstance(args[0], ET.Element): + dict_to_pass.update(self._init_from_xml(args[0])) + else: + 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 + } + ) + # Apply client default values for fields the caller didn't set so that + # defaults are part of `_data` and therefore included during serialization. + for rf in self._attr_to_rest_field.values(): + if rf._default is _UNSET: + continue + if rf._rest_name in dict_to_pass: + continue + dict_to_pass[rf._rest_name] = _create_value(rf, rf._default) + super().__init__(dict_to_pass) + + def _init_from_xml( # pylint: disable=too-many-branches, too-many-statements + self, element: ET.Element + ) -> dict[str, typing.Any]: + """Deserialize an XML element into a dict mapping rest field names to values. + + :param ET.Element element: The XML element to deserialize from. + :returns: A dictionary of rest_name to deserialized value pairs. + :rtype: dict + """ + result: dict[str, typing.Any] = {} + existed_attr_keys: list[str] = [] + + field_plan = getattr(self, "_xml_field_plan", None) + if field_plan: + for rest_name, xml_name, kind, deser, rf_type, is_optional, items_name in field_plan: + if kind == 0: # wrapped element (most common) + item = element.find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + if deser: + result[rest_name] = deser(item) + else: + result[rest_name] = _deserialize(rf_type, item) + elif kind == 1: # attribute + attr_val = element.get(xml_name) + if attr_val is not None: + existed_attr_keys.append(xml_name) + if deser: + result[rest_name] = deser(attr_val) + else: + result[rest_name] = attr_val + elif kind == 2: # unwrapped array + items = element.findall(items_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(items_name) + if deser: + result[rest_name] = deser(items) + else: + result[rest_name] = _deserialize(rf_type, items) + elif not is_optional: + existed_attr_keys.append(items_name) + result[rest_name] = [] + elif kind == 3: # text + if element.text is not None: + if deser: + result[rest_name] = deser(element.text) + else: + result[rest_name] = element.text + else: + model_meta = getattr(self, "_xml", {}) + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and element.get(xml_name) is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, element.get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + _items_name = prop_meta.get("itemsName") + if _items_name: + xml_name = _items_name + _items_ns = prop_meta.get("itemsNs") + if _items_ns is not None: + xml_ns = _items_ns + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = element.findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, items) + elif not rf._is_optional: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = [] + continue + + # text element is primitive type + if prop_meta.get("text", False): + if element.text is not None: + result[rf._rest_name] = _deserialize(rf._type, element.text) + continue + + # wrapped element could be normal property or array + item = element.find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in element: + if e.tag not in existed_attr_keys: + result[e.tag] = _convert_element(e) + + return result + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: 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__") + for k, v in mro_class.__annotations__.items() + } + 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: dict[str, _RestField] = dict(attr_to_rest_field.items()) + # Build XML field plan for fast _init_from_xml (only for XML models) + if getattr(cls, "_xml", None): + cls._xml_field_plan = _build_xml_field_plan(cls, attr_to_rest_field) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + 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 _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +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) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _is_array_encoded_deserializer(deserializer: functools.partial) -> bool: + return ( + isinstance(deserializer, functools.partial) + and isinstance(deserializer.args[0], functools.partial) + and deserializer.args[0].func == _deserialize_array_encoded # pylint: disable=comparison-with-callable + ) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + + # encoded string may be deserialized to sequence + if isinstance(obj, str) and isinstance(deserializer, functools.partial): + # for list[str] + if _is_array_encoded_deserializer(deserializer): + return deserializer(obj) + + # for list[Union[...]] + if isinstance(deserializer.args[0], list): + for sub_deserializer in deserializer.args[0]: + if _is_array_encoded_deserializer(sub_deserializer): + return sub_deserializer(obj) + + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + 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) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + 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 is _NONE_TYPE for a in annotation.__args__): # pyright: ignore + if rf: + rf._is_optional = True + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a is not _NONE_TYPE] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + 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_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + 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, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + 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, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING.values(): + return deserializer(value.text) if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING_WITHFORMAT.values(): + return deserializer(value.text) if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value.text if isinstance(value, ET.Element) else value) + except ValueError: + # for unknown value, return raw value + return value.text if isinstance(value, ET.Element) else 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) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +# pylint: disable=too-many-instance-attributes +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[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + deserializer: typing.Optional[typing.Callable] = None, + ): + 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._is_optional = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + self._deserializer = deserializer + + @property + def _class_type(self) -> typing.Any: + result = getattr(self._type, "args", [None])[0] + # type may be wrapped by nested functools.partial so we need to check for that + if isinstance(result, functools.partial): + return getattr(result, "args", [None])[0] + return result + + @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 + # Use _data.get() directly to avoid triggering __getitem__ which clears the cache + item = obj._data.get(self._rest_name, _UNSET) + if item is _UNSET: + # Field not set by user; return the client default if one exists, otherwise None + return self._default if self._default is not _UNSET else None + if item is None: + return item + if self._is_model: + return item + + # For mutable types, we want mutations to directly affect _data + # Check if we've already deserialized this value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + # Return the value from _data directly (it's been deserialized in place) + return obj._data.get(self._rest_name) + + # Fast path: use _deserializer directly (avoids _serialize/_deserialize chain) + if self._deserializer: + deserialized = self._deserializer(item) + else: + deserialized = _deserialize(self._type, _serialize(item, self._format), rf=self) + + # For mutable types, store the deserialized value back in _data + # so mutations directly affect _data + if isinstance(deserialized, (dict, list, set)): + obj._data[self._rest_name] = deserialized + object.__setattr__(obj, cache_attr, True) # Mark as deserialized + return deserialized + + return deserialized + + def __set__(self, obj: Model, value) -> None: + # Clear the cached deserialized object when setting a new value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + object.__delattr__(obj, cache_attr) + + 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[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + deserializer: typing.Optional[typing.Callable] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + deserializer=deserializer, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_xml_ns(meta: dict[str, typing.Any]) -> typing.Optional[str]: + """Return the XML namespace from a metadata dict, checking both 'ns' (old-style) and 'namespace' (DPG) keys. + + :param dict meta: The metadata dictionary to extract namespace from. + :returns: The namespace string if 'ns' or 'namespace' key is present, None otherwise. + :rtype: str or None + """ + ns = meta.get("ns") + if ns is None: + ns = meta.get("namespace") + return ns + + +def _resolve_xml_ns( + prop_meta: dict[str, typing.Any], model_meta: typing.Optional[dict[str, typing.Any]] = None +) -> typing.Optional[str]: + """Resolve XML namespace for a property, falling back to model namespace when appropriate. + + Checks the property metadata first; if no namespace is found and the model does not declare + an explicit prefix, falls back to the model-level namespace. + + :param dict prop_meta: The property metadata dictionary. + :param dict model_meta: The model metadata dictionary, used as fallback. + :returns: The resolved namespace string, or None. + :rtype: str or None + """ + ns = _get_xml_ns(prop_meta) + if ns is None and model_meta is not None and not model_meta.get("prefix"): + ns = _get_xml_ns(model_meta) + return ns + + +def _set_xml_attribute(element: ET.Element, name: str, value: typing.Any, prop_meta: dict[str, typing.Any]) -> None: + """Set an XML attribute on an element, handling namespace prefix registration. + + :param ET.Element element: The element to set the attribute on. + :param str name: The default attribute name (wire name). + :param any value: The attribute value. + :param dict prop_meta: The property metadata dictionary. + """ + xml_name = prop_meta.get("name", name) + _attr_ns = _get_xml_ns(prop_meta) + if _attr_ns: + _attr_prefix = prop_meta.get("prefix") + if _attr_prefix: + _safe_register_namespace(_attr_prefix, _attr_ns) + xml_name = "{" + _attr_ns + "}" + xml_name + element.set(xml_name, _get_primitive_type_value(value)) + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + # When serializing as an array item (parent_meta is set), check if the parent has an + # explicit itemsName. This ensures correct element names for unwrapped arrays (where + # the element tag is the property/items name, not the model type name). + _items_name = parent_meta.get("itemsName") if parent_meta is not None else None + element_name = _items_name if _items_name else (model_meta.get("name") or o.__class__.__name__) + _model_ns = _get_xml_ns(model_meta) + wrapped_element = _create_xml_element( + element_name, + model_meta.get("prefix"), + _model_ns, + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # Propagate model namespace to properties only for old-style "ns"-keyed models. + # DPG-generated models use the "namespace" key and explicitly declare namespace on + # each property that needs it, so propagation is intentionally skipped for them. + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + _set_xml_attribute(wrapped_element, k, v, prop_meta) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + _dict_ns = _get_xml_ns(parent_meta) if parent_meta else None + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": _dict_ns, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + _items_ns = parent_meta.get("itemsNs") + if _items_ns is None: + _items_ns = _get_xml_ns(parent_meta) + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": _items_ns, + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + _meta_ns = _get_xml_ns(meta) if meta else None + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, _meta_ns + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element # type: ignore[no-any-return] + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _safe_register_namespace(prefix: str, ns: str) -> None: + """Register an XML namespace prefix, handling reserved prefix patterns. + + Some prefixes (e.g. 'ns2') match Python's reserved 'ns\\d+' pattern used for + auto-generated prefixes, causing register_namespace to raise ValueError. + Falls back to directly registering in the internal namespace map. + + :param str prefix: The namespace prefix to register. + :param str ns: The namespace URI. + """ + try: + ET.register_namespace(prefix, ns) + except ValueError: + _ns_map = getattr(ET, "_namespace_map", None) + if _ns_map is not None: + _ns_map[ns] = prefix + + +def _create_xml_element( + tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None +) -> ET.Element: + if prefix and ns: + _safe_register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + if _is_model(deserializer): + return deserializer._deserialize(element, []) + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_serialization.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/serialization.py similarity index 72% rename from sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_serialization.py rename to sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/serialization.py index c13084631923..ae08f9d89f74 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_serialization.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_utils/serialization.py @@ -1,30 +1,12 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 # -------------------------------------------------------------------------- -# # 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. -# +# 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. # -------------------------------------------------------------------------- -# pylint: skip-file # pyright: reportUnnecessaryTypeIgnoreComment=false from base64 import b64decode, b64encode @@ -39,7 +21,6 @@ import sys import codecs from typing import ( - Dict, Any, cast, Optional, @@ -48,11 +29,7 @@ IO, Mapping, Callable, - TypeVar, MutableMapping, - Type, - List, - Mapping, ) try: @@ -63,20 +40,21 @@ import isodate # type: ignore -from azure.core.exceptions import ( - DeserializationError, - SerializationError, - raise_with_traceback, -) -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self _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$") @@ -94,6 +72,8 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: :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. + :return: The deserialized data. + :rtype: object """ if hasattr(data, "read"): # Assume a stream @@ -115,9 +95,10 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: try: return json.loads(data_as_str) except ValueError as err: - raise DeserializationError("JSON is invalid: {}".format(err), err) + raise DeserializationError("JSON is invalid: {}".format(err), err) from 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 @@ -126,7 +107,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: pass return ET.fromstring(data_as_str) # nosec - except ET.ParseError: + 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 @@ -145,7 +126,9 @@ def _json_attemp(data): # The function hack is because Py2.7 messes up with exception # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") - raise_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -155,6 +138,11 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], Use bytes and headers to NOT use any requests/aiohttp or whatever specific implementation. Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object """ # Try to use content-type from headers if available content_type = None @@ -172,13 +160,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -186,80 +167,31 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], 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 +TZ_UTC = datetime.timezone.utc _FLATTEN = re.compile(r"(? None: - self.additional_properties: Dict[str, Any] = {} - for k in kwargs: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items 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__, - ) + _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__, - ) + _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.""" + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ if isinstance(other, self.__class__): return self.__dict__ == other.__dict__ return False def __ne__(self, other: Any) -> bool: - """Compare objects by comparing all attributes.""" + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ return not self.__eq__(other) def __str__(self) -> str: @@ -341,20 +282,20 @@ def is_xml_model(cls) -> bool: @classmethod def _create_xml_node(cls): - """Create XML node.""" + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ 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), - ) + 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 azure from this model. + """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)`. @@ -365,12 +306,14 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) def as_dict( self, keep_readonly: bool = True, - key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, **kwargs: Any ) -> JSON: """Return a dict that can be serialized using json.dump. @@ -399,12 +342,15 @@ def my_key_transformer(key, attr_desc, value): 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 :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) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) @classmethod def _infer_class_models(cls): @@ -414,30 +360,31 @@ def _infer_class_models(cls): 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: + except Exception: # pylint: disable=broad-exception-caught # 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: + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: """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 + :raises DeserializationError: if something went wrong + :rtype: Self """ deserializer = Deserializer(cls._infer_class_models()) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def from_dict( - cls: Type[ModelType], + cls, data: Any, - key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, content_type: Optional[str] = None, - ) -> ModelType: + ) -> Self: """Parse a dict using given key extractor return a model. By default consider key @@ -445,9 +392,11 @@ def from_dict( and last_rest_key_case_insensitive_extractor) :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. :param str content_type: JSON by default, set application/xml if XML. :returns: An instance of this model - :raises: DeserializationError if something went wrong + :raises DeserializationError: if something went wrong + :rtype: Self """ deserializer = Deserializer(cls._infer_class_models()) deserializer.key_extractors = ( # type: ignore @@ -459,7 +408,7 @@ def from_dict( if key_extractors is None else key_extractors ) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def _flatten_subtype(cls, key, objects): @@ -467,21 +416,25 @@ def _flatten_subtype(cls, key, objects): return {} result = dict(cls._subtype_map[key]) for valuetype in cls._subtype_map[key].values(): - result.update(objects[valuetype]._flatten_subtype(key, objects)) + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access 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. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class """ 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) + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) else: subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) if subtype_value: @@ -500,11 +453,7 @@ def _classify(cls, response, objects): ) break else: - _LOGGER.warning( - "Discriminator %s is absent or null, use base class %s.", - subtype_key, - cls.__name__, - ) + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) break return cls @@ -524,12 +473,18 @@ def _decode_attribute_map_key(key): inside the received data. :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str """ return key.replace("\\.", ".") -class Serializer(object): - """Request object model serializer.""" +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer. + + :param classes: Mapping of model names to model types, used to resolve models during serialization. + :type classes: typing.Optional[typing.Mapping[str, type]] + """ basic_types = {str: "str", int: "int", bool: "bool", float: "float"} @@ -563,12 +518,16 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, "unix-time": Serializer.serialize_unix, "duration": Serializer.serialize_duration, + "duration-seconds-int": Serializer.serialize_duration_seconds_int, + "duration-seconds-float": Serializer.serialize_duration_seconds_float, + "duration-milliseconds-int": Serializer.serialize_duration_milliseconds_int, + "duration-milliseconds-float": Serializer.serialize_duration_milliseconds_float, "date": Serializer.serialize_date, "time": Serializer.serialize_time, "decimal": Serializer.serialize_decimal, @@ -579,17 +538,20 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + 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): + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): """Serialize data into a string according to type. - :param target_obj: The data to be serialized. + :param object 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. + :raises SerializationError: if serialization fails. + :returns: The serialized data. """ key_transformer = kwargs.get("key_transformer", self.key_transformer) keep_readonly = kwargs.get("keep_readonly", False) @@ -615,19 +577,22 @@ def _serialize(self, target_obj, data_type=None, **kwargs): serialized = {} if is_xml_model_serialization: - serialized = target_obj._create_xml_node() + serialized = target_obj._create_xml_node() # pylint: disable=protected-access try: - attributes = target_obj._attribute_map + attributes = target_obj._attribute_map # pylint: disable=protected-access for attr, attr_desc in attributes.items(): attr_name = attr - if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + 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) + serialized |= 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" @@ -655,7 +620,8 @@ def _serialize(self, target_obj, data_type=None, **kwargs): 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 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 @@ -666,7 +632,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -685,18 +651,18 @@ def _serialize(self, target_obj, data_type=None, **kwargs): except (AttributeError, KeyError, TypeError) as err: msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) - raise_with_traceback(SerializationError, msg, err) - else: - return serialized + raise SerializationError(msg) from err + return serialized def body(self, data, data_type, **kwargs): """Serialize data intended for a request body. - :param data: The data to be serialized. + :param object 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 + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body """ # Just in case this is a dict @@ -725,20 +691,22 @@ def body(self, data, data_type, **kwargs): attribute_key_case_insensitive_extractor, last_rest_key_case_insensitive_extractor, ] - data = deserializer._deserialize(data_type, data) + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access except DeserializationError as err: - raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), 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 name: The name of the URL path parameter. + :param object 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 + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None """ try: output = self.serialize_data(data, data_type, **kwargs) @@ -747,32 +715,30 @@ def url(self, name, data, data_type, **kwargs): if kwargs.get("skip_quote") is True: output = str(output) - # https://github.com/Azure/autorest.python/issues/2063 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 + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + 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 name: The name of the query parameter. + :param object 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 - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter """ 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 str(self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs)) + 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) @@ -782,19 +748,20 @@ def query(self, name, data, data_type, **kwargs): output = str(output) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + 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 name: The name of the header. + :param object 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 + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header """ try: if data_type in ["[str]"]: @@ -803,37 +770,36 @@ def header(self, name, data, data_type, **kwargs): 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) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + 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 object 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. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list """ if data is None: raise ValueError("No value for given attribute") try: - if data is AzureCoreNull: + 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: + if 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__) + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) if issubclass(enum_type, Enum): return Serializer.serialize_enum(data, enum_obj=enum_type) @@ -843,12 +809,11 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." - raise_with_traceback(SerializationError, msg.format(data, data_type), err) - else: - return self._serialize(data, **kwargs) + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) @classmethod - def _get_custom_serializers(cls, data_type, **kwargs): + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) if custom_serializer: return custom_serializer @@ -864,23 +829,33 @@ def serialize_basic(cls, data, data_type, **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 obj data: Object to be serialized. :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + :raises TypeError: raise if data_type is not one of str, int, float, bool. """ 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 + if data_type == "int": + return int(data) + if data_type == "float": + return float(data) + if data_type == "bool": + return bool(data) + raise TypeError("Unknown basic data type: {}".format(data_type)) @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. + :param str data: Object to be serialized. :rtype: str + :return: serialized object """ try: # If I received an enum, return its value return data.value @@ -894,8 +869,7 @@ def serialize_unicode(cls, data): return data except NameError: return str(data) - else: - return str(data) + return str(data) def serialize_iter(self, data, iter_type, div=None, **kwargs): """Serialize iterable. @@ -905,15 +879,13 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): 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 list data: 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 + :return: serialized iterable """ if isinstance(data, str): raise SerializationError("Refuse str type as a valid iter type.") @@ -956,11 +928,7 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): 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), - ) + 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) @@ -972,9 +940,8 @@ def serialize_dict(self, attr, dict_type, **kwargs): :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 + :return: serialized dictionary """ serialization_ctxt = kwargs.get("serialization_ctxt", {}) serialized = {} @@ -998,7 +965,7 @@ def serialize_dict(self, attr, dict_type, **kwargs): return serialized - def serialize_object(self, attr, **kwargs): + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """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 @@ -1006,6 +973,7 @@ def serialize_object(self, attr, **kwargs): :param dict attr: Object to be serialized. :rtype: dict or str + :return: serialized object """ if attr is None: return None @@ -1016,7 +984,7 @@ def serialize_object(self, attr, **kwargs): 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 unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1030,7 +998,7 @@ def serialize_object(self, attr, **kwargs): 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): + if obj_type in self.dependencies.values() or isinstance(attr, Model): return self._serialize(attr) if obj_type == dict: @@ -1061,56 +1029,61 @@ def serialize_enum(attr, enum_obj=None): try: enum_obj(result) # type: ignore return result - except ValueError: + except ValueError as exc: 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)) + raise SerializationError(error.format(attr, enum_obj)) from exc @staticmethod - def serialize_bytearray(attr, **kwargs): + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument """Serialize bytearray into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ return b64encode(attr).decode() @staticmethod - def serialize_base64(attr, **kwargs): + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument """Serialize str into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ encoded = b64encode(attr).decode("ascii") return encoded.strip("=").replace("+", "-").replace("/", "_") @staticmethod - def serialize_decimal(attr, **kwargs): + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument """Serialize Decimal object to float. - :param attr: Object to be serialized. + :param decimal attr: Object to be serialized. :rtype: float + :return: serialized decimal """ return float(attr) @staticmethod - def serialize_long(attr, **kwargs): + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument """Serialize long (Py2) or int (Py3). - :param attr: Object to be serialized. + :param int attr: Object to be serialized. :rtype: int/long + :return: serialized long """ return _long_type(attr) @staticmethod - def serialize_date(attr, **kwargs): + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument """Serialize Date object into ISO-8601 formatted string. :param Date attr: Object to be serialized. :rtype: str + :return: serialized date """ if isinstance(attr, str): attr = isodate.parse_date(attr) @@ -1118,11 +1091,12 @@ def serialize_date(attr, **kwargs): return t @staticmethod - def serialize_time(attr, **kwargs): + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument """Serialize Time object into ISO-8601 formatted string. :param datetime.time attr: Object to be serialized. :rtype: str + :return: serialized time """ if isinstance(attr, str): attr = isodate.parse_time(attr) @@ -1132,30 +1106,87 @@ def serialize_time(attr, **kwargs): return t @staticmethod - def serialize_duration(attr, **kwargs): + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument """Serialize TimeDelta object into ISO-8601 formatted string. :param TimeDelta attr: Object to be serialized. :rtype: str + :return: serialized duration """ if isinstance(attr, str): attr = isodate.parse_duration(attr) return isodate.duration_isoformat(attr) @staticmethod - def serialize_rfc(attr, **kwargs): + def _serialize_duration_numeric(attr, scale, as_int): + """Serialize a TimeDelta into a numeric value scaled to the wire unit. + + :param TimeDelta attr: Object to be serialized. + :param int scale: Multiplier applied to total seconds (1 for seconds, 1000 for milliseconds). + :param bool as_int: Whether to truncate the result to an int. + :rtype: int or float + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + value = attr.total_seconds() * scale if isinstance(attr, datetime.timedelta) else attr + return int(value) if as_int else float(value) + + @staticmethod + def serialize_duration_seconds_int(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into an integer number of seconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: int + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1, True) + + @staticmethod + def serialize_duration_seconds_float(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into a floating point number of seconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: float + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1, False) + + @staticmethod + def serialize_duration_milliseconds_int(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into an integer number of milliseconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: int + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1000, True) + + @staticmethod + def serialize_duration_milliseconds_float(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into a floating point number of milliseconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: float + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1000, False) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into RFC-1123 formatted string. :param Datetime attr: Object to be serialized. :rtype: str - :raises: TypeError if format invalid. + :raises TypeError: if format invalid. + :return: serialized rfc """ 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.") + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( Serializer.days[utc.tm_wday], @@ -1168,12 +1199,13 @@ def serialize_rfc(attr, **kwargs): ) @staticmethod - def serialize_iso(attr, **kwargs): + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into ISO-8601 formatted string. :param Datetime attr: Object to be serialized. :rtype: str - :raises: SerializationError if format invalid. + :raises SerializationError: if format invalid. + :return: serialized iso """ if isinstance(attr, str): attr = isodate.parse_datetime(attr) @@ -1188,29 +1220,25 @@ def serialize_iso(attr, **kwargs): 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, + 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_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err except AttributeError as err: msg = "ISO-8601 object must be valid Datetime object." - raise_with_traceback(TypeError, msg, err) + raise TypeError(msg) from err @staticmethod - def serialize_unix(attr, **kwargs): + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument """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 + :raises SerializationError: if format invalid + :return: serialied unix """ if isinstance(attr, int): return attr @@ -1218,17 +1246,17 @@ def serialize_unix(attr, **kwargs): 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.") + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc -def rest_key_extractor(attr, attr_desc, data): +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument 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)) + dict_keys = cast(list[str], _FLATTEN.split(key)) if len(dict_keys) == 1: key = _decode_attribute_map_key(dict_keys[0]) break @@ -1237,14 +1265,15 @@ def rest_key_extractor(attr, attr_desc, 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 - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) return working_data.get(key) -def rest_key_case_insensitive_extractor(attr, attr_desc, data): +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): key = attr_desc["key"] working_data = data @@ -1258,7 +1287,6 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, 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 - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1266,17 +1294,29 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, 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.""" +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ 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): +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument """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" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute """ key = attr_desc["key"] dict_keys = _FLATTEN.split(key) @@ -1313,7 +1353,7 @@ def _extract_name_from_internal_type(internal_type): return xml_name -def xml_key_extractor(attr, attr_desc, data): +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements if isinstance(data, dict): return None @@ -1365,22 +1405,21 @@ def xml_key_extractor(attr, attr_desc, data): if is_iter_type: if is_wrapped: return None # is_wrapped no node, we want None - else: - return [] # not wrapped, assume empty list + 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 - ) + # 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. + ) + 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: @@ -1388,7 +1427,7 @@ def xml_key_extractor(attr, attr_desc, data): return children[0] -class Deserializer(object): +class Deserializer: """Response object model deserializer. :param dict classes: Class type dictionary for deserializing complex types. @@ -1397,14 +1436,18 @@ class Deserializer(object): 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}]?") + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, "unix-time": Deserializer.deserialize_unix, "duration": Deserializer.deserialize_duration, + "duration-seconds-int": Deserializer.deserialize_duration_seconds, + "duration-seconds-float": Deserializer.deserialize_duration_seconds, + "duration-milliseconds-int": Deserializer.deserialize_duration_milliseconds, + "duration-milliseconds-float": Deserializer.deserialize_duration_milliseconds, "date": Deserializer.deserialize_date, "time": Deserializer.deserialize_time, "decimal": Deserializer.deserialize_decimal, @@ -1417,9 +1460,13 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): } self.deserialize_expected_types = { "duration": (isodate.Duration, datetime.timedelta), + "duration-seconds-int": (isodate.Duration, datetime.timedelta), + "duration-seconds-float": (isodate.Duration, datetime.timedelta), + "duration-milliseconds-int": (isodate.Duration, datetime.timedelta), + "duration-milliseconds-float": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + 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 @@ -1429,33 +1476,56 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): # Otherwise, result are unexpected self.additional_properties_detection = True - def __call__(self, target_obj, response_data, content_type=None): + def __call__(self, target_obj, response_data, content_type=None): # pylint: disable=too-many-return-statements """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. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ + # Fast path for header deserialization: response_data is a plain str or None + # and target_obj is a simple scalar type. This avoids the expensive + # _unpack_content → _deserialize → _classify_target → deserialize_data chain. + if response_data is None: + return None + if target_obj == "str" and isinstance(response_data, str): + return response_data + if isinstance(response_data, str): + if target_obj == "int": + return int(response_data) + if target_obj == "bool": + if response_data in ("true", "1", "True"): + return True + if response_data in ("false", "0", "False"): + return False + return bool(response_data) + if target_obj == "rfc-1123": + return Deserializer.deserialize_rfc(response_data) + if target_obj == "bytearray": + return Deserializer.deserialize_bytearray(response_data) + data = self._unpack_content(response_data, content_type) return self._deserialize(target_obj, data) - def _deserialize(self, target_obj, data): + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements """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. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: 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(): + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access if attr in constants: continue value = getattr(data, attr) @@ -1472,15 +1542,15 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) - elif isinstance(response, type) and issubclass(response, Enum): + if isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: - attributes = response._attribute_map # type: ignore + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access d_attrs = {} for attr, attr_desc in attributes.items(): # Check empty string. If it's not empty, someone has a real "additionalProperties"... @@ -1509,10 +1579,9 @@ def _deserialize(self, target_obj, data): d_attrs[attr] = value except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore - raise_with_traceback(DeserializationError, msg, err) - else: - additional_properties = self._build_additional_properties(attributes, data) - return self._instantiate_model(response, d_attrs, additional_properties) + raise DeserializationError(msg) from err + 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: @@ -1539,18 +1608,20 @@ def _classify_target(self, target, data): :param str target: The target object type to deserialize to. :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple """ if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1565,13 +1636,14 @@ def failsafe_deserialize(self, target_obj, data, content_type=None): :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. + :return: Deserialized object. + :rtype: object """ try: return self(target_obj, data, content_type=content_type) - except: + except: # pylint: disable=bare-except _LOGGER.debug( - "Ran into a deserialization error. Ignoring since this is failsafe deserialization", - exc_info=True, + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True ) return None @@ -1587,10 +1659,12 @@ def _unpack_content(raw_data, content_type=None): 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. + :param obj raw_data: Data to be processed. + :param str 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 + :rtype: object + :return: Unpacked content. """ # Assume this is enough to detect a Pipeline Response without importing it context = getattr(raw_data, "context", {}) @@ -1607,31 +1681,42 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + 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. + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. """ 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")] + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + 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 + response_obj.additional_properties = additional_properties # type: ignore return response_obj except TypeError as err: msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore - raise DeserializationError(msg + str(err)) + raise DeserializationError(msg + str(err)) from err else: try: for attr, value in attrs.items(): @@ -1640,15 +1725,16 @@ def _instantiate_model(self, response, attrs, additional_properties=None): except Exception as exp: msg = "Unable to populate response model. " msg += "Type: {}, Error: {}".format(type(response), exp) - raise DeserializationError(msg) + raise DeserializationError(msg) from exp - def deserialize_data(self, data, data_type): + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements """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. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ if data is None: return data @@ -1662,7 +1748,11 @@ def deserialize_data(self, data, data_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"{}"] + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "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) @@ -1681,15 +1771,15 @@ def deserialize_data(self, data, data_type): except (ValueError, TypeError, AttributeError) as err: msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) - raise_with_traceback(DeserializationError, msg, err) - else: - return self._deserialize(obj_type, data) + raise DeserializationError(msg) from err + 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. + :return: Deserialized iterable. :rtype: list """ if attr is None: @@ -1706,6 +1796,7 @@ def deserialize_dict(self, attr, dict_type): :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. + :return: Deserialized dictionary. :rtype: dict """ if isinstance(attr, list): @@ -1716,20 +1807,21 @@ def deserialize_dict(self, attr, dict_type): 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): + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """Deserialize a generic object. This will be handled as a dictionary. :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. :rtype: dict - :raises: TypeError if non-builtin datatype encountered. + :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, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1755,11 +1847,10 @@ def deserialize_object(self, attr, **kwargs): pass return deserialized - else: - error = "Cannot deserialize generic object with type: " - raise TypeError(error + str(obj_type)) + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) - def deserialize_basic(self, attr, data_type): + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements """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 @@ -1767,8 +1858,9 @@ def deserialize_basic(self, attr, data_type): :param str attr: response string to be deserialized. :param str data_type: deserialization data type. + :return: Deserialized basic type. :rtype: str, int, float or bool - :raises: TypeError if string format is not valid. + :raises TypeError: if string format is not valid or data_type is not one of str, int, float, bool. """ # If we're here, data is supposed to be a basic type. # If it's still an XML node, take the text @@ -1778,24 +1870,27 @@ def deserialize_basic(self, attr, data_type): 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 + # 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, basestring): + if isinstance(attr, str): if attr.lower() in ["true", "1"]: return True - elif attr.lower() in ["false", "0"]: + if 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 + if data_type == "int": + return int(attr) + if data_type == "float": + return float(attr) + raise TypeError("Unknown basic data type: {}".format(data_type)) @staticmethod def deserialize_unicode(data): @@ -1803,6 +1898,7 @@ def deserialize_unicode(data): as a string. :param str data: response string to be deserialized. + :return: Deserialized string. :rtype: str or unicode """ # We might be here because we have an enum modeled as string, @@ -1816,8 +1912,7 @@ def deserialize_unicode(data): return data except NameError: return str(data) - else: - return str(data) + return str(data) @staticmethod def deserialize_enum(data, enum_obj): @@ -1829,6 +1924,7 @@ def deserialize_enum(data, enum_obj): :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. + :return: Deserialized enum object. :rtype: Enum """ if isinstance(data, enum_obj) or data is None: @@ -1837,12 +1933,11 @@ def deserialize_enum(data, enum_obj): data = data.value if isinstance(data, int): # Workaround. We might consider remove it in the future. - # https://github.com/Azure/azure-rest-api-specs/issues/141 try: return list(enum_obj.__members__.values())[data] - except IndexError: + except IndexError as exc: error = "{!r} is not a valid index for enum {!r}" - raise DeserializationError(error.format(data, enum_obj)) + raise DeserializationError(error.format(data, enum_obj)) from exc try: return enum_obj(str(data)) except ValueError: @@ -1850,11 +1945,7 @@ def deserialize_enum(data, 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, - ) + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) return Deserializer.deserialize_unicode(data) @staticmethod @@ -1862,8 +1953,9 @@ def deserialize_bytearray(attr): """Deserialize string into bytearray. :param str attr: response string to be deserialized. + :return: Deserialized bytearray :rtype: bytearray - :raises: TypeError if string format invalid. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1874,8 +1966,9 @@ def deserialize_base64(attr): """Deserialize base64 encoded string into string. :param str attr: response string to be deserialized. + :return: Deserialized base64 string :rtype: bytearray - :raises: TypeError if string format invalid. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1889,24 +1982,26 @@ 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. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal """ if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) # type: ignore + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) - raise_with_traceback(DeserializationError, msg, err) + 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. + :return: Deserialized int :rtype: long or int - :raises: ValueError if string format invalid. + :raises ValueError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1917,8 +2012,9 @@ def deserialize_duration(attr): """Deserialize ISO-8601 formatted string into TimeDelta object. :param str attr: response string to be deserialized. + :return: Deserialized duration :rtype: TimeDelta - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1926,17 +2022,59 @@ def deserialize_duration(attr): duration = isodate.parse_duration(attr) except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." - raise_with_traceback(DeserializationError, msg, err) - else: - return duration + raise DeserializationError(msg) from err + return duration + + @staticmethod + def _deserialize_duration_numeric(attr, unit): + """Deserialize a numeric duration value into a TimeDelta object. + + :param float attr: response value to be deserialized. + :param str unit: The wire unit, used as the ``timedelta`` keyword + (``"seconds"`` or ``"milliseconds"``). + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = datetime.timedelta(**{unit: float(attr)}) # type: ignore + except (ValueError, OverflowError, TypeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_duration_seconds(attr): + """Deserialize a numeric number of seconds into a TimeDelta object. + + :param float attr: response value to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + return Deserializer._deserialize_duration_numeric(attr, "seconds") + + @staticmethod + def deserialize_duration_milliseconds(attr): + """Deserialize a numeric number of milliseconds into a TimeDelta object. + + :param float attr: response value to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + return Deserializer._deserialize_duration_numeric(attr, "milliseconds") @staticmethod def deserialize_date(attr): """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. + :return: Deserialized date :rtype: Date - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1950,8 +2088,9 @@ def deserialize_time(attr): """Deserialize ISO-8601 formatted string into time object. :param str attr: response string to be deserialized. + :return: Deserialized time :rtype: datetime.time - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1964,31 +2103,32 @@ def deserialize_rfc(attr): """Deserialize RFC-1123 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime :rtype: Datetime - :raises: DeserializationError if string format invalid. + :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)) + *parsed_date[:6], tzinfo=datetime.timezone(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_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj @staticmethod def deserialize_iso(attr): """Deserialize ISO-8601 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime :rtype: Datetime - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -2015,9 +2155,8 @@ def deserialize_iso(attr): raise OverflowError("Hit max or min date") except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." - raise_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj @staticmethod def deserialize_unix(attr): @@ -2025,15 +2164,16 @@ def deserialize_unix(attr): This is represented as seconds. :param int attr: Object to be serialized. + :return: Deserialized datetime :rtype: Datetime - :raises: DeserializationError if format invalid + :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_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_version.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_version.py new file mode 100644 index 000000000000..4e2942f574c4 --- /dev/null +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/_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.6.0" diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/__init__.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/__init__.py index 7d62ac6effd1..1ddad049d3ea 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/__init__.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/__init__.py @@ -2,22 +2,28 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import CommunicationIdentityClient +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import IdentityClient # type: ignore try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ - "CommunicationIdentityClient", + "IdentityClient", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_client.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_client.py index 0c09e59bf350..2aaabe8b1832 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_client.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_client.py @@ -2,33 +2,47 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# 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 +import sys from typing import Any, Awaitable from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest -from .. import models as _models -from .._serialization import Deserializer, Serializer -from ._configuration import CommunicationIdentityClientConfiguration -from .operations import CommunicationIdentityOperations +from .._utils.serialization import Deserializer, Serializer +from ._configuration import IdentityClientConfiguration +from .operations import IdentityOperationsOperations, TeamsExtensionOperationsOperations, TeamsUserOperationsOperations +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self # type: ignore -class CommunicationIdentityClient: # pylint: disable=client-accepts-api-version-keyword + +class IdentityClient: # pylint: disable=docstring-keyword-should-match-keyword-only """Azure Communication Identity Service. - :ivar communication_identity: CommunicationIdentityOperations operations - :vartype communication_identity: - azure.communication.identity.aio.operations.CommunicationIdentityOperations + :ivar identity_operations: IdentityOperationsOperations operations + :vartype identity_operations: + azure.communication.identity.aio.operations.IdentityOperationsOperations + :ivar teams_user_operations: TeamsUserOperationsOperations operations + :vartype teams_user_operations: + azure.communication.identity.aio.operations.TeamsUserOperationsOperations + :ivar teams_extension_operations: TeamsExtensionOperationsOperations operations + :vartype teams_extension_operations: + azure.communication.identity.aio.operations.TeamsExtensionOperationsOperations :param endpoint: The communication resource, for example - https://my-resource.communication.azure.com. Required. + `https://my-resource.communication.azure.com `_. + Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2023-10-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are "2026-09-23" + and None. Default value is None. If not set, the operation's default API version will be used. + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -36,18 +50,43 @@ def __init__( # pylint: disable=missing-client-constructor-parameter-credential self, endpoint: str, **kwargs: Any ) -> None: _endpoint = "{endpoint}" - self._config = CommunicationIdentityClientConfiguration(endpoint=endpoint, **kwargs) - self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) - - client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)} - self._serialize = Serializer(client_models) - self._deserialize = Deserializer(client_models) + self._config = IdentityClientConfiguration(endpoint=endpoint, **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 - self.communication_identity = CommunicationIdentityOperations( + self.identity_operations = IdentityOperationsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.teams_user_operations = TeamsUserOperationsOperations( + self._client, self._config, self._serialize, self._deserialize + ) + self.teams_extension_operations = TeamsExtensionOperationsOperations( self._client, self._config, self._serialize, self._deserialize ) - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + 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 @@ -71,12 +110,12 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + 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) -> "CommunicationIdentityClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_configuration.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_configuration.py index fe759886cbce..d67c45d46467 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_configuration.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_configuration.py @@ -1,45 +1,45 @@ +# pylint: disable=line-too-long,useless-suppression # 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) AutoRest Code Generator. +# 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 -from azure.core.configuration import Configuration from azure.core.pipeline import policies -VERSION = "unknown" +from .._version import VERSION -class CommunicationIdentityClientConfiguration( # pylint: disable=too-many-instance-attributes,name-too-long - Configuration -): - """Configuration for CommunicationIdentityClient. +class IdentityClientConfiguration: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only + """Configuration for IdentityClient. 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. + `https://my-resource.communication.azure.com `_. + Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2023-10-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are "2026-09-23" + and None. Default value is None. If not set, the operation's default API version will be used. + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, **kwargs: Any) -> None: - super(CommunicationIdentityClientConfiguration, self).__init__(**kwargs) - api_version: str = kwargs.pop("api_version", "2023-10-01") + api_version: str = kwargs.pop("api_version", "2026-09-23") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") self.endpoint = endpoint self.api_version = api_version - kwargs.setdefault("sdk_moniker", "communicationidentityclient/{}".format(VERSION)) + kwargs.setdefault("sdk_moniker", "communication-identity/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -48,7 +48,7 @@ def _configure(self, **kwargs: Any) -> None: 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.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**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") diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_patch.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_patch.py index 17dbc073e01b..ea765788358a 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_patch.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/_patch.py @@ -1,32 +1,20 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# # 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. -# +# Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level -# This file is used for handwritten extensions to the generated code. Example: -# https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_code/how-to-patch-sdk-code.md def patch_sdk(): - pass + """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-identity/azure/communication/identity/_generated/aio/operations/__init__.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/__init__.py index 2c8ddc0b3dd9..46690414aedf 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/__init__.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/__init__.py @@ -2,18 +2,28 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import CommunicationIdentityOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import IdentityOperationsOperations # type: ignore +from ._operations import TeamsUserOperationsOperations # type: ignore +from ._operations import TeamsExtensionOperationsOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ - "CommunicationIdentityOperations", + "IdentityOperationsOperations", + "TeamsUserOperationsOperations", + "TeamsExtensionOperationsOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_operations.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_operations.py index d3449860771f..1db7bd9ffd84 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_operations.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_operations.py @@ -3,18 +3,23 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from collections.abc import MutableMapping from io import IOBase -from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, overload +import json +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +from azure.core import AsyncPipelineClient from azure.core.exceptions import ( ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.pipeline import PipelineResponse @@ -22,37 +27,42 @@ from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict -from ... import models as _models +from ... import models as _models, types as _types +from ..._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from ..._utils.serialization import Deserializer, Serializer from ...operations._operations import ( - build_communication_identity_create_request, - build_communication_identity_delete_request, - build_communication_identity_exchange_teams_user_access_token_request, - build_communication_identity_issue_access_token_request, - build_communication_identity_revoke_access_tokens_request, + build_identity_operations_create_request, + build_identity_operations_delete_request, + build_identity_operations_issue_access_token_request, + build_identity_operations_revoke_access_tokens_request, + build_teams_extension_operations_delete_assignment_request, + build_teams_extension_operations_exchange_token_request, + build_teams_extension_operations_get_assignment_request, + build_teams_extension_operations_upsert_assignment_request, + build_teams_user_operations_exchange_teams_user_access_token_request, ) +from .._configuration import IdentityClientConfiguration T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] -class CommunicationIdentityOperations: +class IdentityOperationsOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~azure.communication.identity.aio.CommunicationIdentityClient`'s - :attr:`communication_identity` attribute. + :class:`~azure.communication.identity.aio.IdentityClient`'s + :attr:`identity_operations` attribute. """ - models = _models - def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: IdentityClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @overload async def create( @@ -68,18 +78,23 @@ async def create( :param body: If specified, creates also a Communication Identity access token associated with the identity and containing the requested scopes. Default value is None. - :type body: ~azure.communication.identity.models.CommunicationIdentityCreateRequest + :type body: ~azure.communication.identity._generated.models.CommunicationIdentityCreateRequest :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: CommunicationIdentityAccessTokenResult - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessTokenResult + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ @overload async def create( - self, body: Optional[IO] = None, *, content_type: str = "application/json", **kwargs: Any + self, + body: Optional[_types.CommunicationIdentityCreateRequest] = None, + *, + content_type: str = "application/json", + **kwargs: Any ) -> _models.CommunicationIdentityAccessTokenResult: """Create a new identity, and optionally, an access token. @@ -87,18 +102,43 @@ async def create( :param body: If specified, creates also a Communication Identity access token associated with the identity and containing the requested scopes. Default value is None. - :type body: IO + :type body: ~azure.communication.identity._generated.types.CommunicationIdentityCreateRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create( + self, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Create a new identity, and optionally, an access token. + + Create a new identity, and optionally, an access token. + + :param body: If specified, creates also a Communication Identity access token associated with + the identity and containing the requested scopes. Default value is None. + :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: CommunicationIdentityAccessTokenResult - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessTokenResult + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace_async async def create( - self, body: Optional[Union[_models.CommunicationIdentityCreateRequest, IO]] = None, **kwargs: Any + self, + body: Optional[ + Union[_models.CommunicationIdentityCreateRequest, _types.CommunicationIdentityCreateRequest, IO[bytes]] + ] = None, + **kwargs: Any ) -> _models.CommunicationIdentityAccessTokenResult: """Create a new identity, and optionally, an access token. @@ -106,16 +146,16 @@ async def create( :param body: If specified, creates also a Communication Identity access token associated with the identity and containing the requested scopes. Is either a - CommunicationIdentityCreateRequest type or a IO type. Default value is None. - :type body: ~azure.communication.identity.models.CommunicationIdentityCreateRequest or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: CommunicationIdentityAccessTokenResult - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessTokenResult + CommunicationIdentityCreateRequest type or a IO[bytes] type. Default value is None. + :type body: ~azure.communication.identity._generated.models.CommunicationIdentityCreateRequest + or ~azure.communication.identity._generated.types.CommunicationIdentityCreateRequest or + IO[bytes] + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -127,23 +167,22 @@ async def create( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if body else None cls: ClsType[_models.CommunicationIdentityAccessTokenResult] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if body else None _content = None if isinstance(body, (IOBase, bytes)): _content = body else: if body is not None: - _json = self._serialize.body(body, "CommunicationIdentityCreateRequest") + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_communication_identity_create_request( + _request = build_identity_operations_create_request( content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, @@ -151,31 +190,41 @@ async def create( 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("CommunicationIdentityAccessTokenResult", pipeline_response) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessTokenResult, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace_async - async def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + async def delete(self, id: str, **kwargs: Any) -> None: """Delete the identity, revoke all tokens for the identity and delete all associated data. Delete the identity, revoke all tokens for the identity and delete all associated data. @@ -186,7 +235,7 @@ async def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=incon :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -199,7 +248,7 @@ async def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=incon cls: ClsType[None] = kwargs.pop("cls", None) - request = build_communication_identity_delete_request( + _request = build_identity_operations_delete_request( id=id, api_version=self._config.api_version, headers=_headers, @@ -208,29 +257,28 @@ async def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=incon 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: - 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) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace_async - async def revoke_access_tokens( # pylint: disable=inconsistent-return-statements - self, id: str, **kwargs: Any - ) -> None: + async def revoke_access_tokens(self, id: str, **kwargs: Any) -> None: """Revoke all access tokens for the specific identity. Revoke all access tokens for the specific identity. @@ -241,7 +289,7 @@ async def revoke_access_tokens( # pylint: disable=inconsistent-return-statement :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -254,7 +302,7 @@ async def revoke_access_tokens( # pylint: disable=inconsistent-return-statement cls: ClsType[None] = kwargs.pop("cls", None) - request = build_communication_identity_revoke_access_tokens_request( + _request = build_identity_operations_revoke_access_tokens_request( id=id, api_version=self._config.api_version, headers=_headers, @@ -263,86 +311,295 @@ async def revoke_access_tokens( # pylint: disable=inconsistent-return-statement 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def issue_access_token( + self, + id: str, + body: _models.CommunicationIdentityAccessTokenRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. Required. + :type body: + ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def issue_access_token( + self, + id: str, + body: _types.CommunicationIdentityAccessTokenRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. Required. + :type body: + ~azure.communication.identity._generated.types.CommunicationIdentityAccessTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def issue_access_token( + self, id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. 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: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def issue_access_token( + self, + id: str, + body: Union[ + _models.CommunicationIdentityAccessTokenRequest, _types.CommunicationIdentityAccessTokenRequest, IO[bytes] + ], + **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. Is either a + CommunicationIdentityAccessTokenRequest type or a IO[bytes] type. Required. + :type body: + ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenRequest or + ~azure.communication.identity._generated.types.CommunicationIdentityAccessTokenRequest or + IO[bytes] + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 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.CommunicationIdentityAccessToken] = 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_identity_operations_issue_access_token_request( + id=id, + 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) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await 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: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessToken, response.json()) + if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class TeamsUserOperationsOperations: # pylint: disable=docstring-missing-param + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.communication.identity.aio.IdentityClient`'s + :attr:`teams_user_operations` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: IdentityClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @overload async def exchange_teams_user_access_token( self, body: _models.TeamsUserExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any ) -> _models.CommunicationIdentityAccessToken: - """Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. + + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. + + :param body: Request payload for the token exchange. Required. + :type body: ~azure.communication.identity._generated.models.TeamsUserExchangeTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def exchange_teams_user_access_token( + self, body: _types.TeamsUserExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. - Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. :param body: Request payload for the token exchange. Required. - :type body: ~azure.communication.identity.models.TeamsUserExchangeTokenRequest + :type body: ~azure.communication.identity._generated.types.TeamsUserExchangeTokenRequest :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken :raises ~azure.core.exceptions.HttpResponseError: """ @overload async def exchange_teams_user_access_token( - self, body: IO, *, content_type: str = "application/json", **kwargs: Any + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.CommunicationIdentityAccessToken: - """Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. - Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. :param body: Request payload for the token exchange. Required. - :type body: IO + :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: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace_async async def exchange_teams_user_access_token( - self, body: Union[_models.TeamsUserExchangeTokenRequest, IO], **kwargs: Any + self, + body: Union[_models.TeamsUserExchangeTokenRequest, _types.TeamsUserExchangeTokenRequest, IO[bytes]], + **kwargs: Any ) -> _models.CommunicationIdentityAccessToken: - """Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. - Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. :param body: Request payload for the token exchange. Is either a TeamsUserExchangeTokenRequest - type or a IO type. Required. - :type body: ~azure.communication.identity.models.TeamsUserExchangeTokenRequest or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + type or a IO[bytes] type. Required. + :type body: ~azure.communication.identity._generated.models.TeamsUserExchangeTokenRequest or + ~azure.communication.identity._generated.types.TeamsUserExchangeTokenRequest or IO[bytes] + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -357,17 +614,15 @@ async def exchange_teams_user_access_token( cls: ClsType[_models.CommunicationIdentityAccessToken] = kwargs.pop("cls", None) content_type = content_type or "application/json" - _json = None _content = None if isinstance(body, (IOBase, bytes)): _content = body else: - _json = self._serialize.body(body, "TeamsUserExchangeTokenRequest") + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_communication_identity_exchange_teams_user_access_token_request( + _request = build_teams_user_operations_exchange_teams_user_access_token_request( content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, @@ -375,95 +630,386 @@ async def exchange_teams_user_access_token( 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _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 + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("CommunicationIdentityAccessToken", pipeline_response) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessToken, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class TeamsExtensionOperationsOperations: # pylint: disable=docstring-missing-param + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.communication.identity.aio.IdentityClient`'s + :attr:`teams_extension_operations` attribute. + """ - return deserialized + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: IdentityClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @overload - async def issue_access_token( - self, - id: str, - body: _models.CommunicationIdentityAccessTokenRequest, - *, - content_type: str = "application/json", - **kwargs: Any - ) -> _models.CommunicationIdentityAccessToken: - """Issue a new token for an identity. + async def exchange_token( + self, body: _models.TeamsExtensionExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. - Issue a new token for an identity. + Exchanges a Teams Phone token for an ACS user access token. - :param id: Identifier of the identity to issue token for. Required. - :type id: str - :param body: Requested scopes for the new token. Required. - :type body: ~azure.communication.identity.models.CommunicationIdentityAccessTokenRequest + :param body: Request payload for the token exchange. Required. + :type body: ~azure.communication.identity._generated.models.TeamsExtensionExchangeTokenRequest :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ @overload - async def issue_access_token( - self, id: str, body: IO, *, content_type: str = "application/json", **kwargs: Any - ) -> _models.CommunicationIdentityAccessToken: - """Issue a new token for an identity. + async def exchange_token( + self, body: _types.TeamsExtensionExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. - Issue a new token for an identity. + Exchanges a Teams Phone token for an ACS user access token. - :param id: Identifier of the identity to issue token for. Required. - :type id: str - :param body: Requested scopes for the new token. Required. - :type body: IO + :param body: Request payload for the token exchange. Required. + :type body: ~azure.communication.identity._generated.types.TeamsExtensionExchangeTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def exchange_token( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. + + Exchanges a Teams Phone token for an ACS user access token. + + :param body: Request payload for the token exchange. 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: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace_async - async def issue_access_token( - self, id: str, body: Union[_models.CommunicationIdentityAccessTokenRequest, IO], **kwargs: Any - ) -> _models.CommunicationIdentityAccessToken: - """Issue a new token for an identity. + async def exchange_token( + self, + body: Union[_models.TeamsExtensionExchangeTokenRequest, _types.TeamsExtensionExchangeTokenRequest, IO[bytes]], + **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. + + Exchanges a Teams Phone token for an ACS user access token. + + :param body: Request payload for the token exchange. Is either a + TeamsExtensionExchangeTokenRequest type or a IO[bytes] type. Required. + :type body: ~azure.communication.identity._generated.models.TeamsExtensionExchangeTokenRequest + or ~azure.communication.identity._generated.types.TeamsExtensionExchangeTokenRequest or + IO[bytes] + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) - Issue a new token for an identity. + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} - :param id: Identifier of the identity to issue token for. Required. - :type id: str - :param body: Requested scopes for the new token. Is either a - CommunicationIdentityAccessTokenRequest type or a IO type. Required. - :type body: ~azure.communication.identity.models.CommunicationIdentityAccessTokenRequest or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.CommunicationIdentityAccessTokenResult] = 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_teams_extension_operations_exchange_token_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) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await 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: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessTokenResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_assignment( + self, tenant_id: str, object_id: str, **kwargs: Any + ) -> _models.TeamsExtensionAssignmentResponse: + """Get Teams Phone access assignment by object id. + + Get Teams Phone access assignment by object id. + + :param tenant_id: Tenant Id we want to get the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to get the assignment for. Required. + :type object_id: str + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 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[_models.TeamsExtensionAssignmentResponse] = kwargs.pop("cls", None) + + _request = build_teams_extension_operations_get_assignment_request( + tenant_id=tenant_id, + object_id=object_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) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await 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: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TeamsExtensionAssignmentResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def upsert_assignment( + self, + tenant_id: str, + object_id: str, + body: _models.TeamsExtensionAssignmentCreateOrUpdateRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. Required. + :type body: + ~azure.communication.identity._generated.models.TeamsExtensionAssignmentCreateOrUpdateRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def upsert_assignment( + self, + tenant_id: str, + object_id: str, + body: _types.TeamsExtensionAssignmentCreateOrUpdateRequest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. Required. + :type body: + ~azure.communication.identity._generated.types.TeamsExtensionAssignmentCreateOrUpdateRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def upsert_assignment( + self, tenant_id: str, object_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. 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: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def upsert_assignment( + self, + tenant_id: str, + object_id: str, + body: Union[ + _models.TeamsExtensionAssignmentCreateOrUpdateRequest, + _types.TeamsExtensionAssignmentCreateOrUpdateRequest, + IO[bytes], + ], + **kwargs: Any + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. Is either a TeamsExtensionAssignmentCreateOrUpdateRequest + type or a IO[bytes] type. Required. + :type body: + ~azure.communication.identity._generated.models.TeamsExtensionAssignmentCreateOrUpdateRequest + or ~azure.communication.identity._generated.types.TeamsExtensionAssignmentCreateOrUpdateRequest + or IO[bytes] + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -475,21 +1021,20 @@ async def issue_access_token( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.CommunicationIdentityAccessToken] = kwargs.pop("cls", None) + cls: ClsType[_models.TeamsExtensionAssignmentResponse] = kwargs.pop("cls", None) content_type = content_type or "application/json" - _json = None _content = None if isinstance(body, (IOBase, bytes)): _content = body else: - _json = self._serialize.body(body, "CommunicationIdentityAccessTokenRequest") + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_communication_identity_issue_access_token_request( - id=id, + _request = build_teams_extension_operations_upsert_assignment_request( + tenant_id=tenant_id, + object_id=object_id, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, @@ -497,25 +1042,92 @@ async def issue_access_token( 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200]: + if response.status_code not in [200, 201]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("CommunicationIdentityAccessToken", pipeline_response) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TeamsExtensionAssignmentResponse, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_assignment(self, tenant_id: str, object_id: str, **kwargs: Any) -> None: + """Removes a Teams Phone access assignment. + + Removes a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to remove the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to remove the assignment for. Required. + :type object_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) - return deserialized + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_teams_extension_operations_delete_assignment_request( + tenant_id=tenant_id, + object_id=object_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 = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_patch.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_patch.py index f7dd32510333..ea765788358a 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_patch.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/aio/operations/_patch.py @@ -1,14 +1,14 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# 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. +# -------------------------------------------------------------------------- """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 +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/__init__.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/__init__.py index 9a71cff104ed..5daaa68dd7e1 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/__init__.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/__init__.py @@ -2,22 +2,37 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._models import CommunicationError -from ._models import CommunicationErrorResponse -from ._models import CommunicationIdentity -from ._models import CommunicationIdentityAccessToken -from ._models import CommunicationIdentityAccessTokenRequest -from ._models import CommunicationIdentityAccessTokenResult -from ._models import CommunicationIdentityCreateRequest -from ._models import TeamsUserExchangeTokenRequest +from typing import TYPE_CHECKING -from ._enums import CommunicationTokenScope +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + CommunicationError, + CommunicationErrorResponse, + CommunicationIdentity, + CommunicationIdentityAccessToken, + CommunicationIdentityAccessTokenRequest, + CommunicationIdentityAccessTokenResult, + CommunicationIdentityCreateRequest, + TeamsExtensionAssignmentCreateOrUpdateRequest, + TeamsExtensionAssignmentResponse, + TeamsExtensionExchangeTokenRequest, + TeamsUserExchangeTokenRequest, +) + +from ._enums import ( # type: ignore + CommunicationTokenScope, + TeamsExtensionPrincipalType, +) from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ @@ -28,8 +43,12 @@ "CommunicationIdentityAccessTokenRequest", "CommunicationIdentityAccessTokenResult", "CommunicationIdentityCreateRequest", + "TeamsExtensionAssignmentCreateOrUpdateRequest", + "TeamsExtensionAssignmentResponse", + "TeamsExtensionExchangeTokenRequest", "TeamsUserExchangeTokenRequest", "CommunicationTokenScope", + "TeamsExtensionPrincipalType", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_enums.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_enums.py index e95bddd653ed..5618e7dff5f6 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_enums.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_enums.py @@ -2,7 +2,7 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- @@ -21,6 +21,15 @@ class CommunicationTokenScope(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Access to Chat APIs but without the authorization to create, delete or update chat threads.""" CHAT_JOIN_LIMITED = "chat.join.limited" """A more limited version of chat.join that doesn't allow to add or remove participants. Use this - #: scope when the token bearer is not fully trusted, for example in guest scenarios.""" + scope when the token bearer is not fully trusted, for example in guest scenarios.""" VOIP_JOIN = "voip.join" """Access to Calling APIs but without the authorization to start new calls.""" + + +class TeamsExtensionPrincipalType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The type of principal the assignment is for.""" + + RESOURCE_ACCOUNT = "resourceAccount" + """Resource account principal type.""" + USER = "user" + """User principal type.""" diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_models.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_models.py index a9f24485d60b..3d954eddc038 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_models.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_models.py @@ -1,28 +1,24 @@ # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation -from typing import Any, List, Optional, TYPE_CHECKING, Union +import datetime +from typing import Any, Mapping, Optional, TYPE_CHECKING, Union, overload -from .. import _serialization +from .._utils.model_base import Model as _Model, rest_field if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from .. import models as _models -class CommunicationError(_serialization.Model): +class CommunicationError(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The Communication Services error. - 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 Azure. - :ivar code: The error code. Required. :vartype code: str :ivar message: The error message. Required. @@ -30,131 +26,134 @@ class CommunicationError(_serialization.Model): :ivar target: The error target. :vartype target: str :ivar details: Further details about specific errors that led to this error. - :vartype details: list[~azure.communication.identity.models.CommunicationError] + :vartype details: list[~azure.communication.identity._generated.models.CommunicationError] :ivar inner_error: The inner error if any. - :vartype inner_error: ~azure.communication.identity.models.CommunicationError + :vartype inner_error: ~azure.communication.identity._generated.models.CommunicationError """ - _validation = { - "code": {"required": True}, - "message": {"required": True}, - "target": {"readonly": True}, - "details": {"readonly": True}, - "inner_error": {"readonly": True}, - } - - _attribute_map = { - "code": {"key": "code", "type": "str"}, - "message": {"key": "message", "type": "str"}, - "target": {"key": "target", "type": "str"}, - "details": {"key": "details", "type": "[CommunicationError]"}, - "inner_error": {"key": "innererror", "type": "CommunicationError"}, - } - - def __init__(self, *, code: str, message: str, **kwargs: Any) -> None: + code: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The error code. Required.""" + message: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The error message. Required.""" + target: Optional[str] = rest_field(visibility=["read"]) + """The error target.""" + details: Optional[list["_models.CommunicationError"]] = rest_field(visibility=["read"]) + """Further details about specific errors that led to this error.""" + inner_error: Optional["_models.CommunicationError"] = rest_field(name="innererror", visibility=["read"]) + """The inner error if any.""" + + @overload + def __init__( + self, + *, + code: str, + message: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword code: The error code. Required. - :paramtype code: str - :keyword message: The error message. Required. - :paramtype message: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.code = code - self.message = message - self.target = None - self.details = None - self.inner_error = None + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class CommunicationErrorResponse(_serialization.Model): - """The Communication Services error. - All required parameters must be populated in order to send to Azure. +class CommunicationErrorResponse(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """The Communication Services error. :ivar error: The Communication Services error. Required. - :vartype error: ~azure.communication.identity.models.CommunicationError + :vartype error: ~azure.communication.identity._generated.models.CommunicationError """ - _validation = { - "error": {"required": True}, - } + error: "_models.CommunicationError" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The Communication Services error. Required.""" - _attribute_map = { - "error": {"key": "error", "type": "CommunicationError"}, - } + @overload + def __init__( + self, + *, + error: "_models.CommunicationError", + ) -> None: ... - def __init__(self, *, error: "_models.CommunicationError", **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword error: The Communication Services error. Required. - :paramtype error: ~azure.communication.identity.models.CommunicationError + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.error = error + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class CommunicationIdentity(_serialization.Model): - """A communication identity. - All required parameters must be populated in order to send to Azure. +class CommunicationIdentity(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """A communication identity. :ivar id: Identifier of the identity. Required. :vartype id: str """ - _validation = { - "id": {"required": True}, - } + id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Identifier of the identity. Required.""" - _attribute_map = { - "id": {"key": "id", "type": "str"}, - } + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + ) -> None: ... - def __init__(self, *, id: str, **kwargs: Any) -> None: # pylint: disable=redefined-builtin + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword id: Identifier of the identity. Required. - :paramtype id: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.id = id + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class CommunicationIdentityAccessToken(_serialization.Model): - """An access token. - All required parameters must be populated in order to send to Azure. +class CommunicationIdentityAccessToken(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """An access token. :ivar token: The access token issued for the identity. Required. :vartype token: str :ivar expires_on: The expiry time of the token. Required. - :vartype expires_on: str + :vartype expires_on: ~datetime.datetime """ - _validation = { - "token": {"required": True}, - "expires_on": {"required": True}, - } + token: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The access token issued for the identity. Required.""" + expires_on: datetime.datetime = rest_field( + name="expiresOn", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The expiry time of the token. Required.""" - _attribute_map = { - "token": {"key": "token", "type": "str"}, - "expires_on": {"key": "expiresOn", "type": "str"}, - } + @overload + def __init__( + self, + *, + token: str, + expires_on: datetime.datetime, + ) -> None: ... - def __init__(self, *, token: str, expires_on: str, **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword token: The access token issued for the identity. Required. - :paramtype token: str - :keyword expires_on: The expiry time of the token. Required. - :paramtype expires_on: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.token = token - self.expires_on = expires_on + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class CommunicationIdentityAccessTokenRequest(_serialization.Model): - """CommunicationIdentityAccessTokenRequest. - All required parameters must be populated in order to send to Azure. +class CommunicationIdentityAccessTokenRequest(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """Request to issue a new access token for an identity. :ivar scopes: List of scopes attached to the token. Required. :vartype scopes: list[str or ~azure.communication.identity.models.CommunicationTokenScope] @@ -163,78 +162,73 @@ class CommunicationIdentityAccessTokenRequest(_serialization.Model): :vartype expires_in_minutes: int """ - _validation = { - "scopes": {"required": True}, - "expires_in_minutes": {"maximum": 1440, "minimum": 60}, - } - - _attribute_map = { - "scopes": {"key": "scopes", "type": "[str]"}, - "expires_in_minutes": {"key": "expiresInMinutes", "type": "int"}, - } - + scopes: list[Union[str, "_models.CommunicationTokenScope"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """List of scopes attached to the token. Required.""" + expires_in_minutes: Optional[int] = rest_field( + name="expiresInMinutes", visibility=["read", "create", "update", "delete", "query"] + ) + """Optional custom validity period of the token within [60,1440] minutes range. If not provided, + the default value of 1440 minutes (24 hours) will be used.""" + + @overload def __init__( self, *, - scopes: List[Union[str, "_models.CommunicationTokenScope"]], - expires_in_minutes: int = 1440, - **kwargs: Any - ) -> None: + scopes: list[Union[str, "_models.CommunicationTokenScope"]], + expires_in_minutes: Optional[int] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword scopes: List of scopes attached to the token. Required. - :paramtype scopes: list[str or ~azure.communication.identity.models.CommunicationTokenScope] - :keyword expires_in_minutes: Optional custom validity period of the token within [60,1440] - minutes range. If not provided, the default value of 1440 minutes (24 hours) will be used. - :paramtype expires_in_minutes: int + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.scopes = scopes - self.expires_in_minutes = expires_in_minutes + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class CommunicationIdentityAccessTokenResult(_serialization.Model): - """A communication identity with access token. - All required parameters must be populated in order to send to Azure. +class CommunicationIdentityAccessTokenResult(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """A communication identity with access token. - :ivar identity: A communication identity. Required. - :vartype identity: ~azure.communication.identity.models.CommunicationIdentity + :ivar identity: The communication identity. Required. + :vartype identity: ~azure.communication.identity._generated.models.CommunicationIdentity :ivar access_token: An access token. - :vartype access_token: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :vartype access_token: + ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken """ - _validation = { - "identity": {"required": True}, - } - - _attribute_map = { - "identity": {"key": "identity", "type": "CommunicationIdentity"}, - "access_token": { - "key": "accessToken", - "type": "CommunicationIdentityAccessToken", - }, - } + identity: "_models.CommunicationIdentity" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The communication identity. Required.""" + access_token: Optional["_models.CommunicationIdentityAccessToken"] = rest_field( + name="accessToken", visibility=["read", "create", "update", "delete", "query"] + ) + """An access token.""" + @overload def __init__( self, *, identity: "_models.CommunicationIdentity", access_token: Optional["_models.CommunicationIdentityAccessToken"] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword identity: A communication identity. Required. - :paramtype identity: ~azure.communication.identity.models.CommunicationIdentity - :keyword access_token: An access token. - :paramtype access_token: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.identity = identity - self.access_token = access_token + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class CommunicationIdentityCreateRequest(_serialization.Model): - """CommunicationIdentityCreateRequest. +class CommunicationIdentityCreateRequest(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """Request to create a new identity with optional access token. :ivar create_token_with_scopes: Also create access token for the created identity. :vartype create_token_with_scopes: list[str or @@ -244,76 +238,170 @@ class CommunicationIdentityCreateRequest(_serialization.Model): :vartype expires_in_minutes: int """ - _validation = { - "expires_in_minutes": {"maximum": 1440, "minimum": 60}, - } + create_token_with_scopes: Optional[list[Union[str, "_models.CommunicationTokenScope"]]] = rest_field( + name="createTokenWithScopes", visibility=["read", "create", "update", "delete", "query"] + ) + """Also create access token for the created identity.""" + expires_in_minutes: Optional[int] = rest_field( + name="expiresInMinutes", visibility=["read", "create", "update", "delete", "query"] + ) + """Optional custom validity period of the token within [60,1440] minutes range. If not provided, + the default value of 1440 minutes (24 hours) will be used.""" + + @overload + def __init__( + self, + *, + create_token_with_scopes: Optional[list[Union[str, "_models.CommunicationTokenScope"]]] = None, + expires_in_minutes: Optional[int] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + - _attribute_map = { - "create_token_with_scopes": {"key": "createTokenWithScopes", "type": "[str]"}, - "expires_in_minutes": {"key": "expiresInMinutes", "type": "int"}, - } +class TeamsExtensionAssignmentCreateOrUpdateRequest( + _Model +): # pylint: disable=name-too-long,docstring-keyword-should-match-keyword-only + """A request to create or update a Teams Extension assignment. + :ivar principal_type: The type of principal the assignment is for. Required. Known values are: + "resourceAccount" and "user". + :vartype principal_type: str or + ~azure.communication.identity.models.TeamsExtensionPrincipalType + :ivar client_ids: The client IDs for the assignment. + :vartype client_ids: list[str] + """ + + principal_type: Union[str, "_models.TeamsExtensionPrincipalType"] = rest_field( + name="principalType", visibility=["read", "create", "update", "delete", "query"] + ) + """The type of principal the assignment is for. Required. Known values are: \"resourceAccount\" + and \"user\".""" + client_ids: Optional[list[str]] = rest_field( + name="clientIds", visibility=["read", "create", "update", "delete", "query"] + ) + """The client IDs for the assignment.""" + + @overload def __init__( self, *, - create_token_with_scopes: Optional[List[Union[str, "_models.CommunicationTokenScope"]]] = None, - expires_in_minutes: int = 1440, - **kwargs: Any - ) -> None: + principal_type: Union[str, "_models.TeamsExtensionPrincipalType"], + client_ids: Optional[list[str]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword create_token_with_scopes: Also create access token for the created identity. - :paramtype create_token_with_scopes: list[str or - ~azure.communication.identity.models.CommunicationTokenScope] - :keyword expires_in_minutes: Optional custom validity period of the token within [60,1440] - minutes range. If not provided, the default value of 1440 minutes (24 hours) will be used. - :paramtype expires_in_minutes: int + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.create_token_with_scopes = create_token_with_scopes - self.expires_in_minutes = expires_in_minutes + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class TeamsUserExchangeTokenRequest(_serialization.Model): - """TeamsUserExchangeTokenRequest. - All required parameters must be populated in order to send to Azure. +class TeamsExtensionAssignmentResponse(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """A Teams Extension assignment response. - :ivar token: Azure AD access token of a Teams User to acquire a new Communication Identity + :ivar object_id: The object ID of the assignment. Required. + :vartype object_id: str + :ivar tenant_id: The tenant ID of the assignment. Required. + :vartype tenant_id: str + :ivar principal_type: The type of principal the assignment is for. Required. Known values are: + "resourceAccount" and "user". + :vartype principal_type: str or + ~azure.communication.identity.models.TeamsExtensionPrincipalType + :ivar client_ids: The client IDs for the assignment. + :vartype client_ids: list[str] + """ + + object_id: str = rest_field(name="objectId", visibility=["read", "create", "update", "delete", "query"]) + """The object ID of the assignment. Required.""" + tenant_id: str = rest_field(name="tenantId", visibility=["read", "create", "update", "delete", "query"]) + """The tenant ID of the assignment. Required.""" + principal_type: Union[str, "_models.TeamsExtensionPrincipalType"] = rest_field( + name="principalType", visibility=["read", "create", "update", "delete", "query"] + ) + """The type of principal the assignment is for. Required. Known values are: \"resourceAccount\" + and \"user\".""" + client_ids: Optional[list[str]] = rest_field( + name="clientIds", visibility=["read", "create", "update", "delete", "query"] + ) + """The client IDs for the assignment.""" + + @overload + def __init__( + self, + *, + object_id: str, + tenant_id: str, + principal_type: Union[str, "_models.TeamsExtensionPrincipalType"], + client_ids: Optional[list[str]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class TeamsExtensionExchangeTokenRequest(_Model): + """A request to exchange a Teams Extension token.""" + + +class TeamsUserExchangeTokenRequest(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """A request to exchange a Teams user access token. + + :ivar token: Entra ID access token of a Teams User to acquire a new Communication Identity access token. Required. :vartype token: str - :ivar app_id: Client ID of an Azure AD application to be verified against the appid claim in - the Azure AD access token. Required. + :ivar app_id: Client ID of an Entra ID application to be verified against the appid claim in + the Entra ID access token. Required. :vartype app_id: str - :ivar user_id: Object ID of an Azure AD user (Teams User) to be verified against the oid claim - in the Azure AD access token. Required. + :ivar user_id: Object ID of an Entra ID user (Teams User) to be verified against the oid claim + in the Entra ID access token. Required. :vartype user_id: str """ - _validation = { - "token": {"required": True}, - "app_id": {"required": True}, - "user_id": {"required": True}, - } - - _attribute_map = { - "token": {"key": "token", "type": "str"}, - "app_id": {"key": "appId", "type": "str"}, - "user_id": {"key": "userId", "type": "str"}, - } + token: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Entra ID access token of a Teams User to acquire a new Communication Identity access token. + Required.""" + app_id: str = rest_field(name="appId", visibility=["read", "create", "update", "delete", "query"]) + """Client ID of an Entra ID application to be verified against the appid claim in the Entra ID + access token. Required.""" + user_id: str = rest_field(name="userId", visibility=["read", "create", "update", "delete", "query"]) + """Object ID of an Entra ID user (Teams User) to be verified against the oid claim in the Entra ID + access token. Required.""" + + @overload + def __init__( + self, + *, + token: str, + app_id: str, + user_id: str, + ) -> None: ... - def __init__(self, *, token: str, app_id: str, user_id: str, **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword token: Azure AD access token of a Teams User to acquire a new Communication Identity - access token. Required. - :paramtype token: str - :keyword app_id: Client ID of an Azure AD application to be verified against the appid claim in - the Azure AD access token. Required. - :paramtype app_id: str - :keyword user_id: Object ID of an Azure AD user (Teams User) to be verified against the oid - claim in the Azure AD access token. Required. - :paramtype user_id: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.token = token - self.app_id = app_id - self.user_id = user_id + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_patch.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_patch.py index f7dd32510333..ea765788358a 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_patch.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/models/_patch.py @@ -1,14 +1,14 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# 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. +# -------------------------------------------------------------------------- """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 +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/__init__.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/__init__.py index 2c8ddc0b3dd9..46690414aedf 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/__init__.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/__init__.py @@ -2,18 +2,28 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import CommunicationIdentityOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import IdentityOperationsOperations # type: ignore +from ._operations import TeamsUserOperationsOperations # type: ignore +from ._operations import TeamsExtensionOperationsOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ - "CommunicationIdentityOperations", + "IdentityOperationsOperations", + "TeamsUserOperationsOperations", + "TeamsExtensionOperationsOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_operations.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_operations.py index a60d0262ba38..b3495d1ac211 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_operations.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_operations.py @@ -3,18 +3,23 @@ # -------------------------------------------------------------------------- # 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) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from collections.abc import MutableMapping from io import IOBase -from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, overload +import json +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +from azure.core import PipelineClient from azure.core.exceptions import ( ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.pipeline import PipelineResponse @@ -22,24 +27,24 @@ from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict -from .. import models as _models -from .._serialization import Serializer +from .. import models as _models, types as _types +from .._configuration import IdentityClientConfiguration +from .._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from .._utils.serialization import Deserializer, Serializer T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] _SERIALIZER = Serializer() _SERIALIZER.client_side_validation = False -def build_communication_identity_create_request( - **kwargs: Any, -) -> HttpRequest: # pylint: disable=name-too-long +def build_identity_operations_create_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", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-09-23")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -56,13 +61,10 @@ def build_communication_identity_create_request( return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) -def build_communication_identity_delete_request(id: str, **kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) +def build_identity_operations_delete_request(id: str, **kwargs: Any) -> HttpRequest: _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) - accept = _headers.pop("Accept", "application/json") - + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-09-23")) # Construct URL _url = "/identities/{id}" path_format_arguments = { @@ -74,23 +76,41 @@ def build_communication_identity_delete_request(id: str, **kwargs: Any) -> HttpR # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) - return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) +def build_identity_operations_revoke_access_tokens_request( # pylint: disable=name-too-long + id: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-09-23")) + # Construct URL + _url = "/identities/{id}/:revokeAccessTokens" + path_format_arguments = { + "id": _SERIALIZER.url("id", id, "str"), + } -def build_communication_identity_revoke_access_tokens_request( # pylint: disable=name-too-long + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="POST", url=_url, params=_params, **kwargs) + + +def build_identity_operations_issue_access_token_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", "2023-10-01")) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-09-23")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/identities/{id}/:revokeAccessTokens" + _url = "/identities/{id}/:issueAccessToken" path_format_arguments = { "id": _SERIALIZER.url("id", id, "str"), } @@ -101,19 +121,21 @@ def build_communication_identity_revoke_access_tokens_request( # pylint: disabl _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) -def build_communication_identity_exchange_teams_user_access_token_request( # pylint: disable=name-too-long +def build_teams_user_operations_exchange_teams_user_access_token_request( # pylint: disable=name-too-long **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", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-09-23")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -130,20 +152,72 @@ def build_communication_identity_exchange_teams_user_access_token_request( # py return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) -def build_communication_identity_issue_access_token_request( # pylint: disable=name-too-long - id: str, **kwargs: Any +def build_teams_extension_operations_exchange_token_request( # pylint: disable=name-too-long + **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", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-09-23")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/identities/{id}/:issueAccessToken" + _url = "/access/teamsExtension/:exchangeAccessToken" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_teams_extension_operations_get_assignment_request( # pylint: disable=name-too-long + tenant_id: str, object_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", "2026-09-23")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/access/teamsExtension/tenants/{tenantId}/assignments/{objectId}" path_format_arguments = { - "id": _SERIALIZER.url("id", id, "str"), + "tenantId": _SERIALIZER.url("tenant_id", tenant_id, "str"), + "objectId": _SERIALIZER.url("object_id", object_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_teams_extension_operations_upsert_assignment_request( # pylint: disable=name-too-long + tenant_id: str, object_id: str, **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", "2026-09-23")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/access/teamsExtension/tenants/{tenantId}/assignments/{objectId}" + path_format_arguments = { + "tenantId": _SERIALIZER.url("tenant_id", tenant_id, "str"), + "objectId": _SERIALIZER.url("object_id", object_id, "str"), } _url: str = _url.format(**path_format_arguments) # type: ignore @@ -156,27 +230,46 @@ def build_communication_identity_issue_access_token_request( # pylint: disable= _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) -class CommunicationIdentityOperations: +def build_teams_extension_operations_delete_assignment_request( # pylint: disable=name-too-long + tenant_id: str, object_id: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-09-23")) + # Construct URL + _url = "/access/teamsExtension/tenants/{tenantId}/assignments/{objectId}" + path_format_arguments = { + "tenantId": _SERIALIZER.url("tenant_id", tenant_id, "str"), + "objectId": _SERIALIZER.url("object_id", object_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +class IdentityOperationsOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~azure.communication.identity.CommunicationIdentityClient`'s - :attr:`communication_identity` attribute. + :class:`~azure.communication.identity.IdentityClient`'s + :attr:`identity_operations` attribute. """ - models = _models - - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: IdentityClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @overload def create( @@ -192,19 +285,20 @@ def create( :param body: If specified, creates also a Communication Identity access token associated with the identity and containing the requested scopes. Default value is None. - :type body: ~azure.communication.identity.models.CommunicationIdentityCreateRequest + :type body: ~azure.communication.identity._generated.models.CommunicationIdentityCreateRequest :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: CommunicationIdentityAccessTokenResult - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessTokenResult + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ @overload def create( self, - body: Optional[IO] = None, + body: Optional[_types.CommunicationIdentityCreateRequest] = None, *, content_type: str = "application/json", **kwargs: Any, @@ -215,19 +309,42 @@ def create( :param body: If specified, creates also a Communication Identity access token associated with the identity and containing the requested scopes. Default value is None. - :type body: IO + :type body: ~azure.communication.identity._generated.types.CommunicationIdentityCreateRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create( + self, body: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Create a new identity, and optionally, an access token. + + Create a new identity, and optionally, an access token. + + :param body: If specified, creates also a Communication Identity access token associated with + the identity and containing the requested scopes. Default value is None. + :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: CommunicationIdentityAccessTokenResult - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessTokenResult + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace def create( self, - body: Optional[Union[_models.CommunicationIdentityCreateRequest, IO]] = None, + body: Optional[ + Union[_models.CommunicationIdentityCreateRequest, _types.CommunicationIdentityCreateRequest, IO[bytes]] + ] = None, **kwargs: Any, ) -> _models.CommunicationIdentityAccessTokenResult: """Create a new identity, and optionally, an access token. @@ -236,16 +353,16 @@ def create( :param body: If specified, creates also a Communication Identity access token associated with the identity and containing the requested scopes. Is either a - CommunicationIdentityCreateRequest type or a IO type. Default value is None. - :type body: ~azure.communication.identity.models.CommunicationIdentityCreateRequest or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: CommunicationIdentityAccessTokenResult - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessTokenResult + CommunicationIdentityCreateRequest type or a IO[bytes] type. Default value is None. + :type body: ~azure.communication.identity._generated.models.CommunicationIdentityCreateRequest + or ~azure.communication.identity._generated.types.CommunicationIdentityCreateRequest or + IO[bytes] + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -257,23 +374,22 @@ def create( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if body else None cls: ClsType[_models.CommunicationIdentityAccessTokenResult] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if body else None _content = None if isinstance(body, (IOBase, bytes)): _content = body else: if body is not None: - _json = self._serialize.body(body, "CommunicationIdentityCreateRequest") + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_communication_identity_create_request( + _request = build_identity_operations_create_request( content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, @@ -281,28 +397,38 @@ def create( 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("CommunicationIdentityAccessTokenResult", pipeline_response) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessTokenResult, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements @@ -316,7 +442,7 @@ def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=inconsisten :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -329,7 +455,7 @@ def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=inconsisten cls: ClsType[None] = kwargs.pop("cls", None) - request = build_communication_identity_delete_request( + _request = build_identity_operations_delete_request( id=id, api_version=self._config.api_version, headers=_headers, @@ -338,24 +464,25 @@ def delete(self, id: str, **kwargs: Any) -> None: # pylint: disable=inconsisten 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: - 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) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace def revoke_access_tokens(self, id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements @@ -369,7 +496,7 @@ def revoke_access_tokens(self, id: str, **kwargs: Any) -> None: # pylint: disab :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -382,7 +509,7 @@ def revoke_access_tokens(self, id: str, **kwargs: Any) -> None: # pylint: disab cls: ClsType[None] = kwargs.pop("cls", None) - request = build_communication_identity_revoke_access_tokens_request( + _request = build_identity_operations_revoke_access_tokens_request( id=id, api_version=self._config.api_version, headers=_headers, @@ -391,90 +518,295 @@ def revoke_access_tokens(self, id: str, **kwargs: Any) -> None: # pylint: disab 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: - 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) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @overload - def exchange_teams_user_access_token( + def issue_access_token( + self, + id: str, + body: _models.CommunicationIdentityAccessTokenRequest, + *, + content_type: str = "application/json", + **kwargs: Any, + ) -> _models.CommunicationIdentityAccessToken: + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. Required. + :type body: + ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def issue_access_token( self, - body: _models.TeamsUserExchangeTokenRequest, + id: str, + body: _types.CommunicationIdentityAccessTokenRequest, *, content_type: str = "application/json", **kwargs: Any, ) -> _models.CommunicationIdentityAccessToken: - """Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. Required. + :type body: + ~azure.communication.identity._generated.types.CommunicationIdentityAccessTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def issue_access_token( + self, id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. 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: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def issue_access_token( + self, + id: str, + body: Union[ + _models.CommunicationIdentityAccessTokenRequest, _types.CommunicationIdentityAccessTokenRequest, IO[bytes] + ], + **kwargs: Any, + ) -> _models.CommunicationIdentityAccessToken: + """Issue a new token for an identity. + + Issue a new token for an identity. + + :param id: Identifier of the identity to issue token for. Required. + :type id: str + :param body: Requested scopes for the new token. Is either a + CommunicationIdentityAccessTokenRequest type or a IO[bytes] type. Required. + :type body: + ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenRequest or + ~azure.communication.identity._generated.types.CommunicationIdentityAccessTokenRequest or + IO[bytes] + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 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.CommunicationIdentityAccessToken] = 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_identity_operations_issue_access_token_request( + id=id, + 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) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class TeamsUserOperationsOperations: # pylint: disable=docstring-missing-param + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.communication.identity.IdentityClient`'s + :attr:`teams_user_operations` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: IdentityClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def exchange_teams_user_access_token( + self, body: _models.TeamsUserExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. + + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. + + :param body: Request payload for the token exchange. Required. + :type body: ~azure.communication.identity._generated.models.TeamsUserExchangeTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def exchange_teams_user_access_token( + self, body: _types.TeamsUserExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessToken: + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. + + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. :param body: Request payload for the token exchange. Required. - :type body: ~azure.communication.identity.models.TeamsUserExchangeTokenRequest + :type body: ~azure.communication.identity._generated.types.TeamsUserExchangeTokenRequest :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken :raises ~azure.core.exceptions.HttpResponseError: """ @overload def exchange_teams_user_access_token( - self, body: IO, *, content_type: str = "application/json", **kwargs: Any + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.CommunicationIdentityAccessToken: - """Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. - Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. :param body: Request payload for the token exchange. Required. - :type body: IO + :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: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace def exchange_teams_user_access_token( - self, body: Union[_models.TeamsUserExchangeTokenRequest, IO], **kwargs: Any + self, + body: Union[_models.TeamsUserExchangeTokenRequest, _types.TeamsUserExchangeTokenRequest, IO[bytes]], + **kwargs: Any, ) -> _models.CommunicationIdentityAccessToken: - """Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + """Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. - Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new - Communication Identity access token with a matching expiration time. + Exchange an Entra ID access token of a Teams user for a new Communication Identity access token + with a matching expiration time. :param body: Request payload for the token exchange. Is either a TeamsUserExchangeTokenRequest - type or a IO type. Required. - :type body: ~azure.communication.identity.models.TeamsUserExchangeTokenRequest or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + type or a IO[bytes] type. Required. + :type body: ~azure.communication.identity._generated.models.TeamsUserExchangeTokenRequest or + ~azure.communication.identity._generated.types.TeamsUserExchangeTokenRequest or IO[bytes] + :return: CommunicationIdentityAccessToken. The CommunicationIdentityAccessToken is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -489,17 +821,15 @@ def exchange_teams_user_access_token( cls: ClsType[_models.CommunicationIdentityAccessToken] = kwargs.pop("cls", None) content_type = content_type or "application/json" - _json = None _content = None if isinstance(body, (IOBase, bytes)): _content = body else: - _json = self._serialize.body(body, "TeamsUserExchangeTokenRequest") + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_communication_identity_exchange_teams_user_access_token_request( + _request = build_teams_user_operations_exchange_teams_user_access_token_request( content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, @@ -507,103 +837,384 @@ def exchange_teams_user_access_token( 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _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 + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("CommunicationIdentityAccessToken", pipeline_response) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessToken, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + +class TeamsExtensionOperationsOperations: # pylint: disable=docstring-missing-param + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.communication.identity.IdentityClient`'s + :attr:`teams_extension_operations` attribute. + """ - return deserialized + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: IdentityClientConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @overload - def issue_access_token( + def exchange_token( + self, body: _models.TeamsExtensionExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. + + Exchanges a Teams Phone token for an ACS user access token. + + :param body: Request payload for the token exchange. Required. + :type body: ~azure.communication.identity._generated.models.TeamsExtensionExchangeTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def exchange_token( + self, body: _types.TeamsExtensionExchangeTokenRequest, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. + + Exchanges a Teams Phone token for an ACS user access token. + + :param body: Request payload for the token exchange. Required. + :type body: ~azure.communication.identity._generated.types.TeamsExtensionExchangeTokenRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def exchange_token( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. + + Exchanges a Teams Phone token for an ACS user access token. + + :param body: Request payload for the token exchange. 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: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def exchange_token( self, - id: str, - body: _models.CommunicationIdentityAccessTokenRequest, - *, - content_type: str = "application/json", + body: Union[_models.TeamsExtensionExchangeTokenRequest, _types.TeamsExtensionExchangeTokenRequest, IO[bytes]], **kwargs: Any, - ) -> _models.CommunicationIdentityAccessToken: - """Issue a new token for an identity. + ) -> _models.CommunicationIdentityAccessTokenResult: + """Exchanges a Teams Phone token for an ACS user access token. + + Exchanges a Teams Phone token for an ACS user access token. + + :param body: Request payload for the token exchange. Is either a + TeamsExtensionExchangeTokenRequest type or a IO[bytes] type. Required. + :type body: ~azure.communication.identity._generated.models.TeamsExtensionExchangeTokenRequest + or ~azure.communication.identity._generated.types.TeamsExtensionExchangeTokenRequest or + IO[bytes] + :return: CommunicationIdentityAccessTokenResult. The CommunicationIdentityAccessTokenResult is + compatible with MutableMapping + :rtype: ~azure.communication.identity._generated.models.CommunicationIdentityAccessTokenResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) - Issue a new token for an identity. + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} - :param id: Identifier of the identity to issue token for. Required. - :type id: str - :param body: Requested scopes for the new token. Required. - :type body: ~azure.communication.identity.models.CommunicationIdentityAccessTokenRequest + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.CommunicationIdentityAccessTokenResult] = 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_teams_extension_operations_exchange_token_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) + + _decompress = kwargs.pop("decompress", True) + _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 [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.CommunicationIdentityAccessTokenResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_assignment(self, tenant_id: str, object_id: str, **kwargs: Any) -> _models.TeamsExtensionAssignmentResponse: + """Get Teams Phone access assignment by object id. + + Get Teams Phone access assignment by object id. + + :param tenant_id: Tenant Id we want to get the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to get the assignment for. Required. + :type object_id: str + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 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[_models.TeamsExtensionAssignmentResponse] = kwargs.pop("cls", None) + + _request = build_teams_extension_operations_get_assignment_request( + tenant_id=tenant_id, + object_id=object_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) + + _decompress = kwargs.pop("decompress", True) + _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 [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TeamsExtensionAssignmentResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def upsert_assignment( + self, + tenant_id: str, + object_id: str, + body: _models.TeamsExtensionAssignmentCreateOrUpdateRequest, + *, + content_type: str = "application/json", + **kwargs: Any, + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. Required. + :type body: + ~azure.communication.identity._generated.models.TeamsExtensionAssignmentCreateOrUpdateRequest :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse :raises ~azure.core.exceptions.HttpResponseError: """ @overload - def issue_access_token( + def upsert_assignment( self, - id: str, - body: IO, + tenant_id: str, + object_id: str, + body: _types.TeamsExtensionAssignmentCreateOrUpdateRequest, *, content_type: str = "application/json", **kwargs: Any, - ) -> _models.CommunicationIdentityAccessToken: - """Issue a new token for an identity. - - Issue a new token for an identity. + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. Required. + :type body: + ~azure.communication.identity._generated.types.TeamsExtensionAssignmentCreateOrUpdateRequest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ - :param id: Identifier of the identity to issue token for. Required. - :type id: str - :param body: Requested scopes for the new token. Required. - :type body: IO + @overload + def upsert_assignment( + self, tenant_id: str, object_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. 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: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace - def issue_access_token( + def upsert_assignment( self, - id: str, - body: Union[_models.CommunicationIdentityAccessTokenRequest, IO], + tenant_id: str, + object_id: str, + body: Union[ + _models.TeamsExtensionAssignmentCreateOrUpdateRequest, + _types.TeamsExtensionAssignmentCreateOrUpdateRequest, + IO[bytes], + ], **kwargs: Any, - ) -> _models.CommunicationIdentityAccessToken: - """Issue a new token for an identity. - - Issue a new token for an identity. - - :param id: Identifier of the identity to issue token for. Required. - :type id: str - :param body: Requested scopes for the new token. Is either a - CommunicationIdentityAccessTokenRequest type or a IO type. Required. - :type body: ~azure.communication.identity.models.CommunicationIdentityAccessTokenRequest or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: CommunicationIdentityAccessToken - :rtype: ~azure.communication.identity.models.CommunicationIdentityAccessToken + ) -> _models.TeamsExtensionAssignmentResponse: + """Creates or replaces a Teams Phone access assignment. + + Creates or replaces a Teams Phone access assignment. + + :param tenant_id: Tenant Id we want to update the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to update the assignment for. Required. + :type object_id: str + :param body: Values we want to set. Is either a TeamsExtensionAssignmentCreateOrUpdateRequest + type or a IO[bytes] type. Required. + :type body: + ~azure.communication.identity._generated.models.TeamsExtensionAssignmentCreateOrUpdateRequest + or ~azure.communication.identity._generated.types.TeamsExtensionAssignmentCreateOrUpdateRequest + or IO[bytes] + :return: TeamsExtensionAssignmentResponse. The TeamsExtensionAssignmentResponse is compatible + with MutableMapping + :rtype: ~azure.communication.identity._generated.models.TeamsExtensionAssignmentResponse :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -615,21 +1226,20 @@ def issue_access_token( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.CommunicationIdentityAccessToken] = kwargs.pop("cls", None) + cls: ClsType[_models.TeamsExtensionAssignmentResponse] = kwargs.pop("cls", None) content_type = content_type or "application/json" - _json = None _content = None if isinstance(body, (IOBase, bytes)): _content = body else: - _json = self._serialize.body(body, "CommunicationIdentityAccessTokenRequest") + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_communication_identity_issue_access_token_request( - id=id, + _request = build_teams_extension_operations_upsert_assignment_request( + tenant_id=tenant_id, + object_id=object_id, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, @@ -637,25 +1247,94 @@ def issue_access_token( 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) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200]: + if response.status_code not in [200, 201]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.CommunicationErrorResponse, pipeline_response) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("CommunicationIdentityAccessToken", pipeline_response) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TeamsExtensionAssignmentResponse, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_assignment( # pylint: disable=inconsistent-return-statements + self, tenant_id: str, object_id: str, **kwargs: Any + ) -> None: + """Removes a Teams Phone access assignment. + + Removes a Teams Phone access assignment. - return deserialized + :param tenant_id: Tenant Id we want to remove the assignment for. Required. + :type tenant_id: str + :param object_id: Object Id we want to remove the assignment for. Required. + :type object_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 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[None] = kwargs.pop("cls", None) + + _request = build_teams_extension_operations_delete_assignment_request( + tenant_id=tenant_id, + object_id=object_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 = 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 [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.CommunicationErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_patch.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_patch.py index f7dd32510333..ea765788358a 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_patch.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/operations/_patch.py @@ -1,14 +1,14 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# 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. +# -------------------------------------------------------------------------- """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 +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/py.typed b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/py.typed deleted file mode 100644 index e5aff4f83af8..000000000000 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/py.typed +++ /dev/null @@ -1 +0,0 @@ -# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/types.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/types.py new file mode 100644 index 000000000000..3eb0053aa283 --- /dev/null +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_generated/types.py @@ -0,0 +1,93 @@ +# 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 TYPE_CHECKING, Union +from typing_extensions import Required, TypedDict + +if TYPE_CHECKING: + from .models import CommunicationTokenScope, TeamsExtensionPrincipalType + + +class CommunicationIdentityAccessTokenRequest(TypedDict, total=False): + """Request to issue a new access token for an identity. + + :ivar scopes: List of scopes attached to the token. Required. + :vartype scopes: list[Union[str, "CommunicationTokenScope"]] + :ivar expiresInMinutes: Optional custom validity period of the token within [60,1440] minutes + range. If not provided, the default value of 1440 minutes (24 hours) will be used. + :vartype expiresInMinutes: int + """ + + scopes: Required[list[Union[str, "CommunicationTokenScope"]]] + """List of scopes attached to the token. Required.""" + expiresInMinutes: int + """Optional custom validity period of the token within [60,1440] minutes range. If not provided, + the default value of 1440 minutes (24 hours) will be used.""" + + +class CommunicationIdentityCreateRequest(TypedDict, total=False): + """Request to create a new identity with optional access token. + + :ivar createTokenWithScopes: Also create access token for the created identity. + :vartype createTokenWithScopes: list[Union[str, "CommunicationTokenScope"]] + :ivar expiresInMinutes: Optional custom validity period of the token within [60,1440] minutes + range. If not provided, the default value of 1440 minutes (24 hours) will be used. + :vartype expiresInMinutes: int + """ + + createTokenWithScopes: list[Union[str, "CommunicationTokenScope"]] + """Also create access token for the created identity.""" + expiresInMinutes: int + """Optional custom validity period of the token within [60,1440] minutes range. If not provided, + the default value of 1440 minutes (24 hours) will be used.""" + + +class TeamsExtensionAssignmentCreateOrUpdateRequest(TypedDict, total=False): # pylint: disable=name-too-long + """A request to create or update a Teams Extension assignment. + + :ivar principalType: The type of principal the assignment is for. Required. Known values are: + "resourceAccount" and "user". + :vartype principalType: Union[str, "TeamsExtensionPrincipalType"] + :ivar clientIds: The client IDs for the assignment. + :vartype clientIds: list[str] + """ + + principalType: Required[Union[str, "TeamsExtensionPrincipalType"]] + """The type of principal the assignment is for. Required. Known values are: \"resourceAccount\" + and \"user\".""" + clientIds: list[str] + """The client IDs for the assignment.""" + + +class TeamsExtensionExchangeTokenRequest(TypedDict, total=False): + """A request to exchange a Teams Extension token.""" + + +class TeamsUserExchangeTokenRequest(TypedDict, total=False): + """A request to exchange a Teams user access token. + + :ivar token: Entra ID access token of a Teams User to acquire a new Communication Identity + access token. Required. + :vartype token: str + :ivar appId: Client ID of an Entra ID application to be verified against the appid claim in the + Entra ID access token. Required. + :vartype appId: str + :ivar userId: Object ID of an Entra ID user (Teams User) to be verified against the oid claim + in the Entra ID access token. Required. + :vartype userId: str + """ + + token: Required[str] + """Entra ID access token of a Teams User to acquire a new Communication Identity access token. + Required.""" + appId: Required[str] + """Client ID of an Entra ID application to be verified against the appid claim in the Entra ID + access token. Required.""" + userId: Required[str] + """Object ID of an Entra ID user (Teams User) to be verified against the oid claim in the Entra ID + access token. Required.""" diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_utils.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_utils.py index 0d6042f38bcf..ca784b76e0b6 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_utils.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_utils.py @@ -5,7 +5,174 @@ # ------------------------------------------------------------------------- from datetime import timedelta -from typing import Optional +from typing import Any, Dict, List, Optional, Union +from azure.core.credentials import AccessToken +from azure.core.pipeline.policies import SansIOHTTPPolicy + +# Headers the AutoRest-generated client sent that the TypeSpec DPG emitter does not. +# +# Restoring them keeps the request black-box identical to the previously published SDK. The +# service itself is indifferent -- measured against a live resource, `Accept` makes no +# difference to either the success or the error path -- but a proxy, gateway or request log +# keying on headers would observe the change, so the difference is customer-visible even +# though the service ignores it. +# +# Why the emitter drops them: +# - `delete` and `revoke_access_tokens` return 204 with no response body, so the emitter +# emits no `Accept` header for them at all. +# - `create` declares `content_type` only as a body-parameter keyword, so with no body +# passed it is never applied. +# +# These are request headers only. Sending `Content-Type` does not cause a body to be sent; +# the body remains absent for `create_user`, as it was under AutoRest. +_ACCEPT_JSON = {"Accept": "application/json"} +_CONTENT_TYPE_JSON = {"Content-Type": "application/json"} + + +def to_access_token(access_token: Any) -> AccessToken: + """Build an AccessToken from a generated CommunicationIdentityAccessToken. + + ``expiresOn`` is read **by key**, not via the ``.expires_on`` attribute. Do not + "simplify" this to attribute access: the two are not equivalent. + + The TypeSpec model declares ``expiresOn: utcDateTime``, so the generated model types it + as ``datetime.datetime`` and attribute access returns a deserialized ``datetime``. Every + previously published version of this SDK exposed the raw service string, so returning a + ``datetime`` would be a breaking change for callers. Item access on the generated model + returns the untouched wire value, which keeps the public surface unchanged. + + This is a re-occurrence, not a new concern. The AutoRest configuration formerly at + ``swagger/SWAGGER.md`` carried a directive deleting ``format: date-time`` from this same + property, added because a generator upgrade had already turned it from string into + ``datetime`` once before. That directive acted on the swagger document and does not carry + over to TypeSpec, so this function is now the only thing preventing the same break. + + ``.isoformat()`` is **not** an adequate substitute: it reformats the value (``Z`` becomes + ``+00:00``) and silently truncates the service's 7-digit fractional seconds to 6. + + :param access_token: A generated CommunicationIdentityAccessToken instance. + :type access_token: ~azure.communication.identity._generated.models.CommunicationIdentityAccessToken + :return: The access token and its expiry, as returned by the service. + :rtype: ~azure.core.credentials.AccessToken + """ + return AccessToken(access_token["token"], access_token["expiresOn"]) + + +def build_token_request_body( + scopes_key: str, + scopes: List[Union[str, Any]], + token_expires_in: Optional[timedelta], +) -> Dict[str, Any]: + """Build a token request body, omitting fields the caller did not supply. + + The previous msrest-based layer dropped ``None`` fields during serialization, whereas the + generated code forwards the request body as-is. Both ``scopes`` and ``expiresInMinutes`` + are therefore omitted when unset, so the request stays byte-identical to the previously + published SDK. + + ``expiresInMinutes`` matters because the service constrains it to [60, 1440] and an + explicit ``null`` is not a valid value. ``scopes`` is omitted for the same reason the old + layer omitted it -- passing ``None`` for a required argument is a caller error either way, + but it must fail the way it always failed, with the same request on the wire. + + Note this restores prior behaviour rather than adding validation: the AutoRest client did + not raise on a ``None`` scope list, and neither does this. The request is still sent and + the service still rejects it. + + :param scopes_key: Name of the scopes property expected by the service. + :type scopes_key: str + :param scopes: List of scopes to be added to the token. + :type scopes: list[str or ~azure.communication.identity.CommunicationTokenScope] + :param token_expires_in: Optional custom validity period of the token. + :type token_expires_in: ~datetime.timedelta or None + :return: The request body to send to the service. + :rtype: dict[str, any] + """ + request_body: Dict[str, Any] = {} + if scopes is not None: + request_body[scopes_key] = scopes + expires_in_minutes = convert_timedelta_to_mins(token_expires_in) + if expires_in_minutes is not None: + request_body["expiresInMinutes"] = expires_in_minutes + return request_body + + +def extract_create_content_type(kwargs: Dict[str, Any]) -> Dict[str, Any]: + """Preserve a caller-supplied ``Content-Type`` across the generated create operation. + + The operation discards it when no body is present, so it is moved into the + request context for :class:`BodylessCreateContentTypePolicy` to reapply. + + :param kwargs: Keyword arguments destined for the create operation. + :type kwargs: dict[str, any] + :return: The keyword arguments, with any Content-Type moved to the context. + :rtype: dict[str, any] + """ + headers = kwargs.get("headers") or {} + override = kwargs.pop("content_type", None) + for name in list(headers): + if name.lower() == "content-type": + override = headers.pop(name) + if override: + kwargs[BodylessCreateContentTypePolicy.CONTEXT_KEY] = override + return kwargs + + +def merge_headers(kwargs: Dict[str, Any], defaults: Dict[str, str]) -> Dict[str, Any]: + """Add default request headers without overriding any the caller supplied. + + :param kwargs: Keyword arguments destined for a generated operation. + :type kwargs: dict[str, any] + :param defaults: Headers to apply when the caller has not set them. + :type defaults: dict[str, str] + :return: The keyword arguments, with a merged ``headers`` entry. + :rtype: dict[str, any] + """ + headers = dict(kwargs.pop("headers", None) or {}) + existing = {name.lower() for name in headers} + for name, value in defaults.items(): + if name.lower() not in existing: + headers[name] = value + kwargs["headers"] = headers + return kwargs + + +class BodylessCreateContentTypePolicy(SansIOHTTPPolicy): + """Restores ``Content-Type`` on the bodyless identity-create request. + + The generated ``create`` operation discards ``content_type`` whenever no body + is present -- twice, via ``content_type if body else None`` and again via + ``content_type or "application/json" if body else None`` -- so no argument + passed to the operation can survive. A policy is therefore the only way to + restore the header without editing generated code. + + The same discard also drops a caller-supplied ``Content-Type``, which the + AutoRest client honoured. ``CommunicationIdentityClient.create_user`` + consequently stashes any caller value on the request context under + ``_acs_create_content_type`` and this policy reapplies it, so an explicit + override still reaches the wire. + + The match is deliberately narrow: a POST to the identities collection with no + body. ``create_user_and_token`` sends a body and so already carries the header + from the generated code, and is left untouched. + """ + + CONTEXT_KEY = "_acs_create_content_type" + + def on_request(self, request) -> None: + http_request = request.http_request + if http_request.method != "POST": + return + if not http_request.url.split("?")[0].endswith("/identities"): + return + # The generated operation drops content_type whenever the body is falsy, which covers + # both no body at all and an empty JSON object. Both must be repaired, so the test is + # "did the operation fail to set a JSON content type", not "is there a body" -- an + # empty dict serializes to the string "{}", which is truthy and would be missed. + if http_request.headers.get("Content-Type", "").startswith("application/json"): + return + override = request.context.options.pop(self.CONTEXT_KEY, None) + http_request.headers["Content-Type"] = override or "application/json" def convert_timedelta_to_mins( diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_version.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_version.py index fa4bba0a08c4..563541b7b0a4 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_version.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_version.py @@ -4,6 +4,6 @@ # license information. # -------------------------------------------------------------------------- -VERSION = "1.6.0" +VERSION = "2.0.0" SDK_MONIKER = f"communication-identity/{VERSION}" # type: str diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/aio/_communication_identity_client_async.py b/sdk/communication/azure-communication-identity/azure/communication/identity/aio/_communication_identity_client_async.py index 466f314d6673..6fdc6bc78932 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/aio/_communication_identity_client_async.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/aio/_communication_identity_client_async.py @@ -11,14 +11,21 @@ from azure.core.credentials_async import AsyncTokenCredential from azure.core.credentials import AzureKeyCredential from .._generated.aio._client import ( - CommunicationIdentityClient as CommunicationIdentityClientGen, + IdentityClient as CommunicationIdentityClientGen, ) from .._shared.auth_policy_utils import get_authentication_policy from .._shared.utils import parse_connection_str from .._shared.models import CommunicationUserIdentifier from .._version import SDK_MONIKER from .._api_versions import DEFAULT_VERSION -from .._utils import convert_timedelta_to_mins +from .._utils import ( + _ACCEPT_JSON, + BodylessCreateContentTypePolicy, + build_token_request_body, + extract_create_content_type, + merge_headers, + to_access_token, +) from .._generated.models import CommunicationTokenScope @@ -51,11 +58,14 @@ def __init__(self, endpoint: str, credential: Union[AsyncTokenCredential, AzureK self._endpoint = endpoint self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) + per_call_policies = list(kwargs.pop("per_call_policies", None) or []) + per_call_policies.append(BodylessCreateContentTypePolicy()) self._identity_service_client = CommunicationIdentityClientGen( self._endpoint, api_version=self._api_version, authentication_policy=get_authentication_policy(endpoint, credential, decode_url=True, is_async=True), sdk_moniker=SDK_MONIKER, + per_call_policies=per_call_policies, **kwargs ) @@ -81,13 +91,17 @@ async def create_user(self, **kwargs) -> "CommunicationUserIdentifier": :return: CommunicationUserIdentifier :rtype: ~azure.communication.identity.CommunicationUserIdentifier """ - identity_access_token = await self._identity_service_client.communication_identity.create(**kwargs) + identity_access_token = await self._identity_service_client.identity_operations.create( + **extract_create_content_type(kwargs) + ) return CommunicationUserIdentifier(identity_access_token.identity.id, raw_id=identity_access_token.identity.id) @distributed_trace_async async def create_user_and_token( - self, scopes: List[Union[str, CommunicationTokenScope]], *, + self, + scopes: List[Union[str, CommunicationTokenScope]], + *, token_expires_in: Optional[timedelta] = None, **kwargs ) -> Tuple["CommunicationUserIdentifier", AccessToken]: @@ -103,22 +117,15 @@ async def create_user_and_token( :rtype: tuple of (~azure.communication.identity.CommunicationUserIdentifier, ~azure.core.credentials.AccessToken) """ - request_body = { - "createTokenWithScopes": scopes, - "expiresInMinutes": convert_timedelta_to_mins(token_expires_in), - } - - identity_access_token = await self._identity_service_client.communication_identity.create( + request_body = build_token_request_body("createTokenWithScopes", scopes, token_expires_in) + identity_access_token = await self._identity_service_client.identity_operations.create( body=request_body, **kwargs # type: ignore ) user_identifier = CommunicationUserIdentifier( identity_access_token.identity.id, raw_id=identity_access_token.identity.id ) - access_token = AccessToken( - identity_access_token.access_token.token, - identity_access_token.access_token.expires_on, - ) + access_token = to_access_token(identity_access_token["accessToken"]) return user_identifier, access_token @@ -132,12 +139,16 @@ async def delete_user(self, user: CommunicationUserIdentifier, **kwargs) -> None :return: None :rtype: None """ - await self._identity_service_client.communication_identity.delete(user.properties["id"], **kwargs) + await self._identity_service_client.identity_operations.delete( + user.properties["id"], **merge_headers(kwargs, _ACCEPT_JSON) + ) @distributed_trace_async async def get_token( - self, user: CommunicationUserIdentifier, - scopes: List[Union[str, CommunicationTokenScope]], *, + self, + user: CommunicationUserIdentifier, + scopes: List[Union[str, CommunicationTokenScope]], + *, token_expires_in: Optional[timedelta] = None, **kwargs ) -> AccessToken: @@ -153,16 +164,13 @@ async def get_token( :return: AccessToken :rtype: ~azure.core.credentials.AccessToken """ - request_body = { - "scopes": scopes, - "expiresInMinutes": convert_timedelta_to_mins(token_expires_in), - } + request_body = build_token_request_body("scopes", scopes, token_expires_in) - access_token = await self._identity_service_client.communication_identity.issue_access_token( + access_token = await self._identity_service_client.identity_operations.issue_access_token( user.properties["id"], body=request_body, **kwargs # type: ignore ) - return AccessToken(access_token.token, access_token.expires_on) + return to_access_token(access_token) @distributed_trace_async async def revoke_tokens(self, user: CommunicationUserIdentifier, **kwargs) -> None: @@ -173,8 +181,8 @@ async def revoke_tokens(self, user: CommunicationUserIdentifier, **kwargs) -> No :return: None :rtype: None """ - return await self._identity_service_client.communication_identity.revoke_access_tokens( - user.properties["id"] if user else None, **kwargs # type: ignore + return await self._identity_service_client.identity_operations.revoke_access_tokens( + user.properties["id"] if user else None, **merge_headers(kwargs, _ACCEPT_JSON) # type: ignore ) @distributed_trace_async @@ -204,11 +212,11 @@ async def get_token_for_teams_user( "appId": client_id, "userId": user_object_id, } - access_token = await self._identity_service_client.communication_identity.exchange_teams_user_access_token( + access_token = await self._identity_service_client.teams_user_operations.exchange_teams_user_access_token( body=request_body, **kwargs # type: ignore ) - return AccessToken(access_token.token, access_token.expires_on) + return to_access_token(access_token) async def __aenter__(self) -> "CommunicationIdentityClient": await self._identity_service_client.__aenter__() diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/py.typed b/sdk/communication/azure-communication-identity/azure/communication/identity/py.typed index e69de29bb2d1..e5aff4f83af8 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/py.typed +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/communication/azure-communication-identity/pyproject.toml b/sdk/communication/azure-communication-identity/pyproject.toml index db898be6409d..d85b497d8daa 100644 --- a/sdk/communication/azure-communication-identity/pyproject.toml +++ b/sdk/communication/azure-communication-identity/pyproject.toml @@ -1,9 +1,83 @@ +[build-system] +requires = [ + "setuptools>=77.0.3", + "wheel", +] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-communication-identity" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure Communication Identity Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", +] +requires-python = ">=3.10" +keywords = [ + "azure", + "azure sdk", +] +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.37.0", + "typing-extensions>=4.6.0", +] +dynamic = [ + "version", + "readme", +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic.version] +attr = "azure.communication.identity._version.VERSION" + +[tool.setuptools.dynamic.readme] +file = [ + "README.md", + "CHANGELOG.md", +] +content-type = "text/markdown" + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "generated_tests*", + "samples*", + "generated_samples*", + "doc*", + "azure", + "azure.communication", +] + +[tool.setuptools.package-data] +pytyped = [ + "py.typed", +] + [tool.azure-sdk-build] pyright = false -[tool.pytest.ini_options] -asyncio_default_fixture_loop_scope = "function" - [tool.azure-sdk-conda] in_bundle = true bundle_name = "azure-communication" + +[packaging] +auto_update = false +package_name = "azure-communication-identity" +package_pprint_name = "Communication Identity Service" +package_doc_id = "" +is_stable = false +is_arm = false diff --git a/sdk/communication/azure-communication-identity/sdk_packaging.toml b/sdk/communication/azure-communication-identity/sdk_packaging.toml deleted file mode 100644 index 88dbadd37a99..000000000000 --- a/sdk/communication/azure-communication-identity/sdk_packaging.toml +++ /dev/null @@ -1,7 +0,0 @@ -[packaging] -auto_update = false -package_name = "azure-communication-identity" -package_pprint_name = "Communication Identity Service" -package_doc_id = "" -is_stable = false -is_arm = false \ No newline at end of file diff --git a/sdk/communication/azure-communication-identity/tests/conftest.py b/sdk/communication/azure-communication-identity/tests/conftest.py index 3e8e7cbfbbae..c0c11bca8276 100644 --- a/sdk/communication/azure-communication-identity/tests/conftest.py +++ b/sdk/communication/azure-communication-identity/tests/conftest.py @@ -33,6 +33,7 @@ test_proxy, add_general_regex_sanitizer, add_header_regex_sanitizer, + add_uri_regex_sanitizer, set_default_session_settings, add_body_key_sanitizer, add_oauth_response_sanitizer, @@ -40,6 +41,29 @@ ) from azure.communication.identity._shared.utils import parse_connection_str +# The recorded sessions were captured against api-version 2023-10-01. This package now +# defaults to 2026-09-23, so the request URI no longer matches the recording and every +# recorded test fails with "Unable to find a record for the request". +# +# The two versions are functionally identical for these operations, so the recordings remain +# valid; only the query string differs. Rewriting the request back to the recorded value lets +# them match. This is deliberately narrow -- it maps one exact version to one other exact +# version, so any other api-version still fails to match. +# +# Do NOT replace this with `ignored_query_parameters`: that substitutes a "Volatile" literal +# on both sides, so *any* api-version would match *any* recording, removing all coverage of +# the single field this release changes. +# +# Known limitation: sanitizers apply to both the recording and the incoming request, so the +# two versions become mutually interchangeable and a regression back to 2023-10-01 would not +# be caught here. tests/test_wire_contract.py asserts the exact api-version on the wire +# against a literal, which covers that gap. +# +# This retires itself: once the cassettes are re-recorded at 2026-09-23 the regex matches +# nothing and the sanitizer becomes inert. +RECORDED_API_VERSION = "2023-10-01" +CURRENT_API_VERSION = "2026-09-23" + @pytest.fixture(scope="session", autouse=True) def add_sanitizers(test_proxy): @@ -53,6 +77,11 @@ def add_sanitizers(test_proxy): add_oauth_response_sanitizer() + add_uri_regex_sanitizer( + regex=f"api-version={CURRENT_API_VERSION}", + value=f"api-version={RECORDED_API_VERSION}", + ) + connection_str = os.environ.get("COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING") if connection_str is not None: endpoint, _ = parse_connection_str(connection_str) diff --git a/sdk/communication/azure-communication-identity/tests/test_wire_contract.py b/sdk/communication/azure-communication-identity/tests/test_wire_contract.py new file mode 100644 index 000000000000..d07284cebdf0 --- /dev/null +++ b/sdk/communication/azure-communication-identity/tests/test_wire_contract.py @@ -0,0 +1,388 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +"""Wire-contract tests for CommunicationIdentityClient. + +These assert what the client actually puts on the wire, rather than what the +convenience layer returns. They exist because the move from AutoRest to the +TypeSpec DPG emitter changed three things that are invisible to an API-surface +check and are not covered by the recorded tests: + +1. ``expiresInMinutes`` must be omitted when the caller supplies no expiry. + msrest dropped ``None`` fields during serialization; the generated code + forwards the request body as-is, so without a fix an explicit ``null`` + reaches a property the service constrains to [60, 1440]. + +2. ``AccessToken.expires_on`` must remain the raw service string. The TypeSpec + model declares ``expiresOn: utcDateTime``, so attribute access on the + generated model returns a ``datetime``; every published version of this SDK + exposed the string. + +3. The default api-version must be the one the package claims to target. + +Requests are captured at the transport, which is the last pipeline stage before +the network, so these are wire observations rather than serializer return +values. +""" + +import json +from datetime import timedelta + +import pytest +from azure.core.exceptions import HttpResponseError +from azure.core.pipeline.transport import HttpTransport + +from azure.communication.identity import ( + CommunicationIdentityClient, + CommunicationTokenScope, +) +from azure.communication.identity._api_versions import DEFAULT_VERSION +from azure.communication.identity._shared.models import CommunicationUserIdentifier + +WIRE_EXPIRY = "2026-09-23T12:00:00.1234567Z" +EXPECTED_API_VERSION = "2026-09-23" +FAKE_ENDPOINT = "https://sanitized.communication.azure.com" +FAKE_KEY = "a2V5" * 8 + + +class _FakeResponse: + def __init__(self, request, status_code, body): + self.request = request + self.status_code = status_code + self._body = json.dumps(body).encode() if body is not None else b"" + self.headers = {"content-type": "application/json"} + self.reason = "OK" + self.content_type = "application/json" + self.is_closed = True + self.is_stream_consumed = True + + @property + def content(self): + return self._body + + def text(self, encoding=None): + return self._body.decode() + + def json(self): + return json.loads(self._body) + + def read(self): + return self._body + + def close(self): + pass + + def raise_for_status(self): + pass + + +class _RawResponse: + """Returns a body verbatim, so non-JSON and malformed payloads can be exercised.""" + + def __init__(self, request, status_code, raw_body, content_type="application/json"): + self.request = request + self.status_code = status_code + self._body = raw_body + self.headers = {"content-type": content_type} + self.reason = "Error" + self.content_type = content_type + self.is_closed = True + self.is_stream_consumed = True + + @property + def content(self): + return self._body + + def text(self, encoding=None): + return self._body.decode("utf-8", "replace") + + def json(self): + return json.loads(self._body) + + def read(self): + return self._body + + def close(self): + pass + + def raise_for_status(self): + pass + + +class _ErrorTransport(HttpTransport): + """Replies to every request with one canned error response.""" + + def __init__(self, status_code, raw_body, content_type="application/json"): + self.status_code = status_code + self.raw_body = raw_body + self.content_type = content_type + + def send(self, request, **kwargs): + return _RawResponse(request, self.status_code, self.raw_body, self.content_type) + + def open(self): + pass + + def close(self): + pass + + def __enter__(self): + return self + + def __exit__(self, *args): + pass + + +class _CapturingTransport(HttpTransport): + """Records each outgoing request and replies with a canned response.""" + + def __init__(self): + self.requests = [] + + def send(self, request, **kwargs): + self.requests.append(request) + token = {"token": "jwt.tok.sig", "expiresOn": WIRE_EXPIRY} + path = request.url.split("?")[0] + if path.endswith("/identities"): + return _FakeResponse(request, 201, {"identity": {"id": "8:acs:u"}, "accessToken": token}) + if path.endswith(":issueAccessToken") or path.endswith("teamsUser/:exchangeAccessToken"): + return _FakeResponse(request, 200, token) + return _FakeResponse(request, 204, None) + + def open(self): + pass + + def close(self): + pass + + def __enter__(self): + return self + + def __exit__(self, *args): + pass + + +@pytest.fixture +def transport(): + return _CapturingTransport() + + +@pytest.fixture +def client(transport): + return CommunicationIdentityClient(FAKE_ENDPOINT, FAKE_KEY, transport=transport) + + +def _sent_body(transport): + return json.loads(transport.requests[-1].content) + + +class TestRequestBody: + """expiresInMinutes must be absent unless the caller asked for an expiry.""" + + def test_create_user_and_token_omits_expiry_when_not_requested(self, client, transport): + client.create_user_and_token(scopes=[CommunicationTokenScope.CHAT]) + body = _sent_body(transport) + assert "expiresInMinutes" not in body + assert body["createTokenWithScopes"] == ["chat"] + + def test_create_user_and_token_sends_expiry_when_requested(self, client, transport): + client.create_user_and_token( + scopes=[CommunicationTokenScope.CHAT], + token_expires_in=timedelta(hours=2), + ) + assert _sent_body(transport)["expiresInMinutes"] == 120 + + def test_get_token_omits_expiry_when_not_requested(self, client, transport): + client.get_token(CommunicationUserIdentifier("8:acs:u"), scopes=[CommunicationTokenScope.VOIP]) + body = _sent_body(transport) + assert "expiresInMinutes" not in body + assert body["scopes"] == ["voip"] + + def test_get_token_sends_expiry_when_requested(self, client, transport): + client.get_token( + CommunicationUserIdentifier("8:acs:u"), + scopes=[CommunicationTokenScope.VOIP], + token_expires_in=timedelta(hours=3), + ) + assert _sent_body(transport)["expiresInMinutes"] == 180 + + def test_none_scopes_are_omitted_not_sent_as_null(self, client, transport): + """A None scope list must be dropped, as msrest dropped it. + + Passing None for a required argument is a caller error, but it has to fail the way it + always failed. The AutoRest client sent {} because msrest omitted None fields; sending + {"scopes": null} instead is a different request for a proxy, gateway or log to observe. + This does not assert an exception: the previous client did not raise here either. + """ + try: + client.get_token(CommunicationUserIdentifier("8:acs:u"), None) + except Exception: # pylint: disable=broad-except + pass + assert _sent_body(transport) == {} + + def test_none_create_scopes_are_omitted_not_sent_as_null(self, client, transport): + try: + client.create_user_and_token(None) + except Exception: # pylint: disable=broad-except + pass + assert _sent_body(transport) == {} + + def test_empty_body_still_sends_json_content_type(self, client, transport): + """An empty JSON body must still be typed as JSON. + + The generated operation drops content_type whenever the body is falsy, and an empty + dict is falsy -- so without the policy azure-core falls back to text/plain. The + serialized body is the string "{}", which is truthy, so a body-presence check misses + this case entirely. + """ + try: + client.create_user_and_token(None) + except Exception: # pylint: disable=broad-except + pass + assert transport.requests[-1].headers["Content-Type"] == "application/json" + + def test_empty_scope_list_is_still_sent(self, client, transport): + """An empty list is a value, not an absence, and must survive.""" + try: + client.get_token(CommunicationUserIdentifier("8:acs:u"), []) + except Exception: # pylint: disable=broad-except + pass + assert _sent_body(transport) == {"scopes": []} + + +class TestAccessTokenExpiry: + """expires_on must be the untouched service string, not a deserialized datetime.""" + + def test_create_user_and_token_expiry_is_raw_string(self, client): + _, token = client.create_user_and_token(scopes=[CommunicationTokenScope.CHAT]) + assert isinstance(token.expires_on, str) + assert token.expires_on == WIRE_EXPIRY + + def test_get_token_expiry_is_raw_string(self, client): + token = client.get_token(CommunicationUserIdentifier("8:acs:u"), scopes=[CommunicationTokenScope.CHAT]) + assert isinstance(token.expires_on, str) + assert token.expires_on == WIRE_EXPIRY + + def test_get_token_for_teams_user_expiry_is_raw_string(self, client): + token = client.get_token_for_teams_user("aad-token", "client-id", "user-object-id") + assert isinstance(token.expires_on, str) + assert token.expires_on == WIRE_EXPIRY + + +class TestRequestHeaders: + """Request headers must match what the AutoRest-generated client sent. + + The TypeSpec DPG emitter drops three headers the previous client sent: + ``Content-Type`` on the bodyless ``create_user`` POST, and ``Accept`` on + ``revoke_tokens`` and ``delete_user`` (both typed as 204-no-content, for + which the emitter produces no ``Accept``). + + The service is indifferent to these -- measured against a live resource -- + but a proxy, gateway or request log keying on headers would observe the + change, so they are restored in the convenience layer. + + Expected values are literals rather than references to the constants that + produce them: asserting against ``_ACCEPT_JSON`` would compare the wire to + the same value that set it and would pass even if both were wrong. + """ + + def test_create_user_sends_content_type(self, client, transport): + client.create_user() + assert transport.requests[-1].headers["Content-Type"] == "application/json" + + def test_create_user_sends_no_body_despite_content_type(self, client, transport): + """Content-Type must not cause a body to be sent -- AutoRest sent none.""" + client.create_user() + assert transport.requests[-1].content is None + + def test_revoke_tokens_sends_accept(self, client, transport): + client.revoke_tokens(CommunicationUserIdentifier("8:acs:u")) + assert transport.requests[-1].headers["Accept"] == "application/json" + + def test_delete_user_sends_accept(self, client, transport): + client.delete_user(CommunicationUserIdentifier("8:acs:u")) + assert transport.requests[-1].headers["Accept"] == "application/json" + + def test_body_bearing_operations_still_send_both_headers(self, client, transport): + client.create_user_and_token(scopes=[CommunicationTokenScope.CHAT]) + headers = transport.requests[-1].headers + assert headers["Accept"] == "application/json" + assert headers["Content-Type"] == "application/json" + + def test_caller_supplied_content_type_is_not_overridden(self, client, transport): + """The policy must defer to a Content-Type already on the request.""" + client.create_user(headers={"Content-Type": "application/custom"}) + assert transport.requests[-1].headers["Content-Type"] == "application/custom" + + +class TestErrorResponses: + """A non-envelope error body must still surface the real HTTP status. + + Gateways, front doors, WAFs and throttling pages return HTML or non-envelope JSON on + failure, so this is triggered by infrastructure rather than by caller error. Customer + code branching on ``e.status_code`` (for example retrying on 429) depends on the status + surviving a body the deserializer cannot parse. + + The equivalent JavaScript client raises a bare ``TypeError`` with no status in these + cases. Python is correct because the generated code raises + ``HttpResponseError(response=response, model=error)`` -- taking the status from the + response rather than the parsed model -- and ``_failsafe_deserialize`` swallows the parse + failure. These tests pin that black-box guarantee so a future emitter change cannot + regress it silently. + + Assertions are deliberately limited to the exception type and status code. The internals + of ``_failsafe_deserialize`` are not asserted: they are the mechanism, not the contract. + """ + + @pytest.mark.parametrize( + "status_code,raw_body,content_type", + [ + pytest.param(502, b"Bad Gateway", "text/html", id="html_body"), + pytest.param(500, b'{"message":"oops"}', "application/json", id="non_envelope_json"), + pytest.param(503, b"", "application/json", id="empty_body"), + pytest.param(429, b"Too Many Requests", "text/html", id="throttling_html"), + ], + ) + def test_malformed_error_body_still_reports_status(self, status_code, raw_body, content_type): + client = CommunicationIdentityClient( + FAKE_ENDPOINT, FAKE_KEY, transport=_ErrorTransport(status_code, raw_body, content_type) + ) + with pytest.raises(HttpResponseError) as caught: + client.get_token(CommunicationUserIdentifier("8:acs:u"), scopes=[CommunicationTokenScope.CHAT]) + assert caught.value.status_code == status_code + + def test_well_formed_error_envelope_still_reports_status(self): + body = b'{"error":{"code":"Unauthorized","message":"denied"}}' + client = CommunicationIdentityClient(FAKE_ENDPOINT, FAKE_KEY, transport=_ErrorTransport(401, body)) + with pytest.raises(HttpResponseError) as caught: + client.get_token(CommunicationUserIdentifier("8:acs:u"), scopes=[CommunicationTokenScope.CHAT]) + assert caught.value.status_code == 401 + + +class TestApiVersion: + """Every request must carry the api-version the package targets. + + The expected version is asserted as a literal rather than by reading + ``DEFAULT_VERSION``. Comparing the wire against the same constant that + produced it is self-referential and cannot detect a wrong default -- that + weakness was found by mutation testing, where changing ``DEFAULT_VERSION`` + left the loop below passing. + """ + + def test_default_api_version_is_sent_on_every_operation(self, client, transport): + user = CommunicationUserIdentifier("8:acs:u") + client.create_user() + client.create_user_and_token(scopes=[CommunicationTokenScope.CHAT]) + client.get_token(user, scopes=[CommunicationTokenScope.CHAT]) + client.get_token_for_teams_user("aad-token", "client-id", "user-object-id") + client.revoke_tokens(user) + client.delete_user(user) + + assert len(transport.requests) == 6 + for request in transport.requests: + assert f"api-version={EXPECTED_API_VERSION}" in request.url + + def test_default_api_version_matches_shipped_value(self): + assert DEFAULT_VERSION.value == EXPECTED_API_VERSION diff --git a/sdk/communication/azure-communication-identity/tsp-location.yaml b/sdk/communication/azure-communication-identity/tsp-location.yaml new file mode 100644 index 000000000000..ffe6b6c58998 --- /dev/null +++ b/sdk/communication/azure-communication-identity/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/communication/data-plane/Identity +commit: 1893171028aed5a757fc78c2d4aa439c14df4afc +repo: Azure/azure-rest-api-specs +additionalDirectories: