@brigadasos/nadeshiko-sdk 1.5.0-dev.b657d3a → 1.5.0-dev.ba43c52

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.
@@ -173,6 +173,10 @@ export type Segment = {
173
173
  * Media ID this segment belongs to
174
174
  */
175
175
  mediaId: number;
176
+ /**
177
+ * Public ID of the media this segment belongs to
178
+ */
179
+ mediaPublicId: string;
176
180
  textJa: {
177
181
  /**
178
182
  * Original Japanese content
@@ -245,6 +249,10 @@ export type ExternalId = {
245
249
  * TVDB ID
246
250
  */
247
251
  tvdb?: string;
252
+ /**
253
+ * TMDB ID
254
+ */
255
+ tmdb?: string;
248
256
  };
249
257
  /**
250
258
  * Japanese voice actor (seiyuu)
@@ -363,7 +371,7 @@ export type Media = {
363
371
  /**
364
372
  * Animation studio that produced the media
365
373
  */
366
- studio: string;
374
+ studio?: string;
367
375
  /**
368
376
  * Airing season label for the media
369
377
  */
@@ -402,7 +410,7 @@ export type SearchResponse = {
402
410
  segments: Array<Segment>;
403
411
  includes: {
404
412
  /**
405
- * Media objects keyed by mediaId
413
+ * Media objects keyed by media publicId
406
414
  */
407
415
  media: {
408
416
  [key: string]: Media;
@@ -643,7 +651,7 @@ export type SearchStatsResponse = {
643
651
  categories: Array<CategoryCount>;
644
652
  includes: {
645
653
  /**
646
- * Media objects keyed by mediaId
654
+ * Media objects keyed by media publicId
647
655
  */
648
656
  media: {
649
657
  [key: string]: Media;
@@ -735,6 +743,20 @@ export type OpaqueCursorPagination = {
735
743
  export type MediaListResponse = {
736
744
  media: Array<Media>;
737
745
  pagination: OpaqueCursorPagination;
746
+ stats: {
747
+ /**
748
+ * Total number of media across all pages
749
+ */
750
+ totalMedia: number;
751
+ /**
752
+ * Total number of non-deleted segments
753
+ */
754
+ totalSegments: number;
755
+ /**
756
+ * Total number of episodes
757
+ */
758
+ totalEpisodes: number;
759
+ };
738
760
  };
739
761
  /**
740
762
  * Character data for creating/updating media
@@ -829,7 +851,7 @@ export type MediaCreateRequest = {
829
851
  /**
830
852
  * Animation studio that produced the media
831
853
  */
832
- studio: string;
854
+ studio?: string;
833
855
  /**
834
856
  * Airing season label for the media
835
857
  */
@@ -1088,6 +1110,10 @@ export type Series = {
1088
1110
  * Series ID
1089
1111
  */
1090
1112
  id: number;
1113
+ /**
1114
+ * Public identifier for the series
1115
+ */
1116
+ publicId: string;
1091
1117
  /**
1092
1118
  * Japanese name of the series
1093
1119
  */
@@ -1504,9 +1530,9 @@ export type ReportTargetMedia = {
1504
1530
  */
1505
1531
  type: 'MEDIA';
1506
1532
  /**
1507
- * Media ID this report targets
1533
+ * Public ID of the media this report targets
1508
1534
  */
1509
- mediaId: number;
1535
+ mediaId: string;
1510
1536
  };
1511
1537
  export type ReportTargetSegmentInput = {
1512
1538
  /**
@@ -1514,9 +1540,9 @@ export type ReportTargetSegmentInput = {
1514
1540
  */
1515
1541
  type: 'SEGMENT';
1516
1542
  /**
1517
- * Media ID this report targets
1543
+ * Public ID of the media this report targets
1518
1544
  */
1519
- mediaId: number;
1545
+ mediaId: string;
1520
1546
  /**
1521
1547
  * Episode number containing the segment
1522
1548
  */
@@ -1536,7 +1562,7 @@ export type CreateReportRequest = {
1536
1562
  /**
1537
1563
  * Reason for the report
1538
1564
  */
1539
- reason: 'WRONG_TRANSLATION' | 'WRONG_TIMING' | 'WRONG_AUDIO' | 'NSFW_NOT_TAGGED' | 'DUPLICATE_SEGMENT' | 'WRONG_METADATA' | 'MISSING_EPISODES' | 'WRONG_COVER_IMAGE' | 'INAPPROPRIATE_CONTENT' | 'OTHER';
1565
+ 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';
1540
1566
  /**
1541
1567
  * Optional description with additional details
1542
1568
  */
@@ -1548,9 +1574,9 @@ export type ReportTargetEpisode = {
1548
1574
  */
1549
1575
  type: 'EPISODE';
1550
1576
  /**
1551
- * Media ID this report targets
1577
+ * Public ID of the media this report targets
1552
1578
  */
1553
- mediaId: number;
1579
+ mediaId: string;
1554
1580
  /**
1555
1581
  * Episode number this report targets
1556
1582
  */
@@ -1562,17 +1588,17 @@ export type ReportTargetSegment = {
1562
1588
  */
1563
1589
  type: 'SEGMENT';
1564
1590
  /**
1565
- * Media ID this report targets
1591
+ * Public ID of the media this report targets
1566
1592
  */
1567
- mediaId: number;
1593
+ mediaId: string;
1568
1594
  /**
1569
1595
  * Episode number containing the segment
1570
1596
  */
1571
1597
  episodeNumber?: number;
1572
1598
  /**
1573
- * Segment ID
1599
+ * Segment public ID or UUID
1574
1600
  */
1575
- segmentId: number;
1601
+ segmentId: string;
1576
1602
  };
1577
1603
  export type ReportTarget = ({
1578
1604
  type: 'MEDIA';
@@ -1598,7 +1624,7 @@ export type Report = {
1598
1624
  /**
1599
1625
  * Reason for the report
1600
1626
  */
1601
- 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';
1627
+ 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';
1602
1628
  /**
1603
1629
  * Optional description with additional details
1604
1630
  */
@@ -1705,6 +1731,10 @@ export type Collection = {
1705
1731
  * Collection ID
1706
1732
  */
1707
1733
  id: number;
1734
+ /**
1735
+ * Public identifier for the collection
1736
+ */
1737
+ publicId: string;
1708
1738
  /**
1709
1739
  * Name of the collection
1710
1740
  */
@@ -2602,9 +2632,9 @@ export type DeleteSeriesData = {
2602
2632
  body?: never;
2603
2633
  path: {
2604
2634
  /**
2605
- * Series ID
2635
+ * Series public ID
2606
2636
  */
2607
- id: number;
2637
+ id: string;
2608
2638
  };
2609
2639
  query?: never;
2610
2640
  url: '/v1/media/series/{id}';
@@ -2647,9 +2677,9 @@ export type GetSeriesData = {
2647
2677
  body?: never;
2648
2678
  path: {
2649
2679
  /**
2650
- * Series ID
2680
+ * Series public ID
2651
2681
  */
2652
- id: number;
2682
+ id: string;
2653
2683
  };
2654
2684
  query?: {
2655
2685
  /**
@@ -2710,9 +2740,9 @@ export type UpdateSeriesData = {
2710
2740
  };
2711
2741
  path: {
2712
2742
  /**
2713
- * Series ID
2743
+ * Series public ID
2714
2744
  */
2715
- id: number;
2745
+ id: string;
2716
2746
  };
2717
2747
  query?: never;
2718
2748
  url: '/v1/media/series/{id}';
@@ -2754,9 +2784,9 @@ export type UpdateSeriesResponse = UpdateSeriesResponses[keyof UpdateSeriesRespo
2754
2784
  export type AddMediaToSeriesData = {
2755
2785
  body: {
2756
2786
  /**
2757
- * Media ID to add
2787
+ * Media public ID to add
2758
2788
  */
2759
- mediaId: number;
2789
+ mediaId: string;
2760
2790
  /**
2761
2791
  * Position in the series (1-indexed)
2762
2792
  */
@@ -2764,9 +2794,9 @@ export type AddMediaToSeriesData = {
2764
2794
  };
2765
2795
  path: {
2766
2796
  /**
2767
- * Series ID
2797
+ * Series public ID
2768
2798
  */
2769
- id: number;
2799
+ id: string;
2770
2800
  };
2771
2801
  query?: never;
2772
2802
  url: '/v1/media/series/{id}/media';
@@ -2809,13 +2839,13 @@ export type RemoveMediaFromSeriesData = {
2809
2839
  body?: never;
2810
2840
  path: {
2811
2841
  /**
2812
- * Series ID
2842
+ * Series public ID
2813
2843
  */
2814
- id: number;
2844
+ id: string;
2815
2845
  /**
2816
- * Media ID
2846
+ * Media public ID
2817
2847
  */
2818
- mediaId: number;
2848
+ mediaId: string;
2819
2849
  };
2820
2850
  query?: never;
2821
2851
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2863,13 +2893,13 @@ export type UpdateSeriesMediaData = {
2863
2893
  };
2864
2894
  path: {
2865
2895
  /**
2866
- * Series ID
2896
+ * Series public ID
2867
2897
  */
2868
- id: number;
2898
+ id: string;
2869
2899
  /**
2870
- * Media ID
2900
+ * Media public ID
2871
2901
  */
2872
- mediaId: number;
2902
+ mediaId: string;
2873
2903
  };
2874
2904
  query?: never;
2875
2905
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2912,7 +2942,7 @@ export type GetCharacterData = {
2912
2942
  body?: never;
2913
2943
  path: {
2914
2944
  /**
2915
- * Internal character ID
2945
+ * Character ID
2916
2946
  */
2917
2947
  id: number;
2918
2948
  };
@@ -3002,9 +3032,9 @@ export type DeleteMediaData = {
3002
3032
  body?: never;
3003
3033
  path: {
3004
3034
  /**
3005
- * Media ID
3035
+ * Media public ID
3006
3036
  */
3007
- id: number;
3037
+ id: string;
3008
3038
  };
3009
3039
  query?: never;
3010
3040
  url: '/v1/media/{id}';
@@ -3047,9 +3077,9 @@ export type GetMediaData = {
3047
3077
  body?: never;
3048
3078
  path: {
3049
3079
  /**
3050
- * Media ID
3080
+ * Media public ID
3051
3081
  */
3052
- id: number;
3082
+ id: string;
3053
3083
  };
3054
3084
  query?: {
3055
3085
  /**
@@ -3097,9 +3127,9 @@ export type UpdateMediaData = {
3097
3127
  body: MediaUpdateRequest;
3098
3128
  path: {
3099
3129
  /**
3100
- * Media ID
3130
+ * Media public ID
3101
3131
  */
3102
- id: number;
3132
+ id: string;
3103
3133
  };
3104
3134
  query?: never;
3105
3135
  url: '/v1/media/{id}';
@@ -3142,9 +3172,9 @@ export type ListEpisodesData = {
3142
3172
  body?: never;
3143
3173
  path: {
3144
3174
  /**
3145
- * ID of the media
3175
+ * Public ID of the media
3146
3176
  */
3147
- mediaId: number;
3177
+ mediaId: string;
3148
3178
  };
3149
3179
  query?: {
3150
3180
  /**
@@ -3196,9 +3226,9 @@ export type CreateEpisodeData = {
3196
3226
  body: EpisodeCreateRequest;
3197
3227
  path: {
3198
3228
  /**
3199
- * ID of the media
3229
+ * Public ID of the media
3200
3230
  */
3201
- mediaId: number;
3231
+ mediaId: string;
3202
3232
  };
3203
3233
  query?: never;
3204
3234
  url: '/v1/media/{mediaId}/episodes';
@@ -3245,9 +3275,9 @@ export type DeleteEpisodeData = {
3245
3275
  body?: never;
3246
3276
  path: {
3247
3277
  /**
3248
- * ID of the media
3278
+ * Public ID of the media
3249
3279
  */
3250
- mediaId: number;
3280
+ mediaId: string;
3251
3281
  /**
3252
3282
  * Episode number
3253
3283
  */
@@ -3294,9 +3324,9 @@ export type GetEpisodeData = {
3294
3324
  body?: never;
3295
3325
  path: {
3296
3326
  /**
3297
- * ID of the media
3327
+ * Public ID of the media
3298
3328
  */
3299
- mediaId: number;
3329
+ mediaId: string;
3300
3330
  /**
3301
3331
  * Episode number
3302
3332
  */
@@ -3343,9 +3373,9 @@ export type UpdateEpisodeData = {
3343
3373
  body: EpisodeUpdateRequest;
3344
3374
  path: {
3345
3375
  /**
3346
- * ID of the media
3376
+ * Public ID of the media
3347
3377
  */
3348
- mediaId: number;
3378
+ mediaId: string;
3349
3379
  /**
3350
3380
  * Episode number
3351
3381
  */
@@ -3392,9 +3422,9 @@ export type ListSegmentsData = {
3392
3422
  body?: never;
3393
3423
  path: {
3394
3424
  /**
3395
- * ID of the media
3425
+ * Public ID of the media
3396
3426
  */
3397
- mediaId: number;
3427
+ mediaId: string;
3398
3428
  /**
3399
3429
  * Episode number
3400
3430
  */
@@ -3456,9 +3486,9 @@ export type CreateSegmentData = {
3456
3486
  body: SegmentCreateRequest;
3457
3487
  path: {
3458
3488
  /**
3459
- * ID of the media
3489
+ * Public ID of the media
3460
3490
  */
3461
- mediaId: number;
3491
+ mediaId: string;
3462
3492
  /**
3463
3493
  * Episode number
3464
3494
  */
@@ -3509,9 +3539,9 @@ export type CreateSegmentsBatchData = {
3509
3539
  body: SegmentBatchCreateRequest;
3510
3540
  path: {
3511
3541
  /**
3512
- * ID of the media
3542
+ * Public ID of the media
3513
3543
  */
3514
- mediaId: number;
3544
+ mediaId: string;
3515
3545
  /**
3516
3546
  * Episode number
3517
3547
  */
@@ -3567,9 +3597,9 @@ export type DeleteSegmentData = {
3567
3597
  body?: never;
3568
3598
  path: {
3569
3599
  /**
3570
- * ID of the media
3600
+ * Public ID of the media
3571
3601
  */
3572
- mediaId: number;
3602
+ mediaId: string;
3573
3603
  /**
3574
3604
  * Episode number
3575
3605
  */
@@ -3620,9 +3650,9 @@ export type GetSegmentData = {
3620
3650
  body?: never;
3621
3651
  path: {
3622
3652
  /**
3623
- * ID of the media
3653
+ * Public ID of the media
3624
3654
  */
3625
- mediaId: number;
3655
+ mediaId: string;
3626
3656
  /**
3627
3657
  * Episode number
3628
3658
  */
@@ -3673,9 +3703,9 @@ export type UpdateSegmentData = {
3673
3703
  body: SegmentUpdateRequest;
3674
3704
  path: {
3675
3705
  /**
3676
- * ID of the media
3706
+ * Public ID of the media
3677
3707
  */
3678
- mediaId: number;
3708
+ mediaId: string;
3679
3709
  /**
3680
3710
  * Episode number
3681
3711
  */
@@ -4285,9 +4315,9 @@ export type DeleteCollectionData = {
4285
4315
  body?: never;
4286
4316
  path: {
4287
4317
  /**
4288
- * Collection ID
4318
+ * Collection public ID
4289
4319
  */
4290
- id: number;
4320
+ id: string;
4291
4321
  };
4292
4322
  query?: never;
4293
4323
  url: '/v1/collections/{id}';
@@ -4330,9 +4360,9 @@ export type GetCollectionData = {
4330
4360
  body?: never;
4331
4361
  path: {
4332
4362
  /**
4333
- * Collection ID
4363
+ * Collection public ID
4334
4364
  */
4335
- id: number;
4365
+ id: string;
4336
4366
  };
4337
4367
  query?: {
4338
4368
  /**
@@ -4387,9 +4417,9 @@ export type UpdateCollectionData = {
4387
4417
  };
4388
4418
  path: {
4389
4419
  /**
4390
- * Collection ID
4420
+ * Collection public ID
4391
4421
  */
4392
- id: number;
4422
+ id: string;
4393
4423
  };
4394
4424
  query?: never;
4395
4425
  url: '/v1/collections/{id}';
@@ -4441,9 +4471,9 @@ export type AddSegmentToCollectionData = {
4441
4471
  };
4442
4472
  path: {
4443
4473
  /**
4444
- * Collection ID
4474
+ * Collection public ID
4445
4475
  */
4446
- id: number;
4476
+ id: string;
4447
4477
  };
4448
4478
  query?: never;
4449
4479
  url: '/v1/collections/{id}/segments';
@@ -4486,9 +4516,9 @@ export type RemoveSegmentFromCollectionData = {
4486
4516
  body?: never;
4487
4517
  path: {
4488
4518
  /**
4489
- * Collection ID
4519
+ * Collection public ID
4490
4520
  */
4491
- id: number;
4521
+ id: string;
4492
4522
  /**
4493
4523
  * Segment ID
4494
4524
  */
@@ -4544,9 +4574,9 @@ export type UpdateCollectionSegmentData = {
4544
4574
  };
4545
4575
  path: {
4546
4576
  /**
4547
- * Collection ID
4577
+ * Collection public ID
4548
4578
  */
4549
- id: number;
4579
+ id: string;
4550
4580
  /**
4551
4581
  * Segment ID
4552
4582
  */
@@ -4593,9 +4623,9 @@ export type SearchCollectionSegmentsData = {
4593
4623
  body?: never;
4594
4624
  path: {
4595
4625
  /**
4596
- * Collection ID
4626
+ * Collection public ID
4597
4627
  */
4598
- id: number;
4628
+ id: string;
4599
4629
  };
4600
4630
  query?: {
4601
4631
  /**
@@ -4647,9 +4677,9 @@ export type GetCollectionStatsData = {
4647
4677
  body?: never;
4648
4678
  path: {
4649
4679
  /**
4650
- * Collection ID
4680
+ * Collection public ID
4651
4681
  */
4652
- id: number;
4682
+ id: string;
4653
4683
  };
4654
4684
  query?: never;
4655
4685
  url: '/v1/collections/{id}/stats';
@@ -5577,4 +5607,80 @@ export type GetAdminMediaAuditRunResponses = {
5577
5607
  };
5578
5608
  };
5579
5609
  export type GetAdminMediaAuditRunResponse = GetAdminMediaAuditRunResponses[keyof GetAdminMediaAuditRunResponses];
5610
+ export type GetAnnouncementData = {
5611
+ body?: never;
5612
+ path?: never;
5613
+ query?: never;
5614
+ url: '/v1/admin/announcement';
5615
+ };
5616
+ export type GetAnnouncementErrors = {
5617
+ /**
5618
+ * Too Many Requests
5619
+ */
5620
+ 429: Error429;
5621
+ /**
5622
+ * Internal Server Error
5623
+ */
5624
+ 500: Error500;
5625
+ };
5626
+ export type GetAnnouncementError = GetAnnouncementErrors[keyof GetAnnouncementErrors];
5627
+ export type GetAnnouncementResponses = {
5628
+ /**
5629
+ * OK
5630
+ */
5631
+ 200: {
5632
+ message: string;
5633
+ type: 'info' | 'warning' | 'maintenance';
5634
+ active: boolean;
5635
+ };
5636
+ /**
5637
+ * No announcement set
5638
+ */
5639
+ 204: void;
5640
+ };
5641
+ export type GetAnnouncementResponse = GetAnnouncementResponses[keyof GetAnnouncementResponses];
5642
+ export type UpdateAnnouncementData = {
5643
+ body: {
5644
+ message: string;
5645
+ type: 'info' | 'warning' | 'maintenance';
5646
+ active: boolean;
5647
+ };
5648
+ path?: never;
5649
+ query?: never;
5650
+ url: '/v1/admin/announcement';
5651
+ };
5652
+ export type UpdateAnnouncementErrors = {
5653
+ /**
5654
+ * Bad Request
5655
+ */
5656
+ 400: Error400;
5657
+ /**
5658
+ * Unauthorized (session)
5659
+ */
5660
+ 401: Error401;
5661
+ /**
5662
+ * Forbidden
5663
+ */
5664
+ 403: Error403;
5665
+ /**
5666
+ * Too Many Requests
5667
+ */
5668
+ 429: Error429;
5669
+ /**
5670
+ * Internal Server Error
5671
+ */
5672
+ 500: Error500;
5673
+ };
5674
+ export type UpdateAnnouncementError = UpdateAnnouncementErrors[keyof UpdateAnnouncementErrors];
5675
+ export type UpdateAnnouncementResponses = {
5676
+ /**
5677
+ * Announcement updated
5678
+ */
5679
+ 200: {
5680
+ message: string;
5681
+ type: 'info' | 'warning' | 'maintenance';
5682
+ active: boolean;
5683
+ };
5684
+ };
5685
+ export type UpdateAnnouncementResponse = UpdateAnnouncementResponses[keyof UpdateAnnouncementResponses];
5580
5686
  //# sourceMappingURL=types.gen.d.ts.map