versedb 0.1.0__py3-none-any.whl

versedb/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing VerseDB API Documentation"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

versedb/api/__init__.py

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

versedb/api/barcode_lookup/__init__.py

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

versedb/api/barcode_lookup/lookup_by_isbn.py

@@ -0,0 +1,234 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.lookup_by_isbn_response_200 import LookupByIsbnResponse200
+from ...models.lookup_by_isbn_response_403 import LookupByIsbnResponse403
+from ...models.lookup_by_isbn_response_404 import LookupByIsbnResponse404
+from ...models.too_many_requests_error import TooManyRequestsError
+from ...models.unauthorized_error import UnauthorizedError
+from ...types import Response
+
+
+def _get_kwargs(
+    isbn: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/lookup/isbn/{isbn}".format(
+            isbn=quote(str(isbn), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> (
+    LookupByIsbnResponse200
+    | LookupByIsbnResponse403
+    | LookupByIsbnResponse404
+    | TooManyRequestsError
+    | UnauthorizedError
+    | None
+):
+    if response.status_code == 200:
+        response_200 = LookupByIsbnResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = UnauthorizedError.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = LookupByIsbnResponse403.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = LookupByIsbnResponse404.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = TooManyRequestsError.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[
+    LookupByIsbnResponse200
+    | LookupByIsbnResponse403
+    | LookupByIsbnResponse404
+    | TooManyRequestsError
+    | UnauthorizedError
+]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    isbn: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[
+    LookupByIsbnResponse200
+    | LookupByIsbnResponse403
+    | LookupByIsbnResponse404
+    | TooManyRequestsError
+    | UnauthorizedError
+]:
+    """Lookup by ISBN.
+
+     Find an issue by its ISBN (10 or 13 digits, with or without dashes).
+    Commonly used for trade paperbacks and hardcovers.
+    Returns full issue details including series information.
+
+    Args:
+        isbn (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[LookupByIsbnResponse200 | LookupByIsbnResponse403 | LookupByIsbnResponse404 | TooManyRequestsError | UnauthorizedError]
+    """
+
+    kwargs = _get_kwargs(
+        isbn=isbn,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    isbn: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> (
+    LookupByIsbnResponse200
+    | LookupByIsbnResponse403
+    | LookupByIsbnResponse404
+    | TooManyRequestsError
+    | UnauthorizedError
+    | None
+):
+    """Lookup by ISBN.
+
+     Find an issue by its ISBN (10 or 13 digits, with or without dashes).
+    Commonly used for trade paperbacks and hardcovers.
+    Returns full issue details including series information.
+
+    Args:
+        isbn (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:
+        LookupByIsbnResponse200 | LookupByIsbnResponse403 | LookupByIsbnResponse404 | TooManyRequestsError | UnauthorizedError
+    """
+
+    return sync_detailed(
+        isbn=isbn,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    isbn: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[
+    LookupByIsbnResponse200
+    | LookupByIsbnResponse403
+    | LookupByIsbnResponse404
+    | TooManyRequestsError
+    | UnauthorizedError
+]:
+    """Lookup by ISBN.
+
+     Find an issue by its ISBN (10 or 13 digits, with or without dashes).
+    Commonly used for trade paperbacks and hardcovers.
+    Returns full issue details including series information.
+
+    Args:
+        isbn (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[LookupByIsbnResponse200 | LookupByIsbnResponse403 | LookupByIsbnResponse404 | TooManyRequestsError | UnauthorizedError]
+    """
+
+    kwargs = _get_kwargs(
+        isbn=isbn,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    isbn: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> (
+    LookupByIsbnResponse200
+    | LookupByIsbnResponse403
+    | LookupByIsbnResponse404
+    | TooManyRequestsError
+    | UnauthorizedError
+    | None
+):
+    """Lookup by ISBN.
+
+     Find an issue by its ISBN (10 or 13 digits, with or without dashes).
+    Commonly used for trade paperbacks and hardcovers.
+    Returns full issue details including series information.
+
+    Args:
+        isbn (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:
+        LookupByIsbnResponse200 | LookupByIsbnResponse403 | LookupByIsbnResponse404 | TooManyRequestsError | UnauthorizedError
+    """
+
+    return (
+        await asyncio_detailed(
+            isbn=isbn,
+            client=client,
+        )
+    ).parsed

versedb/api/barcode_lookup/lookup_by_upc.py

@@ -0,0 +1,242 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.lookup_by_upc_response_200 import LookupByUpcResponse200
+from ...models.lookup_by_upc_response_403 import LookupByUpcResponse403
+from ...models.lookup_by_upc_response_404 import LookupByUpcResponse404
+from ...models.lookup_by_upc_response_409 import LookupByUpcResponse409
+from ...models.too_many_requests_error import TooManyRequestsError
+from ...models.unauthorized_error import UnauthorizedError
+from ...types import Response
+
+
+def _get_kwargs(
+    upc: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/lookup/upc/{upc}".format(
+            upc=quote(str(upc), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> (
+    LookupByUpcResponse200
+    | LookupByUpcResponse403
+    | LookupByUpcResponse404
+    | LookupByUpcResponse409
+    | TooManyRequestsError
+    | UnauthorizedError
+    | None
+):
+    if response.status_code == 200:
+        response_200 = LookupByUpcResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = UnauthorizedError.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        response_403 = LookupByUpcResponse403.from_dict(response.json())
+
+        return response_403
+
+    if response.status_code == 404:
+        response_404 = LookupByUpcResponse404.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 409:
+        response_409 = LookupByUpcResponse409.from_dict(response.json())
+
+        return response_409
+
+    if response.status_code == 429:
+        response_429 = TooManyRequestsError.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[
+    LookupByUpcResponse200
+    | LookupByUpcResponse403
+    | LookupByUpcResponse404
+    | LookupByUpcResponse409
+    | TooManyRequestsError
+    | UnauthorizedError
+]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    upc: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[
+    LookupByUpcResponse200
+    | LookupByUpcResponse403
+    | LookupByUpcResponse404
+    | LookupByUpcResponse409
+    | TooManyRequestsError
+    | UnauthorizedError
+]:
+    """Lookup by UPC.
+
+     Find an issue by its UPC barcode (typically 12-17 digits).
+    Returns full issue details including series information.
+
+    Args:
+        upc (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[LookupByUpcResponse200 | LookupByUpcResponse403 | LookupByUpcResponse404 | LookupByUpcResponse409 | TooManyRequestsError | UnauthorizedError]
+    """
+
+    kwargs = _get_kwargs(
+        upc=upc,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    upc: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> (
+    LookupByUpcResponse200
+    | LookupByUpcResponse403
+    | LookupByUpcResponse404
+    | LookupByUpcResponse409
+    | TooManyRequestsError
+    | UnauthorizedError
+    | None
+):
+    """Lookup by UPC.
+
+     Find an issue by its UPC barcode (typically 12-17 digits).
+    Returns full issue details including series information.
+
+    Args:
+        upc (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:
+        LookupByUpcResponse200 | LookupByUpcResponse403 | LookupByUpcResponse404 | LookupByUpcResponse409 | TooManyRequestsError | UnauthorizedError
+    """
+
+    return sync_detailed(
+        upc=upc,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    upc: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[
+    LookupByUpcResponse200
+    | LookupByUpcResponse403
+    | LookupByUpcResponse404
+    | LookupByUpcResponse409
+    | TooManyRequestsError
+    | UnauthorizedError
+]:
+    """Lookup by UPC.
+
+     Find an issue by its UPC barcode (typically 12-17 digits).
+    Returns full issue details including series information.
+
+    Args:
+        upc (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[LookupByUpcResponse200 | LookupByUpcResponse403 | LookupByUpcResponse404 | LookupByUpcResponse409 | TooManyRequestsError | UnauthorizedError]
+    """
+
+    kwargs = _get_kwargs(
+        upc=upc,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    upc: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> (
+    LookupByUpcResponse200
+    | LookupByUpcResponse403
+    | LookupByUpcResponse404
+    | LookupByUpcResponse409
+    | TooManyRequestsError
+    | UnauthorizedError
+    | None
+):
+    """Lookup by UPC.
+
+     Find an issue by its UPC barcode (typically 12-17 digits).
+    Returns full issue details including series information.
+
+    Args:
+        upc (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:
+        LookupByUpcResponse200 | LookupByUpcResponse403 | LookupByUpcResponse404 | LookupByUpcResponse409 | TooManyRequestsError | UnauthorizedError
+    """
+
+    return (
+        await asyncio_detailed(
+            upc=upc,
+            client=client,
+        )
+    ).parsed

versedb/api/characters/__init__.py

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

versedb/api/characters/get_character_details.py

@@ -0,0 +1,195 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_character_details_response_200 import GetCharacterDetailsResponse200
+from ...models.get_character_details_response_404 import GetCharacterDetailsResponse404
+from ...models.too_many_requests_error import TooManyRequestsError
+from ...models.unauthorized_error import UnauthorizedError
+from ...types import Response
+
+
+def _get_kwargs(
+    character_id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/characters/{character_id}".format(
+            character_id=quote(str(character_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError | None:
+    if response.status_code == 200:
+        response_200 = GetCharacterDetailsResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = UnauthorizedError.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = GetCharacterDetailsResponse404.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = TooManyRequestsError.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[
+    GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError
+]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    character_id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[
+    GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError
+]:
+    """Get character details.
+
+     Returns a single character with full details including publishers and
+    cached relationship counts (appearances, series, teams, story arcs) so
+    clients can decide which related-entity tabs to expose.
+
+    Args:
+        character_id (int):
+
+    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[GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError]
+    """
+
+    kwargs = _get_kwargs(
+        character_id=character_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    character_id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError | None:
+    """Get character details.
+
+     Returns a single character with full details including publishers and
+    cached relationship counts (appearances, series, teams, story arcs) so
+    clients can decide which related-entity tabs to expose.
+
+    Args:
+        character_id (int):
+
+    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:
+        GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError
+    """
+
+    return sync_detailed(
+        character_id=character_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    character_id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[
+    GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError
+]:
+    """Get character details.
+
+     Returns a single character with full details including publishers and
+    cached relationship counts (appearances, series, teams, story arcs) so
+    clients can decide which related-entity tabs to expose.
+
+    Args:
+        character_id (int):
+
+    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[GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError]
+    """
+
+    kwargs = _get_kwargs(
+        character_id=character_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    character_id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError | None:
+    """Get character details.
+
+     Returns a single character with full details including publishers and
+    cached relationship counts (appearances, series, teams, story arcs) so
+    clients can decide which related-entity tabs to expose.
+
+    Args:
+        character_id (int):
+
+    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:
+        GetCharacterDetailsResponse200 | GetCharacterDetailsResponse404 | TooManyRequestsError | UnauthorizedError
+    """
+
+    return (
+        await asyncio_detailed(
+            character_id=character_id,
+            client=client,
+        )
+    ).parsed