@silverfish-app/sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,1432 @@
+import { T as TDataShape, O as Options$1, a as Client, b as ClientMeta, e as RequestResult } from './types.gen-Bfm1raMe.js';
+
+type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+/**
+ * AuthorOut
+ */
+type AuthorOut = {
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Sort
+     */
+    sort: string;
+};
+/**
+ * BinaryHealthOut
+ *
+ * Availability of the Calibre binaries (optional system dependency).
+ */
+type BinaryHealthOut = {
+    /**
+     * Convert Available
+     */
+    convert_available: boolean;
+    /**
+     * Metadata Available
+     */
+    metadata_available: boolean;
+};
+/**
+ * Body_upload_book
+ */
+type BodyUploadBook = {
+    /**
+     * File
+     */
+    file: Blob | File;
+};
+/**
+ * BookOut
+ *
+ * A book as returned by the API.
+ *
+ * ``id`` is the public form of the book's internal id — always a string so the
+ * contract keeps one shape, but rendered per library mode (short base62 for
+ * standalone Snowflake ids, plain decimal for Calibre's small ids).
+ */
+type BookOut = {
+    /**
+     * Author Sort
+     */
+    author_sort: string;
+    /**
+     * Authors
+     */
+    authors: Array<AuthorOut>;
+    /**
+     * Cover Url
+     */
+    cover_url: string | null;
+    /**
+     * Formats
+     */
+    formats: Array<FormatOut>;
+    /**
+     * Has Cover
+     */
+    has_cover: boolean;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Identifiers
+     */
+    identifiers: Array<IdentifierOut>;
+    /**
+     * Languages
+     */
+    languages: Array<string>;
+    /**
+     * Publisher
+     */
+    publisher: string | null;
+    /**
+     * Rating
+     */
+    rating: number | null;
+    series: SeriesOut | null;
+    /**
+     * Sort
+     */
+    sort: string;
+    /**
+     * Tags
+     */
+    tags: Array<TagOut>;
+    /**
+     * Title
+     */
+    title: string;
+};
+/**
+ * BookPage
+ *
+ * A paginated page of books.
+ */
+type BookPage = {
+    /**
+     * Has Next
+     */
+    has_next: boolean;
+    /**
+     * Has Prev
+     */
+    has_prev: boolean;
+    /**
+     * Items
+     */
+    items: Array<BookOut>;
+    /**
+     * Page
+     */
+    page: number;
+    /**
+     * Page Size
+     */
+    page_size: number;
+    /**
+     * Total
+     */
+    total: number;
+    /**
+     * Total Pages
+     */
+    total_pages: number;
+};
+/**
+ * BookUpdate
+ *
+ * A partial book metadata update. Only provided fields are changed.
+ *
+ * Omitting a field leaves it untouched; sending ``null`` clears it (e.g.
+ * ``rating: null`` removes the rating). Sort keys and the on-disk path are
+ * recomputed by the server when title/authors change.
+ */
+type BookUpdate = {
+    /**
+     * Authors
+     *
+     * Full author list (replaces the existing one).
+     */
+    authors?: Array<string> | null;
+    /**
+     * Comment
+     *
+     * Description/notes (HTML allowed), or null to clear.
+     */
+    comment?: string | null;
+    /**
+     * Languages
+     *
+     * Language codes (replaces the existing list).
+     */
+    languages?: Array<string> | null;
+    /**
+     * Publisher
+     *
+     * Publisher name, or null to clear.
+     */
+    publisher?: string | null;
+    /**
+     * Rating
+     *
+     * Rating 0-10 (Calibre scale), or null to clear.
+     */
+    rating?: number | null;
+    /**
+     * Series
+     *
+     * Series name, or null to clear.
+     */
+    series?: string | null;
+    /**
+     * Series Index
+     *
+     * Position within the series.
+     */
+    series_index?: number | null;
+    /**
+     * Tags
+     *
+     * Full tag list (replaces the existing one).
+     */
+    tags?: Array<string> | null;
+    /**
+     * Title
+     *
+     * New title.
+     */
+    title?: string | null;
+};
+/**
+ * ConvertRequest
+ *
+ * Request to convert a book from one format to another.
+ */
+type ConvertRequest = {
+    /**
+     * Source Format
+     *
+     * Format to convert from. When omitted, the API picks the best available source by a default priority order.
+     */
+    source_format?: string | null;
+    /**
+     * Target Format
+     *
+     * Format to produce, e.g. 'EPUB', 'MOBI', 'AZW3', 'PDF'.
+     */
+    target_format: string;
+};
+/**
+ * EmailConfigOut
+ *
+ * Non-secret view of the email configuration (never includes the password).
+ *
+ * Whether sending is *available* is reported by ``/health`` (``send_available``);
+ * this is the detail view for a settings screen.
+ */
+type EmailConfigOut = {
+    /**
+     * Configured
+     */
+    configured: boolean;
+    /**
+     * From Address
+     */
+    from_address: string;
+    /**
+     * Host
+     */
+    host: string;
+    /**
+     * Port
+     */
+    port: number;
+    /**
+     * Security
+     */
+    security: string;
+};
+/**
+ * EmailTestRequest
+ *
+ * Request to send a connectivity test email.
+ */
+type EmailTestRequest = {
+    /**
+     * To Email
+     *
+     * Address to send the SMTP connectivity test email to.
+     */
+    to_email: string;
+};
+/**
+ * ErrorBody
+ *
+ * The body of a standardized error.
+ */
+type ErrorBody = {
+    /**
+     * Details
+     */
+    details?: Array<ErrorDetail> | null;
+    /**
+     * Message
+     */
+    message: string;
+    /**
+     * Status
+     */
+    status: number;
+};
+/**
+ * ErrorDetail
+ *
+ * A single field-level validation problem.
+ */
+type ErrorDetail = {
+    /**
+     * Location
+     */
+    location: string;
+    /**
+     * Message
+     */
+    message: string;
+};
+/**
+ * ErrorResponse
+ *
+ * Every error the API returns shares this shape: ``{"error": {...}}``.
+ */
+type ErrorResponse = {
+    error: ErrorBody;
+};
+/**
+ * ExportRequest
+ *
+ * Request to export the library to a Calibre-format zip.
+ *
+ * The export runs asynchronously; a time-limited download link is emailed to
+ * ``to_email`` when it is ready (the zip is never attached — a library can be
+ * far larger than any mail server accepts).
+ *
+ * ``book_ids`` selects which books to export (public id strings). Omit it to
+ * export the whole library.
+ */
+type ExportRequest = {
+    /**
+     * Book Ids
+     *
+     * Public ids of the books to export; omit to export the whole library.
+     */
+    book_ids?: Array<string> | null;
+    /**
+     * To Email
+     *
+     * Address that receives the download link when ready.
+     */
+    to_email: string;
+};
+/**
+ * FormatOut
+ */
+type FormatOut = {
+    /**
+     * Download Url
+     */
+    download_url: string;
+    /**
+     * Extension
+     */
+    extension: string;
+    /**
+     * Size Bytes
+     */
+    size_bytes: number;
+};
+/**
+ * HTTPValidationError
+ */
+type HttpValidationError = {
+    /**
+     * Detail
+     */
+    detail?: Array<ValidationError>;
+};
+/**
+ * HealthResponse
+ *
+ * Liveness payload. Typed so it appears in the OpenAPI contract.
+ */
+type HealthResponse = {
+    binaries: BinaryHealthOut;
+    /**
+     * Send Available
+     */
+    send_available: boolean;
+    /**
+     * Status
+     */
+    status: string;
+    /**
+     * Version
+     */
+    version: string;
+};
+/**
+ * IdentifierOut
+ */
+type IdentifierOut = {
+    /**
+     * Scheme
+     */
+    scheme: string;
+    /**
+     * Value
+     */
+    value: string;
+};
+/**
+ * JobOut
+ *
+ * A background job's observable state.
+ */
+type JobOut = {
+    /**
+     * Error
+     *
+     * Failure reason when status is 'error', else null.
+     */
+    error?: string | null;
+    /**
+     * Id
+     *
+     * Opaque job id; poll it at /jobs/{job_id}.
+     */
+    id: string;
+    /**
+     * Message
+     *
+     * Human-readable description of the current step.
+     */
+    message?: string;
+    /**
+     * Progress
+     *
+     * Completion fraction from 0.0 to 1.0.
+     */
+    progress: number;
+    /**
+     * Current lifecycle state.
+     */
+    status: JobStatusOut;
+    /**
+     * What kind of work this job performs.
+     */
+    type: JobType;
+};
+/**
+ * JobStatusOut
+ *
+ * A job's lifecycle state (mirrors the core's JobStatus).
+ */
+type JobStatusOut = 'queued' | 'running' | 'done' | 'error';
+/**
+ * JobType
+ *
+ * The kind of background work a job performs.
+ */
+type JobType = 'convert' | 'send' | 'export';
+/**
+ * RefreshRequest
+ *
+ * Request to refresh a book's metadata from one of its format files.
+ */
+type RefreshRequest = {
+    /**
+     * Source Format
+     *
+     * Which existing format to re-read metadata (and cover) from, e.g. 'EPUB'.
+     */
+    source_format: string;
+};
+/**
+ * SendRequest
+ *
+ * Request to send a book to an e-reader email address.
+ */
+type SendRequest = {
+    /**
+     * Format
+     *
+     * Format to send. When omitted, the best available is chosen. Must be a format the book actually has, otherwise the request is rejected.
+     */
+    format?: string | null;
+    /**
+     * To Email
+     *
+     * Destination e-reader address (e.g. your Kindle email).
+     */
+    to_email: string;
+};
+/**
+ * SeriesOut
+ */
+type SeriesOut = {
+    /**
+     * Index
+     */
+    index: number;
+    /**
+     * Name
+     */
+    name: string;
+};
+/**
+ * SortDirection
+ */
+type SortDirection = 'asc' | 'desc';
+/**
+ * SortField
+ *
+ * Fields a book listing can be sorted by.
+ */
+type SortField = 'title' | 'author' | 'pubdate' | 'timestamp' | 'last_modified' | 'series' | 'rating';
+/**
+ * TagOut
+ */
+type TagOut = {
+    /**
+     * Name
+     */
+    name: string;
+};
+/**
+ * ValidationError
+ */
+type ValidationError = {
+    /**
+     * Context
+     */
+    ctx?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Input
+     */
+    input?: unknown;
+    /**
+     * Location
+     */
+    loc: Array<string | number>;
+    /**
+     * Message
+     */
+    msg: string;
+    /**
+     * Error Type
+     */
+    type: string;
+};
+type ListBooksData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Page
+         */
+        page?: number;
+        /**
+         * Page Size
+         */
+        page_size?: number;
+        sort?: SortField;
+        direction?: SortDirection;
+    };
+    url: '/books';
+};
+type ListBooksErrors = {
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type ListBooksError = ListBooksErrors[keyof ListBooksErrors];
+type ListBooksResponses = {
+    /**
+     * Successful Response
+     */
+    200: BookPage;
+};
+type ListBooksResponse = ListBooksResponses[keyof ListBooksResponses];
+type UploadBookData = {
+    body: BodyUploadBook;
+    path?: never;
+    query?: never;
+    url: '/books';
+};
+type UploadBookErrors = {
+    /**
+     * Bad request
+     */
+    400: ErrorResponse;
+    /**
+     * Payload too large
+     */
+    413: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type UploadBookError = UploadBookErrors[keyof UploadBookErrors];
+type UploadBookResponses = {
+    /**
+     * Successful Response
+     */
+    201: BookOut;
+};
+type UploadBookResponse = UploadBookResponses[keyof UploadBookResponses];
+type DeleteBookData = {
+    body?: never;
+    path: {
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}';
+};
+type DeleteBookErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type DeleteBookError = DeleteBookErrors[keyof DeleteBookErrors];
+type DeleteBookResponses = {
+    /**
+     * Successful Response
+     */
+    204: void;
+};
+type DeleteBookResponse = DeleteBookResponses[keyof DeleteBookResponses];
+type GetBookData = {
+    body?: never;
+    path: {
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}';
+};
+type GetBookErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type GetBookError = GetBookErrors[keyof GetBookErrors];
+type GetBookResponses = {
+    /**
+     * Successful Response
+     */
+    200: BookOut;
+};
+type GetBookResponse = GetBookResponses[keyof GetBookResponses];
+type UpdateBookData = {
+    body: BookUpdate;
+    path: {
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}';
+};
+type UpdateBookErrors = {
+    /**
+     * Bad request
+     */
+    400: ErrorResponse;
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type UpdateBookError = UpdateBookErrors[keyof UpdateBookErrors];
+type UpdateBookResponses = {
+    /**
+     * Successful Response
+     */
+    200: BookOut;
+};
+type UpdateBookResponse = UpdateBookResponses[keyof UpdateBookResponses];
+type ConvertBookData = {
+    body: ConvertRequest;
+    path: {
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}/convert';
+};
+type ConvertBookErrors = {
+    /**
+     * Bad request
+     */
+    400: ErrorResponse;
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service unavailable
+     */
+    503: ErrorResponse;
+};
+type ConvertBookError = ConvertBookErrors[keyof ConvertBookErrors];
+type ConvertBookResponses = {
+    /**
+     * Successful Response
+     */
+    202: JobOut;
+};
+type ConvertBookResponse = ConvertBookResponses[keyof ConvertBookResponses];
+type GetBookCoverData = {
+    body?: never;
+    path: {
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}/cover';
+};
+type GetBookCoverErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type GetBookCoverError = GetBookCoverErrors[keyof GetBookCoverErrors];
+type GetBookCoverResponses = {
+    /**
+     * Successful Response
+     */
+    200: unknown;
+};
+type DeleteBookFormatData = {
+    body?: never;
+    path: {
+        /**
+         * Book Format
+         */
+        book_format: string;
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}/formats/{book_format}';
+};
+type DeleteBookFormatErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type DeleteBookFormatError = DeleteBookFormatErrors[keyof DeleteBookFormatErrors];
+type DeleteBookFormatResponses = {
+    /**
+     * Successful Response
+     */
+    204: void;
+};
+type DeleteBookFormatResponse = DeleteBookFormatResponses[keyof DeleteBookFormatResponses];
+type DownloadBookFormatData = {
+    body?: never;
+    path: {
+        /**
+         * Book Format
+         */
+        book_format: string;
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}/formats/{book_format}';
+};
+type DownloadBookFormatErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type DownloadBookFormatError = DownloadBookFormatErrors[keyof DownloadBookFormatErrors];
+type DownloadBookFormatResponses = {
+    /**
+     * Successful Response
+     */
+    200: unknown;
+};
+type RefreshMetadataData = {
+    body: RefreshRequest;
+    path: {
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}/refresh-metadata';
+};
+type RefreshMetadataErrors = {
+    /**
+     * Bad request
+     */
+    400: ErrorResponse;
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type RefreshMetadataError = RefreshMetadataErrors[keyof RefreshMetadataErrors];
+type RefreshMetadataResponses = {
+    /**
+     * Successful Response
+     */
+    200: BookOut;
+};
+type RefreshMetadataResponse = RefreshMetadataResponses[keyof RefreshMetadataResponses];
+type SendBookData = {
+    body: SendRequest;
+    path: {
+        /**
+         * Book Id
+         */
+        book_id: string;
+    };
+    query?: never;
+    url: '/books/{book_id}/send';
+};
+type SendBookErrors = {
+    /**
+     * Bad request
+     */
+    400: ErrorResponse;
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service unavailable
+     */
+    503: ErrorResponse;
+};
+type SendBookError = SendBookErrors[keyof SendBookErrors];
+type SendBookResponses = {
+    /**
+     * Successful Response
+     */
+    202: JobOut;
+};
+type SendBookResponse = SendBookResponses[keyof SendBookResponses];
+type GetEmailConfigData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/config/email';
+};
+type GetEmailConfigErrors = {
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type GetEmailConfigError = GetEmailConfigErrors[keyof GetEmailConfigErrors];
+type GetEmailConfigResponses = {
+    /**
+     * Successful Response
+     */
+    200: EmailConfigOut;
+};
+type GetEmailConfigResponse = GetEmailConfigResponses[keyof GetEmailConfigResponses];
+type TestEmailConfigData = {
+    body: EmailTestRequest;
+    path?: never;
+    query?: never;
+    url: '/config/email/test';
+};
+type TestEmailConfigErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service unavailable
+     */
+    503: ErrorResponse;
+};
+type TestEmailConfigError = TestEmailConfigErrors[keyof TestEmailConfigErrors];
+type TestEmailConfigResponses = {
+    /**
+     * Successful Response
+     */
+    204: void;
+};
+type TestEmailConfigResponse = TestEmailConfigResponses[keyof TestEmailConfigResponses];
+type StartExportData = {
+    body: ExportRequest;
+    path?: never;
+    query?: never;
+    url: '/export/calibre';
+};
+type StartExportErrors = {
+    /**
+     * Bad request
+     */
+    400: ErrorResponse;
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service unavailable
+     */
+    503: ErrorResponse;
+};
+type StartExportError = StartExportErrors[keyof StartExportErrors];
+type StartExportResponses = {
+    /**
+     * Successful Response
+     */
+    202: JobOut;
+};
+type StartExportResponse = StartExportResponses[keyof StartExportResponses];
+type DownloadExportData = {
+    body?: never;
+    path: {
+        /**
+         * Token
+         */
+        token: string;
+    };
+    query?: never;
+    url: '/export/download/{token}';
+};
+type DownloadExportErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type DownloadExportError = DownloadExportErrors[keyof DownloadExportErrors];
+type DownloadExportResponses = {
+    /**
+     * Successful Response
+     */
+    200: unknown;
+};
+type HealthData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/health';
+};
+type HealthErrors = {
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type HealthError = HealthErrors[keyof HealthErrors];
+type HealthResponses = {
+    /**
+     * Successful Response
+     */
+    200: HealthResponse;
+};
+type HealthResponse2 = HealthResponses[keyof HealthResponses];
+type GetJobData = {
+    body?: never;
+    path: {
+        /**
+         * Job Id
+         */
+        job_id: string;
+    };
+    query?: never;
+    url: '/jobs/{job_id}';
+};
+type GetJobErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type GetJobError = GetJobErrors[keyof GetJobErrors];
+type GetJobResponses = {
+    /**
+     * Successful Response
+     */
+    200: JobOut;
+};
+type GetJobResponse = GetJobResponses[keyof GetJobResponses];
+type StreamJobData = {
+    body?: never;
+    path: {
+        /**
+         * Job Id
+         */
+        job_id: string;
+    };
+    query?: never;
+    url: '/jobs/{job_id}/stream';
+};
+type StreamJobErrors = {
+    /**
+     * Resource not found
+     */
+    404: ErrorResponse;
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type StreamJobError = StreamJobErrors[keyof StreamJobErrors];
+type StreamJobResponses = {
+    /**
+     * Successful Response
+     */
+    200: unknown;
+};
+type SearchBooksData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Q
+         */
+        q?: string;
+        /**
+         * Page
+         */
+        page?: number;
+        /**
+         * Page Size
+         */
+        page_size?: number;
+        /**
+         * Include Tags
+         */
+        include_tags?: Array<string> | null;
+        /**
+         * Exclude Tags
+         */
+        exclude_tags?: Array<string> | null;
+        /**
+         * Languages
+         */
+        languages?: Array<string> | null;
+        /**
+         * Formats
+         */
+        formats?: Array<string> | null;
+        /**
+         * Rating Min
+         */
+        rating_min?: number | null;
+        /**
+         * Rating Max
+         */
+        rating_max?: number | null;
+    };
+    url: '/search';
+};
+type SearchBooksErrors = {
+    /**
+     * Validation error
+     */
+    422: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+};
+type SearchBooksError = SearchBooksErrors[keyof SearchBooksErrors];
+type SearchBooksResponses = {
+    /**
+     * Successful Response
+     */
+    200: BookPage;
+};
+type SearchBooksResponse = SearchBooksResponses[keyof SearchBooksResponses];
+
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+declare class HeyApiClient {
+    protected client: Client;
+    constructor(args?: {
+        client?: Client;
+    });
+}
+declare class HeyApiRegistry<T> {
+    private readonly defaultKey;
+    private readonly instances;
+    get(key?: string): T;
+    set(value: T, key?: string): void;
+}
+declare class Sdk extends HeyApiClient {
+    static readonly __registry: HeyApiRegistry<Sdk>;
+    constructor(args?: {
+        client?: Client;
+        key?: string;
+    });
+    /**
+     * List Books
+     *
+     * List books, paginated and sorted.
+     *
+     * Returns a page of books controlled by `page` and `page_size`, ordered by
+     * `sort` field in the given `direction`. Out-of-range pagination values are
+     * rejected with `422`.
+     */
+    listBooks<ThrowOnError extends boolean = false>(options?: Options<ListBooksData, ThrowOnError>): RequestResult<ListBooksResponses, ListBooksErrors, ThrowOnError>;
+    /**
+     * Upload Book
+     *
+     * Upload a book file and create a new book.
+     *
+     * Accepts a multipart `file` whose extension must be one of the allowed
+     * upload formats; metadata is extracted from the file on import. Returns the
+     * created book with `201`, `400` if the file is rejected (unsupported
+     * extension or unreadable content), or `413` if it exceeds the upload size
+     * limit.
+     */
+    uploadBook<ThrowOnError extends boolean = false>(options: Options<UploadBookData, ThrowOnError>): RequestResult<UploadBookResponses, UploadBookErrors, ThrowOnError>;
+    /**
+     * Delete Book
+     *
+     * Delete a book and all of its files.
+     *
+     * Removes the book identified by `book_id` along with its stored formats and
+     * cover, returning `204` with no body on success. Responds with `404` when the
+     * book does not exist.
+     */
+    deleteBook<ThrowOnError extends boolean = false>(options: Options<DeleteBookData, ThrowOnError>): RequestResult<DeleteBookResponses, DeleteBookErrors, ThrowOnError>;
+    /**
+     * Get Book
+     *
+     * Get a single book by its public id.
+     *
+     * Looks up the book identified by `book_id` (the book's public id) and returns
+     * its full metadata. Responds with `404` when no such book exists.
+     */
+    getBook<ThrowOnError extends boolean = false>(options: Options<GetBookData, ThrowOnError>): RequestResult<GetBookResponses, GetBookErrors, ThrowOnError>;
+    /**
+     * Update Book
+     *
+     * Partially update a book's metadata.
+     *
+     * Applies only the fields explicitly set in the request body, leaving omitted
+     * fields untouched, and returns the updated book. Responds with `400` when the
+     * patch is empty or violates a domain rule (e.g. an out-of-range `rating`),
+     * and `404` when the book does not exist.
+     */
+    updateBook<ThrowOnError extends boolean = false>(options: Options<UpdateBookData, ThrowOnError>): RequestResult<UpdateBookResponses, UpdateBookErrors, ThrowOnError>;
+    /**
+     * Convert Book
+     *
+     * Convert a book to another format.
+     *
+     * Enqueues a background conversion to `target_format`, optionally from an
+     * explicit `source_format` (otherwise the best available source is chosen), and
+     * returns `202` with a job to poll at `/jobs/{id}`. Responds with `404` if the
+     * book is missing, `503` if `ebook-convert` is unavailable, `409` if the target
+     * format already exists or an identical conversion is already in progress, and
+     * `400` if no suitable source format is available.
+     */
+    convertBook<ThrowOnError extends boolean = false>(options: Options<ConvertBookData, ThrowOnError>): RequestResult<ConvertBookResponses, ConvertBookErrors, ThrowOnError>;
+    /**
+     * Get Book Cover
+     *
+     * Download a book's cover image.
+     *
+     * Returns the cover bytes as `image/jpeg` for the book identified by
+     * `book_id`. Responds with `404` when the book has no recorded cover or the
+     * cover file is missing from storage.
+     */
+    getBookCover<ThrowOnError extends boolean = false>(options: Options<GetBookCoverData, ThrowOnError>): RequestResult<GetBookCoverResponses, GetBookCoverErrors, ThrowOnError>;
+    /**
+     * Delete Book Format
+     *
+     * Delete one format of a book.
+     *
+     * Removes the file for the given `book_format` of the book identified by
+     * `book_id`, returning `204` with no body on success. Responds with `404` when
+     * the book does not exist or it has no such format.
+     */
+    deleteBookFormat<ThrowOnError extends boolean = false>(options: Options<DeleteBookFormatData, ThrowOnError>): RequestResult<DeleteBookFormatResponses, DeleteBookFormatErrors, ThrowOnError>;
+    /**
+     * Download Book Format
+     *
+     * Download one format of a book.
+     *
+     * Returns the file for the given `book_format` of the book identified by
+     * `book_id` as an `application/octet-stream` attachment, with the stored
+     * filename in the `Content-Disposition` header. Responds with `404` when the
+     * book lacks that format or the file is missing from storage.
+     */
+    downloadBookFormat<ThrowOnError extends boolean = false>(options: Options<DownloadBookFormatData, ThrowOnError>): RequestResult<DownloadBookFormatResponses, DownloadBookFormatErrors, ThrowOnError>;
+    /**
+     * Refresh Metadata
+     *
+     * Re-extract metadata from a book file and return the updated book.
+     *
+     * Reads metadata afresh from the book's `source_format` file and merges it in:
+     * fields the extraction produced replace the current ones, fields it could not
+     * read are kept. Responds with `404` when the book or requested format is not
+     * found, and `400` for any other refresh failure.
+     */
+    refreshMetadata<ThrowOnError extends boolean = false>(options: Options<RefreshMetadataData, ThrowOnError>): RequestResult<RefreshMetadataResponses, RefreshMetadataErrors, ThrowOnError>;
+    /**
+     * Send Book
+     *
+     * Email a book to a recipient.
+     *
+     * Enqueues a background job to send the book to `to_email` in the requested
+     * `format` (or the best available sendable format if unspecified), and returns
+     * `202` with a job to poll at `/jobs/{id}`. Responds with `404` if the book is
+     * missing, `503` if SMTP is not configured, and `400` if the book has no
+     * matching or sendable format.
+     */
+    sendBook<ThrowOnError extends boolean = false>(options: Options<SendBookData, ThrowOnError>): RequestResult<SendBookResponses, SendBookErrors, ThrowOnError>;
+    /**
+     * Get Email Config
+     *
+     * Return the non-secret SMTP settings for display.
+     *
+     * Reports whether SMTP is `configured` along with `host`, `port`,
+     * `from_address` (falling back to the username when no explicit from is set)
+     * and `security`. The password is never read or returned.
+     */
+    getEmailConfig<ThrowOnError extends boolean = false>(options?: Options<GetEmailConfigData, ThrowOnError>): RequestResult<GetEmailConfigResponses, GetEmailConfigErrors, ThrowOnError>;
+    /**
+     * Test Email Config
+     *
+     * Send a test email to verify SMTP connectivity.
+     *
+     * Sends a test message to `to_email` and returns 204 on success. Responds 503
+     * if SMTP is not configured, or 502 if the connection, authentication or send
+     * fails.
+     */
+    testEmailConfig<ThrowOnError extends boolean = false>(options: Options<TestEmailConfigData, ThrowOnError>): RequestResult<TestEmailConfigResponses, TestEmailConfigErrors, ThrowOnError>;
+    /**
+     * Start Export
+     *
+     * Start an async Calibre export; the download link is emailed when ready.
+     *
+     * Enqueues a background job that snapshots the requested books (or the whole
+     * library when `book_ids` is omitted) to a zip and emails a time-limited link
+     * to `to_email`, returning 202 with the new job. Responds 503 when export is
+     * unavailable (the calibredb binary is missing, SMTP is not configured, or no
+     * public base URL is set for an absolute link), and 400 for a malformed book id.
+     */
+    startExport<ThrowOnError extends boolean = false>(options: Options<StartExportData, ThrowOnError>): RequestResult<StartExportResponses, StartExportErrors, ThrowOnError>;
+    /**
+     * Download Export
+     *
+     * Stream a finished export zip for a valid, unexpired token.
+     *
+     * Served via ``FileResponse``, which streams the file and honours HTTP Range
+     * requests, so a large download is memory-light and resumable.
+     */
+    downloadExport<ThrowOnError extends boolean = false>(options: Options<DownloadExportData, ThrowOnError>): RequestResult<DownloadExportResponses, DownloadExportErrors, ThrowOnError>;
+    /**
+     * Health
+     *
+     * Report liveness and the availability of optional dependencies.
+     *
+     * Always returns `status` ``"ok"`` and the API `version`, plus the
+     * Calibre binary availability (`convert_available`, `metadata_available`)
+     * and whether send-to-ereader is usable (`send_available`, true when SMTP
+     * is configured).
+     */
+    health<ThrowOnError extends boolean = false>(options?: Options<HealthData, ThrowOnError>): RequestResult<HealthResponses, HealthErrors, ThrowOnError>;
+    /**
+     * Get Job
+     *
+     * Return the current status and progress of a single job.
+     *
+     * Looks up the job by `job_id` and returns its latest state for one-shot
+     * polling. Responds 404 if no job with that id exists; use `/jobs/{job_id}/stream`
+     * instead to follow progress live.
+     */
+    getJob<ThrowOnError extends boolean = false>(options: Options<GetJobData, ThrowOnError>): RequestResult<GetJobResponses, GetJobErrors, ThrowOnError>;
+    /**
+     * Stream Job
+     *
+     * Stream a job's status/progress as Server-Sent Events until it finishes.
+     *
+     * One open connection replaces repeated polling. Updates are event-driven: the
+     * stream blocks (in a threadpool, so the event loop stays free) until the job
+     * actually changes, then emits — so it reflects each new binary output, not a
+     * fixed tick.
+     */
+    streamJob<ThrowOnError extends boolean = false>(options: Options<StreamJobData, ThrowOnError>): RequestResult<StreamJobResponses, StreamJobErrors, ThrowOnError>;
+    /**
+     * Search Books
+     *
+     * Search books by a text query and filters.
+     *
+     * Returns a paginated page of books whose title, author, series or tags match
+     * the query `q` (case-insensitive substring match), narrowed by the optional
+     * `include_tags`, `exclude_tags`, `languages`, `formats`, and
+     * `rating_min`/`rating_max` filters. Out-of-range pagination or rating values
+     * are rejected with `422`.
+     */
+    searchBooks<ThrowOnError extends boolean = false>(options?: Options<SearchBooksData, ThrowOnError>): RequestResult<SearchBooksResponses, SearchBooksErrors, ThrowOnError>;
+}
+
+export { type AuthorOut, type BinaryHealthOut, type BodyUploadBook, type BookOut, type BookPage, type BookUpdate, type ClientOptions, type ConvertBookData, type ConvertBookError, type ConvertBookErrors, type ConvertBookResponse, type ConvertBookResponses, type ConvertRequest, type DeleteBookData, type DeleteBookError, type DeleteBookErrors, type DeleteBookFormatData, type DeleteBookFormatError, type DeleteBookFormatErrors, type DeleteBookFormatResponse, type DeleteBookFormatResponses, type DeleteBookResponse, type DeleteBookResponses, type DownloadBookFormatData, type DownloadBookFormatError, type DownloadBookFormatErrors, type DownloadBookFormatResponses, type DownloadExportData, type DownloadExportError, type DownloadExportErrors, type DownloadExportResponses, type EmailConfigOut, type EmailTestRequest, type ErrorBody, type ErrorDetail, type ErrorResponse, type ExportRequest, type FormatOut, type GetBookCoverData, type GetBookCoverError, type GetBookCoverErrors, type GetBookCoverResponses, type GetBookData, type GetBookError, type GetBookErrors, type GetBookResponse, type GetBookResponses, type GetEmailConfigData, type GetEmailConfigError, type GetEmailConfigErrors, type GetEmailConfigResponse, type GetEmailConfigResponses, type GetJobData, type GetJobError, type GetJobErrors, type GetJobResponse, type GetJobResponses, type HealthData, type HealthError, type HealthErrors, type HealthResponse, type HealthResponse2, type HealthResponses, type HttpValidationError, type IdentifierOut, type JobOut, type JobStatusOut, type JobType, type ListBooksData, type ListBooksError, type ListBooksErrors, type ListBooksResponse, type ListBooksResponses, type Options, type RefreshMetadataData, type RefreshMetadataError, type RefreshMetadataErrors, type RefreshMetadataResponse, type RefreshMetadataResponses, type RefreshRequest, Sdk, type SearchBooksData, type SearchBooksError, type SearchBooksErrors, type SearchBooksResponse, type SearchBooksResponses, type SendBookData, type SendBookError, type SendBookErrors, type SendBookResponse, type SendBookResponses, type SendRequest, type SeriesOut, type SortDirection, type SortField, type StartExportData, type StartExportError, type StartExportErrors, type StartExportResponse, type StartExportResponses, type StreamJobData, type StreamJobError, type StreamJobErrors, type StreamJobResponses, type TagOut, type TestEmailConfigData, type TestEmailConfigError, type TestEmailConfigErrors, type TestEmailConfigResponse, type TestEmailConfigResponses, type UpdateBookData, type UpdateBookError, type UpdateBookErrors, type UpdateBookResponse, type UpdateBookResponses, type UploadBookData, type UploadBookError, type UploadBookErrors, type UploadBookResponse, type UploadBookResponses, type ValidationError };