@prdb/sdk 0.4.0 → 0.6.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.
- package/README.md +72 -0
- package/dist/generated/models/index.d.ts +437 -0
- package/dist/generated/models/index.d.ts.map +1 -1
- package/dist/generated/models/index.js +498 -0
- package/dist/generated/models/index.js.map +1 -1
- package/dist/generated/sites/index.d.ts +4 -3
- package/dist/generated/sites/index.d.ts.map +1 -1
- package/dist/generated/sites/index.js +1 -0
- package/dist/generated/sites/index.js.map +1 -1
- package/dist/generated/videos/filehashSubmissions/index.d.ts +35 -0
- package/dist/generated/videos/filehashSubmissions/index.d.ts.map +1 -0
- package/dist/generated/videos/filehashSubmissions/index.js +33 -0
- package/dist/generated/videos/filehashSubmissions/index.js.map +1 -0
- package/dist/generated/videos/identify/index.d.ts +35 -0
- package/dist/generated/videos/identify/index.d.ts.map +1 -0
- package/dist/generated/videos/identify/index.js +33 -0
- package/dist/generated/videos/identify/index.js.map +1 -0
- package/dist/generated/videos/index.d.ts +10 -0
- package/dist/generated/videos/index.d.ts.map +1 -1
- package/dist/generated/videos/index.js +10 -0
- package/dist/generated/videos/index.js.map +1 -1
- package/dist/generated/wantedVideos/fulfillments/index.d.ts +35 -0
- package/dist/generated/wantedVideos/fulfillments/index.d.ts.map +1 -0
- package/dist/generated/wantedVideos/fulfillments/index.js +33 -0
- package/dist/generated/wantedVideos/fulfillments/index.js.map +1 -0
- package/dist/generated/wantedVideos/index.d.ts +5 -0
- package/dist/generated/wantedVideos/index.d.ts.map +1 -1
- package/dist/generated/wantedVideos/index.js +5 -0
- package/dist/generated/wantedVideos/index.js.map +1 -1
- package/dist/index.d.ts +57 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +82 -7
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -6,9 +6,10 @@ export type GetSortDirectionQueryParameterType = (typeof GetSortDirectionQueryPa
|
|
|
6
6
|
*/
|
|
7
7
|
export interface SitesRequestBuilder extends BaseRequestBuilder<SitesRequestBuilder> {
|
|
8
8
|
/**
|
|
9
|
-
* Returns a paged list of sites ordered by title ascending. Supports filtering by search term matched against site title. Requires API key authentication.
|
|
9
|
+
* Returns a paged list of sites ordered by title ascending. Supports filtering by search term matched against site title. The full list fits in a single request at pageSize=1000. Every response carries a weak ETag covering the matched rows and the paging, sorting and search parameters; send it back as If-None-Match to get 304 Not Modified while nothing changed. Because the shared read-only output cache does not vary by If-None-Match, a request that hits the cache is answered with 200 and a body instead of 304 — that is expected, not an error. Sites carry no alias names, and matching a file name to a site happens exclusively server-side in POST /videos/identify. Requires API key authentication.
|
|
10
10
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
11
|
* @returns {Promise<ListSitesResponse>}
|
|
12
|
+
* @throws {ProblemDetails} error when the service returns a 400 status code
|
|
12
13
|
* @throws {ProblemDetails} error when the service returns a 401 status code
|
|
13
14
|
* @throws {ProblemDetails} error when the service returns a 403 status code
|
|
14
15
|
* @throws {ProblemDetails} error when the service returns a 429 status code
|
|
@@ -16,14 +17,14 @@ export interface SitesRequestBuilder extends BaseRequestBuilder<SitesRequestBuil
|
|
|
16
17
|
*/
|
|
17
18
|
get(requestConfiguration?: RequestConfiguration<SitesRequestBuilderGetQueryParameters> | undefined): Promise<ListSitesResponse | undefined>;
|
|
18
19
|
/**
|
|
19
|
-
* Returns a paged list of sites ordered by title ascending. Supports filtering by search term matched against site title. Requires API key authentication.
|
|
20
|
+
* Returns a paged list of sites ordered by title ascending. Supports filtering by search term matched against site title. The full list fits in a single request at pageSize=1000. Every response carries a weak ETag covering the matched rows and the paging, sorting and search parameters; send it back as If-None-Match to get 304 Not Modified while nothing changed. Because the shared read-only output cache does not vary by If-None-Match, a request that hits the cache is answered with 200 and a body instead of 304 — that is expected, not an error. Sites carry no alias names, and matching a file name to a site happens exclusively server-side in POST /videos/identify. Requires API key authentication.
|
|
20
21
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
21
22
|
* @returns {RequestInformation}
|
|
22
23
|
*/
|
|
23
24
|
toGetRequestInformation(requestConfiguration?: RequestConfiguration<SitesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
|
|
24
25
|
}
|
|
25
26
|
/**
|
|
26
|
-
* Returns a paged list of sites ordered by title ascending. Supports filtering by search term matched against site title. Requires API key authentication.
|
|
27
|
+
* Returns a paged list of sites ordered by title ascending. Supports filtering by search term matched against site title. The full list fits in a single request at pageSize=1000. Every response carries a weak ETag covering the matched rows and the paging, sorting and search parameters; send it back as If-None-Match to get 304 Not Modified while nothing changed. Because the shared read-only output cache does not vary by If-None-Match, a request that hits the cache is answered with 200 and a body instead of 304 — that is expected, not an error. Sites carry no alias names, and matching a file name to a site happens exclusively server-side in POST /videos/identify. Requires API key authentication.
|
|
27
28
|
*/
|
|
28
29
|
export interface SitesRequestBuilderGetQueryParameters {
|
|
29
30
|
page?: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/sites/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA6F,KAAK,iBAAiB,EAAuB,MAAM,oBAAoB,CAAC;AAE5K,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL,MAAM,MAAM,kCAAkC,GAAG,CAAC,OAAO,wCAAwC,CAAC,CAAC,MAAM,OAAO,wCAAwC,CAAC,CAAC;AAC1J;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB,CAAC,mBAAmB,CAAC;IAChF
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/sites/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA6F,KAAK,iBAAiB,EAAuB,MAAM,oBAAoB,CAAC;AAE5K,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL,MAAM,MAAM,kCAAkC,GAAG,CAAC,OAAO,wCAAwC,CAAC,CAAC,MAAM,OAAO,wCAAwC,CAAC,CAAC;AAC1J;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB,CAAC,mBAAmB,CAAC;IAChF;;;;;;;;;OASG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,qCAAqC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAC9I;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,qCAAqC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACjJ;AACD;;GAEG;AACH,MAAM,WAAW,qCAAqC;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,kCAAkC,CAAC;CACtD;AACD;;GAEG;AACH,eAAO,MAAM,8BAA8B,sEAAsE,CAAC;AAClH;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;CAG3C,CAAC;AAWX;;GAEG;AACH,eAAO,MAAM,mCAAmC,EAAE,gBAejD,CAAC"}
|
|
@@ -32,6 +32,7 @@ export const SitesRequestBuilderRequestsMetadata = {
|
|
|
32
32
|
uriTemplate: SitesRequestBuilderUriTemplate,
|
|
33
33
|
responseBodyContentType: "application/json",
|
|
34
34
|
errorMappings: {
|
|
35
|
+
400: createProblemDetailsFromDiscriminatorValue,
|
|
35
36
|
401: createProblemDetailsFromDiscriminatorValue,
|
|
36
37
|
403: createProblemDetailsFromDiscriminatorValue,
|
|
37
38
|
429: createProblemDetailsFromDiscriminatorValue,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/sites/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,6CAA6C,EAAE,0CAA0C,EAA+C,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/sites/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,6CAA6C,EAAE,0CAA0C,EAA+C,MAAM,oBAAoB,CAAC;AAqC5K;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,mEAAmE,CAAC;AAClH;;GAEG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG;IACpD,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACN,CAAC;AACX;;GAEG;AACH,MAAM,2CAA2C,GAA2B;IACxE,MAAM,EAAE,MAAM;IACd,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAE,eAAe;CACnC,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAqB;IACjE,GAAG,EAAE;QACD,WAAW,EAAE,8BAA8B;QAC3C,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,6CAA6C;QACnE,qBAAqB,EAAE,2CAA2C;KACrE;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { type SubmitVideoFilehashesRequest, type SubmitVideoFilehashesResponse } from '../../models/index.js';
|
|
2
|
+
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
3
|
+
/**
|
|
4
|
+
* Builds and executes requests for operations under /videos/filehash-submissions
|
|
5
|
+
*/
|
|
6
|
+
export interface FilehashSubmissionsRequestBuilder extends BaseRequestBuilder<FilehashSubmissionsRequestBuilder> {
|
|
7
|
+
/**
|
|
8
|
+
* 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.
|
|
9
|
+
* @param body The request body
|
|
10
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
|
+
* @returns {Promise<SubmitVideoFilehashesResponse>}
|
|
12
|
+
* @throws {ProblemDetails} error when the service returns a 400 status code
|
|
13
|
+
* @throws {ProblemDetails} error when the service returns a 401 status code
|
|
14
|
+
* @throws {ProblemDetails} error when the service returns a 403 status code
|
|
15
|
+
* @throws {ProblemDetails} error when the service returns a 429 status code
|
|
16
|
+
* @throws {ProblemDetails} error when the service returns a 503 status code
|
|
17
|
+
*/
|
|
18
|
+
post(body: SubmitVideoFilehashesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SubmitVideoFilehashesResponse | undefined>;
|
|
19
|
+
/**
|
|
20
|
+
* 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.
|
|
21
|
+
* @param body The request body
|
|
22
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
23
|
+
* @returns {RequestInformation}
|
|
24
|
+
*/
|
|
25
|
+
toPostRequestInformation(body: SubmitVideoFilehashesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Uri template for the request builder.
|
|
29
|
+
*/
|
|
30
|
+
export declare const FilehashSubmissionsRequestBuilderUriTemplate = "{+baseurl}/videos/filehash-submissions";
|
|
31
|
+
/**
|
|
32
|
+
* Metadata for all the requests in the request builder.
|
|
33
|
+
*/
|
|
34
|
+
export declare const FilehashSubmissionsRequestBuilderRequestsMetadata: RequestsMetadata;
|
|
35
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generated/videos/filehashSubmissions/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA6M,KAAK,4BAA4B,EAAE,KAAK,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAEzT,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,iCAAkC,SAAQ,kBAAkB,CAAC,iCAAiC,CAAC;IAC5G;;;;;;;;;;OAUG;IACF,IAAI,CAAC,IAAI,EAAE,4BAA4B,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,6BAA6B,GAAG,SAAS,CAAC,CAAC;IAChK;;;;;OAKG;IACF,wBAAwB,CAAC,IAAI,EAAE,4BAA4B,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACvJ;AACD;;GAEG;AACH,eAAO,MAAM,4CAA4C,2CAA2C,CAAC;AACrG;;GAEG;AACH,eAAO,MAAM,iDAAiD,EAAE,gBAiB/D,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
// Generated by Microsoft Kiota
|
|
4
|
+
// @ts-ignore
|
|
5
|
+
import { createProblemDetailsFromDiscriminatorValue, createSubmitVideoFilehashesResponseFromDiscriminatorValue, serializeSubmitVideoFilehashesRequest } from '../../models/index.js';
|
|
6
|
+
/**
|
|
7
|
+
* Uri template for the request builder.
|
|
8
|
+
*/
|
|
9
|
+
export const FilehashSubmissionsRequestBuilderUriTemplate = "{+baseurl}/videos/filehash-submissions";
|
|
10
|
+
/**
|
|
11
|
+
* Metadata for all the requests in the request builder.
|
|
12
|
+
*/
|
|
13
|
+
export const FilehashSubmissionsRequestBuilderRequestsMetadata = {
|
|
14
|
+
post: {
|
|
15
|
+
uriTemplate: FilehashSubmissionsRequestBuilderUriTemplate,
|
|
16
|
+
responseBodyContentType: "application/json",
|
|
17
|
+
errorMappings: {
|
|
18
|
+
400: createProblemDetailsFromDiscriminatorValue,
|
|
19
|
+
401: createProblemDetailsFromDiscriminatorValue,
|
|
20
|
+
403: createProblemDetailsFromDiscriminatorValue,
|
|
21
|
+
429: createProblemDetailsFromDiscriminatorValue,
|
|
22
|
+
503: createProblemDetailsFromDiscriminatorValue,
|
|
23
|
+
},
|
|
24
|
+
adapterMethodName: "send",
|
|
25
|
+
responseBodyFactory: createSubmitVideoFilehashesResponseFromDiscriminatorValue,
|
|
26
|
+
requestBodyContentType: "application/json",
|
|
27
|
+
requestBodySerializer: serializeSubmitVideoFilehashesRequest,
|
|
28
|
+
requestInformationContentSetMethod: "setContentFromParsable",
|
|
29
|
+
},
|
|
30
|
+
};
|
|
31
|
+
/* tslint:enable */
|
|
32
|
+
/* eslint-enable */
|
|
33
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generated/videos/filehashSubmissions/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,0CAA0C,EAAE,yDAAyD,EAAE,qCAAqC,EAAsI,MAAM,uBAAuB,CAAC;AA4BzT;;GAEG;AACH,MAAM,CAAC,MAAM,4CAA4C,GAAG,wCAAwC,CAAC;AACrG;;GAEG;AACH,MAAM,CAAC,MAAM,iDAAiD,GAAqB;IAC/E,IAAI,EAAE;QACF,WAAW,EAAE,4CAA4C;QACzD,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,yDAAyD;QAC/E,sBAAsB,EAAE,kBAAkB;QAC1C,qBAAqB,EAAE,qCAAqC;QAC5D,kCAAkC,EAAE,wBAAwB;KAC/D;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { type IdentifyVideosRequest, type IdentifyVideosResponse } from '../../models/index.js';
|
|
2
|
+
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
3
|
+
/**
|
|
4
|
+
* Builds and executes requests for operations under /videos/identify
|
|
5
|
+
*/
|
|
6
|
+
export interface IdentifyRequestBuilder extends BaseRequestBuilder<IdentifyRequestBuilder> {
|
|
7
|
+
/**
|
|
8
|
+
* 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.
|
|
9
|
+
* @param body The request body
|
|
10
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
|
+
* @returns {Promise<IdentifyVideosResponse>}
|
|
12
|
+
* @throws {ProblemDetails} error when the service returns a 400 status code
|
|
13
|
+
* @throws {ProblemDetails} error when the service returns a 401 status code
|
|
14
|
+
* @throws {ProblemDetails} error when the service returns a 403 status code
|
|
15
|
+
* @throws {ProblemDetails} error when the service returns a 429 status code
|
|
16
|
+
* @throws {ProblemDetails} error when the service returns a 503 status code
|
|
17
|
+
*/
|
|
18
|
+
post(body: IdentifyVideosRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<IdentifyVideosResponse | undefined>;
|
|
19
|
+
/**
|
|
20
|
+
* 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.
|
|
21
|
+
* @param body The request body
|
|
22
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
23
|
+
* @returns {RequestInformation}
|
|
24
|
+
*/
|
|
25
|
+
toPostRequestInformation(body: IdentifyVideosRequest, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Uri template for the request builder.
|
|
29
|
+
*/
|
|
30
|
+
export declare const IdentifyRequestBuilderUriTemplate = "{+baseurl}/videos/identify";
|
|
31
|
+
/**
|
|
32
|
+
* Metadata for all the requests in the request builder.
|
|
33
|
+
*/
|
|
34
|
+
export declare const IdentifyRequestBuilderRequestsMetadata: RequestsMetadata;
|
|
35
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generated/videos/identify/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAmK,KAAK,qBAAqB,EAAE,KAAK,sBAAsB,EAAuB,MAAM,uBAAuB,CAAC;AAEtR,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB,CAAC,sBAAsB,CAAC;IACtF;;;;;;;;;;OAUG;IACF,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,sBAAsB,GAAG,SAAS,CAAC,CAAC;IAClJ;;;;;OAKG;IACF,wBAAwB,CAAC,IAAI,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CAChJ;AACD;;GAEG;AACH,eAAO,MAAM,iCAAiC,+BAA+B,CAAC;AAC9E;;GAEG;AACH,eAAO,MAAM,sCAAsC,EAAE,gBAiBpD,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
// Generated by Microsoft Kiota
|
|
4
|
+
// @ts-ignore
|
|
5
|
+
import { createIdentifyVideosResponseFromDiscriminatorValue, createProblemDetailsFromDiscriminatorValue, serializeIdentifyVideosRequest } from '../../models/index.js';
|
|
6
|
+
/**
|
|
7
|
+
* Uri template for the request builder.
|
|
8
|
+
*/
|
|
9
|
+
export const IdentifyRequestBuilderUriTemplate = "{+baseurl}/videos/identify";
|
|
10
|
+
/**
|
|
11
|
+
* Metadata for all the requests in the request builder.
|
|
12
|
+
*/
|
|
13
|
+
export const IdentifyRequestBuilderRequestsMetadata = {
|
|
14
|
+
post: {
|
|
15
|
+
uriTemplate: IdentifyRequestBuilderUriTemplate,
|
|
16
|
+
responseBodyContentType: "application/json",
|
|
17
|
+
errorMappings: {
|
|
18
|
+
400: createProblemDetailsFromDiscriminatorValue,
|
|
19
|
+
401: createProblemDetailsFromDiscriminatorValue,
|
|
20
|
+
403: createProblemDetailsFromDiscriminatorValue,
|
|
21
|
+
429: createProblemDetailsFromDiscriminatorValue,
|
|
22
|
+
503: createProblemDetailsFromDiscriminatorValue,
|
|
23
|
+
},
|
|
24
|
+
adapterMethodName: "send",
|
|
25
|
+
responseBodyFactory: createIdentifyVideosResponseFromDiscriminatorValue,
|
|
26
|
+
requestBodyContentType: "application/json",
|
|
27
|
+
requestBodySerializer: serializeIdentifyVideosRequest,
|
|
28
|
+
requestInformationContentSetMethod: "setContentFromParsable",
|
|
29
|
+
},
|
|
30
|
+
};
|
|
31
|
+
/* tslint:enable */
|
|
32
|
+
/* eslint-enable */
|
|
33
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generated/videos/identify/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,kDAAkD,EAAE,0CAA0C,EAAE,8BAA8B,EAAiH,MAAM,uBAAuB,CAAC;AA4BtR;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,4BAA4B,CAAC;AAC9E;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAqB;IACpE,IAAI,EAAE;QACF,WAAW,EAAE,iCAAiC;QAC9C,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,kDAAkD;QACxE,sBAAsB,EAAE,kBAAkB;QAC1C,qBAAqB,EAAE,8BAA8B;QACrD,kCAAkC,EAAE,wBAAwB;KAC/D;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { type ListVideosResponse } from '../models/index.js';
|
|
2
2
|
import { type BatchRequestBuilder } from './batch/index.js';
|
|
3
3
|
import { type FilehashesRequestBuilder } from './filehashes/index.js';
|
|
4
|
+
import { type FilehashSubmissionsRequestBuilder } from './filehashSubmissions/index.js';
|
|
5
|
+
import { type IdentifyRequestBuilder } from './identify/index.js';
|
|
4
6
|
import { type ItemRequestBuilder } from './item/index.js';
|
|
5
7
|
import { type BaseRequestBuilder, type Guid, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
6
8
|
export type GetSortByQueryParameterType = (typeof GetSortByQueryParameterTypeObject)[keyof typeof GetSortByQueryParameterTypeObject];
|
|
@@ -17,6 +19,14 @@ export interface VideosRequestBuilder extends BaseRequestBuilder<VideosRequestBu
|
|
|
17
19
|
* The filehashes property
|
|
18
20
|
*/
|
|
19
21
|
get filehashes(): FilehashesRequestBuilder;
|
|
22
|
+
/**
|
|
23
|
+
* The filehashSubmissions property
|
|
24
|
+
*/
|
|
25
|
+
get filehashSubmissions(): FilehashSubmissionsRequestBuilder;
|
|
26
|
+
/**
|
|
27
|
+
* The identify property
|
|
28
|
+
*/
|
|
29
|
+
get identify(): IdentifyRequestBuilder;
|
|
20
30
|
/**
|
|
21
31
|
* Gets an item from the prdb-sdk.videos.item collection
|
|
22
32
|
* @param id Unique identifier of the item
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/videos/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA8F,KAAK,kBAAkB,EAAuB,MAAM,oBAAoB,CAAC;AAE9K,OAAO,EAAuC,KAAK,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,OAAO,EAA8C,KAAK,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAElH,OAAO,EAA4E,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEpI,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,IAAI,EAAE,KAAK,kCAAkC,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAErQ,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,iCAAiC,CAAC,CAAC,MAAM,OAAO,iCAAiC,CAAC,CAAC;AACrI,MAAM,MAAM,kCAAkC,GAAG,CAAC,OAAO,wCAAwC,CAAC,CAAC,MAAM,OAAO,wCAAwC,CAAC,CAAC;AAC1J;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,oBAAoB,CAAC;IAClF;;OAEG;IACH,IAAI,KAAK,IAAI,mBAAmB,CAAC;IACjC;;OAEG;IACH,IAAI,UAAU,IAAI,wBAAwB,CAAC;IAC3C;;;;OAIG;IACF,IAAI,CAAC,EAAE,EAAE,IAAI,GAAI,kBAAkB,CAAC;IACrC;;;;;;;;;OASG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,sCAAsC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAChJ;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,sCAAsC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CAClJ;AACD;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACnD,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,MAAM,CAAC,EAAE,2BAA2B,CAAC;IACrC,aAAa,CAAC,EAAE,kCAAkC,CAAC;CACtD;AACD;;GAEG;AACH,eAAO,MAAM,+BAA+B,qHAAqH,CAAC;AAClK;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;CAIpC,CAAC;AACX;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;CAG3C,CAAC;AAeX;;GAEG;AACH,eAAO,MAAM,sCAAsC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,oBAAoB,EAAE,kCAAkC,CAAC,EAAE,kBAAkB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/videos/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA8F,KAAK,kBAAkB,EAAuB,MAAM,oBAAoB,CAAC;AAE9K,OAAO,EAAuC,KAAK,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,OAAO,EAA8C,KAAK,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAElH,OAAO,EAAqD,KAAK,iCAAiC,EAAE,MAAM,gCAAgC,CAAC;AAE3I,OAAO,EAA0C,KAAK,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE1G,OAAO,EAA4E,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAEpI,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,IAAI,EAAE,KAAK,kCAAkC,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAErQ,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,iCAAiC,CAAC,CAAC,MAAM,OAAO,iCAAiC,CAAC,CAAC;AACrI,MAAM,MAAM,kCAAkC,GAAG,CAAC,OAAO,wCAAwC,CAAC,CAAC,MAAM,OAAO,wCAAwC,CAAC,CAAC;AAC1J;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,oBAAoB,CAAC;IAClF;;OAEG;IACH,IAAI,KAAK,IAAI,mBAAmB,CAAC;IACjC;;OAEG;IACH,IAAI,UAAU,IAAI,wBAAwB,CAAC;IAC3C;;OAEG;IACH,IAAI,mBAAmB,IAAI,iCAAiC,CAAC;IAC7D;;OAEG;IACH,IAAI,QAAQ,IAAI,sBAAsB,CAAC;IACvC;;;;OAIG;IACF,IAAI,CAAC,EAAE,EAAE,IAAI,GAAI,kBAAkB,CAAC;IACrC;;;;;;;;;OASG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,sCAAsC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAChJ;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,sCAAsC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CAClJ;AACD;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACnD,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,MAAM,CAAC,EAAE,2BAA2B,CAAC;IACrC,aAAa,CAAC,EAAE,kCAAkC,CAAC;CACtD;AACD;;GAEG;AACH,eAAO,MAAM,+BAA+B,qHAAqH,CAAC;AAClK;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;CAIpC,CAAC;AACX;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;CAG3C,CAAC;AAeX;;GAEG;AACH,eAAO,MAAM,sCAAsC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,oBAAoB,EAAE,kCAAkC,CAAC,EAAE,kBAAkB,CAkBtJ,CAAC;AACF;;GAEG;AACH,eAAO,MAAM,oCAAoC,EAAE,gBAelD,CAAC"}
|
|
@@ -8,6 +8,10 @@ import { BatchRequestBuilderRequestsMetadata } from './batch/index.js';
|
|
|
8
8
|
// @ts-ignore
|
|
9
9
|
import { FilehashesRequestBuilderNavigationMetadata } from './filehashes/index.js';
|
|
10
10
|
// @ts-ignore
|
|
11
|
+
import { FilehashSubmissionsRequestBuilderRequestsMetadata } from './filehashSubmissions/index.js';
|
|
12
|
+
// @ts-ignore
|
|
13
|
+
import { IdentifyRequestBuilderRequestsMetadata } from './identify/index.js';
|
|
14
|
+
// @ts-ignore
|
|
11
15
|
import { ItemRequestBuilderNavigationMetadata, ItemRequestBuilderRequestsMetadata } from './item/index.js';
|
|
12
16
|
/**
|
|
13
17
|
* Uri template for the request builder.
|
|
@@ -57,6 +61,12 @@ export const VideosRequestBuilderNavigationMetadata = {
|
|
|
57
61
|
filehashes: {
|
|
58
62
|
navigationMetadata: FilehashesRequestBuilderNavigationMetadata,
|
|
59
63
|
},
|
|
64
|
+
filehashSubmissions: {
|
|
65
|
+
requestsMetadata: FilehashSubmissionsRequestBuilderRequestsMetadata,
|
|
66
|
+
},
|
|
67
|
+
identify: {
|
|
68
|
+
requestsMetadata: IdentifyRequestBuilderRequestsMetadata,
|
|
69
|
+
},
|
|
60
70
|
};
|
|
61
71
|
/**
|
|
62
72
|
* Metadata for all the requests in the request builder.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/videos/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,8CAA8C,EAAE,0CAA0C,EAAgD,MAAM,oBAAoB,CAAC;AAC9K,aAAa;AACb,OAAO,EAAE,mCAAmC,EAA4B,MAAM,kBAAkB,CAAC;AACjG,aAAa;AACb,OAAO,EAAE,0CAA0C,EAAiC,MAAM,uBAAuB,CAAC;AAClH,aAAa;AACb,OAAO,EAAE,oCAAoC,EAAE,kCAAkC,EAA2B,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/videos/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,8CAA8C,EAAE,0CAA0C,EAAgD,MAAM,oBAAoB,CAAC;AAC9K,aAAa;AACb,OAAO,EAAE,mCAAmC,EAA4B,MAAM,kBAAkB,CAAC;AACjG,aAAa;AACb,OAAO,EAAE,0CAA0C,EAAiC,MAAM,uBAAuB,CAAC;AAClH,aAAa;AACb,OAAO,EAAE,iDAAiD,EAA0C,MAAM,gCAAgC,CAAC;AAC3I,aAAa;AACb,OAAO,EAAE,sCAAsC,EAA+B,MAAM,qBAAqB,CAAC;AAC1G,aAAa;AACb,OAAO,EAAE,oCAAoC,EAAE,kCAAkC,EAA2B,MAAM,iBAAiB,CAAC;AAgEpI;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,kHAAkH,CAAC;AAClK;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC7C,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,cAAc;CACtB,CAAC;AACX;;GAEG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG;IACpD,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACN,CAAC;AACX;;GAEG;AACH,MAAM,4CAA4C,GAA2B;IACzE,SAAS,EAAE,SAAS;IACpB,cAAc,EAAE,cAAc;IAC9B,eAAe,EAAE,eAAe;IAChC,MAAM,EAAE,MAAM;IACd,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAE,eAAe;CACnC,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAwG;IACvJ,IAAI,EAAE;QACF,gBAAgB,EAAE,kCAAkC;QACpD,kBAAkB,EAAE,oCAAoC;QACxD,sBAAsB,EAAE,CAAC,OAAO,CAAC;KACpC;IACD,KAAK,EAAE;QACH,gBAAgB,EAAE,mCAAmC;KACxD;IACD,UAAU,EAAE;QACR,kBAAkB,EAAE,0CAA0C;KACjE;IACD,mBAAmB,EAAE;QACjB,gBAAgB,EAAE,iDAAiD;KACtE;IACD,QAAQ,EAAE;QACN,gBAAgB,EAAE,sCAAsC;KAC3D;CACJ,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAqB;IAClE,GAAG,EAAE;QACD,WAAW,EAAE,+BAA+B;QAC5C,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,8CAA8C;QACpE,qBAAqB,EAAE,4CAA4C;KACtE;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { type FulfillWantedVideosBatchRequest, type FulfillWantedVideosBatchResponse } from '../../models/index.js';
|
|
2
|
+
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
3
|
+
/**
|
|
4
|
+
* Builds and executes requests for operations under /wanted-videos/fulfillments
|
|
5
|
+
*/
|
|
6
|
+
export interface FulfillmentsRequestBuilder extends BaseRequestBuilder<FulfillmentsRequestBuilder> {
|
|
7
|
+
/**
|
|
8
|
+
* Marks up to 50 wanted videos of the currently authenticated user as fulfilled or unfulfilled in a single request. Returns one result per video, naming the outcome — updated, unchanged, not on the wanted list, or unknown video — so unknown and unwanted IDs do not fail the request; the status code stays 200. A 400 is only returned for form errors: an empty list, more than 50 entries, a video listed twice, or an invalid enum value. Setting isFulfilled to false clears the fulfilment timestamp, quality, external ID and application. Setting it to true without a fulfilledAtUtc stamps the server time, unless the entry is already fulfilled, in which case its timestamp is kept. Soft-deleted wanted entries are reported as not wanted and are not revived; use POST /wanted-videos/batch for that. The whole request counts as one request against the rate limit. Requires API key authentication.
|
|
9
|
+
* @param body The request body
|
|
10
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
|
+
* @returns {Promise<FulfillWantedVideosBatchResponse>}
|
|
12
|
+
* @throws {ProblemDetails} error when the service returns a 400 status code
|
|
13
|
+
* @throws {ProblemDetails} error when the service returns a 401 status code
|
|
14
|
+
* @throws {ProblemDetails} error when the service returns a 403 status code
|
|
15
|
+
* @throws {ProblemDetails} error when the service returns a 429 status code
|
|
16
|
+
* @throws {ProblemDetails} error when the service returns a 503 status code
|
|
17
|
+
*/
|
|
18
|
+
post(body: FulfillWantedVideosBatchRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<FulfillWantedVideosBatchResponse | undefined>;
|
|
19
|
+
/**
|
|
20
|
+
* Marks up to 50 wanted videos of the currently authenticated user as fulfilled or unfulfilled in a single request. Returns one result per video, naming the outcome — updated, unchanged, not on the wanted list, or unknown video — so unknown and unwanted IDs do not fail the request; the status code stays 200. A 400 is only returned for form errors: an empty list, more than 50 entries, a video listed twice, or an invalid enum value. Setting isFulfilled to false clears the fulfilment timestamp, quality, external ID and application. Setting it to true without a fulfilledAtUtc stamps the server time, unless the entry is already fulfilled, in which case its timestamp is kept. Soft-deleted wanted entries are reported as not wanted and are not revived; use POST /wanted-videos/batch for that. The whole request counts as one request against the rate limit. Requires API key authentication.
|
|
21
|
+
* @param body The request body
|
|
22
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
23
|
+
* @returns {RequestInformation}
|
|
24
|
+
*/
|
|
25
|
+
toPostRequestInformation(body: FulfillWantedVideosBatchRequest, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Uri template for the request builder.
|
|
29
|
+
*/
|
|
30
|
+
export declare const FulfillmentsRequestBuilderUriTemplate = "{+baseurl}/wanted-videos/fulfillments";
|
|
31
|
+
/**
|
|
32
|
+
* Metadata for all the requests in the request builder.
|
|
33
|
+
*/
|
|
34
|
+
export declare const FulfillmentsRequestBuilderRequestsMetadata: RequestsMetadata;
|
|
35
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generated/wantedVideos/fulfillments/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAiM,KAAK,+BAA+B,EAAE,KAAK,gCAAgC,EAAuB,MAAM,uBAAuB,CAAC;AAExU,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB,CAAC,0BAA0B,CAAC;IAC9F;;;;;;;;;;OAUG;IACF,IAAI,CAAC,IAAI,EAAE,+BAA+B,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,gCAAgC,GAAG,SAAS,CAAC,CAAC;IACtK;;;;;OAKG;IACF,wBAAwB,CAAC,IAAI,EAAE,+BAA+B,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CAC1J;AACD;;GAEG;AACH,eAAO,MAAM,qCAAqC,0CAA0C,CAAC;AAC7F;;GAEG;AACH,eAAO,MAAM,0CAA0C,EAAE,gBAiBxD,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
// Generated by Microsoft Kiota
|
|
4
|
+
// @ts-ignore
|
|
5
|
+
import { createFulfillWantedVideosBatchResponseFromDiscriminatorValue, createProblemDetailsFromDiscriminatorValue, serializeFulfillWantedVideosBatchRequest } from '../../models/index.js';
|
|
6
|
+
/**
|
|
7
|
+
* Uri template for the request builder.
|
|
8
|
+
*/
|
|
9
|
+
export const FulfillmentsRequestBuilderUriTemplate = "{+baseurl}/wanted-videos/fulfillments";
|
|
10
|
+
/**
|
|
11
|
+
* Metadata for all the requests in the request builder.
|
|
12
|
+
*/
|
|
13
|
+
export const FulfillmentsRequestBuilderRequestsMetadata = {
|
|
14
|
+
post: {
|
|
15
|
+
uriTemplate: FulfillmentsRequestBuilderUriTemplate,
|
|
16
|
+
responseBodyContentType: "application/json",
|
|
17
|
+
errorMappings: {
|
|
18
|
+
400: createProblemDetailsFromDiscriminatorValue,
|
|
19
|
+
401: createProblemDetailsFromDiscriminatorValue,
|
|
20
|
+
403: createProblemDetailsFromDiscriminatorValue,
|
|
21
|
+
429: createProblemDetailsFromDiscriminatorValue,
|
|
22
|
+
503: createProblemDetailsFromDiscriminatorValue,
|
|
23
|
+
},
|
|
24
|
+
adapterMethodName: "send",
|
|
25
|
+
responseBodyFactory: createFulfillWantedVideosBatchResponseFromDiscriminatorValue,
|
|
26
|
+
requestBodyContentType: "application/json",
|
|
27
|
+
requestBodySerializer: serializeFulfillWantedVideosBatchRequest,
|
|
28
|
+
requestInformationContentSetMethod: "setContentFromParsable",
|
|
29
|
+
},
|
|
30
|
+
};
|
|
31
|
+
/* tslint:enable */
|
|
32
|
+
/* eslint-enable */
|
|
33
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generated/wantedVideos/fulfillments/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,4DAA4D,EAAE,0CAA0C,EAAE,wCAAwC,EAA+I,MAAM,uBAAuB,CAAC;AA4BxU;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,uCAAuC,CAAC;AAC7F;;GAEG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAqB;IACxE,IAAI,EAAE;QACF,WAAW,EAAE,qCAAqC;QAClD,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,4DAA4D;QAClF,sBAAsB,EAAE,kBAAkB;QAC1C,qBAAqB,EAAE,wCAAwC;QAC/D,kCAAkC,EAAE,wBAAwB;KAC/D;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { type ListWantedVideosResponse } from '../models/index.js';
|
|
2
2
|
import { type BatchRequestBuilder } from './batch/index.js';
|
|
3
3
|
import { type ChangesRequestBuilder } from './changes/index.js';
|
|
4
|
+
import { type FulfillmentsRequestBuilder } from './fulfillments/index.js';
|
|
4
5
|
import { type WithVideoItemRequestBuilder } from './item/index.js';
|
|
5
6
|
import { type BaseRequestBuilder, type Guid, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
6
7
|
export type GetSortDirectionQueryParameterType = (typeof GetSortDirectionQueryParameterTypeObject)[keyof typeof GetSortDirectionQueryParameterTypeObject];
|
|
@@ -16,6 +17,10 @@ export interface WantedVideosRequestBuilder extends BaseRequestBuilder<WantedVid
|
|
|
16
17
|
* The changes property
|
|
17
18
|
*/
|
|
18
19
|
get changes(): ChangesRequestBuilder;
|
|
20
|
+
/**
|
|
21
|
+
* The fulfillments property
|
|
22
|
+
*/
|
|
23
|
+
get fulfillments(): FulfillmentsRequestBuilder;
|
|
19
24
|
/**
|
|
20
25
|
* Gets an item from the prdb-sdk.wantedVideos.item collection
|
|
21
26
|
* @param videoId Unique identifier of the item
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/wantedVideos/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoG,KAAK,wBAAwB,EAAuB,MAAM,oBAAoB,CAAC;AAE1L,OAAO,EAAuC,KAAK,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,OAAO,EAAyC,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAEvG,OAAO,EAAE,KAAK,2BAA2B,EAA+C,MAAM,iBAAiB,CAAC;AAEhH,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,IAAI,EAAE,KAAK,kCAAkC,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAErQ,MAAM,MAAM,kCAAkC,GAAG,CAAC,OAAO,wCAAwC,CAAC,CAAC,MAAM,OAAO,wCAAwC,CAAC,CAAC;AAC1J;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB,CAAC,0BAA0B,CAAC;IAC9F;;OAEG;IACH,IAAI,KAAK,IAAI,mBAAmB,CAAC;IACjC;;OAEG;IACH,IAAI,OAAO,IAAI,qBAAqB,CAAC;IACrC;;;;OAIG;IACF,SAAS,CAAC,OAAO,EAAE,IAAI,GAAI,2BAA2B,CAAC;IACxD;;;;;;;;;OASG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,4CAA4C,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;IAC5J;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,4CAA4C,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACxJ;AACD;;GAEG;AACH,MAAM,WAAW,4CAA4C;IACzD,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,kCAAkC,CAAC;CACtD;AACD;;GAEG;AACH,eAAO,MAAM,qCAAqC,6HAA6H,CAAC;AAChL;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;CAG3C,CAAC;AAeX;;GAEG;AACH,eAAO,MAAM,4CAA4C,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,0BAA0B,EAAE,kCAAkC,CAAC,EAAE,kBAAkB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generated/wantedVideos/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoG,KAAK,wBAAwB,EAAuB,MAAM,oBAAoB,CAAC;AAE1L,OAAO,EAAuC,KAAK,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,OAAO,EAAyC,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAEvG,OAAO,EAA8C,KAAK,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAEtH,OAAO,EAAE,KAAK,2BAA2B,EAA+C,MAAM,iBAAiB,CAAC;AAEhH,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,IAAI,EAAE,KAAK,kCAAkC,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAErQ,MAAM,MAAM,kCAAkC,GAAG,CAAC,OAAO,wCAAwC,CAAC,CAAC,MAAM,OAAO,wCAAwC,CAAC,CAAC;AAC1J;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB,CAAC,0BAA0B,CAAC;IAC9F;;OAEG;IACH,IAAI,KAAK,IAAI,mBAAmB,CAAC;IACjC;;OAEG;IACH,IAAI,OAAO,IAAI,qBAAqB,CAAC;IACrC;;OAEG;IACH,IAAI,YAAY,IAAI,0BAA0B,CAAC;IAC/C;;;;OAIG;IACF,SAAS,CAAC,OAAO,EAAE,IAAI,GAAI,2BAA2B,CAAC;IACxD;;;;;;;;;OASG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,4CAA4C,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;IAC5J;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,4CAA4C,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACxJ;AACD;;GAEG;AACH,MAAM,WAAW,4CAA4C;IACzD,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,kCAAkC,CAAC;CACtD;AACD;;GAEG;AACH,eAAO,MAAM,qCAAqC,6HAA6H,CAAC;AAChL;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;CAG3C,CAAC;AAeX;;GAEG;AACH,eAAO,MAAM,4CAA4C,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,0BAA0B,EAAE,kCAAkC,CAAC,EAAE,kBAAkB,CAclK,CAAC;AACF;;GAEG;AACH,eAAO,MAAM,0CAA0C,EAAE,gBAexD,CAAC"}
|
|
@@ -8,6 +8,8 @@ import { BatchRequestBuilderRequestsMetadata } from './batch/index.js';
|
|
|
8
8
|
// @ts-ignore
|
|
9
9
|
import { ChangesRequestBuilderRequestsMetadata } from './changes/index.js';
|
|
10
10
|
// @ts-ignore
|
|
11
|
+
import { FulfillmentsRequestBuilderRequestsMetadata } from './fulfillments/index.js';
|
|
12
|
+
// @ts-ignore
|
|
11
13
|
import { WithVideoItemRequestBuilderRequestsMetadata } from './item/index.js';
|
|
12
14
|
/**
|
|
13
15
|
* Uri template for the request builder.
|
|
@@ -48,6 +50,9 @@ export const WantedVideosRequestBuilderNavigationMetadata = {
|
|
|
48
50
|
changes: {
|
|
49
51
|
requestsMetadata: ChangesRequestBuilderRequestsMetadata,
|
|
50
52
|
},
|
|
53
|
+
fulfillments: {
|
|
54
|
+
requestsMetadata: FulfillmentsRequestBuilderRequestsMetadata,
|
|
55
|
+
},
|
|
51
56
|
};
|
|
52
57
|
/**
|
|
53
58
|
* Metadata for all the requests in the request builder.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/wantedVideos/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,oDAAoD,EAAE,0CAA0C,EAAsD,MAAM,oBAAoB,CAAC;AAC1L,aAAa;AACb,OAAO,EAAE,mCAAmC,EAA4B,MAAM,kBAAkB,CAAC;AACjG,aAAa;AACb,OAAO,EAAE,qCAAqC,EAA8B,MAAM,oBAAoB,CAAC;AACvG,aAAa;AACb,OAAO,EAAoC,2CAA2C,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/wantedVideos/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,oDAAoD,EAAE,0CAA0C,EAAsD,MAAM,oBAAoB,CAAC;AAC1L,aAAa;AACb,OAAO,EAAE,mCAAmC,EAA4B,MAAM,kBAAkB,CAAC;AACjG,aAAa;AACb,OAAO,EAAE,qCAAqC,EAA8B,MAAM,oBAAoB,CAAC;AACvG,aAAa;AACb,OAAO,EAAE,0CAA0C,EAAmC,MAAM,yBAAyB,CAAC;AACtH,aAAa;AACb,OAAO,EAAoC,2CAA2C,EAAE,MAAM,iBAAiB,CAAC;AA2DhH;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,0HAA0H,CAAC;AAChL;;GAEG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG;IACpD,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACN,CAAC;AACX;;GAEG;AACH,MAAM,kDAAkD,GAA2B;IAC/E,SAAS,EAAE,SAAS;IACpB,iBAAiB,EAAE,iBAAiB;IACpC,aAAa,EAAE,aAAa;IAC5B,MAAM,EAAE,MAAM;IACd,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAE,eAAe;CACnC,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,4CAA4C,GAA8G;IACnK,SAAS,EAAE;QACP,gBAAgB,EAAE,2CAA2C;QAC7D,sBAAsB,EAAE,CAAC,SAAS,CAAC;KACtC;IACD,KAAK,EAAE;QACH,gBAAgB,EAAE,mCAAmC;KACxD;IACD,OAAO,EAAE;QACL,gBAAgB,EAAE,qCAAqC;KAC1D;IACD,YAAY,EAAE;QACV,gBAAgB,EAAE,0CAA0C;KAC/D;CACJ,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAqB;IACxE,GAAG,EAAE;QACD,WAAW,EAAE,qCAAqC;QAClD,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,oDAAoD;QAC1E,qBAAqB,EAAE,kDAAkD;KAC5E;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
|
package/dist/index.d.ts
CHANGED
|
@@ -79,6 +79,63 @@ export declare class ResponseStatusOption implements RequestOption {
|
|
|
79
79
|
statusCode?: number;
|
|
80
80
|
getKey(): string;
|
|
81
81
|
}
|
|
82
|
+
/** Key the {@link RateLimitOption} travels under. */
|
|
83
|
+
export declare const RATE_LIMIT_OPTION_KEY = "prdb.rateLimit";
|
|
84
|
+
/** One rate-limiting window, as the API reported it on a response. */
|
|
85
|
+
export interface RateLimitWindow {
|
|
86
|
+
/** How many requests the window allows in total. */
|
|
87
|
+
readonly limit: number;
|
|
88
|
+
/** How many of them are left. */
|
|
89
|
+
readonly remaining: number;
|
|
90
|
+
/**
|
|
91
|
+
* Seconds until the oldest request leaves the sliding window and frees one
|
|
92
|
+
* slot — not a timestamp, and not the time until the whole window resets.
|
|
93
|
+
* The same quantity `resetsInSeconds` carries on `GET /rate-limit`.
|
|
94
|
+
*/
|
|
95
|
+
readonly resetInSeconds: number;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Per-request option reporting the rate-limit state the API sent back.
|
|
99
|
+
*
|
|
100
|
+
* Every metered response carries its rate-limit headers, so a client can pace
|
|
101
|
+
* itself off the answers it is already getting instead of spending a request on
|
|
102
|
+
* `GET /rate-limit` to ask.
|
|
103
|
+
*
|
|
104
|
+
* Kiota can surface response headers through its own headers-inspection option,
|
|
105
|
+
* but as raw multi-valued strings that a caller has to find, pick apart and
|
|
106
|
+
* parse. This option is the typed form:
|
|
107
|
+
*
|
|
108
|
+
* ```ts
|
|
109
|
+
* const limits = new RateLimitOption();
|
|
110
|
+
*
|
|
111
|
+
* const sites = await client.sites.get({ options: [limits] });
|
|
112
|
+
*
|
|
113
|
+
* if (limits.hour && limits.hour.remaining < 50) {
|
|
114
|
+
* // Slow down; limits.hour.resetInSeconds until a slot frees up.
|
|
115
|
+
* }
|
|
116
|
+
* ```
|
|
117
|
+
*
|
|
118
|
+
* Use one instance per call: it is written when the response arrives, so
|
|
119
|
+
* sharing one across concurrent calls means whichever finishes last wins.
|
|
120
|
+
*/
|
|
121
|
+
export declare class RateLimitOption implements RequestOption {
|
|
122
|
+
/**
|
|
123
|
+
* The hourly window, or `undefined` if the response carried no hourly
|
|
124
|
+
* headers.
|
|
125
|
+
*/
|
|
126
|
+
hour?: RateLimitWindow;
|
|
127
|
+
/**
|
|
128
|
+
* The monthly window, or `undefined` if the response carried no monthly
|
|
129
|
+
* headers.
|
|
130
|
+
*
|
|
131
|
+
* Both are `undefined` for a response the API did not meter — `401`, `403`,
|
|
132
|
+
* `503` and `GET /rate-limit` itself — and for a call that never reached a
|
|
133
|
+
* response. A `429` carries only the window that refused it, so exactly one
|
|
134
|
+
* of the two being set is normal rather than a partial reading.
|
|
135
|
+
*/
|
|
136
|
+
month?: RateLimitWindow;
|
|
137
|
+
getKey(): string;
|
|
138
|
+
}
|
|
82
139
|
/**
|
|
83
140
|
* How the SDK retries a request the API refused with 429, 503 or 504.
|
|
84
141
|
*
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAIN,KAAK,aAAa,EAClB,MAAM,+BAA+B,CAAC;AAavC,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAE9E,yCAAyC;AACzC,eAAO,MAAM,cAAc,cAAc,CAAC;AAE1C,6EAA6E;AAC7E,eAAO,MAAM,gBAAgB,yBAAyB,CAAC;AAEvD,yEAAyE;AACzE,MAAM,MAAM,SAAS,GAAG,CACvB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,WAAW,KACb,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEvB;;;;;;GAMG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;gBACtC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAO/C;AAED,0DAA0D;AAC1D,eAAO,MAAM,0BAA0B,wBAAwB,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACzD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,IAAI,MAAM;CAGhB;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAIN,KAAK,aAAa,EAClB,MAAM,+BAA+B,CAAC;AAavC,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAE9E,yCAAyC;AACzC,eAAO,MAAM,cAAc,cAAc,CAAC;AAE1C,6EAA6E;AAC7E,eAAO,MAAM,gBAAgB,yBAAyB,CAAC;AAEvD,yEAAyE;AACzE,MAAM,MAAM,SAAS,GAAG,CACvB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,WAAW,KACb,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEvB;;;;;;GAMG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;gBACtC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAO/C;AAED,0DAA0D;AAC1D,eAAO,MAAM,0BAA0B,wBAAwB,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACzD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,IAAI,MAAM;CAGhB;AAED,qDAAqD;AACrD,eAAO,MAAM,qBAAqB,mBAAmB,CAAC;AAEtD,sEAAsE;AACtE,MAAM,WAAW,eAAe;IAC/B,oDAAoD;IACpD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,iCAAiC;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,eAAgB,YAAW,aAAa;IACpD;;;OAGG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IAEvB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IAExB,MAAM,IAAI,MAAM;CAGhB;AA4ED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,8EAA8E;AAC9E,eAAO,MAAM,cAAc,EAAE,YAAgC,CAAC;AAE9D,MAAM,WAAW,aAAa;IAC7B,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AAEnE;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,UAAU,CAiB/D;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACpC,OAAO,GAAE,sBAA2B,GAClC,UAAU,CAUZ;AAuKD,YAAY,EAAE,UAAU,EAAE,CAAC"}
|