@brigadasos/nadeshiko-sdk 1.5.0-dev.f6a0c1e → 1.5.0-dev.f73aa53

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;
@@ -843,7 +851,7 @@ export type MediaCreateRequest = {
843
851
  /**
844
852
  * Animation studio that produced the media
845
853
  */
846
- studio: string;
854
+ studio?: string;
847
855
  /**
848
856
  * Airing season label for the media
849
857
  */
@@ -1102,6 +1110,10 @@ export type Series = {
1102
1110
  * Series ID
1103
1111
  */
1104
1112
  id: number;
1113
+ /**
1114
+ * Public identifier for the series
1115
+ */
1116
+ publicId: string;
1105
1117
  /**
1106
1118
  * Japanese name of the series
1107
1119
  */
@@ -1518,9 +1530,9 @@ export type ReportTargetMedia = {
1518
1530
  */
1519
1531
  type: 'MEDIA';
1520
1532
  /**
1521
- * Media ID this report targets
1533
+ * Public ID of the media this report targets
1522
1534
  */
1523
- mediaId: number;
1535
+ mediaId: string;
1524
1536
  };
1525
1537
  export type ReportTargetSegmentInput = {
1526
1538
  /**
@@ -1528,9 +1540,9 @@ export type ReportTargetSegmentInput = {
1528
1540
  */
1529
1541
  type: 'SEGMENT';
1530
1542
  /**
1531
- * Media ID this report targets
1543
+ * Public ID of the media this report targets
1532
1544
  */
1533
- mediaId: number;
1545
+ mediaId: string;
1534
1546
  /**
1535
1547
  * Episode number containing the segment
1536
1548
  */
@@ -1550,7 +1562,7 @@ export type CreateReportRequest = {
1550
1562
  /**
1551
1563
  * Reason for the report
1552
1564
  */
1553
- 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' | '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';
1554
1566
  /**
1555
1567
  * Optional description with additional details
1556
1568
  */
@@ -1562,9 +1574,9 @@ export type ReportTargetEpisode = {
1562
1574
  */
1563
1575
  type: 'EPISODE';
1564
1576
  /**
1565
- * Media ID this report targets
1577
+ * Public ID of the media this report targets
1566
1578
  */
1567
- mediaId: number;
1579
+ mediaId: string;
1568
1580
  /**
1569
1581
  * Episode number this report targets
1570
1582
  */
@@ -1576,17 +1588,17 @@ export type ReportTargetSegment = {
1576
1588
  */
1577
1589
  type: 'SEGMENT';
1578
1590
  /**
1579
- * Media ID this report targets
1591
+ * Public ID of the media this report targets
1580
1592
  */
1581
- mediaId: number;
1593
+ mediaId: string;
1582
1594
  /**
1583
1595
  * Episode number containing the segment
1584
1596
  */
1585
1597
  episodeNumber?: number;
1586
1598
  /**
1587
- * Segment ID
1599
+ * Segment public ID or UUID
1588
1600
  */
1589
- segmentId: number;
1601
+ segmentId: string;
1590
1602
  };
1591
1603
  export type ReportTarget = ({
1592
1604
  type: 'MEDIA';
@@ -1612,7 +1624,7 @@ export type Report = {
1612
1624
  /**
1613
1625
  * Reason for the report
1614
1626
  */
1615
- 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' | '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';
1616
1628
  /**
1617
1629
  * Optional description with additional details
1618
1630
  */
@@ -1719,6 +1731,10 @@ export type Collection = {
1719
1731
  * Collection ID
1720
1732
  */
1721
1733
  id: number;
1734
+ /**
1735
+ * Public identifier for the collection
1736
+ */
1737
+ publicId: string;
1722
1738
  /**
1723
1739
  * Name of the collection
1724
1740
  */
@@ -2616,9 +2632,9 @@ export type DeleteSeriesData = {
2616
2632
  body?: never;
2617
2633
  path: {
2618
2634
  /**
2619
- * Series ID
2635
+ * Series public ID
2620
2636
  */
2621
- id: number;
2637
+ id: string;
2622
2638
  };
2623
2639
  query?: never;
2624
2640
  url: '/v1/media/series/{id}';
@@ -2661,9 +2677,9 @@ export type GetSeriesData = {
2661
2677
  body?: never;
2662
2678
  path: {
2663
2679
  /**
2664
- * Series ID
2680
+ * Series public ID
2665
2681
  */
2666
- id: number;
2682
+ id: string;
2667
2683
  };
2668
2684
  query?: {
2669
2685
  /**
@@ -2724,9 +2740,9 @@ export type UpdateSeriesData = {
2724
2740
  };
2725
2741
  path: {
2726
2742
  /**
2727
- * Series ID
2743
+ * Series public ID
2728
2744
  */
2729
- id: number;
2745
+ id: string;
2730
2746
  };
2731
2747
  query?: never;
2732
2748
  url: '/v1/media/series/{id}';
@@ -2768,9 +2784,9 @@ export type UpdateSeriesResponse = UpdateSeriesResponses[keyof UpdateSeriesRespo
2768
2784
  export type AddMediaToSeriesData = {
2769
2785
  body: {
2770
2786
  /**
2771
- * Media ID to add
2787
+ * Media public ID to add
2772
2788
  */
2773
- mediaId: number;
2789
+ mediaId: string;
2774
2790
  /**
2775
2791
  * Position in the series (1-indexed)
2776
2792
  */
@@ -2778,9 +2794,9 @@ export type AddMediaToSeriesData = {
2778
2794
  };
2779
2795
  path: {
2780
2796
  /**
2781
- * Series ID
2797
+ * Series public ID
2782
2798
  */
2783
- id: number;
2799
+ id: string;
2784
2800
  };
2785
2801
  query?: never;
2786
2802
  url: '/v1/media/series/{id}/media';
@@ -2823,13 +2839,13 @@ export type RemoveMediaFromSeriesData = {
2823
2839
  body?: never;
2824
2840
  path: {
2825
2841
  /**
2826
- * Series ID
2842
+ * Series public ID
2827
2843
  */
2828
- id: number;
2844
+ id: string;
2829
2845
  /**
2830
- * Media ID
2846
+ * Media public ID
2831
2847
  */
2832
- mediaId: number;
2848
+ mediaId: string;
2833
2849
  };
2834
2850
  query?: never;
2835
2851
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2877,13 +2893,13 @@ export type UpdateSeriesMediaData = {
2877
2893
  };
2878
2894
  path: {
2879
2895
  /**
2880
- * Series ID
2896
+ * Series public ID
2881
2897
  */
2882
- id: number;
2898
+ id: string;
2883
2899
  /**
2884
- * Media ID
2900
+ * Media public ID
2885
2901
  */
2886
- mediaId: number;
2902
+ mediaId: string;
2887
2903
  };
2888
2904
  query?: never;
2889
2905
  url: '/v1/media/series/{id}/media/{mediaId}';
@@ -2926,7 +2942,7 @@ export type GetCharacterData = {
2926
2942
  body?: never;
2927
2943
  path: {
2928
2944
  /**
2929
- * Internal character ID
2945
+ * Character ID
2930
2946
  */
2931
2947
  id: number;
2932
2948
  };
@@ -3016,9 +3032,9 @@ export type DeleteMediaData = {
3016
3032
  body?: never;
3017
3033
  path: {
3018
3034
  /**
3019
- * Media ID
3035
+ * Media public ID
3020
3036
  */
3021
- id: number;
3037
+ id: string;
3022
3038
  };
3023
3039
  query?: never;
3024
3040
  url: '/v1/media/{id}';
@@ -3061,9 +3077,9 @@ export type GetMediaData = {
3061
3077
  body?: never;
3062
3078
  path: {
3063
3079
  /**
3064
- * Media ID
3080
+ * Media public ID
3065
3081
  */
3066
- id: number;
3082
+ id: string;
3067
3083
  };
3068
3084
  query?: {
3069
3085
  /**
@@ -3111,9 +3127,9 @@ export type UpdateMediaData = {
3111
3127
  body: MediaUpdateRequest;
3112
3128
  path: {
3113
3129
  /**
3114
- * Media ID
3130
+ * Media public ID
3115
3131
  */
3116
- id: number;
3132
+ id: string;
3117
3133
  };
3118
3134
  query?: never;
3119
3135
  url: '/v1/media/{id}';
@@ -3156,9 +3172,9 @@ export type ListEpisodesData = {
3156
3172
  body?: never;
3157
3173
  path: {
3158
3174
  /**
3159
- * ID of the media
3175
+ * Public ID of the media
3160
3176
  */
3161
- mediaId: number;
3177
+ mediaId: string;
3162
3178
  };
3163
3179
  query?: {
3164
3180
  /**
@@ -3210,9 +3226,9 @@ export type CreateEpisodeData = {
3210
3226
  body: EpisodeCreateRequest;
3211
3227
  path: {
3212
3228
  /**
3213
- * ID of the media
3229
+ * Public ID of the media
3214
3230
  */
3215
- mediaId: number;
3231
+ mediaId: string;
3216
3232
  };
3217
3233
  query?: never;
3218
3234
  url: '/v1/media/{mediaId}/episodes';
@@ -3259,9 +3275,9 @@ export type DeleteEpisodeData = {
3259
3275
  body?: never;
3260
3276
  path: {
3261
3277
  /**
3262
- * ID of the media
3278
+ * Public ID of the media
3263
3279
  */
3264
- mediaId: number;
3280
+ mediaId: string;
3265
3281
  /**
3266
3282
  * Episode number
3267
3283
  */
@@ -3308,9 +3324,9 @@ export type GetEpisodeData = {
3308
3324
  body?: never;
3309
3325
  path: {
3310
3326
  /**
3311
- * ID of the media
3327
+ * Public ID of the media
3312
3328
  */
3313
- mediaId: number;
3329
+ mediaId: string;
3314
3330
  /**
3315
3331
  * Episode number
3316
3332
  */
@@ -3357,9 +3373,9 @@ export type UpdateEpisodeData = {
3357
3373
  body: EpisodeUpdateRequest;
3358
3374
  path: {
3359
3375
  /**
3360
- * ID of the media
3376
+ * Public ID of the media
3361
3377
  */
3362
- mediaId: number;
3378
+ mediaId: string;
3363
3379
  /**
3364
3380
  * Episode number
3365
3381
  */
@@ -3406,9 +3422,9 @@ export type ListSegmentsData = {
3406
3422
  body?: never;
3407
3423
  path: {
3408
3424
  /**
3409
- * ID of the media
3425
+ * Public ID of the media
3410
3426
  */
3411
- mediaId: number;
3427
+ mediaId: string;
3412
3428
  /**
3413
3429
  * Episode number
3414
3430
  */
@@ -3470,9 +3486,9 @@ export type CreateSegmentData = {
3470
3486
  body: SegmentCreateRequest;
3471
3487
  path: {
3472
3488
  /**
3473
- * ID of the media
3489
+ * Public ID of the media
3474
3490
  */
3475
- mediaId: number;
3491
+ mediaId: string;
3476
3492
  /**
3477
3493
  * Episode number
3478
3494
  */
@@ -3523,9 +3539,9 @@ export type CreateSegmentsBatchData = {
3523
3539
  body: SegmentBatchCreateRequest;
3524
3540
  path: {
3525
3541
  /**
3526
- * ID of the media
3542
+ * Public ID of the media
3527
3543
  */
3528
- mediaId: number;
3544
+ mediaId: string;
3529
3545
  /**
3530
3546
  * Episode number
3531
3547
  */
@@ -3581,9 +3597,9 @@ export type DeleteSegmentData = {
3581
3597
  body?: never;
3582
3598
  path: {
3583
3599
  /**
3584
- * ID of the media
3600
+ * Public ID of the media
3585
3601
  */
3586
- mediaId: number;
3602
+ mediaId: string;
3587
3603
  /**
3588
3604
  * Episode number
3589
3605
  */
@@ -3634,9 +3650,9 @@ export type GetSegmentData = {
3634
3650
  body?: never;
3635
3651
  path: {
3636
3652
  /**
3637
- * ID of the media
3653
+ * Public ID of the media
3638
3654
  */
3639
- mediaId: number;
3655
+ mediaId: string;
3640
3656
  /**
3641
3657
  * Episode number
3642
3658
  */
@@ -3687,9 +3703,9 @@ export type UpdateSegmentData = {
3687
3703
  body: SegmentUpdateRequest;
3688
3704
  path: {
3689
3705
  /**
3690
- * ID of the media
3706
+ * Public ID of the media
3691
3707
  */
3692
- mediaId: number;
3708
+ mediaId: string;
3693
3709
  /**
3694
3710
  * Episode number
3695
3711
  */
@@ -4299,9 +4315,9 @@ export type DeleteCollectionData = {
4299
4315
  body?: never;
4300
4316
  path: {
4301
4317
  /**
4302
- * Collection ID
4318
+ * Collection public ID
4303
4319
  */
4304
- id: number;
4320
+ id: string;
4305
4321
  };
4306
4322
  query?: never;
4307
4323
  url: '/v1/collections/{id}';
@@ -4344,9 +4360,9 @@ export type GetCollectionData = {
4344
4360
  body?: never;
4345
4361
  path: {
4346
4362
  /**
4347
- * Collection ID
4363
+ * Collection public ID
4348
4364
  */
4349
- id: number;
4365
+ id: string;
4350
4366
  };
4351
4367
  query?: {
4352
4368
  /**
@@ -4401,9 +4417,9 @@ export type UpdateCollectionData = {
4401
4417
  };
4402
4418
  path: {
4403
4419
  /**
4404
- * Collection ID
4420
+ * Collection public ID
4405
4421
  */
4406
- id: number;
4422
+ id: string;
4407
4423
  };
4408
4424
  query?: never;
4409
4425
  url: '/v1/collections/{id}';
@@ -4455,9 +4471,9 @@ export type AddSegmentToCollectionData = {
4455
4471
  };
4456
4472
  path: {
4457
4473
  /**
4458
- * Collection ID
4474
+ * Collection public ID
4459
4475
  */
4460
- id: number;
4476
+ id: string;
4461
4477
  };
4462
4478
  query?: never;
4463
4479
  url: '/v1/collections/{id}/segments';
@@ -4500,9 +4516,9 @@ export type RemoveSegmentFromCollectionData = {
4500
4516
  body?: never;
4501
4517
  path: {
4502
4518
  /**
4503
- * Collection ID
4519
+ * Collection public ID
4504
4520
  */
4505
- id: number;
4521
+ id: string;
4506
4522
  /**
4507
4523
  * Segment ID
4508
4524
  */
@@ -4558,9 +4574,9 @@ export type UpdateCollectionSegmentData = {
4558
4574
  };
4559
4575
  path: {
4560
4576
  /**
4561
- * Collection ID
4577
+ * Collection public ID
4562
4578
  */
4563
- id: number;
4579
+ id: string;
4564
4580
  /**
4565
4581
  * Segment ID
4566
4582
  */
@@ -4607,9 +4623,9 @@ export type SearchCollectionSegmentsData = {
4607
4623
  body?: never;
4608
4624
  path: {
4609
4625
  /**
4610
- * Collection ID
4626
+ * Collection public ID
4611
4627
  */
4612
- id: number;
4628
+ id: string;
4613
4629
  };
4614
4630
  query?: {
4615
4631
  /**
@@ -4661,9 +4677,9 @@ export type GetCollectionStatsData = {
4661
4677
  body?: never;
4662
4678
  path: {
4663
4679
  /**
4664
- * Collection ID
4680
+ * Collection public ID
4665
4681
  */
4666
- id: number;
4682
+ id: string;
4667
4683
  };
4668
4684
  query?: never;
4669
4685
  url: '/v1/collections/{id}/stats';