@brigadasos/nadeshiko-sdk 1.3.0 → 1.4.0-dev.28a0384

package/dist/sdk.gen.d.ts

@@ -0,0 +1,660 @@
+import type { Client, Options as Options2, TDataShape } from './client';
+import type { AdminDashboardShowData, AdminDashboardShowErrors, AdminDashboardShowResponses, AdminHealthShowData, AdminHealthShowErrors, AdminHealthShowResponses, AdminQueueFailedDestroyData, AdminQueueFailedDestroyErrors, AdminQueueFailedDestroyResponses, AdminQueueFailedIndexData, AdminQueueFailedIndexErrors, AdminQueueFailedIndexResponses, AdminQueueRetryCreateData, AdminQueueRetryCreateErrors, AdminQueueRetryCreateResponses, AdminQueueShowData, AdminQueueShowErrors, AdminQueueShowResponses, AdminQueueStatsIndexData, AdminQueueStatsIndexErrors, AdminQueueStatsIndexResponses, AdminReindexCreateData, AdminReindexCreateErrors, AdminReindexCreateResponses, AdminReportIndexData, AdminReportIndexErrors, AdminReportIndexResponses, AdminReportUpdateData, AdminReportUpdateErrors, AdminReportUpdateResponses, AdminReviewAllowlistCreateData, AdminReviewAllowlistCreateErrors, AdminReviewAllowlistCreateResponses, AdminReviewAllowlistDestroyData, AdminReviewAllowlistDestroyErrors, AdminReviewAllowlistDestroyResponses, AdminReviewAllowlistIndexData, AdminReviewAllowlistIndexErrors, AdminReviewAllowlistIndexResponses, AdminReviewCheckIndexData, AdminReviewCheckIndexErrors, AdminReviewCheckIndexResponses, AdminReviewCheckUpdateData, AdminReviewCheckUpdateErrors, AdminReviewCheckUpdateResponses, AdminReviewRunCreateData, AdminReviewRunCreateErrors, AdminReviewRunCreateResponses, AdminReviewRunIndexData, AdminReviewRunIndexErrors, AdminReviewRunIndexResponses, AdminReviewRunShowData, AdminReviewRunShowErrors, AdminReviewRunShowResponses, CharacterShowData, CharacterShowErrors, CharacterShowResponses, CollectionAddSegmentData, CollectionAddSegmentErrors, CollectionAddSegmentResponses, CollectionCreateData, CollectionCreateErrors, CollectionCreateResponses, CollectionDestroyData, CollectionDestroyErrors, CollectionDestroyResponses, CollectionIndexData, CollectionIndexErrors, CollectionIndexResponses, CollectionRemoveSegmentData, CollectionRemoveSegmentErrors, CollectionRemoveSegmentResponses, CollectionShowData, CollectionShowErrors, CollectionShowResponses, CollectionUpdateData, CollectionUpdateErrors, CollectionUpdateResponses, CollectionUpdateSegmentData, CollectionUpdateSegmentErrors, CollectionUpdateSegmentResponses, EpisodeCreateData, EpisodeCreateErrors, EpisodeCreateResponses, EpisodeDestroyData, EpisodeDestroyErrors, EpisodeDestroyResponses, EpisodeIndexData, EpisodeIndexErrors, EpisodeIndexResponses, EpisodeShowData, EpisodeShowErrors, EpisodeShowResponses, EpisodeUpdateData, EpisodeUpdateErrors, EpisodeUpdateResponses, MediaCreateData, MediaCreateErrors, MediaCreateResponses, MediaDestroyData, MediaDestroyErrors, MediaDestroyResponses, MediaIndexData, MediaIndexErrors, MediaIndexResponses, MediaShowData, MediaShowErrors, MediaShowResponses, MediaUpdateData, MediaUpdateErrors, MediaUpdateResponses, SearchIndexData, SearchIndexErrors, SearchIndexResponses, SearchStatsData, SearchStatsErrors, SearchStatsResponses, SearchWordsData, SearchWordsErrors, SearchWordsResponses, SegmentContextShowData, SegmentContextShowErrors, SegmentContextShowResponses, SegmentCreateData, SegmentCreateErrors, SegmentCreateResponses, SegmentDestroyData, SegmentDestroyErrors, SegmentDestroyResponses, SegmentIndexData, SegmentIndexErrors, SegmentIndexResponses, SegmentShowByUuidData, SegmentShowByUuidErrors, SegmentShowByUuidResponses, SegmentShowData, SegmentShowErrors, SegmentShowResponses, SegmentUpdateData, SegmentUpdateErrors, SegmentUpdateResponses, SeiyuuShowData, SeiyuuShowErrors, SeiyuuShowResponses, SeriesAddMediaData, SeriesAddMediaErrors, SeriesAddMediaResponses, SeriesCreateData, SeriesCreateErrors, SeriesCreateResponses, SeriesDestroyData, SeriesDestroyErrors, SeriesDestroyResponses, SeriesIndexData, SeriesIndexErrors, SeriesIndexResponses, SeriesRemoveMediaData, SeriesRemoveMediaErrors, SeriesRemoveMediaResponses, SeriesShowData, SeriesShowErrors, SeriesShowResponses, SeriesUpdateData, SeriesUpdateErrors, SeriesUpdateMediaData, SeriesUpdateMediaErrors, SeriesUpdateMediaResponses, SeriesUpdateResponses, UserActivityDestroyData, UserActivityDestroyErrors, UserActivityDestroyResponses, UserActivityHeatmapShowData, UserActivityHeatmapShowErrors, UserActivityHeatmapShowResponses, UserActivityIndexData, UserActivityIndexErrors, UserActivityIndexResponses, UserActivityStatsShowData, UserActivityStatsShowErrors, UserActivityStatsShowResponses, UserExportShowData, UserExportShowErrors, UserExportShowResponses, UserLabsIndexData, UserLabsIndexErrors, UserLabsIndexResponses, UserPreferencesShowData, UserPreferencesShowErrors, UserPreferencesShowResponses, UserPreferencesUpdateData, UserPreferencesUpdateErrors, UserPreferencesUpdateResponses, UserQuotaShowData, UserQuotaShowErrors, UserQuotaShowResponses, UserReportCreateData, UserReportCreateErrors, UserReportCreateResponses, UserReportIndexData, UserReportIndexErrors, UserReportIndexResponses } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * 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?: Record<string, unknown>;
+};
+/**
+ * Search segments by query
+ *
+ * The primary search endpoint for finding Japanese segments and their translations across indexed media (anime, J-Drama, audiobooks).
+ *
+ * This endpoint uses Elasticsearch with advanced Japanese text analysis supporting multiple input types (romaji, kanji, kana) and providing intelligent field-based boosting.
+ *
+ * **Query Features**
+ * - **Multi-language Support:** Search using Japanese (kanji/kana), Romaji, or English/Spanish
+ * - **Boolean Operators:** `AND`, `OR`, `NOT` supported (e.g., `(cat OR dog) AND bird`)
+ * - **Phrase Matching:** Use quotes for exact phrases (e.g., `"good morning"`), or pass `exact_match: true` to the request body
+ * - **Wildcards:** `te*t` format (leading wildcards not supported)
+ * - **Smart Field Selection:** Automatically chooses optimal search fields based on input type
+ *
+ * **Input Type Handling**
+ * | Input Type | Search Strategy |
+ * |------------|-----------------|
+ * | **Romaji** (`go`, `taberu`) | Boosts EN/ES translations, reading form (pronunciation), and base form |
+ * | **Kanji** (`食べる`, `彼女`) | Searches content and base form (dictionary form). Ignores matches by reading (homophones). |
+ * | **Kana** (`たべる`, `かのじょ`) | Standard search across content, base form, and reading form |
+ * | **English/Spanish** | Direct translation search |
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const searchIndex: <ThrowOnError extends boolean = false>(options?: Options<SearchIndexData, ThrowOnError>) => import("./client").RequestResult<SearchIndexResponses, SearchIndexErrors, ThrowOnError, "fields">;
+/**
+ * Get search statistics
+ *
+ * Returns statistics for search filters and category tabs without fetching segment rows.
+ *
+ * This endpoint is optimized for UI filter panels:
+ * - `media` powers the media dropdown on the right side.
+ * - `categories` powers category tabs below the search bar.
+ *
+ * The stats are scoped by query and category filters, but are not narrowed by a selected media/episode.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const searchStats: <ThrowOnError extends boolean = false>(options?: Options<SearchStatsData, ThrowOnError>) => import("./client").RequestResult<SearchStatsResponses, SearchStatsErrors, ThrowOnError, "fields">;
+/**
+ * Search by multiple words
+ *
+ * Searches for multiple words simultaneously and aggregates results by media.
+ *
+ * Unlike the main search endpoint, this returns a summary of matches per media rather than individual segments.
+ *
+ * **Use Cases**
+ * - Vocabulary discovery across media library
+ * - Finding anime/dramas that use specific words
+ * - Comparing word usage across different titles
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const searchWords: <ThrowOnError extends boolean = false>(options: Options<SearchWordsData, ThrowOnError>) => import("./client").RequestResult<SearchWordsResponses, SearchWordsErrors, ThrowOnError, "fields">;
+/**
+ * List all media
+ *
+ * Returns a paginated list of media with full metadata, including cover/banner images, episode counts, and genres.
+ * Supports filtering by category and text search.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const mediaIndex: <ThrowOnError extends boolean = false>(options?: Options<MediaIndexData, ThrowOnError>) => import("./client").RequestResult<MediaIndexResponses, MediaIndexErrors, ThrowOnError, "fields">;
+/**
+ * Create new media
+ *
+ * Creates a new media entry in the database.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const mediaCreate: <ThrowOnError extends boolean = false>(options: Options<MediaCreateData, ThrowOnError>) => import("./client").RequestResult<MediaCreateResponses, MediaCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete media (soft delete)
+ *
+ * Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
+ *
+ * **Permissions:** `REMOVE_MEDIA`
+ *
+ */
+export declare const mediaDestroy: <ThrowOnError extends boolean = false>(options: Options<MediaDestroyData, ThrowOnError>) => import("./client").RequestResult<MediaDestroyResponses, MediaDestroyErrors, ThrowOnError, "fields">;
+/**
+ * Get single media
+ *
+ * Returns a single media entry by its ID with full metadata.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const mediaShow: <ThrowOnError extends boolean = false>(options: Options<MediaShowData, ThrowOnError>) => import("./client").RequestResult<MediaShowResponses, MediaShowErrors, ThrowOnError, "fields">;
+/**
+ * Update media
+ *
+ * Updates an existing media entry. Only provided fields will be updated.
+ *
+ * **Permissions:** `UPDATE_MEDIA`
+ *
+ */
+export declare const mediaUpdate: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateData, ThrowOnError>) => import("./client").RequestResult<MediaUpdateResponses, MediaUpdateErrors, ThrowOnError, "fields">;
+/**
+ * List episodes for a media
+ *
+ * Returns a paginated list of episodes for a specific media.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const episodeIndex: <ThrowOnError extends boolean = false>(options: Options<EpisodeIndexData, ThrowOnError>) => import("./client").RequestResult<EpisodeIndexResponses, EpisodeIndexErrors, ThrowOnError, "fields">;
+/**
+ * Create new episode
+ *
+ * Creates a new episode for a specific media.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const episodeCreate: <ThrowOnError extends boolean = false>(options: Options<EpisodeCreateData, ThrowOnError>) => import("./client").RequestResult<EpisodeCreateResponses, EpisodeCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete an episode
+ *
+ * Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
+ *
+ * **Permissions:** `REMOVE_MEDIA`
+ *
+ */
+export declare const episodeDestroy: <ThrowOnError extends boolean = false>(options: Options<EpisodeDestroyData, ThrowOnError>) => import("./client").RequestResult<EpisodeDestroyResponses, EpisodeDestroyErrors, ThrowOnError, "fields">;
+/**
+ * Get single episode
+ *
+ * Returns a specific episode by media ID and episode number.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const episodeShow: <ThrowOnError extends boolean = false>(options: Options<EpisodeShowData, ThrowOnError>) => import("./client").RequestResult<EpisodeShowResponses, EpisodeShowErrors, ThrowOnError, "fields">;
+/**
+ * Update episode
+ *
+ * Updates an existing episode. Only provided fields will be updated.
+ *
+ * **Permissions:** `UPDATE_MEDIA`
+ *
+ */
+export declare const episodeUpdate: <ThrowOnError extends boolean = false>(options: Options<EpisodeUpdateData, ThrowOnError>) => import("./client").RequestResult<EpisodeUpdateResponses, EpisodeUpdateErrors, ThrowOnError, "fields">;
+/**
+ * List segments for an episode
+ *
+ * Returns a paginated list of segments for a specific episode.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const segmentIndex: <ThrowOnError extends boolean = false>(options: Options<SegmentIndexData, ThrowOnError>) => import("./client").RequestResult<SegmentIndexResponses, SegmentIndexErrors, ThrowOnError, "fields">;
+/**
+ * Create new segment
+ *
+ * Creates a new segment for a specific episode.
+ *
+ * **Permissions:** `UPDATE_MEDIA`
+ *
+ */
+export declare const segmentCreate: <ThrowOnError extends boolean = false>(options: Options<SegmentCreateData, ThrowOnError>) => import("./client").RequestResult<SegmentCreateResponses, SegmentCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete segment
+ *
+ * Soft-deletes a segment by setting its status to DELETED.
+ *
+ * **Permissions:** `REMOVE_MEDIA`
+ *
+ */
+export declare const segmentDestroy: <ThrowOnError extends boolean = false>(options: Options<SegmentDestroyData, ThrowOnError>) => import("./client").RequestResult<SegmentDestroyResponses, SegmentDestroyErrors, ThrowOnError, "fields">;
+/**
+ * Get single segment
+ *
+ * Returns a specific segment by its ID within the media/episode hierarchy.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const segmentShow: <ThrowOnError extends boolean = false>(options: Options<SegmentShowData, ThrowOnError>) => import("./client").RequestResult<SegmentShowResponses, SegmentShowErrors, ThrowOnError, "fields">;
+/**
+ * Update segment
+ *
+ * Updates an existing segment. Only provided fields will be updated.
+ *
+ * **Permissions:** `UPDATE_MEDIA`
+ *
+ */
+export declare const segmentUpdate: <ThrowOnError extends boolean = false>(options: Options<SegmentUpdateData, ThrowOnError>) => import("./client").RequestResult<SegmentUpdateResponses, SegmentUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Get segment by UUID
+ *
+ * Returns a specific segment by its UUID. A shortcut alternative to the nested `/media/{mediaId}/episodes/{episodeNumber}/segments/{id}` path.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const segmentShowByUuid: <ThrowOnError extends boolean = false>(options: Options<SegmentShowByUuidData, ThrowOnError>) => import("./client").RequestResult<SegmentShowByUuidResponses, SegmentShowByUuidErrors, ThrowOnError, "fields">;
+/**
+ * Get surrounding context for a segment
+ *
+ * Retrieves segments surrounding a specific segment within an episode.
+ * Returns segments both before and after the target, providing dialogue context for how a sentence is used.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const segmentContextShow: <ThrowOnError extends boolean = false>(options: Options<SegmentContextShowData, ThrowOnError>) => import("./client").RequestResult<SegmentContextShowResponses, SegmentContextShowErrors, ThrowOnError, "fields">;
+/**
+ * List all series
+ *
+ * Returns a paginated list of media series groupings.
+ *
+ */
+export declare const seriesIndex: <ThrowOnError extends boolean = false>(options?: Options<SeriesIndexData, ThrowOnError>) => import("./client").RequestResult<SeriesIndexResponses, SeriesIndexErrors, ThrowOnError, "fields">;
+/**
+ * Create series
+ *
+ * Creates a new media series grouping.
+ *
+ */
+export declare const seriesCreate: <ThrowOnError extends boolean = false>(options: Options<SeriesCreateData, ThrowOnError>) => import("./client").RequestResult<SeriesCreateResponses, SeriesCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete series
+ *
+ * Deletes a series and all its media associations.
+ *
+ */
+export declare const seriesDestroy: <ThrowOnError extends boolean = false>(options: Options<SeriesDestroyData, ThrowOnError>) => import("./client").RequestResult<SeriesDestroyResponses, SeriesDestroyErrors, ThrowOnError, "fields">;
+/**
+ * Get series details
+ *
+ * Returns a series with all media entries sorted by position.
+ *
+ */
+export declare const seriesShow: <ThrowOnError extends boolean = false>(options: Options<SeriesShowData, ThrowOnError>) => import("./client").RequestResult<SeriesShowResponses, SeriesShowErrors, ThrowOnError, "fields">;
+/**
+ * Update series metadata
+ *
+ * Updates series localized names.
+ *
+ */
+export declare const seriesUpdate: <ThrowOnError extends boolean = false>(options: Options<SeriesUpdateData, ThrowOnError>) => import("./client").RequestResult<SeriesUpdateResponses, SeriesUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Add media to series
+ *
+ * Adds a media entry to a series at a specific position.
+ *
+ */
+export declare const seriesAddMedia: <ThrowOnError extends boolean = false>(options: Options<SeriesAddMediaData, ThrowOnError>) => import("./client").RequestResult<SeriesAddMediaResponses, SeriesAddMediaErrors, ThrowOnError, "fields">;
+/**
+ * Remove media from series
+ *
+ * Removes a media entry from a series.
+ *
+ */
+export declare const seriesRemoveMedia: <ThrowOnError extends boolean = false>(options: Options<SeriesRemoveMediaData, ThrowOnError>) => import("./client").RequestResult<SeriesRemoveMediaResponses, SeriesRemoveMediaErrors, ThrowOnError, "fields">;
+/**
+ * Update media position in series
+ *
+ * Updates the position of a media entry in a series.
+ *
+ */
+export declare const seriesUpdateMedia: <ThrowOnError extends boolean = false>(options: Options<SeriesUpdateMediaData, ThrowOnError>) => import("./client").RequestResult<SeriesUpdateMediaResponses, SeriesUpdateMediaErrors, ThrowOnError, "fields">;
+/**
+ * Get character details
+ *
+ * Returns a character with their voice actors (seiyuu) and all media appearances.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const characterShow: <ThrowOnError extends boolean = false>(options: Options<CharacterShowData, ThrowOnError>) => import("./client").RequestResult<CharacterShowResponses, CharacterShowErrors, ThrowOnError, "fields">;
+/**
+ * Get seiyuu details
+ *
+ * Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
+ *
+ * **Permissions:** `READ_MEDIA`
+ *
+ */
+export declare const seiyuuShow: <ThrowOnError extends boolean = false>(options: Options<SeiyuuShowData, ThrowOnError>) => import("./client").RequestResult<SeiyuuShowResponses, SeiyuuShowErrors, ThrowOnError, "fields">;
+/**
+ * Get current monthly API quota
+ *
+ * Returns the API quota usage for the current billing period.
+ * Accepts both session cookie and API key authentication.
+ *
+ * **Permissions:** Session authentication (cookie-based) or API key (`READ_MEDIA`).
+ *
+ */
+export declare const userQuotaShow: <ThrowOnError extends boolean = false>(options?: Options<UserQuotaShowData, ThrowOnError>) => import("./client").RequestResult<UserQuotaShowResponses, UserQuotaShowErrors, ThrowOnError, "fields">;
+/**
+ * List user's own reports
+ *
+ * Returns the authenticated user's submitted reports with cursor pagination.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userReportIndex: <ThrowOnError extends boolean = false>(options?: Options<UserReportIndexData, ThrowOnError>) => import("./client").RequestResult<UserReportIndexResponses, UserReportIndexErrors, ThrowOnError, "fields">;
+/**
+ * Create a new report
+ *
+ * Submit a report for a segment or media entry.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userReportCreate: <ThrowOnError extends boolean = false>(options: Options<UserReportCreateData, ThrowOnError>) => import("./client").RequestResult<UserReportCreateResponses, UserReportCreateErrors, ThrowOnError, "fields">;
+/**
+ * Get user preferences
+ *
+ * Returns the authenticated user's full preferences object.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userPreferencesShow: <ThrowOnError extends boolean = false>(options?: Options<UserPreferencesShowData, ThrowOnError>) => import("./client").RequestResult<UserPreferencesShowResponses, UserPreferencesShowErrors, ThrowOnError, "fields">;
+/**
+ * Update user preferences
+ *
+ * Deep-merges a partial preferences update into the user's existing preferences.
+ * Only the provided keys are updated; all other keys are preserved.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userPreferencesUpdate: <ThrowOnError extends boolean = false>(options: Options<UserPreferencesUpdateData, ThrowOnError>) => import("./client").RequestResult<UserPreferencesUpdateResponses, UserPreferencesUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Clear user activity history
+ *
+ * Deletes the authenticated user's activity history. Optionally filter by activity type.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userActivityDestroy: <ThrowOnError extends boolean = false>(options?: Options<UserActivityDestroyData, ThrowOnError>) => import("./client").RequestResult<UserActivityDestroyResponses, UserActivityDestroyErrors, ThrowOnError, "fields">;
+/**
+ * Get user activity history
+ *
+ * Returns the authenticated user's activity history with cursor-based pagination.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userActivityIndex: <ThrowOnError extends boolean = false>(options?: Options<UserActivityIndexData, ThrowOnError>) => import("./client").RequestResult<UserActivityIndexResponses, UserActivityIndexErrors, ThrowOnError, "fields">;
+/**
+ * Get activity heatmap data
+ *
+ * Returns daily activity counts for the authenticated user, grouped by date.
+ * Designed for rendering a GitHub-style contribution heatmap.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userActivityHeatmapShow: <ThrowOnError extends boolean = false>(options?: Options<UserActivityHeatmapShowData, ThrowOnError>) => import("./client").RequestResult<UserActivityHeatmapShowResponses, UserActivityHeatmapShowErrors, ThrowOnError, "fields">;
+/**
+ * Get user activity statistics
+ *
+ * Returns aggregate statistics about the authenticated user's activity:
+ * total searches, exports, plays, and study streak.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userActivityStatsShow: <ThrowOnError extends boolean = false>(options?: Options<UserActivityStatsShowData, ThrowOnError>) => import("./client").RequestResult<UserActivityStatsShowResponses, UserActivityStatsShowErrors, ThrowOnError, "fields">;
+/**
+ * Export all user data
+ *
+ * Returns a full JSON export of all user-related data for GDPR data portability.
+ * Includes profile, preferences, activity history, collections, and reports.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userExportShow: <ThrowOnError extends boolean = false>(options?: Options<UserExportShowData, ThrowOnError>) => import("./client").RequestResult<UserExportShowResponses, UserExportShowErrors, ThrowOnError, "fields">;
+/**
+ * List lab features with user opt-in status
+ *
+ * Returns all available lab features merged with the authenticated user's
+ * opt-in status. Features gated by role are excluded if the user lacks
+ * the required role.
+ *
+ * **Permissions:** Session authentication (cookie-based).
+ *
+ */
+export declare const userLabsIndex: <ThrowOnError extends boolean = false>(options?: Options<UserLabsIndexData, ThrowOnError>) => import("./client").RequestResult<UserLabsIndexResponses, UserLabsIndexErrors, ThrowOnError, "fields">;
+/**
+ * List user's collections
+ *
+ * Returns all collections for the authenticated user. Can filter by visibility.
+ *
+ */
+export declare const collectionIndex: <ThrowOnError extends boolean = false>(options?: Options<CollectionIndexData, ThrowOnError>) => import("./client").RequestResult<CollectionIndexResponses, CollectionIndexErrors, ThrowOnError, "fields">;
+/**
+ * Create collection
+ *
+ * Creates a new segment collection for the authenticated user.
+ *
+ */
+export declare const collectionCreate: <ThrowOnError extends boolean = false>(options: Options<CollectionCreateData, ThrowOnError>) => import("./client").RequestResult<CollectionCreateResponses, CollectionCreateErrors, ThrowOnError, "fields">;
+/**
+ * Delete collection
+ *
+ * Deletes a collection and all its segment entries. Requires collection ownership.
+ *
+ */
+export declare const collectionDestroy: <ThrowOnError extends boolean = false>(options: Options<CollectionDestroyData, ThrowOnError>) => import("./client").RequestResult<CollectionDestroyResponses, CollectionDestroyErrors, ThrowOnError, "fields">;
+/**
+ * Get collection details
+ *
+ * Returns a collection with paginated segments and their search result data.
+ *
+ */
+export declare const collectionShow: <ThrowOnError extends boolean = false>(options: Options<CollectionShowData, ThrowOnError>) => import("./client").RequestResult<CollectionShowResponses, CollectionShowErrors, ThrowOnError, "fields">;
+/**
+ * Update collection metadata
+ *
+ * Updates collection name or visibility. Requires collection ownership.
+ *
+ */
+export declare const collectionUpdate: <ThrowOnError extends boolean = false>(options: Options<CollectionUpdateData, ThrowOnError>) => import("./client").RequestResult<CollectionUpdateResponses, CollectionUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Add segment to collection
+ *
+ * Adds a segment to a collection. Requires collection ownership.
+ *
+ */
+export declare const collectionAddSegment: <ThrowOnError extends boolean = false>(options: Options<CollectionAddSegmentData, ThrowOnError>) => import("./client").RequestResult<CollectionAddSegmentResponses, CollectionAddSegmentErrors, ThrowOnError, "fields">;
+/**
+ * Remove segment from collection
+ *
+ * Removes a segment from a collection. Requires collection ownership.
+ *
+ */
+export declare const collectionRemoveSegment: <ThrowOnError extends boolean = false>(options: Options<CollectionRemoveSegmentData, ThrowOnError>) => import("./client").RequestResult<CollectionRemoveSegmentResponses, CollectionRemoveSegmentErrors, ThrowOnError, "fields">;
+/**
+ * Update segment in collection
+ *
+ * Updates the note or position of a segment in a collection. Requires collection ownership.
+ *
+ */
+export declare const collectionUpdateSegment: <ThrowOnError extends boolean = false>(options: Options<CollectionUpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<CollectionUpdateSegmentResponses, CollectionUpdateSegmentErrors, ThrowOnError, "fields">;
+/**
+ * Admin dashboard statistics
+ *
+ * Returns at-a-glance statistics for the admin dashboard including media counts,
+ * user counts, and system health information.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminDashboardShow: <ThrowOnError extends boolean = false>(options?: Options<AdminDashboardShowData, ThrowOnError>) => import("./client").RequestResult<AdminDashboardShowResponses, AdminDashboardShowErrors, ThrowOnError, "fields">;
+/**
+ * System health check
+ *
+ * Returns connectivity status and version information for all backend subsystems
+ * (Elasticsearch, PostgreSQL, application).
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminHealthShow: <ThrowOnError extends boolean = false>(options?: Options<AdminHealthShowData, ThrowOnError>) => import("./client").RequestResult<AdminHealthShowResponses, AdminHealthShowErrors, ThrowOnError, "fields">;
+/**
+ * Reindex database into Elasticsearch
+ *
+ * Reindexes segments from the PostgreSQL database into Elasticsearch.
+ * Allows filtering by specific media IDs or episodes.
+ *
+ * **Behavior:**
+ * - If no filters provided, reindexes all segments
+ * - If `mediaIds` provided, reindexes all segments from those media
+ * - If `episodes` provided, reindexes only the specified episodes
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReindexCreate: <ThrowOnError extends boolean = false>(options?: Options<AdminReindexCreateData, ThrowOnError>) => import("./client").RequestResult<AdminReindexCreateResponses, AdminReindexCreateErrors, ThrowOnError, "fields">;
+/**
+ * Get queue statistics
+ *
+ * Returns statistics for all ES sync queues including pending and failed job counts.
+ *
+ * **Use cases:**
+ * - Monitor queue health
+ * - Detect stuck jobs
+ * - Check backlog size
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminQueueStatsIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminQueueStatsIndexData, ThrowOnError>) => import("./client").RequestResult<AdminQueueStatsIndexResponses, AdminQueueStatsIndexErrors, ThrowOnError, "fields">;
+/**
+ * Get detailed queue information
+ *
+ * Returns live queue stats and queue metadata from PgBoss for a specific queue.
+ *
+ * **Queue names:**
+ * - `es-sync-create` - Jobs to create new segments in Elasticsearch
+ * - `es-sync-update` - Jobs to update existing segments
+ * - `es-sync-delete` - Jobs to delete segments
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminQueueShow: <ThrowOnError extends boolean = false>(options: Options<AdminQueueShowData, ThrowOnError>) => import("./client").RequestResult<AdminQueueShowResponses, AdminQueueShowErrors, ThrowOnError, "fields">;
+/**
+ * Get failed jobs from a queue
+ *
+ * Returns jobs that have exceeded their retry limit and permanently failed.
+ *
+ * **Use cases:**
+ * - Identify segments that failed to sync to Elasticsearch
+ * - Debug persistent sync issues
+ * - Decide whether to retry or purge failed jobs
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminQueueFailedIndex: <ThrowOnError extends boolean = false>(options: Options<AdminQueueFailedIndexData, ThrowOnError>) => import("./client").RequestResult<AdminQueueFailedIndexResponses, AdminQueueFailedIndexErrors, ThrowOnError, "fields">;
+/**
+ * Retry failed jobs from a queue
+ *
+ * Re-enqueues all failed jobs from a specific queue for another attempt.
+ *
+ * **Use cases:**
+ * - Retry jobs that failed due to temporary Elasticsearch issues
+ * - Recover from network blips
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminQueueRetryCreate: <ThrowOnError extends boolean = false>(options: Options<AdminQueueRetryCreateData, ThrowOnError>) => import("./client").RequestResult<AdminQueueRetryCreateResponses, AdminQueueRetryCreateErrors, ThrowOnError, "fields">;
+/**
+ * Purge failed jobs from a queue
+ *
+ * Permanently deletes all failed jobs from a queue.
+ * This does **not** re-sync the affected segments — use the reindex endpoint for that.
+ *
+ * **Use cases:**
+ * - Clean up old failed jobs after investigating
+ * - Reset a queue after fixing the underlying issue
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminQueueFailedDestroy: <ThrowOnError extends boolean = false>(options: Options<AdminQueueFailedDestroyData, ThrowOnError>) => import("./client").RequestResult<AdminQueueFailedDestroyResponses, AdminQueueFailedDestroyErrors, ThrowOnError, "fields">;
+/**
+ * List all reports
+ *
+ * Returns all reports with filtering and cursor pagination.
+ * Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReportIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReportIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReportIndexResponses, AdminReportIndexErrors, ThrowOnError, "fields">;
+/**
+ * Update a report
+ *
+ * Updates the status and/or admin notes of a report.
+ * Works for both USER and AUTO reports.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReportUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminReportUpdateData, ThrowOnError>) => import("./client").RequestResult<AdminReportUpdateResponses, AdminReportUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Run auto-checks
+ *
+ * Triggers all enabled auto-checks. Creates ReviewCheckRun records and AUTO reports for any findings.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewRunCreate: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewRunCreateData, ThrowOnError>) => import("./client").RequestResult<AdminReviewRunCreateResponses, AdminReviewRunCreateErrors, ThrowOnError, "fields">;
+/**
+ * List all review checks
+ *
+ * Returns all check definitions with current config, threshold schema, and latest run info.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewCheckIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewCheckIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReviewCheckIndexResponses, AdminReviewCheckIndexErrors, ThrowOnError, "fields">;
+/**
+ * Update a review check config
+ *
+ * Updates the threshold values or enabled status of a check.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewCheckUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminReviewCheckUpdateData, ThrowOnError>) => import("./client").RequestResult<AdminReviewCheckUpdateResponses, AdminReviewCheckUpdateErrors, ThrowOnError, "fields">;
+/**
+ * List past check runs
+ *
+ * Returns past review check runs with summary stats. Supports filtering by check name and cursor pagination.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewRunIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewRunIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReviewRunIndexResponses, AdminReviewRunIndexErrors, ThrowOnError, "fields">;
+/**
+ * Get a specific run's details
+ *
+ * Returns a specific review check run record with its linked reports.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewRunShow: <ThrowOnError extends boolean = false>(options: Options<AdminReviewRunShowData, ThrowOnError>) => import("./client").RequestResult<AdminReviewRunShowResponses, AdminReviewRunShowErrors, ThrowOnError, "fields">;
+/**
+ * List allowlisted items
+ *
+ * Returns all allowlisted items (media/episodes) that are excluded from auto-check runs.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewAllowlistIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewAllowlistIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReviewAllowlistIndexResponses, AdminReviewAllowlistIndexErrors, ThrowOnError, "fields">;
+/**
+ * Add to allowlist
+ *
+ * Adds a media or episode to the allowlist for a specific check, excluding it from future auto-check runs.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewAllowlistCreate: <ThrowOnError extends boolean = false>(options: Options<AdminReviewAllowlistCreateData, ThrowOnError>) => import("./client").RequestResult<AdminReviewAllowlistCreateResponses, AdminReviewAllowlistCreateErrors, ThrowOnError, "fields">;
+/**
+ * Remove from allowlist
+ *
+ * Removes an item from the review allowlist, re-enabling auto-checks for that media/episode.
+ *
+ * **Permissions:** `ADD_MEDIA`
+ *
+ */
+export declare const adminReviewAllowlistDestroy: <ThrowOnError extends boolean = false>(options: Options<AdminReviewAllowlistDestroyData, ThrowOnError>) => import("./client").RequestResult<AdminReviewAllowlistDestroyResponses, AdminReviewAllowlistDestroyErrors, ThrowOnError, "fields">;
+//# sourceMappingURL=sdk.gen.d.ts.map