Add list of participants API

Author: FabienLavocat

client/src/dolbyio_rest_apis/communications/conference.py

@@ -9,7 +9,7 @@
 from dolbyio_rest_apis.communications.internal.http_context import CommunicationsHttpContext
 from dolbyio_rest_apis.core.helpers import get_value, add_if_not_none
 from dolbyio_rest_apis.core.urls import get_comms_url_v2
-from .models import UserToken, Conference, SpatialAudioEnvironment, SpatialAudioListener, SpatialAudioUser, RTCPMode, Participant, VideoCodec
+from .models import UserToken, Conference, SpatialAudioEnvironment, SpatialAudioListener, SpatialAudioUser, RTCPMode, Participant, VideoCodec, GetParticipantsResponse
 from typing import List
 
 async def create_conference(
@@ -336,6 +336,32 @@ async def update_permissions(
 
     return user_tokens
 
+async def list_participants(
+        access_token: str,
+        conference_id: str,
+    ) -> GetParticipantsResponse:
+    r"""
+    Returns the current participant list.
+
+    See: https://docs.dolby.io/communications-apis/reference/return-participant-list
+
+    Args:
+        access_token: Access token to use for authentication.
+        conference_id: Identifier of the conference.
+
+    Raises:
+        HttpRequestError: If a client error one occurred.
+        HTTPError: If one occurred.
+    """
+
+    async with CommunicationsHttpContext() as http_context:
+        json_response = await http_context.requests_get(
+            access_token=access_token,
+            url=f'{get_comms_url_v2()}/conferences/{conference_id}/participants',
+        )
+
+    return GetParticipantsResponse(json_response)
+
 async def terminate(
         access_token: str,
         conference_id: str,

client/src/dolbyio_rest_apis/communications/models.py

@@ -99,6 +99,32 @@ def __init__(self, dictionary: dict):
                 user_token = UserToken(key, self['usersTokens'][key])
                 self.user_tokens.append(user_token)
 
+class ConferenceParticipant(dict):
+    """Representation of a participant."""
+
+    def __init__(self, dictionary: dict):
+        dict.__init__(self, dictionary)
+
+        self.user_id = get_value_or_default(self, 'userId', None)
+        self.external_id = get_value_or_default(self, 'externalId', None)
+        self.name = get_value_or_default(self, 'name', None)
+        self.avatar_url = get_value_or_default(self, 'avatarUrl', None)
+        self.ip_address = get_value_or_default(self, 'ipAddress', None)
+        self.user_agent = get_value_or_default(self, 'userAgent', None)
+        self.last_join_timestamp = get_value_or_default(self, 'lastJoinTimestamp', 0)
+        self.nb_session = get_value_or_default(self, 'nbSession', 0)
+
+class GetParticipantsResponse(dict):
+    """Representation of a Participants response."""
+
+    def __init__(self, dictionary: dict):
+        dict.__init__(self, dictionary)
+
+        self.participants: List[ConferenceParticipant] = []
+        if in_and_not_none(self, 'participants'):
+            for participant in self['participants']:
+                self.participants.append(ConferenceParticipant(participant))
+
 class RemixStatus(dict):
     """Representation of a Remix Status."""