@brigadasos/nadeshiko-sdk 1.4.3-dev.09dcbc3 → 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/dist/client.gen.d.ts.map +1 -1
- package/dist/index.cjs +273 -176
- 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 +260 -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 +35 -29
- package/dist/nadeshiko.gen.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +210 -143
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1472 -1297
- 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, AutocompleteMediaData, AutocompleteMediaErrors, AutocompleteMediaResponses,
|
|
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
|
*
|
|
@@ -101,234 +101,250 @@ export declare const createMedia: <ThrowOnError extends boolean = false>(options
|
|
|
101
101
|
*/
|
|
102
102
|
export declare const autocompleteMedia: <ThrowOnError extends boolean = false>(options: Options<AutocompleteMediaData, ThrowOnError>) => import("./client").RequestResult<AutocompleteMediaResponses, AutocompleteMediaErrors, ThrowOnError, "fields">;
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* Get segment by UUID
|
|
105
105
|
*
|
|
106
|
-
*
|
|
106
|
+
* Returns a specific segment by its UUID. A shortcut alternative to the nested `/media/{mediaId}/episodes/{episodeNumber}/segments/{id}` path.
|
|
107
107
|
*
|
|
108
|
-
* **Permissions:** `
|
|
108
|
+
* **Permissions:** `READ_MEDIA`
|
|
109
109
|
*
|
|
110
110
|
*/
|
|
111
|
-
export declare const
|
|
111
|
+
export declare const getSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<GetSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<GetSegmentByUuidResponses, GetSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
112
112
|
/**
|
|
113
|
-
*
|
|
113
|
+
* Update segment by UUID
|
|
114
114
|
*
|
|
115
|
-
*
|
|
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.
|
|
116
117
|
*
|
|
117
|
-
* **Permissions:** `
|
|
118
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
118
119
|
*
|
|
119
120
|
*/
|
|
120
|
-
export declare const
|
|
121
|
+
export declare const updateSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentByUuidResponses, UpdateSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
121
122
|
/**
|
|
122
|
-
*
|
|
123
|
+
* Get surrounding context for a segment
|
|
123
124
|
*
|
|
124
|
-
*
|
|
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.
|
|
125
127
|
*
|
|
126
|
-
* **Permissions:** `
|
|
128
|
+
* **Permissions:** `READ_MEDIA`
|
|
127
129
|
*
|
|
128
130
|
*/
|
|
129
|
-
export declare const
|
|
131
|
+
export declare const getSegmentContext: <ThrowOnError extends boolean = false>(options: Options<GetSegmentContextData, ThrowOnError>) => import("./client").RequestResult<GetSegmentContextResponses, GetSegmentContextErrors, ThrowOnError, "fields">;
|
|
130
132
|
/**
|
|
131
|
-
* List
|
|
133
|
+
* List all series
|
|
132
134
|
*
|
|
133
|
-
* Returns a paginated list of
|
|
135
|
+
* Returns a paginated list of media series groupings.
|
|
134
136
|
*
|
|
135
137
|
* **Permissions:** `READ_MEDIA`
|
|
136
138
|
*
|
|
137
139
|
*/
|
|
138
|
-
export declare const
|
|
140
|
+
export declare const listSeries: <ThrowOnError extends boolean = false>(options?: Options<ListSeriesData, ThrowOnError>) => import("./client").RequestResult<ListSeriesResponses, ListSeriesErrors, ThrowOnError, "fields">;
|
|
139
141
|
/**
|
|
140
|
-
* Create
|
|
142
|
+
* Create series
|
|
141
143
|
*
|
|
142
|
-
* Creates a new
|
|
144
|
+
* Creates a new media series grouping.
|
|
143
145
|
*
|
|
144
146
|
* **Permissions:** `ADD_MEDIA`
|
|
145
147
|
*
|
|
146
148
|
*/
|
|
147
|
-
export declare const
|
|
149
|
+
export declare const createSeries: <ThrowOnError extends boolean = false>(options: Options<CreateSeriesData, ThrowOnError>) => import("./client").RequestResult<CreateSeriesResponses, CreateSeriesErrors, ThrowOnError, "fields">;
|
|
148
150
|
/**
|
|
149
|
-
* Delete
|
|
151
|
+
* Delete series
|
|
150
152
|
*
|
|
151
|
-
*
|
|
153
|
+
* Deletes a series and all its media associations.
|
|
152
154
|
*
|
|
153
155
|
* **Permissions:** `REMOVE_MEDIA`
|
|
154
156
|
*
|
|
155
157
|
*/
|
|
156
|
-
export declare const
|
|
158
|
+
export declare const deleteSeries: <ThrowOnError extends boolean = false>(options: Options<DeleteSeriesData, ThrowOnError>) => import("./client").RequestResult<DeleteSeriesResponses, DeleteSeriesErrors, ThrowOnError, "fields">;
|
|
157
159
|
/**
|
|
158
|
-
* Get
|
|
160
|
+
* Get series details
|
|
159
161
|
*
|
|
160
|
-
* Returns a
|
|
162
|
+
* Returns a series with all media entries sorted by position.
|
|
161
163
|
*
|
|
162
164
|
* **Permissions:** `READ_MEDIA`
|
|
163
165
|
*
|
|
164
166
|
*/
|
|
165
|
-
export declare const
|
|
167
|
+
export declare const getSeries: <ThrowOnError extends boolean = false>(options: Options<GetSeriesData, ThrowOnError>) => import("./client").RequestResult<GetSeriesResponses, GetSeriesErrors, ThrowOnError, "fields">;
|
|
166
168
|
/**
|
|
167
|
-
* Update
|
|
169
|
+
* Update series metadata
|
|
168
170
|
*
|
|
169
|
-
* Updates
|
|
171
|
+
* Updates series localized names.
|
|
170
172
|
*
|
|
171
173
|
* **Permissions:** `UPDATE_MEDIA`
|
|
172
174
|
*
|
|
173
175
|
*/
|
|
174
|
-
export declare const
|
|
176
|
+
export declare const updateSeries: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesResponses, UpdateSeriesErrors, ThrowOnError, "fields">;
|
|
175
177
|
/**
|
|
176
|
-
*
|
|
178
|
+
* Add media to series
|
|
177
179
|
*
|
|
178
|
-
*
|
|
180
|
+
* Adds a media entry to a series at a specific position.
|
|
179
181
|
*
|
|
180
|
-
* **Permissions:** `
|
|
182
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
181
183
|
*
|
|
182
184
|
*/
|
|
183
|
-
export declare const
|
|
185
|
+
export declare const addMediaToSeries: <ThrowOnError extends boolean = false>(options: Options<AddMediaToSeriesData, ThrowOnError>) => import("./client").RequestResult<AddMediaToSeriesResponses, AddMediaToSeriesErrors, ThrowOnError, "fields">;
|
|
184
186
|
/**
|
|
185
|
-
*
|
|
187
|
+
* Remove media from series
|
|
186
188
|
*
|
|
187
|
-
*
|
|
189
|
+
* Removes a media entry from a series.
|
|
188
190
|
*
|
|
189
|
-
* **Permissions:** `
|
|
191
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
190
192
|
*
|
|
191
193
|
*/
|
|
192
|
-
export declare const
|
|
194
|
+
export declare const removeMediaFromSeries: <ThrowOnError extends boolean = false>(options: Options<RemoveMediaFromSeriesData, ThrowOnError>) => import("./client").RequestResult<RemoveMediaFromSeriesResponses, RemoveMediaFromSeriesErrors, ThrowOnError, "fields">;
|
|
193
195
|
/**
|
|
194
|
-
*
|
|
196
|
+
* Update media position in series
|
|
195
197
|
*
|
|
196
|
-
*
|
|
198
|
+
* Updates the position of a media entry in a series.
|
|
197
199
|
*
|
|
198
|
-
* **Permissions:** `
|
|
200
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
199
201
|
*
|
|
200
202
|
*/
|
|
201
|
-
export declare const
|
|
203
|
+
export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesMediaResponses, UpdateSeriesMediaErrors, ThrowOnError, "fields">;
|
|
202
204
|
/**
|
|
203
|
-
* Get
|
|
205
|
+
* Get character details
|
|
204
206
|
*
|
|
205
|
-
* Returns a
|
|
207
|
+
* Returns a character with their voice actors (seiyuu) and all media appearances.
|
|
206
208
|
*
|
|
207
209
|
* **Permissions:** `READ_MEDIA`
|
|
208
210
|
*
|
|
209
211
|
*/
|
|
210
|
-
export declare const
|
|
212
|
+
export declare const getCharacter: <ThrowOnError extends boolean = false>(options: Options<GetCharacterData, ThrowOnError>) => import("./client").RequestResult<GetCharacterResponses, GetCharacterErrors, ThrowOnError, "fields">;
|
|
211
213
|
/**
|
|
212
|
-
*
|
|
214
|
+
* Get seiyuu details
|
|
213
215
|
*
|
|
214
|
-
*
|
|
216
|
+
* Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
|
|
215
217
|
*
|
|
216
|
-
* **Permissions:** `
|
|
218
|
+
* **Permissions:** `READ_MEDIA`
|
|
217
219
|
*
|
|
218
220
|
*/
|
|
219
|
-
export declare const
|
|
221
|
+
export declare const getSeiyuu: <ThrowOnError extends boolean = false>(options: Options<GetSeiyuuData, ThrowOnError>) => import("./client").RequestResult<GetSeiyuuResponses, GetSeiyuuErrors, ThrowOnError, "fields">;
|
|
220
222
|
/**
|
|
221
|
-
*
|
|
223
|
+
* Delete media (soft delete)
|
|
222
224
|
*
|
|
223
|
-
*
|
|
225
|
+
* Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
|
|
224
226
|
*
|
|
225
|
-
* **Permissions:** `
|
|
227
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
226
228
|
*
|
|
227
229
|
*/
|
|
228
|
-
export declare const
|
|
230
|
+
export declare const deleteMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError, "fields">;
|
|
229
231
|
/**
|
|
230
|
-
* Get
|
|
232
|
+
* Get single media
|
|
231
233
|
*
|
|
232
|
-
*
|
|
233
|
-
* 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.
|
|
234
235
|
*
|
|
235
236
|
* **Permissions:** `READ_MEDIA`
|
|
236
237
|
*
|
|
237
238
|
*/
|
|
238
|
-
export declare const
|
|
239
|
+
export declare const getMedia: <ThrowOnError extends boolean = false>(options: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, GetMediaErrors, ThrowOnError, "fields">;
|
|
239
240
|
/**
|
|
240
|
-
*
|
|
241
|
+
* Update media
|
|
241
242
|
*
|
|
242
|
-
*
|
|
243
|
+
* Updates an existing media entry. Only provided fields will be updated.
|
|
244
|
+
*
|
|
245
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
243
246
|
*
|
|
244
247
|
*/
|
|
245
|
-
export declare const
|
|
248
|
+
export declare const updateMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError, "fields">;
|
|
246
249
|
/**
|
|
247
|
-
*
|
|
250
|
+
* List episodes for a media
|
|
248
251
|
*
|
|
249
|
-
*
|
|
252
|
+
* Returns a paginated list of episodes for a specific media.
|
|
253
|
+
*
|
|
254
|
+
* **Permissions:** `READ_MEDIA`
|
|
250
255
|
*
|
|
251
256
|
*/
|
|
252
|
-
export declare const
|
|
257
|
+
export declare const listEpisodes: <ThrowOnError extends boolean = false>(options: Options<ListEpisodesData, ThrowOnError>) => import("./client").RequestResult<ListEpisodesResponses, ListEpisodesErrors, ThrowOnError, "fields">;
|
|
253
258
|
/**
|
|
254
|
-
*
|
|
259
|
+
* Create new episode
|
|
255
260
|
*
|
|
256
|
-
*
|
|
261
|
+
* Creates a new episode for a specific media.
|
|
262
|
+
*
|
|
263
|
+
* **Permissions:** `ADD_MEDIA`
|
|
257
264
|
*
|
|
258
265
|
*/
|
|
259
|
-
export declare const
|
|
266
|
+
export declare const createEpisode: <ThrowOnError extends boolean = false>(options: Options<CreateEpisodeData, ThrowOnError>) => import("./client").RequestResult<CreateEpisodeResponses, CreateEpisodeErrors, ThrowOnError, "fields">;
|
|
260
267
|
/**
|
|
261
|
-
*
|
|
268
|
+
* Delete an episode
|
|
262
269
|
*
|
|
263
|
-
*
|
|
270
|
+
* Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
|
|
271
|
+
*
|
|
272
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
264
273
|
*
|
|
265
274
|
*/
|
|
266
|
-
export declare const
|
|
275
|
+
export declare const deleteEpisode: <ThrowOnError extends boolean = false>(options: Options<DeleteEpisodeData, ThrowOnError>) => import("./client").RequestResult<DeleteEpisodeResponses, DeleteEpisodeErrors, ThrowOnError, "fields">;
|
|
267
276
|
/**
|
|
268
|
-
*
|
|
277
|
+
* Get single episode
|
|
269
278
|
*
|
|
270
|
-
*
|
|
279
|
+
* Returns a specific episode by media ID and episode number.
|
|
280
|
+
*
|
|
281
|
+
* **Permissions:** `READ_MEDIA`
|
|
271
282
|
*
|
|
272
283
|
*/
|
|
273
|
-
export declare const
|
|
284
|
+
export declare const getEpisode: <ThrowOnError extends boolean = false>(options: Options<GetEpisodeData, ThrowOnError>) => import("./client").RequestResult<GetEpisodeResponses, GetEpisodeErrors, ThrowOnError, "fields">;
|
|
274
285
|
/**
|
|
275
|
-
*
|
|
286
|
+
* Update episode
|
|
276
287
|
*
|
|
277
|
-
*
|
|
288
|
+
* Updates an existing episode. Only provided fields will be updated.
|
|
289
|
+
*
|
|
290
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
278
291
|
*
|
|
279
292
|
*/
|
|
280
|
-
export declare const
|
|
293
|
+
export declare const updateEpisode: <ThrowOnError extends boolean = false>(options: Options<UpdateEpisodeData, ThrowOnError>) => import("./client").RequestResult<UpdateEpisodeResponses, UpdateEpisodeErrors, ThrowOnError, "fields">;
|
|
281
294
|
/**
|
|
282
|
-
*
|
|
295
|
+
* List segments for an episode
|
|
283
296
|
*
|
|
284
|
-
*
|
|
297
|
+
* Returns a paginated list of segments for a specific episode.
|
|
298
|
+
*
|
|
299
|
+
* **Permissions:** `READ_MEDIA`
|
|
285
300
|
*
|
|
286
301
|
*/
|
|
287
|
-
export declare const
|
|
302
|
+
export declare const listSegments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError, "fields">;
|
|
288
303
|
/**
|
|
289
|
-
*
|
|
304
|
+
* Create new segment
|
|
290
305
|
*
|
|
291
|
-
*
|
|
306
|
+
* Creates a new segment for a specific episode.
|
|
307
|
+
*
|
|
308
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
292
309
|
*
|
|
293
310
|
*/
|
|
294
|
-
export declare const
|
|
311
|
+
export declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError, "fields">;
|
|
295
312
|
/**
|
|
296
|
-
*
|
|
313
|
+
* Delete segment
|
|
297
314
|
*
|
|
298
|
-
*
|
|
315
|
+
* Soft-deletes a segment by setting its status to DELETED.
|
|
299
316
|
*
|
|
300
|
-
* **Permissions:** `
|
|
317
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
301
318
|
*
|
|
302
319
|
*/
|
|
303
|
-
export declare const
|
|
320
|
+
export declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => import("./client").RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError, "fields">;
|
|
304
321
|
/**
|
|
305
|
-
* Get
|
|
322
|
+
* Get single segment
|
|
306
323
|
*
|
|
307
|
-
* Returns a
|
|
324
|
+
* Returns a specific segment by its ID within the media/episode hierarchy.
|
|
308
325
|
*
|
|
309
326
|
* **Permissions:** `READ_MEDIA`
|
|
310
327
|
*
|
|
311
328
|
*/
|
|
312
|
-
export declare const
|
|
329
|
+
export declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => import("./client").RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError, "fields">;
|
|
313
330
|
/**
|
|
314
|
-
*
|
|
331
|
+
* Update segment
|
|
315
332
|
*
|
|
316
|
-
*
|
|
317
|
-
* Accepts both session cookie and API key authentication.
|
|
333
|
+
* Updates an existing segment. Only provided fields will be updated.
|
|
318
334
|
*
|
|
319
|
-
* **Permissions:**
|
|
335
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
320
336
|
*
|
|
321
337
|
*/
|
|
322
|
-
export declare const
|
|
338
|
+
export declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError, "fields">;
|
|
323
339
|
/**
|
|
324
|
-
*
|
|
340
|
+
* Get current monthly API quota
|
|
325
341
|
*
|
|
326
|
-
* Returns the
|
|
342
|
+
* Returns the API quota usage for the current billing period.
|
|
327
343
|
*
|
|
328
344
|
* **Permissions:** Session authentication (cookie-based).
|
|
329
345
|
*
|
|
330
346
|
*/
|
|
331
|
-
export declare const
|
|
347
|
+
export declare const getUserQuota: <ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError, "fields">;
|
|
332
348
|
/**
|
|
333
349
|
* Create a new report
|
|
334
350
|
*
|
|
@@ -375,10 +391,19 @@ export declare const deleteUserActivity: <ThrowOnError extends boolean = false>(
|
|
|
375
391
|
*
|
|
376
392
|
*/
|
|
377
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">;
|
|
378
403
|
/**
|
|
379
404
|
* Get activity heatmap data
|
|
380
405
|
*
|
|
381
|
-
* Returns daily activity
|
|
406
|
+
* Returns daily activity activityByDay for the authenticated user, grouped by date.
|
|
382
407
|
* Designed for rendering a GitHub-style contribution heatmap.
|
|
383
408
|
*
|
|
384
409
|
* **Permissions:** Session authentication (cookie-based).
|
|
@@ -389,12 +414,30 @@ export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = fal
|
|
|
389
414
|
* Get user activity statistics
|
|
390
415
|
*
|
|
391
416
|
* Returns aggregate statistics about the authenticated user's activity:
|
|
392
|
-
* total searches, exports, plays, and
|
|
417
|
+
* total searches, exports, plays, and top media.
|
|
393
418
|
*
|
|
394
419
|
* **Permissions:** Session authentication (cookie-based).
|
|
395
420
|
*
|
|
396
421
|
*/
|
|
397
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">;
|
|
398
441
|
/**
|
|
399
442
|
* Export all user data
|
|
400
443
|
*
|
|
@@ -416,6 +459,25 @@ export declare const exportUserData: <ThrowOnError extends boolean = false>(opti
|
|
|
416
459
|
*
|
|
417
460
|
*/
|
|
418
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">;
|
|
419
481
|
/**
|
|
420
482
|
* List user's collections
|
|
421
483
|
*
|
|
@@ -472,6 +534,22 @@ export declare const removeSegmentFromCollection: <ThrowOnError extends boolean
|
|
|
472
534
|
*
|
|
473
535
|
*/
|
|
474
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">;
|
|
475
553
|
/**
|
|
476
554
|
* Admin dashboard statistics
|
|
477
555
|
*
|
|
@@ -496,12 +574,12 @@ export declare const getAdminHealth: <ThrowOnError extends boolean = false>(opti
|
|
|
496
574
|
* Reindex database into Elasticsearch
|
|
497
575
|
*
|
|
498
576
|
* Reindexes segments from the PostgreSQL database into Elasticsearch.
|
|
499
|
-
* Allows filtering by specific media
|
|
577
|
+
* Allows filtering by specific media entries and episodes.
|
|
500
578
|
*
|
|
501
579
|
* **Behavior:**
|
|
502
580
|
* - If no filters provided, reindexes all segments
|
|
503
|
-
* - If `
|
|
504
|
-
* - 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
|
|
505
583
|
*
|
|
506
584
|
* **Permissions:** `ADD_MEDIA`
|
|
507
585
|
*
|
|
@@ -577,95 +655,84 @@ export declare const retryAdminQueueFailed: <ThrowOnError extends boolean = fals
|
|
|
577
655
|
*/
|
|
578
656
|
export declare const purgeAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<PurgeAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<PurgeAdminQueueFailedResponses, PurgeAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
579
657
|
/**
|
|
580
|
-
*
|
|
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.
|
|
658
|
+
* Clear admin impersonation
|
|
594
659
|
*
|
|
595
|
-
*
|
|
660
|
+
* Clears the current impersonation session and related cookies.
|
|
661
|
+
* This endpoint is restricted to admin sessions and only available in local environment.
|
|
596
662
|
*
|
|
597
663
|
*/
|
|
598
|
-
export declare const
|
|
664
|
+
export declare const clearAdminImpersonation: <ThrowOnError extends boolean = false>(options?: Options<ClearAdminImpersonationData, ThrowOnError>) => import("./client").RequestResult<ClearAdminImpersonationResponses, ClearAdminImpersonationErrors, ThrowOnError, "fields">;
|
|
599
665
|
/**
|
|
600
|
-
*
|
|
666
|
+
* Start admin impersonation
|
|
601
667
|
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
* **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.
|
|
605
670
|
*
|
|
606
671
|
*/
|
|
607
|
-
export declare const
|
|
672
|
+
export declare const impersonateAdminUser: <ThrowOnError extends boolean = false>(options: Options<ImpersonateAdminUserData, ThrowOnError>) => import("./client").RequestResult<ImpersonateAdminUserResponses, ImpersonateAdminUserErrors, ThrowOnError, "fields">;
|
|
608
673
|
/**
|
|
609
|
-
* List all
|
|
674
|
+
* List all reports
|
|
610
675
|
*
|
|
611
|
-
* 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.
|
|
612
678
|
*
|
|
613
679
|
* **Permissions:** `ADD_MEDIA`
|
|
614
680
|
*
|
|
615
681
|
*/
|
|
616
|
-
export declare const
|
|
682
|
+
export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
|
|
617
683
|
/**
|
|
618
|
-
* Update a
|
|
684
|
+
* Update a report
|
|
619
685
|
*
|
|
620
|
-
* Updates the
|
|
686
|
+
* Updates the status and/or admin notes of a report.
|
|
687
|
+
* Works for both USER and AUTO reports.
|
|
621
688
|
*
|
|
622
689
|
* **Permissions:** `ADD_MEDIA`
|
|
623
690
|
*
|
|
624
691
|
*/
|
|
625
|
-
export declare const
|
|
692
|
+
export declare const updateAdminReport: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReportData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReportResponses, UpdateAdminReportErrors, ThrowOnError, "fields">;
|
|
626
693
|
/**
|
|
627
|
-
* List
|
|
694
|
+
* List all media audits
|
|
628
695
|
*
|
|
629
|
-
* Returns
|
|
696
|
+
* Returns all audit definitions with current config, threshold schema, and latest run info.
|
|
630
697
|
*
|
|
631
698
|
* **Permissions:** `ADD_MEDIA`
|
|
632
699
|
*
|
|
633
700
|
*/
|
|
634
|
-
export declare const
|
|
701
|
+
export declare const listAdminMediaAudits: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditsResponses, ListAdminMediaAuditsErrors, ThrowOnError, "fields">;
|
|
635
702
|
/**
|
|
636
|
-
*
|
|
703
|
+
* Update a media audit config
|
|
637
704
|
*
|
|
638
|
-
*
|
|
705
|
+
* Updates the threshold values or enabled status of an audit.
|
|
639
706
|
*
|
|
640
707
|
* **Permissions:** `ADD_MEDIA`
|
|
641
708
|
*
|
|
642
709
|
*/
|
|
643
|
-
export declare const
|
|
710
|
+
export declare const updateAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminMediaAuditResponses, UpdateAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
644
711
|
/**
|
|
645
|
-
*
|
|
712
|
+
* Run a media audit
|
|
646
713
|
*
|
|
647
|
-
*
|
|
714
|
+
* Triggers all enabled audits (or a specific one). Creates MediaAuditRun records and AUTO reports for any findings.
|
|
648
715
|
*
|
|
649
716
|
* **Permissions:** `ADD_MEDIA`
|
|
650
717
|
*
|
|
651
718
|
*/
|
|
652
|
-
export declare const
|
|
719
|
+
export declare const runAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<RunAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<RunAdminMediaAuditResponses, RunAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
653
720
|
/**
|
|
654
|
-
*
|
|
721
|
+
* List past audit runs
|
|
655
722
|
*
|
|
656
|
-
*
|
|
723
|
+
* Returns past media audit runs with summary stats. Supports filtering by audit name and cursor pagination.
|
|
657
724
|
*
|
|
658
725
|
* **Permissions:** `ADD_MEDIA`
|
|
659
726
|
*
|
|
660
727
|
*/
|
|
661
|
-
export declare const
|
|
728
|
+
export declare const listAdminMediaAuditRuns: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditRunsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditRunsResponses, ListAdminMediaAuditRunsErrors, ThrowOnError, "fields">;
|
|
662
729
|
/**
|
|
663
|
-
*
|
|
730
|
+
* Get a specific audit run's details
|
|
664
731
|
*
|
|
665
|
-
*
|
|
732
|
+
* Returns a specific media audit run record with its linked reports.
|
|
666
733
|
*
|
|
667
734
|
* **Permissions:** `ADD_MEDIA`
|
|
668
735
|
*
|
|
669
736
|
*/
|
|
670
|
-
export declare const
|
|
737
|
+
export declare const getAdminMediaAuditRun: <ThrowOnError extends boolean = false>(options: Options<GetAdminMediaAuditRunData, ThrowOnError>) => import("./client").RequestResult<GetAdminMediaAuditRunResponses, GetAdminMediaAuditRunErrors, ThrowOnError, "fields">;
|
|
671
738
|
//# sourceMappingURL=sdk.gen.d.ts.map
|