@prdb/sdk 0.9.0 → 0.11.0

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.
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface BatchRequestBuilder extends BaseRequestBuilder<BatchRequestBuilder> {
7
7
  /**
8
- * Returns full details for up to 50 videos by their IDs. IDs that do not exist are silently omitted from the response. Requires API key authentication.
8
+ * Returns full details for up to 50 videos by their IDs. IDs that do not exist are silently omitted from the response. Each video carries its consensus duration and its qualityOverview on the same terms as the single-video endpoint; see Media metadata in the API description. Requires API key authentication.
9
9
  * @param body The request body
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<VideoDetailDto[]>}
@@ -17,7 +17,7 @@ export interface BatchRequestBuilder extends BaseRequestBuilder<BatchRequestBuil
17
17
  */
18
18
  post(body: GetVideosByIdsRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<VideoDetailDto[] | undefined>;
19
19
  /**
20
- * Returns full details for up to 50 videos by their IDs. IDs that do not exist are silently omitted from the response. Requires API key authentication.
20
+ * Returns full details for up to 50 videos by their IDs. IDs that do not exist are silently omitted from the response. Each video carries its consensus duration and its qualityOverview on the same terms as the single-video endpoint; see Media metadata in the API description. Requires API key authentication.
21
21
  * @param body The request body
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface FilehashSubmissionsRequestBuilder extends BaseRequestBuilder<FilehashSubmissionsRequestBuilder> {
7
7
  /**
8
- * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. This is the contribution path for both kinds of assignment: one a person confirmed in a client's UI (userConfirmed) and one the client made on its own (clientDetected). 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 and the releaseName are optional and may be withheld; the endpoint works without either. 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 and appear in no read endpoint. They do reach the aggregated hash set: the scraper's aggregation job counts every non-conflicted submission, weighing userConfirmed and clientDetected alike, and promotes an assignment once enough distinct users agree on it. A conflicted submission never counts towards one. The two sources carry different client-side obligations, which the API cannot enforce: a userConfirmed submission must be strictly opt-in and off by default, because a person is vouching for it; a clientDetected submission may be on by default but has to be switchable off. Requires API key authentication.
8
+ * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. This is the contribution path for both kinds of assignment: one a person confirmed in a client's UI (userConfirmed) and one the client made on its own (clientDetected). 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 and the releaseName are optional and may be withheld; the endpoint works without either. The technical profile of the file is optional in the same way, field by field: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels. Send what the probe reported and leave out what it did not, rather than sending a zero or a guess. The frame rate goes as the rational it was measured as (24000/1001), not as a rounded number, and width and height go as stored, not reordered to make the file landscape; portrait files are ordinary. The container tag block is not accepted: encoder, comment and title are the submitter's data, not the file's, and the endpoint takes the numeric profile only. Nothing reads these values yet; they are recorded for the aggregation that is to derive a consensus duration and a quality overview from them. 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 and appear in no read endpoint. They do reach the aggregated hash set: the scraper's aggregation job counts every non-conflicted submission, weighing userConfirmed and clientDetected alike, and promotes an assignment once enough distinct users agree on it. A conflicted submission never counts towards one. The two sources carry different client-side obligations, which the API cannot enforce: a userConfirmed submission must be strictly opt-in and off by default, because a person is vouching for it; a clientDetected submission may be on by default but has to be switchable off. Requires API key authentication.
9
9
  * @param body Request body for submitting confirmed hash-to-video assignments.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<SubmitVideoFilehashesResponse>}
@@ -17,7 +17,7 @@ export interface FilehashSubmissionsRequestBuilder extends BaseRequestBuilder<Fi
17
17
  */
18
18
  post(body: SubmitVideoFilehashesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SubmitVideoFilehashesResponse | undefined>;
19
19
  /**
20
- * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. This is the contribution path for both kinds of assignment: one a person confirmed in a client's UI (userConfirmed) and one the client made on its own (clientDetected). 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 and the releaseName are optional and may be withheld; the endpoint works without either. 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 and appear in no read endpoint. They do reach the aggregated hash set: the scraper's aggregation job counts every non-conflicted submission, weighing userConfirmed and clientDetected alike, and promotes an assignment once enough distinct users agree on it. A conflicted submission never counts towards one. The two sources carry different client-side obligations, which the API cannot enforce: a userConfirmed submission must be strictly opt-in and off by default, because a person is vouching for it; a clientDetected submission may be on by default but has to be switchable off. Requires API key authentication.
20
+ * Submits up to 200 assignments of a file hash to a video, on behalf of the authenticated user. This is the contribution path for both kinds of assignment: one a person confirmed in a client's UI (userConfirmed) and one the client made on its own (clientDetected). 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 and the releaseName are optional and may be withheld; the endpoint works without either. The technical profile of the file is optional in the same way, field by field: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels. Send what the probe reported and leave out what it did not, rather than sending a zero or a guess. The frame rate goes as the rational it was measured as (24000/1001), not as a rounded number, and width and height go as stored, not reordered to make the file landscape; portrait files are ordinary. The container tag block is not accepted: encoder, comment and title are the submitter's data, not the file's, and the endpoint takes the numeric profile only. Nothing reads these values yet; they are recorded for the aggregation that is to derive a consensus duration and a quality overview from them. 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 and appear in no read endpoint. They do reach the aggregated hash set: the scraper's aggregation job counts every non-conflicted submission, weighing userConfirmed and clientDetected alike, and promotes an assignment once enough distinct users agree on it. A conflicted submission never counts towards one. The two sources carry different client-side obligations, which the API cannot enforce: a userConfirmed submission must be strictly opt-in and off by default, because a person is vouching for it; a clientDetected submission may be on by default but has to be switchable off. Requires API key authentication.
21
21
  * @param body Request body for submitting confirmed hash-to-video assignments.
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface BatchRequestBuilder extends BaseRequestBuilder<BatchRequestBuilder> {
7
7
  /**
8
- * Returns all filehash entries for up to 100 requested video IDs grouped by video ID. Existing videos are included even when they have no filehashes; unknown video IDs are returned separately. Requires API key authentication.
8
+ * Returns all filehash entries for up to 100 requested video IDs grouped by video ID. Existing videos are included even when they have no filehashes; unknown video IDs are returned separately. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
9
9
  * @param body The request body
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<GetVideoFilehashesByVideoIdsResponse>}
@@ -17,7 +17,7 @@ export interface BatchRequestBuilder extends BaseRequestBuilder<BatchRequestBuil
17
17
  */
18
18
  post(body: GetVideoFilehashesByVideoIdsRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<GetVideoFilehashesByVideoIdsResponse | undefined>;
19
19
  /**
20
- * Returns all filehash entries for up to 100 requested video IDs grouped by video ID. Existing videos are included even when they have no filehashes; unknown video IDs are returned separately. Requires API key authentication.
20
+ * Returns all filehash entries for up to 100 requested video IDs grouped by video ID. Existing videos are included even when they have no filehashes; unknown video IDs are returned separately. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
21
21
  * @param body The request body
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type Guid, type RequestConfiguration, type Req
5
5
  */
6
6
  export interface ChangesRequestBuilder extends BaseRequestBuilder<ChangesRequestBuilder> {
7
7
  /**
8
- * Returns a seek-paged delta feed of video filehash rows ordered by updatedAtUtc ascending, then id ascending. Includes created, updated, and soft-deleted rows as full payloads. Use since and the returned nextCursor to continue incrementally. Supports optional video ID and site ID filters. Every page carries serverTimeUtc, the server clock read when the page was produced; persist it as the next since when items is empty. Requires API key authentication.
8
+ * Returns a seek-paged delta feed of video filehash rows ordered by updatedAtUtc ascending, then id ascending. Includes created, updated, and soft-deleted rows as full payloads. Use since and the returned nextCursor to continue incrementally. Supports optional video ID and site ID filters. Every page carries serverTimeUtc, the server clock read when the page was produced; persist it as the next since when items is empty. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
9
9
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
10
10
  * @returns {Promise<GetVideoFilehashChangesResponse>}
11
11
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -16,14 +16,14 @@ export interface ChangesRequestBuilder extends BaseRequestBuilder<ChangesRequest
16
16
  */
17
17
  get(requestConfiguration?: RequestConfiguration<ChangesRequestBuilderGetQueryParameters> | undefined): Promise<GetVideoFilehashChangesResponse | undefined>;
18
18
  /**
19
- * Returns a seek-paged delta feed of video filehash rows ordered by updatedAtUtc ascending, then id ascending. Includes created, updated, and soft-deleted rows as full payloads. Use since and the returned nextCursor to continue incrementally. Supports optional video ID and site ID filters. Every page carries serverTimeUtc, the server clock read when the page was produced; persist it as the next since when items is empty. Requires API key authentication.
19
+ * Returns a seek-paged delta feed of video filehash rows ordered by updatedAtUtc ascending, then id ascending. Includes created, updated, and soft-deleted rows as full payloads. Use since and the returned nextCursor to continue incrementally. Supports optional video ID and site ID filters. Every page carries serverTimeUtc, the server clock read when the page was produced; persist it as the next since when items is empty. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
20
20
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
21
  * @returns {RequestInformation}
22
22
  */
23
23
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<ChangesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
24
24
  }
25
25
  /**
26
- * Returns a seek-paged delta feed of video filehash rows ordered by updatedAtUtc ascending, then id ascending. Includes created, updated, and soft-deleted rows as full payloads. Use since and the returned nextCursor to continue incrementally. Supports optional video ID and site ID filters. Every page carries serverTimeUtc, the server clock read when the page was produced; persist it as the next since when items is empty. Requires API key authentication.
26
+ * Returns a seek-paged delta feed of video filehash rows ordered by updatedAtUtc ascending, then id ascending. Includes created, updated, and soft-deleted rows as full payloads. Use since and the returned nextCursor to continue incrementally. Supports optional video ID and site ID filters. Every page carries serverTimeUtc, the server clock read when the page was produced; persist it as the next since when items is empty. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
27
27
  */
28
28
  export interface ChangesRequestBuilderGetQueryParameters {
29
29
  /**
@@ -7,7 +7,7 @@ export type GetSortDirectionQueryParameterType = (typeof GetSortDirectionQueryPa
7
7
  */
8
8
  export interface LatestRequestBuilder extends BaseRequestBuilder<LatestRequestBuilder> {
9
9
  /**
10
- * Returns a paged list of active video filehash entries, including rows linked to videos and rows whose videoId is null. Supports up to 5000 rows per request, sorting by createdAtUtc, updatedAtUtc, submissionCount, or filesize, and filtering by video ID, site ID, verification state, and inclusive created/updated date ranges. Requires API key authentication.
10
+ * Returns a paged list of active video filehash entries, including rows linked to videos and rows whose videoId is null. Supports up to 5000 rows per request, sorting by createdAtUtc, updatedAtUtc, submissionCount, or filesize, and filtering by video ID, site ID, verification state, and inclusive created/updated date ranges. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
11
11
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
12
12
  * @returns {Promise<LatestVideoFilehashesResponse>}
13
13
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -18,14 +18,14 @@ export interface LatestRequestBuilder extends BaseRequestBuilder<LatestRequestBu
18
18
  */
19
19
  get(requestConfiguration?: RequestConfiguration<LatestRequestBuilderGetQueryParameters> | undefined): Promise<LatestVideoFilehashesResponse | undefined>;
20
20
  /**
21
- * Returns a paged list of active video filehash entries, including rows linked to videos and rows whose videoId is null. Supports up to 5000 rows per request, sorting by createdAtUtc, updatedAtUtc, submissionCount, or filesize, and filtering by video ID, site ID, verification state, and inclusive created/updated date ranges. Requires API key authentication.
21
+ * Returns a paged list of active video filehash entries, including rows linked to videos and rows whose videoId is null. Supports up to 5000 rows per request, sorting by createdAtUtc, updatedAtUtc, submissionCount, or filesize, and filtering by video ID, site ID, verification state, and inclusive created/updated date ranges. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
24
24
  */
25
25
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<LatestRequestBuilderGetQueryParameters> | undefined): RequestInformation;
26
26
  }
27
27
  /**
28
- * Returns a paged list of active video filehash entries, including rows linked to videos and rows whose videoId is null. Supports up to 5000 rows per request, sorting by createdAtUtc, updatedAtUtc, submissionCount, or filesize, and filtering by video ID, site ID, verification state, and inclusive created/updated date ranges. Requires API key authentication.
28
+ * Returns a paged list of active video filehash entries, including rows linked to videos and rows whose videoId is null. Supports up to 5000 rows per request, sorting by createdAtUtc, updatedAtUtc, submissionCount, or filesize, and filtering by video ID, site ID, verification state, and inclusive created/updated date ranges. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
29
29
  */
30
30
  export interface LatestRequestBuilderGetQueryParameters {
31
31
  /**
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface LookupRequestBuilder extends BaseRequestBuilder<LookupRequestBuilder> {
7
7
  /**
8
- * 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.
8
+ * 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. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
9
9
  * @param body The request body
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<LookupVideoFilehashesResponse>}
@@ -17,7 +17,7 @@ export interface LookupRequestBuilder extends BaseRequestBuilder<LookupRequestBu
17
17
  */
18
18
  post(body: LookupVideoFilehashesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LookupVideoFilehashesResponse | undefined>;
19
19
  /**
20
- * 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.
20
+ * 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. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
21
21
  * @param body The request body
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
@@ -7,7 +7,7 @@ export type GetSortDirectionQueryParameterType = (typeof GetSortDirectionQueryPa
7
7
  */
8
8
  export interface UnlinkedRequestBuilder extends BaseRequestBuilder<UnlinkedRequestBuilder> {
9
9
  /**
10
- * Returns a paged list of active filehash entries that are not linked to any video. Requires API key authentication.
10
+ * Returns a paged list of active filehash entries that are not linked to any video. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
11
11
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
12
12
  * @returns {Promise<UnlinkedVideoFilehashesResponse>}
13
13
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -18,14 +18,14 @@ export interface UnlinkedRequestBuilder extends BaseRequestBuilder<UnlinkedReque
18
18
  */
19
19
  get(requestConfiguration?: RequestConfiguration<UnlinkedRequestBuilderGetQueryParameters> | undefined): Promise<UnlinkedVideoFilehashesResponse | undefined>;
20
20
  /**
21
- * Returns a paged list of active filehash entries that are not linked to any video. Requires API key authentication.
21
+ * Returns a paged list of active filehash entries that are not linked to any video. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {RequestInformation}
24
24
  */
25
25
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<UnlinkedRequestBuilderGetQueryParameters> | undefined): RequestInformation;
26
26
  }
27
27
  /**
28
- * Returns a paged list of active filehash entries that are not linked to any video. Requires API key authentication.
28
+ * Returns a paged list of active filehash entries that are not linked to any video. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
29
29
  */
30
30
  export interface UnlinkedRequestBuilderGetQueryParameters {
31
31
  /**
@@ -39,7 +39,7 @@ export interface VideosRequestBuilder extends BaseRequestBuilder<VideosRequestBu
39
39
  */
40
40
  byId(id: Guid): ItemRequestBuilder;
41
41
  /**
42
- * Returns a paged list of videos. Supports filtering by site ID, actor ID, creation timestamp, and searching by video title or site title. Requires API key authentication.
42
+ * Returns a paged list of videos. Supports filtering by site ID, actor ID, creation timestamp, and searching by video title or site title. Each entry carries the consensus duration across the files known for the video — durationMs with durationSpreadMs and durationFileCount — or null where too few independent submitters have reported one. The per-file profile and the quality overview are not in the summary; fetch the video or its filehashes for those. Requires API key authentication.
43
43
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
44
44
  * @returns {Promise<ListVideosResponse>}
45
45
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -50,14 +50,14 @@ export interface VideosRequestBuilder extends BaseRequestBuilder<VideosRequestBu
50
50
  */
51
51
  get(requestConfiguration?: RequestConfiguration<VideosRequestBuilderGetQueryParameters> | undefined): Promise<ListVideosResponse | undefined>;
52
52
  /**
53
- * Returns a paged list of videos. Supports filtering by site ID, actor ID, creation timestamp, and searching by video title or site title. Requires API key authentication.
53
+ * Returns a paged list of videos. Supports filtering by site ID, actor ID, creation timestamp, and searching by video title or site title. Each entry carries the consensus duration across the files known for the video — durationMs with durationSpreadMs and durationFileCount — or null where too few independent submitters have reported one. The per-file profile and the quality overview are not in the summary; fetch the video or its filehashes for those. Requires API key authentication.
54
54
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
55
55
  * @returns {RequestInformation}
56
56
  */
57
57
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<VideosRequestBuilderGetQueryParameters> | undefined): RequestInformation;
58
58
  }
59
59
  /**
60
- * Returns a paged list of videos. Supports filtering by site ID, actor ID, creation timestamp, and searching by video title or site title. Requires API key authentication.
60
+ * Returns a paged list of videos. Supports filtering by site ID, actor ID, creation timestamp, and searching by video title or site title. Each entry carries the consensus duration across the files known for the video — durationMs with durationSpreadMs and durationFileCount — or null where too few independent submitters have reported one. The per-file profile and the quality overview are not in the summary; fetch the video or its filehashes for those. Requires API key authentication.
61
61
  */
62
62
  export interface VideosRequestBuilderGetQueryParameters {
63
63
  /**
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface FilehashesRequestBuilder extends BaseRequestBuilder<FilehashesRequestBuilder> {
7
7
  /**
8
- * Returns all filehash entries for a single video ordered by newest first. Returns 404 when the video does not exist. Requires API key authentication.
8
+ * Returns all filehash entries for a single video ordered by newest first. Returns 404 when the video does not exist. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
9
9
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
10
10
  * @returns {Promise<VideoFilehashDto[]>}
11
11
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -16,7 +16,7 @@ export interface FilehashesRequestBuilder extends BaseRequestBuilder<FilehashesR
16
16
  */
17
17
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<VideoFilehashDto[] | undefined>;
18
18
  /**
19
- * Returns all filehash entries for a single video ordered by newest first. Returns 404 when the video does not exist. Requires API key authentication.
19
+ * Returns all filehash entries for a single video ordered by newest first. Returns 404 when the video does not exist. Every filehash carries the technical profile aggregated from the clients that probed the file: durationMs, containerFormat, bitRate, videoCodec, width, height, frameRate, audioCodec and audioChannels, each null on its own where nothing was reported. The frame rate is a rational as measured (24000/1001), never a rounded decimal, and width and height are as stored rather than ordered — portrait video is ordinary. See Media metadata in the API description. Requires API key authentication.
20
20
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
21
  * @returns {RequestInformation}
22
22
  */
@@ -15,7 +15,7 @@ export interface ItemRequestBuilder extends BaseRequestBuilder<ItemRequestBuilde
15
15
  */
16
16
  get userImages(): UserImagesRequestBuilder;
17
17
  /**
18
- * Returns full details for a single video, including site, network, images, alternative titles, and actors with their images. Requires API key authentication.
18
+ * Returns full details for a single video, including site, network, images, alternative titles, and actors with their images. Carries the consensus duration across the files known for the video (durationMs, with durationSpreadMs and durationFileCount saying how far those files disagree and how many there were), and qualityOverview, which counts the video's files per resolution and per codec. The duration fields are null until enough independent submitters have reported one, and the overview is empty while no file has been probed. See Media metadata in the API description. Requires API key authentication.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {Promise<VideoDetailDto>}
21
21
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -26,7 +26,7 @@ export interface ItemRequestBuilder extends BaseRequestBuilder<ItemRequestBuilde
26
26
  */
27
27
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<VideoDetailDto | undefined>;
28
28
  /**
29
- * Returns full details for a single video, including site, network, images, alternative titles, and actors with their images. Requires API key authentication.
29
+ * Returns full details for a single video, including site, network, images, alternative titles, and actors with their images. Carries the consensus duration across the files known for the video (durationMs, with durationSpreadMs and durationFileCount saying how far those files disagree and how many there were), and qualityOverview, which counts the video's files per resolution and per codec. The duration fields are null until enough independent submitters have reported one, and the overview is empty while no file has been probed. See Media metadata in the API description. Requires API key authentication.
30
30
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
31
31
  * @returns {RequestInformation}
32
32
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prdb/sdk",
3
- "version": "0.9.0",
3
+ "version": "0.11.0",
4
4
  "description": "TypeScript SDK for the prdb Public API",
5
5
  "license": "MIT",
6
6
  "repository": {