@brigadasos/nadeshiko-sdk 1.5.0-dev.972aa12 → 1.5.0-dev.9bfc5f7

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;
@@ -1102,6 +1106,10 @@ export type Series = {
1102
1106
  * Series ID
1103
1107
  */
1104
1108
  id: number;
1109
+ /**
1110
+ * Public identifier for the series
1111
+ */
1112
+ publicId: string;
1105
1113
  /**
1106
1114
  * Japanese name of the series
1107
1115
  */
@@ -1518,9 +1526,9 @@ export type ReportTargetMedia = {
1518
1526
  */
1519
1527
  type: 'MEDIA';
1520
1528
  /**
1521
- * Media ID this report targets
1529
+ * Public ID of the media this report targets
1522
1530
  */
1523
- mediaId: number;
1531
+ mediaId: string;
1524
1532
  };
1525
1533
  export type ReportTargetSegmentInput = {
1526
1534
  /**
@@ -1528,9 +1536,9 @@ export type ReportTargetSegmentInput = {
1528
1536
  */
1529
1537
  type: 'SEGMENT';
1530
1538
  /**
1531
- * Media ID this report targets
1539
+ * Public ID of the media this report targets
1532
1540
  */
1533
- mediaId: number;
1541
+ mediaId: string;
1534
1542
  /**
1535
1543
  * Episode number containing the segment
1536
1544
  */
@@ -1550,7 +1558,7 @@ export type CreateReportRequest = {
1550
1558
  /**
1551
1559
  * Reason for the report
1552
1560
  */
1553
- 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';
1554
1562
  /**
1555
1563
  * Optional description with additional details
1556
1564
  */
@@ -1562,9 +1570,9 @@ export type ReportTargetEpisode = {
1562
1570
  */
1563
1571
  type: 'EPISODE';
1564
1572
  /**
1565
- * Media ID this report targets
1573
+ * Public ID of the media this report targets
1566
1574
  */
1567
- mediaId: number;
1575
+ mediaId: string;
1568
1576
  /**
1569
1577
  * Episode number this report targets
1570
1578
  */
@@ -1576,17 +1584,17 @@ export type ReportTargetSegment = {
1576
1584
  */
1577
1585
  type: 'SEGMENT';
1578
1586
  /**
1579
- * Media ID this report targets
1587
+ * Public ID of the media this report targets
1580
1588
  */
1581
- mediaId: number;
1589
+ mediaId: string;
1582
1590
  /**
1583
1591
  * Episode number containing the segment
1584
1592
  */
1585
1593
  episodeNumber?: number;
1586
1594
  /**
1587
- * Segment ID
1595
+ * Segment public ID or UUID
1588
1596
  */
1589
- segmentId: number;
1597
+ segmentId: string;
1590
1598
  };
1591
1599
  export type ReportTarget = ({
1592
1600
  type: 'MEDIA';
@@ -1612,7 +1620,7 @@ export type Report = {
1612
1620
  /**
1613
1621
  * Reason for the report
1614
1622
  */
1615
- 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';
1616
1624
  /**
1617
1625
  * Optional description with additional details
1618
1626
  */
@@ -1719,6 +1727,10 @@ export type Collection = {
1719
1727
  * Collection ID
1720
1728
  */
1721
1729
  id: number;
1730
+ /**
1731
+ * Public identifier for the collection
1732
+ */
1733
+ publicId: string;
1722
1734
  /**
1723
1735
  * Name of the collection
1724
1736
  */
@@ -2616,9 +2628,9 @@ export type DeleteSeriesData = {
2616
2628
  body?: never;
2617
2629
  path: {
2618
2630
  /**
2619
- * Series ID
2631
+ * Series public ID
2620
2632
  */
2621
- id: number;
2633
+ id: string;
2622
2634
  };
2623
2635
  query?: never;
2624
2636
  url: '/v1/media/series/{id}';
@@ -2661,9 +2673,9 @@ export type GetSeriesData = {
2661
2673
  body?: never;
2662
2674
  path: {
2663
2675
  /**
2664
- * Series ID
2676
+ * Series public ID
2665
2677
  */
2666
- id: number;
2678
+ id: string;
2667
2679
  };
2668
2680
  query?: {
2669
2681
  /**
@@ -2724,9 +2736,9 @@ export type UpdateSeriesData = {
2724
2736
  };
2725
2737
  path: {
2726
2738
  /**
2727
- * Series ID
2739
+ * Series public ID
2728
2740
  */
2729
- id: number;
2741
+ id: string;
2730
2742
  };
2731
2743
  query?: never;
2732
2744
  url: '/v1/media/series/{id}';
@@ -2768,9 +2780,9 @@ export type UpdateSeriesResponse = UpdateSeriesResponses[keyof UpdateSeriesRespo
2768
2780
  export type AddMediaToSeriesData = {
2769
2781
  body: {
2770
2782
  /**
2771
- * Media ID to add
2783
+ * Media public ID to add
2772
2784
  */
2773
- mediaId: number;
2785
+ mediaId: string;
2774
2786
  /**
2775
2787
  * Position in the series (1-indexed)
2776
2788
  */
@@ -2778,9 +2790,9 @@ export type AddMediaToSeriesData = {
2778
2790
  };
2779
2791
  path: {
2780
2792
  /**
2781
- * Series ID
2793
+ * Series public ID
2782
2794
  */
2783
- id: number;
2795
+ id: string;
2784
2796
  };
2785
2797
  query?: never;
2786
2798
  url: '/v1/media/series/{id}/media';
@@ -2823,13 +2835,13 @@ export type RemoveMediaFromSeriesData = {
2823
2835
  body?: never;
2824
2836
  path: {
2825
2837
  /**
2826
- * Series ID
2838
+ * Series public ID
2827
2839
  */
2828
- id: number;
2840
+ id: string;
2829
2841
  /**
2830
- * Media ID
2842
+ * Media public ID
2831
2843
  */
2832
- mediaId: number;
2844
+ mediaId: string;
2833
2845
  };
2834
2846
  query?: never;
2835
2847
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2877,13 +2889,13 @@ export type UpdateSeriesMediaData = {
2877
2889
  };
2878
2890
  path: {
2879
2891
  /**
2880
- * Series ID
2892
+ * Series public ID
2881
2893
  */
2882
- id: number;
2894
+ id: string;
2883
2895
  /**
2884
- * Media ID
2896
+ * Media public ID
2885
2897
  */
2886
- mediaId: number;
2898
+ mediaId: string;
2887
2899
  };
2888
2900
  query?: never;
2889
2901
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2926,7 +2938,7 @@ export type GetCharacterData = {
2926
2938
  body?: never;
2927
2939
  path: {
2928
2940
  /**
2929
- * Internal character ID
2941
+ * Character ID
2930
2942
  */
2931
2943
  id: number;
2932
2944
  };
@@ -3016,9 +3028,9 @@ export type DeleteMediaData = {
3016
3028
  body?: never;
3017
3029
  path: {
3018
3030
  /**
3019
- * Media ID
3031
+ * Media public ID
3020
3032
  */
3021
- id: number;
3033
+ id: string;
3022
3034
  };
3023
3035
  query?: never;
3024
3036
  url: '/v1/media/{id}';
@@ -3061,9 +3073,9 @@ export type GetMediaData = {
3061
3073
  body?: never;
3062
3074
  path: {
3063
3075
  /**
3064
- * Media ID
3076
+ * Media public ID
3065
3077
  */
3066
- id: number;
3078
+ id: string;
3067
3079
  };
3068
3080
  query?: {
3069
3081
  /**
@@ -3111,9 +3123,9 @@ export type UpdateMediaData = {
3111
3123
  body: MediaUpdateRequest;
3112
3124
  path: {
3113
3125
  /**
3114
- * Media ID
3126
+ * Media public ID
3115
3127
  */
3116
- id: number;
3128
+ id: string;
3117
3129
  };
3118
3130
  query?: never;
3119
3131
  url: '/v1/media/{id}';
@@ -3156,9 +3168,9 @@ export type ListEpisodesData = {
3156
3168
  body?: never;
3157
3169
  path: {
3158
3170
  /**
3159
- * ID of the media
3171
+ * Public ID of the media
3160
3172
  */
3161
- mediaId: number;
3173
+ mediaId: string;
3162
3174
  };
3163
3175
  query?: {
3164
3176
  /**
@@ -3210,9 +3222,9 @@ export type CreateEpisodeData = {
3210
3222
  body: EpisodeCreateRequest;
3211
3223
  path: {
3212
3224
  /**
3213
- * ID of the media
3225
+ * Public ID of the media
3214
3226
  */
3215
- mediaId: number;
3227
+ mediaId: string;
3216
3228
  };
3217
3229
  query?: never;
3218
3230
  url: '/v1/media/{mediaId}/episodes';
@@ -3259,9 +3271,9 @@ export type DeleteEpisodeData = {
3259
3271
  body?: never;
3260
3272
  path: {
3261
3273
  /**
3262
- * ID of the media
3274
+ * Public ID of the media
3263
3275
  */
3264
- mediaId: number;
3276
+ mediaId: string;
3265
3277
  /**
3266
3278
  * Episode number
3267
3279
  */
@@ -3308,9 +3320,9 @@ export type GetEpisodeData = {
3308
3320
  body?: never;
3309
3321
  path: {
3310
3322
  /**
3311
- * ID of the media
3323
+ * Public ID of the media
3312
3324
  */
3313
- mediaId: number;
3325
+ mediaId: string;
3314
3326
  /**
3315
3327
  * Episode number
3316
3328
  */
@@ -3357,9 +3369,9 @@ export type UpdateEpisodeData = {
3357
3369
  body: EpisodeUpdateRequest;
3358
3370
  path: {
3359
3371
  /**
3360
- * ID of the media
3372
+ * Public ID of the media
3361
3373
  */
3362
- mediaId: number;
3374
+ mediaId: string;
3363
3375
  /**
3364
3376
  * Episode number
3365
3377
  */
@@ -3406,9 +3418,9 @@ export type ListSegmentsData = {
3406
3418
  body?: never;
3407
3419
  path: {
3408
3420
  /**
3409
- * ID of the media
3421
+ * Public ID of the media
3410
3422
  */
3411
- mediaId: number;
3423
+ mediaId: string;
3412
3424
  /**
3413
3425
  * Episode number
3414
3426
  */
@@ -3470,9 +3482,9 @@ export type CreateSegmentData = {
3470
3482
  body: SegmentCreateRequest;
3471
3483
  path: {
3472
3484
  /**
3473
- * ID of the media
3485
+ * Public ID of the media
3474
3486
  */
3475
- mediaId: number;
3487
+ mediaId: string;
3476
3488
  /**
3477
3489
  * Episode number
3478
3490
  */
@@ -3523,9 +3535,9 @@ export type CreateSegmentsBatchData = {
3523
3535
  body: SegmentBatchCreateRequest;
3524
3536
  path: {
3525
3537
  /**
3526
- * ID of the media
3538
+ * Public ID of the media
3527
3539
  */
3528
- mediaId: number;
3540
+ mediaId: string;
3529
3541
  /**
3530
3542
  * Episode number
3531
3543
  */
@@ -3581,9 +3593,9 @@ export type DeleteSegmentData = {
3581
3593
  body?: never;
3582
3594
  path: {
3583
3595
  /**
3584
- * ID of the media
3596
+ * Public ID of the media
3585
3597
  */
3586
- mediaId: number;
3598
+ mediaId: string;
3587
3599
  /**
3588
3600
  * Episode number
3589
3601
  */
@@ -3634,9 +3646,9 @@ export type GetSegmentData = {
3634
3646
  body?: never;
3635
3647
  path: {
3636
3648
  /**
3637
- * ID of the media
3649
+ * Public ID of the media
3638
3650
  */
3639
- mediaId: number;
3651
+ mediaId: string;
3640
3652
  /**
3641
3653
  * Episode number
3642
3654
  */
@@ -3687,9 +3699,9 @@ export type UpdateSegmentData = {
3687
3699
  body: SegmentUpdateRequest;
3688
3700
  path: {
3689
3701
  /**
3690
- * ID of the media
3702
+ * Public ID of the media
3691
3703
  */
3692
- mediaId: number;
3704
+ mediaId: string;
3693
3705
  /**
3694
3706
  * Episode number
3695
3707
  */
@@ -4299,9 +4311,9 @@ export type DeleteCollectionData = {
4299
4311
  body?: never;
4300
4312
  path: {
4301
4313
  /**
4302
- * Collection ID
4314
+ * Collection public ID
4303
4315
  */
4304
- id: number;
4316
+ id: string;
4305
4317
  };
4306
4318
  query?: never;
4307
4319
  url: '/v1/collections/{id}';
@@ -4344,9 +4356,9 @@ export type GetCollectionData = {
4344
4356
  body?: never;
4345
4357
  path: {
4346
4358
  /**
4347
- * Collection ID
4359
+ * Collection public ID
4348
4360
  */
4349
- id: number;
4361
+ id: string;
4350
4362
  };
4351
4363
  query?: {
4352
4364
  /**
@@ -4401,9 +4413,9 @@ export type UpdateCollectionData = {
4401
4413
  };
4402
4414
  path: {
4403
4415
  /**
4404
- * Collection ID
4416
+ * Collection public ID
4405
4417
  */
4406
- id: number;
4418
+ id: string;
4407
4419
  };
4408
4420
  query?: never;
4409
4421
  url: '/v1/collections/{id}';
@@ -4455,9 +4467,9 @@ export type AddSegmentToCollectionData = {
4455
4467
  };
4456
4468
  path: {
4457
4469
  /**
4458
- * Collection ID
4470
+ * Collection public ID
4459
4471
  */
4460
- id: number;
4472
+ id: string;
4461
4473
  };
4462
4474
  query?: never;
4463
4475
  url: '/v1/collections/{id}/segments';
@@ -4500,9 +4512,9 @@ export type RemoveSegmentFromCollectionData = {
4500
4512
  body?: never;
4501
4513
  path: {
4502
4514
  /**
4503
- * Collection ID
4515
+ * Collection public ID
4504
4516
  */
4505
- id: number;
4517
+ id: string;
4506
4518
  /**
4507
4519
  * Segment ID
4508
4520
  */
@@ -4558,9 +4570,9 @@ export type UpdateCollectionSegmentData = {
4558
4570
  };
4559
4571
  path: {
4560
4572
  /**
4561
- * Collection ID
4573
+ * Collection public ID
4562
4574
  */
4563
- id: number;
4575
+ id: string;
4564
4576
  /**
4565
4577
  * Segment ID
4566
4578
  */
@@ -4607,9 +4619,9 @@ export type SearchCollectionSegmentsData = {
4607
4619
  body?: never;
4608
4620
  path: {
4609
4621
  /**
4610
- * Collection ID
4622
+ * Collection public ID
4611
4623
  */
4612
- id: number;
4624
+ id: string;
4613
4625
  };
4614
4626
  query?: {
4615
4627
  /**
@@ -4661,9 +4673,9 @@ export type GetCollectionStatsData = {
4661
4673
  body?: never;
4662
4674
  path: {
4663
4675
  /**
4664
- * Collection ID
4676
+ * Collection public ID
4665
4677
  */
4666
- id: number;
4678
+ id: string;
4667
4679
  };
4668
4680
  query?: never;
4669
4681
  url: '/v1/collections/{id}/stats';
@@ -5591,4 +5603,80 @@ export type GetAdminMediaAuditRunResponses = {
5591
5603
  };
5592
5604
  };
5593
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];
5594
5682
  //# sourceMappingURL=types.gen.d.ts.map