@brigadasos/nadeshiko-sdk 1.4.3-dev.e5c01f0 → 1.5.0-dev.66d279f
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 +387 -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 +374 -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 +49 -40
- package/dist/nadeshiko.gen.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +223 -143
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1548 -1306
- 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, CreateSegmentsBatchData, CreateSegmentsBatchErrors, CreateSegmentsBatchResponses, 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,263 @@ 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.
|
|
192
|
+
*
|
|
193
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
194
|
+
*
|
|
195
|
+
*/
|
|
196
|
+
export declare const removeMediaFromSeries: <ThrowOnError extends boolean = false>(options: Options<RemoveMediaFromSeriesData, ThrowOnError>) => import("./client").RequestResult<RemoveMediaFromSeriesResponses, RemoveMediaFromSeriesErrors, ThrowOnError, "fields">;
|
|
197
|
+
/**
|
|
198
|
+
* Update media position in series
|
|
199
|
+
*
|
|
200
|
+
* Updates the position of a media entry in a series.
|
|
188
201
|
*
|
|
189
202
|
* **Permissions:** `UPDATE_MEDIA`
|
|
190
203
|
*
|
|
191
204
|
*/
|
|
192
|
-
export declare const
|
|
205
|
+
export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesMediaResponses, UpdateSeriesMediaErrors, ThrowOnError, "fields">;
|
|
193
206
|
/**
|
|
194
|
-
*
|
|
207
|
+
* Get character details
|
|
195
208
|
*
|
|
196
|
-
*
|
|
209
|
+
* Returns a character with their voice actors (seiyuu) and all media appearances.
|
|
197
210
|
*
|
|
198
|
-
* **Permissions:** `
|
|
211
|
+
* **Permissions:** `READ_MEDIA`
|
|
199
212
|
*
|
|
200
213
|
*/
|
|
201
|
-
export declare const
|
|
214
|
+
export declare const getCharacter: <ThrowOnError extends boolean = false>(options: Options<GetCharacterData, ThrowOnError>) => import("./client").RequestResult<GetCharacterResponses, GetCharacterErrors, ThrowOnError, "fields">;
|
|
202
215
|
/**
|
|
203
|
-
* Get
|
|
216
|
+
* Get seiyuu details
|
|
204
217
|
*
|
|
205
|
-
* Returns a
|
|
218
|
+
* Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
|
|
206
219
|
*
|
|
207
220
|
* **Permissions:** `READ_MEDIA`
|
|
208
221
|
*
|
|
209
222
|
*/
|
|
210
|
-
export declare const
|
|
223
|
+
export declare const getSeiyuu: <ThrowOnError extends boolean = false>(options: Options<GetSeiyuuData, ThrowOnError>) => import("./client").RequestResult<GetSeiyuuResponses, GetSeiyuuErrors, ThrowOnError, "fields">;
|
|
211
224
|
/**
|
|
212
|
-
*
|
|
225
|
+
* Delete media (soft delete)
|
|
213
226
|
*
|
|
214
|
-
*
|
|
227
|
+
* Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
|
|
215
228
|
*
|
|
216
|
-
* **Permissions:** `
|
|
229
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
217
230
|
*
|
|
218
231
|
*/
|
|
219
|
-
export declare const
|
|
232
|
+
export declare const deleteMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError, "fields">;
|
|
220
233
|
/**
|
|
221
|
-
* Get
|
|
234
|
+
* Get single media
|
|
222
235
|
*
|
|
223
|
-
* Returns a
|
|
236
|
+
* Returns a single media entry by its ID with full metadata.
|
|
224
237
|
*
|
|
225
238
|
* **Permissions:** `READ_MEDIA`
|
|
226
239
|
*
|
|
227
240
|
*/
|
|
228
|
-
export declare const
|
|
241
|
+
export declare const getMedia: <ThrowOnError extends boolean = false>(options: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, GetMediaErrors, ThrowOnError, "fields">;
|
|
229
242
|
/**
|
|
230
|
-
*
|
|
243
|
+
* Update media
|
|
231
244
|
*
|
|
232
|
-
*
|
|
233
|
-
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
245
|
+
* Updates an existing media entry. Only provided fields will be updated.
|
|
234
246
|
*
|
|
235
|
-
* **Permissions:** `
|
|
247
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
236
248
|
*
|
|
237
249
|
*/
|
|
238
|
-
export declare const
|
|
250
|
+
export declare const updateMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError, "fields">;
|
|
239
251
|
/**
|
|
240
|
-
* List
|
|
252
|
+
* List episodes for a media
|
|
241
253
|
*
|
|
242
|
-
* Returns a paginated list of
|
|
254
|
+
* Returns a paginated list of episodes for a specific media.
|
|
255
|
+
*
|
|
256
|
+
* **Permissions:** `READ_MEDIA`
|
|
243
257
|
*
|
|
244
258
|
*/
|
|
245
|
-
export declare const
|
|
259
|
+
export declare const listEpisodes: <ThrowOnError extends boolean = false>(options: Options<ListEpisodesData, ThrowOnError>) => import("./client").RequestResult<ListEpisodesResponses, ListEpisodesErrors, ThrowOnError, "fields">;
|
|
246
260
|
/**
|
|
247
|
-
* Create
|
|
261
|
+
* Create new episode
|
|
248
262
|
*
|
|
249
|
-
* Creates a new
|
|
263
|
+
* Creates a new episode for a specific media.
|
|
264
|
+
*
|
|
265
|
+
* **Permissions:** `ADD_MEDIA`
|
|
250
266
|
*
|
|
251
267
|
*/
|
|
252
|
-
export declare const
|
|
268
|
+
export declare const createEpisode: <ThrowOnError extends boolean = false>(options: Options<CreateEpisodeData, ThrowOnError>) => import("./client").RequestResult<CreateEpisodeResponses, CreateEpisodeErrors, ThrowOnError, "fields">;
|
|
253
269
|
/**
|
|
254
|
-
* Delete
|
|
270
|
+
* Delete an episode
|
|
255
271
|
*
|
|
256
|
-
*
|
|
272
|
+
* Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
|
|
273
|
+
*
|
|
274
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
257
275
|
*
|
|
258
276
|
*/
|
|
259
|
-
export declare const
|
|
277
|
+
export declare const deleteEpisode: <ThrowOnError extends boolean = false>(options: Options<DeleteEpisodeData, ThrowOnError>) => import("./client").RequestResult<DeleteEpisodeResponses, DeleteEpisodeErrors, ThrowOnError, "fields">;
|
|
260
278
|
/**
|
|
261
|
-
* Get
|
|
279
|
+
* Get single episode
|
|
262
280
|
*
|
|
263
|
-
* Returns a
|
|
281
|
+
* Returns a specific episode by media ID and episode number.
|
|
282
|
+
*
|
|
283
|
+
* **Permissions:** `READ_MEDIA`
|
|
264
284
|
*
|
|
265
285
|
*/
|
|
266
|
-
export declare const
|
|
286
|
+
export declare const getEpisode: <ThrowOnError extends boolean = false>(options: Options<GetEpisodeData, ThrowOnError>) => import("./client").RequestResult<GetEpisodeResponses, GetEpisodeErrors, ThrowOnError, "fields">;
|
|
267
287
|
/**
|
|
268
|
-
* Update
|
|
288
|
+
* Update episode
|
|
269
289
|
*
|
|
270
|
-
* Updates
|
|
290
|
+
* Updates an existing episode. Only provided fields will be updated.
|
|
291
|
+
*
|
|
292
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
271
293
|
*
|
|
272
294
|
*/
|
|
273
|
-
export declare const
|
|
295
|
+
export declare const updateEpisode: <ThrowOnError extends boolean = false>(options: Options<UpdateEpisodeData, ThrowOnError>) => import("./client").RequestResult<UpdateEpisodeResponses, UpdateEpisodeErrors, ThrowOnError, "fields">;
|
|
274
296
|
/**
|
|
275
|
-
*
|
|
297
|
+
* List segments for an episode
|
|
276
298
|
*
|
|
277
|
-
*
|
|
299
|
+
* Returns a paginated list of segments for a specific episode.
|
|
300
|
+
*
|
|
301
|
+
* **Permissions:** `READ_MEDIA`
|
|
278
302
|
*
|
|
279
303
|
*/
|
|
280
|
-
export declare const
|
|
304
|
+
export declare const listSegments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError, "fields">;
|
|
281
305
|
/**
|
|
282
|
-
*
|
|
306
|
+
* Create new segment
|
|
283
307
|
*
|
|
284
|
-
*
|
|
308
|
+
* Creates a new segment for a specific episode.
|
|
309
|
+
*
|
|
310
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
285
311
|
*
|
|
286
312
|
*/
|
|
287
|
-
export declare const
|
|
313
|
+
export declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError, "fields">;
|
|
288
314
|
/**
|
|
289
|
-
*
|
|
315
|
+
* Batch create segments
|
|
290
316
|
*
|
|
291
|
-
*
|
|
317
|
+
* Creates multiple segments for a specific episode in a single request.
|
|
318
|
+
* Segments with duplicate UUIDs are silently skipped (idempotent).
|
|
319
|
+
* The entire batch is wrapped in a transaction — non-duplicate errors roll back all changes.
|
|
320
|
+
*
|
|
321
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
292
322
|
*
|
|
293
323
|
*/
|
|
294
|
-
export declare const
|
|
324
|
+
export declare const createSegmentsBatch: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentsBatchData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentsBatchResponses, CreateSegmentsBatchErrors, ThrowOnError, "fields">;
|
|
295
325
|
/**
|
|
296
|
-
*
|
|
326
|
+
* Delete segment
|
|
297
327
|
*
|
|
298
|
-
*
|
|
328
|
+
* Soft-deletes a segment by setting its status to DELETED.
|
|
299
329
|
*
|
|
300
|
-
* **Permissions:** `
|
|
330
|
+
* **Permissions:** `REMOVE_MEDIA`
|
|
301
331
|
*
|
|
302
332
|
*/
|
|
303
|
-
export declare const
|
|
333
|
+
export declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => import("./client").RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError, "fields">;
|
|
304
334
|
/**
|
|
305
|
-
* Get
|
|
335
|
+
* Get single segment
|
|
306
336
|
*
|
|
307
|
-
* Returns a
|
|
337
|
+
* Returns a specific segment by its ID within the media/episode hierarchy.
|
|
308
338
|
*
|
|
309
339
|
* **Permissions:** `READ_MEDIA`
|
|
310
340
|
*
|
|
311
341
|
*/
|
|
312
|
-
export declare const
|
|
342
|
+
export declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => import("./client").RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError, "fields">;
|
|
313
343
|
/**
|
|
314
|
-
*
|
|
344
|
+
* Update segment
|
|
315
345
|
*
|
|
316
|
-
*
|
|
317
|
-
* Accepts both session cookie and API key authentication.
|
|
346
|
+
* Updates an existing segment. Only provided fields will be updated.
|
|
318
347
|
*
|
|
319
|
-
* **Permissions:**
|
|
348
|
+
* **Permissions:** `UPDATE_MEDIA`
|
|
320
349
|
*
|
|
321
350
|
*/
|
|
322
|
-
export declare const
|
|
351
|
+
export declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError, "fields">;
|
|
323
352
|
/**
|
|
324
|
-
*
|
|
353
|
+
* Get current monthly API quota
|
|
325
354
|
*
|
|
326
|
-
* Returns the
|
|
355
|
+
* Returns the API quota usage for the current billing period.
|
|
327
356
|
*
|
|
328
357
|
* **Permissions:** Session authentication (cookie-based).
|
|
329
358
|
*
|
|
330
359
|
*/
|
|
331
|
-
export declare const
|
|
360
|
+
export declare const getUserQuota: <ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError, "fields">;
|
|
332
361
|
/**
|
|
333
362
|
* Create a new report
|
|
334
363
|
*
|
|
@@ -375,11 +404,20 @@ export declare const deleteUserActivity: <ThrowOnError extends boolean = false>(
|
|
|
375
404
|
*
|
|
376
405
|
*/
|
|
377
406
|
export declare const listUserActivity: <ThrowOnError extends boolean = false>(options?: Options<ListUserActivityData, ThrowOnError>) => import("./client").RequestResult<ListUserActivityResponses, ListUserActivityErrors, ThrowOnError, "fields">;
|
|
407
|
+
/**
|
|
408
|
+
* Track user activity
|
|
409
|
+
*
|
|
410
|
+
* Records a user activity event (e.g. segment play). Fire-and-forget — always returns 204.
|
|
411
|
+
*
|
|
412
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
413
|
+
*
|
|
414
|
+
*/
|
|
415
|
+
export declare const trackUserActivity: <ThrowOnError extends boolean = false>(options: Options<TrackUserActivityData, ThrowOnError>) => import("./client").RequestResult<TrackUserActivityResponses, TrackUserActivityErrors, ThrowOnError, "fields">;
|
|
378
416
|
/**
|
|
379
417
|
* Get activity heatmap data
|
|
380
418
|
*
|
|
381
|
-
* Returns daily activity counts for the authenticated user, grouped by date.
|
|
382
|
-
*
|
|
419
|
+
* Returns daily activity counts for the authenticated user, grouped by date and activity type.
|
|
420
|
+
* Each day contains per-type counts that can be summed or filtered client-side.
|
|
383
421
|
*
|
|
384
422
|
* **Permissions:** Session authentication (cookie-based).
|
|
385
423
|
*
|
|
@@ -389,12 +427,30 @@ export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = fal
|
|
|
389
427
|
* Get user activity statistics
|
|
390
428
|
*
|
|
391
429
|
* Returns aggregate statistics about the authenticated user's activity:
|
|
392
|
-
* total searches, exports, plays, and
|
|
430
|
+
* total searches, exports, plays, and top media.
|
|
393
431
|
*
|
|
394
432
|
* **Permissions:** Session authentication (cookie-based).
|
|
395
433
|
*
|
|
396
434
|
*/
|
|
397
435
|
export declare const getUserActivityStats: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityStatsData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityStatsResponses, GetUserActivityStatsErrors, ThrowOnError, "fields">;
|
|
436
|
+
/**
|
|
437
|
+
* Delete all activity for a specific date
|
|
438
|
+
*
|
|
439
|
+
* Deletes all activity records for the authenticated user on the given date.
|
|
440
|
+
*
|
|
441
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
442
|
+
*
|
|
443
|
+
*/
|
|
444
|
+
export declare const deleteUserActivityByDate: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByDateData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByDateResponses, DeleteUserActivityByDateErrors, ThrowOnError, "fields">;
|
|
445
|
+
/**
|
|
446
|
+
* Delete a single activity record
|
|
447
|
+
*
|
|
448
|
+
* Deletes a single activity record by ID for the authenticated user.
|
|
449
|
+
*
|
|
450
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
451
|
+
*
|
|
452
|
+
*/
|
|
453
|
+
export declare const deleteUserActivityById: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByIdData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByIdResponses, DeleteUserActivityByIdErrors, ThrowOnError, "fields">;
|
|
398
454
|
/**
|
|
399
455
|
* Export all user data
|
|
400
456
|
*
|
|
@@ -416,6 +472,25 @@ export declare const exportUserData: <ThrowOnError extends boolean = false>(opti
|
|
|
416
472
|
*
|
|
417
473
|
*/
|
|
418
474
|
export declare const listUserLabs: <ThrowOnError extends boolean = false>(options?: Options<ListUserLabsData, ThrowOnError>) => import("./client").RequestResult<ListUserLabsResponses, ListUserLabsErrors, ThrowOnError, "fields">;
|
|
475
|
+
/**
|
|
476
|
+
* Unenroll from a lab feature
|
|
477
|
+
*
|
|
478
|
+
* Opts the authenticated user out of a lab feature.
|
|
479
|
+
*
|
|
480
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
481
|
+
*
|
|
482
|
+
*/
|
|
483
|
+
export declare const unenrollUserLab: <ThrowOnError extends boolean = false>(options: Options<UnenrollUserLabData, ThrowOnError>) => import("./client").RequestResult<UnenrollUserLabResponses, UnenrollUserLabErrors, ThrowOnError, "fields">;
|
|
484
|
+
/**
|
|
485
|
+
* Enroll in a lab feature
|
|
486
|
+
*
|
|
487
|
+
* Opts the authenticated user into a lab feature. The user must be eligible
|
|
488
|
+
* for the lab (correct role, in allowlist or rollout percentage).
|
|
489
|
+
*
|
|
490
|
+
* **Permissions:** Session authentication (cookie-based).
|
|
491
|
+
*
|
|
492
|
+
*/
|
|
493
|
+
export declare const enrollUserLab: <ThrowOnError extends boolean = false>(options: Options<EnrollUserLabData, ThrowOnError>) => import("./client").RequestResult<EnrollUserLabResponses, EnrollUserLabErrors, ThrowOnError, "fields">;
|
|
419
494
|
/**
|
|
420
495
|
* List user's collections
|
|
421
496
|
*
|
|
@@ -472,6 +547,22 @@ export declare const removeSegmentFromCollection: <ThrowOnError extends boolean
|
|
|
472
547
|
*
|
|
473
548
|
*/
|
|
474
549
|
export declare const updateCollectionSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateCollectionSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateCollectionSegmentResponses, UpdateCollectionSegmentErrors, ThrowOnError, "fields">;
|
|
550
|
+
/**
|
|
551
|
+
* Search collection segments
|
|
552
|
+
*
|
|
553
|
+
* Returns collection segments in search-response format with pagination.
|
|
554
|
+
* Reshapes the collection data: extracts segment results, includes media, computes pagination.
|
|
555
|
+
*
|
|
556
|
+
*/
|
|
557
|
+
export declare const searchCollectionSegments: <ThrowOnError extends boolean = false>(options: Options<SearchCollectionSegmentsData, ThrowOnError>) => import("./client").RequestResult<SearchCollectionSegmentsResponses, SearchCollectionSegmentsErrors, ThrowOnError, "fields">;
|
|
558
|
+
/**
|
|
559
|
+
* Get collection statistics
|
|
560
|
+
*
|
|
561
|
+
* Returns per-media segment counts and per-category counts for all segments in a collection.
|
|
562
|
+
* Pages through all collection segments internally to compute statistics.
|
|
563
|
+
*
|
|
564
|
+
*/
|
|
565
|
+
export declare const getCollectionStats: <ThrowOnError extends boolean = false>(options: Options<GetCollectionStatsData, ThrowOnError>) => import("./client").RequestResult<GetCollectionStatsResponses, GetCollectionStatsErrors, ThrowOnError, "fields">;
|
|
475
566
|
/**
|
|
476
567
|
* Admin dashboard statistics
|
|
477
568
|
*
|
|
@@ -496,12 +587,12 @@ export declare const getAdminHealth: <ThrowOnError extends boolean = false>(opti
|
|
|
496
587
|
* Reindex database into Elasticsearch
|
|
497
588
|
*
|
|
498
589
|
* Reindexes segments from the PostgreSQL database into Elasticsearch.
|
|
499
|
-
* Allows filtering by specific media
|
|
590
|
+
* Allows filtering by specific media entries and episodes.
|
|
500
591
|
*
|
|
501
592
|
* **Behavior:**
|
|
502
593
|
* - If no filters provided, reindexes all segments
|
|
503
|
-
* - If `
|
|
504
|
-
* - If `episodes
|
|
594
|
+
* - If `media` is provided, reindexes segments from those media entries
|
|
595
|
+
* - If a media item includes `episodes`, only those episodes are reindexed for that media
|
|
505
596
|
*
|
|
506
597
|
* **Permissions:** `ADD_MEDIA`
|
|
507
598
|
*
|
|
@@ -577,95 +668,84 @@ export declare const retryAdminQueueFailed: <ThrowOnError extends boolean = fals
|
|
|
577
668
|
*/
|
|
578
669
|
export declare const purgeAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<PurgeAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<PurgeAdminQueueFailedResponses, PurgeAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
579
670
|
/**
|
|
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.
|
|
671
|
+
* Clear admin impersonation
|
|
594
672
|
*
|
|
595
|
-
*
|
|
673
|
+
* Clears the current impersonation session and related cookies.
|
|
674
|
+
* This endpoint is only available in local environment.
|
|
596
675
|
*
|
|
597
676
|
*/
|
|
598
|
-
export declare const
|
|
677
|
+
export declare const clearAdminImpersonation: <ThrowOnError extends boolean = false>(options?: Options<ClearAdminImpersonationData, ThrowOnError>) => import("./client").RequestResult<ClearAdminImpersonationResponses, ClearAdminImpersonationErrors, ThrowOnError, "fields">;
|
|
599
678
|
/**
|
|
600
|
-
*
|
|
679
|
+
* Start admin impersonation
|
|
601
680
|
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
* **Permissions:** `ADD_MEDIA`
|
|
681
|
+
* Creates an impersonation session for the target user.
|
|
682
|
+
* This endpoint is only available in local environment.
|
|
605
683
|
*
|
|
606
684
|
*/
|
|
607
|
-
export declare const
|
|
685
|
+
export declare const impersonateAdminUser: <ThrowOnError extends boolean = false>(options: Options<ImpersonateAdminUserData, ThrowOnError>) => import("./client").RequestResult<ImpersonateAdminUserResponses, ImpersonateAdminUserErrors, ThrowOnError, "fields">;
|
|
608
686
|
/**
|
|
609
|
-
* List all
|
|
687
|
+
* List all reports
|
|
610
688
|
*
|
|
611
|
-
* Returns all
|
|
689
|
+
* Returns all reports with filtering and cursor pagination.
|
|
690
|
+
* Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
|
|
612
691
|
*
|
|
613
692
|
* **Permissions:** `ADD_MEDIA`
|
|
614
693
|
*
|
|
615
694
|
*/
|
|
616
|
-
export declare const
|
|
695
|
+
export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
|
|
617
696
|
/**
|
|
618
|
-
* Update a
|
|
697
|
+
* Update a report
|
|
619
698
|
*
|
|
620
|
-
* Updates the
|
|
699
|
+
* Updates the status and/or admin notes of a report.
|
|
700
|
+
* Works for both USER and AUTO reports.
|
|
621
701
|
*
|
|
622
702
|
* **Permissions:** `ADD_MEDIA`
|
|
623
703
|
*
|
|
624
704
|
*/
|
|
625
|
-
export declare const
|
|
705
|
+
export declare const updateAdminReport: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReportData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReportResponses, UpdateAdminReportErrors, ThrowOnError, "fields">;
|
|
626
706
|
/**
|
|
627
|
-
* List
|
|
707
|
+
* List all media audits
|
|
628
708
|
*
|
|
629
|
-
* Returns
|
|
709
|
+
* Returns all audit definitions with current config, threshold schema, and latest run info.
|
|
630
710
|
*
|
|
631
711
|
* **Permissions:** `ADD_MEDIA`
|
|
632
712
|
*
|
|
633
713
|
*/
|
|
634
|
-
export declare const
|
|
714
|
+
export declare const listAdminMediaAudits: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditsResponses, ListAdminMediaAuditsErrors, ThrowOnError, "fields">;
|
|
635
715
|
/**
|
|
636
|
-
*
|
|
716
|
+
* Update a media audit config
|
|
637
717
|
*
|
|
638
|
-
*
|
|
718
|
+
* Updates the threshold values or enabled status of an audit.
|
|
639
719
|
*
|
|
640
720
|
* **Permissions:** `ADD_MEDIA`
|
|
641
721
|
*
|
|
642
722
|
*/
|
|
643
|
-
export declare const
|
|
723
|
+
export declare const updateAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminMediaAuditResponses, UpdateAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
644
724
|
/**
|
|
645
|
-
*
|
|
725
|
+
* Run a media audit
|
|
646
726
|
*
|
|
647
|
-
*
|
|
727
|
+
* Triggers all enabled audits (or a specific one). Creates MediaAuditRun records and AUTO reports for any findings.
|
|
648
728
|
*
|
|
649
729
|
* **Permissions:** `ADD_MEDIA`
|
|
650
730
|
*
|
|
651
731
|
*/
|
|
652
|
-
export declare const
|
|
732
|
+
export declare const runAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<RunAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<RunAdminMediaAuditResponses, RunAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
653
733
|
/**
|
|
654
|
-
*
|
|
734
|
+
* List past audit runs
|
|
655
735
|
*
|
|
656
|
-
*
|
|
736
|
+
* Returns past media audit runs with summary stats. Supports filtering by audit name and cursor pagination.
|
|
657
737
|
*
|
|
658
738
|
* **Permissions:** `ADD_MEDIA`
|
|
659
739
|
*
|
|
660
740
|
*/
|
|
661
|
-
export declare const
|
|
741
|
+
export declare const listAdminMediaAuditRuns: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditRunsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditRunsResponses, ListAdminMediaAuditRunsErrors, ThrowOnError, "fields">;
|
|
662
742
|
/**
|
|
663
|
-
*
|
|
743
|
+
* Get a specific audit run's details
|
|
664
744
|
*
|
|
665
|
-
*
|
|
745
|
+
* Returns a specific media audit run record with its linked reports.
|
|
666
746
|
*
|
|
667
747
|
* **Permissions:** `ADD_MEDIA`
|
|
668
748
|
*
|
|
669
749
|
*/
|
|
670
|
-
export declare const
|
|
750
|
+
export declare const getAdminMediaAuditRun: <ThrowOnError extends boolean = false>(options: Options<GetAdminMediaAuditRunData, ThrowOnError>) => import("./client").RequestResult<GetAdminMediaAuditRunResponses, GetAdminMediaAuditRunErrors, ThrowOnError, "fields">;
|
|
671
751
|
//# sourceMappingURL=sdk.gen.d.ts.map
|