@brigadasos/nadeshiko-sdk 1.4.0-dev.c253525 → 1.4.3-dev.0ffbf39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/README.md +99 -2
  2. package/dist/client/client.gen.d.ts.map +1 -1
  3. package/dist/client/index.d.ts.map +1 -1
  4. package/dist/client/types.gen.d.ts.map +1 -1
  5. package/dist/client/utils.gen.d.ts.map +1 -1
  6. package/dist/client.gen.d.ts.map +1 -1
  7. package/dist/core/auth.gen.d.ts.map +1 -1
  8. package/dist/core/bodySerializer.gen.d.ts.map +1 -1
  9. package/dist/core/params.gen.d.ts.map +1 -1
  10. package/dist/core/pathSerializer.gen.d.ts.map +1 -1
  11. package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
  12. package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
  13. package/dist/core/types.gen.d.ts.map +1 -1
  14. package/dist/core/utils.gen.d.ts.map +1 -1
  15. package/dist/index.cjs +455 -246
  16. package/dist/index.cjs.map +5 -5
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.d.ts.map +1 -1
  19. package/dist/index.js +451 -242
  20. package/dist/index.js.map +5 -5
  21. package/dist/internal/admin.gen.d.ts +2 -0
  22. package/dist/internal/admin.gen.d.ts.map +1 -0
  23. package/dist/internal/media.gen.d.ts +1 -1
  24. package/dist/internal/media.gen.d.ts.map +1 -1
  25. package/dist/internal/user.gen.d.ts +2 -0
  26. package/dist/internal/user.gen.d.ts.map +1 -0
  27. package/dist/internal.gen.d.ts +2 -2
  28. package/dist/internal.gen.d.ts.map +1 -1
  29. package/dist/nadeshiko.gen.d.ts +75 -46
  30. package/dist/nadeshiko.gen.d.ts.map +1 -1
  31. package/dist/sdk.gen.d.ts +361 -172
  32. package/dist/sdk.gen.d.ts.map +1 -1
  33. package/dist/types.gen.d.ts +2905 -1742
  34. package/dist/types.gen.d.ts.map +1 -1
  35. package/package.json +1 -1
  36. package/dist/internal/lists.gen.d.ts +0 -2
  37. package/dist/internal/lists.gen.d.ts.map +0 -1
  38. package/dist/internal/search.gen.d.ts +0 -2
  39. package/dist/internal/search.gen.d.ts.map +0 -1
package/dist/sdk.gen.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { BrowseMediaData, BrowseMediaErrors, BrowseMediaResponses, CharacterShowData, CharacterShowErrors, CharacterShowResponses, CreateReportData, CreateReportErrors, CreateReportResponses, EpisodeCreateData, EpisodeCreateErrors, EpisodeCreateResponses, EpisodeDestroyData, EpisodeDestroyErrors, EpisodeDestroyResponses, EpisodeIndexData, EpisodeIndexErrors, EpisodeIndexResponses, EpisodeShowData, EpisodeShowErrors, EpisodeShowResponses, EpisodeUpdateData, EpisodeUpdateErrors, EpisodeUpdateResponses, GetAdminReportsData, GetAdminReportsErrors, GetAdminReportsResponses, GetFailedJobsData, GetFailedJobsErrors, GetFailedJobsResponses, GetQueueDetailsData, GetQueueDetailsErrors, GetQueueDetailsResponses, GetQueueStatsData, GetQueueStatsErrors, GetQueueStatsResponses, GetSearchStatsData, GetSearchStatsErrors, GetSearchStatsResponses, GetSegmentContextData, GetSegmentContextErrors, GetSegmentContextResponses, GetUserQuotaData, GetUserQuotaErrors, GetUserQuotaResponses, GetUserReportsData, GetUserReportsErrors, GetUserReportsResponses, HealthCheckData, HealthCheckErrors, HealthCheckResponses, ListAddItemData, ListAddItemErrors, ListAddItemResponses, ListAddSegmentData, ListAddSegmentErrors, ListAddSegmentResponses, ListCreateData, ListCreateErrors, ListCreateResponses, ListDestroyData, ListDestroyErrors, ListDestroyResponses, ListGetSegmentsData, ListGetSegmentsErrors, ListGetSegmentsResponses, ListIndexData, ListIndexErrors, ListIndexResponses, ListRemoveItemData, ListRemoveItemErrors, ListRemoveItemResponses, ListRemoveSegmentData, ListRemoveSegmentErrors, ListRemoveSegmentResponses, ListShowData, ListShowErrors, ListShowResponses, ListUpdateData, ListUpdateErrors, ListUpdateItemData, ListUpdateItemErrors, ListUpdateItemResponses, ListUpdateResponses, ListUpdateSegmentData, ListUpdateSegmentErrors, ListUpdateSegmentResponses, MediaCreateData, MediaCreateErrors, MediaCreateResponses, MediaDestroyData, MediaDestroyErrors, MediaDestroyResponses, MediaIndexData, MediaIndexErrors, MediaIndexResponses, MediaShowData, MediaShowErrors, MediaShowResponses, MediaUpdateData, MediaUpdateErrors, MediaUpdateResponses, MorphemeBackfillData, MorphemeBackfillResponses, PurgeFailedJobsData, PurgeFailedJobsErrors, PurgeFailedJobsResponses, ReindexElasticsearchData, ReindexElasticsearchErrors, ReindexElasticsearchResponses, RetryQueueJobsData, RetryQueueJobsErrors, RetryQueueJobsResponses, SearchSegmentsData, SearchSegmentsErrors, SearchSegmentsResponses, SearchWordsData, SearchWordsErrors, SearchWordsResponses, SegmentCreateData, SegmentCreateErrors, SegmentCreateResponses, SegmentDestroyData, SegmentDestroyErrors, SegmentDestroyResponses, SegmentIndexData, SegmentIndexErrors, SegmentIndexResponses, SegmentShowByUuidData, SegmentShowByUuidErrors, SegmentShowByUuidResponses, SegmentShowData, SegmentShowErrors, SegmentShowResponses, SegmentUpdateData, SegmentUpdateErrors, SegmentUpdateResponses, SeiyuuShowData, SeiyuuShowErrors, SeiyuuShowResponses, UpdateReportData, UpdateReportErrors, UpdateReportResponses } from './types.gen';
2
+ import type { AddMediaToSeriesData, AddMediaToSeriesErrors, AddMediaToSeriesResponses, AddSegmentToCollectionData, AddSegmentToCollectionErrors, AddSegmentToCollectionResponses, CreateAdminReviewAllowlistEntryData, CreateAdminReviewAllowlistEntryErrors, CreateAdminReviewAllowlistEntryResponses, CreateCollectionData, CreateCollectionErrors, CreateCollectionResponses, CreateEpisodeData, CreateEpisodeErrors, CreateEpisodeResponses, CreateMediaData, CreateMediaErrors, CreateMediaResponses, CreateSegmentData, CreateSegmentErrors, CreateSegmentResponses, CreateSeriesData, CreateSeriesErrors, CreateSeriesResponses, CreateUserReportData, CreateUserReportErrors, CreateUserReportResponses, DeleteAdminReviewAllowlistEntryData, DeleteAdminReviewAllowlistEntryErrors, DeleteAdminReviewAllowlistEntryResponses, DeleteCollectionData, DeleteCollectionErrors, DeleteCollectionResponses, DeleteEpisodeData, DeleteEpisodeErrors, DeleteEpisodeResponses, DeleteMediaData, DeleteMediaErrors, DeleteMediaResponses, DeleteSegmentData, DeleteSegmentErrors, DeleteSegmentResponses, DeleteSeriesData, DeleteSeriesErrors, DeleteSeriesResponses, DeleteUserActivityData, DeleteUserActivityErrors, DeleteUserActivityResponses, ExportUserDataData, ExportUserDataErrors, ExportUserDataResponses, GetAdminDashboardData, GetAdminDashboardErrors, GetAdminDashboardResponses, GetAdminHealthData, GetAdminHealthErrors, GetAdminHealthResponses, GetAdminQueueData, GetAdminQueueErrors, GetAdminQueueResponses, GetAdminReviewRunData, GetAdminReviewRunErrors, GetAdminReviewRunResponses, GetCharacterData, GetCharacterErrors, GetCharacterResponses, GetCollectionData, GetCollectionErrors, GetCollectionResponses, GetEpisodeData, GetEpisodeErrors, GetEpisodeResponses, GetMediaData, GetMediaErrors, GetMediaResponses, GetSearchStatsData, GetSearchStatsErrors, GetSearchStatsResponses, GetSegmentByUuidData, GetSegmentByUuidErrors, GetSegmentByUuidResponses, GetSegmentContextData, GetSegmentContextErrors, GetSegmentContextResponses, GetSegmentData, GetSegmentErrors, GetSegmentResponses, GetSeiyuuData, GetSeiyuuErrors, GetSeiyuuResponses, GetSeriesData, GetSeriesErrors, GetSeriesResponses, GetUserActivityHeatmapData, GetUserActivityHeatmapErrors, GetUserActivityHeatmapResponses, GetUserActivityStatsData, GetUserActivityStatsErrors, GetUserActivityStatsResponses, GetUserPreferencesData, GetUserPreferencesErrors, GetUserPreferencesResponses, GetUserQuotaData, GetUserQuotaErrors, GetUserQuotaResponses, ListAdminQueueFailedData, ListAdminQueueFailedErrors, ListAdminQueueFailedResponses, ListAdminQueueStatsData, ListAdminQueueStatsErrors, ListAdminQueueStatsResponses, ListAdminReportsData, ListAdminReportsErrors, ListAdminReportsResponses, ListAdminReviewAllowlistData, ListAdminReviewAllowlistErrors, ListAdminReviewAllowlistResponses, ListAdminReviewChecksData, ListAdminReviewChecksErrors, ListAdminReviewChecksResponses, ListAdminReviewRunsData, ListAdminReviewRunsErrors, ListAdminReviewRunsResponses, ListCollectionsData, ListCollectionsErrors, ListCollectionsResponses, ListEpisodesData, ListEpisodesErrors, ListEpisodesResponses, ListMediaData, ListMediaErrors, ListMediaResponses, ListSegmentsData, ListSegmentsErrors, ListSegmentsResponses, ListSeriesData, ListSeriesErrors, ListSeriesResponses, ListUserActivityData, ListUserActivityErrors, ListUserActivityResponses, ListUserLabsData, ListUserLabsErrors, ListUserLabsResponses, ListUserReportsData, ListUserReportsErrors, ListUserReportsResponses, PurgeAdminQueueFailedData, PurgeAdminQueueFailedErrors, PurgeAdminQueueFailedResponses, RemoveMediaFromSeriesData, RemoveMediaFromSeriesErrors, RemoveMediaFromSeriesResponses, RemoveSegmentFromCollectionData, RemoveSegmentFromCollectionErrors, RemoveSegmentFromCollectionResponses, RetryAdminQueueFailedData, RetryAdminQueueFailedErrors, RetryAdminQueueFailedResponses, RunAdminReviewData, RunAdminReviewErrors, RunAdminReviewResponses, SearchData, SearchErrors, SearchResponses, SearchWordsData, SearchWordsErrors, SearchWordsResponses, TriggerReindexData, TriggerReindexErrors, TriggerReindexResponses, UpdateAdminReportData, UpdateAdminReportErrors, UpdateAdminReportResponses, UpdateAdminReviewCheckData, UpdateAdminReviewCheckErrors, UpdateAdminReviewCheckResponses, UpdateCollectionData, UpdateCollectionErrors, UpdateCollectionResponses, UpdateCollectionSegmentData, UpdateCollectionSegmentErrors, UpdateCollectionSegmentResponses, UpdateEpisodeData, UpdateEpisodeErrors, UpdateEpisodeResponses, UpdateMediaData, UpdateMediaErrors, UpdateMediaResponses, UpdateSegmentData, UpdateSegmentErrors, UpdateSegmentResponses, UpdateSeriesData, UpdateSeriesErrors, UpdateSeriesMediaData, UpdateSeriesMediaErrors, UpdateSeriesMediaResponses, UpdateSeriesResponses, UpdateUserPreferencesData, UpdateUserPreferencesErrors, UpdateUserPreferencesResponses } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -13,16 +13,6 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
13
13
  */
14
14
  meta?: Record<string, unknown>;
15
15
  };
16
- /**
17
- * Health check
18
- *
19
- * Tests the search service connectivity and functionality by performing a simple search query.
20
- *
21
- * **Requirements:**
22
- * - Required Scopes: `READ_MEDIA`
23
- *
24
- */
25
- export declare const healthCheck: <ThrowOnError extends boolean = false>(options?: Options<HealthCheckData, ThrowOnError>) => import("./client").RequestResult<HealthCheckResponses, HealthCheckErrors, ThrowOnError, "fields">;
26
16
  /**
27
17
  * Search segments by query
28
18
  *
@@ -45,11 +35,10 @@ export declare const healthCheck: <ThrowOnError extends boolean = false>(options
45
35
  * | **Kana** (`たべる`, `かのじょ`) | Standard search across content, base form, and reading form |
46
36
  * | **English/Spanish** | Direct translation search |
47
37
  *
48
- * **Requirements**
49
- * - API Key with `READ_MEDIA` permission
38
+ * **Permissions:** `READ_MEDIA`
50
39
  *
51
40
  */
52
- export declare const searchSegments: <ThrowOnError extends boolean = false>(options?: Options<SearchSegmentsData, ThrowOnError>) => import("./client").RequestResult<SearchSegmentsResponses, SearchSegmentsErrors, ThrowOnError, "fields">;
41
+ export declare const search: <ThrowOnError extends boolean = false>(options?: Options<SearchData, ThrowOnError>) => import("./client").RequestResult<SearchResponses, SearchErrors, ThrowOnError, "fields">;
53
42
  /**
54
43
  * Get search statistics
55
44
  *
@@ -61,8 +50,7 @@ export declare const searchSegments: <ThrowOnError extends boolean = false>(opti
61
50
  *
62
51
  * The stats are scoped by query and category filters, but are not narrowed by a selected media/episode.
63
52
  *
64
- * **Requirements**
65
- * - API Key with `READ_MEDIA` permission
53
+ * **Permissions:** `READ_MEDIA`
66
54
  *
67
55
  */
68
56
  export declare const getSearchStats: <ThrowOnError extends boolean = false>(options?: Options<GetSearchStatsData, ThrowOnError>) => import("./client").RequestResult<GetSearchStatsResponses, GetSearchStatsErrors, ThrowOnError, "fields">;
@@ -78,171 +66,246 @@ export declare const getSearchStats: <ThrowOnError extends boolean = false>(opti
78
66
  * - Finding anime/dramas that use specific words
79
67
  * - Comparing word usage across different titles
80
68
  *
81
- * **Requirements:**
82
- * - Required Scopes: `READ_MEDIA`
69
+ * **Permissions:** `READ_MEDIA`
83
70
  *
84
71
  */
85
72
  export declare const searchWords: <ThrowOnError extends boolean = false>(options: Options<SearchWordsData, ThrowOnError>) => import("./client").RequestResult<SearchWordsResponses, SearchWordsErrors, ThrowOnError, "fields">;
86
- /**
87
- * Get context for a segment
88
- *
89
- * Retrieves segments surrounding a specific segment position within an episode.
90
- * Returns segments both before and after the target position, providing context for understanding how a sentence is used in dialogue.
91
- *
92
- * **Requirements:**
93
- * - Required scopes: `READ_MEDIA`
94
- *
95
- */
96
- export declare const getSegmentContext: <ThrowOnError extends boolean = false>(options: Options<GetSegmentContextData, ThrowOnError>) => import("./client").RequestResult<GetSegmentContextResponses, GetSegmentContextErrors, ThrowOnError, "fields">;
97
- /**
98
- * Browse media library
99
- *
100
- * Lists available media with metadata and supports filtering by type and search query.
101
- *
102
- * Returns paginated results with comprehensive media information including cover/banner images, episode counts, and genres.
103
- *
104
- * **Use Cases**
105
- * - Browsing the media library
106
- * - Getting media metadata for display
107
- *
108
- * **Requirements:**
109
- * - Required Scopes: `READ_MEDIA`
110
- *
111
- */
112
- export declare const browseMedia: <ThrowOnError extends boolean = false>(options?: Options<BrowseMediaData, ThrowOnError>) => import("./client").RequestResult<BrowseMediaResponses, BrowseMediaErrors, ThrowOnError, "fields">;
113
73
  /**
114
74
  * List all media
115
75
  *
116
76
  * Returns a paginated list of media with full metadata, including cover/banner images, episode counts, and genres.
77
+ * Supports filtering by category and text search.
78
+ *
79
+ * **Permissions:** `READ_MEDIA`
117
80
  *
118
81
  */
119
- export declare const mediaIndex: <ThrowOnError extends boolean = false>(options?: Options<MediaIndexData, ThrowOnError>) => import("./client").RequestResult<MediaIndexResponses, MediaIndexErrors, ThrowOnError, "fields">;
82
+ export declare const listMedia: <ThrowOnError extends boolean = false>(options?: Options<ListMediaData, ThrowOnError>) => import("./client").RequestResult<ListMediaResponses, ListMediaErrors, ThrowOnError, "fields">;
120
83
  /**
121
84
  * Create new media
122
85
  *
123
86
  * Creates a new media entry in the database.
124
87
  *
88
+ * **Permissions:** `ADD_MEDIA`
89
+ *
125
90
  */
126
- export declare const mediaCreate: <ThrowOnError extends boolean = false>(options: Options<MediaCreateData, ThrowOnError>) => import("./client").RequestResult<MediaCreateResponses, MediaCreateErrors, ThrowOnError, "fields">;
91
+ export declare const createMedia: <ThrowOnError extends boolean = false>(options: Options<CreateMediaData, ThrowOnError>) => import("./client").RequestResult<CreateMediaResponses, CreateMediaErrors, ThrowOnError, "fields">;
127
92
  /**
128
93
  * Delete media (soft delete)
129
94
  *
130
- * Soft deletes a media entry by setting the `deletedAt` timestamp. The media is not removed from the database but is excluded from query results.
95
+ * Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
96
+ *
97
+ * **Permissions:** `REMOVE_MEDIA`
131
98
  *
132
99
  */
133
- export declare const mediaDestroy: <ThrowOnError extends boolean = false>(options: Options<MediaDestroyData, ThrowOnError>) => import("./client").RequestResult<MediaDestroyResponses, MediaDestroyErrors, ThrowOnError, "fields">;
100
+ export declare const deleteMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError, "fields">;
134
101
  /**
135
102
  * Get single media
136
103
  *
137
- * Retrieves a single media entry by its ID.
104
+ * Returns a single media entry by its ID with full metadata.
105
+ *
106
+ * **Permissions:** `READ_MEDIA`
138
107
  *
139
108
  */
140
- export declare const mediaShow: <ThrowOnError extends boolean = false>(options: Options<MediaShowData, ThrowOnError>) => import("./client").RequestResult<MediaShowResponses, MediaShowErrors, ThrowOnError, "fields">;
109
+ export declare const getMedia: <ThrowOnError extends boolean = false>(options: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, GetMediaErrors, ThrowOnError, "fields">;
141
110
  /**
142
111
  * Update media
143
112
  *
144
- * Updates an existing media entry. All fields are optional - only provided fields will be updated.
113
+ * Updates an existing media entry. Only provided fields will be updated.
114
+ *
115
+ * **Permissions:** `UPDATE_MEDIA`
145
116
  *
146
117
  */
147
- export declare const mediaUpdate: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateData, ThrowOnError>) => import("./client").RequestResult<MediaUpdateResponses, MediaUpdateErrors, ThrowOnError, "fields">;
118
+ export declare const updateMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError, "fields">;
148
119
  /**
149
120
  * List episodes for a media
150
121
  *
151
- * Get a paginated list of episodes for a specific media
122
+ * Returns a paginated list of episodes for a specific media.
123
+ *
124
+ * **Permissions:** `READ_MEDIA`
152
125
  *
153
126
  */
154
- export declare const episodeIndex: <ThrowOnError extends boolean = false>(options: Options<EpisodeIndexData, ThrowOnError>) => import("./client").RequestResult<EpisodeIndexResponses, EpisodeIndexErrors, ThrowOnError, "fields">;
127
+ export declare const listEpisodes: <ThrowOnError extends boolean = false>(options: Options<ListEpisodesData, ThrowOnError>) => import("./client").RequestResult<ListEpisodesResponses, ListEpisodesErrors, ThrowOnError, "fields">;
155
128
  /**
156
129
  * Create new episode
157
130
  *
158
- * Create a new episode for a specific media
131
+ * Creates a new episode for a specific media.
132
+ *
133
+ * **Permissions:** `ADD_MEDIA`
159
134
  *
160
135
  */
161
- export declare const episodeCreate: <ThrowOnError extends boolean = false>(options: Options<EpisodeCreateData, ThrowOnError>) => import("./client").RequestResult<EpisodeCreateResponses, EpisodeCreateErrors, ThrowOnError, "fields">;
136
+ export declare const createEpisode: <ThrowOnError extends boolean = false>(options: Options<CreateEpisodeData, ThrowOnError>) => import("./client").RequestResult<CreateEpisodeResponses, CreateEpisodeErrors, ThrowOnError, "fields">;
162
137
  /**
163
138
  * Delete an episode
164
139
  *
165
- * Soft delete an episode. Segments are not cascade deleted, this only "hides" the episode.
140
+ * Soft-deletes an episode. Segments are not cascade deleted this only hides the episode from results.
141
+ *
142
+ * **Permissions:** `REMOVE_MEDIA`
166
143
  *
167
144
  */
168
- export declare const episodeDestroy: <ThrowOnError extends boolean = false>(options: Options<EpisodeDestroyData, ThrowOnError>) => import("./client").RequestResult<EpisodeDestroyResponses, EpisodeDestroyErrors, ThrowOnError, "fields">;
145
+ export declare const deleteEpisode: <ThrowOnError extends boolean = false>(options: Options<DeleteEpisodeData, ThrowOnError>) => import("./client").RequestResult<DeleteEpisodeResponses, DeleteEpisodeErrors, ThrowOnError, "fields">;
169
146
  /**
170
147
  * Get single episode
171
148
  *
172
- * Get a specific episode by media ID and episode number
149
+ * Returns a specific episode by media ID and episode number.
150
+ *
151
+ * **Permissions:** `READ_MEDIA`
173
152
  *
174
153
  */
175
- export declare const episodeShow: <ThrowOnError extends boolean = false>(options: Options<EpisodeShowData, ThrowOnError>) => import("./client").RequestResult<EpisodeShowResponses, EpisodeShowErrors, ThrowOnError, "fields">;
154
+ export declare const getEpisode: <ThrowOnError extends boolean = false>(options: Options<GetEpisodeData, ThrowOnError>) => import("./client").RequestResult<GetEpisodeResponses, GetEpisodeErrors, ThrowOnError, "fields">;
176
155
  /**
177
156
  * Update episode
178
157
  *
179
- * Update an existing episode with partial data
158
+ * Updates an existing episode. Only provided fields will be updated.
159
+ *
160
+ * **Permissions:** `UPDATE_MEDIA`
180
161
  *
181
162
  */
182
- export declare const episodeUpdate: <ThrowOnError extends boolean = false>(options: Options<EpisodeUpdateData, ThrowOnError>) => import("./client").RequestResult<EpisodeUpdateResponses, EpisodeUpdateErrors, ThrowOnError, "fields">;
163
+ export declare const updateEpisode: <ThrowOnError extends boolean = false>(options: Options<UpdateEpisodeData, ThrowOnError>) => import("./client").RequestResult<UpdateEpisodeResponses, UpdateEpisodeErrors, ThrowOnError, "fields">;
183
164
  /**
184
165
  * List segments for an episode
185
166
  *
186
- * Get a paginated list of segments for a specific episode
167
+ * Returns a paginated list of segments for a specific episode.
168
+ *
169
+ * **Permissions:** `READ_MEDIA`
187
170
  *
188
171
  */
189
- export declare const segmentIndex: <ThrowOnError extends boolean = false>(options: Options<SegmentIndexData, ThrowOnError>) => import("./client").RequestResult<SegmentIndexResponses, SegmentIndexErrors, ThrowOnError, "fields">;
172
+ export declare const listSegments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError, "fields">;
190
173
  /**
191
174
  * Create new segment
192
175
  *
193
- * Create a new segment for a specific episode
176
+ * Creates a new segment for a specific episode.
177
+ *
178
+ * **Permissions:** `UPDATE_MEDIA`
194
179
  *
195
180
  */
196
- export declare const segmentCreate: <ThrowOnError extends boolean = false>(options: Options<SegmentCreateData, ThrowOnError>) => import("./client").RequestResult<SegmentCreateResponses, SegmentCreateErrors, ThrowOnError, "fields">;
181
+ export declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError, "fields">;
197
182
  /**
198
- * Delete segment (set status to deleted)
183
+ * Delete segment
184
+ *
185
+ * Soft-deletes a segment by setting its status to DELETED.
199
186
  *
200
- * Delete a segment by setting its status to 0 (DELETED)
187
+ * **Permissions:** `REMOVE_MEDIA`
201
188
  *
202
189
  */
203
- export declare const segmentDestroy: <ThrowOnError extends boolean = false>(options: Options<SegmentDestroyData, ThrowOnError>) => import("./client").RequestResult<SegmentDestroyResponses, SegmentDestroyErrors, ThrowOnError, "fields">;
190
+ export declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => import("./client").RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError, "fields">;
204
191
  /**
205
192
  * Get single segment
206
193
  *
207
- * Get a specific segment by ID
194
+ * Returns a specific segment by its ID within the media/episode hierarchy.
195
+ *
196
+ * **Permissions:** `READ_MEDIA`
208
197
  *
209
198
  */
210
- export declare const segmentShow: <ThrowOnError extends boolean = false>(options: Options<SegmentShowData, ThrowOnError>) => import("./client").RequestResult<SegmentShowResponses, SegmentShowErrors, ThrowOnError, "fields">;
199
+ export declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => import("./client").RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError, "fields">;
211
200
  /**
212
201
  * Update segment
213
202
  *
214
- * Update an existing segment with partial data
203
+ * Updates an existing segment. Only provided fields will be updated.
204
+ *
205
+ * **Permissions:** `UPDATE_MEDIA`
215
206
  *
216
207
  */
217
- export declare const segmentUpdate: <ThrowOnError extends boolean = false>(options: Options<SegmentUpdateData, ThrowOnError>) => import("./client").RequestResult<SegmentUpdateResponses, SegmentUpdateErrors, ThrowOnError, "fields">;
208
+ export declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError, "fields">;
218
209
  /**
219
210
  * Get segment by UUID
220
211
  *
221
- * Get a specific segment by its UUID
212
+ * Returns a specific segment by its UUID. A shortcut alternative to the nested `/media/{mediaId}/episodes/{episodeNumber}/segments/{id}` path.
213
+ *
214
+ * **Permissions:** `READ_MEDIA`
222
215
  *
223
216
  */
224
- export declare const segmentShowByUuid: <ThrowOnError extends boolean = false>(options: Options<SegmentShowByUuidData, ThrowOnError>) => import("./client").RequestResult<SegmentShowByUuidResponses, SegmentShowByUuidErrors, ThrowOnError, "fields">;
217
+ export declare const getSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<GetSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<GetSegmentByUuidResponses, GetSegmentByUuidErrors, ThrowOnError, "fields">;
218
+ /**
219
+ * Get surrounding context for a segment
220
+ *
221
+ * Retrieves segments surrounding a specific segment within an episode.
222
+ * Returns segments both before and after the target, providing dialogue context for how a sentence is used.
223
+ *
224
+ * **Permissions:** `READ_MEDIA`
225
+ *
226
+ */
227
+ export declare const getSegmentContext: <ThrowOnError extends boolean = false>(options: Options<GetSegmentContextData, ThrowOnError>) => import("./client").RequestResult<GetSegmentContextResponses, GetSegmentContextErrors, ThrowOnError, "fields">;
228
+ /**
229
+ * List all series
230
+ *
231
+ * Returns a paginated list of media series groupings.
232
+ *
233
+ */
234
+ export declare const listSeries: <ThrowOnError extends boolean = false>(options?: Options<ListSeriesData, ThrowOnError>) => import("./client").RequestResult<ListSeriesResponses, ListSeriesErrors, ThrowOnError, "fields">;
235
+ /**
236
+ * Create series
237
+ *
238
+ * Creates a new media series grouping.
239
+ *
240
+ */
241
+ export declare const createSeries: <ThrowOnError extends boolean = false>(options: Options<CreateSeriesData, ThrowOnError>) => import("./client").RequestResult<CreateSeriesResponses, CreateSeriesErrors, ThrowOnError, "fields">;
242
+ /**
243
+ * Delete series
244
+ *
245
+ * Deletes a series and all its media associations.
246
+ *
247
+ */
248
+ export declare const deleteSeries: <ThrowOnError extends boolean = false>(options: Options<DeleteSeriesData, ThrowOnError>) => import("./client").RequestResult<DeleteSeriesResponses, DeleteSeriesErrors, ThrowOnError, "fields">;
249
+ /**
250
+ * Get series details
251
+ *
252
+ * Returns a series with all media entries sorted by position.
253
+ *
254
+ */
255
+ export declare const getSeries: <ThrowOnError extends boolean = false>(options: Options<GetSeriesData, ThrowOnError>) => import("./client").RequestResult<GetSeriesResponses, GetSeriesErrors, ThrowOnError, "fields">;
256
+ /**
257
+ * Update series metadata
258
+ *
259
+ * Updates series localized names.
260
+ *
261
+ */
262
+ export declare const updateSeries: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesResponses, UpdateSeriesErrors, ThrowOnError, "fields">;
263
+ /**
264
+ * Add media to series
265
+ *
266
+ * Adds a media entry to a series at a specific position.
267
+ *
268
+ */
269
+ export declare const addMediaToSeries: <ThrowOnError extends boolean = false>(options: Options<AddMediaToSeriesData, ThrowOnError>) => import("./client").RequestResult<AddMediaToSeriesResponses, AddMediaToSeriesErrors, ThrowOnError, "fields">;
270
+ /**
271
+ * Remove media from series
272
+ *
273
+ * Removes a media entry from a series.
274
+ *
275
+ */
276
+ export declare const removeMediaFromSeries: <ThrowOnError extends boolean = false>(options: Options<RemoveMediaFromSeriesData, ThrowOnError>) => import("./client").RequestResult<RemoveMediaFromSeriesResponses, RemoveMediaFromSeriesErrors, ThrowOnError, "fields">;
277
+ /**
278
+ * Update media position in series
279
+ *
280
+ * Updates the position of a media entry in a series.
281
+ *
282
+ */
283
+ export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesMediaResponses, UpdateSeriesMediaErrors, ThrowOnError, "fields">;
225
284
  /**
226
285
  * Get character details
227
286
  *
228
- * Returns a character with their seiyuu and all media appearances.
287
+ * Returns a character with their voice actors (seiyuu) and all media appearances.
288
+ *
289
+ * **Permissions:** `READ_MEDIA`
229
290
  *
230
291
  */
231
- export declare const characterShow: <ThrowOnError extends boolean = false>(options: Options<CharacterShowData, ThrowOnError>) => import("./client").RequestResult<CharacterShowResponses, CharacterShowErrors, ThrowOnError, "fields">;
292
+ export declare const getCharacter: <ThrowOnError extends boolean = false>(options: Options<GetCharacterData, ThrowOnError>) => import("./client").RequestResult<GetCharacterResponses, GetCharacterErrors, ThrowOnError, "fields">;
232
293
  /**
233
294
  * Get seiyuu details
234
295
  *
235
- * Returns a voice actor with all characters they voiced and media appearances.
296
+ * Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
297
+ *
298
+ * **Permissions:** `READ_MEDIA`
236
299
  *
237
300
  */
238
- export declare const seiyuuShow: <ThrowOnError extends boolean = false>(options: Options<SeiyuuShowData, ThrowOnError>) => import("./client").RequestResult<SeiyuuShowResponses, SeiyuuShowErrors, ThrowOnError, "fields">;
301
+ export declare const getSeiyuu: <ThrowOnError extends boolean = false>(options: Options<GetSeiyuuData, ThrowOnError>) => import("./client").RequestResult<GetSeiyuuResponses, GetSeiyuuErrors, ThrowOnError, "fields">;
239
302
  /**
240
303
  * Get current monthly API quota
241
304
  *
242
- * Returns the authenticated user's API quota usage for the current billing period.
305
+ * Returns the API quota usage for the current billing period.
306
+ * Accepts both session cookie and API key authentication.
243
307
  *
244
- * **Requirements:**
245
- * - Requires session authentication (cookie-based).
308
+ * **Permissions:** Session authentication (cookie-based) or API key (`READ_MEDIA`).
246
309
  *
247
310
  */
248
311
  export declare const getUserQuota: <ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError, "fields">;
@@ -251,221 +314,347 @@ export declare const getUserQuota: <ThrowOnError extends boolean = false>(option
251
314
  *
252
315
  * Returns the authenticated user's submitted reports with cursor pagination.
253
316
  *
254
- * **Requirements:**
255
- * - Requires session authentication (cookie-based).
317
+ * **Permissions:** Session authentication (cookie-based).
256
318
  *
257
319
  */
258
- export declare const getUserReports: <ThrowOnError extends boolean = false>(options?: Options<GetUserReportsData, ThrowOnError>) => import("./client").RequestResult<GetUserReportsResponses, GetUserReportsErrors, ThrowOnError, "fields">;
320
+ export declare const listUserReports: <ThrowOnError extends boolean = false>(options?: Options<ListUserReportsData, ThrowOnError>) => import("./client").RequestResult<ListUserReportsResponses, ListUserReportsErrors, ThrowOnError, "fields">;
259
321
  /**
260
322
  * Create a new report
261
323
  *
262
324
  * Submit a report for a segment or media entry.
263
325
  *
264
- * **Requirements:**
265
- * - Requires session authentication (cookie-based).
326
+ * **Permissions:** Session authentication (cookie-based).
327
+ *
328
+ */
329
+ export declare const createUserReport: <ThrowOnError extends boolean = false>(options: Options<CreateUserReportData, ThrowOnError>) => import("./client").RequestResult<CreateUserReportResponses, CreateUserReportErrors, ThrowOnError, "fields">;
330
+ /**
331
+ * Get user preferences
332
+ *
333
+ * Returns the authenticated user's full preferences object.
334
+ *
335
+ * **Permissions:** Session authentication (cookie-based).
336
+ *
337
+ */
338
+ export declare const getUserPreferences: <ThrowOnError extends boolean = false>(options?: Options<GetUserPreferencesData, ThrowOnError>) => import("./client").RequestResult<GetUserPreferencesResponses, GetUserPreferencesErrors, ThrowOnError, "fields">;
339
+ /**
340
+ * Update user preferences
341
+ *
342
+ * Deep-merges a partial preferences update into the user's existing preferences.
343
+ * Only the provided keys are updated; all other keys are preserved.
344
+ *
345
+ * **Permissions:** Session authentication (cookie-based).
346
+ *
347
+ */
348
+ export declare const updateUserPreferences: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPreferencesData, ThrowOnError>) => import("./client").RequestResult<UpdateUserPreferencesResponses, UpdateUserPreferencesErrors, ThrowOnError, "fields">;
349
+ /**
350
+ * Clear user activity history
351
+ *
352
+ * Deletes the authenticated user's activity history. Optionally filter by activity type.
353
+ *
354
+ * **Permissions:** Session authentication (cookie-based).
355
+ *
356
+ */
357
+ export declare const deleteUserActivity: <ThrowOnError extends boolean = false>(options?: Options<DeleteUserActivityData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityResponses, DeleteUserActivityErrors, ThrowOnError, "fields">;
358
+ /**
359
+ * Get user activity history
360
+ *
361
+ * Returns the authenticated user's activity history with cursor-based pagination.
362
+ *
363
+ * **Permissions:** Session authentication (cookie-based).
364
+ *
365
+ */
366
+ export declare const listUserActivity: <ThrowOnError extends boolean = false>(options?: Options<ListUserActivityData, ThrowOnError>) => import("./client").RequestResult<ListUserActivityResponses, ListUserActivityErrors, ThrowOnError, "fields">;
367
+ /**
368
+ * Get activity heatmap data
369
+ *
370
+ * Returns daily activity counts for the authenticated user, grouped by date.
371
+ * Designed for rendering a GitHub-style contribution heatmap.
372
+ *
373
+ * **Permissions:** Session authentication (cookie-based).
374
+ *
375
+ */
376
+ export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityHeatmapData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityHeatmapResponses, GetUserActivityHeatmapErrors, ThrowOnError, "fields">;
377
+ /**
378
+ * Get user activity statistics
379
+ *
380
+ * Returns aggregate statistics about the authenticated user's activity:
381
+ * total searches, exports, plays, and study streak.
382
+ *
383
+ * **Permissions:** Session authentication (cookie-based).
266
384
  *
267
385
  */
268
- export declare const createReport: <ThrowOnError extends boolean = false>(options: Options<CreateReportData, ThrowOnError>) => import("./client").RequestResult<CreateReportResponses, CreateReportErrors, ThrowOnError, "fields">;
386
+ export declare const getUserActivityStats: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityStatsData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityStatsResponses, GetUserActivityStatsErrors, ThrowOnError, "fields">;
269
387
  /**
270
- * List all lists
388
+ * Export all user data
389
+ *
390
+ * Returns a full JSON export of all user-related data for GDPR data portability.
391
+ * Includes profile, preferences, activity history, collections, and reports.
271
392
  *
272
- * Returns all lists matching the query filters. Can filter by media ID to find lists containing a specific media. Public lists are visible to all users.
393
+ * **Permissions:** Session authentication (cookie-based).
273
394
  *
274
395
  */
275
- export declare const listIndex: <ThrowOnError extends boolean = false>(options?: Options<ListIndexData, ThrowOnError>) => import("./client").RequestResult<ListIndexResponses, ListIndexErrors, ThrowOnError, "fields">;
396
+ export declare const exportUserData: <ThrowOnError extends boolean = false>(options?: Options<ExportUserDataData, ThrowOnError>) => import("./client").RequestResult<ExportUserDataResponses, ExportUserDataErrors, ThrowOnError, "fields">;
276
397
  /**
277
- * Create new list
398
+ * List lab features with user opt-in status
399
+ *
400
+ * Returns all available lab features merged with the authenticated user's
401
+ * opt-in status. Features gated by role are excluded if the user lacks
402
+ * the required role.
278
403
  *
279
- * Creates a new standalone list. Requires admin permissions.
404
+ * **Permissions:** Session authentication (cookie-based).
280
405
  *
281
406
  */
282
- export declare const listCreate: <ThrowOnError extends boolean = false>(options: Options<ListCreateData, ThrowOnError>) => import("./client").RequestResult<ListCreateResponses, ListCreateErrors, ThrowOnError, "fields">;
407
+ export declare const listUserLabs: <ThrowOnError extends boolean = false>(options?: Options<ListUserLabsData, ThrowOnError>) => import("./client").RequestResult<ListUserLabsResponses, ListUserLabsErrors, ThrowOnError, "fields">;
283
408
  /**
284
- * Delete list
409
+ * List user's collections
285
410
  *
286
- * Deletes a list and all its items. Requires admin permissions.
411
+ * Returns all collections for the authenticated user. Can filter by visibility.
287
412
  *
288
413
  */
289
- export declare const listDestroy: <ThrowOnError extends boolean = false>(options: Options<ListDestroyData, ThrowOnError>) => import("./client").RequestResult<ListDestroyResponses, ListDestroyErrors, ThrowOnError, "fields">;
414
+ export declare const listCollections: <ThrowOnError extends boolean = false>(options?: Options<ListCollectionsData, ThrowOnError>) => import("./client").RequestResult<ListCollectionsResponses, ListCollectionsErrors, ThrowOnError, "fields">;
290
415
  /**
291
- * Get list details
416
+ * Create collection
292
417
  *
293
- * Returns a list with all media in order (sorted by position).
418
+ * Creates a new segment collection for the authenticated user.
294
419
  *
295
420
  */
296
- export declare const listShow: <ThrowOnError extends boolean = false>(options: Options<ListShowData, ThrowOnError>) => import("./client").RequestResult<ListShowResponses, ListShowErrors, ThrowOnError, "fields">;
421
+ export declare const createCollection: <ThrowOnError extends boolean = false>(options: Options<CreateCollectionData, ThrowOnError>) => import("./client").RequestResult<CreateCollectionResponses, CreateCollectionErrors, ThrowOnError, "fields">;
297
422
  /**
298
- * Update list metadata
423
+ * Delete collection
299
424
  *
300
- * Updates list name or visibility. Requires admin permissions.
425
+ * Deletes a collection and all its segment entries. Requires collection ownership.
301
426
  *
302
427
  */
303
- export declare const listUpdate: <ThrowOnError extends boolean = false>(options: Options<ListUpdateData, ThrowOnError>) => import("./client").RequestResult<ListUpdateResponses, ListUpdateErrors, ThrowOnError, "fields">;
428
+ export declare const deleteCollection: <ThrowOnError extends boolean = false>(options: Options<DeleteCollectionData, ThrowOnError>) => import("./client").RequestResult<DeleteCollectionResponses, DeleteCollectionErrors, ThrowOnError, "fields">;
304
429
  /**
305
- * Add media to list
430
+ * Get collection details
306
431
  *
307
- * Adds a media entry to the list at the specified position. Requires admin permissions.
432
+ * Returns a collection with paginated segments and their search result data.
308
433
  *
309
434
  */
310
- export declare const listAddItem: <ThrowOnError extends boolean = false>(options: Options<ListAddItemData, ThrowOnError>) => import("./client").RequestResult<ListAddItemResponses, ListAddItemErrors, ThrowOnError, "fields">;
435
+ export declare const getCollection: <ThrowOnError extends boolean = false>(options: Options<GetCollectionData, ThrowOnError>) => import("./client").RequestResult<GetCollectionResponses, GetCollectionErrors, ThrowOnError, "fields">;
311
436
  /**
312
- * Remove media from list
437
+ * Update collection metadata
313
438
  *
314
- * Removes a media entry from the list. Requires admin permissions.
439
+ * Updates collection name or visibility. Requires collection ownership.
315
440
  *
316
441
  */
317
- export declare const listRemoveItem: <ThrowOnError extends boolean = false>(options: Options<ListRemoveItemData, ThrowOnError>) => import("./client").RequestResult<ListRemoveItemResponses, ListRemoveItemErrors, ThrowOnError, "fields">;
442
+ export declare const updateCollection: <ThrowOnError extends boolean = false>(options: Options<UpdateCollectionData, ThrowOnError>) => import("./client").RequestResult<UpdateCollectionResponses, UpdateCollectionErrors, ThrowOnError, "fields">;
318
443
  /**
319
- * Update media position in list
444
+ * Add segment to collection
320
445
  *
321
- * Updates the position of a media entry within the list. Requires admin permissions.
446
+ * Adds a segment to a collection. Requires collection ownership.
322
447
  *
323
448
  */
324
- export declare const listUpdateItem: <ThrowOnError extends boolean = false>(options: Options<ListUpdateItemData, ThrowOnError>) => import("./client").RequestResult<ListUpdateItemResponses, ListUpdateItemErrors, ThrowOnError, "fields">;
449
+ export declare const addSegmentToCollection: <ThrowOnError extends boolean = false>(options: Options<AddSegmentToCollectionData, ThrowOnError>) => import("./client").RequestResult<AddSegmentToCollectionResponses, AddSegmentToCollectionErrors, ThrowOnError, "fields">;
325
450
  /**
326
- * Get segments in list
451
+ * Remove segment from collection
327
452
  *
328
- * Returns paginated segments in a segment list with full search result data.
453
+ * Removes a segment from a collection. Requires collection ownership.
329
454
  *
330
455
  */
331
- export declare const listGetSegments: <ThrowOnError extends boolean = false>(options: Options<ListGetSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListGetSegmentsResponses, ListGetSegmentsErrors, ThrowOnError, "fields">;
456
+ export declare const removeSegmentFromCollection: <ThrowOnError extends boolean = false>(options: Options<RemoveSegmentFromCollectionData, ThrowOnError>) => import("./client").RequestResult<RemoveSegmentFromCollectionResponses, RemoveSegmentFromCollectionErrors, ThrowOnError, "fields">;
332
457
  /**
333
- * Add segment to list
458
+ * Update segment in collection
334
459
  *
335
- * Adds a segment to a segment list. Requires list ownership or admin.
460
+ * Updates the note or position of a segment in a collection. Requires collection ownership.
336
461
  *
337
462
  */
338
- export declare const listAddSegment: <ThrowOnError extends boolean = false>(options: Options<ListAddSegmentData, ThrowOnError>) => import("./client").RequestResult<ListAddSegmentResponses, ListAddSegmentErrors, ThrowOnError, "fields">;
463
+ export declare const updateCollectionSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateCollectionSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateCollectionSegmentResponses, UpdateCollectionSegmentErrors, ThrowOnError, "fields">;
339
464
  /**
340
- * Remove segment from list
465
+ * Admin dashboard statistics
341
466
  *
342
- * Removes a segment from a list. Requires list ownership or admin.
467
+ * Returns at-a-glance statistics for the admin dashboard including media counts,
468
+ * user counts, and system health information.
469
+ *
470
+ * **Permissions:** `ADD_MEDIA`
343
471
  *
344
472
  */
345
- export declare const listRemoveSegment: <ThrowOnError extends boolean = false>(options: Options<ListRemoveSegmentData, ThrowOnError>) => import("./client").RequestResult<ListRemoveSegmentResponses, ListRemoveSegmentErrors, ThrowOnError, "fields">;
473
+ export declare const getAdminDashboard: <ThrowOnError extends boolean = false>(options?: Options<GetAdminDashboardData, ThrowOnError>) => import("./client").RequestResult<GetAdminDashboardResponses, GetAdminDashboardErrors, ThrowOnError, "fields">;
346
474
  /**
347
- * Update segment in list
475
+ * System health check
476
+ *
477
+ * Returns connectivity status and version information for all backend subsystems
478
+ * (Elasticsearch, PostgreSQL, application).
348
479
  *
349
- * Updates the note or position of a segment in a list. Requires list ownership or admin.
480
+ * **Permissions:** `ADD_MEDIA`
350
481
  *
351
482
  */
352
- export declare const listUpdateSegment: <ThrowOnError extends boolean = false>(options: Options<ListUpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<ListUpdateSegmentResponses, ListUpdateSegmentErrors, ThrowOnError, "fields">;
483
+ export declare const getAdminHealth: <ThrowOnError extends boolean = false>(options?: Options<GetAdminHealthData, ThrowOnError>) => import("./client").RequestResult<GetAdminHealthResponses, GetAdminHealthErrors, ThrowOnError, "fields">;
353
484
  /**
354
485
  * Reindex database into Elasticsearch
355
486
  *
356
487
  * Reindexes segments from the PostgreSQL database into Elasticsearch.
357
488
  * Allows filtering by specific media IDs or episodes.
358
489
  *
359
- * **Requirements:**
360
- * - Required Scopes: `ADD_MEDIA` (admin-level permission for reindexing)
361
- *
362
490
  * **Behavior:**
363
491
  * - If no filters provided, reindexes all segments
364
492
  * - If `mediaIds` provided, reindexes all segments from those media
365
493
  * - If `episodes` provided, reindexes only the specified episodes
366
494
  *
495
+ * **Permissions:** `ADD_MEDIA`
496
+ *
367
497
  */
368
- export declare const reindexElasticsearch: <ThrowOnError extends boolean = false>(options?: Options<ReindexElasticsearchData, ThrowOnError>) => import("./client").RequestResult<ReindexElasticsearchResponses, ReindexElasticsearchErrors, ThrowOnError, "fields">;
498
+ export declare const triggerReindex: <ThrowOnError extends boolean = false>(options?: Options<TriggerReindexData, ThrowOnError>) => import("./client").RequestResult<TriggerReindexResponses, TriggerReindexErrors, ThrowOnError, "fields">;
369
499
  /**
370
500
  * Get queue statistics
371
501
  *
372
- * Get statistics for all ES sync queues including pending and failed job counts.
373
- *
374
- * **Requirements:**
375
- * - Required Scopes: `ADD_MEDIA` (admin-level permission)
502
+ * Returns statistics for all ES sync queues including pending and failed job counts.
376
503
  *
377
504
  * **Use cases:**
378
505
  * - Monitor queue health
379
506
  * - Detect stuck jobs
380
507
  * - Check backlog size
381
508
  *
509
+ * **Permissions:** `ADD_MEDIA`
510
+ *
382
511
  */
383
- export declare const getQueueStats: <ThrowOnError extends boolean = false>(options?: Options<GetQueueStatsData, ThrowOnError>) => import("./client").RequestResult<GetQueueStatsResponses, GetQueueStatsErrors, ThrowOnError, "fields">;
512
+ export declare const listAdminQueueStats: <ThrowOnError extends boolean = false>(options?: Options<ListAdminQueueStatsData, ThrowOnError>) => import("./client").RequestResult<ListAdminQueueStatsResponses, ListAdminQueueStatsErrors, ThrowOnError, "fields">;
384
513
  /**
385
514
  * Get detailed queue information
386
515
  *
387
- * Get detailed information about a specific queue including completed, expired, and cancelled jobs.
388
- *
389
- * **Requirements:**
390
- * - Required Scopes: `ADD_MEDIA` (admin-level permission)
516
+ * Returns live queue stats and queue metadata from PgBoss for a specific queue.
391
517
  *
392
518
  * **Queue names:**
393
- * - `es-sync-create` - Jobs to create new segments
519
+ * - `es-sync-create` - Jobs to create new segments in Elasticsearch
394
520
  * - `es-sync-update` - Jobs to update existing segments
395
521
  * - `es-sync-delete` - Jobs to delete segments
396
522
  *
523
+ * **Permissions:** `ADD_MEDIA`
524
+ *
397
525
  */
398
- export declare const getQueueDetails: <ThrowOnError extends boolean = false>(options: Options<GetQueueDetailsData, ThrowOnError>) => import("./client").RequestResult<GetQueueDetailsResponses, GetQueueDetailsErrors, ThrowOnError, "fields">;
526
+ export declare const getAdminQueue: <ThrowOnError extends boolean = false>(options: Options<GetAdminQueueData, ThrowOnError>) => import("./client").RequestResult<GetAdminQueueResponses, GetAdminQueueErrors, ThrowOnError, "fields">;
399
527
  /**
400
528
  * Get failed jobs from a queue
401
529
  *
402
- * Get jobs that have exceeded their retry limit and permanently failed.
403
- *
404
- * **Requirements:**
405
- * - Required Scopes: `ADD_MEDIA` (admin-level permission)
530
+ * Returns jobs that have exceeded their retry limit and permanently failed.
406
531
  *
407
532
  * **Use cases:**
408
533
  * - Identify segments that failed to sync to Elasticsearch
409
534
  * - Debug persistent sync issues
410
535
  * - Decide whether to retry or purge failed jobs
411
536
  *
537
+ * **Permissions:** `ADD_MEDIA`
538
+ *
412
539
  */
413
- export declare const getFailedJobs: <ThrowOnError extends boolean = false>(options: Options<GetFailedJobsData, ThrowOnError>) => import("./client").RequestResult<GetFailedJobsResponses, GetFailedJobsErrors, ThrowOnError, "fields">;
540
+ export declare const listAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<ListAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<ListAdminQueueFailedResponses, ListAdminQueueFailedErrors, ThrowOnError, "fields">;
414
541
  /**
415
542
  * Retry failed jobs from a queue
416
543
  *
417
- * Retry all failed jobs from a specific queue.
418
- *
419
- * **Requirements:**
420
- * - Required Scopes: `ADD_MEDIA` (admin-level permission)
544
+ * Re-enqueues all failed jobs from a specific queue for another attempt.
421
545
  *
422
546
  * **Use cases:**
423
547
  * - Retry jobs that failed due to temporary Elasticsearch issues
424
548
  * - Recover from network blips
425
549
  *
550
+ * **Permissions:** `ADD_MEDIA`
551
+ *
426
552
  */
427
- export declare const retryQueueJobs: <ThrowOnError extends boolean = false>(options: Options<RetryQueueJobsData, ThrowOnError>) => import("./client").RequestResult<RetryQueueJobsResponses, RetryQueueJobsErrors, ThrowOnError, "fields">;
553
+ export declare const retryAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<RetryAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<RetryAdminQueueFailedResponses, RetryAdminQueueFailedErrors, ThrowOnError, "fields">;
428
554
  /**
429
- * Delete failed jobs from a queue
555
+ * Purge failed jobs from a queue
430
556
  *
431
- * Permanently delete all failed jobs from a queue.
432
- *
433
- * **Requirements:**
434
- * - Required Scopes: `ADD_MEDIA` (admin-level permission)
557
+ * Permanently deletes all failed jobs from a queue.
558
+ * This does **not** re-sync the affected segments — use the reindex endpoint for that.
435
559
  *
436
560
  * **Use cases:**
437
561
  * - Clean up old failed jobs after investigating
438
562
  * - Reset a queue after fixing the underlying issue
439
- * - Note: This does NOT re-sync the segments - use the reindex endpoint for that
563
+ *
564
+ * **Permissions:** `ADD_MEDIA`
565
+ *
566
+ */
567
+ export declare const purgeAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<PurgeAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<PurgeAdminQueueFailedResponses, PurgeAdminQueueFailedErrors, ThrowOnError, "fields">;
568
+ /**
569
+ * List all reports
570
+ *
571
+ * Returns all reports with filtering and cursor pagination.
572
+ * Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
573
+ *
574
+ * **Permissions:** `ADD_MEDIA`
575
+ *
576
+ */
577
+ export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
578
+ /**
579
+ * Update a report
580
+ *
581
+ * Updates the status and/or admin notes of a report.
582
+ * Works for both USER and AUTO reports.
583
+ *
584
+ * **Permissions:** `ADD_MEDIA`
585
+ *
586
+ */
587
+ export declare const updateAdminReport: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReportData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReportResponses, UpdateAdminReportErrors, ThrowOnError, "fields">;
588
+ /**
589
+ * Run auto-checks
590
+ *
591
+ * Triggers all enabled auto-checks. Creates ReviewCheckRun records and AUTO reports for any findings.
592
+ *
593
+ * **Permissions:** `ADD_MEDIA`
440
594
  *
441
595
  */
442
- export declare const purgeFailedJobs: <ThrowOnError extends boolean = false>(options: Options<PurgeFailedJobsData, ThrowOnError>) => import("./client").RequestResult<PurgeFailedJobsResponses, PurgeFailedJobsErrors, ThrowOnError, "fields">;
596
+ export declare const runAdminReview: <ThrowOnError extends boolean = false>(options?: Options<RunAdminReviewData, ThrowOnError>) => import("./client").RequestResult<RunAdminReviewResponses, RunAdminReviewErrors, ThrowOnError, "fields">;
443
597
  /**
444
- * Backfill morpheme analysis for segments
598
+ * List all review checks
599
+ *
600
+ * Returns all check definitions with current config, threshold schema, and latest run info.
601
+ *
602
+ * **Permissions:** `ADD_MEDIA`
603
+ *
604
+ */
605
+ export declare const listAdminReviewChecks: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReviewChecksData, ThrowOnError>) => import("./client").RequestResult<ListAdminReviewChecksResponses, ListAdminReviewChecksErrors, ThrowOnError, "fields">;
606
+ /**
607
+ * Update a review check config
608
+ *
609
+ * Updates the threshold values or enabled status of a check.
610
+ *
611
+ * **Permissions:** `ADD_MEDIA`
612
+ *
613
+ */
614
+ export declare const updateAdminReviewCheck: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReviewCheckData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReviewCheckResponses, UpdateAdminReviewCheckErrors, ThrowOnError, "fields">;
615
+ /**
616
+ * List past check runs
617
+ *
618
+ * Returns past review check runs with summary stats. Supports filtering by check name and cursor pagination.
619
+ *
620
+ * **Permissions:** `ADD_MEDIA`
621
+ *
622
+ */
623
+ export declare const listAdminReviewRuns: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReviewRunsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReviewRunsResponses, ListAdminReviewRunsErrors, ThrowOnError, "fields">;
624
+ /**
625
+ * Get a specific run's details
626
+ *
627
+ * Returns a specific review check run record with its linked reports.
628
+ *
629
+ * **Permissions:** `ADD_MEDIA`
630
+ *
631
+ */
632
+ export declare const getAdminReviewRun: <ThrowOnError extends boolean = false>(options: Options<GetAdminReviewRunData, ThrowOnError>) => import("./client").RequestResult<GetAdminReviewRunResponses, GetAdminReviewRunErrors, ThrowOnError, "fields">;
633
+ /**
634
+ * List allowlisted items
635
+ *
636
+ * Returns all allowlisted items (media/episodes) that are excluded from auto-check runs.
637
+ *
638
+ * **Permissions:** `ADD_MEDIA`
445
639
  *
446
- * Analyzes segments that are missing morpheme data using the Sudachi sidecar service.
447
640
  */
448
- export declare const morphemeBackfill: <ThrowOnError extends boolean = false>(options?: Options<MorphemeBackfillData, ThrowOnError>) => import("./client").RequestResult<MorphemeBackfillResponses, unknown, ThrowOnError, "fields">;
641
+ export declare const listAdminReviewAllowlist: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReviewAllowlistData, ThrowOnError>) => import("./client").RequestResult<ListAdminReviewAllowlistResponses, ListAdminReviewAllowlistErrors, ThrowOnError, "fields">;
449
642
  /**
450
- * List all reports (admin)
643
+ * Add to allowlist
451
644
  *
452
- * Returns all reports with filtering and aggregation.
453
- * Reports are grouped by target and sorted by report count descending.
645
+ * Adds a media or episode to the allowlist for a specific check, excluding it from future auto-check runs.
454
646
  *
455
- * **Requirements:**
456
- * - Required Scopes: `ADD_MEDIA` (admin-level permission)
647
+ * **Permissions:** `ADD_MEDIA`
457
648
  *
458
649
  */
459
- export declare const getAdminReports: <ThrowOnError extends boolean = false>(options?: Options<GetAdminReportsData, ThrowOnError>) => import("./client").RequestResult<GetAdminReportsResponses, GetAdminReportsErrors, ThrowOnError, "fields">;
650
+ export declare const createAdminReviewAllowlistEntry: <ThrowOnError extends boolean = false>(options: Options<CreateAdminReviewAllowlistEntryData, ThrowOnError>) => import("./client").RequestResult<CreateAdminReviewAllowlistEntryResponses, CreateAdminReviewAllowlistEntryErrors, ThrowOnError, "fields">;
460
651
  /**
461
- * Update a report (admin)
652
+ * Remove from allowlist
462
653
  *
463
- * Update the status and/or admin notes of a report.
464
- * When status changes to ACCEPTED, REJECTED, or RESOLVED, resolvedAt and resolvedById are set automatically.
654
+ * Removes an item from the review allowlist, re-enabling auto-checks for that media/episode.
465
655
  *
466
- * **Requirements:**
467
- * - Required Scopes: `ADD_MEDIA` (admin-level permission)
656
+ * **Permissions:** `ADD_MEDIA`
468
657
  *
469
658
  */
470
- export declare const updateReport: <ThrowOnError extends boolean = false>(options: Options<UpdateReportData, ThrowOnError>) => import("./client").RequestResult<UpdateReportResponses, UpdateReportErrors, ThrowOnError, "fields">;
659
+ export declare const deleteAdminReviewAllowlistEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteAdminReviewAllowlistEntryData, ThrowOnError>) => import("./client").RequestResult<DeleteAdminReviewAllowlistEntryResponses, DeleteAdminReviewAllowlistEntryErrors, ThrowOnError, "fields">;
471
660
  //# sourceMappingURL=sdk.gen.d.ts.map