@brigadasos/nadeshiko-sdk 1.5.0-dev.be49703 → 1.5.0-dev.ca1fe65

package/dist/types.gen.d.ts

@@ -6,9 +6,9 @@ export type ClientOptions = {
  */
 export type MediaFilterItem = {
     /**
-     * Media ID to filter
+     * Media identifier (publicId or AniList external ID)
      */
-    mediaId: number;
+    mediaId: string;
     /**
      * Specific episodes (omit for all episodes)
      */
@@ -132,6 +132,35 @@ export type SearchRequest = {
      */
     include?: Array<IncludeExpansion>;
 };
+/**
+ * Morphological token from Japanese text analysis
+ */
+export type Token = {
+    /**
+     * Surface form (the text as it appears in the sentence)
+     */
+    s: string;
+    /**
+     * Dictionary form (base/lemma form for search)
+     */
+    d: string;
+    /**
+     * Reading in katakana
+     */
+    r: string;
+    /**
+     * Begin character offset in textJa.content
+     */
+    b: number;
+    /**
+     * End character offset in textJa.content
+     */
+    e: number;
+    /**
+     * Primary part-of-speech tag
+     */
+    p: string;
+};
 /**
  * Segment with content, optional highlights, and media URLs
  */
@@ -144,6 +173,10 @@ export type Segment = {
      * Unique identifier for the segment
      */
     uuid: string;
+    /**
+     * Public identifier for the segment (use this instead of uuid in public URLs)
+     */
+    publicId: string;
     /**
      * Position of the segment within the episode
      */
@@ -169,6 +202,10 @@ export type Segment = {
      * Media ID this segment belongs to
      */
     mediaId: number;
+    /**
+     * Public ID of the media this segment belongs to
+     */
+    mediaPublicId: string;
     textJa: {
         /**
          * Original Japanese content
@@ -178,6 +215,10 @@ export type Segment = {
          * Japanese content with search terms highlighted
          */
         highlight?: string;
+        /**
+         * Morphological tokens for interactive display (Labs feature)
+         */
+        tokens?: Array<Token>;
     };
     textEn: {
         /**
@@ -241,6 +282,10 @@ export type ExternalId = {
      * TVDB ID
      */
     tvdb?: string;
+    /**
+     * TMDB ID
+     */
+    tmdb?: string;
 };
 /**
  * Japanese voice actor (seiyuu)
@@ -250,6 +295,10 @@ export type Seiyuu = {
      * Internal seiyuu ID
      */
     id: number;
+    /**
+     * Public identifier for the seiyuu (use this in public URLs)
+     */
+    publicId: string;
     externalIds: ExternalId;
     /**
      * Japanese name of the voice actor
@@ -295,9 +344,13 @@ export type MediaCharacter = {
  */
 export type Media = {
     /**
-     * Unique identifier for the media
+     * Internal unique identifier for the media
      */
     id: number;
+    /**
+     * Public identifier for the media (use this in public URLs)
+     */
+    publicId: string;
     externalIds: ExternalId;
     /**
      * Original Japanese name of the media
@@ -351,7 +404,7 @@ export type Media = {
     /**
      * Animation studio that produced the media
      */
-    studio: string;
+    studio?: string;
     /**
      * Airing season label for the media
      */
@@ -390,7 +443,7 @@ export type SearchResponse = {
     segments: Array<Segment>;
     includes: {
         /**
-         * Media objects keyed by mediaId
+         * Media objects keyed by media publicId
          */
         media: {
             [key: string]: Media;
@@ -601,6 +654,10 @@ export type MediaSearchStats = {
      * Media identifier (look up full details in includes.media)
      */
     mediaId: number;
+    /**
+     * Public identifier for use in URLs and filters
+     */
+    publicId: string;
     /**
      * Number of matching segments found in this media
      */
@@ -627,7 +684,7 @@ export type SearchStatsResponse = {
     categories: Array<CategoryCount>;
     includes: {
         /**
-         * Media objects keyed by mediaId
+         * Media objects keyed by media publicId
          */
         media: {
             [key: string]: Media;
@@ -719,6 +776,20 @@ export type OpaqueCursorPagination = {
 export type MediaListResponse = {
     media: Array<Media>;
     pagination: OpaqueCursorPagination;
+    stats: {
+        /**
+         * Total number of media across all pages
+         */
+        totalMedia: number;
+        /**
+         * Total number of non-deleted segments
+         */
+        totalSegments: number;
+        /**
+         * Total number of episodes
+         */
+        totalEpisodes: number;
+    };
 };
 /**
  * Character data for creating/updating media
@@ -813,7 +884,7 @@ export type MediaCreateRequest = {
     /**
      * Animation studio that produced the media
      */
-    studio: string;
+    studio?: string;
     /**
      * Airing season label for the media
      */
@@ -1072,6 +1143,10 @@ export type Series = {
      * Series ID
      */
     id: number;
+    /**
+     * Public identifier for the series
+     */
+    publicId: string;
     /**
      * Japanese name of the series
      */
@@ -1128,6 +1203,10 @@ export type Character = {
      * Internal character ID
      */
     id: number;
+    /**
+     * Public identifier for the character (use this in public URLs)
+     */
+    publicId: string;
     externalIds: ExternalId;
     /**
      * Japanese name of the character
@@ -1484,39 +1563,39 @@ export type ReportTargetMedia = {
      */
     type: 'MEDIA';
     /**
-     * Media ID this report targets
+     * Public ID of the media this report targets
      */
-    mediaId: number;
+    mediaId: string;
 };
-export type ReportTargetSegment = {
+export type ReportTargetSegmentInput = {
     /**
      * Report target type
      */
     type: 'SEGMENT';
     /**
-     * Media ID this report targets
+     * Public ID of the media this report targets
      */
-    mediaId: number;
+    mediaId: string;
     /**
      * Episode number containing the segment
      */
     episodeNumber?: number;
     /**
-     * Segment UUID this report targets
+     * Segment public ID or UUID
      */
-    segmentUuid: string;
+    segmentId: string;
 };
 export type UserReportTarget = ({
     type: 'MEDIA';
 } & ReportTargetMedia) | ({
     type: 'SEGMENT';
-} & ReportTargetSegment);
+} & ReportTargetSegmentInput);
 export type CreateReportRequest = {
     target: UserReportTarget;
     /**
      * Reason for the report
      */
-    reason: 'WRONG_TRANSLATION' | 'WRONG_TIMING' | 'WRONG_AUDIO' | 'NSFW_NOT_TAGGED' | 'DUPLICATE_SEGMENT' | 'WRONG_METADATA' | 'MISSING_EPISODES' | 'WRONG_COVER_IMAGE' | 'INAPPROPRIATE_CONTENT' | 'OTHER';
+    reason: 'WRONG_TRANSLATION' | 'WRONG_TIMING' | 'WRONG_AUDIO' | 'WRONG_JAPANESE_TEXT' | 'LOW_QUALITY_AUDIO' | 'NSFW_NOT_TAGGED' | 'DUPLICATE_SEGMENT' | 'WRONG_TITLE' | 'DUPLICATE_MEDIA' | 'WRONG_EPISODE_NUMBER' | 'IMAGE_ISSUE' | 'MISSING_EPISODES' | 'INAPPROPRIATE_CONTENT' | 'OTHER';
     /**
      * Optional description with additional details
      */
@@ -1528,14 +1607,32 @@ export type ReportTargetEpisode = {
      */
     type: 'EPISODE';
     /**
-     * Media ID this report targets
+     * Public ID of the media this report targets
      */
-    mediaId: number;
+    mediaId: string;
     /**
      * Episode number this report targets
      */
     episodeNumber: number;
 };
+export type ReportTargetSegment = {
+    /**
+     * Report target type
+     */
+    type: 'SEGMENT';
+    /**
+     * Public ID of the media this report targets
+     */
+    mediaId: string;
+    /**
+     * Episode number containing the segment
+     */
+    episodeNumber?: number;
+    /**
+     * Segment public ID or UUID
+     */
+    segmentId: string;
+};
 export type ReportTarget = ({
     type: 'MEDIA';
 } & ReportTargetMedia) | ({
@@ -1560,7 +1657,7 @@ export type Report = {
     /**
      * Reason for the report
      */
-    reason: 'WRONG_TRANSLATION' | 'WRONG_TIMING' | 'WRONG_AUDIO' | 'NSFW_NOT_TAGGED' | 'DUPLICATE_SEGMENT' | 'WRONG_METADATA' | 'MISSING_EPISODES' | 'WRONG_COVER_IMAGE' | 'INAPPROPRIATE_CONTENT' | 'OTHER' | 'LOW_SEGMENT_MEDIA' | 'EMPTY_EPISODES' | 'MISSING_EPISODES_AUTO' | 'BAD_SEGMENT_RATIO' | 'MEDIA_WITH_NO_EPISODES' | 'MISSING_TRANSLATIONS' | 'DB_ES_SYNC_ISSUES' | 'HIGH_REPORT_DENSITY';
+    reason: 'WRONG_TRANSLATION' | 'WRONG_TIMING' | 'WRONG_AUDIO' | 'WRONG_JAPANESE_TEXT' | 'LOW_QUALITY_AUDIO' | 'NSFW_NOT_TAGGED' | 'DUPLICATE_SEGMENT' | 'WRONG_METADATA' | 'MISSING_EPISODES' | 'WRONG_COVER_IMAGE' | 'WRONG_TITLE' | 'DUPLICATE_MEDIA' | 'WRONG_EPISODE_NUMBER' | 'IMAGE_ISSUE' | 'INAPPROPRIATE_CONTENT' | 'OTHER' | 'LOW_SEGMENT_MEDIA' | 'EMPTY_EPISODES' | 'MISSING_EPISODES_AUTO' | 'BAD_SEGMENT_RATIO' | 'MEDIA_WITH_NO_EPISODES' | 'MISSING_TRANSLATIONS' | 'DB_ES_SYNC_ISSUES' | 'HIGH_REPORT_DENSITY';
     /**
      * Optional description with additional details
      */
@@ -1643,7 +1740,7 @@ export type ActivityType = 'SEARCH' | 'ANKI_EXPORT' | 'SEGMENT_PLAY' | 'SHARE';
 export type UserActivity = {
     id: number;
     activityType: ActivityType;
-    segmentUuid: string;
+    segmentId: string;
     mediaId: number;
     searchQuery: string;
     mediaName: string;
@@ -1667,6 +1764,10 @@ export type Collection = {
      * Collection ID
      */
     id: number;
+    /**
+     * Public identifier for the collection
+     */
+    publicId: string;
     /**
      * Name of the collection
      */
@@ -1694,9 +1795,9 @@ export type Collection = {
 };
 export type UserExportCollection = Collection & {
     /**
-     * Segment UUIDs in saved order
+     * Segment IDs in saved order
      */
-    segmentUuids: Array<string>;
+    segmentIds: Array<number>;
 };
 /**
  * User data export payload (identifier-oriented references)
@@ -2270,7 +2371,7 @@ export type GetSegmentByUuidData = {
     body?: never;
     path: {
         /**
-         * Segment UUID
+         * Segment UUID or publicId
          */
         uuid: string;
     };
@@ -2320,7 +2421,7 @@ export type UpdateSegmentByUuidData = {
     body: SegmentUpdateRequest;
     path: {
         /**
-         * Segment UUID
+         * Segment UUID or publicId
          */
         uuid: string;
     };
@@ -2365,7 +2466,7 @@ export type GetSegmentContextData = {
     body?: never;
     path: {
         /**
-         * Segment UUID
+         * Segment UUID or publicId
          */
         uuid: string;
     };
@@ -2419,7 +2520,7 @@ export type ListSegmentRevisionsData = {
     body?: never;
     path: {
         /**
-         * Segment UUID
+         * Segment UUID or publicId
          */
         uuid: string;
     };
@@ -2564,9 +2665,9 @@ export type DeleteSeriesData = {
     body?: never;
     path: {
         /**
-         * Series ID
+         * Series public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/media/series/{id}';
@@ -2609,9 +2710,9 @@ export type GetSeriesData = {
     body?: never;
     path: {
         /**
-         * Series ID
+         * Series public ID
          */
-        id: number;
+        id: string;
     };
     query?: {
         /**
@@ -2672,9 +2773,9 @@ export type UpdateSeriesData = {
     };
     path: {
         /**
-         * Series ID
+         * Series public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/media/series/{id}';
@@ -2716,9 +2817,9 @@ export type UpdateSeriesResponse = UpdateSeriesResponses[keyof UpdateSeriesRespo
 export type AddMediaToSeriesData = {
     body: {
         /**
-         * Media ID to add
+         * Media public ID to add
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Position in the series (1-indexed)
          */
@@ -2726,9 +2827,9 @@ export type AddMediaToSeriesData = {
     };
     path: {
         /**
-         * Series ID
+         * Series public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/media/series/{id}/media';
@@ -2771,13 +2872,13 @@ export type RemoveMediaFromSeriesData = {
     body?: never;
     path: {
         /**
-         * Series ID
+         * Series public ID
          */
-        id: number;
+        id: string;
         /**
-         * Media ID
+         * Media public ID
          */
-        mediaId: number;
+        mediaId: string;
     };
     query?: never;
     url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2825,13 +2926,13 @@ export type UpdateSeriesMediaData = {
     };
     path: {
         /**
-         * Series ID
+         * Series public ID
          */
-        id: number;
+        id: string;
         /**
-         * Media ID
+         * Media public ID
          */
-        mediaId: number;
+        mediaId: string;
     };
     query?: never;
     url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2874,7 +2975,7 @@ export type GetCharacterData = {
     body?: never;
     path: {
         /**
-         * Internal character ID
+         * Character ID
          */
         id: number;
     };
@@ -2964,9 +3065,9 @@ export type DeleteMediaData = {
     body?: never;
     path: {
         /**
-         * Media ID
+         * Media public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/media/{id}';
@@ -3009,9 +3110,9 @@ export type GetMediaData = {
     body?: never;
     path: {
         /**
-         * Media ID
+         * Media public ID
          */
-        id: number;
+        id: string;
     };
     query?: {
         /**
@@ -3059,9 +3160,9 @@ export type UpdateMediaData = {
     body: MediaUpdateRequest;
     path: {
         /**
-         * Media ID
+         * Media public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/media/{id}';
@@ -3104,9 +3205,9 @@ export type ListEpisodesData = {
     body?: never;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
     };
     query?: {
         /**
@@ -3158,9 +3259,9 @@ export type CreateEpisodeData = {
     body: EpisodeCreateRequest;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
     };
     query?: never;
     url: '/v1/media/{mediaId}/episodes';
@@ -3207,9 +3308,9 @@ export type DeleteEpisodeData = {
     body?: never;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3256,9 +3357,9 @@ export type GetEpisodeData = {
     body?: never;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3305,9 +3406,9 @@ export type UpdateEpisodeData = {
     body: EpisodeUpdateRequest;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3354,9 +3455,9 @@ export type ListSegmentsData = {
     body?: never;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3418,9 +3519,9 @@ export type CreateSegmentData = {
     body: SegmentCreateRequest;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3471,9 +3572,9 @@ export type CreateSegmentsBatchData = {
     body: SegmentBatchCreateRequest;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3529,9 +3630,9 @@ export type DeleteSegmentData = {
     body?: never;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3582,9 +3683,9 @@ export type GetSegmentData = {
     body?: never;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3635,9 +3736,9 @@ export type UpdateSegmentData = {
     body: SegmentUpdateRequest;
     path: {
         /**
-         * ID of the media
+         * Public ID of the media
          */
-        mediaId: number;
+        mediaId: string;
         /**
          * Episode number
          */
@@ -3873,11 +3974,12 @@ export type ListUserActivityResponses = {
 export type ListUserActivityResponse = ListUserActivityResponses[keyof ListUserActivityResponses];
 export type TrackUserActivityData = {
     body: {
-        activityType: 'SEGMENT_PLAY' | 'SHARE';
-        segmentUuid?: string;
+        activityType: 'SEARCH' | 'SEGMENT_PLAY' | 'SHARE';
+        segmentId?: string;
         mediaId?: number;
         mediaName?: string;
         japaneseText?: string;
+        searchQuery?: string;
     };
     path?: never;
     query?: never;
@@ -4247,9 +4349,9 @@ export type DeleteCollectionData = {
     body?: never;
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/collections/{id}';
@@ -4292,9 +4394,9 @@ export type GetCollectionData = {
     body?: never;
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
     };
     query?: {
         /**
@@ -4349,9 +4451,9 @@ export type UpdateCollectionData = {
     };
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/collections/{id}';
@@ -4393,9 +4495,9 @@ export type UpdateCollectionResponse = UpdateCollectionResponses[keyof UpdateCol
 export type AddSegmentToCollectionData = {
     body: {
         /**
-         * UUID of the segment to add
+         * Public ID or UUID of the segment to add
          */
-        segmentUuid: string;
+        segmentId: string;
         /**
          * Optional annotation
          */
@@ -4403,9 +4505,9 @@ export type AddSegmentToCollectionData = {
     };
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/collections/{id}/segments';
@@ -4448,16 +4550,16 @@ export type RemoveSegmentFromCollectionData = {
     body?: never;
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
         /**
-         * Segment UUID
+         * Segment ID
          */
-        uuid: string;
+        segmentId: number;
     };
     query?: never;
-    url: '/v1/collections/{id}/segments/{uuid}';
+    url: '/v1/collections/{id}/segments/{segmentId}';
 };
 export type RemoveSegmentFromCollectionErrors = {
     /**
@@ -4506,16 +4608,16 @@ export type UpdateCollectionSegmentData = {
     };
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
         /**
-         * Segment UUID
+         * Segment ID
          */
-        uuid: string;
+        segmentId: number;
     };
     query?: never;
-    url: '/v1/collections/{id}/segments/{uuid}';
+    url: '/v1/collections/{id}/segments/{segmentId}';
 };
 export type UpdateCollectionSegmentErrors = {
     /**
@@ -4555,9 +4657,9 @@ export type SearchCollectionSegmentsData = {
     body?: never;
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
     };
     query?: {
         /**
@@ -4609,9 +4711,9 @@ export type GetCollectionStatsData = {
     body?: never;
     path: {
         /**
-         * Collection ID
+         * Collection public ID
          */
-        id: number;
+        id: string;
     };
     query?: never;
     url: '/v1/collections/{id}/stats';
@@ -5232,9 +5334,9 @@ export type ListAdminReportsData = {
          */
         'target.episodeNumber'?: number;
         /**
-         * Filter by target segment UUID
+         * Filter by target segment ID
          */
-        'target.segmentUuid'?: string;
+        'target.segmentId'?: number;
         /**
          * Filter by audit run ID
          */
@@ -5539,4 +5641,80 @@ export type GetAdminMediaAuditRunResponses = {
     };
 };
 export type GetAdminMediaAuditRunResponse = GetAdminMediaAuditRunResponses[keyof GetAdminMediaAuditRunResponses];
+export type GetAnnouncementData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/admin/announcement';
+};
+export type GetAnnouncementErrors = {
+    /**
+     * Too Many Requests
+     */
+    429: Error429;
+    /**
+     * Internal Server Error
+     */
+    500: Error500;
+};
+export type GetAnnouncementError = GetAnnouncementErrors[keyof GetAnnouncementErrors];
+export type GetAnnouncementResponses = {
+    /**
+     * OK
+     */
+    200: {
+        message: string;
+        type: 'info' | 'warning' | 'maintenance';
+        active: boolean;
+    };
+    /**
+     * No announcement set
+     */
+    204: void;
+};
+export type GetAnnouncementResponse = GetAnnouncementResponses[keyof GetAnnouncementResponses];
+export type UpdateAnnouncementData = {
+    body: {
+        message: string;
+        type: 'info' | 'warning' | 'maintenance';
+        active: boolean;
+    };
+    path?: never;
+    query?: never;
+    url: '/v1/admin/announcement';
+};
+export type UpdateAnnouncementErrors = {
+    /**
+     * Bad Request
+     */
+    400: Error400;
+    /**
+     * Unauthorized (session)
+     */
+    401: Error401;
+    /**
+     * Forbidden
+     */
+    403: Error403;
+    /**
+     * Too Many Requests
+     */
+    429: Error429;
+    /**
+     * Internal Server Error
+     */
+    500: Error500;
+};
+export type UpdateAnnouncementError = UpdateAnnouncementErrors[keyof UpdateAnnouncementErrors];
+export type UpdateAnnouncementResponses = {
+    /**
+     * Announcement updated
+     */
+    200: {
+        message: string;
+        type: 'info' | 'warning' | 'maintenance';
+        active: boolean;
+    };
+};
+export type UpdateAnnouncementResponse = UpdateAnnouncementResponses[keyof UpdateAnnouncementResponses];
 //# sourceMappingURL=types.gen.d.ts.map