@prdb/sdk 0.6.1 → 0.6.2

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.
Files changed (57) hide show
  1. package/dist/generated/actors/changes/index.d.ts +9 -0
  2. package/dist/generated/actors/changes/index.d.ts.map +1 -1
  3. package/dist/generated/actors/changes/index.js.map +1 -1
  4. package/dist/generated/actors/index.d.ts +21 -0
  5. package/dist/generated/actors/index.d.ts.map +1 -1
  6. package/dist/generated/actors/index.js.map +1 -1
  7. package/dist/generated/favoriteActors/index.d.ts +15 -0
  8. package/dist/generated/favoriteActors/index.d.ts.map +1 -1
  9. package/dist/generated/favoriteActors/index.js.map +1 -1
  10. package/dist/generated/favoriteSites/index.d.ts +15 -0
  11. package/dist/generated/favoriteSites/index.d.ts.map +1 -1
  12. package/dist/generated/favoriteSites/index.js.map +1 -1
  13. package/dist/generated/indexerFilehashes/changes/index.d.ts +15 -0
  14. package/dist/generated/indexerFilehashes/changes/index.d.ts.map +1 -1
  15. package/dist/generated/indexerFilehashes/changes/index.js.map +1 -1
  16. package/dist/generated/indexerFilehashes/latest/index.d.ts +33 -0
  17. package/dist/generated/indexerFilehashes/latest/index.d.ts.map +1 -1
  18. package/dist/generated/indexerFilehashes/latest/index.js.map +1 -1
  19. package/dist/generated/models/index.d.ts +518 -308
  20. package/dist/generated/models/index.d.ts.map +1 -1
  21. package/dist/generated/models/index.js +1 -1
  22. package/dist/generated/models/index.js.map +1 -1
  23. package/dist/generated/predb/index.d.ts +24 -0
  24. package/dist/generated/predb/index.d.ts.map +1 -1
  25. package/dist/generated/predb/index.js.map +1 -1
  26. package/dist/generated/predb/latest/index.d.ts +15 -0
  27. package/dist/generated/predb/latest/index.d.ts.map +1 -1
  28. package/dist/generated/predb/latest/index.js.map +1 -1
  29. package/dist/generated/predb/searchByVideo/index.d.ts +6 -0
  30. package/dist/generated/predb/searchByVideo/index.d.ts.map +1 -1
  31. package/dist/generated/predb/searchByVideo/index.js.map +1 -1
  32. package/dist/generated/sites/index.d.ts +15 -0
  33. package/dist/generated/sites/index.d.ts.map +1 -1
  34. package/dist/generated/sites/index.js.map +1 -1
  35. package/dist/generated/videos/filehashSubmissions/index.d.ts +2 -2
  36. package/dist/generated/videos/filehashes/changes/index.d.ts +15 -0
  37. package/dist/generated/videos/filehashes/changes/index.d.ts.map +1 -1
  38. package/dist/generated/videos/filehashes/changes/index.js.map +1 -1
  39. package/dist/generated/videos/filehashes/latest/index.d.ts +33 -0
  40. package/dist/generated/videos/filehashes/latest/index.d.ts.map +1 -1
  41. package/dist/generated/videos/filehashes/latest/index.js.map +1 -1
  42. package/dist/generated/videos/filehashes/unlinked/index.d.ts +12 -0
  43. package/dist/generated/videos/filehashes/unlinked/index.d.ts.map +1 -1
  44. package/dist/generated/videos/filehashes/unlinked/index.js.map +1 -1
  45. package/dist/generated/videos/identify/index.d.ts +2 -2
  46. package/dist/generated/videos/index.d.ts +27 -0
  47. package/dist/generated/videos/index.d.ts.map +1 -1
  48. package/dist/generated/videos/index.js.map +1 -1
  49. package/dist/generated/wantedVideos/batch/index.d.ts +2 -2
  50. package/dist/generated/wantedVideos/changes/index.d.ts +9 -0
  51. package/dist/generated/wantedVideos/changes/index.d.ts.map +1 -1
  52. package/dist/generated/wantedVideos/changes/index.js.map +1 -1
  53. package/dist/generated/wantedVideos/fulfillments/index.d.ts +2 -2
  54. package/dist/generated/wantedVideos/index.d.ts +27 -0
  55. package/dist/generated/wantedVideos/index.d.ts.map +1 -1
  56. package/dist/generated/wantedVideos/index.js.map +1 -1
  57. package/package.json +1 -1
@@ -1,19 +1,22 @@
1
1
  import { type AdditionalDataHolder, type ApiError, type DateOnly, type Guid, type Parsable, type ParseNode, type SerializationWriter } from '@microsoft/kiota-abstractions';
2
+ /**
3
+ * An active subscription held by the authenticated user.
4
+ */
2
5
  export interface ActiveSubscriptionDto extends AdditionalDataHolder, Parsable {
3
6
  /**
4
- * The endsAtUtc property
7
+ * UTC timestamp when this subscription period ends.
5
8
  */
6
9
  endsAtUtc?: Date | null;
7
10
  /**
8
- * The packageIdentifier property
11
+ * Stable slug identifying the subscription package (e.g. "plus", "premium").
9
12
  */
10
13
  packageIdentifier?: string | null;
11
14
  /**
12
- * The packageTitle property
15
+ * Human-readable title of the subscription package.
13
16
  */
14
17
  packageTitle?: string | null;
15
18
  /**
16
- * The startsAtUtc property
19
+ * UTC timestamp when this subscription period starts.
17
20
  */
18
21
  startsAtUtc?: Date | null;
19
22
  }
@@ -23,7 +26,7 @@ export interface ActorAliasDto extends AdditionalDataHolder, Parsable {
23
26
  */
24
27
  name?: string | null;
25
28
  /**
26
- * The siteId property
29
+ * ID of the site this alias is associated with, if any.
27
30
  */
28
31
  siteId?: Guid | null;
29
32
  }
@@ -37,6 +40,9 @@ export interface ActorBioDto extends AdditionalDataHolder, Parsable {
37
40
  */
38
41
  text?: string | null;
39
42
  }
43
+ /**
44
+ * Full current actor payload, including tombstone metadata.
45
+ */
40
46
  export interface ActorChangeActorDto extends AdditionalDataHolder, Parsable {
41
47
  /**
42
48
  * The aliases property
@@ -203,13 +209,16 @@ export interface ActorChangeBioDto extends AdditionalDataHolder, Parsable {
203
209
  */
204
210
  text?: string | null;
205
211
  }
212
+ /**
213
+ * A single current-state actor change.
214
+ */
206
215
  export interface ActorChangeDto extends AdditionalDataHolder, Parsable {
207
216
  /**
208
- * The actor property
217
+ * Full current actor payload, including tombstone metadata.
209
218
  */
210
219
  actor?: ActorChangeActorDto | null;
211
220
  /**
212
- * The eventType property
221
+ * One of `created`, `updated`, or `deleted`.
213
222
  */
214
223
  eventType?: string | null;
215
224
  }
@@ -245,6 +254,9 @@ export interface ActorChangeLinkDto extends AdditionalDataHolder, Parsable {
245
254
  */
246
255
  url?: string | null;
247
256
  }
257
+ /**
258
+ * Seek cursor for continuing an actor change feed.
259
+ */
248
260
  export interface ActorChangesCursorDto extends AdditionalDataHolder, Parsable {
249
261
  /**
250
262
  * The id property
@@ -255,6 +267,9 @@ export interface ActorChangesCursorDto extends AdditionalDataHolder, Parsable {
255
267
  */
256
268
  updatedAtUtc?: Date | null;
257
269
  }
270
+ /**
271
+ * Full details for a single actor.
272
+ */
258
273
  export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
259
274
  /**
260
275
  * The aliases property
@@ -265,7 +280,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
265
280
  */
266
281
  bios?: ActorBioDto[] | null;
267
282
  /**
268
- * The birthday property
283
+ * Date of birth, if known.
269
284
  */
270
285
  birthday?: DateOnly | null;
271
286
  /**
@@ -273,7 +288,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
273
288
  */
274
289
  birthdayType?: number | null;
275
290
  /**
276
- * The birthdayTypeLabel property
291
+ * Human-readable birthday type label (e.g. "Exact", "Approximate").
277
292
  */
278
293
  birthdayTypeLabel?: string | null;
279
294
  /**
@@ -285,7 +300,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
285
300
  */
286
301
  braSize?: number | null;
287
302
  /**
288
- * The braSizeLabel property
303
+ * Human-readable bra size label (e.g. "34B").
289
304
  */
290
305
  braSizeLabel?: string | null;
291
306
  /**
@@ -297,11 +312,11 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
297
312
  */
298
313
  breastTypeLabel?: string | null;
299
314
  /**
300
- * The careerEnd property
315
+ * Year the actor's career ended, if applicable.
301
316
  */
302
317
  careerEnd?: number | null;
303
318
  /**
304
- * The careerStart property
319
+ * Year the actor's career began.
305
320
  */
306
321
  careerStart?: number | null;
307
322
  /**
@@ -309,7 +324,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
309
324
  */
310
325
  createdAtUtc?: Date | null;
311
326
  /**
312
- * The deathday property
327
+ * Date of death, if applicable.
313
328
  */
314
329
  deathday?: DateOnly | null;
315
330
  /**
@@ -333,7 +348,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
333
348
  */
334
349
  gender?: number | null;
335
350
  /**
336
- * The genderLabel property
351
+ * Human-readable gender label.
337
352
  */
338
353
  genderLabel?: string | null;
339
354
  /**
@@ -345,11 +360,11 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
345
360
  */
346
361
  haircolorLabel?: string | null;
347
362
  /**
348
- * The height property
363
+ * Height in centimetres.
349
364
  */
350
365
  height?: number | null;
351
366
  /**
352
- * The hipSize property
367
+ * Hip measurement in centimetres.
353
368
  */
354
369
  hipSize?: number | null;
355
370
  /**
@@ -365,7 +380,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
365
380
  */
366
381
  links?: ActorLinkDto[] | null;
367
382
  /**
368
- * The name property
383
+ * Stage name of the actor.
369
384
  */
370
385
  name?: string | null;
371
386
  /**
@@ -389,7 +404,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
389
404
  */
390
405
  updatedAtUtc?: Date | null;
391
406
  /**
392
- * The waistSize property
407
+ * Waist measurement in centimetres.
393
408
  */
394
409
  waistSize?: number | null;
395
410
  }
@@ -407,7 +422,7 @@ export interface ActorImageDetailDto extends AdditionalDataHolder, Parsable {
407
422
  */
408
423
  imageTypeLabel?: string | null;
409
424
  /**
410
- * The url property
425
+ * Full CDN URL for the image, if available.
411
426
  */
412
427
  url?: string | null;
413
428
  }
@@ -425,9 +440,12 @@ export interface ActorLinkDto extends AdditionalDataHolder, Parsable {
425
440
  */
426
441
  url?: string | null;
427
442
  }
443
+ /**
444
+ * Summary of a single actor.
445
+ */
428
446
  export interface ActorSummaryDto extends AdditionalDataHolder, Parsable {
429
447
  /**
430
- * The birthday property
448
+ * Date of birth, if known.
431
449
  */
432
450
  birthday?: DateOnly | null;
433
451
  /**
@@ -435,7 +453,7 @@ export interface ActorSummaryDto extends AdditionalDataHolder, Parsable {
435
453
  */
436
454
  ethnicity?: number | null;
437
455
  /**
438
- * The ethnicityLabel property
456
+ * Human-readable ethnicity label.
439
457
  */
440
458
  ethnicityLabel?: string | null;
441
459
  /**
@@ -443,7 +461,7 @@ export interface ActorSummaryDto extends AdditionalDataHolder, Parsable {
443
461
  */
444
462
  gender?: number | null;
445
463
  /**
446
- * The genderLabel property
464
+ * Human-readable gender label.
447
465
  */
448
466
  genderLabel?: string | null;
449
467
  /**
@@ -451,7 +469,7 @@ export interface ActorSummaryDto extends AdditionalDataHolder, Parsable {
451
469
  */
452
470
  id?: Guid | null;
453
471
  /**
454
- * The name property
472
+ * Stage name of the actor.
455
473
  */
456
474
  name?: string | null;
457
475
  /**
@@ -459,43 +477,43 @@ export interface ActorSummaryDto extends AdditionalDataHolder, Parsable {
459
477
  */
460
478
  nationality?: number | null;
461
479
  /**
462
- * The nationalityLabel property
480
+ * Human-readable nationality label.
463
481
  */
464
482
  nationalityLabel?: string | null;
465
483
  /**
466
- * The profileImageUrl property
484
+ * Full CDN URL of the actor's profile image, if available.
467
485
  */
468
486
  profileImageUrl?: string | null;
469
487
  }
470
488
  export interface AddDownloadedFromIndexerFilenameRequest extends AdditionalDataHolder, Parsable {
471
489
  /**
472
- * The filename property
490
+ * The filename as reported by the indexer/download source.
473
491
  */
474
492
  filename?: string | null;
475
493
  /**
476
- * The filesize property
494
+ * File size in bytes.
477
495
  */
478
496
  filesize?: number | null;
479
497
  /**
480
- * The osHash property
498
+ * Optional OS hash value as a 16-character fixed-length string.
481
499
  */
482
500
  osHash?: string | null;
483
501
  /**
484
- * The pHash property
502
+ * Optional perceptual hash value, 16 hexadecimal characters. It must be computed as"Perceptual hashes" in the API description prescribes; a value from another procedureis stored but can never be matched.
485
503
  */
486
504
  pHash?: string | null;
487
505
  }
488
506
  export interface AddDownloadedFromIndexerRequest extends AdditionalDataHolder, Parsable {
489
507
  /**
490
- * The downloadIdentifier property
508
+ * Download identifier returned by the indexer or download client.
491
509
  */
492
510
  downloadIdentifier?: string | null;
493
511
  /**
494
- * The filenames property
512
+ * Optional filename rows to create together with the parent entry.
495
513
  */
496
514
  filenames?: AddDownloadedFromIndexerFilenameRequest[] | null;
497
515
  /**
498
- * The indexerId property
516
+ * Indexer-specific identifier for the download item.
499
517
  */
500
518
  indexerId?: string | null;
501
519
  /**
@@ -503,35 +521,41 @@ export interface AddDownloadedFromIndexerRequest extends AdditionalDataHolder, P
503
521
  */
504
522
  indexerSource?: number | null;
505
523
  /**
506
- * The nzbName property
524
+ * NZB or release name.
507
525
  */
508
526
  nzbName?: string | null;
509
527
  /**
510
- * The nzbUrl property
528
+ * NZB or release URL.
511
529
  */
512
530
  nzbUrl?: string | null;
513
531
  /**
514
- * The videoId property
532
+ * Optional ID of the wanted video this download belongs to. Pass null when the download is not linked to a video yet.
515
533
  */
516
534
  videoId?: Guid | null;
517
535
  }
536
+ /**
537
+ * Request body for batch-adding wanted videos.
538
+ */
518
539
  export interface AddWantedVideosBatchRequest extends AdditionalDataHolder, Parsable {
519
540
  /**
520
- * The videoIds property
541
+ * IDs of the videos to add. Between 1 and 50 entries.
521
542
  */
522
543
  videoIds?: Guid[] | null;
523
544
  }
545
+ /**
546
+ * Summary of a batch add-wanted-videos operation.
547
+ */
524
548
  export interface AddWantedVideosBatchResponse extends AdditionalDataHolder, Parsable {
525
549
  /**
526
- * The added property
550
+ * Number of entries newly added to the wanted list.
527
551
  */
528
552
  added?: number | null;
529
553
  /**
530
- * The alreadyExisted property
554
+ * Number of entries that were already on the wanted list.
531
555
  */
532
556
  alreadyExisted?: number | null;
533
557
  /**
534
- * The notFound property
558
+ * Number of video IDs that were not found in the database.
535
559
  */
536
560
  notFound?: number | null;
537
561
  }
@@ -1891,59 +1915,65 @@ export declare function deserializeIntoWantedVideoChangeWantedVideoDto(wantedVid
1891
1915
  * @returns {Record<string, (node: ParseNode) => void>}
1892
1916
  */
1893
1917
  export declare function deserializeIntoWantedVideoSummaryDto(wantedVideoSummaryDto?: Partial<WantedVideoSummaryDto> | undefined): Record<string, (node: ParseNode) => void>;
1918
+ /**
1919
+ * A filename recorded for a downloaded-from-indexer entry.
1920
+ */
1894
1921
  export interface DownloadedFromIndexerFilenameDto extends AdditionalDataHolder, Parsable {
1895
1922
  /**
1896
- * The createdAtUtc property
1923
+ * When this filename row was created.
1897
1924
  */
1898
1925
  createdAtUtc?: Date | null;
1899
1926
  /**
1900
- * The downloadedFromIndexerId property
1927
+ * ID of the parent downloaded-from-indexer entry.
1901
1928
  */
1902
1929
  downloadedFromIndexerId?: Guid | null;
1903
1930
  /**
1904
- * The filename property
1931
+ * The filename as reported by the indexer/download source.
1905
1932
  */
1906
1933
  filename?: string | null;
1907
1934
  /**
1908
- * The filesize property
1935
+ * File size in bytes.
1909
1936
  */
1910
1937
  filesize?: number | null;
1911
1938
  /**
1912
- * The id property
1939
+ * ID of the filename row.
1913
1940
  */
1914
1941
  id?: Guid | null;
1915
1942
  /**
1916
- * The osHash property
1943
+ * Optional OS hash value as a 16-character fixed-length string.
1917
1944
  */
1918
1945
  osHash?: string | null;
1919
1946
  /**
1920
- * The pHash property
1947
+ * Optional perceptual hash value as a 16-character fixed-length string.
1921
1948
  */
1922
1949
  pHash?: string | null;
1923
1950
  /**
1924
- * The updatedAtUtc property
1951
+ * When this filename row was last updated.
1925
1952
  */
1926
1953
  updatedAtUtc?: Date | null;
1927
1954
  }
1955
+ /**
1956
+ * A downloaded-from-indexer entry for the current user.
1957
+ */
1928
1958
  export interface DownloadedFromIndexerResponse extends AdditionalDataHolder, Parsable {
1929
1959
  /**
1930
- * The createdAtUtc property
1960
+ * When this entry was created.
1931
1961
  */
1932
1962
  createdAtUtc?: Date | null;
1933
1963
  /**
1934
- * The downloadIdentifier property
1964
+ * Download identifier returned by the indexer or download client.
1935
1965
  */
1936
1966
  downloadIdentifier?: string | null;
1937
1967
  /**
1938
- * The filenames property
1968
+ * Filename rows recorded for this entry.
1939
1969
  */
1940
1970
  filenames?: DownloadedFromIndexerFilenameDto[] | null;
1941
1971
  /**
1942
- * The id property
1972
+ * ID of the downloaded-from-indexer entry.
1943
1973
  */
1944
1974
  id?: Guid | null;
1945
1975
  /**
1946
- * The indexerId property
1976
+ * Indexer-specific identifier for the download item.
1947
1977
  */
1948
1978
  indexerId?: string | null;
1949
1979
  /**
@@ -1951,32 +1981,38 @@ export interface DownloadedFromIndexerResponse extends AdditionalDataHolder, Par
1951
1981
  */
1952
1982
  indexerSource?: number | null;
1953
1983
  /**
1954
- * The nzbName property
1984
+ * NZB or release name.
1955
1985
  */
1956
1986
  nzbName?: string | null;
1957
1987
  /**
1958
- * The nzbUrl property
1988
+ * NZB or release URL.
1959
1989
  */
1960
1990
  nzbUrl?: string | null;
1961
1991
  /**
1962
- * The updatedAtUtc property
1992
+ * When this entry was last updated.
1963
1993
  */
1964
1994
  updatedAtUtc?: Date | null;
1965
1995
  /**
1966
- * The videoId property
1996
+ * ID of the associated wanted video, or null when the download is not linked to a video.
1967
1997
  */
1968
1998
  videoId?: Guid | null;
1969
1999
  }
2000
+ /**
2001
+ * A single changed favorite actor row in the incremental feed.
2002
+ */
1970
2003
  export interface FavoriteActorChangeDto extends AdditionalDataHolder, Parsable {
1971
2004
  /**
1972
- * The eventType property
2005
+ * One of `created`, `updated`, or `deleted`.
1973
2006
  */
1974
2007
  eventType?: string | null;
1975
2008
  /**
1976
- * The favoriteActor property
2009
+ * Current-state payload for a favorite actor row in the incremental feed.
1977
2010
  */
1978
2011
  favoriteActor?: FavoriteActorChangeFavoriteActorDto | null;
1979
2012
  }
2013
+ /**
2014
+ * Current-state payload for a favorite actor row in the incremental feed.
2015
+ */
1980
2016
  export interface FavoriteActorChangeFavoriteActorDto extends AdditionalDataHolder, Parsable {
1981
2017
  /**
1982
2018
  * The deletedAtUtc property
@@ -2019,6 +2055,9 @@ export interface FavoriteActorChangeFavoriteActorDto extends AdditionalDataHolde
2019
2055
  */
2020
2056
  updatedAtUtc?: Date | null;
2021
2057
  }
2058
+ /**
2059
+ * Seek cursor for continuing a favorite actor change feed.
2060
+ */
2022
2061
  export interface FavoriteActorChangesCursorDto extends AdditionalDataHolder, Parsable {
2023
2062
  /**
2024
2063
  * The id property
@@ -2029,17 +2068,20 @@ export interface FavoriteActorChangesCursorDto extends AdditionalDataHolder, Par
2029
2068
  */
2030
2069
  updatedAtUtc?: Date | null;
2031
2070
  }
2071
+ /**
2072
+ * Summary of an actor in the current user's favorites list.
2073
+ */
2032
2074
  export interface FavoriteActorSummaryDto extends AdditionalDataHolder, Parsable {
2033
2075
  /**
2034
- * The ethnicity property
2076
+ * Ethnicity label.
2035
2077
  */
2036
2078
  ethnicity?: string | null;
2037
2079
  /**
2038
- * The favoritedAtUtc property
2080
+ * UTC timestamp when the user added this actor to their favorites.
2039
2081
  */
2040
2082
  favoritedAtUtc?: Date | null;
2041
2083
  /**
2042
- * The gender property
2084
+ * Gender label (e.g. `Female`, `Male`, `Unknown`).
2043
2085
  */
2044
2086
  gender?: string | null;
2045
2087
  /**
@@ -2051,24 +2093,30 @@ export interface FavoriteActorSummaryDto extends AdditionalDataHolder, Parsable
2051
2093
  */
2052
2094
  name?: string | null;
2053
2095
  /**
2054
- * The nationality property
2096
+ * Nationality label.
2055
2097
  */
2056
2098
  nationality?: string | null;
2057
2099
  /**
2058
- * The profileImageCdnPath property
2100
+ * CDN URL of the actor's face/profile image, if available.
2059
2101
  */
2060
2102
  profileImageCdnPath?: string | null;
2061
2103
  }
2104
+ /**
2105
+ * A single changed favorite site row in the incremental feed.
2106
+ */
2062
2107
  export interface FavoriteSiteChangeDto extends AdditionalDataHolder, Parsable {
2063
2108
  /**
2064
- * The eventType property
2109
+ * One of `created`, `updated`, or `deleted`.
2065
2110
  */
2066
2111
  eventType?: string | null;
2067
2112
  /**
2068
- * The favoriteSite property
2113
+ * Current-state payload for a favorite site row in the incremental feed.
2069
2114
  */
2070
2115
  favoriteSite?: FavoriteSiteChangeFavoriteSiteDto | null;
2071
2116
  }
2117
+ /**
2118
+ * Current-state payload for a favorite site row in the incremental feed.
2119
+ */
2072
2120
  export interface FavoriteSiteChangeFavoriteSiteDto extends AdditionalDataHolder, Parsable {
2073
2121
  /**
2074
2122
  * The deletedAtUtc property
@@ -2107,6 +2155,9 @@ export interface FavoriteSiteChangeFavoriteSiteDto extends AdditionalDataHolder,
2107
2155
  */
2108
2156
  url?: string | null;
2109
2157
  }
2158
+ /**
2159
+ * Seek cursor for continuing a favorite site change feed.
2160
+ */
2110
2161
  export interface FavoriteSiteChangesCursorDto extends AdditionalDataHolder, Parsable {
2111
2162
  /**
2112
2163
  * The id property
@@ -2117,9 +2168,12 @@ export interface FavoriteSiteChangesCursorDto extends AdditionalDataHolder, Pars
2117
2168
  */
2118
2169
  updatedAtUtc?: Date | null;
2119
2170
  }
2171
+ /**
2172
+ * Summary of a site in the current user's favorites list.
2173
+ */
2120
2174
  export interface FavoriteSiteSummaryDto extends AdditionalDataHolder, Parsable {
2121
2175
  /**
2122
- * The favoritedAtUtc property
2176
+ * UTC timestamp when the user added this site to their favorites.
2123
2177
  */
2124
2178
  favoritedAtUtc?: Date | null;
2125
2179
  /**
@@ -2143,9 +2197,12 @@ export interface FavoriteSiteSummaryDto extends AdditionalDataHolder, Parsable {
2143
2197
  */
2144
2198
  url?: string | null;
2145
2199
  }
2200
+ /**
2201
+ * A single fulfilment update.
2202
+ */
2146
2203
  export interface FulfillWantedVideoItem extends AdditionalDataHolder, Parsable {
2147
2204
  /**
2148
- * The fulfilledAtUtc property
2205
+ * When the video was fulfilled. Ignored when isFulfilled is false; defaults to the server time when omitted.
2149
2206
  */
2150
2207
  fulfilledAtUtc?: Date | null;
2151
2208
  /**
@@ -2157,40 +2214,52 @@ export interface FulfillWantedVideoItem extends AdditionalDataHolder, Parsable {
2157
2214
  */
2158
2215
  fulfillmentByApp?: number | null;
2159
2216
  /**
2160
- * The fulfillmentExternalId property
2217
+ * External identifier from the fulfilling application, if applicable.
2161
2218
  */
2162
2219
  fulfillmentExternalId?: string | null;
2163
2220
  /**
2164
- * The isFulfilled property
2221
+ * Whether the wanted video has been fulfilled.
2165
2222
  */
2166
2223
  isFulfilled?: boolean | null;
2167
2224
  /**
2168
- * The videoId property
2225
+ * ID of the video whose wanted entry is updated. Must be unique within the request.
2169
2226
  */
2170
2227
  videoId?: Guid | null;
2171
2228
  }
2229
+ /**
2230
+ * What happened to one video of the batch.
2231
+ */
2172
2232
  export interface FulfillWantedVideoResultDto extends AdditionalDataHolder, Parsable {
2173
2233
  /**
2174
- * Known values: Updated (0), Unchanged (1), NotWanted (2), NotFound (3).
2234
+ * Outcome of a single fulfilment update. Known values: Updated (0), Unchanged (1), NotWanted (2), NotFound (3).
2175
2235
  */
2176
2236
  outcome?: number | null;
2177
2237
  /**
2178
- * The videoId property
2238
+ * ID of the video this result belongs to.
2179
2239
  */
2180
2240
  videoId?: Guid | null;
2181
2241
  }
2242
+ /**
2243
+ * Request body for batch-updating the fulfilment state of wanted videos.
2244
+ */
2182
2245
  export interface FulfillWantedVideosBatchRequest extends AdditionalDataHolder, Parsable {
2183
2246
  /**
2184
- * The items property
2247
+ * Fulfilment updates to apply. Between 1 and 50 entries, each for a distinct video.
2185
2248
  */
2186
2249
  items?: FulfillWantedVideoItem[] | null;
2187
2250
  }
2251
+ /**
2252
+ * Per-video outcome of a batch fulfilment update.
2253
+ */
2188
2254
  export interface FulfillWantedVideosBatchResponse extends AdditionalDataHolder, Parsable {
2189
2255
  /**
2190
- * The results property
2256
+ * One result per requested video, in request order.
2191
2257
  */
2192
2258
  results?: FulfillWantedVideoResultDto[] | null;
2193
2259
  }
2260
+ /**
2261
+ * A seek-paged actor delta feed ordered by updated timestamp and actor ID.
2262
+ */
2194
2263
  export interface GetActorChangesResponse extends AdditionalDataHolder, Parsable {
2195
2264
  /**
2196
2265
  * The hasMore property
@@ -2201,7 +2270,7 @@ export interface GetActorChangesResponse extends AdditionalDataHolder, Parsable
2201
2270
  */
2202
2271
  items?: ActorChangeDto[] | null;
2203
2272
  /**
2204
- * The nextCursor property
2273
+ * Seek cursor for continuing an actor change feed.
2205
2274
  */
2206
2275
  nextCursor?: ActorChangesCursorDto | null;
2207
2276
  /**
@@ -2209,7 +2278,7 @@ export interface GetActorChangesResponse extends AdditionalDataHolder, Parsable
2209
2278
  */
2210
2279
  pageSize?: number | null;
2211
2280
  /**
2212
- * The serverTimeUtc property
2281
+ * The server's clock when this page was produced, read before the rows were queried.Safe to persist as the next `since` when `items` is empty: an empty pagecarries no row timestamp to continue from, and a client's own clock or the HTTP`Date` header are not sound substitutes for a value the server later reads backas a lower bound.
2213
2282
  */
2214
2283
  serverTimeUtc?: Date | null;
2215
2284
  }
@@ -2219,6 +2288,9 @@ export interface GetActorsByIdsRequest extends AdditionalDataHolder, Parsable {
2219
2288
  */
2220
2289
  ids?: Guid[] | null;
2221
2290
  }
2291
+ /**
2292
+ * Paged delta feed of favorite actor changes ordered by updated timestamp and ID.
2293
+ */
2222
2294
  export interface GetFavoriteActorChangesResponse extends AdditionalDataHolder, Parsable {
2223
2295
  /**
2224
2296
  * The hasMore property
@@ -2229,7 +2301,7 @@ export interface GetFavoriteActorChangesResponse extends AdditionalDataHolder, P
2229
2301
  */
2230
2302
  items?: FavoriteActorChangeDto[] | null;
2231
2303
  /**
2232
- * The nextCursor property
2304
+ * Seek cursor for continuing a favorite actor change feed.
2233
2305
  */
2234
2306
  nextCursor?: FavoriteActorChangesCursorDto | null;
2235
2307
  /**
@@ -2237,10 +2309,13 @@ export interface GetFavoriteActorChangesResponse extends AdditionalDataHolder, P
2237
2309
  */
2238
2310
  pageSize?: number | null;
2239
2311
  /**
2240
- * The serverTimeUtc property
2312
+ * The server's clock when this page was produced, read before the rows were queried.Safe to persist as the next `since` when `items` is empty: an empty pagecarries no row timestamp to continue from, and a client's own clock or the HTTP`Date` header are not sound substitutes for a value the server later reads backas a lower bound.
2241
2313
  */
2242
2314
  serverTimeUtc?: Date | null;
2243
2315
  }
2316
+ /**
2317
+ * Paged delta feed of favorite site changes ordered by updated timestamp and ID.
2318
+ */
2244
2319
  export interface GetFavoriteSiteChangesResponse extends AdditionalDataHolder, Parsable {
2245
2320
  /**
2246
2321
  * The hasMore property
@@ -2251,7 +2326,7 @@ export interface GetFavoriteSiteChangesResponse extends AdditionalDataHolder, Pa
2251
2326
  */
2252
2327
  items?: FavoriteSiteChangeDto[] | null;
2253
2328
  /**
2254
- * The nextCursor property
2329
+ * Seek cursor for continuing a favorite site change feed.
2255
2330
  */
2256
2331
  nextCursor?: FavoriteSiteChangesCursorDto | null;
2257
2332
  /**
@@ -2259,23 +2334,29 @@ export interface GetFavoriteSiteChangesResponse extends AdditionalDataHolder, Pa
2259
2334
  */
2260
2335
  pageSize?: number | null;
2261
2336
  /**
2262
- * The serverTimeUtc property
2337
+ * The server's clock when this page was produced, read before the rows were queried.Safe to persist as the next `since` when `items` is empty: an empty pagecarries no row timestamp to continue from, and a client's own clock or the HTTP`Date` header are not sound substitutes for a value the server later reads backas a lower bound.
2263
2338
  */
2264
2339
  serverTimeUtc?: Date | null;
2265
2340
  }
2341
+ /**
2342
+ * Health check response.
2343
+ */
2266
2344
  export interface GetHealthResponse extends AdditionalDataHolder, Parsable {
2267
2345
  /**
2268
- * The status property
2346
+ * Always "ok" when the API is reachable.
2269
2347
  */
2270
2348
  status?: string | null;
2271
2349
  /**
2272
- * The timestamp property
2350
+ * UTC timestamp at the time of the request.
2273
2351
  */
2274
2352
  timestamp?: Date | null;
2275
2353
  }
2354
+ /**
2355
+ * Paged delta feed of indexer filehash changes ordered by updated timestamp and ID.
2356
+ */
2276
2357
  export interface GetIndexerFilehashChangesResponse extends AdditionalDataHolder, Parsable {
2277
2358
  /**
2278
- * The hasMore property
2359
+ * Whether additional rows exist after the current page.
2279
2360
  */
2280
2361
  hasMore?: boolean | null;
2281
2362
  /**
@@ -2283,35 +2364,41 @@ export interface GetIndexerFilehashChangesResponse extends AdditionalDataHolder,
2283
2364
  */
2284
2365
  items?: IndexerFilehashChangeDto[] | null;
2285
2366
  /**
2286
- * The nextCursor property
2367
+ * Seek cursor for continuing an indexer filehash change feed.
2287
2368
  */
2288
2369
  nextCursor?: IndexerFilehashChangesCursorDto | null;
2289
2370
  /**
2290
- * The pageSize property
2371
+ * The resolved page size for this response.
2291
2372
  */
2292
2373
  pageSize?: number | null;
2293
2374
  /**
2294
- * The serverTimeUtc property
2375
+ * The server's clock when this page was produced, read before the rows were queried.Safe to persist as the next `since` when `items` is empty: an empty pagecarries no row timestamp to continue from, and a client's own clock or the HTTP`Date` header are not sound substitutes for a value the server later reads backas a lower bound.
2295
2376
  */
2296
2377
  serverTimeUtc?: Date | null;
2297
2378
  }
2379
+ /**
2380
+ * Current rate limit status for the authenticated user.
2381
+ */
2298
2382
  export interface GetRateLimitResponse extends AdditionalDataHolder, Parsable {
2299
2383
  /**
2300
- * The hourly property
2384
+ * Rate limit status for a single time window.
2301
2385
  */
2302
2386
  hourly?: RateLimitWindowStatus | null;
2303
2387
  /**
2304
- * The isEnforced property
2388
+ * Always true. Rate limiting is enforced unconditionally; when it cannot be enforced the APIanswers 503 instead of returning this document. Kept for compatibility with clients thatread the field.
2305
2389
  */
2306
2390
  isEnforced?: boolean | null;
2307
2391
  /**
2308
- * The monthly property
2392
+ * Rate limit status for a single time window.
2309
2393
  */
2310
2394
  monthly?: RateLimitWindowStatus | null;
2311
2395
  }
2396
+ /**
2397
+ * Paged delta feed of video filehash changes ordered by updated timestamp and ID.
2398
+ */
2312
2399
  export interface GetVideoFilehashChangesResponse extends AdditionalDataHolder, Parsable {
2313
2400
  /**
2314
- * The hasMore property
2401
+ * Whether additional rows exist after the current page.
2315
2402
  */
2316
2403
  hasMore?: boolean | null;
2317
2404
  /**
@@ -2319,15 +2406,15 @@ export interface GetVideoFilehashChangesResponse extends AdditionalDataHolder, P
2319
2406
  */
2320
2407
  items?: VideoFilehashChangeDto[] | null;
2321
2408
  /**
2322
- * The nextCursor property
2409
+ * Seek cursor for continuing a video filehash change feed.
2323
2410
  */
2324
2411
  nextCursor?: VideoFilehashChangesCursorDto | null;
2325
2412
  /**
2326
- * The pageSize property
2413
+ * The resolved page size for this response.
2327
2414
  */
2328
2415
  pageSize?: number | null;
2329
2416
  /**
2330
- * The serverTimeUtc property
2417
+ * The server's clock when this page was produced, read before the rows were queried.Safe to persist as the next `since` when `items` is empty: an empty pagecarries no row timestamp to continue from, and a client's own clock or the HTTP`Date` header are not sound substitutes for a value the server later reads backas a lower bound.
2331
2418
  */
2332
2419
  serverTimeUtc?: Date | null;
2333
2420
  }
@@ -2371,10 +2458,13 @@ export interface GetVideoUserImageChangesResponse extends AdditionalDataHolder,
2371
2458
  */
2372
2459
  pageSize?: number | null;
2373
2460
  /**
2374
- * The serverTimeUtc property
2461
+ * The server's clock when this page was produced, read before the rows were queried.Safe to persist as the next `since` when `items` is empty: an empty pagecarries no row timestamp to continue from, and a client's own clock or the HTTP`Date` header are not sound substitutes for a value the server later reads backas a lower bound.
2375
2462
  */
2376
2463
  serverTimeUtc?: Date | null;
2377
2464
  }
2465
+ /**
2466
+ * Paged delta feed of wanted video changes ordered by updated timestamp and ID.
2467
+ */
2378
2468
  export interface GetWantedVideoChangesResponse extends AdditionalDataHolder, Parsable {
2379
2469
  /**
2380
2470
  * The hasMore property
@@ -2385,7 +2475,7 @@ export interface GetWantedVideoChangesResponse extends AdditionalDataHolder, Par
2385
2475
  */
2386
2476
  items?: WantedVideoChangeDto[] | null;
2387
2477
  /**
2388
- * The nextCursor property
2478
+ * Seek cursor for continuing a wanted video change feed.
2389
2479
  */
2390
2480
  nextCursor?: WantedVideoChangesCursorDto | null;
2391
2481
  /**
@@ -2393,53 +2483,62 @@ export interface GetWantedVideoChangesResponse extends AdditionalDataHolder, Par
2393
2483
  */
2394
2484
  pageSize?: number | null;
2395
2485
  /**
2396
- * The serverTimeUtc property
2486
+ * The server's clock when this page was produced, read before the rows were queried.Safe to persist as the next `since` when `items` is empty: an empty pagecarries no row timestamp to continue from, and a client's own clock or the HTTP`Date` header are not sound substitutes for a value the server later reads backas a lower bound.
2397
2487
  */
2398
2488
  serverTimeUtc?: Date | null;
2399
2489
  }
2490
+ /**
2491
+ * The site a file could be attributed to.
2492
+ */
2400
2493
  export interface IdentifySiteDto extends AdditionalDataHolder, Parsable {
2401
2494
  /**
2402
- * The id property
2495
+ * Unique identifier of the site.
2403
2496
  */
2404
2497
  id?: Guid | null;
2405
2498
  /**
2406
- * The title property
2499
+ * Site title.
2407
2500
  */
2408
2501
  title?: string | null;
2409
2502
  /**
2410
- * The url property
2503
+ * Site URL.
2411
2504
  */
2412
2505
  url?: string | null;
2413
2506
  }
2507
+ /**
2508
+ * One file to identify.
2509
+ */
2414
2510
  export interface IdentifyVideoFileDto extends AdditionalDataHolder, Parsable {
2415
2511
  /**
2416
- * The filename property
2512
+ * File name without directory. Required — it carries the lowest rungs of the ladder.
2417
2513
  */
2418
2514
  filename?: string | null;
2419
2515
  /**
2420
- * The filesize property
2516
+ * Size of the file in bytes, if known.
2421
2517
  */
2422
2518
  filesize?: number | null;
2423
2519
  /**
2424
- * The osHash property
2520
+ * OS hash of the file, 16 hexadecimal characters, if the client computed one.
2425
2521
  */
2426
2522
  osHash?: string | null;
2427
2523
  /**
2428
- * The pHash property
2524
+ * Perceptual hash of the file, 16 hexadecimal characters, if the client computed one.Compared for equality only, and only against values computed the way "Perceptual hashes"in the API description prescribes — send none rather than one from another procedure.
2429
2525
  */
2430
2526
  pHash?: string | null;
2431
2527
  /**
2432
- * The ref property
2528
+ * Client-assigned identifier, returned unchanged. Unique within the request.
2433
2529
  */
2434
2530
  ref?: string | null;
2435
2531
  }
2532
+ /**
2533
+ * What the identification ladder made of one file.
2534
+ */
2436
2535
  export interface IdentifyVideoResultDto extends AdditionalDataHolder, Parsable {
2437
2536
  /**
2438
- * The candidates property
2537
+ * All equally good videos when the match was ambiguous; otherwise empty.
2439
2538
  */
2440
2539
  candidates?: Guid[] | null;
2441
2540
  /**
2442
- * Known values: None (0), Partial (1), Probable (2), Strong (3), Exact (4), Ambiguous (5).
2541
+ * How much the match can be trusted. Drives whether a client files a file automatically. Known values: None (0), Partial (1), Probable (2), Strong (3), Exact (4), Ambiguous (5).
2443
2542
  */
2444
2543
  confidence?: number | null;
2445
2544
  /**
@@ -2447,11 +2546,11 @@ export interface IdentifyVideoResultDto extends AdditionalDataHolder, Parsable {
2447
2546
  */
2448
2547
  matchedBy?: number | null;
2449
2548
  /**
2450
- * The ref property
2549
+ * The client-assigned identifier of the input file, returned unchanged.
2451
2550
  */
2452
2551
  ref?: string | null;
2453
2552
  /**
2454
- * The site property
2553
+ * The site a file could be attributed to.
2455
2554
  */
2456
2555
  site?: IdentifySiteDto | null;
2457
2556
  /**
@@ -2459,51 +2558,63 @@ export interface IdentifyVideoResultDto extends AdditionalDataHolder, Parsable {
2459
2558
  */
2460
2559
  video?: VideoDetailDto | null;
2461
2560
  /**
2462
- * The videoId property
2561
+ * The identified video, when exactly one was found.
2463
2562
  */
2464
2563
  videoId?: Guid | null;
2465
2564
  }
2565
+ /**
2566
+ * Request body for identifying local files against the prdb catalogue.
2567
+ */
2466
2568
  export interface IdentifyVideosRequest extends AdditionalDataHolder, Parsable {
2467
2569
  /**
2468
- * The files property
2570
+ * Files to identify. Between 1 and 200 entries.
2469
2571
  */
2470
2572
  files?: IdentifyVideoFileDto[] | null;
2471
2573
  /**
2472
- * The includeVideoDetails property
2574
+ * When true, each matched result carries the full video document. Defaults to false.
2473
2575
  */
2474
2576
  includeVideoDetails?: boolean | null;
2475
2577
  }
2578
+ /**
2579
+ * Identification results, one per submitted file.
2580
+ */
2476
2581
  export interface IdentifyVideosResponse extends AdditionalDataHolder, Parsable {
2477
2582
  /**
2478
- * The results property
2583
+ * One result per input file, in input order.
2479
2584
  */
2480
2585
  results?: IdentifyVideoResultDto[] | null;
2481
2586
  }
2587
+ /**
2588
+ * A single changed indexer filehash row in the incremental feed.
2589
+ */
2482
2590
  export interface IndexerFilehashChangeDto extends AdditionalDataHolder, Parsable {
2483
2591
  /**
2484
- * The eventType property
2592
+ * One of `created`, `updated`, or `deleted`.
2485
2593
  */
2486
2594
  eventType?: string | null;
2487
2595
  /**
2488
- * The filehash property
2596
+ * Current persisted state of a changed indexer filehash row, including soft-delete fields.
2489
2597
  */
2490
2598
  filehash?: IndexerFilehashChangeFilehashDto | null;
2491
2599
  }
2600
+ /**
2601
+ * Current persisted state of a changed indexer filehash row, including soft-delete fields.
2602
+ */
2492
2603
  export interface IndexerFilehashChangeFilehashDto extends AdditionalDataHolder, Parsable {
2493
2604
  /**
2494
2605
  * The createdAtUtc property
2495
2606
  */
2496
2607
  createdAtUtc?: Date | null;
2497
2608
  /**
2498
- * The deletedAtUtc property
2609
+ * Timestamp when the row was soft-deleted, or null when still active.
2499
2610
  */
2500
2611
  deletedAtUtc?: Date | null;
2501
2612
  /**
2502
- * The filename property
2613
+ * Original filename submitted for this filehash record.
2503
2614
  */
2504
2615
  filename?: string | null;
2505
2616
  /**
2506
- * The filesize property
2617
+ * File size in bytes.
2507
2618
  */
2508
2619
  filesize?: number | null;
2509
2620
  /**
@@ -2511,31 +2622,31 @@ export interface IndexerFilehashChangeFilehashDto extends AdditionalDataHolder,
2511
2622
  */
2512
2623
  id?: Guid | null;
2513
2624
  /**
2514
- * The indexerId property
2625
+ * Indexer-specific identifier for the release.
2515
2626
  */
2516
2627
  indexerId?: string | null;
2517
2628
  /**
2518
- * The indexerSource property
2629
+ * Indexer source. Supported values: `DrunkenSlug`, `NzbFinder`, `NzbPorn`.
2519
2630
  */
2520
2631
  indexerSource?: string | null;
2521
2632
  /**
2522
- * The isDeleted property
2633
+ * Whether this row is soft-deleted.
2523
2634
  */
2524
2635
  isDeleted?: boolean | null;
2525
2636
  /**
2526
- * The isVerified property
2637
+ * Whether this filehash record has been verified.
2527
2638
  */
2528
2639
  isVerified?: boolean | null;
2529
2640
  /**
2530
- * The osHash property
2641
+ * OS hash value as stored.
2531
2642
  */
2532
2643
  osHash?: string | null;
2533
2644
  /**
2534
- * The pHash property
2645
+ * P hash value as stored, or null when not available.
2535
2646
  */
2536
2647
  pHash?: string | null;
2537
2648
  /**
2538
- * The submissionCount property
2649
+ * Number of submissions merged into this filehash record.
2539
2650
  */
2540
2651
  submissionCount?: number | null;
2541
2652
  /**
@@ -2543,6 +2654,9 @@ export interface IndexerFilehashChangeFilehashDto extends AdditionalDataHolder,
2543
2654
  */
2544
2655
  updatedAtUtc?: Date | null;
2545
2656
  }
2657
+ /**
2658
+ * Seek cursor for continuing an indexer filehash change feed.
2659
+ */
2546
2660
  export interface IndexerFilehashChangesCursorDto extends AdditionalDataHolder, Parsable {
2547
2661
  /**
2548
2662
  * The id property
@@ -2559,11 +2673,11 @@ export interface IndexerFilehashDto extends AdditionalDataHolder, Parsable {
2559
2673
  */
2560
2674
  createdAtUtc?: Date | null;
2561
2675
  /**
2562
- * The filename property
2676
+ * Original filename submitted for this filehash record.
2563
2677
  */
2564
2678
  filename?: string | null;
2565
2679
  /**
2566
- * The filesize property
2680
+ * File size in bytes.
2567
2681
  */
2568
2682
  filesize?: number | null;
2569
2683
  /**
@@ -2571,27 +2685,27 @@ export interface IndexerFilehashDto extends AdditionalDataHolder, Parsable {
2571
2685
  */
2572
2686
  id?: Guid | null;
2573
2687
  /**
2574
- * The indexerId property
2688
+ * Indexer-specific identifier for the release.
2575
2689
  */
2576
2690
  indexerId?: string | null;
2577
2691
  /**
2578
- * The indexerSource property
2692
+ * Indexer source. Supported values: `DrunkenSlug`, `NzbFinder`, `NzbPorn`.
2579
2693
  */
2580
2694
  indexerSource?: string | null;
2581
2695
  /**
2582
- * The isVerified property
2696
+ * Whether this filehash record has been verified.
2583
2697
  */
2584
2698
  isVerified?: boolean | null;
2585
2699
  /**
2586
- * The osHash property
2700
+ * OS hash value as stored.
2587
2701
  */
2588
2702
  osHash?: string | null;
2589
2703
  /**
2590
- * The pHash property
2704
+ * P hash value as stored, or null when not available.
2591
2705
  */
2592
2706
  pHash?: string | null;
2593
2707
  /**
2594
- * The submissionCount property
2708
+ * Number of submissions merged into this filehash record.
2595
2709
  */
2596
2710
  submissionCount?: number | null;
2597
2711
  /**
@@ -2599,40 +2713,46 @@ export interface IndexerFilehashDto extends AdditionalDataHolder, Parsable {
2599
2713
  */
2600
2714
  updatedAtUtc?: Date | null;
2601
2715
  }
2716
+ /**
2717
+ * Combined indexer identity used to match filehashes by indexer source and indexer-specific ID.
2718
+ */
2602
2719
  export interface IndexerFilehashLookupKeyDto extends AdditionalDataHolder, Parsable {
2603
2720
  /**
2604
- * The indexerId property
2721
+ * Indexer-specific identifier for the release.
2605
2722
  */
2606
2723
  indexerId?: string | null;
2607
2724
  /**
2608
- * Allowed values: DrunkenSlug, NzbFinder, NzbPorn.
2725
+ * Indexer source. Supported values: `DrunkenSlug`, `NzbFinder`, `NzbPorn`. Allowed values: DrunkenSlug, NzbFinder, NzbPorn.
2609
2726
  */
2610
2727
  indexerSource?: IndexerFilehashLookupKeyDto_indexerSource | null;
2611
2728
  }
2612
2729
  export type IndexerFilehashLookupKeyDto_indexerSource = (typeof IndexerFilehashLookupKeyDto_indexerSourceObject)[keyof typeof IndexerFilehashLookupKeyDto_indexerSourceObject];
2730
+ /**
2731
+ * Paged list of the latest indexer filehash entries.
2732
+ */
2613
2733
  export interface LatestIndexerFilehashesResponse extends AdditionalDataHolder, Parsable {
2614
2734
  /**
2615
2735
  * The items property
2616
2736
  */
2617
2737
  items?: IndexerFilehashDto[] | null;
2618
2738
  /**
2619
- * The page property
2739
+ * Current page number (1-based).
2620
2740
  */
2621
2741
  page?: number | null;
2622
2742
  /**
2623
- * The pageSize property
2743
+ * Number of items per page.
2624
2744
  */
2625
2745
  pageSize?: number | null;
2626
2746
  /**
2627
- * The sortBy property
2747
+ * Resolved sort field for the current query.
2628
2748
  */
2629
2749
  sortBy?: string | null;
2630
2750
  /**
2631
- * The sortDirection property
2751
+ * Resolved sort direction for the current query.
2632
2752
  */
2633
2753
  sortDirection?: string | null;
2634
2754
  /**
2635
- * The totalCount property
2755
+ * Total number of filehash entries matching the current filters.
2636
2756
  */
2637
2757
  totalCount?: number | null;
2638
2758
  }
@@ -2654,21 +2774,24 @@ export interface LatestPreDbItemDto extends AdditionalDataHolder, Parsable {
2654
2774
  */
2655
2775
  video?: LatestPreDbVideoDto | null;
2656
2776
  }
2777
+ /**
2778
+ * Paged list of the latest PreDb entries.
2779
+ */
2657
2780
  export interface LatestPreDbResponse extends AdditionalDataHolder, Parsable {
2658
2781
  /**
2659
2782
  * The items property
2660
2783
  */
2661
2784
  items?: LatestPreDbItemDto[] | null;
2662
2785
  /**
2663
- * The page property
2786
+ * Current page number (1-based).
2664
2787
  */
2665
2788
  page?: number | null;
2666
2789
  /**
2667
- * The pageSize property
2790
+ * Number of items per page.
2668
2791
  */
2669
2792
  pageSize?: number | null;
2670
2793
  /**
2671
- * The totalCount property
2794
+ * Total number of PreDb entries matching the current filters.
2672
2795
  */
2673
2796
  totalCount?: number | null;
2674
2797
  }
@@ -2700,256 +2823,283 @@ export interface LatestPreDbVideoDto extends AdditionalDataHolder, Parsable {
2700
2823
  */
2701
2824
  title?: string | null;
2702
2825
  }
2826
+ /**
2827
+ * Paged list of the latest video filehash entries.
2828
+ */
2703
2829
  export interface LatestVideoFilehashesResponse extends AdditionalDataHolder, Parsable {
2704
2830
  /**
2705
2831
  * The items property
2706
2832
  */
2707
2833
  items?: VideoFilehashDto[] | null;
2708
2834
  /**
2709
- * The page property
2835
+ * Current page number (1-based).
2710
2836
  */
2711
2837
  page?: number | null;
2712
2838
  /**
2713
- * The pageSize property
2839
+ * Number of items per page.
2714
2840
  */
2715
2841
  pageSize?: number | null;
2716
2842
  /**
2717
- * The sortBy property
2843
+ * Resolved sort field for the current query.
2718
2844
  */
2719
2845
  sortBy?: string | null;
2720
2846
  /**
2721
- * The sortDirection property
2847
+ * Resolved sort direction for the current query.
2722
2848
  */
2723
2849
  sortDirection?: string | null;
2724
2850
  /**
2725
- * The totalCount property
2851
+ * Total number of filehash entries matching the current filters.
2726
2852
  */
2727
2853
  totalCount?: number | null;
2728
2854
  }
2855
+ /**
2856
+ * Paged list of actors.
2857
+ */
2729
2858
  export interface ListActorsResponse extends AdditionalDataHolder, Parsable {
2730
2859
  /**
2731
- * The items property
2860
+ * Actors on the current page.
2732
2861
  */
2733
2862
  items?: ActorSummaryDto[] | null;
2734
2863
  /**
2735
- * The page property
2864
+ * Current page number (1-based).
2736
2865
  */
2737
2866
  page?: number | null;
2738
2867
  /**
2739
- * The pageSize property
2868
+ * Number of items per page.
2740
2869
  */
2741
2870
  pageSize?: number | null;
2742
2871
  /**
2743
- * The sortBy property
2872
+ * Field the result is sorted by: "name" or "createdAtUtc".
2744
2873
  */
2745
2874
  sortBy?: string | null;
2746
2875
  /**
2747
- * The sortDirection property
2876
+ * Sort direction applied: "asc" or "desc".
2748
2877
  */
2749
2878
  sortDirection?: string | null;
2750
2879
  /**
2751
- * The totalCount property
2880
+ * Total number of actors matching the current query filters.
2752
2881
  */
2753
2882
  totalCount?: number | null;
2754
2883
  /**
2755
- * The totalPages property
2884
+ * Total number of pages for the current query and page size.
2756
2885
  */
2757
2886
  totalPages?: number | null;
2758
2887
  }
2888
+ /**
2889
+ * Paged list of the current user's favorite actors.
2890
+ */
2759
2891
  export interface ListFavoriteActorsResponse extends AdditionalDataHolder, Parsable {
2760
2892
  /**
2761
- * The items property
2893
+ * Favorite actor entries on the current page.
2762
2894
  */
2763
2895
  items?: FavoriteActorSummaryDto[] | null;
2764
2896
  /**
2765
- * The page property
2897
+ * Current page number (1-based).
2766
2898
  */
2767
2899
  page?: number | null;
2768
2900
  /**
2769
- * The pageSize property
2901
+ * Number of items per page.
2770
2902
  */
2771
2903
  pageSize?: number | null;
2772
2904
  /**
2773
- * The sortBy property
2905
+ * Field the results are sorted by.
2774
2906
  */
2775
2907
  sortBy?: string | null;
2776
2908
  /**
2777
- * The sortDirection property
2909
+ * Sort direction applied: `asc` or `desc`.
2778
2910
  */
2779
2911
  sortDirection?: string | null;
2780
2912
  /**
2781
- * The totalCount property
2913
+ * Total number of favorite actors matching the current query filters.
2782
2914
  */
2783
2915
  totalCount?: number | null;
2784
2916
  /**
2785
- * The totalPages property
2917
+ * Total number of pages.
2786
2918
  */
2787
2919
  totalPages?: number | null;
2788
2920
  }
2921
+ /**
2922
+ * Paged list of the current user's favorite sites.
2923
+ */
2789
2924
  export interface ListFavoriteSitesResponse extends AdditionalDataHolder, Parsable {
2790
2925
  /**
2791
- * The items property
2926
+ * Favorite site entries on the current page.
2792
2927
  */
2793
2928
  items?: FavoriteSiteSummaryDto[] | null;
2794
2929
  /**
2795
- * The page property
2930
+ * Current page number (1-based).
2796
2931
  */
2797
2932
  page?: number | null;
2798
2933
  /**
2799
- * The pageSize property
2934
+ * Number of items per page.
2800
2935
  */
2801
2936
  pageSize?: number | null;
2802
2937
  /**
2803
- * The sortBy property
2938
+ * Field the results are sorted by.
2804
2939
  */
2805
2940
  sortBy?: string | null;
2806
2941
  /**
2807
- * The sortDirection property
2942
+ * Sort direction applied: `asc` or `desc`.
2808
2943
  */
2809
2944
  sortDirection?: string | null;
2810
2945
  /**
2811
- * The totalCount property
2946
+ * Total number of favorite sites matching the current query filters.
2812
2947
  */
2813
2948
  totalCount?: number | null;
2814
2949
  /**
2815
- * The totalPages property
2950
+ * Total number of pages.
2816
2951
  */
2817
2952
  totalPages?: number | null;
2818
2953
  }
2954
+ /**
2955
+ * Paged list of PreDb entries.
2956
+ */
2819
2957
  export interface ListPreDbResponse extends AdditionalDataHolder, Parsable {
2820
2958
  /**
2821
- * The items property
2959
+ * PreDb entries on the current page.
2822
2960
  */
2823
2961
  items?: PreDbSummaryDto[] | null;
2824
2962
  /**
2825
- * The page property
2963
+ * Current page number (1-based).
2826
2964
  */
2827
2965
  page?: number | null;
2828
2966
  /**
2829
- * The pageSize property
2967
+ * Number of items per page.
2830
2968
  */
2831
2969
  pageSize?: number | null;
2832
2970
  /**
2833
- * The sortBy property
2971
+ * Field the result is sorted by: "releaseDate" or "title".
2834
2972
  */
2835
2973
  sortBy?: string | null;
2836
2974
  /**
2837
- * The sortDirection property
2975
+ * Sort direction applied: "asc" or "desc".
2838
2976
  */
2839
2977
  sortDirection?: string | null;
2840
2978
  /**
2841
- * The totalCount property
2979
+ * Total number of entries matching the current query filters.
2842
2980
  */
2843
2981
  totalCount?: number | null;
2844
2982
  }
2983
+ /**
2984
+ * Paged list of sites.
2985
+ */
2845
2986
  export interface ListSitesResponse extends AdditionalDataHolder, Parsable {
2846
2987
  /**
2847
- * The items property
2988
+ * Sites on the current page.
2848
2989
  */
2849
2990
  items?: SiteSummaryDto[] | null;
2850
2991
  /**
2851
- * The page property
2992
+ * Current page number (1-based).
2852
2993
  */
2853
2994
  page?: number | null;
2854
2995
  /**
2855
- * The pageSize property
2996
+ * Number of items per page.
2856
2997
  */
2857
2998
  pageSize?: number | null;
2858
2999
  /**
2859
- * The sortBy property
3000
+ * Field the result is sorted by: "title".
2860
3001
  */
2861
3002
  sortBy?: string | null;
2862
3003
  /**
2863
- * The sortDirection property
3004
+ * Sort direction applied: "asc" or "desc".
2864
3005
  */
2865
3006
  sortDirection?: string | null;
2866
3007
  /**
2867
- * The totalCount property
3008
+ * Total number of sites matching the current query filters.
2868
3009
  */
2869
3010
  totalCount?: number | null;
2870
3011
  }
3012
+ /**
3013
+ * Paged list of videos.
3014
+ */
2871
3015
  export interface ListVideosResponse extends AdditionalDataHolder, Parsable {
2872
3016
  /**
2873
- * The items property
3017
+ * Videos on the current page.
2874
3018
  */
2875
3019
  items?: VideoSummaryDto[] | null;
2876
3020
  /**
2877
- * The page property
3021
+ * Current page number (1-based).
2878
3022
  */
2879
3023
  page?: number | null;
2880
3024
  /**
2881
- * The pageSize property
3025
+ * Number of items per page.
2882
3026
  */
2883
3027
  pageSize?: number | null;
2884
3028
  /**
2885
- * The sortBy property
3029
+ * Field the result is sorted by: "title" or "releaseDate".
2886
3030
  */
2887
3031
  sortBy?: string | null;
2888
3032
  /**
2889
- * The sortDirection property
3033
+ * Sort direction applied: "asc" or "desc".
2890
3034
  */
2891
3035
  sortDirection?: string | null;
2892
3036
  /**
2893
- * The totalCount property
3037
+ * Total number of videos matching the current query filters.
2894
3038
  */
2895
3039
  totalCount?: number | null;
2896
3040
  }
3041
+ /**
3042
+ * Paged list of the current user's wanted videos.
3043
+ */
2897
3044
  export interface ListWantedVideosResponse extends AdditionalDataHolder, Parsable {
2898
3045
  /**
2899
- * The items property
3046
+ * Wanted video entries on the current page.
2900
3047
  */
2901
3048
  items?: WantedVideoSummaryDto[] | null;
2902
3049
  /**
2903
- * The page property
3050
+ * Current page number (1-based).
2904
3051
  */
2905
3052
  page?: number | null;
2906
3053
  /**
2907
- * The pageSize property
3054
+ * Number of items per page.
2908
3055
  */
2909
3056
  pageSize?: number | null;
2910
3057
  /**
2911
- * The sortBy property
3058
+ * Field the results are sorted by.
2912
3059
  */
2913
3060
  sortBy?: string | null;
2914
3061
  /**
2915
- * The sortDirection property
3062
+ * Sort direction applied: `asc` or `desc`.
2916
3063
  */
2917
3064
  sortDirection?: string | null;
2918
3065
  /**
2919
- * The totalCount property
3066
+ * Total number of wanted videos matching the current query filters.
2920
3067
  */
2921
3068
  totalCount?: number | null;
2922
3069
  /**
2923
- * The totalPages property
3070
+ * Total number of pages.
2924
3071
  */
2925
3072
  totalPages?: number | null;
2926
3073
  }
2927
3074
  export interface LookupIndexerFilehashesRequest extends AdditionalDataHolder, Parsable {
2928
3075
  /**
2929
- * The filenames property
3076
+ * Optional exact filenames to match.
2930
3077
  */
2931
3078
  filenames?: string[] | null;
2932
3079
  /**
2933
- * The filesizes property
3080
+ * Optional exact file sizes to match.
2934
3081
  */
2935
3082
  filesizes?: number[] | null;
2936
3083
  /**
2937
- * The ids property
3084
+ * Optional filehash row IDs to match.
2938
3085
  */
2939
3086
  ids?: Guid[] | null;
2940
3087
  /**
2941
- * The indexerKeys property
3088
+ * Optional combined indexer source and indexer ID pairs to match.
2942
3089
  */
2943
3090
  indexerKeys?: IndexerFilehashLookupKeyDto[] | null;
2944
3091
  /**
2945
- * The osHashes property
3092
+ * Optional OS hash values to match.
2946
3093
  */
2947
3094
  osHashes?: string[] | null;
2948
3095
  /**
2949
- * The pHashes property
3096
+ * Optional perceptual hash values to match, 16 hexadecimal characters each. Matched forequality, so a value computed by any procedure other than the one under "Perceptualhashes" in the API description matches nothing rather than failing.
2950
3097
  */
2951
3098
  pHashes?: string[] | null;
2952
3099
  }
3100
+ /**
3101
+ * Flat indexer filehash lookup results.
3102
+ */
2953
3103
  export interface LookupIndexerFilehashesResponse extends AdditionalDataHolder, Parsable {
2954
3104
  /**
2955
3105
  * The items property
@@ -2958,30 +3108,33 @@ export interface LookupIndexerFilehashesResponse extends AdditionalDataHolder, P
2958
3108
  }
2959
3109
  export interface LookupVideoFilehashesRequest extends AdditionalDataHolder, Parsable {
2960
3110
  /**
2961
- * The filenames property
3111
+ * Optional exact filenames to match.
2962
3112
  */
2963
3113
  filenames?: string[] | null;
2964
3114
  /**
2965
- * The filesizes property
3115
+ * Optional exact file sizes to match.
2966
3116
  */
2967
3117
  filesizes?: number[] | null;
2968
3118
  /**
2969
- * The ids property
3119
+ * Optional filehash row IDs to match.
2970
3120
  */
2971
3121
  ids?: Guid[] | null;
2972
3122
  /**
2973
- * The osHashes property
3123
+ * Optional OS hash values to match.
2974
3124
  */
2975
3125
  osHashes?: string[] | null;
2976
3126
  /**
2977
- * The pHashes property
3127
+ * Optional perceptual hash values to match, 16 hexadecimal characters each. Matched forequality, so a value computed by any procedure other than the one under "Perceptualhashes" in the API description matches nothing rather than failing.
2978
3128
  */
2979
3129
  pHashes?: string[] | null;
2980
3130
  /**
2981
- * The videoIds property
3131
+ * Optional associated video IDs to match.
2982
3132
  */
2983
3133
  videoIds?: Guid[] | null;
2984
3134
  }
3135
+ /**
3136
+ * Flat filehash lookup results.
3137
+ */
2985
3138
  export interface LookupVideoFilehashesResponse extends AdditionalDataHolder, Parsable {
2986
3139
  /**
2987
3140
  * The items property
@@ -2998,29 +3151,32 @@ export interface PreDbItemDto extends AdditionalDataHolder, Parsable {
2998
3151
  */
2999
3152
  title?: string | null;
3000
3153
  }
3154
+ /**
3155
+ * Summary representation of a PreDb entry.
3156
+ */
3001
3157
  export interface PreDbSummaryDto extends AdditionalDataHolder, Parsable {
3002
3158
  /**
3003
- * The category property
3159
+ * Readable category value: Movies, TvShows, or Adult.
3004
3160
  */
3005
3161
  category?: string | null;
3006
3162
  /**
3007
- * The filesize property
3163
+ * Optional file size value if known.
3008
3164
  */
3009
3165
  filesize?: number | null;
3010
3166
  /**
3011
- * The id property
3167
+ * Unique identifier of the PreDb entry.
3012
3168
  */
3013
3169
  id?: Guid | null;
3014
3170
  /**
3015
- * The releaseDate property
3171
+ * Release date associated with the entry.
3016
3172
  */
3017
3173
  releaseDate?: DateOnly | null;
3018
3174
  /**
3019
- * The releaseGroup property
3175
+ * Release group name.
3020
3176
  */
3021
3177
  releaseGroup?: string | null;
3022
3178
  /**
3023
- * The title property
3179
+ * Release title as indexed in PreDb.
3024
3180
  */
3025
3181
  title?: string | null;
3026
3182
  }
@@ -3068,21 +3224,24 @@ export interface ProblemDetails extends AdditionalDataHolder, ApiError, Parsable
3068
3224
  */
3069
3225
  type?: string | null;
3070
3226
  }
3227
+ /**
3228
+ * Rate limit status for a single time window.
3229
+ */
3071
3230
  export interface RateLimitWindowStatus extends AdditionalDataHolder, Parsable {
3072
3231
  /**
3073
- * The limit property
3232
+ * Maximum number of requests allowed within this window.
3074
3233
  */
3075
3234
  limit?: number | null;
3076
3235
  /**
3077
- * The remaining property
3236
+ * Number of requests remaining before the limit is reached.
3078
3237
  */
3079
3238
  remaining?: number | null;
3080
3239
  /**
3081
- * The resetsInSeconds property
3240
+ * Seconds until the oldest request in the window expires, reducing the used count by one.
3082
3241
  */
3083
3242
  resetsInSeconds?: number | null;
3084
3243
  /**
3085
- * The used property
3244
+ * Number of requests made within the current window.
3086
3245
  */
3087
3246
  used?: number | null;
3088
3247
  }
@@ -3121,7 +3280,7 @@ export interface SearchPreDbByVideoResponse extends AdditionalDataHolder, Parsab
3121
3280
  */
3122
3281
  items?: PreDbVideoGroupDto[] | null;
3123
3282
  /**
3124
- * The totalGroups property
3283
+ * Number of distinct videos in the result set (capped at 500).
3125
3284
  */
3126
3285
  totalGroups?: number | null;
3127
3286
  }
@@ -3916,63 +4075,75 @@ export declare function serializeWantedVideoChangeWantedVideoDto(writer: Seriali
3916
4075
  * @param writer Serialization writer to use to serialize this model
3917
4076
  */
3918
4077
  export declare function serializeWantedVideoSummaryDto(writer: SerializationWriter, wantedVideoSummaryDto?: Partial<WantedVideoSummaryDto> | undefined | null, isSerializingDerivedType?: boolean): void;
4078
+ /**
4079
+ * Summary of a single site.
4080
+ */
3919
4081
  export interface SiteSummaryDto extends AdditionalDataHolder, Parsable {
3920
4082
  /**
3921
- * The createdAtUtc property
4083
+ * When this site was created.
3922
4084
  */
3923
4085
  createdAtUtc?: Date | null;
3924
4086
  /**
3925
- * The id property
4087
+ * Unique identifier of the site.
3926
4088
  */
3927
4089
  id?: Guid | null;
3928
4090
  /**
3929
- * The networkId property
4091
+ * Unique identifier of the network this site belongs to, if any.
3930
4092
  */
3931
4093
  networkId?: Guid | null;
3932
4094
  /**
3933
- * The networkTitle property
4095
+ * Title of the network this site belongs to, if any.
3934
4096
  */
3935
4097
  networkTitle?: string | null;
3936
4098
  /**
3937
- * The title property
4099
+ * Site title.
3938
4100
  */
3939
4101
  title?: string | null;
3940
4102
  /**
3941
- * The updatedAtUtc property
4103
+ * When this site was last changed.
3942
4104
  */
3943
4105
  updatedAtUtc?: Date | null;
3944
4106
  /**
3945
- * The url property
4107
+ * Site URL.
3946
4108
  */
3947
4109
  url?: string | null;
3948
4110
  }
4111
+ /**
4112
+ * Request body for submitting confirmed hash-to-video assignments.
4113
+ */
3949
4114
  export interface SubmitVideoFilehashesRequest extends AdditionalDataHolder, Parsable {
3950
4115
  /**
3951
- * The items property
4116
+ * Assignments to submit. Between 1 and 200 entries.
3952
4117
  */
3953
4118
  items?: SubmitVideoFilehashItem[] | null;
3954
4119
  }
4120
+ /**
4121
+ * Per-entry outcome of a filehash submission.
4122
+ */
3955
4123
  export interface SubmitVideoFilehashesResponse extends AdditionalDataHolder, Parsable {
3956
4124
  /**
3957
- * The results property
4125
+ * One result per submitted entry, in request order.
3958
4126
  */
3959
4127
  results?: SubmitVideoFilehashResultDto[] | null;
3960
4128
  }
4129
+ /**
4130
+ * A single hash-to-video assignment.
4131
+ */
3961
4132
  export interface SubmitVideoFilehashItem extends AdditionalDataHolder, Parsable {
3962
4133
  /**
3963
- * The filename property
4134
+ * File name without directory. Optional — a client may withhold it, and the endpoint works without it.
3964
4135
  */
3965
4136
  filename?: string | null;
3966
4137
  /**
3967
- * The filesize property
4138
+ * Size of the file in bytes.
3968
4139
  */
3969
4140
  filesize?: number | null;
3970
4141
  /**
3971
- * The osHash property
4142
+ * OS hash of the file, 16 hexadecimal characters. Required; it is the only aggregation key.
3972
4143
  */
3973
4144
  osHash?: string | null;
3974
4145
  /**
3975
- * The pHash property
4146
+ * Perceptual hash of the file, 16 hexadecimal characters, if the client computed one. It mustbe computed as "Perceptual hashes" in the API description prescribes; a submission carryinga value from another procedure contributes a row nothing can match.
3976
4147
  */
3977
4148
  pHash?: string | null;
3978
4149
  /**
@@ -3980,21 +4151,24 @@ export interface SubmitVideoFilehashItem extends AdditionalDataHolder, Parsable
3980
4151
  */
3981
4152
  source?: number | null;
3982
4153
  /**
3983
- * The videoId property
4154
+ * The video this file is. Required — a hash observation without an assignment is not accepted.
3984
4155
  */
3985
4156
  videoId?: Guid | null;
3986
4157
  }
4158
+ /**
4159
+ * What happened to one submitted assignment.
4160
+ */
3987
4161
  export interface SubmitVideoFilehashResultDto extends AdditionalDataHolder, Parsable {
3988
4162
  /**
3989
- * The osHash property
4163
+ * The OS hash of the entry, normalized to upper case.
3990
4164
  */
3991
4165
  osHash?: string | null;
3992
4166
  /**
3993
- * Known values: Recorded (0), Updated (1), Conflicted (2), VideoNotFound (3).
4167
+ * Outcome of a single submission. Known values: Recorded (0), Updated (1), Conflicted (2), VideoNotFound (3).
3994
4168
  */
3995
4169
  outcome?: number | null;
3996
4170
  /**
3997
- * The videoId property
4171
+ * The video the entry named.
3998
4172
  */
3999
4173
  videoId?: Guid | null;
4000
4174
  }
@@ -4016,57 +4190,60 @@ export interface SubmitVideoUserImageResponse extends AdditionalDataHolder, Pars
4016
4190
  */
4017
4191
  videoUserImageId?: Guid | null;
4018
4192
  }
4193
+ /**
4194
+ * Paged list of active filehash entries that are not linked to a video.
4195
+ */
4019
4196
  export interface UnlinkedVideoFilehashesResponse extends AdditionalDataHolder, Parsable {
4020
4197
  /**
4021
4198
  * The items property
4022
4199
  */
4023
4200
  items?: VideoFilehashDto[] | null;
4024
4201
  /**
4025
- * The page property
4202
+ * Current page number (1-based).
4026
4203
  */
4027
4204
  page?: number | null;
4028
4205
  /**
4029
- * The pageSize property
4206
+ * Number of items per page.
4030
4207
  */
4031
4208
  pageSize?: number | null;
4032
4209
  /**
4033
- * The sortBy property
4210
+ * Resolved sort field for the current query.
4034
4211
  */
4035
4212
  sortBy?: string | null;
4036
4213
  /**
4037
- * The sortDirection property
4214
+ * Resolved sort direction for the current query.
4038
4215
  */
4039
4216
  sortDirection?: string | null;
4040
4217
  /**
4041
- * The totalCount property
4218
+ * Total number of active unlinked filehash entries matching the current filters.
4042
4219
  */
4043
4220
  totalCount?: number | null;
4044
4221
  }
4045
4222
  export interface UpdateDownloadedFromIndexerFilenameRequest extends AdditionalDataHolder, Parsable {
4046
4223
  /**
4047
- * The filename property
4224
+ * The filename as reported by the indexer/download source.
4048
4225
  */
4049
4226
  filename?: string | null;
4050
4227
  /**
4051
- * The filesize property
4228
+ * File size in bytes.
4052
4229
  */
4053
4230
  filesize?: number | null;
4054
4231
  /**
4055
- * The osHash property
4232
+ * Optional OS hash value as a 16-character fixed-length string.
4056
4233
  */
4057
4234
  osHash?: string | null;
4058
4235
  /**
4059
- * The pHash property
4236
+ * Optional perceptual hash value, 16 hexadecimal characters. It must be computed as"Perceptual hashes" in the API description prescribes; a value from another procedureis stored but can never be matched.
4060
4237
  */
4061
4238
  pHash?: string | null;
4062
4239
  }
4063
4240
  export interface UpdateDownloadedFromIndexerRequest extends AdditionalDataHolder, Parsable {
4064
4241
  /**
4065
- * The downloadIdentifier property
4242
+ * Download identifier returned by the indexer or download client.
4066
4243
  */
4067
4244
  downloadIdentifier?: string | null;
4068
4245
  /**
4069
- * The indexerId property
4246
+ * Indexer-specific identifier for the download item.
4070
4247
  */
4071
4248
  indexerId?: string | null;
4072
4249
  /**
@@ -4074,17 +4251,17 @@ export interface UpdateDownloadedFromIndexerRequest extends AdditionalDataHolder
4074
4251
  */
4075
4252
  indexerSource?: number | null;
4076
4253
  /**
4077
- * The nzbName property
4254
+ * NZB or release name.
4078
4255
  */
4079
4256
  nzbName?: string | null;
4080
4257
  /**
4081
- * The nzbUrl property
4258
+ * NZB or release URL.
4082
4259
  */
4083
4260
  nzbUrl?: string | null;
4084
4261
  }
4085
4262
  export interface UpdateWantedVideoRequest extends AdditionalDataHolder, Parsable {
4086
4263
  /**
4087
- * The fulfilledAtUtc property
4264
+ * When the wanted video was fulfilled, if applicable.
4088
4265
  */
4089
4266
  fulfilledAtUtc?: Date | null;
4090
4267
  /**
@@ -4096,21 +4273,24 @@ export interface UpdateWantedVideoRequest extends AdditionalDataHolder, Parsable
4096
4273
  */
4097
4274
  fulfillmentByApp?: number | null;
4098
4275
  /**
4099
- * The fulfillmentExternalId property
4276
+ * External identifier from the fulfilling application, if applicable.
4100
4277
  */
4101
4278
  fulfillmentExternalId?: string | null;
4102
4279
  /**
4103
- * The isFulfilled property
4280
+ * Whether the wanted video has been fulfilled.
4104
4281
  */
4105
4282
  isFulfilled?: boolean | null;
4106
4283
  }
4284
+ /**
4285
+ * The updated wanted video entry.
4286
+ */
4107
4287
  export interface UpdateWantedVideoResponse extends AdditionalDataHolder, Parsable {
4108
4288
  /**
4109
- * The createdAtUtc property
4289
+ * When this wanted video entry was created.
4110
4290
  */
4111
4291
  createdAtUtc?: Date | null;
4112
4292
  /**
4113
- * The fulfilledAtUtc property
4293
+ * When the wanted video was fulfilled, if applicable.
4114
4294
  */
4115
4295
  fulfilledAtUtc?: Date | null;
4116
4296
  /**
@@ -4122,29 +4302,32 @@ export interface UpdateWantedVideoResponse extends AdditionalDataHolder, Parsabl
4122
4302
  */
4123
4303
  fulfillmentByApp?: number | null;
4124
4304
  /**
4125
- * The fulfillmentExternalId property
4305
+ * External identifier from the fulfilling application, if applicable.
4126
4306
  */
4127
4307
  fulfillmentExternalId?: string | null;
4128
4308
  /**
4129
- * The isFulfilled property
4309
+ * Whether this wanted video has been fulfilled.
4130
4310
  */
4131
4311
  isFulfilled?: boolean | null;
4132
4312
  /**
4133
- * The updatedAtUtc property
4313
+ * When this wanted video entry was last updated.
4134
4314
  */
4135
4315
  updatedAtUtc?: Date | null;
4136
4316
  /**
4137
- * The videoId property
4317
+ * ID of the video.
4138
4318
  */
4139
4319
  videoId?: Guid | null;
4140
4320
  }
4321
+ /**
4322
+ * Identity and subscription state for the authenticated user.
4323
+ */
4141
4324
  export interface UserIdentityResponse extends AdditionalDataHolder, Parsable {
4142
4325
  /**
4143
- * The activeSubscriptions property
4326
+ * All subscriptions with Status=Active and an end date in the future.
4144
4327
  */
4145
4328
  activeSubscriptions?: ActiveSubscriptionDto[] | null;
4146
4329
  /**
4147
- * The userHash property
4330
+ * Stable HMAC-SHA256 hex digest derived from the user's immutable ID.Suitable as a durable public identifier — does not change unless the server secret rotates.
4148
4331
  */
4149
4332
  userHash?: string | null;
4150
4333
  }
@@ -4162,7 +4345,7 @@ export interface VideoDetailActorDto extends AdditionalDataHolder, Parsable {
4162
4345
  */
4163
4346
  id?: Guid | null;
4164
4347
  /**
4165
- * The images property
4348
+ * Images for this actor, ordered by ActorImageType VideoDetailActorImageDto.ImageType ascending(Thumbnail, Poster, Face), then oldest first, with the image ID as the tie-breaker. The orderis stable across requests.
4166
4349
  */
4167
4350
  images?: VideoDetailActorImageDto[] | null;
4168
4351
  /**
@@ -4176,7 +4359,7 @@ export interface VideoDetailActorDto extends AdditionalDataHolder, Parsable {
4176
4359
  }
4177
4360
  export interface VideoDetailActorImageDto extends AdditionalDataHolder, Parsable {
4178
4361
  /**
4179
- * The cdnPath property
4362
+ * Absolute CDN URL for the image, if available. Despite the field name this is a complete URLincluding scheme and host — it needs no base to be prepended and is ready to request as-is.The same image is exposed as `url` by the actor endpoints.
4180
4363
  */
4181
4364
  cdnPath?: string | null;
4182
4365
  /**
@@ -4202,7 +4385,7 @@ export interface VideoDetailDto extends AdditionalDataHolder, Parsable {
4202
4385
  */
4203
4386
  id?: Guid | null;
4204
4387
  /**
4205
- * The images property
4388
+ * Images for this video, ordered oldest first by the time they were added, with the image IDas the tie-breaker. The order is stable across requests.
4206
4389
  */
4207
4390
  images?: VideoDetailImageDto[] | null;
4208
4391
  /**
@@ -4228,7 +4411,7 @@ export interface VideoDetailDto extends AdditionalDataHolder, Parsable {
4228
4411
  }
4229
4412
  export interface VideoDetailImageDto extends AdditionalDataHolder, Parsable {
4230
4413
  /**
4231
- * The cdnPath property
4414
+ * Absolute CDN URL for the image, if available. Despite the field name this is a complete URLincluding scheme and host — it needs no base to be prepended and is ready to request as-is.
4232
4415
  */
4233
4416
  cdnPath?: string | null;
4234
4417
  /**
@@ -4278,31 +4461,37 @@ export interface VideoDetailSiteDto extends AdditionalDataHolder, Parsable {
4278
4461
  */
4279
4462
  url?: string | null;
4280
4463
  }
4464
+ /**
4465
+ * A single changed video filehash row in the incremental feed.
4466
+ */
4281
4467
  export interface VideoFilehashChangeDto extends AdditionalDataHolder, Parsable {
4282
4468
  /**
4283
- * The eventType property
4469
+ * One of `created`, `updated`, or `deleted`.
4284
4470
  */
4285
4471
  eventType?: string | null;
4286
4472
  /**
4287
- * The filehash property
4473
+ * Current persisted state of a changed video filehash row, including soft-delete fields.
4288
4474
  */
4289
4475
  filehash?: VideoFilehashChangeFilehashDto | null;
4290
4476
  }
4477
+ /**
4478
+ * Current persisted state of a changed video filehash row, including soft-delete fields.
4479
+ */
4291
4480
  export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Parsable {
4292
4481
  /**
4293
4482
  * The createdAtUtc property
4294
4483
  */
4295
4484
  createdAtUtc?: Date | null;
4296
4485
  /**
4297
- * The deletedAtUtc property
4486
+ * Timestamp when the row was soft-deleted, or null when still active.
4298
4487
  */
4299
4488
  deletedAtUtc?: Date | null;
4300
4489
  /**
4301
- * The filename property
4490
+ * Original filename submitted for this filehash record.
4302
4491
  */
4303
4492
  filename?: string | null;
4304
4493
  /**
4305
- * The filesize property
4494
+ * File size in bytes.
4306
4495
  */
4307
4496
  filesize?: number | null;
4308
4497
  /**
@@ -4310,23 +4499,23 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
4310
4499
  */
4311
4500
  id?: Guid | null;
4312
4501
  /**
4313
- * The isDeleted property
4502
+ * Whether this row is soft-deleted.
4314
4503
  */
4315
4504
  isDeleted?: boolean | null;
4316
4505
  /**
4317
- * The isVerified property
4506
+ * Whether this filehash record has been verified.
4318
4507
  */
4319
4508
  isVerified?: boolean | null;
4320
4509
  /**
4321
- * The osHash property
4510
+ * OS hash value as stored, or null when not available.
4322
4511
  */
4323
4512
  osHash?: string | null;
4324
4513
  /**
4325
- * The pHash property
4514
+ * P hash value as stored, or null when not available.
4326
4515
  */
4327
4516
  pHash?: string | null;
4328
4517
  /**
4329
- * The submissionCount property
4518
+ * Number of submissions merged into this filehash record.
4330
4519
  */
4331
4520
  submissionCount?: number | null;
4332
4521
  /**
@@ -4338,6 +4527,9 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
4338
4527
  */
4339
4528
  videoId?: Guid | null;
4340
4529
  }
4530
+ /**
4531
+ * Seek cursor for continuing a video filehash change feed.
4532
+ */
4341
4533
  export interface VideoFilehashChangesCursorDto extends AdditionalDataHolder, Parsable {
4342
4534
  /**
4343
4535
  * The id property
@@ -4354,11 +4546,11 @@ export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
4354
4546
  */
4355
4547
  createdAtUtc?: Date | null;
4356
4548
  /**
4357
- * The filename property
4549
+ * Original filename submitted for this filehash record.
4358
4550
  */
4359
4551
  filename?: string | null;
4360
4552
  /**
4361
- * The filesize property
4553
+ * File size in bytes.
4362
4554
  */
4363
4555
  filesize?: number | null;
4364
4556
  /**
@@ -4366,19 +4558,19 @@ export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
4366
4558
  */
4367
4559
  id?: Guid | null;
4368
4560
  /**
4369
- * The isVerified property
4561
+ * Whether this filehash record has been verified.
4370
4562
  */
4371
4563
  isVerified?: boolean | null;
4372
4564
  /**
4373
- * The osHash property
4565
+ * OS hash value as stored, or null when not available.
4374
4566
  */
4375
4567
  osHash?: string | null;
4376
4568
  /**
4377
- * The pHash property
4569
+ * P hash value as stored, or null when not available.
4378
4570
  */
4379
4571
  pHash?: string | null;
4380
4572
  /**
4381
- * The submissionCount property
4573
+ * Number of submissions merged into this filehash record.
4382
4574
  */
4383
4575
  submissionCount?: number | null;
4384
4576
  /**
@@ -4400,43 +4592,49 @@ export interface VideoFilehashesByVideoIdDto extends AdditionalDataHolder, Parsa
4400
4592
  */
4401
4593
  videoId?: Guid | null;
4402
4594
  }
4595
+ /**
4596
+ * Minimal actor summary included in a video list item.
4597
+ */
4403
4598
  export interface VideoSummaryActorDto extends AdditionalDataHolder, Parsable {
4404
4599
  /**
4405
- * The id property
4600
+ * Unique identifier of the actor.
4406
4601
  */
4407
4602
  id?: Guid | null;
4408
4603
  /**
4409
- * The name property
4604
+ * Actor name.
4410
4605
  */
4411
4606
  name?: string | null;
4412
4607
  }
4608
+ /**
4609
+ * Summary of a single video.
4610
+ */
4413
4611
  export interface VideoSummaryDto extends AdditionalDataHolder, Parsable {
4414
4612
  /**
4415
- * The actors property
4613
+ * Actors appearing in this video.
4416
4614
  */
4417
4615
  actors?: VideoSummaryActorDto[] | null;
4418
4616
  /**
4419
- * The createdAtUtc property
4617
+ * Timestamp when the video was created in PRDB.
4420
4618
  */
4421
4619
  createdAtUtc?: Date | null;
4422
4620
  /**
4423
- * The id property
4621
+ * Unique identifier of the video.
4424
4622
  */
4425
4623
  id?: Guid | null;
4426
4624
  /**
4427
- * The releaseDate property
4625
+ * Release date of the video, if known.
4428
4626
  */
4429
4627
  releaseDate?: DateOnly | null;
4430
4628
  /**
4431
- * The siteId property
4629
+ * Unique identifier of the site this video belongs to.
4432
4630
  */
4433
4631
  siteId?: Guid | null;
4434
4632
  /**
4435
- * The siteTitle property
4633
+ * Title of the site this video belongs to.
4436
4634
  */
4437
4635
  siteTitle?: string | null;
4438
4636
  /**
4439
- * The title property
4637
+ * Video title.
4440
4638
  */
4441
4639
  title?: string | null;
4442
4640
  }
@@ -4462,7 +4660,7 @@ export interface VideoUserImageChangesCursorDto extends AdditionalDataHolder, Pa
4462
4660
  }
4463
4661
  export interface VideoUserImageDto extends AdditionalDataHolder, Parsable {
4464
4662
  /**
4465
- * The basedOnFileWithOsHash property
4663
+ * Server-validated 16-character OS hash of the file the preview is based on.
4466
4664
  */
4467
4665
  basedOnFileWithOsHash?: string | null;
4468
4666
  /**
@@ -4510,23 +4708,23 @@ export interface VideoUserImageDto extends AdditionalDataHolder, Parsable {
4510
4708
  */
4511
4709
  previewImageType?: string | null;
4512
4710
  /**
4513
- * The spriteColumns property
4711
+ * Number of occupied tile columns in the sprite-sheet grid.
4514
4712
  */
4515
4713
  spriteColumns?: number | null;
4516
4714
  /**
4517
- * The spriteRows property
4715
+ * Number of occupied tile rows in the sprite-sheet grid.
4518
4716
  */
4519
4717
  spriteRows?: number | null;
4520
4718
  /**
4521
- * The spriteTileCount property
4719
+ * Number of sprite tiles described by the paired WebVTT metadata object.
4522
4720
  */
4523
4721
  spriteTileCount?: number | null;
4524
4722
  /**
4525
- * The spriteTileHeight property
4723
+ * Uniform sprite tile height in pixels.
4526
4724
  */
4527
4725
  spriteTileHeight?: number | null;
4528
4726
  /**
4529
- * The spriteTileWidth property
4727
+ * Uniform sprite tile width in pixels.
4530
4728
  */
4531
4729
  spriteTileWidth?: number | null;
4532
4730
  /**
@@ -4534,7 +4732,7 @@ export interface VideoUserImageDto extends AdditionalDataHolder, Parsable {
4534
4732
  */
4535
4733
  updatedAtUtc?: Date | null;
4536
4734
  /**
4537
- * The url property
4735
+ * Resolved public CDN URL for the stored image object.
4538
4736
  */
4539
4737
  url?: string | null;
4540
4738
  /**
@@ -4546,7 +4744,7 @@ export interface VideoUserImageDto extends AdditionalDataHolder, Parsable {
4546
4744
  */
4547
4745
  videoId?: Guid | null;
4548
4746
  /**
4549
- * The vttUrl property
4747
+ * Resolved public CDN URL for the paired WebVTT metadata object when this image is a sprite sheet.
4550
4748
  */
4551
4749
  vttUrl?: string | null;
4552
4750
  /**
@@ -4554,16 +4752,22 @@ export interface VideoUserImageDto extends AdditionalDataHolder, Parsable {
4554
4752
  */
4555
4753
  width?: number | null;
4556
4754
  }
4755
+ /**
4756
+ * A single changed wanted video row in the incremental feed.
4757
+ */
4557
4758
  export interface WantedVideoChangeDto extends AdditionalDataHolder, Parsable {
4558
4759
  /**
4559
- * The eventType property
4760
+ * One of `created`, `updated`, or `deleted`.
4560
4761
  */
4561
4762
  eventType?: string | null;
4562
4763
  /**
4563
- * The wantedVideo property
4764
+ * Current-state payload for a wanted video row in the incremental feed.
4564
4765
  */
4565
4766
  wantedVideo?: WantedVideoChangeWantedVideoDto | null;
4566
4767
  }
4768
+ /**
4769
+ * Seek cursor for continuing a wanted video change feed.
4770
+ */
4567
4771
  export interface WantedVideoChangesCursorDto extends AdditionalDataHolder, Parsable {
4568
4772
  /**
4569
4773
  * The id property
@@ -4574,6 +4778,9 @@ export interface WantedVideoChangesCursorDto extends AdditionalDataHolder, Parsa
4574
4778
  */
4575
4779
  updatedAtUtc?: Date | null;
4576
4780
  }
4781
+ /**
4782
+ * Current-state payload for a wanted video row in the incremental feed.
4783
+ */
4577
4784
  export interface WantedVideoChangeWantedVideoDto extends AdditionalDataHolder, Parsable {
4578
4785
  /**
4579
4786
  * The createdAtUtc property
@@ -4636,13 +4843,16 @@ export interface WantedVideoChangeWantedVideoDto extends AdditionalDataHolder, P
4636
4843
  */
4637
4844
  videoTitle?: string | null;
4638
4845
  }
4846
+ /**
4847
+ * A wanted video entry for the current user.
4848
+ */
4639
4849
  export interface WantedVideoSummaryDto extends AdditionalDataHolder, Parsable {
4640
4850
  /**
4641
- * The createdAtUtc property
4851
+ * When this wanted video entry was created.
4642
4852
  */
4643
4853
  createdAtUtc?: Date | null;
4644
4854
  /**
4645
- * The fulfilledAtUtc property
4855
+ * When the wanted video was fulfilled, if applicable.
4646
4856
  */
4647
4857
  fulfilledAtUtc?: Date | null;
4648
4858
  /**
@@ -4654,44 +4864,44 @@ export interface WantedVideoSummaryDto extends AdditionalDataHolder, Parsable {
4654
4864
  */
4655
4865
  fulfillmentByApp?: number | null;
4656
4866
  /**
4657
- * The fulfillmentExternalId property
4867
+ * External identifier from the fulfilling application, if applicable.
4658
4868
  */
4659
4869
  fulfillmentExternalId?: string | null;
4660
4870
  /**
4661
- * The imageCdnPath property
4871
+ * Absolute CDN URL for the video's primary image, if available.
4662
4872
  */
4663
4873
  imageCdnPath?: string | null;
4664
4874
  /**
4665
- * The isFulfilled property
4875
+ * Whether this wanted video has been fulfilled.
4666
4876
  */
4667
4877
  isFulfilled?: boolean | null;
4668
4878
  /**
4669
- * The siteTitle property
4879
+ * Title of the site this video belongs to.
4670
4880
  */
4671
4881
  siteTitle?: string | null;
4672
4882
  /**
4673
- * The updatedAtUtc property
4883
+ * When this wanted video entry was last updated.
4674
4884
  */
4675
4885
  updatedAtUtc?: Date | null;
4676
4886
  /**
4677
- * The videoCreatedAtUtc property
4887
+ * When the video was added to the database.
4678
4888
  */
4679
4889
  videoCreatedAtUtc?: Date | null;
4680
4890
  /**
4681
- * The videoId property
4891
+ * ID of the wanted video.
4682
4892
  */
4683
4893
  videoId?: Guid | null;
4684
4894
  /**
4685
- * The videoReleaseDate property
4895
+ * Release date of the video, if known.
4686
4896
  */
4687
4897
  videoReleaseDate?: DateOnly | null;
4688
4898
  /**
4689
- * The videoTitle property
4899
+ * Video title.
4690
4900
  */
4691
4901
  videoTitle?: string | null;
4692
4902
  }
4693
4903
  /**
4694
- * Allowed values: DrunkenSlug, NzbFinder, NzbPorn.
4904
+ * Indexer source. Supported values: `DrunkenSlug`, `NzbFinder`, `NzbPorn`. Allowed values: DrunkenSlug, NzbFinder, NzbPorn.
4695
4905
  */
4696
4906
  export declare const IndexerFilehashLookupKeyDto_indexerSourceObject: {
4697
4907
  readonly DrunkenSlug: "DrunkenSlug";