@brigadasos/nadeshiko-sdk 1.4.0-dev.c253525 → 1.4.3-dev.09dcbc3
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 +129 -8
- 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 +470 -248
- package/dist/index.cjs.map +5 -5
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +466 -244
- package/dist/index.js.map +5 -5
- package/dist/internal/admin.gen.d.ts +2 -0
- package/dist/internal/admin.gen.d.ts.map +1 -0
- package/dist/internal/media.gen.d.ts +1 -1
- package/dist/internal/media.gen.d.ts.map +1 -1
- package/dist/internal/user.gen.d.ts +2 -0
- package/dist/internal/user.gen.d.ts.map +1 -0
- package/dist/internal.gen.d.ts +2 -2
- package/dist/internal.gen.d.ts.map +1 -1
- package/dist/nadeshiko.gen.d.ts +76 -47
- package/dist/nadeshiko.gen.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +369 -169
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +2942 -1718
- package/dist/types.gen.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/internal/lists.gen.d.ts +0 -2
- package/dist/internal/lists.gen.d.ts.map +0 -1
- package/dist/internal/search.gen.d.ts +0 -2
- 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 {
|
|
2
|
+
import type { AddMediaToSeriesData, AddMediaToSeriesErrors, AddMediaToSeriesResponses, AddSegmentToCollectionData, AddSegmentToCollectionErrors, AddSegmentToCollectionResponses, AutocompleteMediaData, AutocompleteMediaErrors, AutocompleteMediaResponses, 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
|
-
* **
|
|
49
|
-
* - API Key with `READ_MEDIA` permission
|
|
38
|
+
* **Permissions:** `READ_MEDIA`
|
|
50
39
|
*
|
|
51
40
|
*/
|
|
52
|
-
export declare const
|
|
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
|
-
* **
|
|
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,257 @@ 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
|
-
* **
|
|
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
73
|
/**
|
|
87
|
-
*
|
|
74
|
+
* List all media
|
|
88
75
|
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
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.
|
|
91
78
|
*
|
|
92
|
-
* **
|
|
93
|
-
* - Required scopes: `READ_MEDIA`
|
|
79
|
+
* **Permissions:** `READ_MEDIA`
|
|
94
80
|
*
|
|
95
81
|
*/
|
|
96
|
-
export declare const
|
|
82
|
+
export declare const listMedia: <ThrowOnError extends boolean = false>(options?: Options<ListMediaData, ThrowOnError>) => import("./client").RequestResult<ListMediaResponses, ListMediaErrors, ThrowOnError, "fields">;
|
|
97
83
|
/**
|
|
98
|
-
*
|
|
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.
|
|
84
|
+
* Create new media
|
|
103
85
|
*
|
|
104
|
-
*
|
|
105
|
-
* - Browsing the media library
|
|
106
|
-
* - Getting media metadata for display
|
|
86
|
+
* Creates a new media entry in the database.
|
|
107
87
|
*
|
|
108
|
-
* **
|
|
109
|
-
* - Required Scopes: `READ_MEDIA`
|
|
88
|
+
* **Permissions:** `ADD_MEDIA`
|
|
110
89
|
*
|
|
111
90
|
*/
|
|
112
|
-
export declare const
|
|
91
|
+
export declare const createMedia: <ThrowOnError extends boolean = false>(options: Options<CreateMediaData, ThrowOnError>) => import("./client").RequestResult<CreateMediaResponses, CreateMediaErrors, ThrowOnError, "fields">;
|
|
113
92
|
/**
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
* Returns a paginated list of media with full metadata, including cover/banner images, episode counts, and genres.
|
|
93
|
+
* Autocomplete media by name
|
|
117
94
|
*
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
* Create new media
|
|
95
|
+
* Returns a short list of media matching a name prefix or substring.
|
|
96
|
+
* Results are ranked by exact match, then prefix match, then contains match,
|
|
97
|
+
* and further sorted by name length.
|
|
122
98
|
*
|
|
123
|
-
*
|
|
99
|
+
* **Permissions:** `READ_MEDIA`
|
|
124
100
|
*
|
|
125
101
|
*/
|
|
126
|
-
export declare const
|
|
102
|
+
export declare const autocompleteMedia: <ThrowOnError extends boolean = false>(options: Options<AutocompleteMediaData, ThrowOnError>) => import("./client").RequestResult<AutocompleteMediaResponses, AutocompleteMediaErrors, ThrowOnError, "fields">;
|
|
127
103
|
/**
|
|
128
104
|
* Delete media (soft delete)
|
|
129
105
|
*
|
|
130
|
-
* Soft
|
|
106
|
+
* Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
|
|
107
|
+
*
|
|
108
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
131
109
|
*
|
|
132
110
|
*/
|
|
133
|
-
export declare const
|
|
111
|
+
export declare const deleteMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError, "fields">;
|
|
134
112
|
/**
|
|
135
113
|
* Get single media
|
|
136
114
|
*
|
|
137
|
-
*
|
|
115
|
+
* Returns a single media entry by its ID with full metadata.
|
|
116
|
+
*
|
|
117
|
+
* **Permissions:** `READ_MEDIA`
|
|
138
118
|
*
|
|
139
119
|
*/
|
|
140
|
-
export declare const
|
|
120
|
+
export declare const getMedia: <ThrowOnError extends boolean = false>(options: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, GetMediaErrors, ThrowOnError, "fields">;
|
|
141
121
|
/**
|
|
142
122
|
* Update media
|
|
143
123
|
*
|
|
144
|
-
* Updates an existing media entry.
|
|
124
|
+
* Updates an existing media entry. Only provided fields will be updated.
|
|
125
|
+
*
|
|
126
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
145
127
|
*
|
|
146
128
|
*/
|
|
147
|
-
export declare const
|
|
129
|
+
export declare const updateMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError, "fields">;
|
|
148
130
|
/**
|
|
149
131
|
* List episodes for a media
|
|
150
132
|
*
|
|
151
|
-
*
|
|
133
|
+
* Returns a paginated list of episodes for a specific media.
|
|
134
|
+
*
|
|
135
|
+
* **Permissions:** `READ_MEDIA`
|
|
152
136
|
*
|
|
153
137
|
*/
|
|
154
|
-
export declare const
|
|
138
|
+
export declare const listEpisodes: <ThrowOnError extends boolean = false>(options: Options<ListEpisodesData, ThrowOnError>) => import("./client").RequestResult<ListEpisodesResponses, ListEpisodesErrors, ThrowOnError, "fields">;
|
|
155
139
|
/**
|
|
156
140
|
* Create new episode
|
|
157
141
|
*
|
|
158
|
-
*
|
|
142
|
+
* Creates a new episode for a specific media.
|
|
143
|
+
*
|
|
144
|
+
* **Permissions:** `ADD_MEDIA`
|
|
159
145
|
*
|
|
160
146
|
*/
|
|
161
|
-
export declare const
|
|
147
|
+
export declare const createEpisode: <ThrowOnError extends boolean = false>(options: Options<CreateEpisodeData, ThrowOnError>) => import("./client").RequestResult<CreateEpisodeResponses, CreateEpisodeErrors, ThrowOnError, "fields">;
|
|
162
148
|
/**
|
|
163
149
|
* Delete an episode
|
|
164
150
|
*
|
|
165
|
-
* Soft
|
|
151
|
+
* Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
|
|
152
|
+
*
|
|
153
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
166
154
|
*
|
|
167
155
|
*/
|
|
168
|
-
export declare const
|
|
156
|
+
export declare const deleteEpisode: <ThrowOnError extends boolean = false>(options: Options<DeleteEpisodeData, ThrowOnError>) => import("./client").RequestResult<DeleteEpisodeResponses, DeleteEpisodeErrors, ThrowOnError, "fields">;
|
|
169
157
|
/**
|
|
170
158
|
* Get single episode
|
|
171
159
|
*
|
|
172
|
-
*
|
|
160
|
+
* Returns a specific episode by media ID and episode number.
|
|
161
|
+
*
|
|
162
|
+
* **Permissions:** `READ_MEDIA`
|
|
173
163
|
*
|
|
174
164
|
*/
|
|
175
|
-
export declare const
|
|
165
|
+
export declare const getEpisode: <ThrowOnError extends boolean = false>(options: Options<GetEpisodeData, ThrowOnError>) => import("./client").RequestResult<GetEpisodeResponses, GetEpisodeErrors, ThrowOnError, "fields">;
|
|
176
166
|
/**
|
|
177
167
|
* Update episode
|
|
178
168
|
*
|
|
179
|
-
*
|
|
169
|
+
* Updates an existing episode. Only provided fields will be updated.
|
|
170
|
+
*
|
|
171
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
180
172
|
*
|
|
181
173
|
*/
|
|
182
|
-
export declare const
|
|
174
|
+
export declare const updateEpisode: <ThrowOnError extends boolean = false>(options: Options<UpdateEpisodeData, ThrowOnError>) => import("./client").RequestResult<UpdateEpisodeResponses, UpdateEpisodeErrors, ThrowOnError, "fields">;
|
|
183
175
|
/**
|
|
184
176
|
* List segments for an episode
|
|
185
177
|
*
|
|
186
|
-
*
|
|
178
|
+
* Returns a paginated list of segments for a specific episode.
|
|
179
|
+
*
|
|
180
|
+
* **Permissions:** `READ_MEDIA`
|
|
187
181
|
*
|
|
188
182
|
*/
|
|
189
|
-
export declare const
|
|
183
|
+
export declare const listSegments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError, "fields">;
|
|
190
184
|
/**
|
|
191
185
|
* Create new segment
|
|
192
186
|
*
|
|
193
|
-
*
|
|
187
|
+
* Creates a new segment for a specific episode.
|
|
188
|
+
*
|
|
189
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
194
190
|
*
|
|
195
191
|
*/
|
|
196
|
-
export declare const
|
|
192
|
+
export declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError, "fields">;
|
|
197
193
|
/**
|
|
198
|
-
* Delete segment
|
|
194
|
+
* Delete segment
|
|
199
195
|
*
|
|
200
|
-
*
|
|
196
|
+
* Soft-deletes a segment by setting its status to DELETED.
|
|
197
|
+
*
|
|
198
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
201
199
|
*
|
|
202
200
|
*/
|
|
203
|
-
export declare const
|
|
201
|
+
export declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => import("./client").RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError, "fields">;
|
|
204
202
|
/**
|
|
205
203
|
* Get single segment
|
|
206
204
|
*
|
|
207
|
-
*
|
|
205
|
+
* Returns a specific segment by its ID within the media/episode hierarchy.
|
|
206
|
+
*
|
|
207
|
+
* **Permissions:** `READ_MEDIA`
|
|
208
208
|
*
|
|
209
209
|
*/
|
|
210
|
-
export declare const
|
|
210
|
+
export declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => import("./client").RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError, "fields">;
|
|
211
211
|
/**
|
|
212
212
|
* Update segment
|
|
213
213
|
*
|
|
214
|
-
*
|
|
214
|
+
* Updates an existing segment. Only provided fields will be updated.
|
|
215
|
+
*
|
|
216
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
215
217
|
*
|
|
216
218
|
*/
|
|
217
|
-
export declare const
|
|
219
|
+
export declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError, "fields">;
|
|
218
220
|
/**
|
|
219
221
|
* Get segment by UUID
|
|
220
222
|
*
|
|
221
|
-
*
|
|
223
|
+
* Returns a specific segment by its UUID. A shortcut alternative to the nested `/media/{mediaId}/episodes/{episodeNumber}/segments/{id}` path.
|
|
224
|
+
*
|
|
225
|
+
* **Permissions:** `READ_MEDIA`
|
|
226
|
+
*
|
|
227
|
+
*/
|
|
228
|
+
export declare const getSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<GetSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<GetSegmentByUuidResponses, GetSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
229
|
+
/**
|
|
230
|
+
* Get surrounding context for a segment
|
|
231
|
+
*
|
|
232
|
+
* Retrieves segments surrounding a specific segment within an episode.
|
|
233
|
+
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
234
|
+
*
|
|
235
|
+
* **Permissions:** `READ_MEDIA`
|
|
222
236
|
*
|
|
223
237
|
*/
|
|
224
|
-
export declare const
|
|
238
|
+
export declare const getSegmentContext: <ThrowOnError extends boolean = false>(options: Options<GetSegmentContextData, ThrowOnError>) => import("./client").RequestResult<GetSegmentContextResponses, GetSegmentContextErrors, ThrowOnError, "fields">;
|
|
239
|
+
/**
|
|
240
|
+
* List all series
|
|
241
|
+
*
|
|
242
|
+
* Returns a paginated list of media series groupings.
|
|
243
|
+
*
|
|
244
|
+
*/
|
|
245
|
+
export declare const listSeries: <ThrowOnError extends boolean = false>(options?: Options<ListSeriesData, ThrowOnError>) => import("./client").RequestResult<ListSeriesResponses, ListSeriesErrors, ThrowOnError, "fields">;
|
|
246
|
+
/**
|
|
247
|
+
* Create series
|
|
248
|
+
*
|
|
249
|
+
* Creates a new media series grouping.
|
|
250
|
+
*
|
|
251
|
+
*/
|
|
252
|
+
export declare const createSeries: <ThrowOnError extends boolean = false>(options: Options<CreateSeriesData, ThrowOnError>) => import("./client").RequestResult<CreateSeriesResponses, CreateSeriesErrors, ThrowOnError, "fields">;
|
|
253
|
+
/**
|
|
254
|
+
* Delete series
|
|
255
|
+
*
|
|
256
|
+
* Deletes a series and all its media associations.
|
|
257
|
+
*
|
|
258
|
+
*/
|
|
259
|
+
export declare const deleteSeries: <ThrowOnError extends boolean = false>(options: Options<DeleteSeriesData, ThrowOnError>) => import("./client").RequestResult<DeleteSeriesResponses, DeleteSeriesErrors, ThrowOnError, "fields">;
|
|
260
|
+
/**
|
|
261
|
+
* Get series details
|
|
262
|
+
*
|
|
263
|
+
* Returns a series with all media entries sorted by position.
|
|
264
|
+
*
|
|
265
|
+
*/
|
|
266
|
+
export declare const getSeries: <ThrowOnError extends boolean = false>(options: Options<GetSeriesData, ThrowOnError>) => import("./client").RequestResult<GetSeriesResponses, GetSeriesErrors, ThrowOnError, "fields">;
|
|
267
|
+
/**
|
|
268
|
+
* Update series metadata
|
|
269
|
+
*
|
|
270
|
+
* Updates series localized names.
|
|
271
|
+
*
|
|
272
|
+
*/
|
|
273
|
+
export declare const updateSeries: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesResponses, UpdateSeriesErrors, ThrowOnError, "fields">;
|
|
274
|
+
/**
|
|
275
|
+
* Add media to series
|
|
276
|
+
*
|
|
277
|
+
* Adds a media entry to a series at a specific position.
|
|
278
|
+
*
|
|
279
|
+
*/
|
|
280
|
+
export declare const addMediaToSeries: <ThrowOnError extends boolean = false>(options: Options<AddMediaToSeriesData, ThrowOnError>) => import("./client").RequestResult<AddMediaToSeriesResponses, AddMediaToSeriesErrors, ThrowOnError, "fields">;
|
|
281
|
+
/**
|
|
282
|
+
* Remove media from series
|
|
283
|
+
*
|
|
284
|
+
* Removes a media entry from a series.
|
|
285
|
+
*
|
|
286
|
+
*/
|
|
287
|
+
export declare const removeMediaFromSeries: <ThrowOnError extends boolean = false>(options: Options<RemoveMediaFromSeriesData, ThrowOnError>) => import("./client").RequestResult<RemoveMediaFromSeriesResponses, RemoveMediaFromSeriesErrors, ThrowOnError, "fields">;
|
|
288
|
+
/**
|
|
289
|
+
* Update media position in series
|
|
290
|
+
*
|
|
291
|
+
* Updates the position of a media entry in a series.
|
|
292
|
+
*
|
|
293
|
+
*/
|
|
294
|
+
export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesMediaResponses, UpdateSeriesMediaErrors, ThrowOnError, "fields">;
|
|
225
295
|
/**
|
|
226
296
|
* Get character details
|
|
227
297
|
*
|
|
228
|
-
* Returns a character with their seiyuu and all media appearances.
|
|
298
|
+
* Returns a character with their voice actors (seiyuu) and all media appearances.
|
|
299
|
+
*
|
|
300
|
+
* **Permissions:** `READ_MEDIA`
|
|
229
301
|
*
|
|
230
302
|
*/
|
|
231
|
-
export declare const
|
|
303
|
+
export declare const getCharacter: <ThrowOnError extends boolean = false>(options: Options<GetCharacterData, ThrowOnError>) => import("./client").RequestResult<GetCharacterResponses, GetCharacterErrors, ThrowOnError, "fields">;
|
|
232
304
|
/**
|
|
233
305
|
* Get seiyuu details
|
|
234
306
|
*
|
|
235
|
-
* Returns a voice actor with all characters they voiced and media appearances.
|
|
307
|
+
* Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
|
|
308
|
+
*
|
|
309
|
+
* **Permissions:** `READ_MEDIA`
|
|
236
310
|
*
|
|
237
311
|
*/
|
|
238
|
-
export declare const
|
|
312
|
+
export declare const getSeiyuu: <ThrowOnError extends boolean = false>(options: Options<GetSeiyuuData, ThrowOnError>) => import("./client").RequestResult<GetSeiyuuResponses, GetSeiyuuErrors, ThrowOnError, "fields">;
|
|
239
313
|
/**
|
|
240
314
|
* Get current monthly API quota
|
|
241
315
|
*
|
|
242
|
-
* Returns the
|
|
316
|
+
* Returns the API quota usage for the current billing period.
|
|
317
|
+
* Accepts both session cookie and API key authentication.
|
|
243
318
|
*
|
|
244
|
-
* **
|
|
245
|
-
* - Requires session authentication (cookie-based).
|
|
319
|
+
* **Permissions:** Session authentication (cookie-based) or API key (`READ_MEDIA`).
|
|
246
320
|
*
|
|
247
321
|
*/
|
|
248
322
|
export declare const getUserQuota: <ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError, "fields">;
|
|
@@ -251,221 +325,347 @@ export declare const getUserQuota: <ThrowOnError extends boolean = false>(option
|
|
|
251
325
|
*
|
|
252
326
|
* Returns the authenticated user's submitted reports with cursor pagination.
|
|
253
327
|
*
|
|
254
|
-
* **
|
|
255
|
-
* - Requires session authentication (cookie-based).
|
|
328
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
256
329
|
*
|
|
257
330
|
*/
|
|
258
|
-
export declare const
|
|
331
|
+
export declare const listUserReports: <ThrowOnError extends boolean = false>(options?: Options<ListUserReportsData, ThrowOnError>) => import("./client").RequestResult<ListUserReportsResponses, ListUserReportsErrors, ThrowOnError, "fields">;
|
|
259
332
|
/**
|
|
260
333
|
* Create a new report
|
|
261
334
|
*
|
|
262
335
|
* Submit a report for a segment or media entry.
|
|
263
336
|
*
|
|
264
|
-
* **
|
|
265
|
-
* - Requires session authentication (cookie-based).
|
|
337
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
266
338
|
*
|
|
267
339
|
*/
|
|
268
|
-
export declare const
|
|
340
|
+
export declare const createUserReport: <ThrowOnError extends boolean = false>(options: Options<CreateUserReportData, ThrowOnError>) => import("./client").RequestResult<CreateUserReportResponses, CreateUserReportErrors, ThrowOnError, "fields">;
|
|
269
341
|
/**
|
|
270
|
-
*
|
|
342
|
+
* Get user preferences
|
|
343
|
+
*
|
|
344
|
+
* Returns the authenticated user's full preferences object.
|
|
271
345
|
*
|
|
272
|
-
*
|
|
346
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
273
347
|
*
|
|
274
348
|
*/
|
|
275
|
-
export declare const
|
|
349
|
+
export declare const getUserPreferences: <ThrowOnError extends boolean = false>(options?: Options<GetUserPreferencesData, ThrowOnError>) => import("./client").RequestResult<GetUserPreferencesResponses, GetUserPreferencesErrors, ThrowOnError, "fields">;
|
|
276
350
|
/**
|
|
277
|
-
*
|
|
351
|
+
* Update user preferences
|
|
278
352
|
*
|
|
279
|
-
*
|
|
353
|
+
* Deep-merges a partial preferences update into the user's existing preferences.
|
|
354
|
+
* Only the provided keys are updated; all other keys are preserved.
|
|
355
|
+
*
|
|
356
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
280
357
|
*
|
|
281
358
|
*/
|
|
282
|
-
export declare const
|
|
359
|
+
export declare const updateUserPreferences: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPreferencesData, ThrowOnError>) => import("./client").RequestResult<UpdateUserPreferencesResponses, UpdateUserPreferencesErrors, ThrowOnError, "fields">;
|
|
283
360
|
/**
|
|
284
|
-
*
|
|
361
|
+
* Clear user activity history
|
|
362
|
+
*
|
|
363
|
+
* Deletes the authenticated user's activity history. Optionally filter by activity type.
|
|
285
364
|
*
|
|
286
|
-
*
|
|
365
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
287
366
|
*
|
|
288
367
|
*/
|
|
289
|
-
export declare const
|
|
368
|
+
export declare const deleteUserActivity: <ThrowOnError extends boolean = false>(options?: Options<DeleteUserActivityData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityResponses, DeleteUserActivityErrors, ThrowOnError, "fields">;
|
|
290
369
|
/**
|
|
291
|
-
* Get
|
|
370
|
+
* Get user activity history
|
|
292
371
|
*
|
|
293
|
-
* Returns
|
|
372
|
+
* Returns the authenticated user's activity history with cursor-based pagination.
|
|
373
|
+
*
|
|
374
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
294
375
|
*
|
|
295
376
|
*/
|
|
296
|
-
export declare const
|
|
377
|
+
export declare const listUserActivity: <ThrowOnError extends boolean = false>(options?: Options<ListUserActivityData, ThrowOnError>) => import("./client").RequestResult<ListUserActivityResponses, ListUserActivityErrors, ThrowOnError, "fields">;
|
|
297
378
|
/**
|
|
298
|
-
*
|
|
379
|
+
* Get activity heatmap data
|
|
380
|
+
*
|
|
381
|
+
* Returns daily activity counts for the authenticated user, grouped by date.
|
|
382
|
+
* Designed for rendering a GitHub-style contribution heatmap.
|
|
299
383
|
*
|
|
300
|
-
*
|
|
384
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
301
385
|
*
|
|
302
386
|
*/
|
|
303
|
-
export declare const
|
|
387
|
+
export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityHeatmapData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityHeatmapResponses, GetUserActivityHeatmapErrors, ThrowOnError, "fields">;
|
|
304
388
|
/**
|
|
305
|
-
*
|
|
389
|
+
* Get user activity statistics
|
|
306
390
|
*
|
|
307
|
-
*
|
|
391
|
+
* Returns aggregate statistics about the authenticated user's activity:
|
|
392
|
+
* total searches, exports, plays, and study streak.
|
|
393
|
+
*
|
|
394
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
395
|
+
*
|
|
396
|
+
*/
|
|
397
|
+
export declare const getUserActivityStats: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityStatsData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityStatsResponses, GetUserActivityStatsErrors, ThrowOnError, "fields">;
|
|
398
|
+
/**
|
|
399
|
+
* Export all user data
|
|
400
|
+
*
|
|
401
|
+
* Returns a full JSON export of all user-related data for GDPR data portability.
|
|
402
|
+
* Includes profile, preferences, activity history, collections, and reports.
|
|
403
|
+
*
|
|
404
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
405
|
+
*
|
|
406
|
+
*/
|
|
407
|
+
export declare const exportUserData: <ThrowOnError extends boolean = false>(options?: Options<ExportUserDataData, ThrowOnError>) => import("./client").RequestResult<ExportUserDataResponses, ExportUserDataErrors, ThrowOnError, "fields">;
|
|
408
|
+
/**
|
|
409
|
+
* List lab features with user opt-in status
|
|
410
|
+
*
|
|
411
|
+
* Returns all available lab features merged with the authenticated user's
|
|
412
|
+
* opt-in status. Features gated by role are excluded if the user lacks
|
|
413
|
+
* the required role.
|
|
414
|
+
*
|
|
415
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
416
|
+
*
|
|
417
|
+
*/
|
|
418
|
+
export declare const listUserLabs: <ThrowOnError extends boolean = false>(options?: Options<ListUserLabsData, ThrowOnError>) => import("./client").RequestResult<ListUserLabsResponses, ListUserLabsErrors, ThrowOnError, "fields">;
|
|
419
|
+
/**
|
|
420
|
+
* List user's collections
|
|
421
|
+
*
|
|
422
|
+
* Returns all collections for the authenticated user. Can filter by visibility.
|
|
308
423
|
*
|
|
309
424
|
*/
|
|
310
|
-
export declare const
|
|
425
|
+
export declare const listCollections: <ThrowOnError extends boolean = false>(options?: Options<ListCollectionsData, ThrowOnError>) => import("./client").RequestResult<ListCollectionsResponses, ListCollectionsErrors, ThrowOnError, "fields">;
|
|
311
426
|
/**
|
|
312
|
-
*
|
|
427
|
+
* Create collection
|
|
313
428
|
*
|
|
314
|
-
*
|
|
429
|
+
* Creates a new segment collection for the authenticated user.
|
|
315
430
|
*
|
|
316
431
|
*/
|
|
317
|
-
export declare const
|
|
432
|
+
export declare const createCollection: <ThrowOnError extends boolean = false>(options: Options<CreateCollectionData, ThrowOnError>) => import("./client").RequestResult<CreateCollectionResponses, CreateCollectionErrors, ThrowOnError, "fields">;
|
|
318
433
|
/**
|
|
319
|
-
*
|
|
434
|
+
* Delete collection
|
|
320
435
|
*
|
|
321
|
-
*
|
|
436
|
+
* Deletes a collection and all its segment entries. Requires collection ownership.
|
|
322
437
|
*
|
|
323
438
|
*/
|
|
324
|
-
export declare const
|
|
439
|
+
export declare const deleteCollection: <ThrowOnError extends boolean = false>(options: Options<DeleteCollectionData, ThrowOnError>) => import("./client").RequestResult<DeleteCollectionResponses, DeleteCollectionErrors, ThrowOnError, "fields">;
|
|
325
440
|
/**
|
|
326
|
-
* Get
|
|
441
|
+
* Get collection details
|
|
327
442
|
*
|
|
328
|
-
* Returns
|
|
443
|
+
* Returns a collection with paginated segments and their search result data.
|
|
329
444
|
*
|
|
330
445
|
*/
|
|
331
|
-
export declare const
|
|
446
|
+
export declare const getCollection: <ThrowOnError extends boolean = false>(options: Options<GetCollectionData, ThrowOnError>) => import("./client").RequestResult<GetCollectionResponses, GetCollectionErrors, ThrowOnError, "fields">;
|
|
332
447
|
/**
|
|
333
|
-
*
|
|
448
|
+
* Update collection metadata
|
|
334
449
|
*
|
|
335
|
-
*
|
|
450
|
+
* Updates collection name or visibility. Requires collection ownership.
|
|
336
451
|
*
|
|
337
452
|
*/
|
|
338
|
-
export declare const
|
|
453
|
+
export declare const updateCollection: <ThrowOnError extends boolean = false>(options: Options<UpdateCollectionData, ThrowOnError>) => import("./client").RequestResult<UpdateCollectionResponses, UpdateCollectionErrors, ThrowOnError, "fields">;
|
|
339
454
|
/**
|
|
340
|
-
*
|
|
455
|
+
* Add segment to collection
|
|
341
456
|
*
|
|
342
|
-
*
|
|
457
|
+
* Adds a segment to a collection. Requires collection ownership.
|
|
343
458
|
*
|
|
344
459
|
*/
|
|
345
|
-
export declare const
|
|
460
|
+
export declare const addSegmentToCollection: <ThrowOnError extends boolean = false>(options: Options<AddSegmentToCollectionData, ThrowOnError>) => import("./client").RequestResult<AddSegmentToCollectionResponses, AddSegmentToCollectionErrors, ThrowOnError, "fields">;
|
|
346
461
|
/**
|
|
347
|
-
*
|
|
462
|
+
* Remove segment from collection
|
|
348
463
|
*
|
|
349
|
-
*
|
|
464
|
+
* Removes a segment from a collection. Requires collection ownership.
|
|
350
465
|
*
|
|
351
466
|
*/
|
|
352
|
-
export declare const
|
|
467
|
+
export declare const removeSegmentFromCollection: <ThrowOnError extends boolean = false>(options: Options<RemoveSegmentFromCollectionData, ThrowOnError>) => import("./client").RequestResult<RemoveSegmentFromCollectionResponses, RemoveSegmentFromCollectionErrors, ThrowOnError, "fields">;
|
|
468
|
+
/**
|
|
469
|
+
* Update segment in collection
|
|
470
|
+
*
|
|
471
|
+
* Updates the note or position of a segment in a collection. Requires collection ownership.
|
|
472
|
+
*
|
|
473
|
+
*/
|
|
474
|
+
export declare const updateCollectionSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateCollectionSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateCollectionSegmentResponses, UpdateCollectionSegmentErrors, ThrowOnError, "fields">;
|
|
475
|
+
/**
|
|
476
|
+
* Admin dashboard statistics
|
|
477
|
+
*
|
|
478
|
+
* Returns at-a-glance statistics for the admin dashboard including media counts,
|
|
479
|
+
* user counts, and system health information.
|
|
480
|
+
*
|
|
481
|
+
* **Permissions:** `ADD_MEDIA`
|
|
482
|
+
*
|
|
483
|
+
*/
|
|
484
|
+
export declare const getAdminDashboard: <ThrowOnError extends boolean = false>(options?: Options<GetAdminDashboardData, ThrowOnError>) => import("./client").RequestResult<GetAdminDashboardResponses, GetAdminDashboardErrors, ThrowOnError, "fields">;
|
|
485
|
+
/**
|
|
486
|
+
* System health check
|
|
487
|
+
*
|
|
488
|
+
* Returns connectivity status and version information for all backend subsystems
|
|
489
|
+
* (Elasticsearch, PostgreSQL, application).
|
|
490
|
+
*
|
|
491
|
+
* **Permissions:** `ADD_MEDIA`
|
|
492
|
+
*
|
|
493
|
+
*/
|
|
494
|
+
export declare const getAdminHealth: <ThrowOnError extends boolean = false>(options?: Options<GetAdminHealthData, ThrowOnError>) => import("./client").RequestResult<GetAdminHealthResponses, GetAdminHealthErrors, ThrowOnError, "fields">;
|
|
353
495
|
/**
|
|
354
496
|
* Reindex database into Elasticsearch
|
|
355
497
|
*
|
|
356
498
|
* Reindexes segments from the PostgreSQL database into Elasticsearch.
|
|
357
499
|
* Allows filtering by specific media IDs or episodes.
|
|
358
500
|
*
|
|
359
|
-
* **Requirements:**
|
|
360
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission for reindexing)
|
|
361
|
-
*
|
|
362
501
|
* **Behavior:**
|
|
363
502
|
* - If no filters provided, reindexes all segments
|
|
364
503
|
* - If `mediaIds` provided, reindexes all segments from those media
|
|
365
504
|
* - If `episodes` provided, reindexes only the specified episodes
|
|
366
505
|
*
|
|
506
|
+
* **Permissions:** `ADD_MEDIA`
|
|
507
|
+
*
|
|
367
508
|
*/
|
|
368
|
-
export declare const
|
|
509
|
+
export declare const triggerReindex: <ThrowOnError extends boolean = false>(options?: Options<TriggerReindexData, ThrowOnError>) => import("./client").RequestResult<TriggerReindexResponses, TriggerReindexErrors, ThrowOnError, "fields">;
|
|
369
510
|
/**
|
|
370
511
|
* Get queue statistics
|
|
371
512
|
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
* **Requirements:**
|
|
375
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
513
|
+
* Returns statistics for all ES sync queues including pending and failed job counts.
|
|
376
514
|
*
|
|
377
515
|
* **Use cases:**
|
|
378
516
|
* - Monitor queue health
|
|
379
517
|
* - Detect stuck jobs
|
|
380
518
|
* - Check backlog size
|
|
381
519
|
*
|
|
520
|
+
* **Permissions:** `ADD_MEDIA`
|
|
521
|
+
*
|
|
382
522
|
*/
|
|
383
|
-
export declare const
|
|
523
|
+
export declare const listAdminQueueStats: <ThrowOnError extends boolean = false>(options?: Options<ListAdminQueueStatsData, ThrowOnError>) => import("./client").RequestResult<ListAdminQueueStatsResponses, ListAdminQueueStatsErrors, ThrowOnError, "fields">;
|
|
384
524
|
/**
|
|
385
525
|
* Get detailed queue information
|
|
386
526
|
*
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
* **Requirements:**
|
|
390
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
527
|
+
* Returns live queue stats and queue metadata from PgBoss for a specific queue.
|
|
391
528
|
*
|
|
392
529
|
* **Queue names:**
|
|
393
|
-
* - `es-sync-create` - Jobs to create new segments
|
|
530
|
+
* - `es-sync-create` - Jobs to create new segments in Elasticsearch
|
|
394
531
|
* - `es-sync-update` - Jobs to update existing segments
|
|
395
532
|
* - `es-sync-delete` - Jobs to delete segments
|
|
396
533
|
*
|
|
534
|
+
* **Permissions:** `ADD_MEDIA`
|
|
535
|
+
*
|
|
397
536
|
*/
|
|
398
|
-
export declare const
|
|
537
|
+
export declare const getAdminQueue: <ThrowOnError extends boolean = false>(options: Options<GetAdminQueueData, ThrowOnError>) => import("./client").RequestResult<GetAdminQueueResponses, GetAdminQueueErrors, ThrowOnError, "fields">;
|
|
399
538
|
/**
|
|
400
539
|
* Get failed jobs from a queue
|
|
401
540
|
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
* **Requirements:**
|
|
405
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
541
|
+
* Returns jobs that have exceeded their retry limit and permanently failed.
|
|
406
542
|
*
|
|
407
543
|
* **Use cases:**
|
|
408
544
|
* - Identify segments that failed to sync to Elasticsearch
|
|
409
545
|
* - Debug persistent sync issues
|
|
410
546
|
* - Decide whether to retry or purge failed jobs
|
|
411
547
|
*
|
|
548
|
+
* **Permissions:** `ADD_MEDIA`
|
|
549
|
+
*
|
|
412
550
|
*/
|
|
413
|
-
export declare const
|
|
551
|
+
export declare const listAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<ListAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<ListAdminQueueFailedResponses, ListAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
414
552
|
/**
|
|
415
553
|
* Retry failed jobs from a queue
|
|
416
554
|
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
* **Requirements:**
|
|
420
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
555
|
+
* Re-enqueues all failed jobs from a specific queue for another attempt.
|
|
421
556
|
*
|
|
422
557
|
* **Use cases:**
|
|
423
558
|
* - Retry jobs that failed due to temporary Elasticsearch issues
|
|
424
559
|
* - Recover from network blips
|
|
425
560
|
*
|
|
561
|
+
* **Permissions:** `ADD_MEDIA`
|
|
562
|
+
*
|
|
426
563
|
*/
|
|
427
|
-
export declare const
|
|
564
|
+
export declare const retryAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<RetryAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<RetryAdminQueueFailedResponses, RetryAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
428
565
|
/**
|
|
429
|
-
*
|
|
566
|
+
* Purge failed jobs from a queue
|
|
430
567
|
*
|
|
431
|
-
* Permanently
|
|
432
|
-
*
|
|
433
|
-
* **Requirements:**
|
|
434
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
568
|
+
* Permanently deletes all failed jobs from a queue.
|
|
569
|
+
* This does **not** re-sync the affected segments — use the reindex endpoint for that.
|
|
435
570
|
*
|
|
436
571
|
* **Use cases:**
|
|
437
572
|
* - Clean up old failed jobs after investigating
|
|
438
573
|
* - Reset a queue after fixing the underlying issue
|
|
439
|
-
*
|
|
574
|
+
*
|
|
575
|
+
* **Permissions:** `ADD_MEDIA`
|
|
576
|
+
*
|
|
577
|
+
*/
|
|
578
|
+
export declare const purgeAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<PurgeAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<PurgeAdminQueueFailedResponses, PurgeAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
579
|
+
/**
|
|
580
|
+
* List all reports
|
|
581
|
+
*
|
|
582
|
+
* Returns all reports with filtering and cursor pagination.
|
|
583
|
+
* Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
|
|
584
|
+
*
|
|
585
|
+
* **Permissions:** `ADD_MEDIA`
|
|
586
|
+
*
|
|
587
|
+
*/
|
|
588
|
+
export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
|
|
589
|
+
/**
|
|
590
|
+
* Update a report
|
|
591
|
+
*
|
|
592
|
+
* Updates the status and/or admin notes of a report.
|
|
593
|
+
* Works for both USER and AUTO reports.
|
|
594
|
+
*
|
|
595
|
+
* **Permissions:** `ADD_MEDIA`
|
|
596
|
+
*
|
|
597
|
+
*/
|
|
598
|
+
export declare const updateAdminReport: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReportData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReportResponses, UpdateAdminReportErrors, ThrowOnError, "fields">;
|
|
599
|
+
/**
|
|
600
|
+
* Run auto-checks
|
|
601
|
+
*
|
|
602
|
+
* Triggers all enabled auto-checks. Creates ReviewCheckRun records and AUTO reports for any findings.
|
|
603
|
+
*
|
|
604
|
+
* **Permissions:** `ADD_MEDIA`
|
|
440
605
|
*
|
|
441
606
|
*/
|
|
442
|
-
export declare const
|
|
607
|
+
export declare const runAdminReview: <ThrowOnError extends boolean = false>(options?: Options<RunAdminReviewData, ThrowOnError>) => import("./client").RequestResult<RunAdminReviewResponses, RunAdminReviewErrors, ThrowOnError, "fields">;
|
|
443
608
|
/**
|
|
444
|
-
*
|
|
609
|
+
* List all review checks
|
|
610
|
+
*
|
|
611
|
+
* Returns all check definitions with current config, threshold schema, and latest run info.
|
|
612
|
+
*
|
|
613
|
+
* **Permissions:** `ADD_MEDIA`
|
|
614
|
+
*
|
|
615
|
+
*/
|
|
616
|
+
export declare const listAdminReviewChecks: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReviewChecksData, ThrowOnError>) => import("./client").RequestResult<ListAdminReviewChecksResponses, ListAdminReviewChecksErrors, ThrowOnError, "fields">;
|
|
617
|
+
/**
|
|
618
|
+
* Update a review check config
|
|
619
|
+
*
|
|
620
|
+
* Updates the threshold values or enabled status of a check.
|
|
621
|
+
*
|
|
622
|
+
* **Permissions:** `ADD_MEDIA`
|
|
623
|
+
*
|
|
624
|
+
*/
|
|
625
|
+
export declare const updateAdminReviewCheck: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReviewCheckData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReviewCheckResponses, UpdateAdminReviewCheckErrors, ThrowOnError, "fields">;
|
|
626
|
+
/**
|
|
627
|
+
* List past check runs
|
|
628
|
+
*
|
|
629
|
+
* Returns past review check runs with summary stats. Supports filtering by check name and cursor pagination.
|
|
630
|
+
*
|
|
631
|
+
* **Permissions:** `ADD_MEDIA`
|
|
632
|
+
*
|
|
633
|
+
*/
|
|
634
|
+
export declare const listAdminReviewRuns: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReviewRunsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReviewRunsResponses, ListAdminReviewRunsErrors, ThrowOnError, "fields">;
|
|
635
|
+
/**
|
|
636
|
+
* Get a specific run's details
|
|
637
|
+
*
|
|
638
|
+
* Returns a specific review check run record with its linked reports.
|
|
639
|
+
*
|
|
640
|
+
* **Permissions:** `ADD_MEDIA`
|
|
641
|
+
*
|
|
642
|
+
*/
|
|
643
|
+
export declare const getAdminReviewRun: <ThrowOnError extends boolean = false>(options: Options<GetAdminReviewRunData, ThrowOnError>) => import("./client").RequestResult<GetAdminReviewRunResponses, GetAdminReviewRunErrors, ThrowOnError, "fields">;
|
|
644
|
+
/**
|
|
645
|
+
* List allowlisted items
|
|
646
|
+
*
|
|
647
|
+
* Returns all allowlisted items (media/episodes) that are excluded from auto-check runs.
|
|
648
|
+
*
|
|
649
|
+
* **Permissions:** `ADD_MEDIA`
|
|
445
650
|
*
|
|
446
|
-
* Analyzes segments that are missing morpheme data using the Sudachi sidecar service.
|
|
447
651
|
*/
|
|
448
|
-
export declare const
|
|
652
|
+
export declare const listAdminReviewAllowlist: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReviewAllowlistData, ThrowOnError>) => import("./client").RequestResult<ListAdminReviewAllowlistResponses, ListAdminReviewAllowlistErrors, ThrowOnError, "fields">;
|
|
449
653
|
/**
|
|
450
|
-
*
|
|
654
|
+
* Add to allowlist
|
|
451
655
|
*
|
|
452
|
-
*
|
|
453
|
-
* Reports are grouped by target and sorted by report count descending.
|
|
656
|
+
* Adds a media or episode to the allowlist for a specific check, excluding it from future auto-check runs.
|
|
454
657
|
*
|
|
455
|
-
* **
|
|
456
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
658
|
+
* **Permissions:** `ADD_MEDIA`
|
|
457
659
|
*
|
|
458
660
|
*/
|
|
459
|
-
export declare const
|
|
661
|
+
export declare const createAdminReviewAllowlistEntry: <ThrowOnError extends boolean = false>(options: Options<CreateAdminReviewAllowlistEntryData, ThrowOnError>) => import("./client").RequestResult<CreateAdminReviewAllowlistEntryResponses, CreateAdminReviewAllowlistEntryErrors, ThrowOnError, "fields">;
|
|
460
662
|
/**
|
|
461
|
-
*
|
|
663
|
+
* Remove from allowlist
|
|
462
664
|
*
|
|
463
|
-
*
|
|
464
|
-
* When status changes to ACCEPTED, REJECTED, or RESOLVED, resolvedAt and resolvedById are set automatically.
|
|
665
|
+
* Removes an item from the review allowlist, re-enabling auto-checks for that media/episode.
|
|
465
666
|
*
|
|
466
|
-
* **
|
|
467
|
-
* - Required Scopes: `ADD_MEDIA` (admin-level permission)
|
|
667
|
+
* **Permissions:** `ADD_MEDIA`
|
|
468
668
|
*
|
|
469
669
|
*/
|
|
470
|
-
export declare const
|
|
670
|
+
export declare const deleteAdminReviewAllowlistEntry: <ThrowOnError extends boolean = false>(options: Options<DeleteAdminReviewAllowlistEntryData, ThrowOnError>) => import("./client").RequestResult<DeleteAdminReviewAllowlistEntryResponses, DeleteAdminReviewAllowlistEntryErrors, ThrowOnError, "fields">;
|
|
471
671
|
//# sourceMappingURL=sdk.gen.d.ts.map
|