@aignostics/sdk 3.3.0 → 3.5.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/dist/aignostics-sdk-3.5.0.tgz +0 -0
- package/dist/{api-CWohsFN3.d.cts → api-CrZaHZZr.d.cts} +1187 -23
- package/dist/{api-CWohsFN3.d.ts → api-CrZaHZZr.d.ts} +1187 -23
- package/dist/index.cjs +1211 -25
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +36 -2
- package/dist/index.d.ts +36 -2
- package/dist/index.js +1208 -26
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +26 -1
- package/dist/test-utils/http-mocks.cjs.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +1 -1
- package/dist/test-utils/http-mocks.d.ts +1 -1
- package/dist/test-utils/http-mocks.js +26 -1
- package/dist/test-utils/http-mocks.js.map +1 -1
- package/package.json +2 -1
- package/dist/aignostics-sdk-3.3.0.tgz +0 -0
package/dist/index.cjs
CHANGED
|
@@ -103,6 +103,11 @@ var ArtifactTerminationReason = {
|
|
|
103
103
|
SystemError: "SYSTEM_ERROR",
|
|
104
104
|
Skipped: "SKIPPED"
|
|
105
105
|
};
|
|
106
|
+
var GrantRelation = {
|
|
107
|
+
Owner: "owner",
|
|
108
|
+
Editor: "editor",
|
|
109
|
+
Viewer: "viewer"
|
|
110
|
+
};
|
|
106
111
|
var ItemOutput = {
|
|
107
112
|
None: "NONE",
|
|
108
113
|
Full: "FULL"
|
|
@@ -126,6 +131,12 @@ var OutputArtifactVisibility = {
|
|
|
126
131
|
Internal: "INTERNAL",
|
|
127
132
|
External: "EXTERNAL"
|
|
128
133
|
};
|
|
134
|
+
var ResourceType = {
|
|
135
|
+
Run: "run",
|
|
136
|
+
Item: "item",
|
|
137
|
+
OutputArtifact: "output_artifact",
|
|
138
|
+
ShareToken: "share_token"
|
|
139
|
+
};
|
|
129
140
|
var RunOutput = {
|
|
130
141
|
None: "NONE",
|
|
131
142
|
Partial: "PARTIAL",
|
|
@@ -141,6 +152,16 @@ var RunTerminationReason = {
|
|
|
141
152
|
CanceledBySystem: "CANCELED_BY_SYSTEM",
|
|
142
153
|
CanceledByUser: "CANCELED_BY_USER"
|
|
143
154
|
};
|
|
155
|
+
var SubjectType = {
|
|
156
|
+
User: "user",
|
|
157
|
+
OrganizationAdmin: "organization_admin",
|
|
158
|
+
OrganizationUser: "organization_user",
|
|
159
|
+
ShareToken: "share_token"
|
|
160
|
+
};
|
|
161
|
+
var VersionDocumentVisibility = {
|
|
162
|
+
Public: "public",
|
|
163
|
+
Internal: "internal"
|
|
164
|
+
};
|
|
144
165
|
var PublicApiAxiosParamCreator = function(configuration) {
|
|
145
166
|
return {
|
|
146
167
|
/**
|
|
@@ -199,6 +220,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
199
220
|
options: localVarRequestOptions
|
|
200
221
|
};
|
|
201
222
|
},
|
|
223
|
+
/**
|
|
224
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
225
|
+
* @summary Create Grant
|
|
226
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
createGrantV1AccessGrantsPost: async (grantCreateRequest, options = {}) => {
|
|
231
|
+
assertParamExists("createGrantV1AccessGrantsPost", "grantCreateRequest", grantCreateRequest);
|
|
232
|
+
const localVarPath = `/v1/access/grants`;
|
|
233
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
234
|
+
let baseOptions;
|
|
235
|
+
if (configuration) {
|
|
236
|
+
baseOptions = configuration.baseOptions;
|
|
237
|
+
}
|
|
238
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
239
|
+
const localVarHeaderParameter = {};
|
|
240
|
+
const localVarQueryParameter = {};
|
|
241
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
242
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
243
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
244
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
245
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
246
|
+
localVarRequestOptions.data = serializeDataIfNeeded(grantCreateRequest, localVarRequestOptions, configuration);
|
|
247
|
+
return {
|
|
248
|
+
url: toPathString(localVarUrlObj),
|
|
249
|
+
options: localVarRequestOptions
|
|
250
|
+
};
|
|
251
|
+
},
|
|
202
252
|
/**
|
|
203
253
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
204
254
|
* @summary Initiate Run
|
|
@@ -228,6 +278,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
228
278
|
options: localVarRequestOptions
|
|
229
279
|
};
|
|
230
280
|
},
|
|
281
|
+
/**
|
|
282
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
283
|
+
* @summary Create Share Token
|
|
284
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
285
|
+
* @param {*} [options] Override http request option.
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
createShareTokenV1AccessShareTokensPost: async (shareTokenCreateRequest, options = {}) => {
|
|
289
|
+
assertParamExists("createShareTokenV1AccessShareTokensPost", "shareTokenCreateRequest", shareTokenCreateRequest);
|
|
290
|
+
const localVarPath = `/v1/access/share-tokens`;
|
|
291
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
292
|
+
let baseOptions;
|
|
293
|
+
if (configuration) {
|
|
294
|
+
baseOptions = configuration.baseOptions;
|
|
295
|
+
}
|
|
296
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
297
|
+
const localVarHeaderParameter = {};
|
|
298
|
+
const localVarQueryParameter = {};
|
|
299
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
300
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
301
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
302
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
303
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
304
|
+
localVarRequestOptions.data = serializeDataIfNeeded(shareTokenCreateRequest, localVarRequestOptions, configuration);
|
|
305
|
+
return {
|
|
306
|
+
url: toPathString(localVarUrlObj),
|
|
307
|
+
options: localVarRequestOptions
|
|
308
|
+
};
|
|
309
|
+
},
|
|
231
310
|
/**
|
|
232
311
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
233
312
|
* @summary Delete Run Items
|
|
@@ -260,10 +339,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
260
339
|
* @summary Get Artifact Url
|
|
261
340
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
262
341
|
* @param {string} artifactId The artifact id to download
|
|
342
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
263
343
|
* @param {*} [options] Override http request option.
|
|
264
344
|
* @throws {RequiredError}
|
|
265
345
|
*/
|
|
266
|
-
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, options = {}) => {
|
|
346
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, shareToken, options = {}) => {
|
|
267
347
|
assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "runId", runId);
|
|
268
348
|
assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "artifactId", artifactId);
|
|
269
349
|
const localVarPath = `/v1/runs/{run_id}/artifacts/{artifact_id}/file`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"artifact_id"}}`, encodeURIComponent(String(artifactId)));
|
|
@@ -276,6 +356,36 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
276
356
|
const localVarHeaderParameter = {};
|
|
277
357
|
const localVarQueryParameter = {};
|
|
278
358
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
359
|
+
if (shareToken !== void 0) {
|
|
360
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
361
|
+
}
|
|
362
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
363
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
364
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
365
|
+
return {
|
|
366
|
+
url: toPathString(localVarUrlObj),
|
|
367
|
+
options: localVarRequestOptions
|
|
368
|
+
};
|
|
369
|
+
},
|
|
370
|
+
/**
|
|
371
|
+
* Get a grant by its ID.
|
|
372
|
+
* @summary Get Grant
|
|
373
|
+
* @param {string} grantId Grant ID
|
|
374
|
+
* @param {*} [options] Override http request option.
|
|
375
|
+
* @throws {RequiredError}
|
|
376
|
+
*/
|
|
377
|
+
getGrantV1AccessGrantsGrantIdGet: async (grantId, options = {}) => {
|
|
378
|
+
assertParamExists("getGrantV1AccessGrantsGrantIdGet", "grantId", grantId);
|
|
379
|
+
const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
|
|
380
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
381
|
+
let baseOptions;
|
|
382
|
+
if (configuration) {
|
|
383
|
+
baseOptions = configuration.baseOptions;
|
|
384
|
+
}
|
|
385
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
386
|
+
const localVarHeaderParameter = {};
|
|
387
|
+
const localVarQueryParameter = {};
|
|
388
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
279
389
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
280
390
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
281
391
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -289,10 +399,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
289
399
|
* @summary Get Item By Run
|
|
290
400
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
291
401
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
402
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
292
403
|
* @param {*} [options] Override http request option.
|
|
293
404
|
* @throws {RequiredError}
|
|
294
405
|
*/
|
|
295
|
-
getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, options = {}) => {
|
|
406
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, shareToken, options = {}) => {
|
|
296
407
|
assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "runId", runId);
|
|
297
408
|
assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "externalId", externalId);
|
|
298
409
|
const localVarPath = `/v1/runs/{run_id}/items/{external_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
|
|
@@ -305,6 +416,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
305
416
|
const localVarHeaderParameter = {};
|
|
306
417
|
const localVarQueryParameter = {};
|
|
307
418
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
419
|
+
if (shareToken !== void 0) {
|
|
420
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
421
|
+
}
|
|
308
422
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
309
423
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
310
424
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -339,13 +453,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
339
453
|
};
|
|
340
454
|
},
|
|
341
455
|
/**
|
|
342
|
-
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
456
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
343
457
|
* @summary Get run details
|
|
344
458
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
459
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
345
460
|
* @param {*} [options] Override http request option.
|
|
346
461
|
* @throws {RequiredError}
|
|
347
462
|
*/
|
|
348
|
-
getRunV1RunsRunIdGet: async (runId, options = {}) => {
|
|
463
|
+
getRunV1RunsRunIdGet: async (runId, shareToken, options = {}) => {
|
|
349
464
|
assertParamExists("getRunV1RunsRunIdGet", "runId", runId);
|
|
350
465
|
const localVarPath = `/v1/runs/{run_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
351
466
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -357,6 +472,129 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
357
472
|
const localVarHeaderParameter = {};
|
|
358
473
|
const localVarQueryParameter = {};
|
|
359
474
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
475
|
+
if (shareToken !== void 0) {
|
|
476
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
477
|
+
}
|
|
478
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
479
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
480
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
481
|
+
return {
|
|
482
|
+
url: toPathString(localVarUrlObj),
|
|
483
|
+
options: localVarRequestOptions
|
|
484
|
+
};
|
|
485
|
+
},
|
|
486
|
+
/**
|
|
487
|
+
* Get a share token by its ID.
|
|
488
|
+
* @summary Get Share Token
|
|
489
|
+
* @param {string} shareTokenId Share token ID
|
|
490
|
+
* @param {*} [options] Override http request option.
|
|
491
|
+
* @throws {RequiredError}
|
|
492
|
+
*/
|
|
493
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet: async (shareTokenId, options = {}) => {
|
|
494
|
+
assertParamExists("getShareTokenV1AccessShareTokensShareTokenIdGet", "shareTokenId", shareTokenId);
|
|
495
|
+
const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
|
|
496
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
497
|
+
let baseOptions;
|
|
498
|
+
if (configuration) {
|
|
499
|
+
baseOptions = configuration.baseOptions;
|
|
500
|
+
}
|
|
501
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
502
|
+
const localVarHeaderParameter = {};
|
|
503
|
+
const localVarQueryParameter = {};
|
|
504
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
505
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
506
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
507
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
508
|
+
return {
|
|
509
|
+
url: toPathString(localVarUrlObj),
|
|
510
|
+
options: localVarRequestOptions
|
|
511
|
+
};
|
|
512
|
+
},
|
|
513
|
+
/**
|
|
514
|
+
* Return metadata for a single public document attached to an application version.
|
|
515
|
+
* @summary Get version document metadata
|
|
516
|
+
* @param {string} applicationId
|
|
517
|
+
* @param {string} version
|
|
518
|
+
* @param {string} name
|
|
519
|
+
* @param {*} [options] Override http request option.
|
|
520
|
+
* @throws {RequiredError}
|
|
521
|
+
*/
|
|
522
|
+
getVersionDocument: async (applicationId, version, name, options = {}) => {
|
|
523
|
+
assertParamExists("getVersionDocument", "applicationId", applicationId);
|
|
524
|
+
assertParamExists("getVersionDocument", "version", version);
|
|
525
|
+
assertParamExists("getVersionDocument", "name", name);
|
|
526
|
+
const localVarPath = `/v1/applications/{application_id}/versions/{version}/documents/{name}`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version))).replace(`{${"name"}}`, encodeURIComponent(String(name)));
|
|
527
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
528
|
+
let baseOptions;
|
|
529
|
+
if (configuration) {
|
|
530
|
+
baseOptions = configuration.baseOptions;
|
|
531
|
+
}
|
|
532
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
533
|
+
const localVarHeaderParameter = {};
|
|
534
|
+
const localVarQueryParameter = {};
|
|
535
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
536
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
537
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
538
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
539
|
+
return {
|
|
540
|
+
url: toPathString(localVarUrlObj),
|
|
541
|
+
options: localVarRequestOptions
|
|
542
|
+
};
|
|
543
|
+
},
|
|
544
|
+
/**
|
|
545
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
546
|
+
* @summary Stream version document content (programmatic)
|
|
547
|
+
* @param {string} applicationId
|
|
548
|
+
* @param {string} version
|
|
549
|
+
* @param {string} name
|
|
550
|
+
* @param {*} [options] Override http request option.
|
|
551
|
+
* @throws {RequiredError}
|
|
552
|
+
*/
|
|
553
|
+
getVersionDocumentContent: async (applicationId, version, name, options = {}) => {
|
|
554
|
+
assertParamExists("getVersionDocumentContent", "applicationId", applicationId);
|
|
555
|
+
assertParamExists("getVersionDocumentContent", "version", version);
|
|
556
|
+
assertParamExists("getVersionDocumentContent", "name", name);
|
|
557
|
+
const localVarPath = `/v1/applications/{application_id}/versions/{version}/documents/{name}/content`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version))).replace(`{${"name"}}`, encodeURIComponent(String(name)));
|
|
558
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
559
|
+
let baseOptions;
|
|
560
|
+
if (configuration) {
|
|
561
|
+
baseOptions = configuration.baseOptions;
|
|
562
|
+
}
|
|
563
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
564
|
+
const localVarHeaderParameter = {};
|
|
565
|
+
const localVarQueryParameter = {};
|
|
566
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
567
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
568
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
569
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
570
|
+
return {
|
|
571
|
+
url: toPathString(localVarUrlObj),
|
|
572
|
+
options: localVarRequestOptions
|
|
573
|
+
};
|
|
574
|
+
},
|
|
575
|
+
/**
|
|
576
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
577
|
+
* @summary Download version document (browser)
|
|
578
|
+
* @param {string} applicationId
|
|
579
|
+
* @param {string} version
|
|
580
|
+
* @param {string} name
|
|
581
|
+
* @param {*} [options] Override http request option.
|
|
582
|
+
* @throws {RequiredError}
|
|
583
|
+
*/
|
|
584
|
+
getVersionDocumentFile: async (applicationId, version, name, options = {}) => {
|
|
585
|
+
assertParamExists("getVersionDocumentFile", "applicationId", applicationId);
|
|
586
|
+
assertParamExists("getVersionDocumentFile", "version", version);
|
|
587
|
+
assertParamExists("getVersionDocumentFile", "name", name);
|
|
588
|
+
const localVarPath = `/v1/applications/{application_id}/versions/{version}/documents/{name}/file`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version))).replace(`{${"name"}}`, encodeURIComponent(String(name)));
|
|
589
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
590
|
+
let baseOptions;
|
|
591
|
+
if (configuration) {
|
|
592
|
+
baseOptions = configuration.baseOptions;
|
|
593
|
+
}
|
|
594
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
595
|
+
const localVarHeaderParameter = {};
|
|
596
|
+
const localVarQueryParameter = {};
|
|
597
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
360
598
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
361
599
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
362
600
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -402,10 +640,68 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
402
640
|
options: localVarRequestOptions
|
|
403
641
|
};
|
|
404
642
|
},
|
|
643
|
+
/**
|
|
644
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
645
|
+
* @summary List Grants
|
|
646
|
+
* @param {ResourceType | null} [resourceType]
|
|
647
|
+
* @param {string | null} [resourceId]
|
|
648
|
+
* @param {SubjectType | null} [subjectType]
|
|
649
|
+
* @param {string | null} [subjectId]
|
|
650
|
+
* @param {boolean | null} [revoked]
|
|
651
|
+
* @param {number} [page]
|
|
652
|
+
* @param {number} [pageSize]
|
|
653
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
*/
|
|
657
|
+
listGrantsV1AccessGrantsGet: async (resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options = {}) => {
|
|
658
|
+
const localVarPath = `/v1/access/grants`;
|
|
659
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
660
|
+
let baseOptions;
|
|
661
|
+
if (configuration) {
|
|
662
|
+
baseOptions = configuration.baseOptions;
|
|
663
|
+
}
|
|
664
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
665
|
+
const localVarHeaderParameter = {};
|
|
666
|
+
const localVarQueryParameter = {};
|
|
667
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
668
|
+
if (resourceType !== void 0) {
|
|
669
|
+
localVarQueryParameter["resource_type"] = resourceType;
|
|
670
|
+
}
|
|
671
|
+
if (resourceId !== void 0) {
|
|
672
|
+
localVarQueryParameter["resource_id"] = resourceId;
|
|
673
|
+
}
|
|
674
|
+
if (subjectType !== void 0) {
|
|
675
|
+
localVarQueryParameter["subject_type"] = subjectType;
|
|
676
|
+
}
|
|
677
|
+
if (subjectId !== void 0) {
|
|
678
|
+
localVarQueryParameter["subject_id"] = subjectId;
|
|
679
|
+
}
|
|
680
|
+
if (revoked !== void 0) {
|
|
681
|
+
localVarQueryParameter["revoked"] = revoked;
|
|
682
|
+
}
|
|
683
|
+
if (page !== void 0) {
|
|
684
|
+
localVarQueryParameter["page"] = page;
|
|
685
|
+
}
|
|
686
|
+
if (pageSize !== void 0) {
|
|
687
|
+
localVarQueryParameter["page_size"] = pageSize;
|
|
688
|
+
}
|
|
689
|
+
if (sort) {
|
|
690
|
+
localVarQueryParameter["sort"] = sort;
|
|
691
|
+
}
|
|
692
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
693
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
694
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
695
|
+
return {
|
|
696
|
+
url: toPathString(localVarUrlObj),
|
|
697
|
+
options: localVarRequestOptions
|
|
698
|
+
};
|
|
699
|
+
},
|
|
405
700
|
/**
|
|
406
701
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
407
702
|
* @summary List Run Items
|
|
408
703
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
704
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
409
705
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
410
706
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
411
707
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -417,7 +713,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
417
713
|
* @param {*} [options] Override http request option.
|
|
418
714
|
* @throws {RequiredError}
|
|
419
715
|
*/
|
|
420
|
-
listRunItemsV1RunsRunIdItemsGet: async (runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
|
|
716
|
+
listRunItemsV1RunsRunIdItemsGet: async (runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
|
|
421
717
|
assertParamExists("listRunItemsV1RunsRunIdItemsGet", "runId", runId);
|
|
422
718
|
const localVarPath = `/v1/runs/{run_id}/items`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
423
719
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -429,6 +725,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
429
725
|
const localVarHeaderParameter = {};
|
|
430
726
|
const localVarQueryParameter = {};
|
|
431
727
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
728
|
+
if (shareToken !== void 0) {
|
|
729
|
+
localVarQueryParameter["share_token"] = shareToken;
|
|
730
|
+
}
|
|
432
731
|
if (itemIdIn) {
|
|
433
732
|
localVarQueryParameter["item_id__in"] = itemIdIn;
|
|
434
733
|
}
|
|
@@ -518,6 +817,84 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
518
817
|
options: localVarRequestOptions
|
|
519
818
|
};
|
|
520
819
|
},
|
|
820
|
+
/**
|
|
821
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
822
|
+
* @summary List Share Tokens
|
|
823
|
+
* @param {string | null} [runId] Filter by run ID
|
|
824
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
825
|
+
* @param {boolean | null} [revoked]
|
|
826
|
+
* @param {number} [page]
|
|
827
|
+
* @param {number} [pageSize]
|
|
828
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
829
|
+
* @param {*} [options] Override http request option.
|
|
830
|
+
* @throws {RequiredError}
|
|
831
|
+
*/
|
|
832
|
+
listShareTokensV1AccessShareTokensGet: async (runId, createdBy, revoked, page, pageSize, sort, options = {}) => {
|
|
833
|
+
const localVarPath = `/v1/access/share-tokens`;
|
|
834
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
835
|
+
let baseOptions;
|
|
836
|
+
if (configuration) {
|
|
837
|
+
baseOptions = configuration.baseOptions;
|
|
838
|
+
}
|
|
839
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
840
|
+
const localVarHeaderParameter = {};
|
|
841
|
+
const localVarQueryParameter = {};
|
|
842
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
843
|
+
if (runId !== void 0) {
|
|
844
|
+
localVarQueryParameter["run_id"] = runId;
|
|
845
|
+
}
|
|
846
|
+
if (createdBy !== void 0) {
|
|
847
|
+
localVarQueryParameter["created_by"] = createdBy;
|
|
848
|
+
}
|
|
849
|
+
if (revoked !== void 0) {
|
|
850
|
+
localVarQueryParameter["revoked"] = revoked;
|
|
851
|
+
}
|
|
852
|
+
if (page !== void 0) {
|
|
853
|
+
localVarQueryParameter["page"] = page;
|
|
854
|
+
}
|
|
855
|
+
if (pageSize !== void 0) {
|
|
856
|
+
localVarQueryParameter["page_size"] = pageSize;
|
|
857
|
+
}
|
|
858
|
+
if (sort) {
|
|
859
|
+
localVarQueryParameter["sort"] = sort;
|
|
860
|
+
}
|
|
861
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
862
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
863
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
864
|
+
return {
|
|
865
|
+
url: toPathString(localVarUrlObj),
|
|
866
|
+
options: localVarRequestOptions
|
|
867
|
+
};
|
|
868
|
+
},
|
|
869
|
+
/**
|
|
870
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
871
|
+
* @summary List version documents
|
|
872
|
+
* @param {string} applicationId
|
|
873
|
+
* @param {string} version
|
|
874
|
+
* @param {*} [options] Override http request option.
|
|
875
|
+
* @throws {RequiredError}
|
|
876
|
+
*/
|
|
877
|
+
listVersionDocuments: async (applicationId, version, options = {}) => {
|
|
878
|
+
assertParamExists("listVersionDocuments", "applicationId", applicationId);
|
|
879
|
+
assertParamExists("listVersionDocuments", "version", version);
|
|
880
|
+
const localVarPath = `/v1/applications/{application_id}/versions/{version}/documents`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version)));
|
|
881
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
882
|
+
let baseOptions;
|
|
883
|
+
if (configuration) {
|
|
884
|
+
baseOptions = configuration.baseOptions;
|
|
885
|
+
}
|
|
886
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
887
|
+
const localVarHeaderParameter = {};
|
|
888
|
+
const localVarQueryParameter = {};
|
|
889
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
890
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
891
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
892
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
893
|
+
return {
|
|
894
|
+
url: toPathString(localVarUrlObj),
|
|
895
|
+
options: localVarRequestOptions
|
|
896
|
+
};
|
|
897
|
+
},
|
|
521
898
|
/**
|
|
522
899
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
523
900
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -608,6 +985,60 @@ var PublicApiAxiosParamCreator = function(configuration) {
|
|
|
608
985
|
url: toPathString(localVarUrlObj),
|
|
609
986
|
options: localVarRequestOptions
|
|
610
987
|
};
|
|
988
|
+
},
|
|
989
|
+
/**
|
|
990
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
991
|
+
* @summary Revoke Grant
|
|
992
|
+
* @param {string} grantId Grant ID
|
|
993
|
+
* @param {*} [options] Override http request option.
|
|
994
|
+
* @throws {RequiredError}
|
|
995
|
+
*/
|
|
996
|
+
revokeGrantV1AccessGrantsGrantIdDelete: async (grantId, options = {}) => {
|
|
997
|
+
assertParamExists("revokeGrantV1AccessGrantsGrantIdDelete", "grantId", grantId);
|
|
998
|
+
const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
|
|
999
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1000
|
+
let baseOptions;
|
|
1001
|
+
if (configuration) {
|
|
1002
|
+
baseOptions = configuration.baseOptions;
|
|
1003
|
+
}
|
|
1004
|
+
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
1005
|
+
const localVarHeaderParameter = {};
|
|
1006
|
+
const localVarQueryParameter = {};
|
|
1007
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
1008
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1009
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1010
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1011
|
+
return {
|
|
1012
|
+
url: toPathString(localVarUrlObj),
|
|
1013
|
+
options: localVarRequestOptions
|
|
1014
|
+
};
|
|
1015
|
+
},
|
|
1016
|
+
/**
|
|
1017
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1018
|
+
* @summary Revoke Share Token
|
|
1019
|
+
* @param {string} shareTokenId Share token ID
|
|
1020
|
+
* @param {*} [options] Override http request option.
|
|
1021
|
+
* @throws {RequiredError}
|
|
1022
|
+
*/
|
|
1023
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete: async (shareTokenId, options = {}) => {
|
|
1024
|
+
assertParamExists("revokeShareTokenV1AccessShareTokensShareTokenIdDelete", "shareTokenId", shareTokenId);
|
|
1025
|
+
const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
|
|
1026
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1027
|
+
let baseOptions;
|
|
1028
|
+
if (configuration) {
|
|
1029
|
+
baseOptions = configuration.baseOptions;
|
|
1030
|
+
}
|
|
1031
|
+
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
1032
|
+
const localVarHeaderParameter = {};
|
|
1033
|
+
const localVarQueryParameter = {};
|
|
1034
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
1035
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1036
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1037
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1038
|
+
return {
|
|
1039
|
+
url: toPathString(localVarUrlObj),
|
|
1040
|
+
options: localVarRequestOptions
|
|
1041
|
+
};
|
|
611
1042
|
}
|
|
612
1043
|
};
|
|
613
1044
|
};
|
|
@@ -641,6 +1072,19 @@ var PublicApiFp = function(configuration) {
|
|
|
641
1072
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelRunV1RunsRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
|
|
642
1073
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
643
1074
|
},
|
|
1075
|
+
/**
|
|
1076
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1077
|
+
* @summary Create Grant
|
|
1078
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
1079
|
+
* @param {*} [options] Override http request option.
|
|
1080
|
+
* @throws {RequiredError}
|
|
1081
|
+
*/
|
|
1082
|
+
async createGrantV1AccessGrantsPost(grantCreateRequest, options) {
|
|
1083
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createGrantV1AccessGrantsPost(grantCreateRequest, options);
|
|
1084
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1085
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.createGrantV1AccessGrantsPost"]?.[localVarOperationServerIndex]?.url;
|
|
1086
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1087
|
+
},
|
|
644
1088
|
/**
|
|
645
1089
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
646
1090
|
* @summary Initiate Run
|
|
@@ -654,6 +1098,19 @@ var PublicApiFp = function(configuration) {
|
|
|
654
1098
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.createRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
|
|
655
1099
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
656
1100
|
},
|
|
1101
|
+
/**
|
|
1102
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1103
|
+
* @summary Create Share Token
|
|
1104
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
1105
|
+
* @param {*} [options] Override http request option.
|
|
1106
|
+
* @throws {RequiredError}
|
|
1107
|
+
*/
|
|
1108
|
+
async createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options) {
|
|
1109
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options);
|
|
1110
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1111
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.createShareTokenV1AccessShareTokensPost"]?.[localVarOperationServerIndex]?.url;
|
|
1112
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1113
|
+
},
|
|
657
1114
|
/**
|
|
658
1115
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
659
1116
|
* @summary Delete Run Items
|
|
@@ -672,25 +1129,40 @@ var PublicApiFp = function(configuration) {
|
|
|
672
1129
|
* @summary Get Artifact Url
|
|
673
1130
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
674
1131
|
* @param {string} artifactId The artifact id to download
|
|
1132
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
675
1133
|
* @param {*} [options] Override http request option.
|
|
676
1134
|
* @throws {RequiredError}
|
|
677
1135
|
*/
|
|
678
|
-
async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options) {
|
|
679
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options);
|
|
1136
|
+
async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options) {
|
|
1137
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options);
|
|
680
1138
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
681
1139
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet"]?.[localVarOperationServerIndex]?.url;
|
|
682
1140
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
683
1141
|
},
|
|
1142
|
+
/**
|
|
1143
|
+
* Get a grant by its ID.
|
|
1144
|
+
* @summary Get Grant
|
|
1145
|
+
* @param {string} grantId Grant ID
|
|
1146
|
+
* @param {*} [options] Override http request option.
|
|
1147
|
+
* @throws {RequiredError}
|
|
1148
|
+
*/
|
|
1149
|
+
async getGrantV1AccessGrantsGrantIdGet(grantId, options) {
|
|
1150
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGrantV1AccessGrantsGrantIdGet(grantId, options);
|
|
1151
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1152
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getGrantV1AccessGrantsGrantIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
1153
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1154
|
+
},
|
|
684
1155
|
/**
|
|
685
1156
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
686
1157
|
* @summary Get Item By Run
|
|
687
1158
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
688
1159
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1160
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
689
1161
|
* @param {*} [options] Override http request option.
|
|
690
1162
|
* @throws {RequiredError}
|
|
691
1163
|
*/
|
|
692
|
-
async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options) {
|
|
693
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options);
|
|
1164
|
+
async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options) {
|
|
1165
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options);
|
|
694
1166
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
695
1167
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.getItemByRunV1RunsRunIdItemsExternalIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
696
1168
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -708,18 +1180,77 @@ var PublicApiFp = function(configuration) {
|
|
|
708
1180
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
709
1181
|
},
|
|
710
1182
|
/**
|
|
711
|
-
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1183
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
712
1184
|
* @summary Get run details
|
|
713
1185
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1186
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
714
1187
|
* @param {*} [options] Override http request option.
|
|
715
1188
|
* @throws {RequiredError}
|
|
716
1189
|
*/
|
|
717
|
-
async getRunV1RunsRunIdGet(runId, options) {
|
|
718
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, options);
|
|
1190
|
+
async getRunV1RunsRunIdGet(runId, shareToken, options) {
|
|
1191
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, shareToken, options);
|
|
719
1192
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
720
1193
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsRunIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
721
1194
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
722
1195
|
},
|
|
1196
|
+
/**
|
|
1197
|
+
* Get a share token by its ID.
|
|
1198
|
+
* @summary Get Share Token
|
|
1199
|
+
* @param {string} shareTokenId Share token ID
|
|
1200
|
+
* @param {*} [options] Override http request option.
|
|
1201
|
+
* @throws {RequiredError}
|
|
1202
|
+
*/
|
|
1203
|
+
async getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options) {
|
|
1204
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options);
|
|
1205
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1206
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getShareTokenV1AccessShareTokensShareTokenIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
1207
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1208
|
+
},
|
|
1209
|
+
/**
|
|
1210
|
+
* Return metadata for a single public document attached to an application version.
|
|
1211
|
+
* @summary Get version document metadata
|
|
1212
|
+
* @param {string} applicationId
|
|
1213
|
+
* @param {string} version
|
|
1214
|
+
* @param {string} name
|
|
1215
|
+
* @param {*} [options] Override http request option.
|
|
1216
|
+
* @throws {RequiredError}
|
|
1217
|
+
*/
|
|
1218
|
+
async getVersionDocument(applicationId, version, name, options) {
|
|
1219
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVersionDocument(applicationId, version, name, options);
|
|
1220
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1221
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getVersionDocument"]?.[localVarOperationServerIndex]?.url;
|
|
1222
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1223
|
+
},
|
|
1224
|
+
/**
|
|
1225
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1226
|
+
* @summary Stream version document content (programmatic)
|
|
1227
|
+
* @param {string} applicationId
|
|
1228
|
+
* @param {string} version
|
|
1229
|
+
* @param {string} name
|
|
1230
|
+
* @param {*} [options] Override http request option.
|
|
1231
|
+
* @throws {RequiredError}
|
|
1232
|
+
*/
|
|
1233
|
+
async getVersionDocumentContent(applicationId, version, name, options) {
|
|
1234
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVersionDocumentContent(applicationId, version, name, options);
|
|
1235
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1236
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getVersionDocumentContent"]?.[localVarOperationServerIndex]?.url;
|
|
1237
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1238
|
+
},
|
|
1239
|
+
/**
|
|
1240
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1241
|
+
* @summary Download version document (browser)
|
|
1242
|
+
* @param {string} applicationId
|
|
1243
|
+
* @param {string} version
|
|
1244
|
+
* @param {string} name
|
|
1245
|
+
* @param {*} [options] Override http request option.
|
|
1246
|
+
* @throws {RequiredError}
|
|
1247
|
+
*/
|
|
1248
|
+
async getVersionDocumentFile(applicationId, version, name, options) {
|
|
1249
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVersionDocumentFile(applicationId, version, name, options);
|
|
1250
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1251
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.getVersionDocumentFile"]?.[localVarOperationServerIndex]?.url;
|
|
1252
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1253
|
+
},
|
|
723
1254
|
/**
|
|
724
1255
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
725
1256
|
* @summary List available applications
|
|
@@ -732,13 +1263,34 @@ var PublicApiFp = function(configuration) {
|
|
|
732
1263
|
async listApplicationsV1ApplicationsGet(page, pageSize, sort, options) {
|
|
733
1264
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationsV1ApplicationsGet(page, pageSize, sort, options);
|
|
734
1265
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
735
|
-
const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
|
|
1266
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
|
|
1267
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1268
|
+
},
|
|
1269
|
+
/**
|
|
1270
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1271
|
+
* @summary List Grants
|
|
1272
|
+
* @param {ResourceType | null} [resourceType]
|
|
1273
|
+
* @param {string | null} [resourceId]
|
|
1274
|
+
* @param {SubjectType | null} [subjectType]
|
|
1275
|
+
* @param {string | null} [subjectId]
|
|
1276
|
+
* @param {boolean | null} [revoked]
|
|
1277
|
+
* @param {number} [page]
|
|
1278
|
+
* @param {number} [pageSize]
|
|
1279
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1280
|
+
* @param {*} [options] Override http request option.
|
|
1281
|
+
* @throws {RequiredError}
|
|
1282
|
+
*/
|
|
1283
|
+
async listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options) {
|
|
1284
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options);
|
|
1285
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1286
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listGrantsV1AccessGrantsGet"]?.[localVarOperationServerIndex]?.url;
|
|
736
1287
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
737
1288
|
},
|
|
738
1289
|
/**
|
|
739
1290
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
740
1291
|
* @summary List Run Items
|
|
741
1292
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1293
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
742
1294
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
743
1295
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
744
1296
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -750,8 +1302,8 @@ var PublicApiFp = function(configuration) {
|
|
|
750
1302
|
* @param {*} [options] Override http request option.
|
|
751
1303
|
* @throws {RequiredError}
|
|
752
1304
|
*/
|
|
753
|
-
async listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
|
|
754
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
|
|
1305
|
+
async listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
|
|
1306
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
|
|
755
1307
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
756
1308
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunItemsV1RunsRunIdItemsGet"]?.[localVarOperationServerIndex]?.url;
|
|
757
1309
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -776,6 +1328,38 @@ var PublicApiFp = function(configuration) {
|
|
|
776
1328
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
|
|
777
1329
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
778
1330
|
},
|
|
1331
|
+
/**
|
|
1332
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1333
|
+
* @summary List Share Tokens
|
|
1334
|
+
* @param {string | null} [runId] Filter by run ID
|
|
1335
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
1336
|
+
* @param {boolean | null} [revoked]
|
|
1337
|
+
* @param {number} [page]
|
|
1338
|
+
* @param {number} [pageSize]
|
|
1339
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1340
|
+
* @param {*} [options] Override http request option.
|
|
1341
|
+
* @throws {RequiredError}
|
|
1342
|
+
*/
|
|
1343
|
+
async listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options) {
|
|
1344
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options);
|
|
1345
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1346
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listShareTokensV1AccessShareTokensGet"]?.[localVarOperationServerIndex]?.url;
|
|
1347
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1348
|
+
},
|
|
1349
|
+
/**
|
|
1350
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1351
|
+
* @summary List version documents
|
|
1352
|
+
* @param {string} applicationId
|
|
1353
|
+
* @param {string} version
|
|
1354
|
+
* @param {*} [options] Override http request option.
|
|
1355
|
+
* @throws {RequiredError}
|
|
1356
|
+
*/
|
|
1357
|
+
async listVersionDocuments(applicationId, version, options) {
|
|
1358
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVersionDocuments(applicationId, version, options);
|
|
1359
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1360
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.listVersionDocuments"]?.[localVarOperationServerIndex]?.url;
|
|
1361
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1362
|
+
},
|
|
779
1363
|
/**
|
|
780
1364
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
781
1365
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -817,6 +1401,32 @@ var PublicApiFp = function(configuration) {
|
|
|
817
1401
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
818
1402
|
const localVarOperationServerBasePath = operationServerMap["PublicApi.readApplicationByIdV1ApplicationsApplicationIdGet"]?.[localVarOperationServerIndex]?.url;
|
|
819
1403
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1404
|
+
},
|
|
1405
|
+
/**
|
|
1406
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1407
|
+
* @summary Revoke Grant
|
|
1408
|
+
* @param {string} grantId Grant ID
|
|
1409
|
+
* @param {*} [options] Override http request option.
|
|
1410
|
+
* @throws {RequiredError}
|
|
1411
|
+
*/
|
|
1412
|
+
async revokeGrantV1AccessGrantsGrantIdDelete(grantId, options) {
|
|
1413
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.revokeGrantV1AccessGrantsGrantIdDelete(grantId, options);
|
|
1414
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1415
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeGrantV1AccessGrantsGrantIdDelete"]?.[localVarOperationServerIndex]?.url;
|
|
1416
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1417
|
+
},
|
|
1418
|
+
/**
|
|
1419
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1420
|
+
* @summary Revoke Share Token
|
|
1421
|
+
* @param {string} shareTokenId Share token ID
|
|
1422
|
+
* @param {*} [options] Override http request option.
|
|
1423
|
+
* @throws {RequiredError}
|
|
1424
|
+
*/
|
|
1425
|
+
async revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options) {
|
|
1426
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options);
|
|
1427
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1428
|
+
const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeShareTokenV1AccessShareTokensShareTokenIdDelete"]?.[localVarOperationServerIndex]?.url;
|
|
1429
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
820
1430
|
}
|
|
821
1431
|
};
|
|
822
1432
|
};
|
|
@@ -843,6 +1453,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
843
1453
|
cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
|
|
844
1454
|
return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
845
1455
|
},
|
|
1456
|
+
/**
|
|
1457
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1458
|
+
* @summary Create Grant
|
|
1459
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
1460
|
+
* @param {*} [options] Override http request option.
|
|
1461
|
+
* @throws {RequiredError}
|
|
1462
|
+
*/
|
|
1463
|
+
createGrantV1AccessGrantsPost(requestParameters, options) {
|
|
1464
|
+
return localVarFp.createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(axios, basePath));
|
|
1465
|
+
},
|
|
846
1466
|
/**
|
|
847
1467
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
848
1468
|
* @summary Initiate Run
|
|
@@ -853,6 +1473,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
853
1473
|
createRunV1RunsPost(requestParameters, options) {
|
|
854
1474
|
return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
|
|
855
1475
|
},
|
|
1476
|
+
/**
|
|
1477
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1478
|
+
* @summary Create Share Token
|
|
1479
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
1480
|
+
* @param {*} [options] Override http request option.
|
|
1481
|
+
* @throws {RequiredError}
|
|
1482
|
+
*/
|
|
1483
|
+
createShareTokenV1AccessShareTokensPost(requestParameters, options) {
|
|
1484
|
+
return localVarFp.createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(axios, basePath));
|
|
1485
|
+
},
|
|
856
1486
|
/**
|
|
857
1487
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
858
1488
|
* @summary Delete Run Items
|
|
@@ -871,7 +1501,17 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
871
1501
|
* @throws {RequiredError}
|
|
872
1502
|
*/
|
|
873
1503
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
|
|
874
|
-
return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(axios, basePath));
|
|
1504
|
+
return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
|
|
1505
|
+
},
|
|
1506
|
+
/**
|
|
1507
|
+
* Get a grant by its ID.
|
|
1508
|
+
* @summary Get Grant
|
|
1509
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
1510
|
+
* @param {*} [options] Override http request option.
|
|
1511
|
+
* @throws {RequiredError}
|
|
1512
|
+
*/
|
|
1513
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
|
|
1514
|
+
return localVarFp.getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(axios, basePath));
|
|
875
1515
|
},
|
|
876
1516
|
/**
|
|
877
1517
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
@@ -881,7 +1521,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
881
1521
|
* @throws {RequiredError}
|
|
882
1522
|
*/
|
|
883
1523
|
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
|
|
884
|
-
return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(axios, basePath));
|
|
1524
|
+
return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
|
|
885
1525
|
},
|
|
886
1526
|
/**
|
|
887
1527
|
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
@@ -893,14 +1533,54 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
893
1533
|
return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
|
|
894
1534
|
},
|
|
895
1535
|
/**
|
|
896
|
-
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1536
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
897
1537
|
* @summary Get run details
|
|
898
1538
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
899
1539
|
* @param {*} [options] Override http request option.
|
|
900
1540
|
* @throws {RequiredError}
|
|
901
1541
|
*/
|
|
902
1542
|
getRunV1RunsRunIdGet(requestParameters, options) {
|
|
903
|
-
return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
|
|
1543
|
+
return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
|
|
1544
|
+
},
|
|
1545
|
+
/**
|
|
1546
|
+
* Get a share token by its ID.
|
|
1547
|
+
* @summary Get Share Token
|
|
1548
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
1549
|
+
* @param {*} [options] Override http request option.
|
|
1550
|
+
* @throws {RequiredError}
|
|
1551
|
+
*/
|
|
1552
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
|
|
1553
|
+
return localVarFp.getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
|
|
1554
|
+
},
|
|
1555
|
+
/**
|
|
1556
|
+
* Return metadata for a single public document attached to an application version.
|
|
1557
|
+
* @summary Get version document metadata
|
|
1558
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
1559
|
+
* @param {*} [options] Override http request option.
|
|
1560
|
+
* @throws {RequiredError}
|
|
1561
|
+
*/
|
|
1562
|
+
getVersionDocument(requestParameters, options) {
|
|
1563
|
+
return localVarFp.getVersionDocument(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(axios, basePath));
|
|
1564
|
+
},
|
|
1565
|
+
/**
|
|
1566
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1567
|
+
* @summary Stream version document content (programmatic)
|
|
1568
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
1569
|
+
* @param {*} [options] Override http request option.
|
|
1570
|
+
* @throws {RequiredError}
|
|
1571
|
+
*/
|
|
1572
|
+
getVersionDocumentContent(requestParameters, options) {
|
|
1573
|
+
return localVarFp.getVersionDocumentContent(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(axios, basePath));
|
|
1574
|
+
},
|
|
1575
|
+
/**
|
|
1576
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1577
|
+
* @summary Download version document (browser)
|
|
1578
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
1579
|
+
* @param {*} [options] Override http request option.
|
|
1580
|
+
* @throws {RequiredError}
|
|
1581
|
+
*/
|
|
1582
|
+
getVersionDocumentFile(requestParameters, options) {
|
|
1583
|
+
return localVarFp.getVersionDocumentFile(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(axios, basePath));
|
|
904
1584
|
},
|
|
905
1585
|
/**
|
|
906
1586
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
@@ -912,6 +1592,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
912
1592
|
listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
|
|
913
1593
|
return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
914
1594
|
},
|
|
1595
|
+
/**
|
|
1596
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1597
|
+
* @summary List Grants
|
|
1598
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
1599
|
+
* @param {*} [options] Override http request option.
|
|
1600
|
+
* @throws {RequiredError}
|
|
1601
|
+
*/
|
|
1602
|
+
listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
|
|
1603
|
+
return localVarFp.listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1604
|
+
},
|
|
915
1605
|
/**
|
|
916
1606
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
917
1607
|
* @summary List Run Items
|
|
@@ -920,7 +1610,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
920
1610
|
* @throws {RequiredError}
|
|
921
1611
|
*/
|
|
922
1612
|
listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
|
|
923
|
-
return localVarFp.listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1613
|
+
return localVarFp.listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.shareToken, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
924
1614
|
},
|
|
925
1615
|
/**
|
|
926
1616
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
@@ -932,6 +1622,26 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
932
1622
|
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
933
1623
|
return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
934
1624
|
},
|
|
1625
|
+
/**
|
|
1626
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1627
|
+
* @summary List Share Tokens
|
|
1628
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
1629
|
+
* @param {*} [options] Override http request option.
|
|
1630
|
+
* @throws {RequiredError}
|
|
1631
|
+
*/
|
|
1632
|
+
listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
|
|
1633
|
+
return localVarFp.listShareTokensV1AccessShareTokensGet(requestParameters.runId, requestParameters.createdBy, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
|
|
1634
|
+
},
|
|
1635
|
+
/**
|
|
1636
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1637
|
+
* @summary List version documents
|
|
1638
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
1639
|
+
* @param {*} [options] Override http request option.
|
|
1640
|
+
* @throws {RequiredError}
|
|
1641
|
+
*/
|
|
1642
|
+
listVersionDocuments(requestParameters, options) {
|
|
1643
|
+
return localVarFp.listVersionDocuments(requestParameters.applicationId, requestParameters.version, options).then((request) => request(axios, basePath));
|
|
1644
|
+
},
|
|
935
1645
|
/**
|
|
936
1646
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
937
1647
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -961,6 +1671,26 @@ var PublicApiFactory = function(configuration, basePath, axios) {
|
|
|
961
1671
|
*/
|
|
962
1672
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
|
|
963
1673
|
return localVarFp.readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(axios, basePath));
|
|
1674
|
+
},
|
|
1675
|
+
/**
|
|
1676
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1677
|
+
* @summary Revoke Grant
|
|
1678
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
1679
|
+
* @param {*} [options] Override http request option.
|
|
1680
|
+
* @throws {RequiredError}
|
|
1681
|
+
*/
|
|
1682
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
|
|
1683
|
+
return localVarFp.revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(axios, basePath));
|
|
1684
|
+
},
|
|
1685
|
+
/**
|
|
1686
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1687
|
+
* @summary Revoke Share Token
|
|
1688
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
1689
|
+
* @param {*} [options] Override http request option.
|
|
1690
|
+
* @throws {RequiredError}
|
|
1691
|
+
*/
|
|
1692
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
|
|
1693
|
+
return localVarFp.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
|
|
964
1694
|
}
|
|
965
1695
|
};
|
|
966
1696
|
};
|
|
@@ -987,6 +1717,17 @@ var PublicApi = class extends BaseAPI {
|
|
|
987
1717
|
cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
|
|
988
1718
|
return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
989
1719
|
}
|
|
1720
|
+
/**
|
|
1721
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1722
|
+
* @summary Create Grant
|
|
1723
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
1724
|
+
* @param {*} [options] Override http request option.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
* @memberof PublicApi
|
|
1727
|
+
*/
|
|
1728
|
+
createGrantV1AccessGrantsPost(requestParameters, options) {
|
|
1729
|
+
return PublicApiFp(this.configuration).createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1730
|
+
}
|
|
990
1731
|
/**
|
|
991
1732
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
992
1733
|
* @summary Initiate Run
|
|
@@ -998,6 +1739,17 @@ var PublicApi = class extends BaseAPI {
|
|
|
998
1739
|
createRunV1RunsPost(requestParameters, options) {
|
|
999
1740
|
return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1000
1741
|
}
|
|
1742
|
+
/**
|
|
1743
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1744
|
+
* @summary Create Share Token
|
|
1745
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
1746
|
+
* @param {*} [options] Override http request option.
|
|
1747
|
+
* @throws {RequiredError}
|
|
1748
|
+
* @memberof PublicApi
|
|
1749
|
+
*/
|
|
1750
|
+
createShareTokenV1AccessShareTokensPost(requestParameters, options) {
|
|
1751
|
+
return PublicApiFp(this.configuration).createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1752
|
+
}
|
|
1001
1753
|
/**
|
|
1002
1754
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
1003
1755
|
* @summary Delete Run Items
|
|
@@ -1018,7 +1770,18 @@ var PublicApi = class extends BaseAPI {
|
|
|
1018
1770
|
* @memberof PublicApi
|
|
1019
1771
|
*/
|
|
1020
1772
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
|
|
1021
|
-
return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(this.axios, this.basePath));
|
|
1773
|
+
return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
|
|
1774
|
+
}
|
|
1775
|
+
/**
|
|
1776
|
+
* Get a grant by its ID.
|
|
1777
|
+
* @summary Get Grant
|
|
1778
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
1779
|
+
* @param {*} [options] Override http request option.
|
|
1780
|
+
* @throws {RequiredError}
|
|
1781
|
+
* @memberof PublicApi
|
|
1782
|
+
*/
|
|
1783
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
|
|
1784
|
+
return PublicApiFp(this.configuration).getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
|
|
1022
1785
|
}
|
|
1023
1786
|
/**
|
|
1024
1787
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
@@ -1029,7 +1792,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1029
1792
|
* @memberof PublicApi
|
|
1030
1793
|
*/
|
|
1031
1794
|
getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
|
|
1032
|
-
return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(this.axios, this.basePath));
|
|
1795
|
+
return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
|
|
1033
1796
|
}
|
|
1034
1797
|
/**
|
|
1035
1798
|
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
@@ -1042,7 +1805,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1042
1805
|
return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
|
|
1043
1806
|
}
|
|
1044
1807
|
/**
|
|
1045
|
-
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
|
|
1808
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
1046
1809
|
* @summary Get run details
|
|
1047
1810
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1048
1811
|
* @param {*} [options] Override http request option.
|
|
@@ -1050,7 +1813,51 @@ var PublicApi = class extends BaseAPI {
|
|
|
1050
1813
|
* @memberof PublicApi
|
|
1051
1814
|
*/
|
|
1052
1815
|
getRunV1RunsRunIdGet(requestParameters, options) {
|
|
1053
|
-
return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
1816
|
+
return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
|
|
1817
|
+
}
|
|
1818
|
+
/**
|
|
1819
|
+
* Get a share token by its ID.
|
|
1820
|
+
* @summary Get Share Token
|
|
1821
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
1822
|
+
* @param {*} [options] Override http request option.
|
|
1823
|
+
* @throws {RequiredError}
|
|
1824
|
+
* @memberof PublicApi
|
|
1825
|
+
*/
|
|
1826
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
|
|
1827
|
+
return PublicApiFp(this.configuration).getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
|
|
1828
|
+
}
|
|
1829
|
+
/**
|
|
1830
|
+
* Return metadata for a single public document attached to an application version.
|
|
1831
|
+
* @summary Get version document metadata
|
|
1832
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
1833
|
+
* @param {*} [options] Override http request option.
|
|
1834
|
+
* @throws {RequiredError}
|
|
1835
|
+
* @memberof PublicApi
|
|
1836
|
+
*/
|
|
1837
|
+
getVersionDocument(requestParameters, options) {
|
|
1838
|
+
return PublicApiFp(this.configuration).getVersionDocument(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(this.axios, this.basePath));
|
|
1839
|
+
}
|
|
1840
|
+
/**
|
|
1841
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1842
|
+
* @summary Stream version document content (programmatic)
|
|
1843
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
1844
|
+
* @param {*} [options] Override http request option.
|
|
1845
|
+
* @throws {RequiredError}
|
|
1846
|
+
* @memberof PublicApi
|
|
1847
|
+
*/
|
|
1848
|
+
getVersionDocumentContent(requestParameters, options) {
|
|
1849
|
+
return PublicApiFp(this.configuration).getVersionDocumentContent(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(this.axios, this.basePath));
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1853
|
+
* @summary Download version document (browser)
|
|
1854
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
1855
|
+
* @param {*} [options] Override http request option.
|
|
1856
|
+
* @throws {RequiredError}
|
|
1857
|
+
* @memberof PublicApi
|
|
1858
|
+
*/
|
|
1859
|
+
getVersionDocumentFile(requestParameters, options) {
|
|
1860
|
+
return PublicApiFp(this.configuration).getVersionDocumentFile(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(this.axios, this.basePath));
|
|
1054
1861
|
}
|
|
1055
1862
|
/**
|
|
1056
1863
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
@@ -1063,6 +1870,17 @@ var PublicApi = class extends BaseAPI {
|
|
|
1063
1870
|
listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
|
|
1064
1871
|
return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1065
1872
|
}
|
|
1873
|
+
/**
|
|
1874
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1875
|
+
* @summary List Grants
|
|
1876
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
1877
|
+
* @param {*} [options] Override http request option.
|
|
1878
|
+
* @throws {RequiredError}
|
|
1879
|
+
* @memberof PublicApi
|
|
1880
|
+
*/
|
|
1881
|
+
listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
|
|
1882
|
+
return PublicApiFp(this.configuration).listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1883
|
+
}
|
|
1066
1884
|
/**
|
|
1067
1885
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1068
1886
|
* @summary List Run Items
|
|
@@ -1072,7 +1890,7 @@ var PublicApi = class extends BaseAPI {
|
|
|
1072
1890
|
* @memberof PublicApi
|
|
1073
1891
|
*/
|
|
1074
1892
|
listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
|
|
1075
|
-
return PublicApiFp(this.configuration).listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1893
|
+
return PublicApiFp(this.configuration).listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.shareToken, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1076
1894
|
}
|
|
1077
1895
|
/**
|
|
1078
1896
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
@@ -1085,6 +1903,28 @@ var PublicApi = class extends BaseAPI {
|
|
|
1085
1903
|
listRunsV1RunsGet(requestParameters = {}, options) {
|
|
1086
1904
|
return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1087
1905
|
}
|
|
1906
|
+
/**
|
|
1907
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1908
|
+
* @summary List Share Tokens
|
|
1909
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
1910
|
+
* @param {*} [options] Override http request option.
|
|
1911
|
+
* @throws {RequiredError}
|
|
1912
|
+
* @memberof PublicApi
|
|
1913
|
+
*/
|
|
1914
|
+
listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
|
|
1915
|
+
return PublicApiFp(this.configuration).listShareTokensV1AccessShareTokensGet(requestParameters.runId, requestParameters.createdBy, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
|
|
1916
|
+
}
|
|
1917
|
+
/**
|
|
1918
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1919
|
+
* @summary List version documents
|
|
1920
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
1921
|
+
* @param {*} [options] Override http request option.
|
|
1922
|
+
* @throws {RequiredError}
|
|
1923
|
+
* @memberof PublicApi
|
|
1924
|
+
*/
|
|
1925
|
+
listVersionDocuments(requestParameters, options) {
|
|
1926
|
+
return PublicApiFp(this.configuration).listVersionDocuments(requestParameters.applicationId, requestParameters.version, options).then((request) => request(this.axios, this.basePath));
|
|
1927
|
+
}
|
|
1088
1928
|
/**
|
|
1089
1929
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1090
1930
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1118,6 +1958,28 @@ var PublicApi = class extends BaseAPI {
|
|
|
1118
1958
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
|
|
1119
1959
|
return PublicApiFp(this.configuration).readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(this.axios, this.basePath));
|
|
1120
1960
|
}
|
|
1961
|
+
/**
|
|
1962
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1963
|
+
* @summary Revoke Grant
|
|
1964
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
1965
|
+
* @param {*} [options] Override http request option.
|
|
1966
|
+
* @throws {RequiredError}
|
|
1967
|
+
* @memberof PublicApi
|
|
1968
|
+
*/
|
|
1969
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
|
|
1970
|
+
return PublicApiFp(this.configuration).revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
|
|
1971
|
+
}
|
|
1972
|
+
/**
|
|
1973
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1974
|
+
* @summary Revoke Share Token
|
|
1975
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
1976
|
+
* @param {*} [options] Override http request option.
|
|
1977
|
+
* @throws {RequiredError}
|
|
1978
|
+
* @memberof PublicApi
|
|
1979
|
+
*/
|
|
1980
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
|
|
1981
|
+
return PublicApiFp(this.configuration).revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
|
|
1982
|
+
}
|
|
1121
1983
|
};
|
|
1122
1984
|
|
|
1123
1985
|
// src/generated/configuration.ts
|
|
@@ -1373,6 +2235,256 @@ var processRunItem = (item) => {
|
|
|
1373
2235
|
};
|
|
1374
2236
|
};
|
|
1375
2237
|
|
|
2238
|
+
// ../../node_modules/is-network-error/index.js
|
|
2239
|
+
var objectToString = Object.prototype.toString;
|
|
2240
|
+
var isError = (value) => objectToString.call(value) === "[object Error]";
|
|
2241
|
+
var errorMessages = /* @__PURE__ */ new Set([
|
|
2242
|
+
"network error",
|
|
2243
|
+
// Chrome
|
|
2244
|
+
"NetworkError when attempting to fetch resource.",
|
|
2245
|
+
// Firefox
|
|
2246
|
+
"The Internet connection appears to be offline.",
|
|
2247
|
+
// Safari 16
|
|
2248
|
+
"Network request failed",
|
|
2249
|
+
// `cross-fetch`
|
|
2250
|
+
"fetch failed",
|
|
2251
|
+
// Undici (Node.js)
|
|
2252
|
+
"terminated",
|
|
2253
|
+
// Undici (Node.js)
|
|
2254
|
+
" A network error occurred.",
|
|
2255
|
+
// Bun (WebKit)
|
|
2256
|
+
"Network connection lost"
|
|
2257
|
+
// Cloudflare Workers (fetch)
|
|
2258
|
+
]);
|
|
2259
|
+
function isNetworkError(error) {
|
|
2260
|
+
const isValid = error && isError(error) && error.name === "TypeError" && typeof error.message === "string";
|
|
2261
|
+
if (!isValid) {
|
|
2262
|
+
return false;
|
|
2263
|
+
}
|
|
2264
|
+
const { message, stack } = error;
|
|
2265
|
+
if (message === "Load failed") {
|
|
2266
|
+
return stack === void 0 || "__sentry_captured__" in error;
|
|
2267
|
+
}
|
|
2268
|
+
if (message.startsWith("error sending request for url")) {
|
|
2269
|
+
return true;
|
|
2270
|
+
}
|
|
2271
|
+
if (message === "Failed to fetch" || message.startsWith("Failed to fetch (") && message.endsWith(")")) {
|
|
2272
|
+
return true;
|
|
2273
|
+
}
|
|
2274
|
+
return errorMessages.has(message);
|
|
2275
|
+
}
|
|
2276
|
+
|
|
2277
|
+
// ../../node_modules/p-retry/index.js
|
|
2278
|
+
function validateRetries(retries) {
|
|
2279
|
+
if (typeof retries === "number") {
|
|
2280
|
+
if (retries < 0) {
|
|
2281
|
+
throw new TypeError("Expected `retries` to be a non-negative number.");
|
|
2282
|
+
}
|
|
2283
|
+
if (Number.isNaN(retries)) {
|
|
2284
|
+
throw new TypeError("Expected `retries` to be a valid number or Infinity, got NaN.");
|
|
2285
|
+
}
|
|
2286
|
+
} else if (retries !== void 0) {
|
|
2287
|
+
throw new TypeError("Expected `retries` to be a number or Infinity.");
|
|
2288
|
+
}
|
|
2289
|
+
}
|
|
2290
|
+
function validateNumberOption(name, value, { min = 0, allowInfinity = false } = {}) {
|
|
2291
|
+
if (value === void 0) {
|
|
2292
|
+
return;
|
|
2293
|
+
}
|
|
2294
|
+
if (typeof value !== "number" || Number.isNaN(value)) {
|
|
2295
|
+
throw new TypeError(`Expected \`${name}\` to be a number${allowInfinity ? " or Infinity" : ""}.`);
|
|
2296
|
+
}
|
|
2297
|
+
if (!allowInfinity && !Number.isFinite(value)) {
|
|
2298
|
+
throw new TypeError(`Expected \`${name}\` to be a finite number.`);
|
|
2299
|
+
}
|
|
2300
|
+
if (value < min) {
|
|
2301
|
+
throw new TypeError(`Expected \`${name}\` to be \u2265 ${min}.`);
|
|
2302
|
+
}
|
|
2303
|
+
}
|
|
2304
|
+
function validateFunctionOption(name, value) {
|
|
2305
|
+
if (value === void 0) {
|
|
2306
|
+
return;
|
|
2307
|
+
}
|
|
2308
|
+
if (typeof value !== "function") {
|
|
2309
|
+
throw new TypeError(`Expected \`${name}\` to be a function.`);
|
|
2310
|
+
}
|
|
2311
|
+
}
|
|
2312
|
+
var AbortError = class extends Error {
|
|
2313
|
+
constructor(message) {
|
|
2314
|
+
super();
|
|
2315
|
+
if (message instanceof Error) {
|
|
2316
|
+
this.originalError = message;
|
|
2317
|
+
({ message } = message);
|
|
2318
|
+
} else {
|
|
2319
|
+
this.originalError = new Error(message);
|
|
2320
|
+
this.originalError.stack = this.stack;
|
|
2321
|
+
}
|
|
2322
|
+
this.name = "AbortError";
|
|
2323
|
+
this.message = message;
|
|
2324
|
+
}
|
|
2325
|
+
};
|
|
2326
|
+
function calculateDelay(retriesConsumed, options) {
|
|
2327
|
+
const attempt = Math.max(1, retriesConsumed + 1);
|
|
2328
|
+
const random = options.randomize ? Math.random() + 1 : 1;
|
|
2329
|
+
let timeout = Math.round(random * options.minTimeout * options.factor ** (attempt - 1));
|
|
2330
|
+
timeout = Math.min(timeout, options.maxTimeout);
|
|
2331
|
+
return timeout;
|
|
2332
|
+
}
|
|
2333
|
+
function calculateRemainingTime(start, max) {
|
|
2334
|
+
if (!Number.isFinite(max)) {
|
|
2335
|
+
return max;
|
|
2336
|
+
}
|
|
2337
|
+
return max - (performance.now() - start);
|
|
2338
|
+
}
|
|
2339
|
+
async function delayForRetry(delay, options) {
|
|
2340
|
+
if (delay <= 0) {
|
|
2341
|
+
return;
|
|
2342
|
+
}
|
|
2343
|
+
await new Promise((resolve, reject) => {
|
|
2344
|
+
const onAbort = () => {
|
|
2345
|
+
clearTimeout(timeoutToken);
|
|
2346
|
+
options.signal?.removeEventListener("abort", onAbort);
|
|
2347
|
+
reject(options.signal.reason);
|
|
2348
|
+
};
|
|
2349
|
+
const timeoutToken = setTimeout(() => {
|
|
2350
|
+
options.signal?.removeEventListener("abort", onAbort);
|
|
2351
|
+
resolve();
|
|
2352
|
+
}, delay);
|
|
2353
|
+
if (options.unref) {
|
|
2354
|
+
timeoutToken.unref?.();
|
|
2355
|
+
}
|
|
2356
|
+
options.signal?.addEventListener("abort", onAbort, { once: true });
|
|
2357
|
+
});
|
|
2358
|
+
}
|
|
2359
|
+
async function onAttemptFailure({ error, attemptNumber, retriesConsumed, startTime, options }) {
|
|
2360
|
+
const normalizedError = error instanceof Error ? error : new TypeError(`Non-error was thrown: "${error}". You should only throw errors.`);
|
|
2361
|
+
if (normalizedError instanceof AbortError) {
|
|
2362
|
+
throw normalizedError.originalError;
|
|
2363
|
+
}
|
|
2364
|
+
const retriesLeft = Number.isFinite(options.retries) ? Math.max(0, options.retries - retriesConsumed) : options.retries;
|
|
2365
|
+
const maxRetryTime = options.maxRetryTime ?? Number.POSITIVE_INFINITY;
|
|
2366
|
+
const delayTime = calculateDelay(retriesConsumed, options);
|
|
2367
|
+
const remainingTimeBeforeCallbacks = calculateRemainingTime(startTime, maxRetryTime);
|
|
2368
|
+
if (remainingTimeBeforeCallbacks <= 0) {
|
|
2369
|
+
const context2 = Object.freeze({
|
|
2370
|
+
error: normalizedError,
|
|
2371
|
+
attemptNumber,
|
|
2372
|
+
retriesLeft,
|
|
2373
|
+
retriesConsumed,
|
|
2374
|
+
retryDelay: 0
|
|
2375
|
+
});
|
|
2376
|
+
await options.onFailedAttempt(context2);
|
|
2377
|
+
throw normalizedError;
|
|
2378
|
+
}
|
|
2379
|
+
const consumeRetryContext = Object.freeze({
|
|
2380
|
+
error: normalizedError,
|
|
2381
|
+
attemptNumber,
|
|
2382
|
+
retriesLeft,
|
|
2383
|
+
retriesConsumed,
|
|
2384
|
+
retryDelay: retriesLeft > 0 ? delayTime : 0
|
|
2385
|
+
});
|
|
2386
|
+
const consumeRetry = await options.shouldConsumeRetry(consumeRetryContext);
|
|
2387
|
+
const effectiveDelay = consumeRetry && retriesLeft > 0 ? delayTime : 0;
|
|
2388
|
+
const context = Object.freeze({
|
|
2389
|
+
error: normalizedError,
|
|
2390
|
+
attemptNumber,
|
|
2391
|
+
retriesLeft,
|
|
2392
|
+
retriesConsumed,
|
|
2393
|
+
retryDelay: effectiveDelay
|
|
2394
|
+
});
|
|
2395
|
+
await options.onFailedAttempt(context);
|
|
2396
|
+
if (calculateRemainingTime(startTime, maxRetryTime) <= 0) {
|
|
2397
|
+
throw normalizedError;
|
|
2398
|
+
}
|
|
2399
|
+
const remainingTime = calculateRemainingTime(startTime, maxRetryTime);
|
|
2400
|
+
if (remainingTime <= 0 || retriesLeft <= 0) {
|
|
2401
|
+
throw normalizedError;
|
|
2402
|
+
}
|
|
2403
|
+
if (normalizedError instanceof TypeError && !isNetworkError(normalizedError)) {
|
|
2404
|
+
throw normalizedError;
|
|
2405
|
+
}
|
|
2406
|
+
if (!await options.shouldRetry(context)) {
|
|
2407
|
+
throw normalizedError;
|
|
2408
|
+
}
|
|
2409
|
+
const remainingTimeAfterShouldRetry = calculateRemainingTime(startTime, maxRetryTime);
|
|
2410
|
+
if (remainingTimeAfterShouldRetry <= 0) {
|
|
2411
|
+
throw normalizedError;
|
|
2412
|
+
}
|
|
2413
|
+
if (!consumeRetry) {
|
|
2414
|
+
options.signal?.throwIfAborted();
|
|
2415
|
+
return false;
|
|
2416
|
+
}
|
|
2417
|
+
const finalDelay = Math.min(effectiveDelay, remainingTimeAfterShouldRetry);
|
|
2418
|
+
options.signal?.throwIfAborted();
|
|
2419
|
+
await delayForRetry(finalDelay, options);
|
|
2420
|
+
options.signal?.throwIfAborted();
|
|
2421
|
+
return true;
|
|
2422
|
+
}
|
|
2423
|
+
async function pRetry(input, options = {}) {
|
|
2424
|
+
options = { ...options };
|
|
2425
|
+
validateRetries(options.retries);
|
|
2426
|
+
if (Object.hasOwn(options, "forever")) {
|
|
2427
|
+
throw new Error("The `forever` option is no longer supported. For many use-cases, you can set `retries: Infinity` instead.");
|
|
2428
|
+
}
|
|
2429
|
+
options.retries ??= 10;
|
|
2430
|
+
options.factor ??= 2;
|
|
2431
|
+
options.minTimeout ??= 1e3;
|
|
2432
|
+
options.maxTimeout ??= Number.POSITIVE_INFINITY;
|
|
2433
|
+
options.maxRetryTime ??= Number.POSITIVE_INFINITY;
|
|
2434
|
+
options.randomize ??= false;
|
|
2435
|
+
options.onFailedAttempt ??= () => {
|
|
2436
|
+
};
|
|
2437
|
+
options.shouldRetry ??= () => true;
|
|
2438
|
+
options.shouldConsumeRetry ??= () => true;
|
|
2439
|
+
validateFunctionOption("onFailedAttempt", options.onFailedAttempt);
|
|
2440
|
+
validateFunctionOption("shouldRetry", options.shouldRetry);
|
|
2441
|
+
validateFunctionOption("shouldConsumeRetry", options.shouldConsumeRetry);
|
|
2442
|
+
validateNumberOption("factor", options.factor, { min: 0, allowInfinity: false });
|
|
2443
|
+
validateNumberOption("minTimeout", options.minTimeout, { min: 0, allowInfinity: false });
|
|
2444
|
+
validateNumberOption("maxTimeout", options.maxTimeout, { min: 0, allowInfinity: true });
|
|
2445
|
+
validateNumberOption("maxRetryTime", options.maxRetryTime, { min: 0, allowInfinity: true });
|
|
2446
|
+
if (!(options.factor > 0)) {
|
|
2447
|
+
options.factor = 1;
|
|
2448
|
+
}
|
|
2449
|
+
options.signal?.throwIfAborted();
|
|
2450
|
+
let attemptNumber = 0;
|
|
2451
|
+
let retriesConsumed = 0;
|
|
2452
|
+
const startTime = performance.now();
|
|
2453
|
+
while (Number.isFinite(options.retries) ? retriesConsumed <= options.retries : true) {
|
|
2454
|
+
attemptNumber++;
|
|
2455
|
+
try {
|
|
2456
|
+
options.signal?.throwIfAborted();
|
|
2457
|
+
const result = await input(attemptNumber);
|
|
2458
|
+
options.signal?.throwIfAborted();
|
|
2459
|
+
return result;
|
|
2460
|
+
} catch (error) {
|
|
2461
|
+
if (await onAttemptFailure({
|
|
2462
|
+
error,
|
|
2463
|
+
attemptNumber,
|
|
2464
|
+
retriesConsumed,
|
|
2465
|
+
startTime,
|
|
2466
|
+
options
|
|
2467
|
+
})) {
|
|
2468
|
+
retriesConsumed++;
|
|
2469
|
+
}
|
|
2470
|
+
}
|
|
2471
|
+
}
|
|
2472
|
+
throw new Error("Retry attempts exhausted without throwing an error.");
|
|
2473
|
+
}
|
|
2474
|
+
|
|
2475
|
+
// src/utils/downloadWithRetry.ts
|
|
2476
|
+
var downloadWithRetry = async (callbackFn, abortStatuses = [404]) => {
|
|
2477
|
+
return await pRetry(callbackFn, {
|
|
2478
|
+
retries: 3,
|
|
2479
|
+
shouldRetry: ({ error }) => {
|
|
2480
|
+
if (globalAxios2.isAxiosError(error) && abortStatuses.includes(error.response?.status ?? 0)) {
|
|
2481
|
+
return false;
|
|
2482
|
+
}
|
|
2483
|
+
return true;
|
|
2484
|
+
}
|
|
2485
|
+
});
|
|
2486
|
+
};
|
|
2487
|
+
|
|
1376
2488
|
// src/platform-sdk.ts
|
|
1377
2489
|
var validationErrorSchema = z__default.default.object({
|
|
1378
2490
|
detail: z__default.default.array(
|
|
@@ -1405,6 +2517,24 @@ function handleRequestError(error) {
|
|
|
1405
2517
|
statusCode: 404
|
|
1406
2518
|
});
|
|
1407
2519
|
}
|
|
2520
|
+
case 403: {
|
|
2521
|
+
throw new APIError(`Access forbidden: ${error.message}`, {
|
|
2522
|
+
context: {
|
|
2523
|
+
responseBody: errorResponseSchema.parse(error.response?.data)
|
|
2524
|
+
},
|
|
2525
|
+
originalError: error,
|
|
2526
|
+
statusCode: 403
|
|
2527
|
+
});
|
|
2528
|
+
}
|
|
2529
|
+
case 410: {
|
|
2530
|
+
throw new APIError(`Resource gone: ${error.message}`, {
|
|
2531
|
+
context: {
|
|
2532
|
+
responseBody: errorResponseSchema.parse(error.response?.data)
|
|
2533
|
+
},
|
|
2534
|
+
originalError: error,
|
|
2535
|
+
statusCode: 410
|
|
2536
|
+
});
|
|
2537
|
+
}
|
|
1408
2538
|
default: {
|
|
1409
2539
|
throw new APIError(`API request failed: ${error.message}`, {
|
|
1410
2540
|
context: {
|
|
@@ -1863,6 +2993,58 @@ var PlatformSDKHttp = class {
|
|
|
1863
2993
|
getConfig() {
|
|
1864
2994
|
return { ...this.#config };
|
|
1865
2995
|
}
|
|
2996
|
+
/**
|
|
2997
|
+
* Download an artifact file from a completed application run
|
|
2998
|
+
*
|
|
2999
|
+
* This method retrieves the binary content of a specific artifact produced
|
|
3000
|
+
* during an application run. Artifacts can include generated reports, processed
|
|
3001
|
+
* images, or other output files from the AI model execution.
|
|
3002
|
+
*
|
|
3003
|
+
* The download is performed with automatic retries for transient failures.
|
|
3004
|
+
* Non-retryable HTTP status codes (403, 404, 410, 422) will abort immediately.
|
|
3005
|
+
*
|
|
3006
|
+
* @param runId - The unique identifier of the application run
|
|
3007
|
+
* @param artifactId - The unique identifier of the artifact to download
|
|
3008
|
+
* @returns A promise that resolves to an ArrayBuffer containing the artifact's binary content
|
|
3009
|
+
* @throws {AuthenticationError} If no valid authentication token is available
|
|
3010
|
+
* @throws {APIError} If the API request fails (e.g., 403, 404, 410, 422, or other HTTP errors)
|
|
3011
|
+
* @throws {UnexpectedError} If a non-HTTP error occurs
|
|
3012
|
+
*
|
|
3013
|
+
* @example
|
|
3014
|
+
* ```typescript
|
|
3015
|
+
* const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
|
|
3016
|
+
*
|
|
3017
|
+
* try {
|
|
3018
|
+
* const buffer = await sdk.downloadArtifact('run-123', 'artifact-456');
|
|
3019
|
+
* console.log(`Downloaded ${buffer.byteLength} bytes`);
|
|
3020
|
+
*
|
|
3021
|
+
* // Write to file (Node.js)
|
|
3022
|
+
* fs.writeFileSync('output.bin', Buffer.from(buffer));
|
|
3023
|
+
* } catch (error) {
|
|
3024
|
+
* console.error('Failed to download artifact:', error.message);
|
|
3025
|
+
* }
|
|
3026
|
+
* ```
|
|
3027
|
+
*/
|
|
3028
|
+
async downloadArtifact(runId, artifactId) {
|
|
3029
|
+
const client = await this.#getClient();
|
|
3030
|
+
try {
|
|
3031
|
+
const response = await downloadWithRetry(
|
|
3032
|
+
() => client.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(
|
|
3033
|
+
{
|
|
3034
|
+
runId,
|
|
3035
|
+
artifactId
|
|
3036
|
+
},
|
|
3037
|
+
{
|
|
3038
|
+
responseType: "arraybuffer"
|
|
3039
|
+
}
|
|
3040
|
+
),
|
|
3041
|
+
[403, 404, 410, 422]
|
|
3042
|
+
);
|
|
3043
|
+
return response.data;
|
|
3044
|
+
} catch (error) {
|
|
3045
|
+
handleRequestError(error);
|
|
3046
|
+
}
|
|
3047
|
+
}
|
|
1866
3048
|
};
|
|
1867
3049
|
|
|
1868
3050
|
// src/index.ts
|
|
@@ -1876,6 +3058,7 @@ exports.AuthenticationError = AuthenticationError;
|
|
|
1876
3058
|
exports.BaseError = BaseError;
|
|
1877
3059
|
exports.Configuration = Configuration;
|
|
1878
3060
|
exports.ConfigurationError = ConfigurationError;
|
|
3061
|
+
exports.GrantRelation = GrantRelation;
|
|
1879
3062
|
exports.ItemOutput = ItemOutput;
|
|
1880
3063
|
exports.ItemState = ItemState;
|
|
1881
3064
|
exports.ItemTerminationReason = ItemTerminationReason;
|
|
@@ -1886,9 +3069,12 @@ exports.PublicApi = PublicApi;
|
|
|
1886
3069
|
exports.PublicApiAxiosParamCreator = PublicApiAxiosParamCreator;
|
|
1887
3070
|
exports.PublicApiFactory = PublicApiFactory;
|
|
1888
3071
|
exports.PublicApiFp = PublicApiFp;
|
|
3072
|
+
exports.ResourceType = ResourceType;
|
|
1889
3073
|
exports.RunOutput = RunOutput;
|
|
1890
3074
|
exports.RunState = RunState;
|
|
1891
3075
|
exports.RunTerminationReason = RunTerminationReason;
|
|
3076
|
+
exports.SubjectType = SubjectType;
|
|
3077
|
+
exports.VersionDocumentVisibility = VersionDocumentVisibility;
|
|
1892
3078
|
exports.canDownloadItem = canDownloadItem;
|
|
1893
3079
|
exports.canDownloadRunItems = canDownloadRunItems;
|
|
1894
3080
|
exports.default = index_default;
|