@prdb/sdk 0.6.0 → 0.6.1

package/dist/generated/downloadedFromIndexers/index.d.ts

@@ -12,7 +12,7 @@ export interface DownloadedFromIndexersRequestBuilder extends BaseRequestBuilder
      */
     byDownloadedFromIndexerId(downloadedFromIndexerId: Guid): WithDownloadedFromIndexerItemRequestBuilder;
     /**
-     * Creates a downloaded-from-indexer entry for the authenticated user and returns 201, or returns the complete existing owned entry without mutating it and returns 200. Uniqueness is defined by userId, videoId (including null), indexerSource, and the trimmed indexerId; comparison uses the database collation. downloadIdentifier is not part of the key. Returns 404 when the referenced wanted video does not exist and 409 only for a different non-recoverable conflict.
+     * Creates a downloaded-from-indexer entry for the authenticated user and returns 201, or returns the complete existing owned entry without mutating it and returns 200. Uniqueness is defined by userId, videoId (including null), indexerSource, and the trimmed indexerId; comparison uses the database collation. downloadIdentifier is not part of the key. A pHash on a filename must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. Returns 404 when the referenced wanted video does not exist and 409 only for a different non-recoverable conflict.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<DownloadedFromIndexerResponse>}
@@ -26,7 +26,7 @@ export interface DownloadedFromIndexersRequestBuilder extends BaseRequestBuilder
      */
     post(body: AddDownloadedFromIndexerRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<DownloadedFromIndexerResponse | undefined>;
     /**
-     * Creates a downloaded-from-indexer entry for the authenticated user and returns 201, or returns the complete existing owned entry without mutating it and returns 200. Uniqueness is defined by userId, videoId (including null), indexerSource, and the trimmed indexerId; comparison uses the database collation. downloadIdentifier is not part of the key. Returns 404 when the referenced wanted video does not exist and 409 only for a different non-recoverable conflict.
+     * Creates a downloaded-from-indexer entry for the authenticated user and returns 201, or returns the complete existing owned entry without mutating it and returns 200. Uniqueness is defined by userId, videoId (including null), indexerSource, and the trimmed indexerId; comparison uses the database collation. downloadIdentifier is not part of the key. A pHash on a filename must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. Returns 404 when the referenced wanted video does not exist and 409 only for a different non-recoverable conflict.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/generated/downloadedFromIndexers/item/filenames/index.d.ts

@@ -12,7 +12,7 @@ export interface FilenamesRequestBuilder extends BaseRequestBuilder<FilenamesReq
      */
     byFilenameId(filenameId: Guid): WithFilenameItemRequestBuilder;
     /**
-     * Adds a single filename row to a downloaded-from-indexer entry owned by the currently authenticated user. Returns 409 when the filename already exists under the parent entry.
+     * Adds a single filename row to a downloaded-from-indexer entry owned by the currently authenticated user. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. Returns 409 when the filename already exists under the parent entry.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<DownloadedFromIndexerResponse>}
@@ -26,7 +26,7 @@ export interface FilenamesRequestBuilder extends BaseRequestBuilder<FilenamesReq
      */
     post(body: AddDownloadedFromIndexerFilenameRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<DownloadedFromIndexerResponse | undefined>;
     /**
-     * Adds a single filename row to a downloaded-from-indexer entry owned by the currently authenticated user. Returns 409 when the filename already exists under the parent entry.
+     * Adds a single filename row to a downloaded-from-indexer entry owned by the currently authenticated user. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. Returns 409 when the filename already exists under the parent entry.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/generated/downloadedFromIndexers/item/filenames/item/index.d.ts

@@ -15,7 +15,7 @@ export interface WithFilenameItemRequestBuilder extends BaseRequestBuilder<WithF
      */
     delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
     /**
-     * Updates a single filename row for a downloaded-from-indexer entry owned by the currently authenticated user. Returns 409 when the filename would duplicate another filename under the same parent.
+     * Updates a single filename row for a downloaded-from-indexer entry owned by the currently authenticated user. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. Returns 409 when the filename would duplicate another filename under the same parent.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<DownloadedFromIndexerResponse>}
@@ -35,7 +35,7 @@ export interface WithFilenameItemRequestBuilder extends BaseRequestBuilder<WithF
      */
     toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
     /**
-     * Updates a single filename row for a downloaded-from-indexer entry owned by the currently authenticated user. Returns 409 when the filename would duplicate another filename under the same parent.
+     * Updates a single filename row for a downloaded-from-indexer entry owned by the currently authenticated user. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. Returns 409 when the filename would duplicate another filename under the same parent.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/generated/indexerFilehashes/lookup/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface LookupRequestBuilder extends BaseRequestBuilder<LookupRequestBuilder> {
     /**
-     * Returns a flat list of active indexer filehash entries matching any supplied IDs, combined indexer source and indexer ID pairs, hashes, filenames, or file sizes. Requires API key authentication.
+     * Returns a flat list of active indexer filehash entries matching any supplied IDs, combined indexer source and indexer ID pairs, hashes, filenames, or file sizes. pHashes are matched for equality and must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure matches nothing. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<LookupIndexerFilehashesResponse>}
@@ -17,7 +17,7 @@ export interface LookupRequestBuilder extends BaseRequestBuilder<LookupRequestBu
      */
     post(body: LookupIndexerFilehashesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LookupIndexerFilehashesResponse | undefined>;
     /**
-     * Returns a flat list of active indexer filehash entries matching any supplied IDs, combined indexer source and indexer ID pairs, hashes, filenames, or file sizes. Requires API key authentication.
+     * Returns a flat list of active indexer filehash entries matching any supplied IDs, combined indexer source and indexer ID pairs, hashes, filenames, or file sizes. pHashes are matched for equality and must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure matches nothing. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/generated/models/index.d.ts

@@ -51,7 +51,7 @@ export interface ActorChangeActorDto extends AdditionalDataHolder, Parsable {
      */
     birthday?: DateOnly | null;
     /**
-     * The birthdayType property
+     * Known values: ExactDate (1), MonthYear (2), Year (3).
      */
     birthdayType?: number | null;
     /**
@@ -269,7 +269,7 @@ export interface ActorDetailDto extends AdditionalDataHolder, Parsable {
      */
     birthday?: DateOnly | null;
     /**
-     * The birthdayType property
+     * Known values: ExactDate (1), MonthYear (2), Year (3).
      */
     birthdayType?: number | null;
     /**
@@ -2149,11 +2149,11 @@ export interface FulfillWantedVideoItem extends AdditionalDataHolder, Parsable {
      */
     fulfilledAtUtc?: Date | null;
     /**
-     * The fulfilledInQuality property
+     * Known values: P720 (0), P1080 (1), P2160 (2).
      */
     fulfilledInQuality?: number | null;
     /**
-     * The fulfillmentByApp property
+     * Known values: Sabnzbd (0), Nzbget (1), Filesystem (2), Other (3), Ordeno (4).
      */
     fulfillmentByApp?: number | null;
     /**
@@ -2443,7 +2443,7 @@ export interface IdentifyVideoResultDto extends AdditionalDataHolder, Parsable {
      */
     confidence?: number | null;
     /**
-     * The matchedBy property
+     * Known values: OsHash (0), PHash (1), Filename (2), ReleaseName (3), Site (4).
      */
     matchedBy?: number | null;
     /**
@@ -4088,11 +4088,11 @@ export interface UpdateWantedVideoRequest extends AdditionalDataHolder, Parsable
      */
     fulfilledAtUtc?: Date | null;
     /**
-     * The fulfilledInQuality property
+     * Known values: P720 (0), P1080 (1), P2160 (2).
      */
     fulfilledInQuality?: number | null;
     /**
-     * The fulfillmentByApp property
+     * Known values: Sabnzbd (0), Nzbget (1), Filesystem (2), Other (3), Ordeno (4).
      */
     fulfillmentByApp?: number | null;
     /**
@@ -4114,11 +4114,11 @@ export interface UpdateWantedVideoResponse extends AdditionalDataHolder, Parsabl
      */
     fulfilledAtUtc?: Date | null;
     /**
-     * The fulfilledInQuality property
+     * Known values: P720 (0), P1080 (1), P2160 (2).
      */
     fulfilledInQuality?: number | null;
     /**
-     * The fulfillmentByApp property
+     * Known values: Sabnzbd (0), Nzbget (1), Filesystem (2), Other (3), Ordeno (4).
      */
     fulfillmentByApp?: number | null;
     /**
@@ -4588,11 +4588,11 @@ export interface WantedVideoChangeWantedVideoDto extends AdditionalDataHolder, P
      */
     fulfilledAtUtc?: Date | null;
     /**
-     * The fulfilledInQuality property
+     * Known values: P720 (0), P1080 (1), P2160 (2).
      */
     fulfilledInQuality?: number | null;
     /**
-     * The fulfillmentByApp property
+     * Known values: Sabnzbd (0), Nzbget (1), Filesystem (2), Other (3), Ordeno (4).
      */
     fulfillmentByApp?: number | null;
     /**
@@ -4646,11 +4646,11 @@ export interface WantedVideoSummaryDto extends AdditionalDataHolder, Parsable {
      */
     fulfilledAtUtc?: Date | null;
     /**
-     * The fulfilledInQuality property
+     * Known values: P720 (0), P1080 (1), P2160 (2).
      */
     fulfilledInQuality?: number | null;
     /**
-     * The fulfillmentByApp property
+     * Known values: Sabnzbd (0), Nzbget (1), Filesystem (2), Other (3), Ordeno (4).
      */
     fulfillmentByApp?: number | null;
     /**

package/dist/generated/videos/filehashSubmissions/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface FilehashSubmissionsRequestBuilder extends BaseRequestBuilder<FilehashSubmissionsRequestBuilder> {
     /**
-     * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. Intended for assignments a person confirmed in a client's UI — exactly the cases automatic detection missed. Each entry needs a videoId and an osHash; the osHash is the only aggregation key, so an entry carrying only a pHash cannot be used. The filename is optional and may be withheld; the endpoint works without it. Every entry gets its own outcome and the status stays 200: an unknown videoId is reported as videoNotFound, and an assignment that contradicts an existing one is stored as conflicted rather than overwriting it. Submissions are recorded in their own table. They appear in no read endpoint and change no lookup result; whether they ever enter the aggregated hash set is decided by the scraper's aggregation job, not here. Clients must make this strictly opt-in and off by default — that is a client-side obligation the API cannot enforce. Requires API key authentication.
+     * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. Intended for assignments a person confirmed in a client's UI — exactly the cases automatic detection missed. Each entry needs a videoId and an osHash; the osHash is the only aggregation key, so an entry carrying only a pHash cannot be used. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. The filename is optional and may be withheld; the endpoint works without it. Every entry gets its own outcome and the status stays 200: an unknown videoId is reported as videoNotFound, and an assignment that contradicts an existing one is stored as conflicted rather than overwriting it. Submissions are recorded in their own table. They appear in no read endpoint and change no lookup result; whether they ever enter the aggregated hash set is decided by the scraper's aggregation job, not here. Clients must make this strictly opt-in and off by default — that is a client-side obligation the API cannot enforce. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<SubmitVideoFilehashesResponse>}
@@ -17,7 +17,7 @@ export interface FilehashSubmissionsRequestBuilder extends BaseRequestBuilder<Fi
      */
     post(body: SubmitVideoFilehashesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SubmitVideoFilehashesResponse | undefined>;
     /**
-     * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. Intended for assignments a person confirmed in a client's UI — exactly the cases automatic detection missed. Each entry needs a videoId and an osHash; the osHash is the only aggregation key, so an entry carrying only a pHash cannot be used. The filename is optional and may be withheld; the endpoint works without it. Every entry gets its own outcome and the status stays 200: an unknown videoId is reported as videoNotFound, and an assignment that contradicts an existing one is stored as conflicted rather than overwriting it. Submissions are recorded in their own table. They appear in no read endpoint and change no lookup result; whether they ever enter the aggregated hash set is decided by the scraper's aggregation job, not here. Clients must make this strictly opt-in and off by default — that is a client-side obligation the API cannot enforce. Requires API key authentication.
+     * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. Intended for assignments a person confirmed in a client's UI — exactly the cases automatic detection missed. Each entry needs a videoId and an osHash; the osHash is the only aggregation key, so an entry carrying only a pHash cannot be used. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure is stored but can never be matched. The filename is optional and may be withheld; the endpoint works without it. Every entry gets its own outcome and the status stays 200: an unknown videoId is reported as videoNotFound, and an assignment that contradicts an existing one is stored as conflicted rather than overwriting it. Submissions are recorded in their own table. They appear in no read endpoint and change no lookup result; whether they ever enter the aggregated hash set is decided by the scraper's aggregation job, not here. Clients must make this strictly opt-in and off by default — that is a client-side obligation the API cannot enforce. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/generated/videos/filehashes/lookup/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface LookupRequestBuilder extends BaseRequestBuilder<LookupRequestBuilder> {
     /**
-     * Returns a flat list of active filehash entries matching any supplied IDs, video IDs, hashes, filenames, or file sizes. Results can include unlinked rows whose videoId is null. Requires API key authentication.
+     * Returns a flat list of active filehash entries matching any supplied IDs, video IDs, hashes, filenames, or file sizes. Results can include unlinked rows whose videoId is null. pHashes are matched for equality and must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure matches nothing. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<LookupVideoFilehashesResponse>}
@@ -17,7 +17,7 @@ export interface LookupRequestBuilder extends BaseRequestBuilder<LookupRequestBu
      */
     post(body: LookupVideoFilehashesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LookupVideoFilehashesResponse | undefined>;
     /**
-     * Returns a flat list of active filehash entries matching any supplied IDs, video IDs, hashes, filenames, or file sizes. Results can include unlinked rows whose videoId is null. Requires API key authentication.
+     * Returns a flat list of active filehash entries matching any supplied IDs, video IDs, hashes, filenames, or file sizes. Results can include unlinked rows whose videoId is null. pHashes are matched for equality and must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure matches nothing. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/dist/generated/videos/identify/index.d.ts

@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
  */
 export interface IdentifyRequestBuilder extends BaseRequestBuilder<IdentifyRequestBuilder> {
     /**
-     * Identifies up to 200 local files in one request and returns one result per file, mapped back by the client-assigned ref and in input order. Each file walks an identification ladder and the first rung that matches wins: OS hash, then perceptual hash (compared for equality), then a stored file name, then the file name without its extension as a scene release title, and finally the site read out of the file name. matchedBy names the rung and confidence says how far the result can be trusted, so a client can decide which files it may file automatically and which it must show to a person. When a rung matches several videos equally well, the server does not guess: videoId is null, confidence is ambiguous and every candidate is listed. A file that matches nothing is a result with confidence none, not an error. Set includeVideoDetails to receive the full video document per matched file; it is off by default because 200 full documents is a large response. The whole request counts as one request against the rate limit. Nothing sent to this endpoint is stored. Requires API key authentication.
+     * Identifies up to 200 local files in one request and returns one result per file, mapped back by the client-assigned ref and in input order. Each file walks an identification ladder and the first rung that matches wins: OS hash, then perceptual hash (compared for equality), then a stored file name, then the file name without its extension as a scene release title, and finally the site read out of the file name. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure skips that rung silently rather than failing, so send none if in doubt. matchedBy names the rung and confidence says how far the result can be trusted, so a client can decide which files it may file automatically and which it must show to a person. When a rung matches several videos equally well, the server does not guess: videoId is null, confidence is ambiguous and every candidate is listed. A file that matches nothing is a result with confidence none, not an error. Set includeVideoDetails to receive the full video document per matched file; it is off by default because 200 full documents is a large response. The whole request counts as one request against the rate limit. Nothing sent to this endpoint is stored. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {Promise<IdentifyVideosResponse>}
@@ -17,7 +17,7 @@ export interface IdentifyRequestBuilder extends BaseRequestBuilder<IdentifyReque
      */
     post(body: IdentifyVideosRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<IdentifyVideosResponse | undefined>;
     /**
-     * Identifies up to 200 local files in one request and returns one result per file, mapped back by the client-assigned ref and in input order. Each file walks an identification ladder and the first rung that matches wins: OS hash, then perceptual hash (compared for equality), then a stored file name, then the file name without its extension as a scene release title, and finally the site read out of the file name. matchedBy names the rung and confidence says how far the result can be trusted, so a client can decide which files it may file automatically and which it must show to a person. When a rung matches several videos equally well, the server does not guess: videoId is null, confidence is ambiguous and every candidate is listed. A file that matches nothing is a result with confidence none, not an error. Set includeVideoDetails to receive the full video document per matched file; it is off by default because 200 full documents is a large response. The whole request counts as one request against the rate limit. Nothing sent to this endpoint is stored. Requires API key authentication.
+     * Identifies up to 200 local files in one request and returns one result per file, mapped back by the client-assigned ref and in input order. Each file walks an identification ladder and the first rung that matches wins: OS hash, then perceptual hash (compared for equality), then a stored file name, then the file name without its extension as a scene release title, and finally the site read out of the file name. A pHash must be computed exactly as described under Perceptual hashes in the API description; a value from any other procedure skips that rung silently rather than failing, so send none if in doubt. matchedBy names the rung and confidence says how far the result can be trusted, so a client can decide which files it may file automatically and which it must show to a person. When a rung matches several videos equally well, the server does not guess: videoId is null, confidence is ambiguous and every candidate is listed. A file that matches nothing is a result with confidence none, not an error. Set includeVideoDetails to receive the full video document per matched file; it is off by default because 200 full documents is a large response. The whole request counts as one request against the rate limit. Nothing sent to this endpoint is stored. Requires API key authentication.
      * @param body The request body
      * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
      * @returns {RequestInformation}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prdb/sdk",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "TypeScript SDK for the prdb Public API",
   "license": "MIT",
   "repository": {