@brigadasos/nadeshiko-sdk 2.0.0 → 2.0.1-dev.7bb457a
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/client.gen.d.ts.map +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/index.cjs +823 -66
- package/dist/index.cjs.map +5 -5
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +834 -62
- package/dist/index.js.map +5 -5
- package/dist/internal/admin.gen.d.ts +2 -0
- package/dist/internal/admin.gen.d.ts.map +1 -0
- package/dist/internal/collections.gen.d.ts +2 -0
- package/dist/internal/collections.gen.d.ts.map +1 -0
- package/dist/internal/media.gen.d.ts +2 -0
- package/dist/internal/media.gen.d.ts.map +1 -0
- package/dist/internal/user.gen.d.ts +2 -0
- package/dist/internal/user.gen.d.ts.map +1 -0
- package/dist/internal.gen.d.ts +5 -0
- package/dist/internal.gen.d.ts.map +1 -0
- package/dist/nadeshiko.gen.d.ts +1201 -25
- package/dist/nadeshiko.gen.d.ts.map +1 -1
- package/dist/paginate.d.ts.map +1 -1
- package/dist/retry.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +26 -180
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +114 -114
- package/dist/types.gen.d.ts.map +1 -1
- package/package.json +4 -3
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -35,8 +35,6 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
35
35
|
* | **Kana** (`たべる`, `かのじょ`) | Standard search across content, base form, and reading form |
|
|
36
36
|
* | **English/Spanish** | Direct translation search |
|
|
37
37
|
*
|
|
38
|
-
* **Permissions:** `READ_MEDIA`
|
|
39
|
-
*
|
|
40
38
|
*/
|
|
41
39
|
export declare const search: <ThrowOnError extends boolean = false>(options?: Options<SearchData, ThrowOnError>) => import("./client").RequestResult<SearchResponses, SearchErrors, ThrowOnError, "fields">;
|
|
42
40
|
/**
|
|
@@ -50,8 +48,6 @@ export declare const search: <ThrowOnError extends boolean = false>(options?: Op
|
|
|
50
48
|
*
|
|
51
49
|
* The stats are scoped by query and category filters, but are not narrowed by a selected media/episode.
|
|
52
50
|
*
|
|
53
|
-
* **Permissions:** `READ_MEDIA`
|
|
54
|
-
*
|
|
55
51
|
*/
|
|
56
52
|
export declare const getSearchStats: <ThrowOnError extends boolean = false>(options?: Options<GetSearchStatsData, ThrowOnError>) => import("./client").RequestResult<GetSearchStatsResponses, GetSearchStatsErrors, ThrowOnError, "fields">;
|
|
57
53
|
/**
|
|
@@ -61,13 +57,6 @@ export declare const getSearchStats: <ThrowOnError extends boolean = false>(opti
|
|
|
61
57
|
*
|
|
62
58
|
* Unlike the main search endpoint, this returns a summary of matches per media rather than individual segments.
|
|
63
59
|
*
|
|
64
|
-
* **Use Cases**
|
|
65
|
-
* - Vocabulary discovery across media library
|
|
66
|
-
* - Finding anime/dramas that use specific words
|
|
67
|
-
* - Comparing word usage across different titles
|
|
68
|
-
*
|
|
69
|
-
* **Permissions:** `READ_MEDIA`
|
|
70
|
-
*
|
|
71
60
|
*/
|
|
72
61
|
export declare const searchWords: <ThrowOnError extends boolean = false>(options: Options<SearchWordsData, ThrowOnError>) => import("./client").RequestResult<SearchWordsResponses, SearchWordsErrors, ThrowOnError, "fields">;
|
|
73
62
|
/**
|
|
@@ -76,17 +65,13 @@ export declare const searchWords: <ThrowOnError extends boolean = false>(options
|
|
|
76
65
|
* Returns a paginated list of media with full metadata, including cover/banner images, episode counts, and genres.
|
|
77
66
|
* Supports filtering by category and text search.
|
|
78
67
|
*
|
|
79
|
-
* **Permissions:** `READ_MEDIA`
|
|
80
|
-
*
|
|
81
68
|
*/
|
|
82
69
|
export declare const listMedia: <ThrowOnError extends boolean = false>(options?: Options<ListMediaData, ThrowOnError>) => import("./client").RequestResult<ListMediaResponses, ListMediaErrors, ThrowOnError, "fields">;
|
|
83
70
|
/**
|
|
84
|
-
* Create
|
|
71
|
+
* Create media
|
|
85
72
|
*
|
|
86
73
|
* Creates a new media entry in the database.
|
|
87
74
|
*
|
|
88
|
-
* **Permissions:** `ADD_MEDIA`
|
|
89
|
-
*
|
|
90
75
|
*/
|
|
91
76
|
export declare const createMedia: <ThrowOnError extends boolean = false>(options: Options<CreateMediaData, ThrowOnError>) => import("./client").RequestResult<CreateMediaResponses, CreateMediaErrors, ThrowOnError, "fields">;
|
|
92
77
|
/**
|
|
@@ -96,28 +81,21 @@ export declare const createMedia: <ThrowOnError extends boolean = false>(options
|
|
|
96
81
|
* Results are ranked by exact match, then prefix match, then contains match,
|
|
97
82
|
* and further sorted by name length.
|
|
98
83
|
*
|
|
99
|
-
* **Permissions:** `READ_MEDIA`
|
|
100
|
-
*
|
|
101
84
|
*/
|
|
102
85
|
export declare const autocompleteMedia: <ThrowOnError extends boolean = false>(options: Options<AutocompleteMediaData, ThrowOnError>) => import("./client").RequestResult<AutocompleteMediaResponses, AutocompleteMediaErrors, ThrowOnError, "fields">;
|
|
103
86
|
/**
|
|
104
|
-
* Get segment by
|
|
87
|
+
* Get segment by publicId
|
|
105
88
|
*
|
|
106
|
-
* Returns a specific segment by its
|
|
89
|
+
* Returns a specific segment by its publicId. A shortcut alternative to the nested `/media/{mediaId}/episodes/{episodeNumber}/segments/{id}` path.
|
|
107
90
|
*
|
|
108
91
|
* Pass `include[]=ratingAnalysis` and/or `include[]=posAnalysis` to receive raw analysis fields alongside the standard segment data.
|
|
109
92
|
*
|
|
110
|
-
* **Permissions:** `UPDATE_MEDIA` (API key) or admin session
|
|
111
|
-
*
|
|
112
93
|
*/
|
|
113
94
|
export declare const getSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<GetSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<GetSegmentByUuidResponses, GetSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
114
95
|
/**
|
|
115
|
-
* Update segment by
|
|
116
|
-
*
|
|
117
|
-
* Updates an existing segment identified by its UUID or publicId. Performs the lookup internally,
|
|
118
|
-
* then applies the update. Only provided fields will be updated.
|
|
96
|
+
* Update segment by publicId
|
|
119
97
|
*
|
|
120
|
-
*
|
|
98
|
+
* Updates an existing segment identified by its publicId. Only provided fields will be updated.
|
|
121
99
|
*
|
|
122
100
|
*/
|
|
123
101
|
export declare const updateSegmentByUuid: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentByUuidData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentByUuidResponses, UpdateSegmentByUuidErrors, ThrowOnError, "fields">;
|
|
@@ -127,16 +105,12 @@ export declare const updateSegmentByUuid: <ThrowOnError extends boolean = false>
|
|
|
127
105
|
* Retrieves segments surrounding a specific segment within an episode.
|
|
128
106
|
* Returns segments both before and after the target, providing dialogue context for how a sentence is used.
|
|
129
107
|
*
|
|
130
|
-
* **Permissions:** `UPDATE_MEDIA` (API key) or admin session
|
|
131
|
-
*
|
|
132
108
|
*/
|
|
133
109
|
export declare const getSegmentContext: <ThrowOnError extends boolean = false>(options: Options<GetSegmentContextData, ThrowOnError>) => import("./client").RequestResult<GetSegmentContextResponses, GetSegmentContextErrors, ThrowOnError, "fields">;
|
|
134
110
|
/**
|
|
135
111
|
* List segment revision history
|
|
136
112
|
*
|
|
137
|
-
* Returns the revision history for a segment
|
|
138
|
-
*
|
|
139
|
-
* **Permissions:** `UPDATE_MEDIA` (API key) or admin session
|
|
113
|
+
* Returns the revision history for a segment, ordered by most recent first.
|
|
140
114
|
*
|
|
141
115
|
*/
|
|
142
116
|
export declare const listSegmentRevisions: <ThrowOnError extends boolean = false>(options: Options<ListSegmentRevisionsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentRevisionsResponses, ListSegmentRevisionsErrors, ThrowOnError, "fields">;
|
|
@@ -145,8 +119,6 @@ export declare const listSegmentRevisions: <ThrowOnError extends boolean = false
|
|
|
145
119
|
*
|
|
146
120
|
* Returns a paginated list of media series groupings.
|
|
147
121
|
*
|
|
148
|
-
* **Permissions:** `READ_MEDIA`
|
|
149
|
-
*
|
|
150
122
|
*/
|
|
151
123
|
export declare const listSeries: <ThrowOnError extends boolean = false>(options?: Options<ListSeriesData, ThrowOnError>) => import("./client").RequestResult<ListSeriesResponses, ListSeriesErrors, ThrowOnError, "fields">;
|
|
152
124
|
/**
|
|
@@ -154,8 +126,6 @@ export declare const listSeries: <ThrowOnError extends boolean = false>(options?
|
|
|
154
126
|
*
|
|
155
127
|
* Creates a new media series grouping.
|
|
156
128
|
*
|
|
157
|
-
* **Permissions:** `ADD_MEDIA`
|
|
158
|
-
*
|
|
159
129
|
*/
|
|
160
130
|
export declare const createSeries: <ThrowOnError extends boolean = false>(options: Options<CreateSeriesData, ThrowOnError>) => import("./client").RequestResult<CreateSeriesResponses, CreateSeriesErrors, ThrowOnError, "fields">;
|
|
161
131
|
/**
|
|
@@ -163,8 +133,6 @@ export declare const createSeries: <ThrowOnError extends boolean = false>(option
|
|
|
163
133
|
*
|
|
164
134
|
* Deletes a series and all its media associations.
|
|
165
135
|
*
|
|
166
|
-
* **Permissions:** `REMOVE_MEDIA`
|
|
167
|
-
*
|
|
168
136
|
*/
|
|
169
137
|
export declare const deleteSeries: <ThrowOnError extends boolean = false>(options: Options<DeleteSeriesData, ThrowOnError>) => import("./client").RequestResult<DeleteSeriesResponses, DeleteSeriesErrors, ThrowOnError, "fields">;
|
|
170
138
|
/**
|
|
@@ -172,8 +140,6 @@ export declare const deleteSeries: <ThrowOnError extends boolean = false>(option
|
|
|
172
140
|
*
|
|
173
141
|
* Returns a series with all media entries sorted by position.
|
|
174
142
|
*
|
|
175
|
-
* **Permissions:** `READ_MEDIA`
|
|
176
|
-
*
|
|
177
143
|
*/
|
|
178
144
|
export declare const getSeries: <ThrowOnError extends boolean = false>(options: Options<GetSeriesData, ThrowOnError>) => import("./client").RequestResult<GetSeriesResponses, GetSeriesErrors, ThrowOnError, "fields">;
|
|
179
145
|
/**
|
|
@@ -181,8 +147,6 @@ export declare const getSeries: <ThrowOnError extends boolean = false>(options:
|
|
|
181
147
|
*
|
|
182
148
|
* Updates series localized names.
|
|
183
149
|
*
|
|
184
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
185
|
-
*
|
|
186
150
|
*/
|
|
187
151
|
export declare const updateSeries: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesResponses, UpdateSeriesErrors, ThrowOnError, "fields">;
|
|
188
152
|
/**
|
|
@@ -190,8 +154,6 @@ export declare const updateSeries: <ThrowOnError extends boolean = false>(option
|
|
|
190
154
|
*
|
|
191
155
|
* Adds a media entry to a series at a specific position.
|
|
192
156
|
*
|
|
193
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
194
|
-
*
|
|
195
157
|
*/
|
|
196
158
|
export declare const addMediaToSeries: <ThrowOnError extends boolean = false>(options: Options<AddMediaToSeriesData, ThrowOnError>) => import("./client").RequestResult<AddMediaToSeriesResponses, AddMediaToSeriesErrors, ThrowOnError, "fields">;
|
|
197
159
|
/**
|
|
@@ -199,8 +161,6 @@ export declare const addMediaToSeries: <ThrowOnError extends boolean = false>(op
|
|
|
199
161
|
*
|
|
200
162
|
* Removes a media entry from a series.
|
|
201
163
|
*
|
|
202
|
-
* **Permissions:** `REMOVE_MEDIA`
|
|
203
|
-
*
|
|
204
164
|
*/
|
|
205
165
|
export declare const removeMediaFromSeries: <ThrowOnError extends boolean = false>(options: Options<RemoveMediaFromSeriesData, ThrowOnError>) => import("./client").RequestResult<RemoveMediaFromSeriesResponses, RemoveMediaFromSeriesErrors, ThrowOnError, "fields">;
|
|
206
166
|
/**
|
|
@@ -208,8 +168,6 @@ export declare const removeMediaFromSeries: <ThrowOnError extends boolean = fals
|
|
|
208
168
|
*
|
|
209
169
|
* Updates the position of a media entry in a series.
|
|
210
170
|
*
|
|
211
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
212
|
-
*
|
|
213
171
|
*/
|
|
214
172
|
export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateSeriesMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateSeriesMediaResponses, UpdateSeriesMediaErrors, ThrowOnError, "fields">;
|
|
215
173
|
/**
|
|
@@ -217,8 +175,6 @@ export declare const updateSeriesMedia: <ThrowOnError extends boolean = false>(o
|
|
|
217
175
|
*
|
|
218
176
|
* Returns a character with their voice actors (seiyuu) and all media appearances.
|
|
219
177
|
*
|
|
220
|
-
* **Permissions:** `READ_MEDIA`
|
|
221
|
-
*
|
|
222
178
|
*/
|
|
223
179
|
export declare const getCharacter: <ThrowOnError extends boolean = false>(options: Options<GetCharacterData, ThrowOnError>) => import("./client").RequestResult<GetCharacterResponses, GetCharacterErrors, ThrowOnError, "fields">;
|
|
224
180
|
/**
|
|
@@ -226,17 +182,13 @@ export declare const getCharacter: <ThrowOnError extends boolean = false>(option
|
|
|
226
182
|
*
|
|
227
183
|
* Returns a voice actor (seiyuu) with all characters they voiced and their media appearances.
|
|
228
184
|
*
|
|
229
|
-
* **Permissions:** `READ_MEDIA`
|
|
230
|
-
*
|
|
231
185
|
*/
|
|
232
186
|
export declare const getSeiyuu: <ThrowOnError extends boolean = false>(options: Options<GetSeiyuuData, ThrowOnError>) => import("./client").RequestResult<GetSeiyuuResponses, GetSeiyuuErrors, ThrowOnError, "fields">;
|
|
233
187
|
/**
|
|
234
|
-
* Delete media
|
|
188
|
+
* Delete media
|
|
235
189
|
*
|
|
236
190
|
* Soft-deletes a media entry by setting the `deletedAt` timestamp. The media remains in the database but is excluded from query results.
|
|
237
191
|
*
|
|
238
|
-
* **Permissions:** `REMOVE_MEDIA`
|
|
239
|
-
*
|
|
240
192
|
*/
|
|
241
193
|
export declare const deleteMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaResponses, DeleteMediaErrors, ThrowOnError, "fields">;
|
|
242
194
|
/**
|
|
@@ -244,8 +196,6 @@ export declare const deleteMedia: <ThrowOnError extends boolean = false>(options
|
|
|
244
196
|
*
|
|
245
197
|
* Returns a single media entry by its ID with full metadata.
|
|
246
198
|
*
|
|
247
|
-
* **Permissions:** `READ_MEDIA`
|
|
248
|
-
*
|
|
249
199
|
*/
|
|
250
200
|
export declare const getMedia: <ThrowOnError extends boolean = false>(options: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, GetMediaErrors, ThrowOnError, "fields">;
|
|
251
201
|
/**
|
|
@@ -253,8 +203,6 @@ export declare const getMedia: <ThrowOnError extends boolean = false>(options: O
|
|
|
253
203
|
*
|
|
254
204
|
* Updates an existing media entry. Only provided fields will be updated.
|
|
255
205
|
*
|
|
256
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
257
|
-
*
|
|
258
206
|
*/
|
|
259
207
|
export declare const updateMedia: <ThrowOnError extends boolean = false>(options: Options<UpdateMediaData, ThrowOnError>) => import("./client").RequestResult<UpdateMediaResponses, UpdateMediaErrors, ThrowOnError, "fields">;
|
|
260
208
|
/**
|
|
@@ -262,26 +210,20 @@ export declare const updateMedia: <ThrowOnError extends boolean = false>(options
|
|
|
262
210
|
*
|
|
263
211
|
* Returns a paginated list of episodes for a specific media.
|
|
264
212
|
*
|
|
265
|
-
* **Permissions:** `READ_MEDIA`
|
|
266
|
-
*
|
|
267
213
|
*/
|
|
268
214
|
export declare const listEpisodes: <ThrowOnError extends boolean = false>(options: Options<ListEpisodesData, ThrowOnError>) => import("./client").RequestResult<ListEpisodesResponses, ListEpisodesErrors, ThrowOnError, "fields">;
|
|
269
215
|
/**
|
|
270
|
-
* Create
|
|
216
|
+
* Create episode
|
|
271
217
|
*
|
|
272
218
|
* Creates a new episode for a specific media.
|
|
273
219
|
*
|
|
274
|
-
* **Permissions:** `ADD_MEDIA`
|
|
275
|
-
*
|
|
276
220
|
*/
|
|
277
221
|
export declare const createEpisode: <ThrowOnError extends boolean = false>(options: Options<CreateEpisodeData, ThrowOnError>) => import("./client").RequestResult<CreateEpisodeResponses, CreateEpisodeErrors, ThrowOnError, "fields">;
|
|
278
222
|
/**
|
|
279
|
-
* Delete
|
|
223
|
+
* Delete episode
|
|
280
224
|
*
|
|
281
225
|
* Soft-deletes an episode. Segments are not cascade deleted — this only hides the episode from results.
|
|
282
226
|
*
|
|
283
|
-
* **Permissions:** `REMOVE_MEDIA`
|
|
284
|
-
*
|
|
285
227
|
*/
|
|
286
228
|
export declare const deleteEpisode: <ThrowOnError extends boolean = false>(options: Options<DeleteEpisodeData, ThrowOnError>) => import("./client").RequestResult<DeleteEpisodeResponses, DeleteEpisodeErrors, ThrowOnError, "fields">;
|
|
287
229
|
/**
|
|
@@ -289,8 +231,6 @@ export declare const deleteEpisode: <ThrowOnError extends boolean = false>(optio
|
|
|
289
231
|
*
|
|
290
232
|
* Returns a specific episode by media ID and episode number.
|
|
291
233
|
*
|
|
292
|
-
* **Permissions:** `READ_MEDIA`
|
|
293
|
-
*
|
|
294
234
|
*/
|
|
295
235
|
export declare const getEpisode: <ThrowOnError extends boolean = false>(options: Options<GetEpisodeData, ThrowOnError>) => import("./client").RequestResult<GetEpisodeResponses, GetEpisodeErrors, ThrowOnError, "fields">;
|
|
296
236
|
/**
|
|
@@ -298,8 +238,6 @@ export declare const getEpisode: <ThrowOnError extends boolean = false>(options:
|
|
|
298
238
|
*
|
|
299
239
|
* Updates an existing episode. Only provided fields will be updated.
|
|
300
240
|
*
|
|
301
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
302
|
-
*
|
|
303
241
|
*/
|
|
304
242
|
export declare const updateEpisode: <ThrowOnError extends boolean = false>(options: Options<UpdateEpisodeData, ThrowOnError>) => import("./client").RequestResult<UpdateEpisodeResponses, UpdateEpisodeErrors, ThrowOnError, "fields">;
|
|
305
243
|
/**
|
|
@@ -307,27 +245,21 @@ export declare const updateEpisode: <ThrowOnError extends boolean = false>(optio
|
|
|
307
245
|
*
|
|
308
246
|
* Returns a paginated list of segments for a specific episode.
|
|
309
247
|
*
|
|
310
|
-
* **Permissions:** `READ_MEDIA`
|
|
311
|
-
*
|
|
312
248
|
*/
|
|
313
249
|
export declare const listSegments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentsData, ThrowOnError>) => import("./client").RequestResult<ListSegmentsResponses, ListSegmentsErrors, ThrowOnError, "fields">;
|
|
314
250
|
/**
|
|
315
|
-
* Create
|
|
251
|
+
* Create segment
|
|
316
252
|
*
|
|
317
253
|
* Creates a new segment for a specific episode.
|
|
318
254
|
*
|
|
319
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
320
|
-
*
|
|
321
255
|
*/
|
|
322
256
|
export declare const createSegment: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentResponses, CreateSegmentErrors, ThrowOnError, "fields">;
|
|
323
257
|
/**
|
|
324
|
-
* Batch create segments
|
|
258
|
+
* Batch create segments
|
|
325
259
|
*
|
|
326
260
|
* Creates multiple segments for a specific episode in a single request.
|
|
327
261
|
* Duplicate UUIDs are silently skipped.
|
|
328
262
|
*
|
|
329
|
-
* **Permissions:** `ADD_MEDIA`
|
|
330
|
-
*
|
|
331
263
|
*/
|
|
332
264
|
export declare const createSegmentsBatch: <ThrowOnError extends boolean = false>(options: Options<CreateSegmentsBatchData, ThrowOnError>) => import("./client").RequestResult<CreateSegmentsBatchResponses, CreateSegmentsBatchErrors, ThrowOnError, "fields">;
|
|
333
265
|
/**
|
|
@@ -335,8 +267,6 @@ export declare const createSegmentsBatch: <ThrowOnError extends boolean = false>
|
|
|
335
267
|
*
|
|
336
268
|
* Soft-deletes a segment by setting its status to DELETED.
|
|
337
269
|
*
|
|
338
|
-
* **Permissions:** `REMOVE_MEDIA`
|
|
339
|
-
*
|
|
340
270
|
*/
|
|
341
271
|
export declare const deleteSegment: <ThrowOnError extends boolean = false>(options: Options<DeleteSegmentData, ThrowOnError>) => import("./client").RequestResult<DeleteSegmentResponses, DeleteSegmentErrors, ThrowOnError, "fields">;
|
|
342
272
|
/**
|
|
@@ -344,8 +274,6 @@ export declare const deleteSegment: <ThrowOnError extends boolean = false>(optio
|
|
|
344
274
|
*
|
|
345
275
|
* Returns a specific segment by its ID within the media/episode hierarchy.
|
|
346
276
|
*
|
|
347
|
-
* **Permissions:** `READ_MEDIA`
|
|
348
|
-
*
|
|
349
277
|
*/
|
|
350
278
|
export declare const getSegment: <ThrowOnError extends boolean = false>(options: Options<GetSegmentData, ThrowOnError>) => import("./client").RequestResult<GetSegmentResponses, GetSegmentErrors, ThrowOnError, "fields">;
|
|
351
279
|
/**
|
|
@@ -353,8 +281,6 @@ export declare const getSegment: <ThrowOnError extends boolean = false>(options:
|
|
|
353
281
|
*
|
|
354
282
|
* Updates an existing segment. Only provided fields will be updated.
|
|
355
283
|
*
|
|
356
|
-
* **Permissions:** `UPDATE_MEDIA`
|
|
357
|
-
*
|
|
358
284
|
*/
|
|
359
285
|
export declare const updateSegment: <ThrowOnError extends boolean = false>(options: Options<UpdateSegmentData, ThrowOnError>) => import("./client").RequestResult<UpdateSegmentResponses, UpdateSegmentErrors, ThrowOnError, "fields">;
|
|
360
286
|
/**
|
|
@@ -362,16 +288,12 @@ export declare const updateSegment: <ThrowOnError extends boolean = false>(optio
|
|
|
362
288
|
*
|
|
363
289
|
* Returns the API quota usage for the current billing period.
|
|
364
290
|
*
|
|
365
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
366
|
-
*
|
|
367
291
|
*/
|
|
368
292
|
export declare const getUserQuota: <ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError, "fields">;
|
|
369
293
|
/**
|
|
370
|
-
* Create
|
|
371
|
-
*
|
|
372
|
-
* Submit a report for a segment or media entry.
|
|
294
|
+
* Create report
|
|
373
295
|
*
|
|
374
|
-
*
|
|
296
|
+
* Submits a report for a segment or media entry.
|
|
375
297
|
*
|
|
376
298
|
*/
|
|
377
299
|
export declare const createUserReport: <ThrowOnError extends boolean = false>(options: Options<CreateUserReportData, ThrowOnError>) => import("./client").RequestResult<CreateUserReportResponses, CreateUserReportErrors, ThrowOnError, "fields">;
|
|
@@ -380,8 +302,6 @@ export declare const createUserReport: <ThrowOnError extends boolean = false>(op
|
|
|
380
302
|
*
|
|
381
303
|
* Returns the authenticated user's full preferences object.
|
|
382
304
|
*
|
|
383
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
384
|
-
*
|
|
385
305
|
*/
|
|
386
306
|
export declare const getUserPreferences: <ThrowOnError extends boolean = false>(options?: Options<GetUserPreferencesData, ThrowOnError>) => import("./client").RequestResult<GetUserPreferencesResponses, GetUserPreferencesErrors, ThrowOnError, "fields">;
|
|
387
307
|
/**
|
|
@@ -390,26 +310,20 @@ export declare const getUserPreferences: <ThrowOnError extends boolean = false>(
|
|
|
390
310
|
* Deep-merges a partial preferences update into the user's existing preferences.
|
|
391
311
|
* Only the provided keys are updated; all other keys are preserved.
|
|
392
312
|
*
|
|
393
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
394
|
-
*
|
|
395
313
|
*/
|
|
396
314
|
export declare const updateUserPreferences: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPreferencesData, ThrowOnError>) => import("./client").RequestResult<UpdateUserPreferencesResponses, UpdateUserPreferencesErrors, ThrowOnError, "fields">;
|
|
397
315
|
/**
|
|
398
|
-
* Clear user activity
|
|
316
|
+
* Clear user activity
|
|
399
317
|
*
|
|
400
318
|
* Deletes the authenticated user's activity history. Optionally filter by activity type.
|
|
401
319
|
*
|
|
402
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
403
|
-
*
|
|
404
320
|
*/
|
|
405
321
|
export declare const deleteUserActivity: <ThrowOnError extends boolean = false>(options?: Options<DeleteUserActivityData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityResponses, DeleteUserActivityErrors, ThrowOnError, "fields">;
|
|
406
322
|
/**
|
|
407
|
-
*
|
|
323
|
+
* List user activity
|
|
408
324
|
*
|
|
409
325
|
* Returns the authenticated user's activity history with cursor-based pagination.
|
|
410
326
|
*
|
|
411
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
412
|
-
*
|
|
413
327
|
*/
|
|
414
328
|
export declare const listUserActivity: <ThrowOnError extends boolean = false>(options?: Options<ListUserActivityData, ThrowOnError>) => import("./client").RequestResult<ListUserActivityResponses, ListUserActivityErrors, ThrowOnError, "fields">;
|
|
415
329
|
/**
|
|
@@ -417,8 +331,6 @@ export declare const listUserActivity: <ThrowOnError extends boolean = false>(op
|
|
|
417
331
|
*
|
|
418
332
|
* Records a user activity event (e.g. segment play). Fire-and-forget — always returns 204.
|
|
419
333
|
*
|
|
420
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
421
|
-
*
|
|
422
334
|
*/
|
|
423
335
|
export declare const trackUserActivity: <ThrowOnError extends boolean = false>(options: Options<TrackUserActivityData, ThrowOnError>) => import("./client").RequestResult<TrackUserActivityResponses, TrackUserActivityErrors, ThrowOnError, "fields">;
|
|
424
336
|
/**
|
|
@@ -427,8 +339,6 @@ export declare const trackUserActivity: <ThrowOnError extends boolean = false>(o
|
|
|
427
339
|
* Returns daily activity counts for the authenticated user, grouped by date and activity type.
|
|
428
340
|
* Each day contains per-type counts that can be summed or filtered client-side.
|
|
429
341
|
*
|
|
430
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
431
|
-
*
|
|
432
342
|
*/
|
|
433
343
|
export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityHeatmapData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityHeatmapResponses, GetUserActivityHeatmapErrors, ThrowOnError, "fields">;
|
|
434
344
|
/**
|
|
@@ -437,8 +347,6 @@ export declare const getUserActivityHeatmap: <ThrowOnError extends boolean = fal
|
|
|
437
347
|
* Returns aggregate statistics about the authenticated user's activity:
|
|
438
348
|
* total searches, exports, plays, and top media.
|
|
439
349
|
*
|
|
440
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
441
|
-
*
|
|
442
350
|
*/
|
|
443
351
|
export declare const getUserActivityStats: <ThrowOnError extends boolean = false>(options?: Options<GetUserActivityStatsData, ThrowOnError>) => import("./client").RequestResult<GetUserActivityStatsResponses, GetUserActivityStatsErrors, ThrowOnError, "fields">;
|
|
444
352
|
/**
|
|
@@ -446,17 +354,13 @@ export declare const getUserActivityStats: <ThrowOnError extends boolean = false
|
|
|
446
354
|
*
|
|
447
355
|
* Deletes all activity records for the authenticated user on the given date.
|
|
448
356
|
*
|
|
449
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
450
|
-
*
|
|
451
357
|
*/
|
|
452
358
|
export declare const deleteUserActivityByDate: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByDateData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByDateResponses, DeleteUserActivityByDateErrors, ThrowOnError, "fields">;
|
|
453
359
|
/**
|
|
454
|
-
* Delete
|
|
360
|
+
* Delete activity record
|
|
455
361
|
*
|
|
456
362
|
* Deletes a single activity record by ID for the authenticated user.
|
|
457
363
|
*
|
|
458
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
459
|
-
*
|
|
460
364
|
*/
|
|
461
365
|
export declare const deleteUserActivityById: <ThrowOnError extends boolean = false>(options: Options<DeleteUserActivityByIdData, ThrowOnError>) => import("./client").RequestResult<DeleteUserActivityByIdResponses, DeleteUserActivityByIdErrors, ThrowOnError, "fields">;
|
|
462
366
|
/**
|
|
@@ -465,8 +369,6 @@ export declare const deleteUserActivityById: <ThrowOnError extends boolean = fal
|
|
|
465
369
|
* Returns a full JSON export of all user-related data for GDPR data portability.
|
|
466
370
|
* Includes profile, preferences, activity history, collections, and reports.
|
|
467
371
|
*
|
|
468
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
469
|
-
*
|
|
470
372
|
*/
|
|
471
373
|
export declare const exportUserData: <ThrowOnError extends boolean = false>(options?: Options<ExportUserDataData, ThrowOnError>) => import("./client").RequestResult<ExportUserDataResponses, ExportUserDataErrors, ThrowOnError, "fields">;
|
|
472
374
|
/**
|
|
@@ -476,8 +378,6 @@ export declare const exportUserData: <ThrowOnError extends boolean = false>(opti
|
|
|
476
378
|
* opt-in status. Features gated by role are excluded if the user lacks
|
|
477
379
|
* the required role.
|
|
478
380
|
*
|
|
479
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
480
|
-
*
|
|
481
381
|
*/
|
|
482
382
|
export declare const listUserLabs: <ThrowOnError extends boolean = false>(options?: Options<ListUserLabsData, ThrowOnError>) => import("./client").RequestResult<ListUserLabsResponses, ListUserLabsErrors, ThrowOnError, "fields">;
|
|
483
383
|
/**
|
|
@@ -485,8 +385,6 @@ export declare const listUserLabs: <ThrowOnError extends boolean = false>(option
|
|
|
485
385
|
*
|
|
486
386
|
* Opts the authenticated user out of a lab feature.
|
|
487
387
|
*
|
|
488
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
489
|
-
*
|
|
490
388
|
*/
|
|
491
389
|
export declare const unenrollUserLab: <ThrowOnError extends boolean = false>(options: Options<UnenrollUserLabData, ThrowOnError>) => import("./client").RequestResult<UnenrollUserLabResponses, UnenrollUserLabErrors, ThrowOnError, "fields">;
|
|
492
390
|
/**
|
|
@@ -495,8 +393,6 @@ export declare const unenrollUserLab: <ThrowOnError extends boolean = false>(opt
|
|
|
495
393
|
* Opts the authenticated user into a lab feature. The user must be eligible
|
|
496
394
|
* for the lab (correct role, in allowlist or rollout percentage).
|
|
497
395
|
*
|
|
498
|
-
* **Permissions:** Session authentication (cookie-based).
|
|
499
|
-
*
|
|
500
396
|
*/
|
|
501
397
|
export declare const enrollUserLab: <ThrowOnError extends boolean = false>(options: Options<EnrollUserLabData, ThrowOnError>) => import("./client").RequestResult<EnrollUserLabResponses, EnrollUserLabErrors, ThrowOnError, "fields">;
|
|
502
398
|
/**
|
|
@@ -572,27 +468,23 @@ export declare const searchCollectionSegments: <ThrowOnError extends boolean = f
|
|
|
572
468
|
*/
|
|
573
469
|
export declare const getCollectionStats: <ThrowOnError extends boolean = false>(options: Options<GetCollectionStatsData, ThrowOnError>) => import("./client").RequestResult<GetCollectionStatsResponses, GetCollectionStatsErrors, ThrowOnError, "fields">;
|
|
574
470
|
/**
|
|
575
|
-
*
|
|
471
|
+
* Get dashboard statistics
|
|
576
472
|
*
|
|
577
473
|
* Returns at-a-glance statistics for the admin dashboard including media counts,
|
|
578
474
|
* user counts, and system health information.
|
|
579
475
|
*
|
|
580
|
-
* **Permissions:** `ADD_MEDIA`
|
|
581
|
-
*
|
|
582
476
|
*/
|
|
583
477
|
export declare const getAdminDashboard: <ThrowOnError extends boolean = false>(options?: Options<GetAdminDashboardData, ThrowOnError>) => import("./client").RequestResult<GetAdminDashboardResponses, GetAdminDashboardErrors, ThrowOnError, "fields">;
|
|
584
478
|
/**
|
|
585
|
-
*
|
|
479
|
+
* Check system health
|
|
586
480
|
*
|
|
587
481
|
* Returns connectivity status and version information for all backend subsystems
|
|
588
482
|
* (Elasticsearch, PostgreSQL, application).
|
|
589
483
|
*
|
|
590
|
-
* **Permissions:** `ADD_MEDIA`
|
|
591
|
-
*
|
|
592
484
|
*/
|
|
593
485
|
export declare const getAdminHealth: <ThrowOnError extends boolean = false>(options?: Options<GetAdminHealthData, ThrowOnError>) => import("./client").RequestResult<GetAdminHealthResponses, GetAdminHealthErrors, ThrowOnError, "fields">;
|
|
594
486
|
/**
|
|
595
|
-
* Reindex
|
|
487
|
+
* Reindex segments into Elasticsearch
|
|
596
488
|
*
|
|
597
489
|
* Reindexes segments from the PostgreSQL database into Elasticsearch.
|
|
598
490
|
* Allows filtering by specific media entries and episodes.
|
|
@@ -602,8 +494,6 @@ export declare const getAdminHealth: <ThrowOnError extends boolean = false>(opti
|
|
|
602
494
|
* - If `media` is provided, reindexes segments from those media entries
|
|
603
495
|
* - If a media item includes `episodes`, only those episodes are reindexed for that media
|
|
604
496
|
*
|
|
605
|
-
* **Permissions:** `ADD_MEDIA`
|
|
606
|
-
*
|
|
607
497
|
*/
|
|
608
498
|
export declare const triggerReindex: <ThrowOnError extends boolean = false>(options?: Options<TriggerReindexData, ThrowOnError>) => import("./client").RequestResult<TriggerReindexResponses, TriggerReindexErrors, ThrowOnError, "fields">;
|
|
609
499
|
/**
|
|
@@ -611,13 +501,6 @@ export declare const triggerReindex: <ThrowOnError extends boolean = false>(opti
|
|
|
611
501
|
*
|
|
612
502
|
* Returns statistics for all ES sync queues including pending and failed job counts.
|
|
613
503
|
*
|
|
614
|
-
* **Use cases:**
|
|
615
|
-
* - Monitor queue health
|
|
616
|
-
* - Detect stuck jobs
|
|
617
|
-
* - Check backlog size
|
|
618
|
-
*
|
|
619
|
-
* **Permissions:** `ADD_MEDIA`
|
|
620
|
-
*
|
|
621
504
|
*/
|
|
622
505
|
export declare const listAdminQueueStats: <ThrowOnError extends boolean = false>(options?: Options<ListAdminQueueStatsData, ThrowOnError>) => import("./client").RequestResult<ListAdminQueueStatsResponses, ListAdminQueueStatsErrors, ThrowOnError, "fields">;
|
|
623
506
|
/**
|
|
@@ -630,8 +513,6 @@ export declare const listAdminQueueStats: <ThrowOnError extends boolean = false>
|
|
|
630
513
|
* - `es-sync-update` - Jobs to update existing segments
|
|
631
514
|
* - `es-sync-delete` - Jobs to delete segments
|
|
632
515
|
*
|
|
633
|
-
* **Permissions:** `ADD_MEDIA`
|
|
634
|
-
*
|
|
635
516
|
*/
|
|
636
517
|
export declare const getAdminQueue: <ThrowOnError extends boolean = false>(options: Options<GetAdminQueueData, ThrowOnError>) => import("./client").RequestResult<GetAdminQueueResponses, GetAdminQueueErrors, ThrowOnError, "fields">;
|
|
637
518
|
/**
|
|
@@ -639,13 +520,6 @@ export declare const getAdminQueue: <ThrowOnError extends boolean = false>(optio
|
|
|
639
520
|
*
|
|
640
521
|
* Returns jobs that have exceeded their retry limit and permanently failed.
|
|
641
522
|
*
|
|
642
|
-
* **Use cases:**
|
|
643
|
-
* - Identify segments that failed to sync to Elasticsearch
|
|
644
|
-
* - Debug persistent sync issues
|
|
645
|
-
* - Decide whether to retry or purge failed jobs
|
|
646
|
-
*
|
|
647
|
-
* **Permissions:** `ADD_MEDIA`
|
|
648
|
-
*
|
|
649
523
|
*/
|
|
650
524
|
export declare const listAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<ListAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<ListAdminQueueFailedResponses, ListAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
651
525
|
/**
|
|
@@ -653,25 +527,13 @@ export declare const listAdminQueueFailed: <ThrowOnError extends boolean = false
|
|
|
653
527
|
*
|
|
654
528
|
* Re-enqueues all failed jobs from a specific queue for another attempt.
|
|
655
529
|
*
|
|
656
|
-
* **Use cases:**
|
|
657
|
-
* - Retry jobs that failed due to temporary Elasticsearch issues
|
|
658
|
-
* - Recover from network blips
|
|
659
|
-
*
|
|
660
|
-
* **Permissions:** `ADD_MEDIA`
|
|
661
|
-
*
|
|
662
530
|
*/
|
|
663
531
|
export declare const retryAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<RetryAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<RetryAdminQueueFailedResponses, RetryAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
664
532
|
/**
|
|
665
533
|
* Purge failed jobs from a queue
|
|
666
534
|
*
|
|
667
535
|
* Permanently deletes all failed jobs from a queue.
|
|
668
|
-
* This does **not** re-sync the affected segments
|
|
669
|
-
*
|
|
670
|
-
* **Use cases:**
|
|
671
|
-
* - Clean up old failed jobs after investigating
|
|
672
|
-
* - Reset a queue after fixing the underlying issue
|
|
673
|
-
*
|
|
674
|
-
* **Permissions:** `ADD_MEDIA`
|
|
536
|
+
* This does **not** re-sync the affected segments -- use the reindex endpoint for that.
|
|
675
537
|
*
|
|
676
538
|
*/
|
|
677
539
|
export declare const purgeAdminQueueFailed: <ThrowOnError extends boolean = false>(options: Options<PurgeAdminQueueFailedData, ThrowOnError>) => import("./client").RequestResult<PurgeAdminQueueFailedResponses, PurgeAdminQueueFailedErrors, ThrowOnError, "fields">;
|
|
@@ -697,8 +559,6 @@ export declare const impersonateAdminUser: <ThrowOnError extends boolean = false
|
|
|
697
559
|
* Returns all reports with filtering and cursor pagination.
|
|
698
560
|
* Supports filtering by source (USER/AUTO) to separate user reports from auto-check findings.
|
|
699
561
|
*
|
|
700
|
-
* **Permissions:** `ADD_MEDIA`
|
|
701
|
-
*
|
|
702
562
|
*/
|
|
703
563
|
export declare const listAdminReports: <ThrowOnError extends boolean = false>(options?: Options<ListAdminReportsData, ThrowOnError>) => import("./client").RequestResult<ListAdminReportsResponses, ListAdminReportsErrors, ThrowOnError, "fields">;
|
|
704
564
|
/**
|
|
@@ -706,18 +566,14 @@ export declare const listAdminReports: <ThrowOnError extends boolean = false>(op
|
|
|
706
566
|
*
|
|
707
567
|
* Updates the status (and optionally admin notes) of multiple reports at once.
|
|
708
568
|
*
|
|
709
|
-
* **Permissions:** `ADD_MEDIA`
|
|
710
|
-
*
|
|
711
569
|
*/
|
|
712
570
|
export declare const batchUpdateAdminReports: <ThrowOnError extends boolean = false>(options: Options<BatchUpdateAdminReportsData, ThrowOnError>) => import("./client").RequestResult<BatchUpdateAdminReportsResponses, BatchUpdateAdminReportsErrors, ThrowOnError, "fields">;
|
|
713
571
|
/**
|
|
714
|
-
* Update
|
|
572
|
+
* Update report
|
|
715
573
|
*
|
|
716
574
|
* Updates the status and/or admin notes of a report.
|
|
717
575
|
* Works for both USER and AUTO reports.
|
|
718
576
|
*
|
|
719
|
-
* **Permissions:** `ADD_MEDIA`
|
|
720
|
-
*
|
|
721
577
|
*/
|
|
722
578
|
export declare const updateAdminReport: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminReportData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminReportResponses, UpdateAdminReportErrors, ThrowOnError, "fields">;
|
|
723
579
|
/**
|
|
@@ -725,26 +581,20 @@ export declare const updateAdminReport: <ThrowOnError extends boolean = false>(o
|
|
|
725
581
|
*
|
|
726
582
|
* Returns all audit definitions with current config, threshold schema, and latest run info.
|
|
727
583
|
*
|
|
728
|
-
* **Permissions:** `ADD_MEDIA`
|
|
729
|
-
*
|
|
730
584
|
*/
|
|
731
585
|
export declare const listAdminMediaAudits: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditsResponses, ListAdminMediaAuditsErrors, ThrowOnError, "fields">;
|
|
732
586
|
/**
|
|
733
|
-
* Update
|
|
587
|
+
* Update media audit config
|
|
734
588
|
*
|
|
735
589
|
* Updates the threshold values or enabled status of an audit.
|
|
736
590
|
*
|
|
737
|
-
* **Permissions:** `ADD_MEDIA`
|
|
738
|
-
*
|
|
739
591
|
*/
|
|
740
592
|
export declare const updateAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<UpdateAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<UpdateAdminMediaAuditResponses, UpdateAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
741
593
|
/**
|
|
742
|
-
* Run
|
|
594
|
+
* Run media audit
|
|
743
595
|
*
|
|
744
596
|
* Triggers all enabled audits (or a specific one). Creates MediaAuditRun records and AUTO reports for any findings.
|
|
745
597
|
*
|
|
746
|
-
* **Permissions:** `ADD_MEDIA`
|
|
747
|
-
*
|
|
748
598
|
*/
|
|
749
599
|
export declare const runAdminMediaAudit: <ThrowOnError extends boolean = false>(options: Options<RunAdminMediaAuditData, ThrowOnError>) => import("./client").RequestResult<RunAdminMediaAuditResponses, RunAdminMediaAuditErrors, ThrowOnError, "fields">;
|
|
750
600
|
/**
|
|
@@ -752,28 +602,24 @@ export declare const runAdminMediaAudit: <ThrowOnError extends boolean = false>(
|
|
|
752
602
|
*
|
|
753
603
|
* Returns past media audit runs with summary stats. Supports filtering by audit name and cursor pagination.
|
|
754
604
|
*
|
|
755
|
-
* **Permissions:** `ADD_MEDIA`
|
|
756
|
-
*
|
|
757
605
|
*/
|
|
758
606
|
export declare const listAdminMediaAuditRuns: <ThrowOnError extends boolean = false>(options?: Options<ListAdminMediaAuditRunsData, ThrowOnError>) => import("./client").RequestResult<ListAdminMediaAuditRunsResponses, ListAdminMediaAuditRunsErrors, ThrowOnError, "fields">;
|
|
759
607
|
/**
|
|
760
|
-
* Get
|
|
608
|
+
* Get audit run details
|
|
761
609
|
*
|
|
762
610
|
* Returns a specific media audit run record with its linked reports.
|
|
763
611
|
*
|
|
764
|
-
* **Permissions:** `ADD_MEDIA`
|
|
765
|
-
*
|
|
766
612
|
*/
|
|
767
613
|
export declare const getAdminMediaAuditRun: <ThrowOnError extends boolean = false>(options: Options<GetAdminMediaAuditRunData, ThrowOnError>) => import("./client").RequestResult<GetAdminMediaAuditRunResponses, GetAdminMediaAuditRunErrors, ThrowOnError, "fields">;
|
|
768
614
|
/**
|
|
769
|
-
* Get
|
|
615
|
+
* Get current announcement
|
|
770
616
|
*
|
|
771
617
|
* Returns the current announcement if one is active. Public endpoint (no auth required).
|
|
772
618
|
*
|
|
773
619
|
*/
|
|
774
620
|
export declare const getAnnouncement: <ThrowOnError extends boolean = false>(options?: Options<GetAnnouncementData, ThrowOnError>) => import("./client").RequestResult<GetAnnouncementResponses, GetAnnouncementErrors, ThrowOnError, "fields">;
|
|
775
621
|
/**
|
|
776
|
-
* Create or update
|
|
622
|
+
* Create or update announcement
|
|
777
623
|
*
|
|
778
624
|
* Upserts the site-wide announcement. Only one announcement exists at a time.
|
|
779
625
|
*
|