Add list_connections_in_group for Web PubSub SDK (Azure#40911)

Author: Y-Sindo

sdk/webpubsub/azure-messaging-webpubsubservice/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+## 1.3.0 (Unreleased)
+
+### Features Added
+- Added new APIs "list_connections"
+
 ## 1.2.2 (2025-02-28)
 
 ### Features Added

sdk/webpubsub/azure-messaging-webpubsubservice/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/webpubsub/azure-messaging-webpubsubservice",
-  "Tag": "python/webpubsub/azure-messaging-webpubsubservice_9aa2aadef9"
+  "Tag": "python/webpubsub/azure-messaging-webpubsubservice_34edba9a6b"
 }

sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/__init__.py

@@ -5,22 +5,28 @@
 # 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 WebPubSubServiceClient
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._client import WebPubSubServiceClient  # 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__ = [
     "WebPubSubServiceClient",
 ]
-__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/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/_client.py

@@ -16,16 +16,13 @@
 
 from ._configuration import WebPubSubServiceClientConfiguration
 from ._operations import WebPubSubServiceClientOperationsMixin
-from ._serialization import Deserializer, Serializer
+from ._utils.serialization import Deserializer, Serializer
 
 if TYPE_CHECKING:
-    # pylint: disable=unused-import,ungrouped-imports
     from azure.core.credentials import TokenCredential
 
 
-class WebPubSubServiceClient(
-    WebPubSubServiceClientOperationsMixin
-):  # pylint: disable=client-accepts-api-version-keyword
+class WebPubSubServiceClient(WebPubSubServiceClientOperationsMixin):
     """WebPubSubServiceClient.
 
     :param hub: Target hub name, which should start with alphabetic characters and only contain
@@ -35,14 +32,15 @@ class WebPubSubServiceClient(
     :type endpoint: str
     :param credential: Credential needed for the client to connect to Azure. Required.
     :type credential: ~azure.core.credentials.TokenCredential
-    :keyword api_version: Api Version. Default value is "2024-01-01". Note that overriding this
+    :keyword api_version: Api Version. Default value is "2024-12-01". Note that overriding this
      default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
     def __init__(self, hub: str, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
         _endpoint = "{endpoint}"
         self._config = WebPubSubServiceClientConfiguration(hub=hub, endpoint=endpoint, credential=credential, **kwargs)
+
         _policies = kwargs.pop("policies", None)
         if _policies is None:
             _policies = [

sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/_configuration.py

@@ -13,11 +13,10 @@
 from ._version import VERSION
 
 if TYPE_CHECKING:
-    # pylint: disable=unused-import,ungrouped-imports
     from azure.core.credentials import TokenCredential
 
 
-class WebPubSubServiceClientConfiguration:  # pylint: disable=too-many-instance-attributes,name-too-long
+class WebPubSubServiceClientConfiguration:  # pylint: disable=too-many-instance-attributes
     """Configuration for WebPubSubServiceClient.
 
     Note that all parameters used to create this instance are saved as instance
@@ -30,13 +29,13 @@ class WebPubSubServiceClientConfiguration:  # pylint: disable=too-many-instance-
     :type endpoint: str
     :param credential: Credential needed for the client to connect to Azure. Required.
     :type credential: ~azure.core.credentials.TokenCredential
-    :keyword api_version: Api Version. Default value is "2024-01-01". Note that overriding this
+    :keyword api_version: Api Version. Default value is "2024-12-01". Note that overriding this
      default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
     def __init__(self, hub: str, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
-        api_version: str = kwargs.pop("api_version", "2024-01-01")
+        api_version: str = kwargs.pop("api_version", "2024-12-01")
 
         if hub is None:
             raise ValueError("Parameter 'hub' must not be None.")

sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/_models.py

@@ -0,0 +1,35 @@
+from typing import Optional
+
+class GroupMember:
+    """Represents a member in a group.
+
+    :param connection_id: A unique identifier of a connection.
+    :type connection_id: str
+    :param user_id: The user ID of the connection. A user can have multiple connections.
+    :type user_id: Optional[str]
+    """
+
+    def __init__(self, connection_id: str, user_id: Optional[str] = None) -> None:
+        self._connection_id = connection_id
+        self._user_id = user_id
+
+    @property
+    def connection_id(self) -> str:
+        """Gets the connection ID.
+
+        :return: The connection ID.
+        :rtype: str
+        """
+        return self._connection_id
+
+    @property
+    def user_id(self) -> Optional[str]:
+        """Gets the user ID.
+
+        :return: The user ID.
+        :rtype: Optional[str]
+        """
+        return self._user_id
+
+    def __repr__(self) -> str:
+        return f"GroupMember(connection_id={self._connection_id!r}, user_id={self._user_id!r}, id={id(self)})"[:1024]

sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/_operations/__init__.py

@@ -5,15 +5,21 @@
 # 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 ._operations import WebPubSubServiceClientOperationsMixin
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._operations import WebPubSubServiceClientOperationsMixin  # 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__ = [
     "WebPubSubServiceClientOperationsMixin",
 ]
-__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()