pyninaapiio 0.0.2__tar.gz → 0.0.4__tar.gz

{pyninaapiio-0.0.2 → pyninaapiio-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyninaapiio
-Version: 0.0.2
+Version: 0.0.4
 Summary: Python Wrapper for N.I.N.A. Advanced API
 Home-page: https://github.com/mawinkler/pyninaapiio
 Author: Markus Winkler
@@ -23,6 +23,7 @@ Classifier: Programming Language :: Python :: 3.13
 License-File: LICENSE
 Requires-Dist: httpx
 Requires-Dist: attrs
+Requires-Dist: typeguard
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

pyninaapiio-0.0.4/pyninaapiio/__init__.py

@@ -0,0 +1,10 @@
+"""A client library for accessing Advanced API"""
+
+from pyninaapiio.client import AuthenticatedClient, Client
+from pyninaapiio.nina import NinaAPI
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+    "NinaAPI",
+)

pyninaapiio-0.0.4/pyninaapiio/api/__init__.py

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

pyninaapiio-0.0.4/pyninaapiio/api/application/__init__.py

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

pyninaapiio-0.0.4/pyninaapiio/api/application/get_application_get_tab.py

@@ -0,0 +1,144 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_application_get_tab_response_200 import GetApplicationGetTabResponse200
+from ...models.get_application_get_tab_response_400 import GetApplicationGetTabResponse400
+from ...models.unknown_error import UnknownError
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/application/get-tab",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    if response.status_code == 200:
+        response_200 = GetApplicationGetTabResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = GetApplicationGetTabResponse400.from_dict(response.json())
+
+        return response_400
+    if response.status_code == 500:
+        response_500 = UnknownError.from_dict(response.json())
+
+        return response_500
+    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[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    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: Union[AuthenticatedClient, Client],
+) -> Response[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    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[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    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[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    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[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    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[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

pyninaapiio-0.0.4/pyninaapiio/api/application/get_application_plugins.py

@@ -0,0 +1,134 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.unknown_error import UnknownError
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/application/plugins",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[UnknownError]:
+    if response.status_code == 500:
+        response_500 = UnknownError.from_dict(response.json())
+
+        return response_500
+    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[UnknownError]:
+    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: Union[AuthenticatedClient, Client],
+) -> Response[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    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[UnknownError]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    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:
+        UnknownError
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    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[UnknownError]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    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:
+        UnknownError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

pyninaapiio-0.0.4/pyninaapiio/api/application/get_application_screenshot.py

@@ -0,0 +1,231 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_application_screenshot_response_200 import GetApplicationScreenshotResponse200
+from ...models.unknown_error import UnknownError
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    resize: Union[Unset, bool] = UNSET,
+    quality: Union[Unset, int] = UNSET,
+    size: Union[Unset, str] = UNSET,
+    scale: Union[Unset, float] = UNSET,
+    stream: Union[Unset, bool] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["resize"] = resize
+
+    params["quality"] = quality
+
+    params["size"] = size
+
+    params["scale"] = scale
+
+    params["stream"] = stream
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/application/screenshot",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[GetApplicationScreenshotResponse200, UnknownError]]:
+    if response.status_code == 200:
+        response_200 = GetApplicationScreenshotResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 500:
+        response_500 = UnknownError.from_dict(response.json())
+
+        return response_500
+    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[GetApplicationScreenshotResponse200, UnknownError]]:
+    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: Union[AuthenticatedClient, Client],
+    resize: Union[Unset, bool] = UNSET,
+    quality: Union[Unset, int] = UNSET,
+    size: Union[Unset, str] = UNSET,
+    scale: Union[Unset, float] = UNSET,
+    stream: Union[Unset, bool] = UNSET,
+) -> Response[Union[GetApplicationScreenshotResponse200, UnknownError]]:
+    """Screenshot
+
+     Takes a screenshot
+
+    Args:
+        resize (Union[Unset, bool]):
+        quality (Union[Unset, int]):
+        size (Union[Unset, str]):
+        scale (Union[Unset, float]):
+        stream (Union[Unset, bool]):
+
+    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[GetApplicationScreenshotResponse200, UnknownError]]
+    """
+
+    kwargs = _get_kwargs(
+        resize=resize,
+        quality=quality,
+        size=size,
+        scale=scale,
+        stream=stream,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    resize: Union[Unset, bool] = UNSET,
+    quality: Union[Unset, int] = UNSET,
+    size: Union[Unset, str] = UNSET,
+    scale: Union[Unset, float] = UNSET,
+    stream: Union[Unset, bool] = UNSET,
+) -> Optional[Union[GetApplicationScreenshotResponse200, UnknownError]]:
+    """Screenshot
+
+     Takes a screenshot
+
+    Args:
+        resize (Union[Unset, bool]):
+        quality (Union[Unset, int]):
+        size (Union[Unset, str]):
+        scale (Union[Unset, float]):
+        stream (Union[Unset, bool]):
+
+    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[GetApplicationScreenshotResponse200, UnknownError]
+    """
+
+    return sync_detailed(
+        client=client,
+        resize=resize,
+        quality=quality,
+        size=size,
+        scale=scale,
+        stream=stream,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    resize: Union[Unset, bool] = UNSET,
+    quality: Union[Unset, int] = UNSET,
+    size: Union[Unset, str] = UNSET,
+    scale: Union[Unset, float] = UNSET,
+    stream: Union[Unset, bool] = UNSET,
+) -> Response[Union[GetApplicationScreenshotResponse200, UnknownError]]:
+    """Screenshot
+
+     Takes a screenshot
+
+    Args:
+        resize (Union[Unset, bool]):
+        quality (Union[Unset, int]):
+        size (Union[Unset, str]):
+        scale (Union[Unset, float]):
+        stream (Union[Unset, bool]):
+
+    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[GetApplicationScreenshotResponse200, UnknownError]]
+    """
+
+    kwargs = _get_kwargs(
+        resize=resize,
+        quality=quality,
+        size=size,
+        scale=scale,
+        stream=stream,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    resize: Union[Unset, bool] = UNSET,
+    quality: Union[Unset, int] = UNSET,
+    size: Union[Unset, str] = UNSET,
+    scale: Union[Unset, float] = UNSET,
+    stream: Union[Unset, bool] = UNSET,
+) -> Optional[Union[GetApplicationScreenshotResponse200, UnknownError]]:
+    """Screenshot
+
+     Takes a screenshot
+
+    Args:
+        resize (Union[Unset, bool]):
+        quality (Union[Unset, int]):
+        size (Union[Unset, str]):
+        scale (Union[Unset, float]):
+        stream (Union[Unset, bool]):
+
+    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[GetApplicationScreenshotResponse200, UnknownError]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            resize=resize,
+            quality=quality,
+            size=size,
+            scale=scale,
+            stream=stream,
+        )
+    ).parsed