@brigadasos/nadeshiko-sdk 1.4.3-dev.e5c01f0 → 1.5.0-dev.0c1011b
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 +17 -14
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/index.cjs +375 -202
- 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 +362 -195
- 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/collections.gen.d.ts +2 -0
- package/dist/internal/collections.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 +1 -1
- package/dist/internal/user.gen.d.ts.map +1 -1
- package/dist/internal.gen.d.ts +1 -0
- package/dist/internal.gen.d.ts.map +1 -1
- package/dist/nadeshiko.gen.d.ts +48 -40
- package/dist/nadeshiko.gen.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +213 -144
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1505 -1324
- 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,252 @@ 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
|
-
*
|
|
108
|
+
* Pass `include[]=ratingAnalysis` and/or `include[]=posAnalysis` to receive raw analysis fields alongside the standard segment data.
|
|
109
|
+
*
|
|
110
|
+
* **Permissions:** `UPDATE_MEDIA` (API key) or admin session
|
|
109
111
|
*
|
|
110
112
|
*/
|
|
111
|
-
export declare const
|
|
113
|
+
export declare const getSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<GetSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<GetSegmentByUuidResponses, GetSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
112
114
|
/**
|
|
113
|
-
*
|
|
115
|
+
* Update segment by UUID
|
|
114
116
|
*
|
|
115
|
-
*
|
|
117
|
+
* Updates an existing segment identified by its UUID. Performs the UUID→segment lookup internally,
|
|
118
|
+
* then applies the update. Only provided fields will be updated.
|
|
116
119
|
*
|
|
117
|
-
* **Permissions:** `
|
|
120
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
118
121
|
*
|
|
119
122
|
*/
|
|
120
|
-
export declare const
|
|
123
|
+
export declare const updateSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentByUuidResponses, UpdateSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
121
124
|
/**
|
|
122
|
-
*
|
|
125
|
+
* Get surrounding context for a segment
|
|
123
126
|
*
|
|
124
|
-
*
|
|
127
|
+
* Retrieves segments surrounding a specific segment within an episode.
|
|
128
|
+
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
125
129
|
*
|
|
126
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
130
|
+
* **Permissions:** `UPDATE_MEDIA` (API key) or admin session
|
|
127
131
|
*
|
|
128
132
|
*/
|
|
129
|
-
export declare const
|
|
133
|
+
export declare const getSegmentContext: <ThrowOnError extends boolean = false>(options: Options<GetSegmentContextData, ThrowOnError>) => import("./client").RequestResult<GetSegmentContextResponses, GetSegmentContextErrors, ThrowOnError, "fields">;
|
|
130
134
|
/**
|
|
131
|
-
* List
|
|
135
|
+
* List all series
|
|
132
136
|
*
|
|
133
|
-
* Returns a paginated list of
|
|
137
|
+
* Returns a paginated list of media series groupings.
|
|
134
138
|
*
|
|
135
139
|
* **Permissions:** `READ_MEDIA`
|
|
136
140
|
*
|
|
137
141
|
*/
|
|
138
|
-
export declare const
|
|
142
|
+
export declare const listSeries: <ThrowOnError extends boolean = false>(options?: Options<ListSeriesData, ThrowOnError>) => import("./client").RequestResult<ListSeriesResponses, ListSeriesErrors, ThrowOnError, "fields">;
|
|
139
143
|
/**
|
|
140
|
-
* Create
|
|
144
|
+
* Create series
|
|
141
145
|
*
|
|
142
|
-
* Creates a new
|
|
146
|
+
* Creates a new media series grouping.
|
|
143
147
|
*
|
|
144
148
|
* **Permissions:** `ADD_MEDIA`
|
|
145
149
|
*
|
|
146
150
|
*/
|
|
147
|
-
export declare const
|
|
151
|
+
export declare const createSeries: <ThrowOnError extends boolean = false>(options: Options<CreateSeriesData, ThrowOnError>) => import("./client").RequestResult<CreateSeriesResponses, CreateSeriesErrors, ThrowOnError, "fields">;
|
|
148
152
|
/**
|
|
149
|
-
* Delete
|
|
153
|
+
* Delete series
|
|
150
154
|
*
|
|
151
|
-
*
|
|
155
|
+
* Deletes a series and all its media associations.
|
|
152
156
|
*
|
|
153
157
|
* **Permissions:** `REMOVE_MEDIA`
|
|
154
158
|
*
|
|
155
159
|
*/
|
|
156
|
-
export declare const
|
|
160
|
+
export declare const deleteSeries: <ThrowOnError extends boolean = false>(options: Options<DeleteSeriesData, ThrowOnError>) => import("./client").RequestResult<DeleteSeriesResponses, DeleteSeriesErrors, ThrowOnError, "fields">;
|
|
157
161
|
/**
|
|
158
|
-
* Get
|
|
162
|
+
* Get series details
|
|
159
163
|
*
|
|
160
|
-
* Returns a
|
|
164
|
+
* Returns a series with all media entries sorted by position.
|
|
161
165
|
*
|
|
162
166
|
* **Permissions:** `READ_MEDIA`
|
|
163
167
|
*
|
|
164
168
|
*/
|
|
165
|
-
export declare const
|
|
169
|
+
export declare const getSeries: <ThrowOnError extends boolean = false>(options: Options<GetSeriesData, ThrowOnError>) => import("./client").RequestResult<GetSeriesResponses, GetSeriesErrors, ThrowOnError, "fields">;
|
|
166
170
|
/**
|
|
167
|
-
* Update
|
|
171
|
+
* Update series metadata
|
|
168
172
|
*
|
|
169
|
-
* Updates
|
|
173
|
+
* Updates series localized names.
|
|
170
174
|
*
|
|
171
175
|
* **Permissions:** `UPDATE_MEDIA`
|
|
172
176
|
*
|
|
173
177
|
*/
|
|
174
|
-
export declare const
|
|
178
|
+
export declare const updateSeries: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesResponses, UpdateSeriesErrors, ThrowOnError, "fields">;
|
|
175
179
|
/**
|
|
176
|
-
*
|
|
180
|
+
* Add media to series
|
|
177
181
|
*
|
|
178
|
-
*
|
|
182
|
+
* Adds a media entry to a series at a specific position.
|
|
179
183
|
*
|
|
180
|
-
* **Permissions:** `
|
|
184
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
181
185
|
*
|
|
182
186
|
*/
|
|
183
|
-
export declare const
|
|
187
|
+
export declare const addMediaToSeries: <ThrowOnError extends boolean = false>(options: Options<AddMediaToSeriesData, ThrowOnError>) => import("./client").RequestResult<AddMediaToSeriesResponses, AddMediaToSeriesErrors, ThrowOnError, "fields">;
|
|
184
188
|
/**
|
|
185
|
-
*
|
|
189
|
+
* Remove media from series
|
|
186
190
|
*
|
|
187
|
-
*
|
|
191
|
+
* Removes a media entry from a series.
|
|
188
192
|
*
|
|
189
|
-
* **Permissions:** `
|
|
193
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
190
194
|
*
|
|
191
195
|
*/
|
|
192
|
-
export declare const
|
|
196
|
+
export declare const removeMediaFromSeries: <ThrowOnError extends boolean = false>(options: Options<RemoveMediaFromSeriesData, ThrowOnError>) => import("./client").RequestResult<RemoveMediaFromSeriesResponses, RemoveMediaFromSeriesErrors, ThrowOnError, "fields">;
|
|
193
197
|
/**
|
|
194
|
-
*
|
|
198
|
+
* Update media position in series
|
|
195
199
|
*
|
|
196
|
-
*
|
|
200
|
+
* Updates the position of a media entry in a series.
|
|
197
201
|
*
|
|
198
|
-
* **Permissions:** `
|
|
202
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
199
203
|
*
|
|
200
204
|
*/
|
|
201
|
-
export declare const
|
|
205
|
+
export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesMediaResponses, UpdateSeriesMediaErrors, ThrowOnError, "fields">;
|
|
202
206
|
/**
|
|
203
|
-
* Get
|
|
207
|
+
* Get character details
|
|
204
208
|
*
|
|
205
|
-
* Returns a
|
|
209
|
+
* Returns a character with their voice actors (seiyuu) and all media appearances.
|
|
206
210
|
*
|
|
207
211
|
* **Permissions:** `READ_MEDIA`
|
|
208
212
|
*
|
|
209
213
|
*/
|
|
210
|
-
export declare const
|
|
214
|
+
export declare const getCharacter: <ThrowOnError extends boolean = false>(options: Options<GetCharacterData, ThrowOnError>) => import("./client").RequestResult<GetCharacterResponses, GetCharacterErrors, ThrowOnError, "fields">;
|
|
211
215
|
/**
|
|
212
|
-
*
|
|
216
|
+
* Get seiyuu details
|
|
213
217
|
*
|
|
214
|
-
*
|
|
218
|
+
* Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
|
|
215
219
|
*
|
|
216
|
-
* **Permissions:** `
|
|
220
|
+
* **Permissions:** `READ_MEDIA`
|
|
217
221
|
*
|
|
218
222
|
*/
|
|
219
|
-
export declare const
|
|
223
|
+
export declare const getSeiyuu: <ThrowOnError extends boolean = false>(options: Options<GetSeiyuuData, ThrowOnError>) => import("./client").RequestResult<GetSeiyuuResponses, GetSeiyuuErrors, ThrowOnError, "fields">;
|
|
220
224
|
/**
|
|
221
|
-
*
|
|
225
|
+
* Delete media (soft delete)
|
|
222
226
|
*
|
|
223
|
-
*
|
|
227
|
+
* Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
|
|
224
228
|
*
|
|
225
|
-
* **Permissions:** `
|
|
229
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
226
230
|
*
|
|
227
231
|
*/
|
|
228
|
-
export declare const
|
|
232
|
+
export declare const deleteMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError, "fields">;
|
|
229
233
|
/**
|
|
230
|
-
* Get
|
|
234
|
+
* Get single media
|
|
231
235
|
*
|
|
232
|
-
*
|
|
233
|
-
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
236
|
+
* Returns a single media entry by its ID with full metadata.
|
|
234
237
|
*
|
|
235
238
|
* **Permissions:** `READ_MEDIA`
|
|
236
239
|
*
|
|
237
240
|
*/
|
|
238
|
-
export declare const
|
|
241
|
+
export declare const getMedia: <ThrowOnError extends boolean = false>(options: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, GetMediaErrors, ThrowOnError, "fields">;
|
|
239
242
|
/**
|
|
240
|
-
*
|
|
243
|
+
* Update media
|
|
241
244
|
*
|
|
242
|
-
*
|
|
245
|
+
* Updates an existing media entry. Only provided fields will be updated.
|
|
246
|
+
*
|
|
247
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
243
248
|
*
|
|
244
249
|
*/
|
|
245
|
-
export declare const
|
|
250
|
+
export declare const updateMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError, "fields">;
|
|
246
251
|
/**
|
|
247
|
-
*
|
|
252
|
+
* List episodes for a media
|
|
248
253
|
*
|
|
249
|
-
*
|
|
254
|
+
* Returns a paginated list of episodes for a specific media.
|
|
255
|
+
*
|
|
256
|
+
* **Permissions:** `READ_MEDIA`
|
|
250
257
|
*
|
|
251
258
|
*/
|
|
252
|
-
export declare const
|
|
259
|
+
export declare const listEpisodes: <ThrowOnError extends boolean = false>(options: Options<ListEpisodesData, ThrowOnError>) => import("./client").RequestResult<ListEpisodesResponses, ListEpisodesErrors, ThrowOnError, "fields">;
|
|
253
260
|
/**
|
|
254
|
-
*
|
|
261
|
+
* Create new episode
|
|
255
262
|
*
|
|
256
|
-
*
|
|
263
|
+
* Creates a new episode for a specific media.
|
|
264
|
+
*
|
|
265
|
+
* **Permissions:** `ADD_MEDIA`
|
|
257
266
|
*
|
|
258
267
|
*/
|
|
259
|
-
export declare const
|
|
268
|
+
export declare const createEpisode: <ThrowOnError extends boolean = false>(options: Options<CreateEpisodeData, ThrowOnError>) => import("./client").RequestResult<CreateEpisodeResponses, CreateEpisodeErrors, ThrowOnError, "fields">;
|
|
260
269
|
/**
|
|
261
|
-
*
|
|
270
|
+
* Delete an episode
|
|
262
271
|
*
|
|
263
|
-
*
|
|
272
|
+
* Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
|
|
273
|
+
*
|
|
274
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
264
275
|
*
|
|
265
276
|
*/
|
|
266
|
-
export declare const
|
|
277
|
+
export declare const deleteEpisode: <ThrowOnError extends boolean = false>(options: Options<DeleteEpisodeData, ThrowOnError>) => import("./client").RequestResult<DeleteEpisodeResponses, DeleteEpisodeErrors, ThrowOnError, "fields">;
|
|
267
278
|
/**
|
|
268
|
-
*
|
|
279
|
+
* Get single episode
|
|
269
280
|
*
|
|
270
|
-
*
|
|
281
|
+
* Returns a specific episode by media ID and episode number.
|
|
282
|
+
*
|
|
283
|
+
* **Permissions:** `READ_MEDIA`
|
|
271
284
|
*
|
|
272
285
|
*/
|
|
273
|
-
export declare const
|
|
286
|
+
export declare const getEpisode: <ThrowOnError extends boolean = false>(options: Options<GetEpisodeData, ThrowOnError>) => import("./client").RequestResult<GetEpisodeResponses, GetEpisodeErrors, ThrowOnError, "fields">;
|
|
274
287
|
/**
|
|
275
|
-
*
|
|
288
|
+
* Update episode
|
|
276
289
|
*
|
|
277
|
-
*
|
|
290
|
+
* Updates an existing episode. Only provided fields will be updated.
|
|
291
|
+
*
|
|
292
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
278
293
|
*
|
|
279
294
|
*/
|
|
280
|
-
export declare const
|
|
295
|
+
export declare const updateEpisode: <ThrowOnError extends boolean = false>(options: Options<UpdateEpisodeData, ThrowOnError>) => import("./client").RequestResult<UpdateEpisodeResponses, UpdateEpisodeErrors, ThrowOnError, "fields">;
|
|
281
296
|
/**
|
|
282
|
-
*
|
|
297
|
+
* List segments for an episode
|
|
283
298
|
*
|
|
284
|
-
*
|
|
299
|
+
* Returns a paginated list of segments for a specific episode.
|
|
300
|
+
*
|
|
301
|
+
* **Permissions:** `READ_MEDIA`
|
|
285
302
|
*
|
|
286
303
|
*/
|
|
287
|
-
export declare const
|
|
304
|
+
export declare const listSegments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError, "fields">;
|
|
288
305
|
/**
|
|
289
|
-
*
|
|
306
|
+
* Create new segment
|
|
290
307
|
*
|
|
291
|
-
*
|
|
308
|
+
* Creates a new segment for a specific episode.
|
|
309
|
+
*
|
|
310
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
292
311
|
*
|
|
293
312
|
*/
|
|
294
|
-
export declare const
|
|
313
|
+
export declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError, "fields">;
|
|
295
314
|
/**
|
|
296
|
-
*
|
|
315
|
+
* Delete segment
|
|
297
316
|
*
|
|
298
|
-
*
|
|
317
|
+
* Soft-deletes a segment by setting its status to DELETED.
|
|
299
318
|
*
|
|
300
|
-
* **Permissions:** `
|
|
319
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
301
320
|
*
|
|
302
321
|
*/
|
|
303
|
-
export declare const
|
|
322
|
+
export declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => import("./client").RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError, "fields">;
|
|
304
323
|
/**
|
|
305
|
-
* Get
|
|
324
|
+
* Get single segment
|
|
306
325
|
*
|
|
307
|
-
* Returns a
|
|
326
|
+
* Returns a specific segment by its ID within the media/episode hierarchy.
|
|
308
327
|
*
|
|
309
328
|
* **Permissions:** `READ_MEDIA`
|
|
310
329
|
*
|
|
311
330
|
*/
|
|
312
|
-
export declare const
|
|
331
|
+
export declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => import("./client").RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError, "fields">;
|
|
313
332
|
/**
|
|
314
|
-
*
|
|
333
|
+
* Update segment
|
|
315
334
|
*
|
|
316
|
-
*
|
|
317
|
-
* Accepts both session cookie and API key authentication.
|
|
335
|
+
* Updates an existing segment. Only provided fields will be updated.
|
|
318
336
|
*
|
|
319
|
-
* **Permissions:**
|
|
337
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
320
338
|
*
|
|
321
339
|
*/
|
|
322
|
-
export declare const
|
|
340
|
+
export declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError, "fields">;
|
|
323
341
|
/**
|
|
324
|
-
*
|
|
342
|
+
* Get current monthly API quota
|
|
325
343
|
*
|
|
326
|
-
* Returns the
|
|
344
|
+
* Returns the API quota usage for the current billing period.
|
|
327
345
|
*
|
|
328
346
|
* **Permissions:** Session authentication (cookie-based).
|
|
329
347
|
*
|
|
330
348
|
*/
|
|
331
|
-
export declare const
|
|
349
|
+
export declare const getUserQuota: <ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError, "fields">;
|
|
332
350
|
/**
|
|
333
351
|
* Create a new report
|
|
334
352
|
*
|
|
@@ -375,11 +393,20 @@ export declare const deleteUserActivity: <ThrowOnError extends boolean = false>(
|
|
|
375
393
|
*
|
|
376
394
|
*/
|
|
377
395
|
export declare const listUserActivity: <ThrowOnError extends boolean = false>(options?: Options<ListUserActivityData, ThrowOnError>) => import("./client").RequestResult<ListUserActivityResponses, ListUserActivityErrors, ThrowOnError, "fields">;
|
|
396
|
+
/**
|
|
397
|
+
* Track user activity
|
|
398
|
+
*
|
|
399
|
+
* Records a user activity event (e.g. segment play). Fire-and-forget — always returns 204.
|
|
400
|
+
*
|
|
401
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
402
|
+
*
|
|
403
|
+
*/
|
|
404
|
+
export declare const trackUserActivity: <ThrowOnError extends boolean = false>(options: Options<TrackUserActivityData, ThrowOnError>) => import("./client").RequestResult<TrackUserActivityResponses, TrackUserActivityErrors, ThrowOnError, "fields">;
|
|
378
405
|
/**
|
|
379
406
|
* Get activity heatmap data
|
|
380
407
|
*
|
|
381
|
-
* Returns daily activity counts for the authenticated user, grouped by date.
|
|
382
|
-
*
|
|
408
|
+
* Returns daily activity counts for the authenticated user, grouped by date and activity type.
|
|
409
|
+
* Each day contains per-type counts that can be summed or filtered client-side.
|
|
383
410
|
*
|
|
384
411
|
* **Permissions:** Session authentication (cookie-based).
|
|
385
412
|
*
|
|
@@ -389,12 +416,30 @@ export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = fal
|
|
|
389
416
|
* Get user activity statistics
|
|
390
417
|
*
|
|
391
418
|
* Returns aggregate statistics about the authenticated user's activity:
|
|
392
|
-
* total searches, exports, plays, and
|
|
419
|
+
* total searches, exports, plays, and top media.
|
|
393
420
|
*
|
|
394
421
|
* **Permissions:** Session authentication (cookie-based).
|
|
395
422
|
*
|
|
396
423
|
*/
|
|
397
424
|
export declare const getUserActivityStats: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityStatsData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityStatsResponses, GetUserActivityStatsErrors, ThrowOnError, "fields">;
|
|
425
|
+
/**
|
|
426
|
+
* Delete all activity for a specific date
|
|
427
|
+
*
|
|
428
|
+
* Deletes all activity records for the authenticated user on the given date.
|
|
429
|
+
*
|
|
430
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
431
|
+
*
|
|
432
|
+
*/
|
|
433
|
+
export declare const deleteUserActivityByDate: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByDateData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByDateResponses, DeleteUserActivityByDateErrors, ThrowOnError, "fields">;
|
|
434
|
+
/**
|
|
435
|
+
* Delete a single activity record
|
|
436
|
+
*
|
|
437
|
+
* Deletes a single activity record by ID for the authenticated user.
|
|
438
|
+
*
|
|
439
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
440
|
+
*
|
|
441
|
+
*/
|
|
442
|
+
export declare const deleteUserActivityById: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByIdData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByIdResponses, DeleteUserActivityByIdErrors, ThrowOnError, "fields">;
|
|
398
443
|
/**
|
|
399
444
|
* Export all user data
|
|
400
445
|
*
|
|
@@ -416,6 +461,25 @@ export declare const exportUserData: <ThrowOnError extends boolean = false>(opti
|
|
|
416
461
|
*
|
|
417
462
|
*/
|
|
418
463
|
export declare const listUserLabs: <ThrowOnError extends boolean = false>(options?: Options<ListUserLabsData, ThrowOnError>) => import("./client").RequestResult<ListUserLabsResponses, ListUserLabsErrors, ThrowOnError, "fields">;
|
|
464
|
+
/**
|
|
465
|
+
* Unenroll from a lab feature
|
|
466
|
+
*
|
|
467
|
+
* Opts the authenticated user out of a lab feature.
|
|
468
|
+
*
|
|
469
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
470
|
+
*
|
|
471
|
+
*/
|
|
472
|
+
export declare const unenrollUserLab: <ThrowOnError extends boolean = false>(options: Options<UnenrollUserLabData, ThrowOnError>) => import("./client").RequestResult<UnenrollUserLabResponses, UnenrollUserLabErrors, ThrowOnError, "fields">;
|
|
473
|
+
/**
|
|
474
|
+
* Enroll in a lab feature
|
|
475
|
+
*
|
|
476
|
+
* Opts the authenticated user into a lab feature. The user must be eligible
|
|
477
|
+
* for the lab (correct role, in allowlist or rollout percentage).
|
|
478
|
+
*
|
|
479
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
480
|
+
*
|
|
481
|
+
*/
|
|
482
|
+
export declare const enrollUserLab: <ThrowOnError extends boolean = false>(options: Options<EnrollUserLabData, ThrowOnError>) => import("./client").RequestResult<EnrollUserLabResponses, EnrollUserLabErrors, ThrowOnError, "fields">;
|
|
419
483
|
/**
|
|
420
484
|
* List user's collections
|
|
421
485
|
*
|
|
@@ -472,6 +536,22 @@ export declare const removeSegmentFromCollection: <ThrowOnError extends boolean
|
|
|
472
536
|
*
|
|
473
537
|
*/
|
|
474
538
|
export declare const updateCollectionSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateCollectionSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateCollectionSegmentResponses, UpdateCollectionSegmentErrors, ThrowOnError, "fields">;
|
|
539
|
+
/**
|
|
540
|
+
* Search collection segments
|
|
541
|
+
*
|
|
542
|
+
* Returns collection segments in search-response format with pagination.
|
|
543
|
+
* Reshapes the collection data: extracts segment results, includes media, computes pagination.
|
|
544
|
+
*
|
|
545
|
+
*/
|
|
546
|
+
export declare const searchCollectionSegments: <ThrowOnError extends boolean = false>(options: Options<SearchCollectionSegmentsData, ThrowOnError>) => import("./client").RequestResult<SearchCollectionSegmentsResponses, SearchCollectionSegmentsErrors, ThrowOnError, "fields">;
|
|
547
|
+
/**
|
|
548
|
+
* Get collection statistics
|
|
549
|
+
*
|
|
550
|
+
* Returns per-media segment counts and per-category counts for all segments in a collection.
|
|
551
|
+
* Pages through all collection segments internally to compute statistics.
|
|
552
|
+
*
|
|
553
|
+
*/
|
|
554
|
+
export declare const getCollectionStats: <ThrowOnError extends boolean = false>(options: Options<GetCollectionStatsData, ThrowOnError>) => import("./client").RequestResult<GetCollectionStatsResponses, GetCollectionStatsErrors, ThrowOnError, "fields">;
|
|
475
555
|
/**
|
|
476
556
|
* Admin dashboard statistics
|
|
477
557
|
*
|
|
@@ -496,12 +576,12 @@ export declare const getAdminHealth: <ThrowOnError extends boolean = false>(opti
|
|
|
496
576
|
* Reindex database into Elasticsearch
|
|
497
577
|
*
|
|
498
578
|
* Reindexes segments from the PostgreSQL database into Elasticsearch.
|
|
499
|
-
* Allows filtering by specific media
|
|
579
|
+
* Allows filtering by specific media entries and episodes.
|
|
500
580
|
*
|
|
501
581
|
* **Behavior:**
|
|
502
582
|
* - If no filters provided, reindexes all segments
|
|
503
|
-
* - If `
|
|
504
|
-
* - If `episodes
|
|
583
|
+
* - If `media` is provided, reindexes segments from those media entries
|
|
584
|
+
* - If a media item includes `episodes`, only those episodes are reindexed for that media
|
|
505
585
|
*
|
|
506
586
|
* **Permissions:** `ADD_MEDIA`
|
|
507
587
|
*
|
|
@@ -577,95 +657,84 @@ export declare const retryAdminQueueFailed: <ThrowOnError extends boolean = fals
|
|
|
577
657
|
*/
|
|
578
658
|
export declare const purgeAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<PurgeAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<PurgeAdminQueueFailedResponses, PurgeAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
579
659
|
/**
|
|
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.
|
|
660
|
+
* Clear admin impersonation
|
|
594
661
|
*
|
|
595
|
-
*
|
|
662
|
+
* Clears the current impersonation session and related cookies.
|
|
663
|
+
* This endpoint is only available in local environment.
|
|
596
664
|
*
|
|
597
665
|
*/
|
|
598
|
-
export declare const
|
|
666
|
+
export declare const clearAdminImpersonation: <ThrowOnError extends boolean = false>(options?: Options<ClearAdminImpersonationData, ThrowOnError>) => import("./client").RequestResult<ClearAdminImpersonationResponses, ClearAdminImpersonationErrors, ThrowOnError, "fields">;
|
|
599
667
|
/**
|
|
600
|
-
*
|
|
668
|
+
* Start admin impersonation
|
|
601
669
|
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
* **Permissions:** `ADD_MEDIA`
|
|
670
|
+
* Creates an impersonation session for the target user.
|
|
671
|
+
* This endpoint is only available in local environment.
|
|
605
672
|
*
|
|
606
673
|
*/
|
|
607
|
-
export declare const
|
|
674
|
+
export declare const impersonateAdminUser: <ThrowOnError extends boolean = false>(options: Options<ImpersonateAdminUserData, ThrowOnError>) => import("./client").RequestResult<ImpersonateAdminUserResponses, ImpersonateAdminUserErrors, ThrowOnError, "fields">;
|
|
608
675
|
/**
|
|
609
|
-
* List all
|
|
676
|
+
* List all reports
|
|
610
677
|
*
|
|
611
|
-
* Returns all
|
|
678
|
+
* Returns all reports with filtering and cursor pagination.
|
|
679
|
+
* Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
|
|
612
680
|
*
|
|
613
681
|
* **Permissions:** `ADD_MEDIA`
|
|
614
682
|
*
|
|
615
683
|
*/
|
|
616
|
-
export declare const
|
|
684
|
+
export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
|
|
617
685
|
/**
|
|
618
|
-
* Update a
|
|
686
|
+
* Update a report
|
|
619
687
|
*
|
|
620
|
-
* Updates the
|
|
688
|
+
* Updates the status and/or admin notes of a report.
|
|
689
|
+
* Works for both USER and AUTO reports.
|
|
621
690
|
*
|
|
622
691
|
* **Permissions:** `ADD_MEDIA`
|
|
623
692
|
*
|
|
624
693
|
*/
|
|
625
|
-
export declare const
|
|
694
|
+
export declare const updateAdminReport: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReportData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReportResponses, UpdateAdminReportErrors, ThrowOnError, "fields">;
|
|
626
695
|
/**
|
|
627
|
-
* List
|
|
696
|
+
* List all media audits
|
|
628
697
|
*
|
|
629
|
-
* Returns
|
|
698
|
+
* Returns all audit definitions with current config, threshold schema, and latest run info.
|
|
630
699
|
*
|
|
631
700
|
* **Permissions:** `ADD_MEDIA`
|
|
632
701
|
*
|
|
633
702
|
*/
|
|
634
|
-
export declare const
|
|
703
|
+
export declare const listAdminMediaAudits: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditsResponses, ListAdminMediaAuditsErrors, ThrowOnError, "fields">;
|
|
635
704
|
/**
|
|
636
|
-
*
|
|
705
|
+
* Update a media audit config
|
|
637
706
|
*
|
|
638
|
-
*
|
|
707
|
+
* Updates the threshold values or enabled status of an audit.
|
|
639
708
|
*
|
|
640
709
|
* **Permissions:** `ADD_MEDIA`
|
|
641
710
|
*
|
|
642
711
|
*/
|
|
643
|
-
export declare const
|
|
712
|
+
export declare const updateAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminMediaAuditResponses, UpdateAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
644
713
|
/**
|
|
645
|
-
*
|
|
714
|
+
* Run a media audit
|
|
646
715
|
*
|
|
647
|
-
*
|
|
716
|
+
* Triggers all enabled audits (or a specific one). Creates MediaAuditRun records and AUTO reports for any findings.
|
|
648
717
|
*
|
|
649
718
|
* **Permissions:** `ADD_MEDIA`
|
|
650
719
|
*
|
|
651
720
|
*/
|
|
652
|
-
export declare const
|
|
721
|
+
export declare const runAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<RunAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<RunAdminMediaAuditResponses, RunAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
653
722
|
/**
|
|
654
|
-
*
|
|
723
|
+
* List past audit runs
|
|
655
724
|
*
|
|
656
|
-
*
|
|
725
|
+
* Returns past media audit runs with summary stats. Supports filtering by audit name and cursor pagination.
|
|
657
726
|
*
|
|
658
727
|
* **Permissions:** `ADD_MEDIA`
|
|
659
728
|
*
|
|
660
729
|
*/
|
|
661
|
-
export declare const
|
|
730
|
+
export declare const listAdminMediaAuditRuns: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditRunsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditRunsResponses, ListAdminMediaAuditRunsErrors, ThrowOnError, "fields">;
|
|
662
731
|
/**
|
|
663
|
-
*
|
|
732
|
+
* Get a specific audit run's details
|
|
664
733
|
*
|
|
665
|
-
*
|
|
734
|
+
* Returns a specific media audit run record with its linked reports.
|
|
666
735
|
*
|
|
667
736
|
* **Permissions:** `ADD_MEDIA`
|
|
668
737
|
*
|
|
669
738
|
*/
|
|
670
|
-
export declare const
|
|
739
|
+
export declare const getAdminMediaAuditRun: <ThrowOnError extends boolean = false>(options: Options<GetAdminMediaAuditRunData, ThrowOnError>) => import("./client").RequestResult<GetAdminMediaAuditRunResponses, GetAdminMediaAuditRunErrors, ThrowOnError, "fields">;
|
|
671
740
|
//# sourceMappingURL=sdk.gen.d.ts.map
|