@brigadasos/nadeshiko-sdk 1.5.0-dev.45bdd31 → 1.5.0-dev.50b8295

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
@@ -402,7 +406,7 @@ export type SearchResponse = {
402
406
  segments: Array<Segment>;
403
407
  includes: {
404
408
  /**
405
- * Media objects keyed by mediaId
409
+ * Media objects keyed by media publicId
406
410
  */
407
411
  media: {
408
412
  [key: string]: Media;
@@ -643,7 +647,7 @@ export type SearchStatsResponse = {
643
647
  categories: Array<CategoryCount>;
644
648
  includes: {
645
649
  /**
646
- * Media objects keyed by mediaId
650
+ * Media objects keyed by media publicId
647
651
  */
648
652
  media: {
649
653
  [key: string]: Media;
@@ -735,6 +739,20 @@ export type OpaqueCursorPagination = {
735
739
  export type MediaListResponse = {
736
740
  media: Array<Media>;
737
741
  pagination: OpaqueCursorPagination;
742
+ stats: {
743
+ /**
744
+ * Total number of media across all pages
745
+ */
746
+ totalMedia: number;
747
+ /**
748
+ * Total number of non-deleted segments
749
+ */
750
+ totalSegments: number;
751
+ /**
752
+ * Total number of episodes
753
+ */
754
+ totalEpisodes: number;
755
+ };
738
756
  };
739
757
  /**
740
758
  * Character data for creating/updating media
@@ -1088,6 +1106,10 @@ export type Series = {
1088
1106
  * Series ID
1089
1107
  */
1090
1108
  id: number;
1109
+ /**
1110
+ * Public identifier for the series
1111
+ */
1112
+ publicId: string;
1091
1113
  /**
1092
1114
  * Japanese name of the series
1093
1115
  */
@@ -1504,9 +1526,9 @@ export type ReportTargetMedia = {
1504
1526
  */
1505
1527
  type: 'MEDIA';
1506
1528
  /**
1507
- * Media ID this report targets
1529
+ * Public ID of the media this report targets
1508
1530
  */
1509
- mediaId: number;
1531
+ mediaId: string;
1510
1532
  };
1511
1533
  export type ReportTargetSegmentInput = {
1512
1534
  /**
@@ -1514,9 +1536,9 @@ export type ReportTargetSegmentInput = {
1514
1536
  */
1515
1537
  type: 'SEGMENT';
1516
1538
  /**
1517
- * Media ID this report targets
1539
+ * Public ID of the media this report targets
1518
1540
  */
1519
- mediaId: number;
1541
+ mediaId: string;
1520
1542
  /**
1521
1543
  * Episode number containing the segment
1522
1544
  */
@@ -1536,7 +1558,7 @@ export type CreateReportRequest = {
1536
1558
  /**
1537
1559
  * Reason for the report
1538
1560
  */
1539
- reason: 'WRONG_TRANSLATION' | 'WRONG_TIMING' | 'WRONG_AUDIO' | 'NSFW_NOT_TAGGED' | 'DUPLICATE_SEGMENT' | 'WRONG_METADATA' | 'MISSING_EPISODES' | 'WRONG_COVER_IMAGE' | 'INAPPROPRIATE_CONTENT' | 'OTHER';
1561
+ 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
1562
  /**
1541
1563
  * Optional description with additional details
1542
1564
  */
@@ -1548,9 +1570,9 @@ export type ReportTargetEpisode = {
1548
1570
  */
1549
1571
  type: 'EPISODE';
1550
1572
  /**
1551
- * Media ID this report targets
1573
+ * Public ID of the media this report targets
1552
1574
  */
1553
- mediaId: number;
1575
+ mediaId: string;
1554
1576
  /**
1555
1577
  * Episode number this report targets
1556
1578
  */
@@ -1562,17 +1584,17 @@ export type ReportTargetSegment = {
1562
1584
  */
1563
1585
  type: 'SEGMENT';
1564
1586
  /**
1565
- * Media ID this report targets
1587
+ * Public ID of the media this report targets
1566
1588
  */
1567
- mediaId: number;
1589
+ mediaId: string;
1568
1590
  /**
1569
1591
  * Episode number containing the segment
1570
1592
  */
1571
1593
  episodeNumber?: number;
1572
1594
  /**
1573
- * Segment ID
1595
+ * Segment public ID or UUID
1574
1596
  */
1575
- segmentId: number;
1597
+ segmentId: string;
1576
1598
  };
1577
1599
  export type ReportTarget = ({
1578
1600
  type: 'MEDIA';
@@ -1598,7 +1620,7 @@ export type Report = {
1598
1620
  /**
1599
1621
  * Reason for the report
1600
1622
  */
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';
1623
+ 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
1624
  /**
1603
1625
  * Optional description with additional details
1604
1626
  */
@@ -1705,6 +1727,10 @@ export type Collection = {
1705
1727
  * Collection ID
1706
1728
  */
1707
1729
  id: number;
1730
+ /**
1731
+ * Public identifier for the collection
1732
+ */
1733
+ publicId: string;
1708
1734
  /**
1709
1735
  * Name of the collection
1710
1736
  */
@@ -2602,9 +2628,9 @@ export type DeleteSeriesData = {
2602
2628
  body?: never;
2603
2629
  path: {
2604
2630
  /**
2605
- * Series ID
2631
+ * Series public ID
2606
2632
  */
2607
- id: number;
2633
+ id: string;
2608
2634
  };
2609
2635
  query?: never;
2610
2636
  url: '/v1/media/series/{id}';
@@ -2647,9 +2673,9 @@ export type GetSeriesData = {
2647
2673
  body?: never;
2648
2674
  path: {
2649
2675
  /**
2650
- * Series ID
2676
+ * Series public ID
2651
2677
  */
2652
- id: number;
2678
+ id: string;
2653
2679
  };
2654
2680
  query?: {
2655
2681
  /**
@@ -2710,9 +2736,9 @@ export type UpdateSeriesData = {
2710
2736
  };
2711
2737
  path: {
2712
2738
  /**
2713
- * Series ID
2739
+ * Series public ID
2714
2740
  */
2715
- id: number;
2741
+ id: string;
2716
2742
  };
2717
2743
  query?: never;
2718
2744
  url: '/v1/media/series/{id}';
@@ -2754,9 +2780,9 @@ export type UpdateSeriesResponse = UpdateSeriesResponses[keyof UpdateSeriesRespo
2754
2780
  export type AddMediaToSeriesData = {
2755
2781
  body: {
2756
2782
  /**
2757
- * Media ID to add
2783
+ * Media public ID to add
2758
2784
  */
2759
- mediaId: number;
2785
+ mediaId: string;
2760
2786
  /**
2761
2787
  * Position in the series (1-indexed)
2762
2788
  */
@@ -2764,9 +2790,9 @@ export type AddMediaToSeriesData = {
2764
2790
  };
2765
2791
  path: {
2766
2792
  /**
2767
- * Series ID
2793
+ * Series public ID
2768
2794
  */
2769
- id: number;
2795
+ id: string;
2770
2796
  };
2771
2797
  query?: never;
2772
2798
  url: '/v1/media/series/{id}/media';
@@ -2809,13 +2835,13 @@ export type RemoveMediaFromSeriesData = {
2809
2835
  body?: never;
2810
2836
  path: {
2811
2837
  /**
2812
- * Series ID
2838
+ * Series public ID
2813
2839
  */
2814
- id: number;
2840
+ id: string;
2815
2841
  /**
2816
- * Media ID
2842
+ * Media public ID
2817
2843
  */
2818
- mediaId: number;
2844
+ mediaId: string;
2819
2845
  };
2820
2846
  query?: never;
2821
2847
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2863,13 +2889,13 @@ export type UpdateSeriesMediaData = {
2863
2889
  };
2864
2890
  path: {
2865
2891
  /**
2866
- * Series ID
2892
+ * Series public ID
2867
2893
  */
2868
- id: number;
2894
+ id: string;
2869
2895
  /**
2870
- * Media ID
2896
+ * Media public ID
2871
2897
  */
2872
- mediaId: number;
2898
+ mediaId: string;
2873
2899
  };
2874
2900
  query?: never;
2875
2901
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2912,7 +2938,7 @@ export type GetCharacterData = {
2912
2938
  body?: never;
2913
2939
  path: {
2914
2940
  /**
2915
- * Internal character ID
2941
+ * Character ID
2916
2942
  */
2917
2943
  id: number;
2918
2944
  };
@@ -3002,9 +3028,9 @@ export type DeleteMediaData = {
3002
3028
  body?: never;
3003
3029
  path: {
3004
3030
  /**
3005
- * Media ID
3031
+ * Media public ID
3006
3032
  */
3007
- id: number;
3033
+ id: string;
3008
3034
  };
3009
3035
  query?: never;
3010
3036
  url: '/v1/media/{id}';
@@ -3047,9 +3073,9 @@ export type GetMediaData = {
3047
3073
  body?: never;
3048
3074
  path: {
3049
3075
  /**
3050
- * Media ID
3076
+ * Media public ID
3051
3077
  */
3052
- id: number;
3078
+ id: string;
3053
3079
  };
3054
3080
  query?: {
3055
3081
  /**
@@ -3097,9 +3123,9 @@ export type UpdateMediaData = {
3097
3123
  body: MediaUpdateRequest;
3098
3124
  path: {
3099
3125
  /**
3100
- * Media ID
3126
+ * Media public ID
3101
3127
  */
3102
- id: number;
3128
+ id: string;
3103
3129
  };
3104
3130
  query?: never;
3105
3131
  url: '/v1/media/{id}';
@@ -3142,9 +3168,9 @@ export type ListEpisodesData = {
3142
3168
  body?: never;
3143
3169
  path: {
3144
3170
  /**
3145
- * ID of the media
3171
+ * Public ID of the media
3146
3172
  */
3147
- mediaId: number;
3173
+ mediaId: string;
3148
3174
  };
3149
3175
  query?: {
3150
3176
  /**
@@ -3196,9 +3222,9 @@ export type CreateEpisodeData = {
3196
3222
  body: EpisodeCreateRequest;
3197
3223
  path: {
3198
3224
  /**
3199
- * ID of the media
3225
+ * Public ID of the media
3200
3226
  */
3201
- mediaId: number;
3227
+ mediaId: string;
3202
3228
  };
3203
3229
  query?: never;
3204
3230
  url: '/v1/media/{mediaId}/episodes';
@@ -3245,9 +3271,9 @@ export type DeleteEpisodeData = {
3245
3271
  body?: never;
3246
3272
  path: {
3247
3273
  /**
3248
- * ID of the media
3274
+ * Public ID of the media
3249
3275
  */
3250
- mediaId: number;
3276
+ mediaId: string;
3251
3277
  /**
3252
3278
  * Episode number
3253
3279
  */
@@ -3294,9 +3320,9 @@ export type GetEpisodeData = {
3294
3320
  body?: never;
3295
3321
  path: {
3296
3322
  /**
3297
- * ID of the media
3323
+ * Public ID of the media
3298
3324
  */
3299
- mediaId: number;
3325
+ mediaId: string;
3300
3326
  /**
3301
3327
  * Episode number
3302
3328
  */
@@ -3343,9 +3369,9 @@ export type UpdateEpisodeData = {
3343
3369
  body: EpisodeUpdateRequest;
3344
3370
  path: {
3345
3371
  /**
3346
- * ID of the media
3372
+ * Public ID of the media
3347
3373
  */
3348
- mediaId: number;
3374
+ mediaId: string;
3349
3375
  /**
3350
3376
  * Episode number
3351
3377
  */
@@ -3392,9 +3418,9 @@ export type ListSegmentsData = {
3392
3418
  body?: never;
3393
3419
  path: {
3394
3420
  /**
3395
- * ID of the media
3421
+ * Public ID of the media
3396
3422
  */
3397
- mediaId: number;
3423
+ mediaId: string;
3398
3424
  /**
3399
3425
  * Episode number
3400
3426
  */
@@ -3456,9 +3482,9 @@ export type CreateSegmentData = {
3456
3482
  body: SegmentCreateRequest;
3457
3483
  path: {
3458
3484
  /**
3459
- * ID of the media
3485
+ * Public ID of the media
3460
3486
  */
3461
- mediaId: number;
3487
+ mediaId: string;
3462
3488
  /**
3463
3489
  * Episode number
3464
3490
  */
@@ -3509,9 +3535,9 @@ export type CreateSegmentsBatchData = {
3509
3535
  body: SegmentBatchCreateRequest;
3510
3536
  path: {
3511
3537
  /**
3512
- * ID of the media
3538
+ * Public ID of the media
3513
3539
  */
3514
- mediaId: number;
3540
+ mediaId: string;
3515
3541
  /**
3516
3542
  * Episode number
3517
3543
  */
@@ -3567,9 +3593,9 @@ export type DeleteSegmentData = {
3567
3593
  body?: never;
3568
3594
  path: {
3569
3595
  /**
3570
- * ID of the media
3596
+ * Public ID of the media
3571
3597
  */
3572
- mediaId: number;
3598
+ mediaId: string;
3573
3599
  /**
3574
3600
  * Episode number
3575
3601
  */
@@ -3620,9 +3646,9 @@ export type GetSegmentData = {
3620
3646
  body?: never;
3621
3647
  path: {
3622
3648
  /**
3623
- * ID of the media
3649
+ * Public ID of the media
3624
3650
  */
3625
- mediaId: number;
3651
+ mediaId: string;
3626
3652
  /**
3627
3653
  * Episode number
3628
3654
  */
@@ -3673,9 +3699,9 @@ export type UpdateSegmentData = {
3673
3699
  body: SegmentUpdateRequest;
3674
3700
  path: {
3675
3701
  /**
3676
- * ID of the media
3702
+ * Public ID of the media
3677
3703
  */
3678
- mediaId: number;
3704
+ mediaId: string;
3679
3705
  /**
3680
3706
  * Episode number
3681
3707
  */
@@ -4285,9 +4311,9 @@ export type DeleteCollectionData = {
4285
4311
  body?: never;
4286
4312
  path: {
4287
4313
  /**
4288
- * Collection ID
4314
+ * Collection public ID
4289
4315
  */
4290
- id: number;
4316
+ id: string;
4291
4317
  };
4292
4318
  query?: never;
4293
4319
  url: '/v1/collections/{id}';
@@ -4330,9 +4356,9 @@ export type GetCollectionData = {
4330
4356
  body?: never;
4331
4357
  path: {
4332
4358
  /**
4333
- * Collection ID
4359
+ * Collection public ID
4334
4360
  */
4335
- id: number;
4361
+ id: string;
4336
4362
  };
4337
4363
  query?: {
4338
4364
  /**
@@ -4387,9 +4413,9 @@ export type UpdateCollectionData = {
4387
4413
  };
4388
4414
  path: {
4389
4415
  /**
4390
- * Collection ID
4416
+ * Collection public ID
4391
4417
  */
4392
- id: number;
4418
+ id: string;
4393
4419
  };
4394
4420
  query?: never;
4395
4421
  url: '/v1/collections/{id}';
@@ -4441,9 +4467,9 @@ export type AddSegmentToCollectionData = {
4441
4467
  };
4442
4468
  path: {
4443
4469
  /**
4444
- * Collection ID
4470
+ * Collection public ID
4445
4471
  */
4446
- id: number;
4472
+ id: string;
4447
4473
  };
4448
4474
  query?: never;
4449
4475
  url: '/v1/collections/{id}/segments';
@@ -4486,9 +4512,9 @@ export type RemoveSegmentFromCollectionData = {
4486
4512
  body?: never;
4487
4513
  path: {
4488
4514
  /**
4489
- * Collection ID
4515
+ * Collection public ID
4490
4516
  */
4491
- id: number;
4517
+ id: string;
4492
4518
  /**
4493
4519
  * Segment ID
4494
4520
  */
@@ -4544,9 +4570,9 @@ export type UpdateCollectionSegmentData = {
4544
4570
  };
4545
4571
  path: {
4546
4572
  /**
4547
- * Collection ID
4573
+ * Collection public ID
4548
4574
  */
4549
- id: number;
4575
+ id: string;
4550
4576
  /**
4551
4577
  * Segment ID
4552
4578
  */
@@ -4593,9 +4619,9 @@ export type SearchCollectionSegmentsData = {
4593
4619
  body?: never;
4594
4620
  path: {
4595
4621
  /**
4596
- * Collection ID
4622
+ * Collection public ID
4597
4623
  */
4598
- id: number;
4624
+ id: string;
4599
4625
  };
4600
4626
  query?: {
4601
4627
  /**
@@ -4647,9 +4673,9 @@ export type GetCollectionStatsData = {
4647
4673
  body?: never;
4648
4674
  path: {
4649
4675
  /**
4650
- * Collection ID
4676
+ * Collection public ID
4651
4677
  */
4652
- id: number;
4678
+ id: string;
4653
4679
  };
4654
4680
  query?: never;
4655
4681
  url: '/v1/collections/{id}/stats';
@@ -5577,4 +5603,80 @@ export type GetAdminMediaAuditRunResponses = {
5577
5603
  };
5578
5604
  };
5579
5605
  export type GetAdminMediaAuditRunResponse = GetAdminMediaAuditRunResponses[keyof GetAdminMediaAuditRunResponses];
5606
+ export type GetAnnouncementData = {
5607
+ body?: never;
5608
+ path?: never;
5609
+ query?: never;
5610
+ url: '/v1/admin/announcement';
5611
+ };
5612
+ export type GetAnnouncementErrors = {
5613
+ /**
5614
+ * Too Many Requests
5615
+ */
5616
+ 429: Error429;
5617
+ /**
5618
+ * Internal Server Error
5619
+ */
5620
+ 500: Error500;
5621
+ };
5622
+ export type GetAnnouncementError = GetAnnouncementErrors[keyof GetAnnouncementErrors];
5623
+ export type GetAnnouncementResponses = {
5624
+ /**
5625
+ * OK
5626
+ */
5627
+ 200: {
5628
+ message: string;
5629
+ type: 'info' | 'warning' | 'maintenance';
5630
+ active: boolean;
5631
+ };
5632
+ /**
5633
+ * No announcement set
5634
+ */
5635
+ 204: void;
5636
+ };
5637
+ export type GetAnnouncementResponse = GetAnnouncementResponses[keyof GetAnnouncementResponses];
5638
+ export type UpdateAnnouncementData = {
5639
+ body: {
5640
+ message: string;
5641
+ type: 'info' | 'warning' | 'maintenance';
5642
+ active: boolean;
5643
+ };
5644
+ path?: never;
5645
+ query?: never;
5646
+ url: '/v1/admin/announcement';
5647
+ };
5648
+ export type UpdateAnnouncementErrors = {
5649
+ /**
5650
+ * Bad Request
5651
+ */
5652
+ 400: Error400;
5653
+ /**
5654
+ * Unauthorized (session)
5655
+ */
5656
+ 401: Error401;
5657
+ /**
5658
+ * Forbidden
5659
+ */
5660
+ 403: Error403;
5661
+ /**
5662
+ * Too Many Requests
5663
+ */
5664
+ 429: Error429;
5665
+ /**
5666
+ * Internal Server Error
5667
+ */
5668
+ 500: Error500;
5669
+ };
5670
+ export type UpdateAnnouncementError = UpdateAnnouncementErrors[keyof UpdateAnnouncementErrors];
5671
+ export type UpdateAnnouncementResponses = {
5672
+ /**
5673
+ * Announcement updated
5674
+ */
5675
+ 200: {
5676
+ message: string;
5677
+ type: 'info' | 'warning' | 'maintenance';
5678
+ active: boolean;
5679
+ };
5680
+ };
5681
+ export type UpdateAnnouncementResponse = UpdateAnnouncementResponses[keyof UpdateAnnouncementResponses];
5580
5682
  //# sourceMappingURL=types.gen.d.ts.map