aioaudiobookshelf 0.1.0__py3-none-any.whl

aioaudiobookshelf/schema/book.py

@@ -0,0 +1,125 @@
+"""Schema for Books."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+from .audio import AudioFile, AudioTrack
+from .author import AuthorMinified
+from .file import FileMetadata
+from .series import SeriesSequence
+
+
+@dataclass(kw_only=True)
+class EBookFile(_BaseModel):
+    """EBookFile."""
+
+    ino: str
+    metadata: FileMetadata
+    ebook_format: Annotated[str, Alias("ebookFormat")]
+    added_at: Annotated[int, Alias("addedAt")]  # time in ms since unix epoch
+    updated_at: Annotated[int, Alias("updatedAt")]  # time in ms since unix epoch
+
+
+@dataclass(kw_only=True)
+class BookChapter(_BaseModel):
+    """
+    BookChapter. No variants.
+
+    https://api.audiobookshelf.org/#book-chapter
+    """
+
+    id_: Annotated[int, Alias("id")]
+    start: float
+    end: float
+    title: str
+
+
+@dataclass(kw_only=True)
+class _BookMetadataBase(_BaseModel):
+    """_BookMetadataBase."""
+
+    title: str | None = None
+    subtitle: str | None = None
+    genres: list[str]
+    published_year: Annotated[str | None, Alias("publishedYear")] = None
+    published_date: Annotated[str | None, Alias("publishedDate")] = None
+    publisher: str | None = None
+    description: str | None = None
+    isbn: str | None = None
+    asin: str | None = None
+    language: str | None = None
+    explicit: bool
+
+
+@dataclass(kw_only=True)
+class BookMetadata(_BookMetadataBase):
+    """BookMetadata."""
+
+    authors: list[AuthorMinified]
+    narrators: list[str]
+    series: list[SeriesSequence]
+
+
+@dataclass(kw_only=True)
+class BookMetadataMinified(_BookMetadataBase):
+    """BookMetadataMinified."""
+
+    title_ignore_prefix: Annotated[str, Alias("titleIgnorePrefix")]
+    author_name: Annotated[str, Alias("authorName")]
+    author_name_lf: Annotated[str, Alias("authorNameLF")]
+    narrator_name: Annotated[str, Alias("narratorName")]
+    series_name: Annotated[str, Alias("seriesName")]
+
+
+@dataclass(kw_only=True)
+class BookMetadataExpanded(BookMetadata, BookMetadataMinified):
+    """BookMetadataExpanded."""
+
+
+@dataclass(kw_only=True)
+class _BookBase(_BaseModel):
+    """_BookBase."""
+
+    tags: list[str]
+    cover_path: Annotated[str | None, Alias("coverPath")] = None
+
+
+@dataclass(kw_only=True)
+class Book(_BookBase):
+    """Book."""
+
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    metadata: BookMetadata
+    audio_files: Annotated[list[AudioFile], Alias("audioFiles")]
+    chapters: list[BookChapter]
+    ebook_file: Annotated[EBookFile | None, Alias("ebookFile")] = None
+
+
+@dataclass(kw_only=True)
+class BookMinified(_BookBase):
+    """BookMinified."""
+
+    metadata: BookMetadataMinified
+    num_tracks: Annotated[int, Alias("numTracks")]
+    num_audiofiles: Annotated[int, Alias("numAudioFiles")]
+    num_chapters: Annotated[int, Alias("numChapters")]
+    duration: float  # in s
+    size: int  # in bytes
+    ebook_format: Annotated[str | None, Alias("ebookFormat")] = None
+
+
+@dataclass(kw_only=True)
+class BookExpanded(_BookBase):
+    """BookExpanded."""
+
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    metadata: BookMetadataExpanded
+    audio_files: Annotated[list[AudioFile], Alias("audioFiles")]
+    chapters: list[BookChapter]
+    ebook_file: Annotated[EBookFile | None, Alias("ebookFile")] = None
+    duration: float
+    size: int  # bytes
+    tracks: list[AudioTrack]

aioaudiobookshelf/schema/calls_authors.py

@@ -0,0 +1,33 @@
+"""Calls to /api/authors."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+from .author import Author
+from .library import LibraryItemMinified
+
+
+@dataclass(kw_only=True)
+class AuthorSeries(_BaseModel):
+    """AuthorSeries."""
+
+    id_: Annotated[str, Alias("id")]
+    name: str
+    items: list[LibraryItemMinified]
+
+
+@dataclass(kw_only=True)
+class AuthorWithItems(Author):
+    """AuthorWithItems."""
+
+    library_items: Annotated[list[LibraryItemMinified], Alias("libraryItems")]
+
+
+@dataclass(kw_only=True)
+class AuthorWithItemsAndSeries(AuthorWithItems):
+    """AuthorWithItemsAndSeries."""
+
+    series: list[AuthorSeries]

aioaudiobookshelf/schema/calls_collections.py

@@ -0,0 +1,14 @@
+"""Params and responses for collections."""
+
+from dataclasses import dataclass
+
+from aioaudiobookshelf.schema.collection import CollectionExpanded
+
+from . import _BaseModel
+
+
+@dataclass(kw_only=True)
+class AllCollectionsResponse(_BaseModel):
+    """AllCollectionsResponse."""
+
+    collections: list[CollectionExpanded]

aioaudiobookshelf/schema/calls_items.py

@@ -0,0 +1,53 @@
+"""Calls for items."""
+
+from dataclasses import dataclass, field
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from aioaudiobookshelf.schema import _BaseModel
+from aioaudiobookshelf.schema.library import (
+    LibraryItemExpandedBook,
+    LibraryItemExpandedPodcast,
+)
+from aioaudiobookshelf.schema.session import DeviceInfo
+
+
+@dataclass(kw_only=True)
+class PlayParameters(_BaseModel):
+    """PlayParameters.
+
+    https://api.audiobookshelf.org/#play-a-library-item-or-podcast-episode
+    """
+
+    device_info: Annotated[DeviceInfo, Alias("deviceInfo")]
+    force_direct_play: Annotated[bool, Alias("forceDirectPlay")] = False
+    force_transcode: Annotated[bool, Alias("forceTranscode")] = False
+    supported_mime_types: Annotated[list[str], Alias("supportedMimeTypes")] = field(
+        default_factory=list
+    )
+    media_player: Annotated[str, Alias("mediaPlayer")] = "unknown"
+
+
+PlaybackSessionParameters = PlayParameters
+
+
+@dataclass(kw_only=True)
+class LibraryItemsBatchParameters(_BaseModel):
+    """GetLibraryItemsBatchParameters."""
+
+    library_item_ids: Annotated[list[str], Alias("libraryItemIds")]
+
+
+@dataclass(kw_only=True)
+class LibraryItemsBatchBookResponse(_BaseModel):
+    """GetLibraryItemsBatchBookResponse."""
+
+    library_items: Annotated[list[LibraryItemExpandedBook], Alias("libraryItems")]
+
+
+@dataclass(kw_only=True)
+class LibraryItemsBatchPodcastResponse(_BaseModel):
+    """GetLibraryItemsBatchBookResponse."""
+
+    library_items: Annotated[list[LibraryItemExpandedPodcast], Alias("libraryItems")]

aioaudiobookshelf/schema/calls_library.py

@@ -0,0 +1,103 @@
+"""Calls for Libraries."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from aioaudiobookshelf.schema.author import AuthorExpanded, Narrator
+from aioaudiobookshelf.schema.collection import Collection, CollectionExpanded
+from aioaudiobookshelf.schema.playlist import PlaylistExpanded
+from aioaudiobookshelf.schema.series_books import SeriesBooks, SeriesBooksMinified
+
+from . import _BaseModel
+from .library import Library, LibraryFilterData, LibraryItem, LibraryItemMinified
+
+
+@dataclass(kw_only=True)
+class AllLibrariesResponse(_BaseModel):
+    """LibrariesResponse."""
+
+    libraries: list[Library]
+
+
+@dataclass(kw_only=True)
+class LibraryWithFilterDataResponse(_BaseModel):
+    """LibraryWithFilterDataResponse."""
+
+    filterdata: LibraryFilterData
+    issues: int
+    num_user_playlists: Annotated[int, Alias("numUserPlaylists")]
+    library: Library
+
+
+@dataclass(kw_only=True)
+class _LibraryPaginationResponseBase(_BaseModel):
+    """Due to options of this API call, some parameters omitted."""
+
+    total: int
+    limit: int
+    page: int
+
+
+@dataclass(kw_only=True)
+class LibraryItemsMinifiedResponse(_LibraryPaginationResponseBase):
+    """LibraryItemsMinifiedResponse."""
+
+    results: list[LibraryItemMinified]
+
+
+@dataclass(kw_only=True)
+class LibraryItemsResponse(_LibraryPaginationResponseBase):
+    """LibraryItemsResponse."""
+
+    results: list[LibraryItem]
+
+
+@dataclass(kw_only=True)
+class LibrarySeriesResponse(_LibraryPaginationResponseBase):
+    """LibrarySeriesResponse."""
+
+    results: list[SeriesBooks]
+
+
+@dataclass(kw_only=True)
+class LibrarySeriesMinifiedResponse(_LibraryPaginationResponseBase):
+    """LibrarySeriesMinifiedResponse."""
+
+    results: list[SeriesBooksMinified]
+
+
+@dataclass(kw_only=True)
+class LibraryCollectionsResponse(_LibraryPaginationResponseBase):
+    """LibraryCollectionsResponse."""
+
+    results: list[CollectionExpanded]
+
+
+@dataclass(kw_only=True)
+class LibraryCollectionsMinifiedResponse(_LibraryPaginationResponseBase):
+    """LibraryCollectionMinifiedResponse."""
+
+    results: list[Collection]
+
+
+@dataclass(kw_only=True)
+class LibraryPlaylistsResponse(_LibraryPaginationResponseBase):
+    """LibraryPlaylistsResponse."""
+
+    results: list[PlaylistExpanded]
+
+
+@dataclass(kw_only=True)
+class LibraryAuthorsResponse(_BaseModel):
+    """LibraryAuthorsResponse."""
+
+    authors: list[AuthorExpanded]
+
+
+@dataclass(kw_only=True)
+class LibraryNarratorsResponse(_BaseModel):
+    """LibraryNarratorsResponse."""
+
+    narrators: list[Narrator]

aioaudiobookshelf/schema/calls_login.py

@@ -0,0 +1,28 @@
+"""Requests and responses to talk to abs api."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.mixins.json import DataClassJSONMixin
+from mashumaro.types import Alias
+
+from .server import ServerSettings
+from .user import User
+
+
+@dataclass(kw_only=True)
+class LoginParameters(DataClassJSONMixin):
+    """Login params."""
+
+    username: str
+    password: str
+
+
+@dataclass(kw_only=True)
+class LoginResponse(DataClassJSONMixin):
+    """Response to login request."""
+
+    user: User
+    user_default_library_id: Annotated[str, Alias("userDefaultLibraryId")]
+    server_settings: Annotated[ServerSettings, Alias("serverSettings")]
+    source: Annotated[str, Alias("Source")]

aioaudiobookshelf/schema/calls_me.py

@@ -0,0 +1,28 @@
+"""Params and responses for me."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from aioaudiobookshelf.schema.session import PlaybackSession
+
+from . import _BaseModel
+
+
+@dataclass(kw_only=True)
+class MeListeningSessionsParameters(_BaseModel):
+    """MeListeningSessionsParameters."""
+
+    items_per_page: Annotated[int, Alias("itemsPerPage")] = 10
+    page: int = 0
+
+
+@dataclass(kw_only=True)
+class MeListeningSessionsResponse(_BaseModel):
+    """MeListeningSessionsResponse."""
+
+    total: int
+    num_pages: Annotated[int, Alias("numPages")]
+    items_per_page: Annotated[int, Alias("itemsPerPage")]
+    sessions: list[PlaybackSession]

aioaudiobookshelf/schema/calls_playlists.py

@@ -0,0 +1,14 @@
+"""Params and responses for playlists."""
+
+from dataclasses import dataclass
+
+from aioaudiobookshelf.schema.playlist import PlaylistExpanded
+
+from . import _BaseModel
+
+
+@dataclass(kw_only=True)
+class AllPlaylistsResponse(_BaseModel):
+    """AllPlaylistsResponse."""
+
+    playlists: list[PlaylistExpanded]

aioaudiobookshelf/schema/calls_series.py

@@ -0,0 +1,25 @@
+"""Calls to /api/series."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+from .series import Series
+
+
+@dataclass(kw_only=True)
+class SeriesProgress(_BaseModel):
+    """SeriesProgress."""
+
+    library_item_ids: Annotated[list[str], Alias("libraryItemIds")]
+    library_items_ids_finished: Annotated[list[str], Alias("libraryItemIdsFinished")]
+    is_finished: Annotated[bool, Alias("isFinished")]
+
+
+@dataclass(kw_only=True)
+class SeriesWithProgress(Series):
+    """SeriesWithProgress."""
+
+    progress: SeriesProgress

aioaudiobookshelf/schema/calls_session.py

@@ -0,0 +1,17 @@
+"""Params and responses for sessions."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+
+
+@dataclass(kw_only=True)
+class CloseOpenSessionsParameters(_BaseModel):
+    """CloseOpenSessionsParameters."""
+
+    current_time: Annotated[float, Alias("currentTime")]
+    time_listened: Annotated[float, Alias("timeListened")]
+    duration: float

aioaudiobookshelf/schema/collection.py

@@ -0,0 +1,36 @@
+"""Schema for Collections."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+from .library import LibraryItemBook, LibraryItemExpandedBook
+
+
+@dataclass(kw_only=True)
+class _CollectionBase(_BaseModel):
+    """_CollectionBase."""
+
+    id_: Annotated[str, Alias("id")]
+    library_id: Annotated[str, Alias("libraryId")]
+    user_id: Annotated[str | None, Alias("userId")] = None
+    name: str
+    description: str | None = None
+    last_update: Annotated[int, Alias("lastUpdate")]  # ms epoch
+    created_at: Annotated[int, Alias("createdAt")]  # ms epoch
+
+
+@dataclass(kw_only=True)
+class Collection(_CollectionBase):
+    """Collection."""
+
+    books: list[LibraryItemBook]
+
+
+@dataclass(kw_only=True)
+class CollectionExpanded(_CollectionBase):
+    """Collection."""
+
+    books: list[LibraryItemExpandedBook]

aioaudiobookshelf/schema/events_socket.py

@@ -0,0 +1,46 @@
+"""Scheme for socket client."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+from .media_progress import MediaProgress
+
+
+@dataclass(kw_only=True)
+class UserItemProgressUpdatedEvent(_BaseModel):
+    """UserItemProgressUpdatedEvent."""
+
+    id_: Annotated[str, Alias("id")]
+    data: MediaProgress
+
+
+@dataclass(kw_only=True)
+class PodcastEpisodeDownload(_BaseModel):
+    """PodcastEpisodeDownload."""
+
+    id_: Annotated[str, Alias("id")]
+    episode_display_title: Annotated[str, Alias("episodeDisplayTitle")]
+    url: str
+    library_item_id: Annotated[str, Alias("libraryItemId")]
+    library_id: Annotated[str, Alias("libraryId")]
+    is_finished: Annotated[bool, Alias("isFinished")]
+    failed: bool
+    started_at: Annotated[int | None, Alias("startedAt")] = None
+    created_at: Annotated[int, Alias("createdAt")]
+    finished_at: Annotated[int | None, Alias("finishedAt")] = None
+    podcast_title: Annotated[str | None, Alias("podcastTitle")] = None
+    podcast_explicit: Annotated[bool, Alias("podcastExplicit")]
+    season: str | None = None
+    episode: str | None = None
+    episode_type: Annotated[str, Alias("episodeType")]
+    published_at: Annotated[int | None, Alias("publishedAt")] = None
+
+
+@dataclass(kw_only=True)
+class LibraryItemRemoved(_BaseModel):
+    """LibraryItemRemoved."""
+
+    id_: Annotated[str, Alias("id")]

aioaudiobookshelf/schema/file.py

@@ -0,0 +1,22 @@
+"""File schema."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+
+
+@dataclass(kw_only=True)
+class FileMetadata(_BaseModel):
+    """FileMetadata."""
+
+    filename: str
+    ext: str
+    path: str
+    relative_path: Annotated[str, Alias("relPath")]
+    size: int  # in bytes
+    modified_time_ms: Annotated[int, Alias("mtimeMs")]
+    changed_time_ms: Annotated[int, Alias("ctimeMs")]
+    created_time_ms: Annotated[int, Alias("birthtimeMs")] = 0  # 0 if unknown

aioaudiobookshelf/schema/folder.py

@@ -0,0 +1,18 @@
+"""Folder Schema."""
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.types import Alias
+
+from . import _BaseModel
+
+
+@dataclass(kw_only=True)
+class Folder(_BaseModel):
+    """Folder."""
+
+    id_: Annotated[str, Alias("id")]
+    full_path: Annotated[str, Alias("fullPath")]
+    library_id: Annotated[str, Alias("libraryId")]
+    added_at: Annotated[int, Alias("addedAt")]  # ms epoch