fishjam-server-sdk 0.5.0__py3-none-any.whl

fishjam/__init__.py

@@ -0,0 +1,85 @@
+"""
+    .. include:: ../README.md
+"""
+
+# pylint: disable=locally-disabled, no-name-in-module, import-error
+
+# Exceptions and Server Messages
+from fishjam import errors, events
+
+# Models
+from fishjam._openapi_client.models import (
+    ComponentFile,
+    ComponentHLS,
+    ComponentOptionsFile,
+    ComponentOptionsHLS,
+    ComponentOptionsHLSSubscribeMode,
+    ComponentOptionsRecording,
+    ComponentOptionsRecordingSubscribeMode,
+    ComponentOptionsRTSP,
+    ComponentOptionsSIP,
+    ComponentPropertiesFile,
+    ComponentPropertiesHLS,
+    ComponentPropertiesHLSSubscribeMode,
+    ComponentPropertiesRecording,
+    ComponentPropertiesRecordingSubscribeMode,
+    ComponentPropertiesRTSP,
+    ComponentPropertiesSIP,
+    ComponentPropertiesSIPSIPCredentials,
+    ComponentRecording,
+    ComponentRTSP,
+    ComponentSIP,
+    Peer,
+    PeerOptionsWebRTC,
+    PeerStatus,
+    Room,
+    RoomConfig,
+    RoomConfigVideoCodec,
+    S3Credentials,
+    SIPCredentials,
+)
+
+# API
+from fishjam._webhook_notifier import receive_binary
+from fishjam._ws_notifier import Notifier
+from fishjam.api._recording_api import RecordingApi
+from fishjam.api._room_api import RoomApi
+
+__all__ = [
+    "RoomApi",
+    "RecordingApi",
+    "Notifier",
+    "receive_binary",
+    "Room",
+    "RoomConfig",
+    "RoomConfigVideoCodec",
+    "Peer",
+    "PeerOptionsWebRTC",
+    "PeerStatus",
+    "ComponentHLS",
+    "ComponentOptionsHLS",
+    "ComponentOptionsHLSSubscribeMode",
+    "ComponentPropertiesHLS",
+    "ComponentPropertiesHLSSubscribeMode",
+    "ComponentSIP",
+    "ComponentOptionsSIP",
+    "ComponentPropertiesSIP",
+    "ComponentPropertiesSIPSIPCredentials",
+    "ComponentFile",
+    "ComponentRTSP",
+    "ComponentOptionsRTSP",
+    "ComponentPropertiesRTSP",
+    "ComponentFile",
+    "ComponentOptionsFile",
+    "ComponentPropertiesFile",
+    "events",
+    "errors",
+    "SIPCredentials",
+    "ComponentRecording",
+    "ComponentOptionsRecording",
+    "ComponentOptionsRecordingSubscribeMode",
+    "ComponentPropertiesRecording",
+    "ComponentPropertiesRecordingSubscribeMode",
+    "S3Credentials",
+]
+__docformat__ = "restructuredtext"

fishjam/_openapi_client/__init__.py

@@ -0,0 +1,7 @@
+""" A client library for accessing Fishjam Media Server """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

fishjam/_openapi_client/api/__init__.py

@@ -0,0 +1 @@
+""" Contains methods for accessing the API """

fishjam/_openapi_client/api/health/healthcheck.py

@@ -0,0 +1,129 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error import Error
+from ...models.healthcheck_response import HealthcheckResponse
+from ...types import Response
+
+
+def _get_kwargs() -> Dict[str, Any]:
+    return {
+        "method": "get",
+        "url": "/health",
+    }
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Error, HealthcheckResponse]]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = HealthcheckResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == HTTPStatus.UNAUTHORIZED:
+        response_401 = Error.from_dict(response.json())
+
+        return response_401
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Error, HealthcheckResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Error, HealthcheckResponse]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Error, HealthcheckResponse]
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Error, HealthcheckResponse]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Error, HealthcheckResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

fishjam/_openapi_client/api/hls/get_hls_content.py

@@ -0,0 +1,243 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error import Error
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    room_id: str,
+    filename: str,
+    *,
+    field_hls_msn: Union[Unset, None, int] = UNSET,
+    field_hls_part: Union[Unset, None, int] = UNSET,
+    field_hls_skip: Union[Unset, None, str] = UNSET,
+    range_: Union[Unset, str] = UNSET,
+) -> Dict[str, Any]:
+    headers = {}
+    if not isinstance(range_, Unset):
+        headers["range"] = range_
+
+    params: Dict[str, Any] = {}
+    params["_HLS_msn"] = field_hls_msn
+
+    params["_HLS_part"] = field_hls_part
+
+    params["_HLS_skip"] = field_hls_skip
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    return {
+        "method": "get",
+        "url": "/hls/{room_id}/{filename}".format(
+            room_id=room_id,
+            filename=filename,
+        ),
+        "params": params,
+        "headers": headers,
+    }
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Error, str]]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = cast(str, response.json())
+        return response_200
+    if response.status_code == HTTPStatus.BAD_REQUEST:
+        response_400 = Error.from_dict(response.json())
+
+        return response_400
+    if response.status_code == HTTPStatus.NOT_FOUND:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Error, str]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    room_id: str,
+    filename: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    field_hls_msn: Union[Unset, None, int] = UNSET,
+    field_hls_part: Union[Unset, None, int] = UNSET,
+    field_hls_skip: Union[Unset, None, str] = UNSET,
+    range_: Union[Unset, str] = UNSET,
+) -> Response[Union[Error, str]]:
+    """Retrieve HLS Content
+
+    Args:
+        room_id (str):
+        filename (str):
+        field_hls_msn (Union[Unset, None, int]): Segment sequence number Example: 10.
+        field_hls_part (Union[Unset, None, int]): Partial segment sequence number Example: 10.
+        field_hls_skip (Union[Unset, None, str]): Set to "YES" if delta manifest should be
+            requested Example: True.
+        range_ (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Error, str]]
+    """
+
+    kwargs = _get_kwargs(
+        room_id=room_id,
+        filename=filename,
+        field_hls_msn=field_hls_msn,
+        field_hls_part=field_hls_part,
+        field_hls_skip=field_hls_skip,
+        range_=range_,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    room_id: str,
+    filename: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    field_hls_msn: Union[Unset, None, int] = UNSET,
+    field_hls_part: Union[Unset, None, int] = UNSET,
+    field_hls_skip: Union[Unset, None, str] = UNSET,
+    range_: Union[Unset, str] = UNSET,
+) -> Optional[Union[Error, str]]:
+    """Retrieve HLS Content
+
+    Args:
+        room_id (str):
+        filename (str):
+        field_hls_msn (Union[Unset, None, int]): Segment sequence number Example: 10.
+        field_hls_part (Union[Unset, None, int]): Partial segment sequence number Example: 10.
+        field_hls_skip (Union[Unset, None, str]): Set to "YES" if delta manifest should be
+            requested Example: True.
+        range_ (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Error, str]
+    """
+
+    return sync_detailed(
+        room_id=room_id,
+        filename=filename,
+        client=client,
+        field_hls_msn=field_hls_msn,
+        field_hls_part=field_hls_part,
+        field_hls_skip=field_hls_skip,
+        range_=range_,
+    ).parsed
+
+
+async def asyncio_detailed(
+    room_id: str,
+    filename: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    field_hls_msn: Union[Unset, None, int] = UNSET,
+    field_hls_part: Union[Unset, None, int] = UNSET,
+    field_hls_skip: Union[Unset, None, str] = UNSET,
+    range_: Union[Unset, str] = UNSET,
+) -> Response[Union[Error, str]]:
+    """Retrieve HLS Content
+
+    Args:
+        room_id (str):
+        filename (str):
+        field_hls_msn (Union[Unset, None, int]): Segment sequence number Example: 10.
+        field_hls_part (Union[Unset, None, int]): Partial segment sequence number Example: 10.
+        field_hls_skip (Union[Unset, None, str]): Set to "YES" if delta manifest should be
+            requested Example: True.
+        range_ (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Error, str]]
+    """
+
+    kwargs = _get_kwargs(
+        room_id=room_id,
+        filename=filename,
+        field_hls_msn=field_hls_msn,
+        field_hls_part=field_hls_part,
+        field_hls_skip=field_hls_skip,
+        range_=range_,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    room_id: str,
+    filename: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    field_hls_msn: Union[Unset, None, int] = UNSET,
+    field_hls_part: Union[Unset, None, int] = UNSET,
+    field_hls_skip: Union[Unset, None, str] = UNSET,
+    range_: Union[Unset, str] = UNSET,
+) -> Optional[Union[Error, str]]:
+    """Retrieve HLS Content
+
+    Args:
+        room_id (str):
+        filename (str):
+        field_hls_msn (Union[Unset, None, int]): Segment sequence number Example: 10.
+        field_hls_part (Union[Unset, None, int]): Partial segment sequence number Example: 10.
+        field_hls_skip (Union[Unset, None, str]): Set to "YES" if delta manifest should be
+            requested Example: True.
+        range_ (Union[Unset, str]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Error, str]
+    """
+
+    return (
+        await asyncio_detailed(
+            room_id=room_id,
+            filename=filename,
+            client=client,
+            field_hls_msn=field_hls_msn,
+            field_hls_part=field_hls_part,
+            field_hls_skip=field_hls_skip,
+            range_=range_,
+        )
+    ).parsed

fishjam/_openapi_client/api/recording/delete_recording.py

@@ -0,0 +1,161 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    recording_id: str,
+) -> Dict[str, Any]:
+    return {
+        "method": "delete",
+        "url": "/recording/{recording_id}".format(
+            recording_id=recording_id,
+        ),
+    }
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, Error]]:
+    if response.status_code == HTTPStatus.NO_CONTENT:
+        response_204 = cast(Any, None)
+        return response_204
+    if response.status_code == HTTPStatus.BAD_REQUEST:
+        response_400 = Error.from_dict(response.json())
+
+        return response_400
+    if response.status_code == HTTPStatus.UNAUTHORIZED:
+        response_401 = Error.from_dict(response.json())
+
+        return response_401
+    if response.status_code == HTTPStatus.NOT_FOUND:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, Error]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    recording_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[Any, Error]]:
+    """Deletes the recording
+
+    Args:
+        recording_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        recording_id=recording_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    recording_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[Any, Error]]:
+    """Deletes the recording
+
+    Args:
+        recording_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, Error]
+    """
+
+    return sync_detailed(
+        recording_id=recording_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    recording_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[Any, Error]]:
+    """Deletes the recording
+
+    Args:
+        recording_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        recording_id=recording_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    recording_id: str,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[Any, Error]]:
+    """Deletes the recording
+
+    Args:
+        recording_id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, Error]
+    """
+
+    return (
+        await asyncio_detailed(
+            recording_id=recording_id,
+            client=client,
+        )
+    ).parsed