@brigadasos/nadeshiko-sdk 1.4.3-dev.0ffbf39 → 1.4.3-dev.2ba18e0
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 +34 -10
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/index.cjs +286 -176
- 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 +273 -169
- package/dist/index.js.map +5 -5
- package/dist/internal/admin.gen.d.ts +1 -1
- package/dist/internal/admin.gen.d.ts.map +1 -1
- 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 +1 -1
- package/dist/internal/user.gen.d.ts.map +1 -1
- package/dist/nadeshiko.gen.d.ts +39 -33
- package/dist/nadeshiko.gen.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +219 -141
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1528 -1292
- 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 { AddMediaToSeriesData, AddMediaToSeriesErrors, AddMediaToSeriesResponses, AddSegmentToCollectionData, AddSegmentToCollectionErrors, AddSegmentToCollectionResponses,
|
|
2
|
+
import type { AddMediaToSeriesData, AddMediaToSeriesErrors, AddMediaToSeriesResponses, AddSegmentToCollectionData, AddSegmentToCollectionErrors, AddSegmentToCollectionResponses, AutocompleteMediaData, AutocompleteMediaErrors, AutocompleteMediaResponses, ClearAdminImpersonationData, ClearAdminImpersonationErrors, ClearAdminImpersonationResponses, CreateCollectionData, CreateCollectionErrors, CreateCollectionResponses, CreateEpisodeData, CreateEpisodeErrors, CreateEpisodeResponses, CreateMediaData, CreateMediaErrors, CreateMediaResponses, CreateSegmentData, CreateSegmentErrors, CreateSegmentResponses, CreateSeriesData, CreateSeriesErrors, CreateSeriesResponses, CreateUserReportData, CreateUserReportErrors, CreateUserReportResponses, DeleteCollectionData, DeleteCollectionErrors, DeleteCollectionResponses, DeleteEpisodeData, DeleteEpisodeErrors, DeleteEpisodeResponses, DeleteMediaData, DeleteMediaErrors, DeleteMediaResponses, DeleteSegmentData, DeleteSegmentErrors, DeleteSegmentResponses, DeleteSeriesData, DeleteSeriesErrors, DeleteSeriesResponses, DeleteUserActivityByDateData, DeleteUserActivityByDateErrors, DeleteUserActivityByDateResponses, DeleteUserActivityByIdData, DeleteUserActivityByIdErrors, DeleteUserActivityByIdResponses, DeleteUserActivityData, DeleteUserActivityErrors, DeleteUserActivityResponses, EnrollUserLabData, EnrollUserLabErrors, EnrollUserLabResponses, ExportUserDataData, ExportUserDataErrors, ExportUserDataResponses, GetAdminDashboardData, GetAdminDashboardErrors, GetAdminDashboardResponses, GetAdminHealthData, GetAdminHealthErrors, GetAdminHealthResponses, GetAdminMediaAuditRunData, GetAdminMediaAuditRunErrors, GetAdminMediaAuditRunResponses, GetAdminQueueData, GetAdminQueueErrors, GetAdminQueueResponses, GetCharacterData, GetCharacterErrors, GetCharacterResponses, GetCollectionData, GetCollectionErrors, GetCollectionResponses, GetCollectionStatsData, GetCollectionStatsErrors, GetCollectionStatsResponses, 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, ImpersonateAdminUserData, ImpersonateAdminUserErrors, ImpersonateAdminUserResponses, ListAdminMediaAuditRunsData, ListAdminMediaAuditRunsErrors, ListAdminMediaAuditRunsResponses, ListAdminMediaAuditsData, ListAdminMediaAuditsErrors, ListAdminMediaAuditsResponses, ListAdminQueueFailedData, ListAdminQueueFailedErrors, ListAdminQueueFailedResponses, ListAdminQueueStatsData, ListAdminQueueStatsErrors, ListAdminQueueStatsResponses, ListAdminReportsData, ListAdminReportsErrors, ListAdminReportsResponses, ListCollectionsData, ListCollectionsErrors, ListCollectionsResponses, ListEpisodesData, ListEpisodesErrors, ListEpisodesResponses, ListMediaData, ListMediaErrors, ListMediaResponses, ListSegmentsData, ListSegmentsErrors, ListSegmentsResponses, ListSeriesData, ListSeriesErrors, ListSeriesResponses, ListUserActivityData, ListUserActivityErrors, ListUserActivityResponses, ListUserLabsData, ListUserLabsErrors, ListUserLabsResponses, PurgeAdminQueueFailedData, PurgeAdminQueueFailedErrors, PurgeAdminQueueFailedResponses, RemoveMediaFromSeriesData, RemoveMediaFromSeriesErrors, RemoveMediaFromSeriesResponses, RemoveSegmentFromCollectionData, RemoveSegmentFromCollectionErrors, RemoveSegmentFromCollectionResponses, RetryAdminQueueFailedData, RetryAdminQueueFailedErrors, RetryAdminQueueFailedResponses, RunAdminMediaAuditData, RunAdminMediaAuditErrors, RunAdminMediaAuditResponses, SearchCollectionSegmentsData, SearchCollectionSegmentsErrors, SearchCollectionSegmentsResponses, SearchData, SearchErrors, SearchResponses, SearchWordsData, SearchWordsErrors, SearchWordsResponses, TrackUserActivityData, TrackUserActivityErrors, TrackUserActivityResponses, TriggerReindexData, TriggerReindexErrors, TriggerReindexResponses, UnenrollUserLabData, UnenrollUserLabErrors, UnenrollUserLabResponses, UpdateAdminMediaAuditData, UpdateAdminMediaAuditErrors, UpdateAdminMediaAuditResponses, UpdateAdminReportData, UpdateAdminReportErrors, UpdateAdminReportResponses, UpdateCollectionData, UpdateCollectionErrors, UpdateCollectionResponses, UpdateCollectionSegmentData, UpdateCollectionSegmentErrors, UpdateCollectionSegmentResponses, UpdateEpisodeData, UpdateEpisodeErrors, UpdateEpisodeResponses, UpdateMediaData, UpdateMediaErrors, UpdateMediaResponses, UpdateSegmentByUuidData, UpdateSegmentByUuidErrors, UpdateSegmentByUuidResponses, 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
|
|
@@ -16,14 +16,14 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
16
16
|
/**
|
|
17
17
|
* Search segments by query
|
|
18
18
|
*
|
|
19
|
-
* The primary search endpoint for finding Japanese segments and their translations across indexed media (anime, J-Drama
|
|
19
|
+
* The primary search endpoint for finding Japanese segments and their translations across indexed media (anime, J-Drama).
|
|
20
20
|
*
|
|
21
21
|
* This endpoint uses Elasticsearch with advanced Japanese text analysis supporting multiple input types (romaji, kanji, kana) and providing intelligent field-based boosting.
|
|
22
22
|
*
|
|
23
23
|
* **Query Features**
|
|
24
24
|
* - **Multi-language Support:** Search using Japanese (kanji/kana), Romaji, or English/Spanish
|
|
25
25
|
* - **Boolean Operators:** `AND`, `OR`, `NOT` supported (e.g., `(cat OR dog) AND bird`)
|
|
26
|
-
* - **Phrase Matching:** Use quotes for exact phrases (e.g., `"good morning"`), or pass `
|
|
26
|
+
* - **Phrase Matching:** Use quotes for exact phrases (e.g., `"good morning"`), or pass `exactMatch: true` to the request body
|
|
27
27
|
* - **Wildcards:** `te*t` format (leading wildcards not supported)
|
|
28
28
|
* - **Smart Field Selection:** Automatically chooses optimal search fields based on input type
|
|
29
29
|
*
|
|
@@ -90,234 +90,261 @@ export declare const listMedia: <ThrowOnError extends boolean = false>(options?:
|
|
|
90
90
|
*/
|
|
91
91
|
export declare const createMedia: <ThrowOnError extends boolean = false>(options: Options<CreateMediaData, ThrowOnError>) => import("./client").RequestResult<CreateMediaResponses, CreateMediaErrors, ThrowOnError, "fields">;
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* Autocomplete media by name
|
|
94
94
|
*
|
|
95
|
-
*
|
|
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.
|
|
96
98
|
*
|
|
97
|
-
* **Permissions:** `
|
|
99
|
+
* **Permissions:** `READ_MEDIA`
|
|
98
100
|
*
|
|
99
101
|
*/
|
|
100
|
-
export declare const
|
|
102
|
+
export declare const autocompleteMedia: <ThrowOnError extends boolean = false>(options: Options<AutocompleteMediaData, ThrowOnError>) => import("./client").RequestResult<AutocompleteMediaResponses, AutocompleteMediaErrors, ThrowOnError, "fields">;
|
|
101
103
|
/**
|
|
102
|
-
* Get
|
|
104
|
+
* Get segment by UUID
|
|
103
105
|
*
|
|
104
|
-
* Returns a
|
|
106
|
+
* Returns a specific segment by its UUID. A shortcut alternative to the nested `/media/{mediaId}/episodes/{episodeNumber}/segments/{id}` path.
|
|
105
107
|
*
|
|
106
108
|
* **Permissions:** `READ_MEDIA`
|
|
107
109
|
*
|
|
108
110
|
*/
|
|
109
|
-
export declare const
|
|
111
|
+
export declare const getSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<GetSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<GetSegmentByUuidResponses, GetSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
110
112
|
/**
|
|
111
|
-
* Update
|
|
113
|
+
* Update segment by UUID
|
|
112
114
|
*
|
|
113
|
-
* Updates an existing
|
|
115
|
+
* Updates an existing segment identified by its UUID. Performs the UUID→segment lookup internally,
|
|
116
|
+
* then applies the update. Only provided fields will be updated.
|
|
114
117
|
*
|
|
115
118
|
* **Permissions:** `UPDATE_MEDIA`
|
|
116
119
|
*
|
|
117
120
|
*/
|
|
118
|
-
export declare const
|
|
121
|
+
export declare const updateSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentByUuidResponses, UpdateSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
119
122
|
/**
|
|
120
|
-
*
|
|
123
|
+
* Get surrounding context for a segment
|
|
121
124
|
*
|
|
122
|
-
*
|
|
125
|
+
* Retrieves segments surrounding a specific segment within an episode.
|
|
126
|
+
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
123
127
|
*
|
|
124
128
|
* **Permissions:** `READ_MEDIA`
|
|
125
129
|
*
|
|
126
130
|
*/
|
|
127
|
-
export declare const
|
|
131
|
+
export declare const getSegmentContext: <ThrowOnError extends boolean = false>(options: Options<GetSegmentContextData, ThrowOnError>) => import("./client").RequestResult<GetSegmentContextResponses, GetSegmentContextErrors, ThrowOnError, "fields">;
|
|
128
132
|
/**
|
|
129
|
-
*
|
|
133
|
+
* List all series
|
|
130
134
|
*
|
|
131
|
-
*
|
|
135
|
+
* Returns a paginated list of media series groupings.
|
|
136
|
+
*
|
|
137
|
+
* **Permissions:** `READ_MEDIA`
|
|
138
|
+
*
|
|
139
|
+
*/
|
|
140
|
+
export declare const listSeries: <ThrowOnError extends boolean = false>(options?: Options<ListSeriesData, ThrowOnError>) => import("./client").RequestResult<ListSeriesResponses, ListSeriesErrors, ThrowOnError, "fields">;
|
|
141
|
+
/**
|
|
142
|
+
* Create series
|
|
143
|
+
*
|
|
144
|
+
* Creates a new media series grouping.
|
|
132
145
|
*
|
|
133
146
|
* **Permissions:** `ADD_MEDIA`
|
|
134
147
|
*
|
|
135
148
|
*/
|
|
136
|
-
export declare const
|
|
149
|
+
export declare const createSeries: <ThrowOnError extends boolean = false>(options: Options<CreateSeriesData, ThrowOnError>) => import("./client").RequestResult<CreateSeriesResponses, CreateSeriesErrors, ThrowOnError, "fields">;
|
|
137
150
|
/**
|
|
138
|
-
* Delete
|
|
151
|
+
* Delete series
|
|
139
152
|
*
|
|
140
|
-
*
|
|
153
|
+
* Deletes a series and all its media associations.
|
|
141
154
|
*
|
|
142
155
|
* **Permissions:** `REMOVE_MEDIA`
|
|
143
156
|
*
|
|
144
157
|
*/
|
|
145
|
-
export declare const
|
|
158
|
+
export declare const deleteSeries: <ThrowOnError extends boolean = false>(options: Options<DeleteSeriesData, ThrowOnError>) => import("./client").RequestResult<DeleteSeriesResponses, DeleteSeriesErrors, ThrowOnError, "fields">;
|
|
146
159
|
/**
|
|
147
|
-
* Get
|
|
160
|
+
* Get series details
|
|
148
161
|
*
|
|
149
|
-
* Returns a
|
|
162
|
+
* Returns a series with all media entries sorted by position.
|
|
150
163
|
*
|
|
151
164
|
* **Permissions:** `READ_MEDIA`
|
|
152
165
|
*
|
|
153
166
|
*/
|
|
154
|
-
export declare const
|
|
167
|
+
export declare const getSeries: <ThrowOnError extends boolean = false>(options: Options<GetSeriesData, ThrowOnError>) => import("./client").RequestResult<GetSeriesResponses, GetSeriesErrors, ThrowOnError, "fields">;
|
|
155
168
|
/**
|
|
156
|
-
* Update
|
|
169
|
+
* Update series metadata
|
|
157
170
|
*
|
|
158
|
-
* Updates
|
|
171
|
+
* Updates series localized names.
|
|
159
172
|
*
|
|
160
173
|
* **Permissions:** `UPDATE_MEDIA`
|
|
161
174
|
*
|
|
162
175
|
*/
|
|
163
|
-
export declare const
|
|
176
|
+
export declare const updateSeries: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesResponses, UpdateSeriesErrors, ThrowOnError, "fields">;
|
|
164
177
|
/**
|
|
165
|
-
*
|
|
178
|
+
* Add media to series
|
|
166
179
|
*
|
|
167
|
-
*
|
|
180
|
+
* Adds a media entry to a series at a specific position.
|
|
168
181
|
*
|
|
169
|
-
* **Permissions:** `
|
|
182
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
170
183
|
*
|
|
171
184
|
*/
|
|
172
|
-
export declare const
|
|
185
|
+
export declare const addMediaToSeries: <ThrowOnError extends boolean = false>(options: Options<AddMediaToSeriesData, ThrowOnError>) => import("./client").RequestResult<AddMediaToSeriesResponses, AddMediaToSeriesErrors, ThrowOnError, "fields">;
|
|
173
186
|
/**
|
|
174
|
-
*
|
|
187
|
+
* Remove media from series
|
|
175
188
|
*
|
|
176
|
-
*
|
|
189
|
+
* Removes a media entry from a series.
|
|
177
190
|
*
|
|
178
|
-
* **Permissions:** `
|
|
191
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
179
192
|
*
|
|
180
193
|
*/
|
|
181
|
-
export declare const
|
|
194
|
+
export declare const removeMediaFromSeries: <ThrowOnError extends boolean = false>(options: Options<RemoveMediaFromSeriesData, ThrowOnError>) => import("./client").RequestResult<RemoveMediaFromSeriesResponses, RemoveMediaFromSeriesErrors, ThrowOnError, "fields">;
|
|
182
195
|
/**
|
|
183
|
-
*
|
|
196
|
+
* Update media position in series
|
|
184
197
|
*
|
|
185
|
-
*
|
|
198
|
+
* Updates the position of a media entry in a series.
|
|
186
199
|
*
|
|
187
|
-
* **Permissions:** `
|
|
200
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
188
201
|
*
|
|
189
202
|
*/
|
|
190
|
-
export declare const
|
|
203
|
+
export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesMediaResponses, UpdateSeriesMediaErrors, ThrowOnError, "fields">;
|
|
191
204
|
/**
|
|
192
|
-
* Get
|
|
205
|
+
* Get character details
|
|
193
206
|
*
|
|
194
|
-
* Returns a
|
|
207
|
+
* Returns a character with their voice actors (seiyuu) and all media appearances.
|
|
195
208
|
*
|
|
196
209
|
* **Permissions:** `READ_MEDIA`
|
|
197
210
|
*
|
|
198
211
|
*/
|
|
199
|
-
export declare const
|
|
212
|
+
export declare const getCharacter: <ThrowOnError extends boolean = false>(options: Options<GetCharacterData, ThrowOnError>) => import("./client").RequestResult<GetCharacterResponses, GetCharacterErrors, ThrowOnError, "fields">;
|
|
200
213
|
/**
|
|
201
|
-
*
|
|
214
|
+
* Get seiyuu details
|
|
202
215
|
*
|
|
203
|
-
*
|
|
216
|
+
* Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
|
|
204
217
|
*
|
|
205
|
-
* **Permissions:** `
|
|
218
|
+
* **Permissions:** `READ_MEDIA`
|
|
206
219
|
*
|
|
207
220
|
*/
|
|
208
|
-
export declare const
|
|
221
|
+
export declare const getSeiyuu: <ThrowOnError extends boolean = false>(options: Options<GetSeiyuuData, ThrowOnError>) => import("./client").RequestResult<GetSeiyuuResponses, GetSeiyuuErrors, ThrowOnError, "fields">;
|
|
209
222
|
/**
|
|
210
|
-
*
|
|
223
|
+
* Delete media (soft delete)
|
|
211
224
|
*
|
|
212
|
-
*
|
|
225
|
+
* Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
|
|
213
226
|
*
|
|
214
|
-
* **Permissions:** `
|
|
227
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
215
228
|
*
|
|
216
229
|
*/
|
|
217
|
-
export declare const
|
|
230
|
+
export declare const deleteMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError, "fields">;
|
|
218
231
|
/**
|
|
219
|
-
* Get
|
|
232
|
+
* Get single media
|
|
220
233
|
*
|
|
221
|
-
*
|
|
222
|
-
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
234
|
+
* Returns a single media entry by its ID with full metadata.
|
|
223
235
|
*
|
|
224
236
|
* **Permissions:** `READ_MEDIA`
|
|
225
237
|
*
|
|
226
238
|
*/
|
|
227
|
-
export declare const
|
|
239
|
+
export declare const getMedia: <ThrowOnError extends boolean = false>(options: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, GetMediaErrors, ThrowOnError, "fields">;
|
|
228
240
|
/**
|
|
229
|
-
*
|
|
241
|
+
* Update media
|
|
230
242
|
*
|
|
231
|
-
*
|
|
243
|
+
* Updates an existing media entry. Only provided fields will be updated.
|
|
244
|
+
*
|
|
245
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
232
246
|
*
|
|
233
247
|
*/
|
|
234
|
-
export declare const
|
|
248
|
+
export declare const updateMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError, "fields">;
|
|
235
249
|
/**
|
|
236
|
-
*
|
|
250
|
+
* List episodes for a media
|
|
237
251
|
*
|
|
238
|
-
*
|
|
252
|
+
* Returns a paginated list of episodes for a specific media.
|
|
253
|
+
*
|
|
254
|
+
* **Permissions:** `READ_MEDIA`
|
|
239
255
|
*
|
|
240
256
|
*/
|
|
241
|
-
export declare const
|
|
257
|
+
export declare const listEpisodes: <ThrowOnError extends boolean = false>(options: Options<ListEpisodesData, ThrowOnError>) => import("./client").RequestResult<ListEpisodesResponses, ListEpisodesErrors, ThrowOnError, "fields">;
|
|
242
258
|
/**
|
|
243
|
-
*
|
|
259
|
+
* Create new episode
|
|
244
260
|
*
|
|
245
|
-
*
|
|
261
|
+
* Creates a new episode for a specific media.
|
|
262
|
+
*
|
|
263
|
+
* **Permissions:** `ADD_MEDIA`
|
|
246
264
|
*
|
|
247
265
|
*/
|
|
248
|
-
export declare const
|
|
266
|
+
export declare const createEpisode: <ThrowOnError extends boolean = false>(options: Options<CreateEpisodeData, ThrowOnError>) => import("./client").RequestResult<CreateEpisodeResponses, CreateEpisodeErrors, ThrowOnError, "fields">;
|
|
249
267
|
/**
|
|
250
|
-
*
|
|
268
|
+
* Delete an episode
|
|
251
269
|
*
|
|
252
|
-
*
|
|
270
|
+
* Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
|
|
271
|
+
*
|
|
272
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
253
273
|
*
|
|
254
274
|
*/
|
|
255
|
-
export declare const
|
|
275
|
+
export declare const deleteEpisode: <ThrowOnError extends boolean = false>(options: Options<DeleteEpisodeData, ThrowOnError>) => import("./client").RequestResult<DeleteEpisodeResponses, DeleteEpisodeErrors, ThrowOnError, "fields">;
|
|
256
276
|
/**
|
|
257
|
-
*
|
|
277
|
+
* Get single episode
|
|
258
278
|
*
|
|
259
|
-
*
|
|
279
|
+
* Returns a specific episode by media ID and episode number.
|
|
280
|
+
*
|
|
281
|
+
* **Permissions:** `READ_MEDIA`
|
|
260
282
|
*
|
|
261
283
|
*/
|
|
262
|
-
export declare const
|
|
284
|
+
export declare const getEpisode: <ThrowOnError extends boolean = false>(options: Options<GetEpisodeData, ThrowOnError>) => import("./client").RequestResult<GetEpisodeResponses, GetEpisodeErrors, ThrowOnError, "fields">;
|
|
263
285
|
/**
|
|
264
|
-
*
|
|
286
|
+
* Update episode
|
|
265
287
|
*
|
|
266
|
-
*
|
|
288
|
+
* Updates an existing episode. Only provided fields will be updated.
|
|
289
|
+
*
|
|
290
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
267
291
|
*
|
|
268
292
|
*/
|
|
269
|
-
export declare const
|
|
293
|
+
export declare const updateEpisode: <ThrowOnError extends boolean = false>(options: Options<UpdateEpisodeData, ThrowOnError>) => import("./client").RequestResult<UpdateEpisodeResponses, UpdateEpisodeErrors, ThrowOnError, "fields">;
|
|
270
294
|
/**
|
|
271
|
-
*
|
|
295
|
+
* List segments for an episode
|
|
272
296
|
*
|
|
273
|
-
*
|
|
297
|
+
* Returns a paginated list of segments for a specific episode.
|
|
298
|
+
*
|
|
299
|
+
* **Permissions:** `READ_MEDIA`
|
|
274
300
|
*
|
|
275
301
|
*/
|
|
276
|
-
export declare const
|
|
302
|
+
export declare const listSegments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError, "fields">;
|
|
277
303
|
/**
|
|
278
|
-
*
|
|
304
|
+
* Create new segment
|
|
279
305
|
*
|
|
280
|
-
*
|
|
306
|
+
* Creates a new segment for a specific episode.
|
|
307
|
+
*
|
|
308
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
281
309
|
*
|
|
282
310
|
*/
|
|
283
|
-
export declare const
|
|
311
|
+
export declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError, "fields">;
|
|
284
312
|
/**
|
|
285
|
-
*
|
|
313
|
+
* Delete segment
|
|
286
314
|
*
|
|
287
|
-
*
|
|
315
|
+
* Soft-deletes a segment by setting its status to DELETED.
|
|
288
316
|
*
|
|
289
|
-
* **Permissions:** `
|
|
317
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
290
318
|
*
|
|
291
319
|
*/
|
|
292
|
-
export declare const
|
|
320
|
+
export declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => import("./client").RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError, "fields">;
|
|
293
321
|
/**
|
|
294
|
-
* Get
|
|
322
|
+
* Get single segment
|
|
295
323
|
*
|
|
296
|
-
* Returns a
|
|
324
|
+
* Returns a specific segment by its ID within the media/episode hierarchy.
|
|
297
325
|
*
|
|
298
326
|
* **Permissions:** `READ_MEDIA`
|
|
299
327
|
*
|
|
300
328
|
*/
|
|
301
|
-
export declare const
|
|
329
|
+
export declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => import("./client").RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError, "fields">;
|
|
302
330
|
/**
|
|
303
|
-
*
|
|
331
|
+
* Update segment
|
|
304
332
|
*
|
|
305
|
-
*
|
|
306
|
-
* Accepts both session cookie and API key authentication.
|
|
333
|
+
* Updates an existing segment. Only provided fields will be updated.
|
|
307
334
|
*
|
|
308
|
-
* **Permissions:**
|
|
335
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
309
336
|
*
|
|
310
337
|
*/
|
|
311
|
-
export declare const
|
|
338
|
+
export declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError, "fields">;
|
|
312
339
|
/**
|
|
313
|
-
*
|
|
340
|
+
* Get current monthly API quota
|
|
314
341
|
*
|
|
315
|
-
* Returns the
|
|
342
|
+
* Returns the API quota usage for the current billing period.
|
|
316
343
|
*
|
|
317
344
|
* **Permissions:** Session authentication (cookie-based).
|
|
318
345
|
*
|
|
319
346
|
*/
|
|
320
|
-
export declare const
|
|
347
|
+
export declare const getUserQuota: <ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError, "fields">;
|
|
321
348
|
/**
|
|
322
349
|
* Create a new report
|
|
323
350
|
*
|
|
@@ -364,10 +391,19 @@ export declare const deleteUserActivity: <ThrowOnError extends boolean = false>(
|
|
|
364
391
|
*
|
|
365
392
|
*/
|
|
366
393
|
export declare const listUserActivity: <ThrowOnError extends boolean = false>(options?: Options<ListUserActivityData, ThrowOnError>) => import("./client").RequestResult<ListUserActivityResponses, ListUserActivityErrors, ThrowOnError, "fields">;
|
|
394
|
+
/**
|
|
395
|
+
* Track user activity
|
|
396
|
+
*
|
|
397
|
+
* Records a user activity event (e.g. segment play). Fire-and-forget — always returns 204.
|
|
398
|
+
*
|
|
399
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
400
|
+
*
|
|
401
|
+
*/
|
|
402
|
+
export declare const trackUserActivity: <ThrowOnError extends boolean = false>(options: Options<TrackUserActivityData, ThrowOnError>) => import("./client").RequestResult<TrackUserActivityResponses, TrackUserActivityErrors, ThrowOnError, "fields">;
|
|
367
403
|
/**
|
|
368
404
|
* Get activity heatmap data
|
|
369
405
|
*
|
|
370
|
-
* Returns daily activity
|
|
406
|
+
* Returns daily activity activityByDay for the authenticated user, grouped by date.
|
|
371
407
|
* Designed for rendering a GitHub-style contribution heatmap.
|
|
372
408
|
*
|
|
373
409
|
* **Permissions:** Session authentication (cookie-based).
|
|
@@ -378,12 +414,30 @@ export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = fal
|
|
|
378
414
|
* Get user activity statistics
|
|
379
415
|
*
|
|
380
416
|
* Returns aggregate statistics about the authenticated user's activity:
|
|
381
|
-
* total searches, exports, plays, and
|
|
417
|
+
* total searches, exports, plays, and top media.
|
|
382
418
|
*
|
|
383
419
|
* **Permissions:** Session authentication (cookie-based).
|
|
384
420
|
*
|
|
385
421
|
*/
|
|
386
422
|
export declare const getUserActivityStats: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityStatsData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityStatsResponses, GetUserActivityStatsErrors, ThrowOnError, "fields">;
|
|
423
|
+
/**
|
|
424
|
+
* Delete all activity for a specific date
|
|
425
|
+
*
|
|
426
|
+
* Deletes all activity records for the authenticated user on the given date.
|
|
427
|
+
*
|
|
428
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
429
|
+
*
|
|
430
|
+
*/
|
|
431
|
+
export declare const deleteUserActivityByDate: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByDateData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByDateResponses, DeleteUserActivityByDateErrors, ThrowOnError, "fields">;
|
|
432
|
+
/**
|
|
433
|
+
* Delete a single activity record
|
|
434
|
+
*
|
|
435
|
+
* Deletes a single activity record by ID for the authenticated user.
|
|
436
|
+
*
|
|
437
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
438
|
+
*
|
|
439
|
+
*/
|
|
440
|
+
export declare const deleteUserActivityById: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByIdData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByIdResponses, DeleteUserActivityByIdErrors, ThrowOnError, "fields">;
|
|
387
441
|
/**
|
|
388
442
|
* Export all user data
|
|
389
443
|
*
|
|
@@ -405,6 +459,25 @@ export declare const exportUserData: <ThrowOnError extends boolean = false>(opti
|
|
|
405
459
|
*
|
|
406
460
|
*/
|
|
407
461
|
export declare const listUserLabs: <ThrowOnError extends boolean = false>(options?: Options<ListUserLabsData, ThrowOnError>) => import("./client").RequestResult<ListUserLabsResponses, ListUserLabsErrors, ThrowOnError, "fields">;
|
|
462
|
+
/**
|
|
463
|
+
* Unenroll from a lab feature
|
|
464
|
+
*
|
|
465
|
+
* Opts the authenticated user out of a lab feature.
|
|
466
|
+
*
|
|
467
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
468
|
+
*
|
|
469
|
+
*/
|
|
470
|
+
export declare const unenrollUserLab: <ThrowOnError extends boolean = false>(options: Options<UnenrollUserLabData, ThrowOnError>) => import("./client").RequestResult<UnenrollUserLabResponses, UnenrollUserLabErrors, ThrowOnError, "fields">;
|
|
471
|
+
/**
|
|
472
|
+
* Enroll in a lab feature
|
|
473
|
+
*
|
|
474
|
+
* Opts the authenticated user into a lab feature. The user must be eligible
|
|
475
|
+
* for the lab (correct role, in allowlist or rollout percentage).
|
|
476
|
+
*
|
|
477
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
478
|
+
*
|
|
479
|
+
*/
|
|
480
|
+
export declare const enrollUserLab: <ThrowOnError extends boolean = false>(options: Options<EnrollUserLabData, ThrowOnError>) => import("./client").RequestResult<EnrollUserLabResponses, EnrollUserLabErrors, ThrowOnError, "fields">;
|
|
408
481
|
/**
|
|
409
482
|
* List user's collections
|
|
410
483
|
*
|
|
@@ -461,6 +534,22 @@ export declare const removeSegmentFromCollection: <ThrowOnError extends boolean
|
|
|
461
534
|
*
|
|
462
535
|
*/
|
|
463
536
|
export declare const updateCollectionSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateCollectionSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateCollectionSegmentResponses, UpdateCollectionSegmentErrors, ThrowOnError, "fields">;
|
|
537
|
+
/**
|
|
538
|
+
* Search collection segments
|
|
539
|
+
*
|
|
540
|
+
* Returns collection segments in search-response format with pagination.
|
|
541
|
+
* Reshapes the collection data: extracts segment results, includes media, computes pagination.
|
|
542
|
+
*
|
|
543
|
+
*/
|
|
544
|
+
export declare const searchCollectionSegments: <ThrowOnError extends boolean = false>(options: Options<SearchCollectionSegmentsData, ThrowOnError>) => import("./client").RequestResult<SearchCollectionSegmentsResponses, SearchCollectionSegmentsErrors, ThrowOnError, "fields">;
|
|
545
|
+
/**
|
|
546
|
+
* Get collection statistics
|
|
547
|
+
*
|
|
548
|
+
* Returns per-media segment counts and per-category counts for all segments in a collection.
|
|
549
|
+
* Pages through all collection segments internally to compute statistics.
|
|
550
|
+
*
|
|
551
|
+
*/
|
|
552
|
+
export declare const getCollectionStats: <ThrowOnError extends boolean = false>(options: Options<GetCollectionStatsData, ThrowOnError>) => import("./client").RequestResult<GetCollectionStatsResponses, GetCollectionStatsErrors, ThrowOnError, "fields">;
|
|
464
553
|
/**
|
|
465
554
|
* Admin dashboard statistics
|
|
466
555
|
*
|
|
@@ -485,12 +574,12 @@ export declare const getAdminHealth: <ThrowOnError extends boolean = false>(opti
|
|
|
485
574
|
* Reindex database into Elasticsearch
|
|
486
575
|
*
|
|
487
576
|
* Reindexes segments from the PostgreSQL database into Elasticsearch.
|
|
488
|
-
* Allows filtering by specific media
|
|
577
|
+
* Allows filtering by specific media entries and episodes.
|
|
489
578
|
*
|
|
490
579
|
* **Behavior:**
|
|
491
580
|
* - If no filters provided, reindexes all segments
|
|
492
|
-
* - If `
|
|
493
|
-
* - If `episodes
|
|
581
|
+
* - If `media` is provided, reindexes segments from those media entries
|
|
582
|
+
* - If a media item includes `episodes`, only those episodes are reindexed for that media
|
|
494
583
|
*
|
|
495
584
|
* **Permissions:** `ADD_MEDIA`
|
|
496
585
|
*
|
|
@@ -566,95 +655,84 @@ export declare const retryAdminQueueFailed: <ThrowOnError extends boolean = fals
|
|
|
566
655
|
*/
|
|
567
656
|
export declare const purgeAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<PurgeAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<PurgeAdminQueueFailedResponses, PurgeAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
568
657
|
/**
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
* Returns all reports with filtering and cursor pagination.
|
|
572
|
-
* Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
|
|
573
|
-
*
|
|
574
|
-
* **Permissions:** `ADD_MEDIA`
|
|
575
|
-
*
|
|
576
|
-
*/
|
|
577
|
-
export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
|
|
578
|
-
/**
|
|
579
|
-
* Update a report
|
|
580
|
-
*
|
|
581
|
-
* Updates the status and/or admin notes of a report.
|
|
582
|
-
* Works for both USER and AUTO reports.
|
|
658
|
+
* Clear admin impersonation
|
|
583
659
|
*
|
|
584
|
-
*
|
|
660
|
+
* Clears the current impersonation session and related cookies.
|
|
661
|
+
* This endpoint is restricted to admin sessions and only available in local environment.
|
|
585
662
|
*
|
|
586
663
|
*/
|
|
587
|
-
export declare const
|
|
664
|
+
export declare const clearAdminImpersonation: <ThrowOnError extends boolean = false>(options?: Options<ClearAdminImpersonationData, ThrowOnError>) => import("./client").RequestResult<ClearAdminImpersonationResponses, ClearAdminImpersonationErrors, ThrowOnError, "fields">;
|
|
588
665
|
/**
|
|
589
|
-
*
|
|
666
|
+
* Start admin impersonation
|
|
590
667
|
*
|
|
591
|
-
*
|
|
592
|
-
*
|
|
593
|
-
* **Permissions:** `ADD_MEDIA`
|
|
668
|
+
* Creates an impersonation session for the target user.
|
|
669
|
+
* This endpoint is restricted to admin sessions and only available in local environment.
|
|
594
670
|
*
|
|
595
671
|
*/
|
|
596
|
-
export declare const
|
|
672
|
+
export declare const impersonateAdminUser: <ThrowOnError extends boolean = false>(options: Options<ImpersonateAdminUserData, ThrowOnError>) => import("./client").RequestResult<ImpersonateAdminUserResponses, ImpersonateAdminUserErrors, ThrowOnError, "fields">;
|
|
597
673
|
/**
|
|
598
|
-
* List all
|
|
674
|
+
* List all reports
|
|
599
675
|
*
|
|
600
|
-
* Returns all
|
|
676
|
+
* Returns all reports with filtering and cursor pagination.
|
|
677
|
+
* Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
|
|
601
678
|
*
|
|
602
679
|
* **Permissions:** `ADD_MEDIA`
|
|
603
680
|
*
|
|
604
681
|
*/
|
|
605
|
-
export declare const
|
|
682
|
+
export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
|
|
606
683
|
/**
|
|
607
|
-
* Update a
|
|
684
|
+
* Update a report
|
|
608
685
|
*
|
|
609
|
-
* Updates the
|
|
686
|
+
* Updates the status and/or admin notes of a report.
|
|
687
|
+
* Works for both USER and AUTO reports.
|
|
610
688
|
*
|
|
611
689
|
* **Permissions:** `ADD_MEDIA`
|
|
612
690
|
*
|
|
613
691
|
*/
|
|
614
|
-
export declare const
|
|
692
|
+
export declare const updateAdminReport: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReportData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReportResponses, UpdateAdminReportErrors, ThrowOnError, "fields">;
|
|
615
693
|
/**
|
|
616
|
-
* List
|
|
694
|
+
* List all media audits
|
|
617
695
|
*
|
|
618
|
-
* Returns
|
|
696
|
+
* Returns all audit definitions with current config, threshold schema, and latest run info.
|
|
619
697
|
*
|
|
620
698
|
* **Permissions:** `ADD_MEDIA`
|
|
621
699
|
*
|
|
622
700
|
*/
|
|
623
|
-
export declare const
|
|
701
|
+
export declare const listAdminMediaAudits: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditsResponses, ListAdminMediaAuditsErrors, ThrowOnError, "fields">;
|
|
624
702
|
/**
|
|
625
|
-
*
|
|
703
|
+
* Update a media audit config
|
|
626
704
|
*
|
|
627
|
-
*
|
|
705
|
+
* Updates the threshold values or enabled status of an audit.
|
|
628
706
|
*
|
|
629
707
|
* **Permissions:** `ADD_MEDIA`
|
|
630
708
|
*
|
|
631
709
|
*/
|
|
632
|
-
export declare const
|
|
710
|
+
export declare const updateAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminMediaAuditResponses, UpdateAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
633
711
|
/**
|
|
634
|
-
*
|
|
712
|
+
* Run a media audit
|
|
635
713
|
*
|
|
636
|
-
*
|
|
714
|
+
* Triggers all enabled audits (or a specific one). Creates MediaAuditRun records and AUTO reports for any findings.
|
|
637
715
|
*
|
|
638
716
|
* **Permissions:** `ADD_MEDIA`
|
|
639
717
|
*
|
|
640
718
|
*/
|
|
641
|
-
export declare const
|
|
719
|
+
export declare const runAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<RunAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<RunAdminMediaAuditResponses, RunAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
642
720
|
/**
|
|
643
|
-
*
|
|
721
|
+
* List past audit runs
|
|
644
722
|
*
|
|
645
|
-
*
|
|
723
|
+
* Returns past media audit runs with summary stats. Supports filtering by audit name and cursor pagination.
|
|
646
724
|
*
|
|
647
725
|
* **Permissions:** `ADD_MEDIA`
|
|
648
726
|
*
|
|
649
727
|
*/
|
|
650
|
-
export declare const
|
|
728
|
+
export declare const listAdminMediaAuditRuns: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditRunsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditRunsResponses, ListAdminMediaAuditRunsErrors, ThrowOnError, "fields">;
|
|
651
729
|
/**
|
|
652
|
-
*
|
|
730
|
+
* Get a specific audit run's details
|
|
653
731
|
*
|
|
654
|
-
*
|
|
732
|
+
* Returns a specific media audit run record with its linked reports.
|
|
655
733
|
*
|
|
656
734
|
* **Permissions:** `ADD_MEDIA`
|
|
657
735
|
*
|
|
658
736
|
*/
|
|
659
|
-
export declare const
|
|
737
|
+
export declare const getAdminMediaAuditRun: <ThrowOnError extends boolean = false>(options: Options<GetAdminMediaAuditRunData, ThrowOnError>) => import("./client").RequestResult<GetAdminMediaAuditRunResponses, GetAdminMediaAuditRunErrors, ThrowOnError, "fields">;
|
|
660
738
|
//# sourceMappingURL=sdk.gen.d.ts.map
|