Release v0.27.0

fishjam/_openapi_client/__init__.py

@@ -1,4 +1,4 @@
-"""A client library for accessing Fishjam Media Server"""
+"""A client library for accessing Fishjam API"""
 
 from .client import AuthenticatedClient, Client
 

fishjam/_openapi_client/api/moq/create_moq_token.py → fishjam/_openapi_client/api/mo_q/create_moq_token.py

@@ -76,7 +76,9 @@ def sync_detailed(
     client: AuthenticatedClient,
     body: MoqTokenConfig | Unset = UNSET,
 ) -> Response[Error | MoqToken]:
-    """Creates a MoQ token for the given stream
+    """Create a MoQ token
+
+     Issue a short-lived JWT for a Media over QUIC client.
 
     Args:
         body (MoqTokenConfig | Unset): MoQ token configuration
@@ -105,7 +107,9 @@ def sync(
     client: AuthenticatedClient,
     body: MoqTokenConfig | Unset = UNSET,
 ) -> Error | MoqToken | None:
-    """Creates a MoQ token for the given stream
+    """Create a MoQ token
+
+     Issue a short-lived JWT for a Media over QUIC client.
 
     Args:
         body (MoqTokenConfig | Unset): MoQ token configuration
@@ -129,7 +133,9 @@ async def asyncio_detailed(
     client: AuthenticatedClient,
     body: MoqTokenConfig | Unset = UNSET,
 ) -> Response[Error | MoqToken]:
-    """Creates a MoQ token for the given stream
+    """Create a MoQ token
+
+     Issue a short-lived JWT for a Media over QUIC client.
 
     Args:
         body (MoqTokenConfig | Unset): MoQ token configuration
@@ -156,7 +162,9 @@ async def asyncio(
     client: AuthenticatedClient,
     body: MoqTokenConfig | Unset = UNSET,
 ) -> Error | MoqToken | None:
-    """Creates a MoQ token for the given stream
+    """Create a MoQ token
+
+     Issue a short-lived JWT for a Media over QUIC client.
 
     Args:
         body (MoqTokenConfig | Unset): MoQ token configuration

fishjam/_openapi_client/api/room/add_peer.py → fishjam/_openapi_client/api/rooms/add_peer.py

@@ -96,7 +96,9 @@ def sync_detailed(
     client: AuthenticatedClient,
     body: PeerConfig | Unset = UNSET,
 ) -> Response[Error | PeerDetailsResponse]:
-    """Create peer
+    """Create a peer
+
+     Add a peer to a room and return its connection token.
 
     Args:
         room_id (str):
@@ -128,7 +130,9 @@ def sync(
     client: AuthenticatedClient,
     body: PeerConfig | Unset = UNSET,
 ) -> Error | PeerDetailsResponse | None:
-    """Create peer
+    """Create a peer
+
+     Add a peer to a room and return its connection token.
 
     Args:
         room_id (str):
@@ -155,7 +159,9 @@ async def asyncio_detailed(
     client: AuthenticatedClient,
     body: PeerConfig | Unset = UNSET,
 ) -> Response[Error | PeerDetailsResponse]:
-    """Create peer
+    """Create a peer
+
+     Add a peer to a room and return its connection token.
 
     Args:
         room_id (str):
@@ -185,7 +191,9 @@ async def asyncio(
     client: AuthenticatedClient,
     body: PeerConfig | Unset = UNSET,
 ) -> Error | PeerDetailsResponse | None:
-    """Create peer
+    """Create a peer
+
+     Add a peer to a room and return its connection token.
 
     Args:
         room_id (str):

fishjam/_openapi_client/api/room/create_room.py → fishjam/_openapi_client/api/rooms/create_room.py

@@ -81,7 +81,9 @@ def sync_detailed(
     client: AuthenticatedClient,
     body: RoomConfig | Unset = UNSET,
 ) -> Response[Error | RoomCreateDetailsResponse]:
-    """Creates a room
+    """Create a room
+
+     Create a new room with the given configuration.
 
     Args:
         body (RoomConfig | Unset): Room configuration
@@ -110,7 +112,9 @@ def sync(
     client: AuthenticatedClient,
     body: RoomConfig | Unset = UNSET,
 ) -> Error | RoomCreateDetailsResponse | None:
-    """Creates a room
+    """Create a room
+
+     Create a new room with the given configuration.
 
     Args:
         body (RoomConfig | Unset): Room configuration
@@ -134,7 +138,9 @@ async def asyncio_detailed(
     client: AuthenticatedClient,
     body: RoomConfig | Unset = UNSET,
 ) -> Response[Error | RoomCreateDetailsResponse]:
-    """Creates a room
+    """Create a room
+
+     Create a new room with the given configuration.
 
     Args:
         body (RoomConfig | Unset): Room configuration
@@ -161,7 +167,9 @@ async def asyncio(
     client: AuthenticatedClient,
     body: RoomConfig | Unset = UNSET,
 ) -> Error | RoomCreateDetailsResponse | None:
-    """Creates a room
+    """Create a room
+
+     Create a new room with the given configuration.
 
     Args:
         body (RoomConfig | Unset): Room configuration

fishjam/_openapi_client/api/room/delete_peer.py → fishjam/_openapi_client/api/rooms/delete_peer.py

@@ -75,7 +75,9 @@ def sync_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Any | Error]:
-    """Delete peer
+    """Delete a peer
+
+     Remove a peer from a room and disconnect it.
 
     Args:
         room_id (str):
@@ -107,7 +109,9 @@ def sync(
     *,
     client: AuthenticatedClient,
 ) -> Any | Error | None:
-    """Delete peer
+    """Delete a peer
+
+     Remove a peer from a room and disconnect it.
 
     Args:
         room_id (str):
@@ -134,7 +138,9 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Any | Error]:
-    """Delete peer
+    """Delete a peer
+
+     Remove a peer from a room and disconnect it.
 
     Args:
         room_id (str):
@@ -164,7 +170,9 @@ async def asyncio(
     *,
     client: AuthenticatedClient,
 ) -> Any | Error | None:
-    """Delete peer
+    """Delete a peer
+
+     Remove a peer from a room and disconnect it.
 
     Args:
         room_id (str):

fishjam/_openapi_client/api/room/delete_room.py → fishjam/_openapi_client/api/rooms/delete_room.py

@@ -72,7 +72,9 @@ def sync_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Any | Error]:
-    """Delete the room
+    """Delete a room
+
+     Delete a room by id and disconnect all of its peers.
 
     Args:
         room_id (str):
@@ -101,7 +103,9 @@ def sync(
     *,
     client: AuthenticatedClient,
 ) -> Any | Error | None:
-    """Delete the room
+    """Delete a room
+
+     Delete a room by id and disconnect all of its peers.
 
     Args:
         room_id (str):
@@ -125,7 +129,9 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Any | Error]:
-    """Delete the room
+    """Delete a room
+
+     Delete a room by id and disconnect all of its peers.
 
     Args:
         room_id (str):
@@ -152,7 +158,9 @@ async def asyncio(
     *,
     client: AuthenticatedClient,
 ) -> Any | Error | None:
-    """Delete the room
+    """Delete a room
+
+     Delete a room by id and disconnect all of its peers.
 
     Args:
         room_id (str):

fishjam/_openapi_client/api/room/get_all_rooms.py → fishjam/_openapi_client/api/rooms/get_all_rooms.py

@@ -53,7 +53,9 @@ def sync_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Error | RoomsListingResponse]:
-    """Show information about all rooms
+    """List all rooms
+
+     List all rooms and livestreams.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -76,7 +78,9 @@ def sync(
     *,
     client: AuthenticatedClient,
 ) -> Error | RoomsListingResponse | None:
-    """Show information about all rooms
+    """List all rooms
+
+     List all rooms and livestreams.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -95,7 +99,9 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Error | RoomsListingResponse]:
-    """Show information about all rooms
+    """List all rooms
+
+     List all rooms and livestreams.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -116,7 +122,9 @@ async def asyncio(
     *,
     client: AuthenticatedClient,
 ) -> Error | RoomsListingResponse | None:
-    """Show information about all rooms
+    """List all rooms
+
+     List all rooms and livestreams.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

fishjam/_openapi_client/api/room/get_room.py → fishjam/_openapi_client/api/rooms/get_room.py

@@ -74,7 +74,9 @@ def sync_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Error | RoomDetailsResponse]:
-    """Shows information about the room
+    """Get a room
+
+     Get a room by id.
 
     Args:
         room_id (str):
@@ -103,7 +105,9 @@ def sync(
     *,
     client: AuthenticatedClient,
 ) -> Error | RoomDetailsResponse | None:
-    """Shows information about the room
+    """Get a room
+
+     Get a room by id.
 
     Args:
         room_id (str):
@@ -127,7 +131,9 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Error | RoomDetailsResponse]:
-    """Shows information about the room
+    """Get a room
+
+     Get a room by id.
 
     Args:
         room_id (str):
@@ -154,7 +160,9 @@ async def asyncio(
     *,
     client: AuthenticatedClient,
 ) -> Error | RoomDetailsResponse | None:
-    """Shows information about the room
+    """Get a room
+
+     Get a room by id.
 
     Args:
         room_id (str):

fishjam/_openapi_client/api/room/refresh_token.py → fishjam/_openapi_client/api/rooms/refresh_token.py

@@ -77,7 +77,9 @@ def sync_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Error | PeerRefreshTokenResponse]:
-    """Refresh peer token
+    """Refresh a peer token
+
+     Issue a fresh connection token for an existing peer.
 
     Args:
         room_id (str):
@@ -109,7 +111,9 @@ def sync(
     *,
     client: AuthenticatedClient,
 ) -> Error | PeerRefreshTokenResponse | None:
-    """Refresh peer token
+    """Refresh a peer token
+
+     Issue a fresh connection token for an existing peer.
 
     Args:
         room_id (str):
@@ -136,7 +140,9 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient,
 ) -> Response[Error | PeerRefreshTokenResponse]:
-    """Refresh peer token
+    """Refresh a peer token
+
+     Issue a fresh connection token for an existing peer.
 
     Args:
         room_id (str):
@@ -166,7 +172,9 @@ async def asyncio(
     *,
     client: AuthenticatedClient,
 ) -> Error | PeerRefreshTokenResponse | None:
-    """Refresh peer token
+    """Refresh a peer token
+
+     Issue a fresh connection token for an existing peer.
 
     Args:
         room_id (str):