paperus 0.0.0-stage → 0.0.8

package/dist/generated/sdk.gen.d.ts

@@ -0,0 +1,718 @@
+import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client/index.js';
+import type { AddItemData, AddItemErrors, AddItemResponses, AddItemsData, AddItemsErrors, AddItemsResponses, AddNotesData, AddNotesErrors, AddNotesResponses, AddTagData, AddTagErrors, AddTagResponses, AddVersionData, AddVersionErrors, AddVersionResponses, AuthenticationData, AuthenticationResponses, ChangeCollectionData, ChangeCollectionErrors, ChangeCollectionResponses, ChangeGroupData, ChangeGroupErrors, ChangeGroupResponses, ChangeNoteData, ChangeNoteErrors, ChangeNoteResponses, ChangePasswordData, ChangePasswordErrors, ChangePasswordResponses, ChangeTagData, ChangeTagErrors, ChangeTagResponses, ChangeUserData, ChangeUserErrors, ChangeUserResponses, CheckProviderData, CheckProviderErrors, CheckProviderResponses, CheckRestoreData, CheckRestoreErrors, CheckRestoreResponses, CreateCollectionData, CreateCollectionErrors, CreateCollectionResponses, CreateFirstAdminData, CreateFirstAdminErrors, CreateFirstAdminResponses, CreateGroupData, CreateGroupErrors, CreateGroupResponses, CreateNoteData, CreateNoteErrors, CreateNoteResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserData, CreateUserErrors, CreateUserResponses, DeleteBackupData, DeleteBackupErrors, DeleteBackupResponses, DeleteCollectionData, DeleteCollectionErrors, DeleteCollectionResponses, DeleteGroupData, DeleteGroupErrors, DeleteGroupResponses, DeleteMlModelData, DeleteMlModelErrors, DeleteMlModelResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DownloadFileData, DownloadFileErrors, DownloadFileResponses, EmptyTrashData, EmptyTrashResponses, EndAllSessionsData, EndAllSessionsResponses, ExportCitationsData, ExportCitationsErrors, ExportCitationsResponses, FindUploadData, FindUploadErrors, FindUploadResponses, FindUsersData, FindUsersErrors, FindUsersResponses, GetAvatarData, GetAvatarErrors, GetAvatarResponses, GetConfigData, GetConfigResponses, GetImportData, GetImportErrors, GetImportResponses, GetItemData, GetItemErrors, GetItemResponses, HandOverData, HandOverErrors, HandOverResponses, HealthData, HealthDbData, HealthDbResponses, HealthResponses, IntegrityReportData, IntegrityReportResponses, LeaveGroupData, LeaveGroupErrors, LeaveGroupResponses, LinkItemData, LinkItemErrors, LinkItemResponses, ListBackupsData, ListBackupsResponses, ListCollectionsData, ListCollectionsResponses, ListDuplicatesData, ListDuplicatesErrors, ListDuplicatesEverywhereData, ListDuplicatesEverywhereResponses, ListDuplicatesResponses, ListGroupsData, ListGroupsResponses, ListImportsData, ListImportsResponses, ListItemsData, ListItemsErrors, ListItemsResponses, ListLibrariesData, ListLibrariesResponses, ListMembersData, ListMembersErrors, ListMembersResponses, ListNotesData, ListNotesErrors, ListNotesResponses, ListTagsData, ListTagsResponses, ListTokensData, ListTokensResponses, ListUsersData, ListUsersResponses, LoginData, LoginErrors, LoginMethodsData, LoginMethodsResponses, LoginResponses, LogoutData, LogoutResponses, MarkDifferentData, MarkDifferentErrors, MarkDifferentResponses, MarkHintSeenData, MarkHintSeenErrors, MarkHintSeenResponses, MarkViewedData, MarkViewedErrors, MarkViewedResponses, MeasureMlSpeedData, MeasureMlSpeedErrors, MeasureMlSpeedResponses, MeData, MeResponses, MergeItemData, MergeItemErrors, MergeItemResponses, MlStatusData, MlStatusResponses, NoteHistoryData, NoteHistoryErrors, NoteHistoryResponses, NoteMarkdownData, NoteMarkdownErrors, NoteMarkdownResponses, OidcCallbackData, OidcCallbackErrors, OidcCallbackResponses, OidcStartData, OidcStartErrors, OidcStartResponses, PinCollectionData, PinCollectionErrors, PinCollectionResponses, PinVersionData, PinVersionErrors, PinVersionResponses, PreviewMergeData, PreviewMergeErrors, PreviewMergeResponses, PreviewMoveData, PreviewMoveErrors, PreviewMoveResponses, PreviewTemplateData, PreviewTemplateErrors, PreviewTemplateResponses, PrivateThingsData, PrivateThingsErrors, PrivateThingsResponses, ReadableCopyData, ReadableCopyResponses, ReadNoteData, ReadNoteErrors, ReadNoteResponses, RemoveAvatarData, RemoveAvatarResponses, RemoveItemData, RemoveItemErrors, RemoveItemResponses, RemoveMemberData, RemoveMemberErrors, RemoveMemberResponses, RemoveNoteData, RemoveNoteErrors, RemoveNoteResponses, RemoveTagData, RemoveTagErrors, RemoveTagResponses, RestoreFileData, RestoreFileErrors, RestoreFileResponses, RestoreItemData, RestoreItemErrors, RestoreItemResponses, RestoreNoteData, RestoreNoteErrors, RestoreNoteResponses, RestoreOnFirstStartData, RestoreOnFirstStartErrors, RestoreOnFirstStartResponses, RevokeTokenData, RevokeTokenErrors, RevokeTokenResponses, RunJobData, RunJobErrors, RunJobResponses, SearchData, SearchErrors, SearchResponses, SetAvatarData, SetAvatarErrors, SetAvatarResponses, SetBackupConfigData, SetBackupConfigErrors, SetBackupConfigResponses, SetConfigData, SetConfigErrors, SetConfigResponses, SetDefaultLibraryData, SetDefaultLibraryErrors, SetDefaultLibraryResponses, SetMemberData, SetMemberErrors, SetMemberResponses, SetNoteOwnerData, SetNoteOwnerErrors, SetNoteOwnerResponses, SetOidcSecretData, SetOidcSecretErrors, SetOidcSecretResponses, SetOverridesData, SetOverridesErrors, SetOverridesResponses, SetOwnerData, SetOwnerErrors, SetOwnerResponses, SetupStateData, SetupStateResponses, StarItemData, StarItemErrors, StarItemResponses, StartBackupData, StartBackupErrors, StartBackupResponses, StartImportData, StartImportErrors, StartImportResponses, StatsData, StatsResponses, StorageData, StorageResponses, TrashFileData, TrashFileErrors, TrashFileResponses, TrashItemData, TrashItemErrors, TrashItemResponses, TrashNoteData, TrashNoteErrors, TrashNoteResponses, UnlinkItemData, UnlinkItemErrors, UnlinkItemResponses, UnlinkOidcData, UnlinkOidcResponses, UnpinCollectionData, UnpinCollectionErrors, UnpinCollectionResponses, UnstarItemData, UnstarItemErrors, UnstarItemResponses, UploadNewItemData, UploadNewItemErrors, UploadNewItemResponses, UploadToItemData, UploadToItemErrors, UploadToItemResponses, UploadToVersionData, UploadToVersionErrors, UploadToVersionResponses } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<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;
+};
+/**
+ * Health
+ */
+export declare const health: <ThrowOnError extends boolean = false>(options?: Options<HealthData, ThrowOnError>) => RequestResult<HealthResponses, unknown, ThrowOnError>;
+/**
+ * Health Db
+ */
+export declare const healthDb: <ThrowOnError extends boolean = false>(options?: Options<HealthDbData, ThrowOnError>) => RequestResult<HealthDbResponses, unknown, ThrowOnError>;
+/**
+ * Login
+ */
+export declare const login: <ThrowOnError extends boolean = false>(options: Options<LoginData, ThrowOnError>) => RequestResult<LoginResponses, LoginErrors, ThrowOnError>;
+/**
+ * Login Methods
+ *
+ * How one may log in (for the login page).
+ */
+export declare const loginMethods: <ThrowOnError extends boolean = false>(options?: Options<LoginMethodsData, ThrowOnError>) => RequestResult<LoginMethodsResponses, unknown, ThrowOnError>;
+/**
+ * Oidc Start
+ *
+ * Off to the identity provider; it sends the browser back to
+ * ``/api/auth/oidc/callback``. With ``link``, the OIDC login is
+ * linked to the account logged in now instead (whatever its name).
+ */
+export declare const oidcStart: <ThrowOnError extends boolean = false>(options?: Options<OidcStartData, ThrowOnError>) => RequestResult<OidcStartResponses, OidcStartErrors, ThrowOnError>;
+/**
+ * Oidc Callback
+ *
+ * Back from the identity provider: log the person in.
+ */
+export declare const oidcCallback: <ThrowOnError extends boolean = false>(options?: Options<OidcCallbackData, ThrowOnError>) => RequestResult<OidcCallbackResponses, OidcCallbackErrors, ThrowOnError>;
+/**
+ * Unlink Oidc
+ *
+ * Unlink one's account from the OIDC login (the password stays).
+ */
+export declare const unlinkOidc: <ThrowOnError extends boolean = false>(options?: Options<UnlinkOidcData, ThrowOnError>) => RequestResult<UnlinkOidcResponses, unknown, ThrowOnError>;
+/**
+ * Logout
+ */
+export declare const logout: <ThrowOnError extends boolean = false>(options?: Options<LogoutData, ThrowOnError>) => RequestResult<LogoutResponses, unknown, ThrowOnError>;
+/**
+ * Me
+ */
+export declare const me: <ThrowOnError extends boolean = false>(options?: Options<MeData, ThrowOnError>) => RequestResult<MeResponses, unknown, ThrowOnError>;
+/**
+ * Change Password
+ *
+ * Change one's password (the current one is needed); other devices are
+ * logged out, this one stays logged in.
+ */
+export declare const changePassword: <ThrowOnError extends boolean = false>(options: Options<ChangePasswordData, ThrowOnError>) => RequestResult<ChangePasswordResponses, ChangePasswordErrors, ThrowOnError>;
+/**
+ * Mark Hint Seen
+ *
+ * Remember that the person has seen a tutorial hint.
+ */
+export declare const markHintSeen: <ThrowOnError extends boolean = false>(options: Options<MarkHintSeenData, ThrowOnError>) => RequestResult<MarkHintSeenResponses, MarkHintSeenErrors, ThrowOnError>;
+/**
+ * Remove Avatar
+ */
+export declare const removeAvatar: <ThrowOnError extends boolean = false>(options?: Options<RemoveAvatarData, ThrowOnError>) => RequestResult<RemoveAvatarResponses, unknown, ThrowOnError>;
+/**
+ * Set Avatar
+ *
+ * One's profile picture: PNG, JPEG or WebP, up to 256 KB (the website
+ * sends it square, 256 pixels wide).
+ */
+export declare const setAvatar: <ThrowOnError extends boolean = false>(options: Options<SetAvatarData, ThrowOnError>) => RequestResult<SetAvatarResponses, SetAvatarErrors, ThrowOnError>;
+/**
+ * Get Avatar
+ *
+ * A person's profile picture (404 without one). Its address carries
+ * the picture's version, so it may be kept for long.
+ */
+export declare const getAvatar: <ThrowOnError extends boolean = false>(options: Options<GetAvatarData, ThrowOnError>) => RequestResult<GetAvatarResponses, GetAvatarErrors, ThrowOnError>;
+/**
+ * List Items
+ *
+ * Items the person can read, newest first; ``before`` = last ``id`` for
+ * the next page. ``library`` shows one library only. ``sort=recent``:
+ * by the latest of the item's last change and the reader's last opening,
+ * newest first, paged with ``offset`` instead of ``before``;
+ * ``sort=opened``: only items the reader opened, by when.
+ *
+ * ``trashed=true`` lists the trash instead. ``unsorted=true``: only papers
+ * with a PDF whose details could not be found (all guessed from the file;
+ * papers still being read, and notes or other files without a DOI to
+ * find, are left out). ``tag`` (repeatable: items
+ * with all of them) and ``collection`` (with its subcollections unless
+ * ``nested=false``) filter the list, and ``title`` to items with all of its
+ * words in their title (any case). ``X-Total-Count`` is the number of
+ * matching items, for showing the total while paging.
+ * ``since=N`` is for syncing:
+ * every item changed after change number N, trashed or not, in change
+ * order; ``limit`` and ``before`` do not apply. The ``Last-Change`` header
+ * is the number to pass as ``since`` next time.
+ */
+export declare const listItems: <ThrowOnError extends boolean = false>(options?: Options<ListItemsData, ThrowOnError>) => RequestResult<ListItemsResponses, ListItemsErrors, ThrowOnError>;
+/**
+ * Add Item
+ *
+ * A new item; if one of its identifiers is known among the items the
+ * person can see, the existing item (200).
+ */
+export declare const addItem: <ThrowOnError extends boolean = false>(options: Options<AddItemData, ThrowOnError>) => RequestResult<AddItemResponses, AddItemErrors, ThrowOnError>;
+/**
+ * Add Version
+ *
+ * Another version of an item, e.g. the published one of a preprint.
+ */
+export declare const addVersion: <ThrowOnError extends boolean = false>(options: Options<AddVersionData, ThrowOnError>) => RequestResult<AddVersionResponses, AddVersionErrors, ThrowOnError>;
+/**
+ * Pin Version
+ *
+ * Cite this version, whatever its kind.
+ */
+export declare const pinVersion: <ThrowOnError extends boolean = false>(options: Options<PinVersionData, ThrowOnError>) => RequestResult<PinVersionResponses, PinVersionErrors, ThrowOnError>;
+/**
+ * Set Overrides
+ *
+ * Replace the manual edits to the metadata for citing.
+ *
+ * Fields set here win over every version's metadata and survive new
+ * lookups; ``null`` hides a field. Needs ``If-Match`` with the ETag from the
+ * last read, so concurrent edits are not lost (412 if the item changed).
+ */
+export declare const setOverrides: <ThrowOnError extends boolean = false>(options: Options<SetOverridesData, ThrowOnError>) => RequestResult<SetOverridesResponses, SetOverridesErrors, ThrowOnError>;
+/**
+ * Trash Item
+ *
+ * Move to the trash; restorable with ``POST …/restore``.
+ */
+export declare const trashItem: <ThrowOnError extends boolean = false>(options: Options<TrashItemData, ThrowOnError>) => RequestResult<TrashItemResponses, TrashItemErrors, ThrowOnError>;
+/**
+ * Get Item
+ */
+export declare const getItem: <ThrowOnError extends boolean = false>(options: Options<GetItemData, ThrowOnError>) => RequestResult<GetItemResponses, GetItemErrors, ThrowOnError>;
+/**
+ * Set Owner
+ *
+ * Give the item to another owner the person may add to: share it with a
+ * group, or take a group's paper for oneself (members may delete it
+ * anyway). Tags and collections of the group that gave it up come off.
+ */
+export declare const setOwner: <ThrowOnError extends boolean = false>(options: Options<SetOwnerData, ThrowOnError>) => RequestResult<SetOwnerResponses, SetOwnerErrors, ThrowOnError>;
+/**
+ * Restore Item
+ */
+export declare const restoreItem: <ThrowOnError extends boolean = false>(options: Options<RestoreItemData, ThrowOnError>) => RequestResult<RestoreItemResponses, RestoreItemErrors, ThrowOnError>;
+/**
+ * Unstar Item
+ */
+export declare const unstarItem: <ThrowOnError extends boolean = false>(options: Options<UnstarItemData, ThrowOnError>) => RequestResult<UnstarItemResponses, UnstarItemErrors, ThrowOnError>;
+/**
+ * Star Item
+ *
+ * Star the paper (for the person only; any paper they can see).
+ */
+export declare const starItem: <ThrowOnError extends boolean = false>(options: Options<StarItemData, ThrowOnError>) => RequestResult<StarItemResponses, StarItemErrors, ThrowOnError>;
+/**
+ * Mark Viewed
+ *
+ * Remember that the person opened the item (for their recent papers).
+ */
+export declare const markViewed: <ThrowOnError extends boolean = false>(options: Options<MarkViewedData, ThrowOnError>) => RequestResult<MarkViewedResponses, MarkViewedErrors, ThrowOnError>;
+/**
+ * List Duplicates
+ *
+ * Papers the person can see that share an identifier or a file with
+ * this one: candidates for merging.
+ */
+export declare const listDuplicates: <ThrowOnError extends boolean = false>(options: Options<ListDuplicatesData, ThrowOnError>) => RequestResult<ListDuplicatesResponses, ListDuplicatesErrors, ThrowOnError>;
+/**
+ * Preview Merge
+ *
+ * What merging this paper into ``into`` would move and leave behind.
+ */
+export declare const previewMerge: <ThrowOnError extends boolean = false>(options: Options<PreviewMergeData, ThrowOnError>) => RequestResult<PreviewMergeResponses, PreviewMergeErrors, ThrowOnError>;
+/**
+ * Merge Item
+ *
+ * Merge this paper into another one (the same paper twice). Needs the
+ * right to change this one; what may move to the other depends on the
+ * person's rights there (see docs/permissions.md).
+ */
+export declare const mergeItem: <ThrowOnError extends boolean = false>(options: Options<MergeItemData, ThrowOnError>) => RequestResult<MergeItemResponses, MergeItemErrors, ThrowOnError>;
+/**
+ * Find Upload
+ *
+ * The item in a library the person can read that already has a file
+ * with this SHA-256 (hex), so a client can skip uploading it again; 404 if
+ * there is none.
+ */
+export declare const findUpload: <ThrowOnError extends boolean = false>(options: Options<FindUploadData, ThrowOnError>) => RequestResult<FindUploadResponses, FindUploadErrors, ThrowOnError>;
+/**
+ * Upload New Item
+ *
+ * A new item from a file, titled after the file until its text tells more.
+ *
+ * The background job looks for a DOI or arXiv ID in the file and replaces
+ * the placeholder metadata (see ``paperus.identify``). A file that is
+ * already in a library the person can read makes no new item: the answer
+ * (200, ``existing``) names the item that has it. ``library_id`` (the
+ * owner): the person's default if not given.
+ */
+export declare const uploadNewItem: <ThrowOnError extends boolean = false>(options: Options<UploadNewItemData, ThrowOnError>) => RequestResult<UploadNewItemResponses, UploadNewItemErrors, ThrowOnError>;
+/**
+ * Upload To Version
+ */
+export declare const uploadToVersion: <ThrowOnError extends boolean = false>(options: Options<UploadToVersionData, ThrowOnError>) => RequestResult<UploadToVersionResponses, UploadToVersionErrors, ThrowOnError>;
+/**
+ * Upload To Item
+ *
+ * Upload to the item's preferred version.
+ */
+export declare const uploadToItem: <ThrowOnError extends boolean = false>(options: Options<UploadToItemData, ThrowOnError>) => RequestResult<UploadToItemResponses, UploadToItemErrors, ThrowOnError>;
+/**
+ * Download File
+ */
+export declare const downloadFile: <ThrowOnError extends boolean = false>(options: Options<DownloadFileData, ThrowOnError>) => RequestResult<DownloadFileResponses, DownloadFileErrors, ThrowOnError>;
+/**
+ * Trash File
+ *
+ * Move to the trash; restorable with ``POST …/restore``.
+ */
+export declare const trashFile: <ThrowOnError extends boolean = false>(options: Options<TrashFileData, ThrowOnError>) => RequestResult<TrashFileResponses, TrashFileErrors, ThrowOnError>;
+/**
+ * Restore File
+ */
+export declare const restoreFile: <ThrowOnError extends boolean = false>(options: Options<RestoreFileData, ThrowOnError>) => RequestResult<RestoreFileResponses, RestoreFileErrors, ThrowOnError>;
+/**
+ * Search
+ *
+ * Passages for ``q`` in the libraries the person can read (or one
+ * ``library``): its words (quotes for phrases, ``-`` to exclude), its
+ * meaning, or both; ``type`` (repeatable, CSL types) limits the items.
+ * ``per_item`` keeps the best few per paper or note, so more papers fit;
+ * ``item`` searches within one paper. The ``X-Search-Mode`` header says
+ * what was used: without the ML service, hybrid search falls back to
+ * keywords.
+ */
+export declare const search: <ThrowOnError extends boolean = false>(options: Options<SearchData, ThrowOnError>) => RequestResult<SearchResponses, SearchErrors, ThrowOnError>;
+/**
+ * Export Citations
+ *
+ * Citations for the given papers (``item``, repeatable), a collection
+ * (with its subcollections unless ``nested=false``) or, with neither,
+ * everything the person can read. ``download=true`` offers it as a file
+ * (``.bib`` or ``.json``).
+ */
+export declare const exportCitations: <ThrowOnError extends boolean = false>(options?: Options<ExportCitationsData, ThrowOnError>) => RequestResult<ExportCitationsResponses, ExportCitationsErrors, ThrowOnError>;
+/**
+ * List Notes
+ *
+ * Notes the person can read, last changed first: all of them, those
+ * about a paper (``item``) or in a collection (with its subcollections
+ * unless ``nested=false``); ``trashed=true`` lists the trash instead.
+ * ``X-Total-Count`` is the number of matching notes.
+ */
+export declare const listNotes: <ThrowOnError extends boolean = false>(options?: Options<ListNotesData, ThrowOnError>) => RequestResult<ListNotesResponses, ListNotesErrors, ThrowOnError>;
+/**
+ * Create Note
+ *
+ * A new note for the given owner (or the person's default owner), about
+ * the given papers, optionally put into a collection.
+ */
+export declare const createNote: <ThrowOnError extends boolean = false>(options: Options<CreateNoteData, ThrowOnError>) => RequestResult<CreateNoteResponses, CreateNoteErrors, ThrowOnError>;
+/**
+ * Trash Note
+ */
+export declare const trashNote: <ThrowOnError extends boolean = false>(options: Options<TrashNoteData, ThrowOnError>) => RequestResult<TrashNoteResponses, TrashNoteErrors, ThrowOnError>;
+/**
+ * Read Note
+ *
+ * The note with its text; the ``ETag`` goes into ``If-Match`` when saving.
+ */
+export declare const readNote: <ThrowOnError extends boolean = false>(options: Options<ReadNoteData, ThrowOnError>) => RequestResult<ReadNoteResponses, ReadNoteErrors, ThrowOnError>;
+/**
+ * Change Note
+ *
+ * Save the text. Needs ``If-Match`` with the ETag the editor started
+ * from: 412 if someone else saved in between (then reload and merge).
+ */
+export declare const changeNote: <ThrowOnError extends boolean = false>(options: Options<ChangeNoteData, ThrowOnError>) => RequestResult<ChangeNoteResponses, ChangeNoteErrors, ThrowOnError>;
+/**
+ * Unlink Item
+ */
+export declare const unlinkItem: <ThrowOnError extends boolean = false>(options: Options<UnlinkItemData, ThrowOnError>) => RequestResult<UnlinkItemResponses, UnlinkItemErrors, ThrowOnError>;
+/**
+ * Link Item
+ *
+ * Say the note is about the paper (at a page); changes the page if it
+ * is linked already.
+ */
+export declare const linkItem: <ThrowOnError extends boolean = false>(options: Options<LinkItemData, ThrowOnError>) => RequestResult<LinkItemResponses, LinkItemErrors, ThrowOnError>;
+/**
+ * Set Note Owner
+ *
+ * Give the note to another owner the person may add to. Collections of a
+ * group that no longer owns it let it go.
+ */
+export declare const setNoteOwner: <ThrowOnError extends boolean = false>(options: Options<SetNoteOwnerData, ThrowOnError>) => RequestResult<SetNoteOwnerResponses, SetNoteOwnerErrors, ThrowOnError>;
+/**
+ * Restore Note
+ */
+export declare const restoreNote: <ThrowOnError extends boolean = false>(options: Options<RestoreNoteData, ThrowOnError>) => RequestResult<RestoreNoteResponses, RestoreNoteErrors, ThrowOnError>;
+/**
+ * Note History
+ *
+ * Earlier texts of the note, newest first.
+ */
+export declare const noteHistory: <ThrowOnError extends boolean = false>(options: Options<NoteHistoryData, ThrowOnError>) => RequestResult<NoteHistoryResponses, NoteHistoryErrors, ThrowOnError>;
+/**
+ * Note Markdown
+ *
+ * The note as a Markdown file.
+ */
+export declare const noteMarkdown: <ThrowOnError extends boolean = false>(options: Options<NoteMarkdownData, ThrowOnError>) => RequestResult<NoteMarkdownResponses, NoteMarkdownErrors, ThrowOnError>;
+/**
+ * Add Notes
+ *
+ * Put notes into a collection; those it may not hold (a group's
+ * collection holds only the group's notes) or unknown ones are skipped.
+ */
+export declare const addNotes: <ThrowOnError extends boolean = false>(options: Options<AddNotesData, ThrowOnError>) => RequestResult<AddNotesResponses, AddNotesErrors, ThrowOnError>;
+/**
+ * Remove Note
+ */
+export declare const removeNote: <ThrowOnError extends boolean = false>(options: Options<RemoveNoteData, ThrowOnError>) => RequestResult<RemoveNoteResponses, RemoveNoteErrors, ThrowOnError>;
+/**
+ * List Imports
+ *
+ * The person's imports, newest first.
+ */
+export declare const listImports: <ThrowOnError extends boolean = false>(options?: Options<ListImportsData, ThrowOnError>) => RequestResult<ListImportsResponses, unknown, ThrowOnError>;
+/**
+ * Start Import
+ *
+ * Import an export: BibTeX, RIS or CSL-JSON, alone or zipped with its
+ * files. Everything new belongs to ``library_id`` (default: the person's
+ * default owner). Runs in the background; poll ``GET /api/imports/{id}``.
+ */
+export declare const startImport: <ThrowOnError extends boolean = false>(options: Options<StartImportData, ThrowOnError>) => RequestResult<StartImportResponses, StartImportErrors, ThrowOnError>;
+/**
+ * Get Import
+ */
+export declare const getImport: <ThrowOnError extends boolean = false>(options: Options<GetImportData, ThrowOnError>) => RequestResult<GetImportResponses, GetImportErrors, ThrowOnError>;
+/**
+ * List Duplicates Everywhere
+ *
+ * Pairs of papers that look like the same paper (same identifier or
+ * file first, then the same title), with a recommendation which to keep;
+ * pairs marked as different are left out.
+ */
+export declare const listDuplicatesEverywhere: <ThrowOnError extends boolean = false>(options?: Options<ListDuplicatesEverywhereData, ThrowOnError>) => RequestResult<ListDuplicatesEverywhereResponses, unknown, ThrowOnError>;
+/**
+ * Mark Different
+ *
+ * The two are different papers: do not suggest them again (for everyone
+ * who sees both). Needs the right to change at least one of them.
+ */
+export declare const markDifferent: <ThrowOnError extends boolean = false>(options: Options<MarkDifferentData, ThrowOnError>) => RequestResult<MarkDifferentResponses, MarkDifferentErrors, ThrowOnError>;
+/**
+ * Empty Trash
+ *
+ * Delete for good everything in the trash the person may change: their
+ * own and that of groups where they are a member or admin.
+ */
+export declare const emptyTrash: <ThrowOnError extends boolean = false>(options?: Options<EmptyTrashData, ThrowOnError>) => RequestResult<EmptyTrashResponses, unknown, ThrowOnError>;
+/**
+ * Storage
+ *
+ * How full the storage is (for the bar at the bottom of the menu).
+ */
+export declare const storage: <ThrowOnError extends boolean = false>(options?: Options<StorageData, ThrowOnError>) => RequestResult<StorageResponses, unknown, ThrowOnError>;
+/**
+ * Get Config
+ */
+export declare const getConfig: <ThrowOnError extends boolean = false>(options?: Options<GetConfigData, ThrowOnError>) => RequestResult<GetConfigResponses, unknown, ThrowOnError>;
+/**
+ * Set Config
+ *
+ * Save settings. A new embedding model must be one the ML service
+ * offers; the library is then re-embedded in the background, while keyword
+ * search keeps working and search by meaning covers more and more.
+ */
+export declare const setConfig: <ThrowOnError extends boolean = false>(options: Options<SetConfigData, ThrowOnError>) => RequestResult<SetConfigResponses, SetConfigErrors, ThrowOnError>;
+/**
+ * Ml Status
+ */
+export declare const mlStatus: <ThrowOnError extends boolean = false>(options?: Options<MlStatusData, ThrowOnError>) => RequestResult<MlStatusResponses, unknown, ThrowOnError>;
+/**
+ * Measure Ml Speed
+ *
+ * Time a model on this installation's ML service with sample passages.
+ * A model not downloaded yet starts downloading: the answer then says
+ * ``loading``; ask again in a while.
+ */
+export declare const measureMlSpeed: <ThrowOnError extends boolean = false>(options: Options<MeasureMlSpeedData, ThrowOnError>) => RequestResult<MeasureMlSpeedResponses, MeasureMlSpeedErrors, ThrowOnError>;
+/**
+ * Delete Ml Model
+ *
+ * Remove a downloaded model from the ML service (not the one in use).
+ */
+export declare const deleteMlModel: <ThrowOnError extends boolean = false>(options: Options<DeleteMlModelData, ThrowOnError>) => RequestResult<DeleteMlModelResponses, DeleteMlModelErrors, ThrowOnError>;
+/**
+ * Stats
+ */
+export declare const stats: <ThrowOnError extends boolean = false>(options?: Options<StatsData, ThrowOnError>) => RequestResult<StatsResponses, unknown, ThrowOnError>;
+/**
+ * Run Job
+ *
+ * Start a sweep now: ``embeddings`` (embed what is missing), ``text``
+ * (read files still pending), ``text-all`` (read every file again),
+ * ``trash`` (delete what is older than the trash days), ``integrity``
+ * (check stored contents), ``integrity-deep`` (also their SHA-256) or
+ * ``integrity-clean`` (check and remove unused stored contents), ``copy``
+ * (update the readable copy) or ``copy-remove`` (delete it).
+ */
+export declare const runJob: <ThrowOnError extends boolean = false>(options: Options<RunJobData, ThrowOnError>) => RequestResult<RunJobResponses, RunJobErrors, ThrowOnError>;
+/**
+ * Integrity Report
+ *
+ * The last integrity check's report (None before the first).
+ */
+export declare const integrityReport: <ThrowOnError extends boolean = false>(options?: Options<IntegrityReportData, ThrowOnError>) => RequestResult<IntegrityReportResponses, unknown, ThrowOnError>;
+/**
+ * Authentication
+ *
+ * What the Authentication settings show besides the settings.
+ */
+export declare const authentication: <ThrowOnError extends boolean = false>(options?: Options<AuthenticationData, ThrowOnError>) => RequestResult<AuthenticationResponses, unknown, ThrowOnError>;
+/**
+ * Set Oidc Secret
+ *
+ * The OIDC login's client secret; never sent back.
+ */
+export declare const setOidcSecret: <ThrowOnError extends boolean = false>(options: Options<SetOidcSecretData, ThrowOnError>) => RequestResult<SetOidcSecretResponses, SetOidcSecretErrors, ThrowOnError>;
+/**
+ * Check Provider
+ *
+ * Whether the identity provider answers at this address.
+ */
+export declare const checkProvider: <ThrowOnError extends boolean = false>(options: Options<CheckProviderData, ThrowOnError>) => RequestResult<CheckProviderResponses, CheckProviderErrors, ThrowOnError>;
+/**
+ * End All Sessions
+ *
+ * Log everyone out on every device, except this one.
+ */
+export declare const endAllSessions: <ThrowOnError extends boolean = false>(options?: Options<EndAllSessionsData, ThrowOnError>) => RequestResult<EndAllSessionsResponses, unknown, ThrowOnError>;
+/**
+ * Readable Copy
+ */
+export declare const readableCopy: <ThrowOnError extends boolean = false>(options?: Options<ReadableCopyData, ThrowOnError>) => RequestResult<ReadableCopyResponses, unknown, ThrowOnError>;
+/**
+ * Preview Template
+ */
+export declare const previewTemplate: <ThrowOnError extends boolean = false>(options: Options<PreviewTemplateData, ThrowOnError>) => RequestResult<PreviewTemplateResponses, PreviewTemplateErrors, ThrowOnError>;
+/**
+ * List Tags
+ *
+ * The tags of the libraries the person can read, with how they are used
+ * (items in the trash do not count).
+ */
+export declare const listTags: <ThrowOnError extends boolean = false>(options?: Options<ListTagsData, ThrowOnError>) => RequestResult<ListTagsResponses, unknown, ThrowOnError>;
+/**
+ * Create Tag
+ *
+ * A tag not on any item yet (409 if the library has one of that name).
+ */
+export declare const createTag: <ThrowOnError extends boolean = false>(options: Options<CreateTagData, ThrowOnError>) => RequestResult<CreateTagResponses, CreateTagErrors, ThrowOnError>;
+/**
+ * Add Tag
+ *
+ * Tag an item with its owner's, the person's or one of their groups' tag
+ * (see ``Access.may_tag``); the tag is created if that owner has none of
+ * that name (any case), which for a group needs member rights there.
+ */
+export declare const addTag: <ThrowOnError extends boolean = false>(options: Options<AddTagData, ThrowOnError>) => RequestResult<AddTagResponses, AddTagErrors, ThrowOnError>;
+/**
+ * Remove Tag
+ */
+export declare const removeTag: <ThrowOnError extends boolean = false>(options: Options<RemoveTagData, ThrowOnError>) => RequestResult<RemoveTagResponses, RemoveTagErrors, ThrowOnError>;
+/**
+ * Delete Tag
+ *
+ * Remove a tag from every item and delete it.
+ */
+export declare const deleteTag: <ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>) => RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError>;
+/**
+ * Change Tag
+ *
+ * Rename a tag everywhere (409 if another tag of its owner has that
+ * name), set its colour or description, or give it to another owner.
+ */
+export declare const changeTag: <ThrowOnError extends boolean = false>(options: Options<ChangeTagData, ThrowOnError>) => RequestResult<ChangeTagResponses, ChangeTagErrors, ThrowOnError>;
+/**
+ * List Collections
+ *
+ * The collections of the libraries the person can read, flat;
+ * ``parent_id`` gives the tree.
+ */
+export declare const listCollections: <ThrowOnError extends boolean = false>(options?: Options<ListCollectionsData, ThrowOnError>) => RequestResult<ListCollectionsResponses, unknown, ThrowOnError>;
+/**
+ * Create Collection
+ */
+export declare const createCollection: <ThrowOnError extends boolean = false>(options: Options<CreateCollectionData, ThrowOnError>) => RequestResult<CreateCollectionResponses, CreateCollectionErrors, ThrowOnError>;
+/**
+ * Delete Collection
+ *
+ * Delete a collection and its subcollections; items stay in the library.
+ */
+export declare const deleteCollection: <ThrowOnError extends boolean = false>(options: Options<DeleteCollectionData, ThrowOnError>) => RequestResult<DeleteCollectionResponses, DeleteCollectionErrors, ThrowOnError>;
+/**
+ * Change Collection
+ *
+ * Rename, describe or move a collection (not into itself), also into
+ * another library the person may change.
+ */
+export declare const changeCollection: <ThrowOnError extends boolean = false>(options: Options<ChangeCollectionData, ThrowOnError>) => RequestResult<ChangeCollectionResponses, ChangeCollectionErrors, ThrowOnError>;
+/**
+ * Preview Move
+ *
+ * Before moving a collection into another library: how many of its
+ * papers are not in that library yet.
+ */
+export declare const previewMove: <ThrowOnError extends boolean = false>(options: Options<PreviewMoveData, ThrowOnError>) => RequestResult<PreviewMoveResponses, PreviewMoveErrors, ThrowOnError>;
+/**
+ * Unpin Collection
+ */
+export declare const unpinCollection: <ThrowOnError extends boolean = false>(options: Options<UnpinCollectionData, ThrowOnError>) => RequestResult<UnpinCollectionResponses, UnpinCollectionErrors, ThrowOnError>;
+/**
+ * Pin Collection
+ *
+ * Pin the collection to the person's sidebar (readers may too).
+ */
+export declare const pinCollection: <ThrowOnError extends boolean = false>(options: Options<PinCollectionData, ThrowOnError>) => RequestResult<PinCollectionResponses, PinCollectionErrors, ThrowOnError>;
+/**
+ * Add Items
+ *
+ * Add items; those the collection may not hold (a group's collection
+ * holds only that group's items) or the person cannot read are skipped.
+ */
+export declare const addItems: <ThrowOnError extends boolean = false>(options: Options<AddItemsData, ThrowOnError>) => RequestResult<AddItemsResponses, AddItemsErrors, ThrowOnError>;
+/**
+ * Remove Item
+ */
+export declare const removeItem: <ThrowOnError extends boolean = false>(options: Options<RemoveItemData, ThrowOnError>) => RequestResult<RemoveItemResponses, RemoveItemErrors, ThrowOnError>;
+/**
+ * List Libraries
+ *
+ * The libraries the person can read: their own first, then their groups'.
+ */
+export declare const listLibraries: <ThrowOnError extends boolean = false>(options?: Options<ListLibrariesData, ThrowOnError>) => RequestResult<ListLibrariesResponses, unknown, ThrowOnError>;
+/**
+ * Set Default Library
+ *
+ * Where new items go unless another library is chosen.
+ */
+export declare const setDefaultLibrary: <ThrowOnError extends boolean = false>(options: Options<SetDefaultLibraryData, ThrowOnError>) => RequestResult<SetDefaultLibraryResponses, SetDefaultLibraryErrors, ThrowOnError>;
+/**
+ * List Groups
+ *
+ * The groups the person belongs to (directly or through a group above);
+ * site administrators see every group. Flat; ``parent_id`` gives the tree.
+ */
+export declare const listGroups: <ThrowOnError extends boolean = false>(options?: Options<ListGroupsData, ThrowOnError>) => RequestResult<ListGroupsResponses, unknown, ThrowOnError>;
+/**
+ * Create Group
+ *
+ * A group with its library. Top-level groups: site administrators only,
+ * with a first admin. Subgroups: the parent's admins (who are then admins
+ * of the subgroup too).
+ */
+export declare const createGroup: <ThrowOnError extends boolean = false>(options: Options<CreateGroupData, ThrowOnError>) => RequestResult<CreateGroupResponses, CreateGroupErrors, ThrowOnError>;
+/**
+ * Delete Group
+ *
+ * Delete an empty group: no groups inside and no items or notes (not
+ * even in its trash). Its tags, collections and memberships go with it.
+ */
+export declare const deleteGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteGroupData, ThrowOnError>) => RequestResult<DeleteGroupResponses, DeleteGroupErrors, ThrowOnError>;
+/**
+ * Change Group
+ */
+export declare const changeGroup: <ThrowOnError extends boolean = false>(options: Options<ChangeGroupData, ThrowOnError>) => RequestResult<ChangeGroupResponses, ChangeGroupErrors, ThrowOnError>;
+/**
+ * List Members
+ *
+ * Everyone in the group: given a role here or in a group above.
+ */
+export declare const listMembers: <ThrowOnError extends boolean = false>(options: Options<ListMembersData, ThrowOnError>) => RequestResult<ListMembersResponses, ListMembersErrors, ThrowOnError>;
+/**
+ * Remove Member
+ *
+ * Remove someone's membership here (inherited ones stay).
+ */
+export declare const removeMember: <ThrowOnError extends boolean = false>(options: Options<RemoveMemberData, ThrowOnError>) => RequestResult<RemoveMemberResponses, RemoveMemberErrors, ThrowOnError>;
+/**
+ * Set Member
+ *
+ * Add someone to the group, or change their role here. A role lower than
+ * one inherited from a group above has no effect (inherited roles win).
+ */
+export declare const setMember: <ThrowOnError extends boolean = false>(options: Options<SetMemberData, ThrowOnError>) => RequestResult<SetMemberResponses, SetMemberErrors, ThrowOnError>;
+/**
+ * Leave Group
+ *
+ * Leave a group one was added to. Membership through a group above can
+ * only be left there.
+ */
+export declare const leaveGroup: <ThrowOnError extends boolean = false>(options: Options<LeaveGroupData, ThrowOnError>) => RequestResult<LeaveGroupResponses, LeaveGroupErrors, ThrowOnError>;
+/**
+ * Find Users
+ *
+ * People to add to a group, by username; for site administrators and
+ * group admins.
+ */
+export declare const findUsers: <ThrowOnError extends boolean = false>(options?: Options<FindUsersData, ThrowOnError>) => RequestResult<FindUsersResponses, FindUsersErrors, ThrowOnError>;
+/**
+ * List Users
+ */
+export declare const listUsers: <ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>) => RequestResult<ListUsersResponses, unknown, ThrowOnError>;
+/**
+ * Create User
+ *
+ * A new account (with its private space); 409 if the name is taken.
+ */
+export declare const createUser: <ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>) => RequestResult<CreateUserResponses, CreateUserErrors, ThrowOnError>;
+/**
+ * Change User
+ *
+ * Reset a password, grant or take admin rights, (de)activate. The last
+ * active administrator cannot lose those rights, and nobody deactivates
+ * themselves.
+ */
+export declare const changeUser: <ThrowOnError extends boolean = false>(options: Options<ChangeUserData, ThrowOnError>) => RequestResult<ChangeUserResponses, ChangeUserErrors, ThrowOnError>;
+/**
+ * Private Things
+ */
+export declare const privateThings: <ThrowOnError extends boolean = false>(options: Options<PrivateThingsData, ThrowOnError>) => RequestResult<PrivateThingsResponses, PrivateThingsErrors, ThrowOnError>;
+/**
+ * Hand Over
+ *
+ * Give a deactivated person's papers, notes, tags and collections to a
+ * group or another person.
+ */
+export declare const handOver: <ThrowOnError extends boolean = false>(options: Options<HandOverData, ThrowOnError>) => RequestResult<HandOverResponses, HandOverErrors, ThrowOnError>;
+/**
+ * List Backups
+ */
+export declare const listBackups: <ThrowOnError extends boolean = false>(options?: Options<ListBackupsData, ThrowOnError>) => RequestResult<ListBackupsResponses, unknown, ThrowOnError>;
+/**
+ * Start Backup
+ *
+ * Queue a backup now (the worker writes it); 409 if one is running.
+ */
+export declare const startBackup: <ThrowOnError extends boolean = false>(options: Options<StartBackupData, ThrowOnError>) => RequestResult<StartBackupResponses, StartBackupErrors, ThrowOnError>;
+/**
+ * Set Backup Config
+ */
+export declare const setBackupConfig: <ThrowOnError extends boolean = false>(options: Options<SetBackupConfigData, ThrowOnError>) => RequestResult<SetBackupConfigResponses, SetBackupConfigErrors, ThrowOnError>;
+/**
+ * Delete Backup
+ */
+export declare const deleteBackup: <ThrowOnError extends boolean = false>(options: Options<DeleteBackupData, ThrowOnError>) => RequestResult<DeleteBackupResponses, DeleteBackupErrors, ThrowOnError>;
+/**
+ * Check Restore
+ */
+export declare const checkRestore: <ThrowOnError extends boolean = false>(options: Options<CheckRestoreData, ThrowOnError>) => RequestResult<CheckRestoreResponses, CheckRestoreErrors, ThrowOnError>;
+/**
+ * Setup State
+ */
+export declare const setupState: <ThrowOnError extends boolean = false>(options?: Options<SetupStateData, ThrowOnError>) => RequestResult<SetupStateResponses, unknown, ThrowOnError>;
+/**
+ * Create First Admin
+ *
+ * The first administrator, logged in right away.
+ */
+export declare const createFirstAdmin: <ThrowOnError extends boolean = false>(options: Options<CreateFirstAdminData, ThrowOnError>) => RequestResult<CreateFirstAdminResponses, CreateFirstAdminErrors, ThrowOnError>;
+/**
+ * Restore On First Start
+ *
+ * Restore a backup from the backup folder into the empty database; then
+ * people log in with their accounts from the backup.
+ */
+export declare const restoreOnFirstStart: <ThrowOnError extends boolean = false>(options: Options<RestoreOnFirstStartData, ThrowOnError>) => RequestResult<RestoreOnFirstStartResponses, RestoreOnFirstStartErrors, ThrowOnError>;
+/**
+ * List Tokens
+ */
+export declare const listTokens: <ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>) => RequestResult<ListTokensResponses, unknown, ThrowOnError>;
+/**
+ * Create Token
+ *
+ * A token acting as you, narrowed to its scopes (and owners).
+ */
+export declare const createToken: <ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>) => RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError>;
+/**
+ * Revoke Token
+ */
+export declare const revokeToken: <ThrowOnError extends boolean = false>(options: Options<RevokeTokenData, ThrowOnError>) => RequestResult<RevokeTokenResponses, RevokeTokenErrors, ThrowOnError>;