Number Insight GA (Azure#38793)

* Add number lookup GA

* Add GA release of Number Insight to changelog

* add number insight models to init file to make them public

* add PhoneNumberSearchResultError to init file to make them public

* error code and error from PhoneNumberSearchResult to match previous stable version

* disable pylint docstring-keyword-should-match-keyword-only

* fixed async search operatorInformation

* Change code comment, Mobile Network Code -> ISO 2 Mobile Network Code; Mobile Country Code -> ISO 2 Mobile Country Code

* update docs

* regenerate comments

* fix doc comment policy issue

* options becomes a kwarg

* fix pylint and docs

* update change logs for options as kwarg

Author: guoqing2023

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

@@ -1,5 +1,14 @@
 # Release History
 
+## 1.2.0 (2025-02-11)
+
+### Features Added
+- GA release of Number Insight.
+- API version `2025-02-11` is the default.
+
+## Other changes
+- Updated `search_operator_information` method signature to enforce `options` as a keyword-only argument.
+
 ## 1.2.0b2 (2024-03-01)
 
 ### Features Added

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

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/communication/azure-communication-phonenumbers",
-  "Tag": "python/communication/azure-communication-phonenumbers_f1965f9584"
+  "Tag": "python/communication/azure-communication-phonenumbers_a45b7bec94"
 }

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

@@ -20,23 +20,27 @@
     PhoneNumberCountry,
     PhoneNumberLocality,
     PhoneNumberOffering,
+    OperatorInformationOptions,
+    OperatorInformation,
     OperatorInformationResult,
 )
 
 __all__ = [
-    "PurchasedPhoneNumber",
-    "PhoneNumberCapabilities",
-    "PhoneNumberCost",
-    "PhoneNumberSearchResult",
-    "BillingFrequency",
-    "PhoneNumberAssignmentType",
-    "PhoneNumberCapabilityType",
-    "PhoneNumberType",
-    "PhoneNumberAreaCode",
-    "PhoneNumberAdministrativeDivision",
-    "PhoneNumberCountry",
-    "PhoneNumberLocality",
-    "PhoneNumberOffering",
-    "OperatorInformationResult",
-    "PhoneNumbersClient",
+    'PurchasedPhoneNumber',
+    'PhoneNumberCapabilities',
+    'PhoneNumberCost',
+    'PhoneNumberSearchResult',
+    'BillingFrequency',
+    'PhoneNumberAssignmentType',
+    'PhoneNumberCapabilityType',
+    'PhoneNumberType',
+    'PhoneNumberAreaCode',
+    'PhoneNumberAdministrativeDivision',
+    'PhoneNumberCountry',
+    'PhoneNumberLocality',
+    'PhoneNumberOffering',
+    'OperatorInformationOptions',
+    'OperatorInformation',
+    'OperatorInformationResult',
+    'PhoneNumbersClient'
 ]

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

@@ -12,6 +12,7 @@ class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     V2022_12_01 = "2022-12-01"
     V2023_05_01_PREVIEW = "2023-05-01-preview"
     V2024_03_01_PREVIEW = "2024-03-01-preview"
+    V2025_02_11 = "2025-02-11"
 
 
-DEFAULT_VERSION = ApiVersion.V2024_03_01_PREVIEW
+DEFAULT_VERSION = ApiVersion.V2025_02_11

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

@@ -5,19 +5,25 @@
 # Code generated by Microsoft (R) AutoRest Code Generator.
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
+# pylint: disable=wrong-import-position
 
-from ._client import PhoneNumbersClient
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._client import PhoneNumbersClient  # 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__ = [
     "PhoneNumbersClient",
 ]
-__all__.extend([p for p in _patch_all if p not in __all__])
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
 
 _patch_sdk()

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

@@ -8,6 +8,7 @@
 
 from copy import deepcopy
 from typing import Any
+from typing_extensions import Self
 
 from azure.core import PipelineClient
 from azure.core.pipeline import policies
@@ -19,7 +20,7 @@
 from .operations import PhoneNumbersOperations
 
 
-class PhoneNumbersClient:  # pylint: disable=client-accepts-api-version-keyword
+class PhoneNumbersClient:
     """The phone numbers client uses Azure Communication Services to purchase and manage phone
     numbers.
 
@@ -28,8 +29,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 "2024-03-01-preview". Note that overriding
-     this default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2025-02-11". 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.
@@ -95,7 +96,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs:
     def close(self) -> None:
         self._client.close()
 
-    def __enter__(self) -> "PhoneNumbersClient":
+    def __enter__(self) -> Self:
         self._client.__enter__()
         return self
 

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

@@ -13,7 +13,7 @@
 VERSION = "unknown"
 
 
-class PhoneNumbersClientConfiguration:  # pylint: disable=too-many-instance-attributes,name-too-long
+class PhoneNumbersClientConfiguration:  # pylint: disable=too-many-instance-attributes
     """Configuration for PhoneNumbersClient.
 
     Note that all parameters used to create this instance are saved as instance
@@ -22,13 +22,13 @@ class PhoneNumbersClientConfiguration:  # pylint: disable=too-many-instance-attr
     :param endpoint: The communication resource, for example
      https://resourcename.communication.azure.com. Required.
     :type endpoint: str
-    :keyword api_version: Api Version. Default value is "2024-03-01-preview". Note that overriding
-     this default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2025-02-11". Note that overriding this
+     default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
     def __init__(self, endpoint: str, **kwargs: Any) -> None:
-        api_version: str = kwargs.pop("api_version", "2024-03-01-preview")
+        api_version: str = kwargs.pop("api_version", "2025-02-11")
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")

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

@@ -2,6 +2,7 @@
 # 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