@brigadasos/nadeshiko-sdk 1.4.0-dev.6f733b8 → 1.4.0-dev.7a7fd76
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.
- package/README.md +99 -2
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/index.cjs +214 -88
- package/dist/index.cjs.map +5 -5
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +210 -84
- package/dist/index.js.map +5 -5
- package/dist/internal/lists.gen.d.ts.map +1 -1
- package/dist/internal/media.gen.d.ts.map +1 -1
- package/dist/internal/search.gen.d.ts.map +1 -1
- package/dist/internal.gen.d.ts.map +1 -1
- package/dist/nadeshiko.gen.d.ts +31 -17
- package/dist/nadeshiko.gen.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +286 -116
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1434 -617
- package/dist/types.gen.d.ts.map +1 -1
- package/package.json +1 -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 {
|
|
2
|
+
import type { AdminMorphemeBackfillCreateData, AdminMorphemeBackfillCreateResponses, 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, EpisodeCreateData, EpisodeCreateErrors, EpisodeCreateResponses, EpisodeDestroyData, EpisodeDestroyErrors, EpisodeDestroyResponses, EpisodeIndexData, EpisodeIndexErrors, EpisodeIndexResponses, EpisodeShowData, EpisodeShowErrors, EpisodeShowResponses, EpisodeUpdateData, EpisodeUpdateErrors, EpisodeUpdateResponses, HealthCheckData, HealthCheckErrors, HealthCheckResponses, LabIndexData, LabIndexErrors, LabIndexResponses, 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, 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, UserActivityDestroyData, UserActivityDestroyErrors, UserActivityDestroyResponses, UserActivityIndexData, UserActivityIndexErrors, UserActivityIndexResponses, UserActivityStatsShowData, UserActivityStatsShowErrors, UserActivityStatsShowResponses, UserExportShowData, UserExportShowErrors, UserExportShowResponses, UserPreferencesShowData, UserPreferencesShowErrors, UserPreferencesShowResponses, UserPreferencesUpdateData, UserPreferencesUpdateErrors, UserPreferencesUpdateResponses, UserQuotaShowData, UserQuotaShowErrors, UserQuotaShowResponses, UserReportCreateData, UserReportCreateErrors, UserReportCreateResponses, UserReportIndexData, UserReportIndexErrors, UserReportIndexResponses } 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
|
|
@@ -18,8 +18,7 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
18
18
|
*
|
|
19
19
|
* Tests the search service connectivity and functionality by performing a simple search query.
|
|
20
20
|
*
|
|
21
|
-
* **
|
|
22
|
-
* - Required Scopes: `READ_MEDIA`
|
|
21
|
+
* **Permissions:** `READ_MEDIA`
|
|
23
22
|
*
|
|
24
23
|
*/
|
|
25
24
|
export declare const healthCheck: <ThrowOnError extends boolean = false>(options?: Options<HealthCheckData, ThrowOnError>) => import("./client").RequestResult<HealthCheckResponses, HealthCheckErrors, ThrowOnError, "fields">;
|
|
@@ -45,11 +44,10 @@ export declare const healthCheck: <ThrowOnError extends boolean = false>(options
|
|
|
45
44
|
* | **Kana** (`たべる`, `かのじょ`) | Standard search across content, base form, and reading form |
|
|
46
45
|
* | **English/Spanish** | Direct translation search |
|
|
47
46
|
*
|
|
48
|
-
* **
|
|
49
|
-
* - API Key with `READ_MEDIA` permission
|
|
47
|
+
* **Permissions:** `READ_MEDIA`
|
|
50
48
|
*
|
|
51
49
|
*/
|
|
52
|
-
export declare const
|
|
50
|
+
export declare const searchIndex: <ThrowOnError extends boolean = false>(options?: Options<SearchIndexData, ThrowOnError>) => import("./client").RequestResult<SearchIndexResponses, SearchIndexErrors, ThrowOnError, "fields">;
|
|
53
51
|
/**
|
|
54
52
|
* Get search statistics
|
|
55
53
|
*
|
|
@@ -61,11 +59,10 @@ export declare const searchSegments: <ThrowOnError extends boolean = false>(opti
|
|
|
61
59
|
*
|
|
62
60
|
* The stats are scoped by query and category filters, but are not narrowed by a selected media/episode.
|
|
63
61
|
*
|
|
64
|
-
* **
|
|
65
|
-
* - API Key with `READ_MEDIA` permission
|
|
62
|
+
* **Permissions:** `READ_MEDIA`
|
|
66
63
|
*
|
|
67
64
|
*/
|
|
68
|
-
export declare const
|
|
65
|
+
export declare const searchStats: <ThrowOnError extends boolean = false>(options?: Options<SearchStatsData, ThrowOnError>) => import("./client").RequestResult<SearchStatsResponses, SearchStatsErrors, ThrowOnError, "fields">;
|
|
69
66
|
/**
|
|
70
67
|
* Search by multiple words
|
|
71
68
|
*
|
|
@@ -78,42 +75,17 @@ export declare const getSearchStats: <ThrowOnError extends boolean = false>(opti
|
|
|
78
75
|
* - Finding anime/dramas that use specific words
|
|
79
76
|
* - Comparing word usage across different titles
|
|
80
77
|
*
|
|
81
|
-
* **
|
|
82
|
-
* - Required Scopes: `READ_MEDIA`
|
|
78
|
+
* **Permissions:** `READ_MEDIA`
|
|
83
79
|
*
|
|
84
80
|
*/
|
|
85
81
|
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
82
|
/**
|
|
114
83
|
* List all media
|
|
115
84
|
*
|
|
116
85
|
* Returns a paginated list of media with full metadata, including cover/banner images, episode counts, and genres.
|
|
86
|
+
* Supports filtering by category and text search.
|
|
87
|
+
*
|
|
88
|
+
* **Permissions:** `READ_MEDIA`
|
|
117
89
|
*
|
|
118
90
|
*/
|
|
119
91
|
export declare const mediaIndex: <ThrowOnError extends boolean = false>(options?: Options<MediaIndexData, ThrowOnError>) => import("./client").RequestResult<MediaIndexResponses, MediaIndexErrors, ThrowOnError, "fields">;
|
|
@@ -122,117 +94,161 @@ export declare const mediaIndex: <ThrowOnError extends boolean = false>(options?
|
|
|
122
94
|
*
|
|
123
95
|
* Creates a new media entry in the database.
|
|
124
96
|
*
|
|
97
|
+
* **Permissions:** `ADD_MEDIA`
|
|
98
|
+
*
|
|
125
99
|
*/
|
|
126
100
|
export declare const mediaCreate: <ThrowOnError extends boolean = false>(options: Options<MediaCreateData, ThrowOnError>) => import("./client").RequestResult<MediaCreateResponses, MediaCreateErrors, ThrowOnError, "fields">;
|
|
127
101
|
/**
|
|
128
102
|
* Delete media (soft delete)
|
|
129
103
|
*
|
|
130
|
-
* Soft
|
|
104
|
+
* Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
|
|
105
|
+
*
|
|
106
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
131
107
|
*
|
|
132
108
|
*/
|
|
133
109
|
export declare const mediaDestroy: <ThrowOnError extends boolean = false>(options: Options<MediaDestroyData, ThrowOnError>) => import("./client").RequestResult<MediaDestroyResponses, MediaDestroyErrors, ThrowOnError, "fields">;
|
|
134
110
|
/**
|
|
135
111
|
* Get single media
|
|
136
112
|
*
|
|
137
|
-
*
|
|
113
|
+
* Returns a single media entry by its ID with full metadata.
|
|
114
|
+
*
|
|
115
|
+
* **Permissions:** `READ_MEDIA`
|
|
138
116
|
*
|
|
139
117
|
*/
|
|
140
118
|
export declare const mediaShow: <ThrowOnError extends boolean = false>(options: Options<MediaShowData, ThrowOnError>) => import("./client").RequestResult<MediaShowResponses, MediaShowErrors, ThrowOnError, "fields">;
|
|
141
119
|
/**
|
|
142
120
|
* Update media
|
|
143
121
|
*
|
|
144
|
-
* Updates an existing media entry.
|
|
122
|
+
* Updates an existing media entry. Only provided fields will be updated.
|
|
123
|
+
*
|
|
124
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
145
125
|
*
|
|
146
126
|
*/
|
|
147
127
|
export declare const mediaUpdate: <ThrowOnError extends boolean = false>(options: Options<MediaUpdateData, ThrowOnError>) => import("./client").RequestResult<MediaUpdateResponses, MediaUpdateErrors, ThrowOnError, "fields">;
|
|
148
128
|
/**
|
|
149
129
|
* List episodes for a media
|
|
150
130
|
*
|
|
151
|
-
*
|
|
131
|
+
* Returns a paginated list of episodes for a specific media.
|
|
132
|
+
*
|
|
133
|
+
* **Permissions:** `READ_MEDIA`
|
|
152
134
|
*
|
|
153
135
|
*/
|
|
154
136
|
export declare const episodeIndex: <ThrowOnError extends boolean = false>(options: Options<EpisodeIndexData, ThrowOnError>) => import("./client").RequestResult<EpisodeIndexResponses, EpisodeIndexErrors, ThrowOnError, "fields">;
|
|
155
137
|
/**
|
|
156
138
|
* Create new episode
|
|
157
139
|
*
|
|
158
|
-
*
|
|
140
|
+
* Creates a new episode for a specific media.
|
|
141
|
+
*
|
|
142
|
+
* **Permissions:** `ADD_MEDIA`
|
|
159
143
|
*
|
|
160
144
|
*/
|
|
161
145
|
export declare const episodeCreate: <ThrowOnError extends boolean = false>(options: Options<EpisodeCreateData, ThrowOnError>) => import("./client").RequestResult<EpisodeCreateResponses, EpisodeCreateErrors, ThrowOnError, "fields">;
|
|
162
146
|
/**
|
|
163
147
|
* Delete an episode
|
|
164
148
|
*
|
|
165
|
-
* Soft
|
|
149
|
+
* Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
|
|
150
|
+
*
|
|
151
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
166
152
|
*
|
|
167
153
|
*/
|
|
168
154
|
export declare const episodeDestroy: <ThrowOnError extends boolean = false>(options: Options<EpisodeDestroyData, ThrowOnError>) => import("./client").RequestResult<EpisodeDestroyResponses, EpisodeDestroyErrors, ThrowOnError, "fields">;
|
|
169
155
|
/**
|
|
170
156
|
* Get single episode
|
|
171
157
|
*
|
|
172
|
-
*
|
|
158
|
+
* Returns a specific episode by media ID and episode number.
|
|
159
|
+
*
|
|
160
|
+
* **Permissions:** `READ_MEDIA`
|
|
173
161
|
*
|
|
174
162
|
*/
|
|
175
163
|
export declare const episodeShow: <ThrowOnError extends boolean = false>(options: Options<EpisodeShowData, ThrowOnError>) => import("./client").RequestResult<EpisodeShowResponses, EpisodeShowErrors, ThrowOnError, "fields">;
|
|
176
164
|
/**
|
|
177
165
|
* Update episode
|
|
178
166
|
*
|
|
179
|
-
*
|
|
167
|
+
* Updates an existing episode. Only provided fields will be updated.
|
|
168
|
+
*
|
|
169
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
180
170
|
*
|
|
181
171
|
*/
|
|
182
172
|
export declare const episodeUpdate: <ThrowOnError extends boolean = false>(options: Options<EpisodeUpdateData, ThrowOnError>) => import("./client").RequestResult<EpisodeUpdateResponses, EpisodeUpdateErrors, ThrowOnError, "fields">;
|
|
183
173
|
/**
|
|
184
174
|
* List segments for an episode
|
|
185
175
|
*
|
|
186
|
-
*
|
|
176
|
+
* Returns a paginated list of segments for a specific episode.
|
|
177
|
+
*
|
|
178
|
+
* **Permissions:** `READ_MEDIA`
|
|
187
179
|
*
|
|
188
180
|
*/
|
|
189
181
|
export declare const segmentIndex: <ThrowOnError extends boolean = false>(options: Options<SegmentIndexData, ThrowOnError>) => import("./client").RequestResult<SegmentIndexResponses, SegmentIndexErrors, ThrowOnError, "fields">;
|
|
190
182
|
/**
|
|
191
183
|
* Create new segment
|
|
192
184
|
*
|
|
193
|
-
*
|
|
185
|
+
* Creates a new segment for a specific episode.
|
|
186
|
+
*
|
|
187
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
194
188
|
*
|
|
195
189
|
*/
|
|
196
190
|
export declare const segmentCreate: <ThrowOnError extends boolean = false>(options: Options<SegmentCreateData, ThrowOnError>) => import("./client").RequestResult<SegmentCreateResponses, SegmentCreateErrors, ThrowOnError, "fields">;
|
|
197
191
|
/**
|
|
198
|
-
* Delete segment
|
|
192
|
+
* Delete segment
|
|
193
|
+
*
|
|
194
|
+
* Soft-deletes a segment by setting its status to DELETED.
|
|
199
195
|
*
|
|
200
|
-
*
|
|
196
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
201
197
|
*
|
|
202
198
|
*/
|
|
203
199
|
export declare const segmentDestroy: <ThrowOnError extends boolean = false>(options: Options<SegmentDestroyData, ThrowOnError>) => import("./client").RequestResult<SegmentDestroyResponses, SegmentDestroyErrors, ThrowOnError, "fields">;
|
|
204
200
|
/**
|
|
205
201
|
* Get single segment
|
|
206
202
|
*
|
|
207
|
-
*
|
|
203
|
+
* Returns a specific segment by its ID within the media/episode hierarchy.
|
|
204
|
+
*
|
|
205
|
+
* **Permissions:** `READ_MEDIA`
|
|
208
206
|
*
|
|
209
207
|
*/
|
|
210
208
|
export declare const segmentShow: <ThrowOnError extends boolean = false>(options: Options<SegmentShowData, ThrowOnError>) => import("./client").RequestResult<SegmentShowResponses, SegmentShowErrors, ThrowOnError, "fields">;
|
|
211
209
|
/**
|
|
212
210
|
* Update segment
|
|
213
211
|
*
|
|
214
|
-
*
|
|
212
|
+
* Updates an existing segment. Only provided fields will be updated.
|
|
213
|
+
*
|
|
214
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
215
215
|
*
|
|
216
216
|
*/
|
|
217
217
|
export declare const segmentUpdate: <ThrowOnError extends boolean = false>(options: Options<SegmentUpdateData, ThrowOnError>) => import("./client").RequestResult<SegmentUpdateResponses, SegmentUpdateErrors, ThrowOnError, "fields">;
|
|
218
218
|
/**
|
|
219
219
|
* Get segment by UUID
|
|
220
220
|
*
|
|
221
|
-
*
|
|
221
|
+
* Returns a specific segment by its UUID. A shortcut alternative to the nested `/media/{mediaId}/episodes/{episodeNumber}/segments/{id}` path.
|
|
222
|
+
*
|
|
223
|
+
* **Permissions:** `READ_MEDIA`
|
|
222
224
|
*
|
|
223
225
|
*/
|
|
224
226
|
export declare const segmentShowByUuid: <ThrowOnError extends boolean = false>(options: Options<SegmentShowByUuidData, ThrowOnError>) => import("./client").RequestResult<SegmentShowByUuidResponses, SegmentShowByUuidErrors, ThrowOnError, "fields">;
|
|
227
|
+
/**
|
|
228
|
+
* Get surrounding context for a segment
|
|
229
|
+
*
|
|
230
|
+
* Retrieves segments surrounding a specific segment within an episode.
|
|
231
|
+
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
232
|
+
*
|
|
233
|
+
* **Permissions:** `READ_MEDIA`
|
|
234
|
+
*
|
|
235
|
+
*/
|
|
236
|
+
export declare const segmentContextShow: <ThrowOnError extends boolean = false>(options: Options<SegmentContextShowData, ThrowOnError>) => import("./client").RequestResult<SegmentContextShowResponses, SegmentContextShowErrors, ThrowOnError, "fields">;
|
|
225
237
|
/**
|
|
226
238
|
* Get character details
|
|
227
239
|
*
|
|
228
|
-
* Returns a character with their seiyuu and all media appearances.
|
|
240
|
+
* Returns a character with their voice actors (seiyuu) and all media appearances.
|
|
241
|
+
*
|
|
242
|
+
* **Permissions:** `READ_MEDIA`
|
|
229
243
|
*
|
|
230
244
|
*/
|
|
231
245
|
export declare const characterShow: <ThrowOnError extends boolean = false>(options: Options<CharacterShowData, ThrowOnError>) => import("./client").RequestResult<CharacterShowResponses, CharacterShowErrors, ThrowOnError, "fields">;
|
|
232
246
|
/**
|
|
233
247
|
* Get seiyuu details
|
|
234
248
|
*
|
|
235
|
-
* Returns a voice actor with all characters they voiced and media appearances.
|
|
249
|
+
* Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
|
|
250
|
+
*
|
|
251
|
+
* **Permissions:** `READ_MEDIA`
|
|
236
252
|
*
|
|
237
253
|
*/
|
|
238
254
|
export declare const seiyuuShow: <ThrowOnError extends boolean = false>(options: Options<SeiyuuShowData, ThrowOnError>) => import("./client").RequestResult<SeiyuuShowResponses, SeiyuuShowErrors, ThrowOnError, "fields">;
|
|
@@ -241,84 +257,162 @@ export declare const seiyuuShow: <ThrowOnError extends boolean = false>(options:
|
|
|
241
257
|
*
|
|
242
258
|
* Returns the authenticated user's API quota usage for the current billing period.
|
|
243
259
|
*
|
|
244
|
-
* **
|
|
245
|
-
* - Requires session authentication (cookie-based).
|
|
260
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
246
261
|
*
|
|
247
262
|
*/
|
|
248
|
-
export declare const
|
|
263
|
+
export declare const userQuotaShow: <ThrowOnError extends boolean = false>(options?: Options<UserQuotaShowData, ThrowOnError>) => import("./client").RequestResult<UserQuotaShowResponses, UserQuotaShowErrors, ThrowOnError, "fields">;
|
|
249
264
|
/**
|
|
250
265
|
* List user's own reports
|
|
251
266
|
*
|
|
252
267
|
* Returns the authenticated user's submitted reports with cursor pagination.
|
|
253
268
|
*
|
|
254
|
-
* **
|
|
255
|
-
* - Requires session authentication (cookie-based).
|
|
269
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
256
270
|
*
|
|
257
271
|
*/
|
|
258
|
-
export declare const
|
|
272
|
+
export declare const userReportIndex: <ThrowOnError extends boolean = false>(options?: Options<UserReportIndexData, ThrowOnError>) => import("./client").RequestResult<UserReportIndexResponses, UserReportIndexErrors, ThrowOnError, "fields">;
|
|
259
273
|
/**
|
|
260
274
|
* Create a new report
|
|
261
275
|
*
|
|
262
276
|
* Submit a report for a segment or media entry.
|
|
263
277
|
*
|
|
264
|
-
* **
|
|
265
|
-
*
|
|
278
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
279
|
+
*
|
|
280
|
+
*/
|
|
281
|
+
export declare const userReportCreate: <ThrowOnError extends boolean = false>(options: Options<UserReportCreateData, ThrowOnError>) => import("./client").RequestResult<UserReportCreateResponses, UserReportCreateErrors, ThrowOnError, "fields">;
|
|
282
|
+
/**
|
|
283
|
+
* Get user preferences
|
|
284
|
+
*
|
|
285
|
+
* Returns the authenticated user's full preferences object.
|
|
286
|
+
*
|
|
287
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
288
|
+
*
|
|
289
|
+
*/
|
|
290
|
+
export declare const userPreferencesShow: <ThrowOnError extends boolean = false>(options?: Options<UserPreferencesShowData, ThrowOnError>) => import("./client").RequestResult<UserPreferencesShowResponses, UserPreferencesShowErrors, ThrowOnError, "fields">;
|
|
291
|
+
/**
|
|
292
|
+
* Update user preferences
|
|
293
|
+
*
|
|
294
|
+
* Deep-merges a partial preferences update into the user's existing preferences.
|
|
295
|
+
* Only the provided keys are updated; all other keys are preserved.
|
|
296
|
+
*
|
|
297
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
298
|
+
*
|
|
299
|
+
*/
|
|
300
|
+
export declare const userPreferencesUpdate: <ThrowOnError extends boolean = false>(options: Options<UserPreferencesUpdateData, ThrowOnError>) => import("./client").RequestResult<UserPreferencesUpdateResponses, UserPreferencesUpdateErrors, ThrowOnError, "fields">;
|
|
301
|
+
/**
|
|
302
|
+
* Clear user activity history
|
|
303
|
+
*
|
|
304
|
+
* Deletes the authenticated user's activity history. Optionally filter by activity type.
|
|
305
|
+
*
|
|
306
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
307
|
+
*
|
|
308
|
+
*/
|
|
309
|
+
export declare const userActivityDestroy: <ThrowOnError extends boolean = false>(options?: Options<UserActivityDestroyData, ThrowOnError>) => import("./client").RequestResult<UserActivityDestroyResponses, UserActivityDestroyErrors, ThrowOnError, "fields">;
|
|
310
|
+
/**
|
|
311
|
+
* Get user activity history
|
|
312
|
+
*
|
|
313
|
+
* Returns the authenticated user's activity history with cursor-based pagination.
|
|
314
|
+
*
|
|
315
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
316
|
+
*
|
|
317
|
+
*/
|
|
318
|
+
export declare const userActivityIndex: <ThrowOnError extends boolean = false>(options?: Options<UserActivityIndexData, ThrowOnError>) => import("./client").RequestResult<UserActivityIndexResponses, UserActivityIndexErrors, ThrowOnError, "fields">;
|
|
319
|
+
/**
|
|
320
|
+
* Get user activity statistics
|
|
321
|
+
*
|
|
322
|
+
* Returns aggregate statistics about the authenticated user's activity:
|
|
323
|
+
* total searches, exports, plays, and study streak.
|
|
324
|
+
*
|
|
325
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
326
|
+
*
|
|
327
|
+
*/
|
|
328
|
+
export declare const userActivityStatsShow: <ThrowOnError extends boolean = false>(options?: Options<UserActivityStatsShowData, ThrowOnError>) => import("./client").RequestResult<UserActivityStatsShowResponses, UserActivityStatsShowErrors, ThrowOnError, "fields">;
|
|
329
|
+
/**
|
|
330
|
+
* Export all user data
|
|
331
|
+
*
|
|
332
|
+
* Returns a full JSON export of all user-related data for GDPR data portability.
|
|
333
|
+
* Includes profile, preferences, activity history, lists, and reports.
|
|
334
|
+
*
|
|
335
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
336
|
+
*
|
|
337
|
+
*/
|
|
338
|
+
export declare const userExportShow: <ThrowOnError extends boolean = false>(options?: Options<UserExportShowData, ThrowOnError>) => import("./client").RequestResult<UserExportShowResponses, UserExportShowErrors, ThrowOnError, "fields">;
|
|
339
|
+
/**
|
|
340
|
+
* List available lab features
|
|
341
|
+
*
|
|
342
|
+
* Returns all available lab features from the code registry.
|
|
343
|
+
* This is a static, cacheable endpoint that does not require authentication.
|
|
266
344
|
*
|
|
267
345
|
*/
|
|
268
|
-
export declare const
|
|
346
|
+
export declare const labIndex: <ThrowOnError extends boolean = false>(options?: Options<LabIndexData, ThrowOnError>) => import("./client").RequestResult<LabIndexResponses, LabIndexErrors, ThrowOnError, "fields">;
|
|
269
347
|
/**
|
|
270
348
|
* List all lists
|
|
271
349
|
*
|
|
272
350
|
* 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.
|
|
273
351
|
*
|
|
352
|
+
* **Permissions:** `READ_LISTS`
|
|
353
|
+
*
|
|
274
354
|
*/
|
|
275
355
|
export declare const listIndex: <ThrowOnError extends boolean = false>(options?: Options<ListIndexData, ThrowOnError>) => import("./client").RequestResult<ListIndexResponses, ListIndexErrors, ThrowOnError, "fields">;
|
|
276
356
|
/**
|
|
277
357
|
* Create new list
|
|
278
358
|
*
|
|
279
|
-
* Creates a new standalone list.
|
|
359
|
+
* Creates a new standalone list.
|
|
360
|
+
*
|
|
361
|
+
* **Permissions:** `CREATE_LISTS`
|
|
280
362
|
*
|
|
281
363
|
*/
|
|
282
364
|
export declare const listCreate: <ThrowOnError extends boolean = false>(options: Options<ListCreateData, ThrowOnError>) => import("./client").RequestResult<ListCreateResponses, ListCreateErrors, ThrowOnError, "fields">;
|
|
283
365
|
/**
|
|
284
366
|
* Delete list
|
|
285
367
|
*
|
|
286
|
-
* Deletes a list and all its items.
|
|
368
|
+
* Deletes a list and all its items.
|
|
369
|
+
*
|
|
370
|
+
* **Permissions:** `DELETE_LISTS`
|
|
287
371
|
*
|
|
288
372
|
*/
|
|
289
373
|
export declare const listDestroy: <ThrowOnError extends boolean = false>(options: Options<ListDestroyData, ThrowOnError>) => import("./client").RequestResult<ListDestroyResponses, ListDestroyErrors, ThrowOnError, "fields">;
|
|
290
374
|
/**
|
|
291
375
|
* Get list details
|
|
292
376
|
*
|
|
293
|
-
* Returns a list with all media
|
|
377
|
+
* Returns a list with all media items sorted by position.
|
|
378
|
+
*
|
|
379
|
+
* **Permissions:** `READ_LISTS`
|
|
294
380
|
*
|
|
295
381
|
*/
|
|
296
382
|
export declare const listShow: <ThrowOnError extends boolean = false>(options: Options<ListShowData, ThrowOnError>) => import("./client").RequestResult<ListShowResponses, ListShowErrors, ThrowOnError, "fields">;
|
|
297
383
|
/**
|
|
298
384
|
* Update list metadata
|
|
299
385
|
*
|
|
300
|
-
* Updates list name or visibility.
|
|
386
|
+
* Updates list name or visibility.
|
|
387
|
+
*
|
|
388
|
+
* **Permissions:** `UPDATE_LISTS`
|
|
301
389
|
*
|
|
302
390
|
*/
|
|
303
391
|
export declare const listUpdate: <ThrowOnError extends boolean = false>(options: Options<ListUpdateData, ThrowOnError>) => import("./client").RequestResult<ListUpdateResponses, ListUpdateErrors, ThrowOnError, "fields">;
|
|
304
392
|
/**
|
|
305
393
|
* Add media to list
|
|
306
394
|
*
|
|
307
|
-
* Adds a media entry to the list at the specified position.
|
|
395
|
+
* Adds a media entry to the list at the specified position.
|
|
396
|
+
*
|
|
397
|
+
* **Permissions:** `UPDATE_LISTS`
|
|
308
398
|
*
|
|
309
399
|
*/
|
|
310
400
|
export declare const listAddItem: <ThrowOnError extends boolean = false>(options: Options<ListAddItemData, ThrowOnError>) => import("./client").RequestResult<ListAddItemResponses, ListAddItemErrors, ThrowOnError, "fields">;
|
|
311
401
|
/**
|
|
312
402
|
* Remove media from list
|
|
313
403
|
*
|
|
314
|
-
* Removes a media entry from the list.
|
|
404
|
+
* Removes a media entry from the list.
|
|
405
|
+
*
|
|
406
|
+
* **Permissions:** `UPDATE_LISTS`
|
|
315
407
|
*
|
|
316
408
|
*/
|
|
317
409
|
export declare const listRemoveItem: <ThrowOnError extends boolean = false>(options: Options<ListRemoveItemData, ThrowOnError>) => import("./client").RequestResult<ListRemoveItemResponses, ListRemoveItemErrors, ThrowOnError, "fields">;
|
|
318
410
|
/**
|
|
319
411
|
* Update media position in list
|
|
320
412
|
*
|
|
321
|
-
* Updates the position of a media entry within the list.
|
|
413
|
+
* Updates the position of a media entry within the list.
|
|
414
|
+
*
|
|
415
|
+
* **Permissions:** `UPDATE_LISTS`
|
|
322
416
|
*
|
|
323
417
|
*/
|
|
324
418
|
export declare const listUpdateItem: <ThrowOnError extends boolean = false>(options: Options<ListUpdateItemData, ThrowOnError>) => import("./client").RequestResult<ListUpdateItemResponses, ListUpdateItemErrors, ThrowOnError, "fields">;
|
|
@@ -327,6 +421,8 @@ export declare const listUpdateItem: <ThrowOnError extends boolean = false>(opti
|
|
|
327
421
|
*
|
|
328
422
|
* Returns paginated segments in a segment list with full search result data.
|
|
329
423
|
*
|
|
424
|
+
* **Permissions:** `READ_LISTS`
|
|
425
|
+
*
|
|
330
426
|
*/
|
|
331
427
|
export declare const listGetSegments: <ThrowOnError extends boolean = false>(options: Options<ListGetSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListGetSegmentsResponses, ListGetSegmentsErrors, ThrowOnError, "fields">;
|
|
332
428
|
/**
|
|
@@ -334,6 +430,8 @@ export declare const listGetSegments: <ThrowOnError extends boolean = false>(opt
|
|
|
334
430
|
*
|
|
335
431
|
* Adds a segment to a segment list. Requires list ownership or admin.
|
|
336
432
|
*
|
|
433
|
+
* **Permissions:** `UPDATE_LISTS`
|
|
434
|
+
*
|
|
337
435
|
*/
|
|
338
436
|
export declare const listAddSegment: <ThrowOnError extends boolean = false>(options: Options<ListAddSegmentData, ThrowOnError>) => import("./client").RequestResult<ListAddSegmentResponses, ListAddSegmentErrors, ThrowOnError, "fields">;
|
|
339
437
|
/**
|
|
@@ -341,6 +439,8 @@ export declare const listAddSegment: <ThrowOnError extends boolean = false>(opti
|
|
|
341
439
|
*
|
|
342
440
|
* Removes a segment from a list. Requires list ownership or admin.
|
|
343
441
|
*
|
|
442
|
+
* **Permissions:** `UPDATE_LISTS`
|
|
443
|
+
*
|
|
344
444
|
*/
|
|
345
445
|
export declare const listRemoveSegment: <ThrowOnError extends boolean = false>(options: Options<ListRemoveSegmentData, ThrowOnError>) => import("./client").RequestResult<ListRemoveSegmentResponses, ListRemoveSegmentErrors, ThrowOnError, "fields">;
|
|
346
446
|
/**
|
|
@@ -348,6 +448,8 @@ export declare const listRemoveSegment: <ThrowOnError extends boolean = false>(o
|
|
|
348
448
|
*
|
|
349
449
|
* Updates the note or position of a segment in a list. Requires list ownership or admin.
|
|
350
450
|
*
|
|
451
|
+
* **Permissions:** `UPDATE_LISTS`
|
|
452
|
+
*
|
|
351
453
|
*/
|
|
352
454
|
export declare const listUpdateSegment: <ThrowOnError extends boolean = false>(options: Options<ListUpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<ListUpdateSegmentResponses, ListUpdateSegmentErrors, ThrowOnError, "fields">;
|
|
353
455
|
/**
|
|
@@ -356,116 +458,184 @@ export declare const listUpdateSegment: <ThrowOnError extends boolean = false>(o
|
|
|
356
458
|
* Reindexes segments from the PostgreSQL database into Elasticsearch.
|
|
357
459
|
* Allows filtering by specific media IDs or episodes.
|
|
358
460
|
*
|
|
359
|
-
* **Requirements:**
|
|
360
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission for reindexing)
|
|
361
|
-
*
|
|
362
461
|
* **Behavior:**
|
|
363
462
|
* - If no filters provided, reindexes all segments
|
|
364
463
|
* - If `mediaIds` provided, reindexes all segments from those media
|
|
365
464
|
* - If `episodes` provided, reindexes only the specified episodes
|
|
366
465
|
*
|
|
466
|
+
* **Permissions:** `ADD_MEDIA`
|
|
467
|
+
*
|
|
367
468
|
*/
|
|
368
|
-
export declare const
|
|
469
|
+
export declare const adminReindexCreate: <ThrowOnError extends boolean = false>(options?: Options<AdminReindexCreateData, ThrowOnError>) => import("./client").RequestResult<AdminReindexCreateResponses, AdminReindexCreateErrors, ThrowOnError, "fields">;
|
|
369
470
|
/**
|
|
370
471
|
* Get queue statistics
|
|
371
472
|
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
* **Requirements:**
|
|
375
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
473
|
+
* Returns statistics for all ES sync queues including pending and failed job counts.
|
|
376
474
|
*
|
|
377
475
|
* **Use cases:**
|
|
378
476
|
* - Monitor queue health
|
|
379
477
|
* - Detect stuck jobs
|
|
380
478
|
* - Check backlog size
|
|
381
479
|
*
|
|
480
|
+
* **Permissions:** `ADD_MEDIA`
|
|
481
|
+
*
|
|
382
482
|
*/
|
|
383
|
-
export declare const
|
|
483
|
+
export declare const adminQueueStatsIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminQueueStatsIndexData, ThrowOnError>) => import("./client").RequestResult<AdminQueueStatsIndexResponses, AdminQueueStatsIndexErrors, ThrowOnError, "fields">;
|
|
384
484
|
/**
|
|
385
485
|
* Get detailed queue information
|
|
386
486
|
*
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
* **Requirements:**
|
|
390
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
487
|
+
* Returns detailed information about a specific queue including completed, expired, and cancelled jobs.
|
|
391
488
|
*
|
|
392
489
|
* **Queue names:**
|
|
393
|
-
* - `es-sync-create` - Jobs to create new segments
|
|
490
|
+
* - `es-sync-create` - Jobs to create new segments in Elasticsearch
|
|
394
491
|
* - `es-sync-update` - Jobs to update existing segments
|
|
395
492
|
* - `es-sync-delete` - Jobs to delete segments
|
|
396
493
|
*
|
|
494
|
+
* **Permissions:** `ADD_MEDIA`
|
|
495
|
+
*
|
|
397
496
|
*/
|
|
398
|
-
export declare const
|
|
497
|
+
export declare const adminQueueShow: <ThrowOnError extends boolean = false>(options: Options<AdminQueueShowData, ThrowOnError>) => import("./client").RequestResult<AdminQueueShowResponses, AdminQueueShowErrors, ThrowOnError, "fields">;
|
|
399
498
|
/**
|
|
400
499
|
* Get failed jobs from a queue
|
|
401
500
|
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
* **Requirements:**
|
|
405
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
501
|
+
* Returns jobs that have exceeded their retry limit and permanently failed.
|
|
406
502
|
*
|
|
407
503
|
* **Use cases:**
|
|
408
504
|
* - Identify segments that failed to sync to Elasticsearch
|
|
409
505
|
* - Debug persistent sync issues
|
|
410
506
|
* - Decide whether to retry or purge failed jobs
|
|
411
507
|
*
|
|
508
|
+
* **Permissions:** `ADD_MEDIA`
|
|
509
|
+
*
|
|
412
510
|
*/
|
|
413
|
-
export declare const
|
|
511
|
+
export declare const adminQueueFailedIndex: <ThrowOnError extends boolean = false>(options: Options<AdminQueueFailedIndexData, ThrowOnError>) => import("./client").RequestResult<AdminQueueFailedIndexResponses, AdminQueueFailedIndexErrors, ThrowOnError, "fields">;
|
|
414
512
|
/**
|
|
415
513
|
* Retry failed jobs from a queue
|
|
416
514
|
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
* **Requirements:**
|
|
420
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
515
|
+
* Re-enqueues all failed jobs from a specific queue for another attempt.
|
|
421
516
|
*
|
|
422
517
|
* **Use cases:**
|
|
423
518
|
* - Retry jobs that failed due to temporary Elasticsearch issues
|
|
424
519
|
* - Recover from network blips
|
|
425
520
|
*
|
|
521
|
+
* **Permissions:** `ADD_MEDIA`
|
|
522
|
+
*
|
|
426
523
|
*/
|
|
427
|
-
export declare const
|
|
524
|
+
export declare const adminQueueRetryCreate: <ThrowOnError extends boolean = false>(options: Options<AdminQueueRetryCreateData, ThrowOnError>) => import("./client").RequestResult<AdminQueueRetryCreateResponses, AdminQueueRetryCreateErrors, ThrowOnError, "fields">;
|
|
428
525
|
/**
|
|
429
|
-
*
|
|
526
|
+
* Purge failed jobs from a queue
|
|
430
527
|
*
|
|
431
|
-
* Permanently
|
|
432
|
-
*
|
|
433
|
-
* **Requirements:**
|
|
434
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
528
|
+
* Permanently deletes all failed jobs from a queue.
|
|
529
|
+
* This does **not** re-sync the affected segments — use the reindex endpoint for that.
|
|
435
530
|
*
|
|
436
531
|
* **Use cases:**
|
|
437
532
|
* - Clean up old failed jobs after investigating
|
|
438
533
|
* - Reset a queue after fixing the underlying issue
|
|
439
|
-
*
|
|
534
|
+
*
|
|
535
|
+
* **Permissions:** `ADD_MEDIA`
|
|
440
536
|
*
|
|
441
537
|
*/
|
|
442
|
-
export declare const
|
|
538
|
+
export declare const adminQueueFailedDestroy: <ThrowOnError extends boolean = false>(options: Options<AdminQueueFailedDestroyData, ThrowOnError>) => import("./client").RequestResult<AdminQueueFailedDestroyResponses, AdminQueueFailedDestroyErrors, ThrowOnError, "fields">;
|
|
443
539
|
/**
|
|
444
540
|
* Backfill morpheme analysis for segments
|
|
445
541
|
*
|
|
446
542
|
* Analyzes segments that are missing morpheme data using the Sudachi sidecar service.
|
|
543
|
+
* Returns stats on how many segments were successfully analyzed vs failed.
|
|
544
|
+
*
|
|
545
|
+
* **Permissions:** `ADD_MEDIA`
|
|
546
|
+
*
|
|
547
|
+
*/
|
|
548
|
+
export declare const adminMorphemeBackfillCreate: <ThrowOnError extends boolean = false>(options?: Options<AdminMorphemeBackfillCreateData, ThrowOnError>) => import("./client").RequestResult<AdminMorphemeBackfillCreateResponses, unknown, ThrowOnError, "fields">;
|
|
549
|
+
/**
|
|
550
|
+
* List all reports
|
|
551
|
+
*
|
|
552
|
+
* Returns all reports with filtering and cursor pagination.
|
|
553
|
+
* Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
|
|
554
|
+
*
|
|
555
|
+
* **Permissions:** `ADD_MEDIA`
|
|
556
|
+
*
|
|
557
|
+
*/
|
|
558
|
+
export declare const adminReportIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReportIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReportIndexResponses, AdminReportIndexErrors, ThrowOnError, "fields">;
|
|
559
|
+
/**
|
|
560
|
+
* Update a report
|
|
561
|
+
*
|
|
562
|
+
* Updates the status and/or admin notes of a report.
|
|
563
|
+
* Works for both USER and AUTO reports.
|
|
564
|
+
*
|
|
565
|
+
* **Permissions:** `ADD_MEDIA`
|
|
566
|
+
*
|
|
567
|
+
*/
|
|
568
|
+
export declare const adminReportUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminReportUpdateData, ThrowOnError>) => import("./client").RequestResult<AdminReportUpdateResponses, AdminReportUpdateErrors, ThrowOnError, "fields">;
|
|
569
|
+
/**
|
|
570
|
+
* Run auto-checks
|
|
571
|
+
*
|
|
572
|
+
* Triggers all enabled auto-checks. Creates ReviewCheckRun records and AUTO reports for any findings.
|
|
573
|
+
*
|
|
574
|
+
* **Permissions:** `ADD_MEDIA`
|
|
575
|
+
*
|
|
576
|
+
*/
|
|
577
|
+
export declare const adminReviewRunCreate: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewRunCreateData, ThrowOnError>) => import("./client").RequestResult<AdminReviewRunCreateResponses, AdminReviewRunCreateErrors, ThrowOnError, "fields">;
|
|
578
|
+
/**
|
|
579
|
+
* List all review checks
|
|
580
|
+
*
|
|
581
|
+
* Returns all check definitions with current config, threshold schema, and latest run info.
|
|
582
|
+
*
|
|
583
|
+
* **Permissions:** `ADD_MEDIA`
|
|
584
|
+
*
|
|
585
|
+
*/
|
|
586
|
+
export declare const adminReviewCheckIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewCheckIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReviewCheckIndexResponses, AdminReviewCheckIndexErrors, ThrowOnError, "fields">;
|
|
587
|
+
/**
|
|
588
|
+
* Update a review check config
|
|
589
|
+
*
|
|
590
|
+
* Updates the threshold values or enabled status of a check.
|
|
591
|
+
*
|
|
592
|
+
* **Permissions:** `ADD_MEDIA`
|
|
593
|
+
*
|
|
594
|
+
*/
|
|
595
|
+
export declare const adminReviewCheckUpdate: <ThrowOnError extends boolean = false>(options: Options<AdminReviewCheckUpdateData, ThrowOnError>) => import("./client").RequestResult<AdminReviewCheckUpdateResponses, AdminReviewCheckUpdateErrors, ThrowOnError, "fields">;
|
|
596
|
+
/**
|
|
597
|
+
* List past check runs
|
|
598
|
+
*
|
|
599
|
+
* Returns past review check runs with summary stats. Supports filtering by check name and cursor pagination.
|
|
600
|
+
*
|
|
601
|
+
* **Permissions:** `ADD_MEDIA`
|
|
602
|
+
*
|
|
603
|
+
*/
|
|
604
|
+
export declare const adminReviewRunIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewRunIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReviewRunIndexResponses, AdminReviewRunIndexErrors, ThrowOnError, "fields">;
|
|
605
|
+
/**
|
|
606
|
+
* Get a specific run's details
|
|
607
|
+
*
|
|
608
|
+
* Returns a specific review check run record with its linked reports.
|
|
609
|
+
*
|
|
610
|
+
* **Permissions:** `ADD_MEDIA`
|
|
611
|
+
*
|
|
612
|
+
*/
|
|
613
|
+
export declare const adminReviewRunShow: <ThrowOnError extends boolean = false>(options: Options<AdminReviewRunShowData, ThrowOnError>) => import("./client").RequestResult<AdminReviewRunShowResponses, AdminReviewRunShowErrors, ThrowOnError, "fields">;
|
|
614
|
+
/**
|
|
615
|
+
* List allowlisted items
|
|
616
|
+
*
|
|
617
|
+
* Returns all allowlisted items (media/episodes) that are excluded from auto-check runs.
|
|
618
|
+
*
|
|
619
|
+
* **Permissions:** `ADD_MEDIA`
|
|
620
|
+
*
|
|
447
621
|
*/
|
|
448
|
-
export declare const
|
|
622
|
+
export declare const adminReviewAllowlistIndex: <ThrowOnError extends boolean = false>(options?: Options<AdminReviewAllowlistIndexData, ThrowOnError>) => import("./client").RequestResult<AdminReviewAllowlistIndexResponses, AdminReviewAllowlistIndexErrors, ThrowOnError, "fields">;
|
|
449
623
|
/**
|
|
450
|
-
*
|
|
624
|
+
* Add to allowlist
|
|
451
625
|
*
|
|
452
|
-
*
|
|
453
|
-
* Reports are grouped by target and sorted by report count descending.
|
|
626
|
+
* Adds a media or episode to the allowlist for a specific check, excluding it from future auto-check runs.
|
|
454
627
|
*
|
|
455
|
-
* **
|
|
456
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
628
|
+
* **Permissions:** `ADD_MEDIA`
|
|
457
629
|
*
|
|
458
630
|
*/
|
|
459
|
-
export declare const
|
|
631
|
+
export declare const adminReviewAllowlistCreate: <ThrowOnError extends boolean = false>(options: Options<AdminReviewAllowlistCreateData, ThrowOnError>) => import("./client").RequestResult<AdminReviewAllowlistCreateResponses, AdminReviewAllowlistCreateErrors, ThrowOnError, "fields">;
|
|
460
632
|
/**
|
|
461
|
-
*
|
|
633
|
+
* Remove from allowlist
|
|
462
634
|
*
|
|
463
|
-
*
|
|
464
|
-
* When status changes to ACCEPTED, REJECTED, or RESOLVED, resolvedAt and resolvedById are set automatically.
|
|
635
|
+
* Removes an item from the review allowlist, re-enabling auto-checks for that media/episode.
|
|
465
636
|
*
|
|
466
|
-
* **
|
|
467
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
637
|
+
* **Permissions:** `ADD_MEDIA`
|
|
468
638
|
*
|
|
469
639
|
*/
|
|
470
|
-
export declare const
|
|
640
|
+
export declare const adminReviewAllowlistDestroy: <ThrowOnError extends boolean = false>(options: Options<AdminReviewAllowlistDestroyData, ThrowOnError>) => import("./client").RequestResult<AdminReviewAllowlistDestroyResponses, AdminReviewAllowlistDestroyErrors, ThrowOnError, "fields">;
|
|
471
641
|
//# sourceMappingURL=sdk.gen.d.ts.map
|