[Communication] - Phone Numbers - Add browse API methods (Azure#25355)

* Add browse API methods

* Export new models to public API, fix errors

Due to changes in the latest version of autorest, some generated method signatures had changed.

* Fix docstring for new API methods

* Cleanup docstrings, update min azure-core version

* Override locked dependency for phone-numbers

* Fix linter issues

* Setup autorest with new v2 api

* Rename AreaCodeResult to AreaCodeItem

* Add locality and administrative division to search and add acepted_language to constructor

* Rafactor list_area_codes to have just 1 function for tollFree and geographic

* Replace two_letter_iso_country_name  with country_code

* Add optional arguments to kwargs

* Add changes to phone_number_clients_async

* Replace phone_number_assignment_type with assignment_type

* Replace get_routes with list_routes

* Replace get_trunks with list_trunks

* Add area codes tests

* Add countries  tests

* Add localities and offerings tests

* Test changes in administrative division

* Replace swagger

* Update tests to include first locality

* Replace docstrings for area codes method

* Fix docstring comments

* Refactor area_codes function to receive phone number type

* Remove unecessary comments

* Add aad tests to browse api

* Update recordings

* Update recordings

* Update sync recordings

* Update sip recordings

* Update sip recordings duplicates

* Rename localities tests

* Update localities recordings

* Update localities recordings

* Remove unused recordings

* Fix linting

* Fix failling error from merge

* Fix lint and recover errased test cases

* Fix identation

* Remove whitespace

* Remove extra whitespace

Co-authored-by: Sofia Robles Sandoval <sofiar@microsoft.com>

Author: danielortega-msft

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

@@ -189,11 +189,11 @@ poller = self.phone_number_client.begin_update_phone_number_capabilities(
 Get the list of currently configured trunks or routes.
 
 ```python
-trunks = sip_routing_client.get_trunks()
+trunks = sip_routing_client.list_trunks()
 for trunk in trunks:
     print(trunk.fqdn)
     print(trunk.sip_signaling_port)
-routes = sip_routing_client.get_routes()
+routes = sip_routing_client.list_routes()
 for route in routes:
     print(route.name)
     print(route.description)

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

@@ -15,6 +15,11 @@
     PhoneNumberAssignmentType,
     PhoneNumberCapabilityType,
     PhoneNumberType,
+    PhoneNumberAreaCode,
+    PhoneNumberAdministrativeDivision,
+    PhoneNumberCountry,
+    PhoneNumberLocality,
+    PhoneNumberOffering,
 )
 
 __all__ = [
@@ -26,5 +31,10 @@
     'PhoneNumberAssignmentType',
     'PhoneNumberCapabilityType',
     'PhoneNumberType',
+    'PhoneNumberAreaCode',
+    'PhoneNumberAdministrativeDivision',
+    'PhoneNumberCountry',
+    'PhoneNumberLocality',
+    'PhoneNumberOffering',
     'PhoneNumbersClient'
 ]

sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_generated/__init__.py

@@ -6,16 +6,18 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-from ._phone_numbers_client import PhoneNumbersClient
+from ._client import PhoneNumbersClient
 
 try:
     from ._patch import __all__ as _patch_all
-    from ._patch import *  # type: ignore # pylint: disable=unused-wildcard-import
+    from ._patch import *  # pylint: disable=unused-wildcard-import
 except ImportError:
     _patch_all = []
 from ._patch import patch_sdk as _patch_sdk
 
-__all__ = ["PhoneNumbersClient"]
+__all__ = [
+    "PhoneNumbersClient",
+]
 __all__.extend([p for p in _patch_all if p not in __all__])
 
 _patch_sdk()

…bers/_generated/_phone_numbers_client.py …ation/phonenumbers/_generated/_client.pysdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_generated/_phone_numbers_client.py renamed to sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_generated/_client.py sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_generated/_phone_numbers_client.py renamed to sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_generated/_client.py

@@ -12,7 +12,7 @@
 from azure.core import PipelineClient
 from azure.core.rest import HttpRequest, HttpResponse
 
-from . import models
+from . import models as _models
 from ._configuration import PhoneNumbersClientConfiguration
 from ._serialization import Deserializer, Serializer
 from .operations import PhoneNumbersOperations
@@ -27,8 +27,8 @@ class PhoneNumbersClient:  # pylint: disable=client-accepts-api-version-keyword
     :param endpoint: The communication resource, for example
      https://resourcename.communication.azure.com. Required.
     :type endpoint: str
-    :keyword api_version: Api Version. Default value is "2022-01-11-preview2". Note that overriding
-     this default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2022-12-01". Note that overriding this
+     default value may result in unsupported behavior.
     :paramtype api_version: str
     :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
      Retry-After header is present.
@@ -41,19 +41,20 @@ def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
         self._config = PhoneNumbersClientConfiguration(endpoint=endpoint, **kwargs)
         self._client = PipelineClient(base_url=_endpoint, config=self._config, **kwargs)
 
-        client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
+        client_models = {k: v for k, v in _models._models.__dict__.items() if isinstance(v, type)}
+        client_models.update({k: v for k, v in _models.__dict__.items() if isinstance(v, type)})
         self._serialize = Serializer(client_models)
         self._deserialize = Deserializer(client_models)
         self._serialize.client_side_validation = False
         self.phone_numbers = PhoneNumbersOperations(self._client, self._config, self._serialize, self._deserialize)
 
-    def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
+    def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
         """Runs the network request through the client's chained policies.
 
         >>> from azure.core.rest import HttpRequest
         >>> request = HttpRequest("GET", "https://www.example.org/")
         <HttpRequest [GET], url: 'https://www.example.org/'>
-        >>> response = client._send_request(request)
+        >>> response = client.send_request(request)
         <HttpResponse: 200 OK>
 
         For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
@@ -73,15 +74,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)
 
-    def close(self):
-        # type: () -> None
+    def close(self) -> None:
         self._client.close()
 
-    def __enter__(self):
-        # type: () -> PhoneNumbersClient
+    def __enter__(self) -> "PhoneNumbersClient":
         self._client.__enter__()
         return self
 
-    def __exit__(self, *exc_details):
-        # type: (Any) -> None
+    def __exit__(self, *exc_details) -> None:
         self._client.__exit__(*exc_details)

sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_generated/_configuration.py

@@ -6,11 +6,17 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
+import sys
 from typing import Any
 
 from azure.core.configuration import Configuration
 from azure.core.pipeline import policies
 
+if sys.version_info >= (3, 8):
+    from typing import Literal  # pylint: disable=no-name-in-module, ungrouped-imports
+else:
+    from typing_extensions import Literal  # type: ignore  # pylint: disable=ungrouped-imports
+
 VERSION = "unknown"
 
 
@@ -23,14 +29,14 @@ class PhoneNumbersClientConfiguration(Configuration):  # pylint: disable=too-man
     :param endpoint: The communication resource, for example
      https://resourcename.communication.azure.com. Required.
     :type endpoint: str
-    :keyword api_version: Api Version. Default value is "2022-01-11-preview2". Note that overriding
-     this default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2022-12-01". Note that overriding this
+     default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
     def __init__(self, endpoint: str, **kwargs: Any) -> None:
         super(PhoneNumbersClientConfiguration, self).__init__(**kwargs)
-        api_version = kwargs.pop("api_version", "2022-01-11-preview2")  # type: str
+        api_version: Literal["2022-12-01"] = kwargs.pop("api_version", "2022-12-01")
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")
@@ -40,10 +46,7 @@ def __init__(self, endpoint: str, **kwargs: Any) -> None:
         kwargs.setdefault("sdk_moniker", "phonenumbersclient/{}".format(VERSION))
         self._configure(**kwargs)
 
-    def _configure(
-        self, **kwargs  # type: Any
-    ):
-        # type: (...) -> None
+    def _configure(self, **kwargs: Any) -> None:
         self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
         self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
         self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)

sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_generated/_patch.py

@@ -1,31 +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.
-#
-# --------------------------------------------------------------------------
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+"""Customize generated code here.
+
+Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
+"""
+from typing import List
+
+__all__: List[str] = []  # Add all objects you want publicly available to users at this package level
+
 
-# 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
+    """