@brigadasos/nadeshiko-sdk 1.5.0-dev.9402be1 → 1.5.0-dev.b657d3a

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)
      */
@@ -144,6 +144,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
      */
@@ -250,6 +254,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 +303,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
@@ -601,6 +613,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
      */
@@ -866,8 +882,65 @@ export type Error409 = {
         [key: string]: string;
     };
 };
+/**
+ * Slim media item returned by autocomplete (names + cover only)
+ */
+export type MediaAutocompleteItem = {
+    /**
+     * Unique identifier for the media
+     */
+    id: number;
+    /**
+     * Original Japanese name of the media
+     */
+    nameJa: string;
+    /**
+     * Romaji transliteration of the media name
+     */
+    nameRomaji: string;
+    /**
+     * English name of the media
+     */
+    nameEn: string;
+    /**
+     * Full URL to the cover image
+     */
+    coverUrl: string;
+    category: Category;
+};
 export type MediaAutocompleteResponse = {
-    media: Array<Media>;
+    media: Array<MediaAutocompleteItem>;
+};
+/**
+ * Segment with internal fields. For write operations (create, update) all fields are always populated.
+ * For GET, optional fields are only populated when requested via include[].
+ *
+ */
+export type SegmentInternal = Segment & {
+    /**
+     * Storage backend for segment assets
+     */
+    storage?: 'LOCAL' | 'R2';
+    /**
+     * Hash identifier for the segment
+     */
+    hashedId?: string;
+    /**
+     * Base path in the storage backend
+     */
+    storageBasePath?: string;
+    /**
+     * Raw WD Tagger v3 classifier output used to derive content rating
+     */
+    ratingAnalysis?: {
+        [key: string]: unknown;
+    };
+    /**
+     * POS tokenization results keyed by engine (sudachi, unidic)
+     */
+    posAnalysis?: {
+        [key: string]: unknown;
+    };
 };
 /**
  * Not Found error response
@@ -972,35 +1045,6 @@ export type SegmentUpdateRequest = {
      */
     hashedId?: string;
 };
-/**
- * Segment with internal fields (for internal API responses)
- */
-export type SegmentInternal = Segment & {
-    /**
-     * Storage backend for segment assets
-     */
-    storage: 'LOCAL' | 'R2';
-    /**
-     * Hash identifier for the segment
-     */
-    hashedId: string;
-    /**
-     * Base path in the storage backend
-     */
-    storageBasePath: string;
-    /**
-     * Raw WD Tagger v3 classifier output used to derive content rating
-     */
-    ratingAnalysis: {
-        [key: string]: unknown;
-    };
-    /**
-     * POS tokenization results keyed by engine (sudachi, unidic)
-     */
-    posAnalysis: {
-        [key: string]: unknown;
-    };
-};
 export type SegmentContextResponse = {
     segments: Array<Segment>;
     includes: {
@@ -1012,6 +1056,30 @@ export type SegmentContextResponse = {
         };
     };
 };
+export type SegmentRevision = {
+    /**
+     * Revision ID
+     */
+    id: number;
+    /**
+     * Sequential revision number per segment
+     */
+    revisionNumber: number;
+    /**
+     * Snapshot of editable fields at the time of the revision
+     */
+    snapshot: {
+        [key: string]: unknown;
+    };
+    /**
+     * Name of the user who made the change
+     */
+    userName?: string;
+    /**
+     * When the revision was created
+     */
+    createdAt: string;
+};
 /**
  * Ordered media series grouping
  */
@@ -1076,6 +1144,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
@@ -1397,6 +1469,9 @@ export type SegmentCreateRequest = {
      */
     hashedId: string;
 };
+export type SegmentBatchCreateRequest = {
+    segments: Array<SegmentCreateRequest>;
+};
 export type UserQuotaResponse = {
     /**
      * Number of API requests used in the current billing period.
@@ -1433,7 +1508,7 @@ export type ReportTargetMedia = {
      */
     mediaId: number;
 };
-export type ReportTargetSegment = {
+export type ReportTargetSegmentInput = {
     /**
      * Report target type
      */
@@ -1447,15 +1522,15 @@ export type ReportTargetSegment = {
      */
     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;
     /**
@@ -1481,6 +1556,24 @@ export type ReportTargetEpisode = {
      */
     episodeNumber: number;
 };
+export type ReportTargetSegment = {
+    /**
+     * Report target type
+     */
+    type: 'SEGMENT';
+    /**
+     * Media ID this report targets
+     */
+    mediaId: number;
+    /**
+     * Episode number containing the segment
+     */
+    episodeNumber?: number;
+    /**
+     * Segment ID
+     */
+    segmentId: number;
+};
 export type ReportTarget = ({
     type: 'MEDIA';
 } & ReportTargetMedia) | ({
@@ -1584,17 +1677,26 @@ export type UserPreferences = {
 /**
  * Type of user activity
  */
-export type ActivityType = 'SEARCH' | 'ANKI_EXPORT' | 'SEGMENT_PLAY' | 'LIST_ADD_SEGMENT';
+export type ActivityType = 'SEARCH' | 'ANKI_EXPORT' | 'SEGMENT_PLAY' | 'SHARE';
 export type UserActivity = {
     id: number;
     activityType: ActivityType;
-    segmentUuid: string;
+    segmentId: number;
     mediaId: number;
     searchQuery: string;
     mediaName: string;
     japaneseText: string;
     createdAt: string;
 };
+/**
+ * Activity counts for a single day, broken down by type. Only types with at least 1 event are present.
+ */
+export type HeatmapDayCounts = {
+    SEARCH?: number;
+    SEGMENT_PLAY?: number;
+    ANKI_EXPORT?: number;
+    SHARE?: number;
+};
 /**
  * User segment collection
  */
@@ -1607,6 +1709,10 @@ export type Collection = {
      * Name of the collection
      */
     name: string;
+    /**
+     * Type of the collection
+     */
+    type: 'USER' | 'ANKI_EXPORT';
     /**
      * Visibility of the collection
      */
@@ -1626,9 +1732,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)
@@ -2202,11 +2308,16 @@ export type GetSegmentByUuidData = {
     body?: never;
     path: {
         /**
-         * Segment UUID
+         * Segment UUID or publicId
          */
         uuid: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Additional internal fields to include in the response
+         */
+        include?: Array<'ratingAnalysis' | 'posAnalysis' | 'hashedId' | 'storageBasePath' | 'storage'>;
+    };
     url: '/v1/media/segments/{uuid}';
 };
 export type GetSegmentByUuidErrors = {
@@ -2215,7 +2326,7 @@ export type GetSegmentByUuidErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (API key or session)
      */
     401: Error401;
     /**
@@ -2238,16 +2349,16 @@ export type GetSegmentByUuidErrors = {
 export type GetSegmentByUuidError = GetSegmentByUuidErrors[keyof GetSegmentByUuidErrors];
 export type GetSegmentByUuidResponses = {
     /**
-     * OK
+     * Single segment response with internal fields
      */
-    200: Segment;
+    200: SegmentInternal;
 };
 export type GetSegmentByUuidResponse = GetSegmentByUuidResponses[keyof GetSegmentByUuidResponses];
 export type UpdateSegmentByUuidData = {
     body: SegmentUpdateRequest;
     path: {
         /**
-         * Segment UUID
+         * Segment UUID or publicId
          */
         uuid: string;
     };
@@ -2292,7 +2403,7 @@ export type GetSegmentContextData = {
     body?: never;
     path: {
         /**
-         * Segment UUID
+         * Segment UUID or publicId
          */
         uuid: string;
     };
@@ -2314,7 +2425,7 @@ export type GetSegmentContextErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (API key or session)
      */
     401: Error401;
     /**
@@ -2342,6 +2453,53 @@ export type GetSegmentContextResponses = {
     200: SegmentContextResponse;
 };
 export type GetSegmentContextResponse = GetSegmentContextResponses[keyof GetSegmentContextResponses];
+export type ListSegmentRevisionsData = {
+    body?: never;
+    path: {
+        /**
+         * Segment UUID or publicId
+         */
+        uuid: string;
+    };
+    query?: never;
+    url: '/v1/media/segments/{uuid}/revisions';
+};
+export type ListSegmentRevisionsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Error400;
+    /**
+     * Unauthorized (API key or session)
+     */
+    401: Error401;
+    /**
+     * Forbidden
+     */
+    403: Error403;
+    /**
+     * Not Found
+     */
+    404: Error404;
+    /**
+     * Too Many Requests
+     */
+    429: Error429;
+    /**
+     * Internal Server Error
+     */
+    500: Error500;
+};
+export type ListSegmentRevisionsError = ListSegmentRevisionsErrors[keyof ListSegmentRevisionsErrors];
+export type ListSegmentRevisionsResponses = {
+    /**
+     * List of segment revisions
+     */
+    200: {
+        revisions: Array<SegmentRevision>;
+    };
+};
+export type ListSegmentRevisionsResponse = ListSegmentRevisionsResponses[keyof ListSegmentRevisionsResponses];
 export type ListSeriesData = {
     body?: never;
     path?: never;
@@ -3347,6 +3505,64 @@ export type CreateSegmentResponses = {
     201: SegmentInternal;
 };
 export type CreateSegmentResponse = CreateSegmentResponses[keyof CreateSegmentResponses];
+export type CreateSegmentsBatchData = {
+    body: SegmentBatchCreateRequest;
+    path: {
+        /**
+         * ID of the media
+         */
+        mediaId: number;
+        /**
+         * Episode number
+         */
+        episodeNumber: number;
+    };
+    query?: never;
+    url: '/v1/media/{mediaId}/episodes/{episodeNumber}/segments/batch';
+};
+export type CreateSegmentsBatchErrors = {
+    /**
+     * Bad Request
+     */
+    400: Error400;
+    /**
+     * Unauthorized (API key)
+     */
+    401: Error401;
+    /**
+     * Forbidden
+     */
+    403: Error403;
+    /**
+     * Not Found
+     */
+    404: Error404;
+    /**
+     * Too Many Requests
+     */
+    429: Error429;
+    /**
+     * Internal Server Error
+     */
+    500: Error500;
+};
+export type CreateSegmentsBatchError = CreateSegmentsBatchErrors[keyof CreateSegmentsBatchErrors];
+export type CreateSegmentsBatchResponses = {
+    /**
+     * Batch segment creation result
+     */
+    201: {
+        /**
+         * Number of segments successfully created
+         */
+        created: number;
+        /**
+         * Number of segments skipped due to duplicate UUIDs
+         */
+        skipped: number;
+    };
+};
+export type CreateSegmentsBatchResponse = CreateSegmentsBatchResponses[keyof CreateSegmentsBatchResponses];
 export type DeleteSegmentData = {
     body?: never;
     path: {
@@ -3695,8 +3911,8 @@ export type ListUserActivityResponses = {
 export type ListUserActivityResponse = ListUserActivityResponses[keyof ListUserActivityResponses];
 export type TrackUserActivityData = {
     body: {
-        activityType: 'SEGMENT_PLAY';
-        segmentUuid?: string;
+        activityType: 'SEGMENT_PLAY' | 'SHARE';
+        segmentId?: number;
         mediaId?: number;
         mediaName?: string;
         japaneseText?: string;
@@ -3735,10 +3951,6 @@ export type GetUserActivityHeatmapData = {
          * Number of days to include in the heatmap
          */
         days?: number;
-        /**
-         * Filter by activity type
-         */
-        activityType?: ActivityType;
     };
     url: '/v1/user/activity/heatmap';
 };
@@ -3759,10 +3971,10 @@ export type GetUserActivityHeatmapResponses = {
      */
     200: {
         /**
-         * Map of YYYY-MM-DD date strings to activity activityByDay
+         * Map of YYYY-MM-DD date strings to per-type activity counts
          */
         activityByDay: {
-            [key: string]: number;
+            [key: string]: HeatmapDayCounts;
         };
     };
 };
@@ -3798,6 +4010,7 @@ export type GetUserActivityStatsResponses = {
         totalExports: number;
         totalPlays: number;
         totalListAdds: number;
+        totalShares: number;
         topMedia: Array<{
             mediaId: number;
             count: number;
@@ -4218,9 +4431,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
          */
@@ -4277,12 +4490,12 @@ export type RemoveSegmentFromCollectionData = {
          */
         id: number;
         /**
-         * 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 = {
     /**
@@ -4335,12 +4548,12 @@ export type UpdateCollectionSegmentData = {
          */
         id: number;
         /**
-         * 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 = {
     /**
@@ -4483,7 +4696,7 @@ export type GetAdminDashboardData = {
 };
 export type GetAdminDashboardErrors = {
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4575,7 +4788,7 @@ export type GetAdminHealthData = {
 };
 export type GetAdminHealthErrors = {
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4637,7 +4850,7 @@ export type TriggerReindexErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4673,7 +4886,7 @@ export type ListAdminQueueStatsErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4724,7 +4937,7 @@ export type GetAdminQueueErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4809,7 +5022,7 @@ export type ListAdminQueueFailedErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4867,7 +5080,7 @@ export type RetryAdminQueueFailedErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4915,7 +5128,7 @@ export type PurgeAdminQueueFailedErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -4953,10 +5166,6 @@ export type ClearAdminImpersonationData = {
     url: '/v1/admin/impersonation';
 };
 export type ClearAdminImpersonationErrors = {
-    /**
-     * Unauthorized (session)
-     */
-    401: Error401;
     /**
      * Forbidden
      */
@@ -4996,10 +5205,6 @@ export type ImpersonateAdminUserErrors = {
      * Bad Request
      */
     400: Error400;
-    /**
-     * Unauthorized (session)
-     */
-    401: Error401;
     /**
      * Forbidden
      */
@@ -5065,9 +5270,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
          */
@@ -5077,7 +5282,7 @@ export type ListAdminReportsData = {
 };
 export type ListAdminReportsErrors = {
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -5118,7 +5323,7 @@ export type UpdateAdminReportErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -5154,7 +5359,7 @@ export type ListAdminMediaAuditsData = {
 };
 export type ListAdminMediaAuditsErrors = {
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -5206,7 +5411,7 @@ export type UpdateAdminMediaAuditErrors = {
      */
     400: Error400;
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -5252,7 +5457,7 @@ export type RunAdminMediaAuditData = {
 };
 export type RunAdminMediaAuditErrors = {
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -5301,7 +5506,7 @@ export type ListAdminMediaAuditRunsData = {
 };
 export type ListAdminMediaAuditRunsErrors = {
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**
@@ -5341,7 +5546,7 @@ export type GetAdminMediaAuditRunData = {
 };
 export type GetAdminMediaAuditRunErrors = {
     /**
-     * Unauthorized (API key)
+     * Unauthorized (session)
      */
     401: Error401;
     /**