@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/index.js CHANGED
@@ -94,6 +94,11 @@ var ArtifactTerminationReason = {
94
94
  SystemError: "SYSTEM_ERROR",
95
95
  Skipped: "SKIPPED"
96
96
  };
97
+ var GrantRelation = {
98
+ Owner: "owner",
99
+ Editor: "editor",
100
+ Viewer: "viewer"
101
+ };
97
102
  var ItemOutput = {
98
103
  None: "NONE",
99
104
  Full: "FULL"
@@ -117,6 +122,12 @@ var OutputArtifactVisibility = {
117
122
  Internal: "INTERNAL",
118
123
  External: "EXTERNAL"
119
124
  };
125
+ var ResourceType = {
126
+ Run: "run",
127
+ Item: "item",
128
+ OutputArtifact: "output_artifact",
129
+ ShareToken: "share_token"
130
+ };
120
131
  var RunOutput = {
121
132
  None: "NONE",
122
133
  Partial: "PARTIAL",
@@ -132,6 +143,16 @@ var RunTerminationReason = {
132
143
  CanceledBySystem: "CANCELED_BY_SYSTEM",
133
144
  CanceledByUser: "CANCELED_BY_USER"
134
145
  };
146
+ var SubjectType = {
147
+ User: "user",
148
+ OrganizationAdmin: "organization_admin",
149
+ OrganizationUser: "organization_user",
150
+ ShareToken: "share_token"
151
+ };
152
+ var VersionDocumentVisibility = {
153
+ Public: "public",
154
+ Internal: "internal"
155
+ };
135
156
  var PublicApiAxiosParamCreator = function(configuration) {
136
157
  return {
137
158
  /**
@@ -190,6 +211,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
190
211
  options: localVarRequestOptions
191
212
  };
192
213
  },
214
+ /**
215
+ * Create a grant to share access to a resource with a subject (user or organization).
216
+ * @summary Create Grant
217
+ * @param {GrantCreateRequest} grantCreateRequest
218
+ * @param {*} [options] Override http request option.
219
+ * @throws {RequiredError}
220
+ */
221
+ createGrantV1AccessGrantsPost: async (grantCreateRequest, options = {}) => {
222
+ assertParamExists("createGrantV1AccessGrantsPost", "grantCreateRequest", grantCreateRequest);
223
+ const localVarPath = `/v1/access/grants`;
224
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
225
+ let baseOptions;
226
+ if (configuration) {
227
+ baseOptions = configuration.baseOptions;
228
+ }
229
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
230
+ const localVarHeaderParameter = {};
231
+ const localVarQueryParameter = {};
232
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
233
+ localVarHeaderParameter["Content-Type"] = "application/json";
234
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
235
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
236
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
237
+ localVarRequestOptions.data = serializeDataIfNeeded(grantCreateRequest, localVarRequestOptions, configuration);
238
+ return {
239
+ url: toPathString(localVarUrlObj),
240
+ options: localVarRequestOptions
241
+ };
242
+ },
193
243
  /**
194
244
  * 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
195
245
  * @summary Initiate Run
@@ -219,6 +269,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
219
269
  options: localVarRequestOptions
220
270
  };
221
271
  },
272
+ /**
273
+ * 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.
274
+ * @summary Create Share Token
275
+ * @param {ShareTokenCreateRequest} shareTokenCreateRequest
276
+ * @param {*} [options] Override http request option.
277
+ * @throws {RequiredError}
278
+ */
279
+ createShareTokenV1AccessShareTokensPost: async (shareTokenCreateRequest, options = {}) => {
280
+ assertParamExists("createShareTokenV1AccessShareTokensPost", "shareTokenCreateRequest", shareTokenCreateRequest);
281
+ const localVarPath = `/v1/access/share-tokens`;
282
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
283
+ let baseOptions;
284
+ if (configuration) {
285
+ baseOptions = configuration.baseOptions;
286
+ }
287
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
288
+ const localVarHeaderParameter = {};
289
+ const localVarQueryParameter = {};
290
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
291
+ localVarHeaderParameter["Content-Type"] = "application/json";
292
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
293
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
294
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
295
+ localVarRequestOptions.data = serializeDataIfNeeded(shareTokenCreateRequest, localVarRequestOptions, configuration);
296
+ return {
297
+ url: toPathString(localVarUrlObj),
298
+ options: localVarRequestOptions
299
+ };
300
+ },
222
301
  /**
223
302
  * 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.
224
303
  * @summary Delete Run Items
@@ -251,10 +330,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
251
330
  * @summary Get Artifact Url
252
331
  * @param {string} runId Run id, returned by `POST /runs/` endpoint
253
332
  * @param {string} artifactId The artifact id to download
333
+ * @param {string | null} [shareToken] Share token for accessing shared runs
254
334
  * @param {*} [options] Override http request option.
255
335
  * @throws {RequiredError}
256
336
  */
257
- getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, options = {}) => {
337
+ getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, shareToken, options = {}) => {
258
338
  assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "runId", runId);
259
339
  assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "artifactId", artifactId);
260
340
  const localVarPath = `/v1/runs/{run_id}/artifacts/{artifact_id}/file`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"artifact_id"}}`, encodeURIComponent(String(artifactId)));
@@ -267,6 +347,36 @@ var PublicApiAxiosParamCreator = function(configuration) {
267
347
  const localVarHeaderParameter = {};
268
348
  const localVarQueryParameter = {};
269
349
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
350
+ if (shareToken !== void 0) {
351
+ localVarQueryParameter["share_token"] = shareToken;
352
+ }
353
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
354
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
355
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
356
+ return {
357
+ url: toPathString(localVarUrlObj),
358
+ options: localVarRequestOptions
359
+ };
360
+ },
361
+ /**
362
+ * Get a grant by its ID.
363
+ * @summary Get Grant
364
+ * @param {string} grantId Grant ID
365
+ * @param {*} [options] Override http request option.
366
+ * @throws {RequiredError}
367
+ */
368
+ getGrantV1AccessGrantsGrantIdGet: async (grantId, options = {}) => {
369
+ assertParamExists("getGrantV1AccessGrantsGrantIdGet", "grantId", grantId);
370
+ const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
371
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
372
+ let baseOptions;
373
+ if (configuration) {
374
+ baseOptions = configuration.baseOptions;
375
+ }
376
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
377
+ const localVarHeaderParameter = {};
378
+ const localVarQueryParameter = {};
379
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
270
380
  setSearchParams(localVarUrlObj, localVarQueryParameter);
271
381
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
272
382
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -280,10 +390,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
280
390
  * @summary Get Item By Run
281
391
  * @param {string} runId The run id, returned by `POST /runs/` endpoint
282
392
  * @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
393
+ * @param {string | null} [shareToken] Share token for accessing shared runs
283
394
  * @param {*} [options] Override http request option.
284
395
  * @throws {RequiredError}
285
396
  */
286
- getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, options = {}) => {
397
+ getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, shareToken, options = {}) => {
287
398
  assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "runId", runId);
288
399
  assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "externalId", externalId);
289
400
  const localVarPath = `/v1/runs/{run_id}/items/{external_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
@@ -296,6 +407,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
296
407
  const localVarHeaderParameter = {};
297
408
  const localVarQueryParameter = {};
298
409
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
410
+ if (shareToken !== void 0) {
411
+ localVarQueryParameter["share_token"] = shareToken;
412
+ }
299
413
  setSearchParams(localVarUrlObj, localVarQueryParameter);
300
414
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
301
415
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -330,13 +444,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
330
444
  };
331
445
  },
332
446
  /**
333
- * 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.
447
+ * 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.
334
448
  * @summary Get run details
335
449
  * @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
450
+ * @param {string | null} [shareToken] Share token for accessing shared runs
336
451
  * @param {*} [options] Override http request option.
337
452
  * @throws {RequiredError}
338
453
  */
339
- getRunV1RunsRunIdGet: async (runId, options = {}) => {
454
+ getRunV1RunsRunIdGet: async (runId, shareToken, options = {}) => {
340
455
  assertParamExists("getRunV1RunsRunIdGet", "runId", runId);
341
456
  const localVarPath = `/v1/runs/{run_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
342
457
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -348,6 +463,129 @@ var PublicApiAxiosParamCreator = function(configuration) {
348
463
  const localVarHeaderParameter = {};
349
464
  const localVarQueryParameter = {};
350
465
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
466
+ if (shareToken !== void 0) {
467
+ localVarQueryParameter["share_token"] = shareToken;
468
+ }
469
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
470
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
471
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
472
+ return {
473
+ url: toPathString(localVarUrlObj),
474
+ options: localVarRequestOptions
475
+ };
476
+ },
477
+ /**
478
+ * Get a share token by its ID.
479
+ * @summary Get Share Token
480
+ * @param {string} shareTokenId Share token ID
481
+ * @param {*} [options] Override http request option.
482
+ * @throws {RequiredError}
483
+ */
484
+ getShareTokenV1AccessShareTokensShareTokenIdGet: async (shareTokenId, options = {}) => {
485
+ assertParamExists("getShareTokenV1AccessShareTokensShareTokenIdGet", "shareTokenId", shareTokenId);
486
+ const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
487
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
488
+ let baseOptions;
489
+ if (configuration) {
490
+ baseOptions = configuration.baseOptions;
491
+ }
492
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
493
+ const localVarHeaderParameter = {};
494
+ const localVarQueryParameter = {};
495
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
496
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
497
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
498
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
499
+ return {
500
+ url: toPathString(localVarUrlObj),
501
+ options: localVarRequestOptions
502
+ };
503
+ },
504
+ /**
505
+ * Return metadata for a single public document attached to an application version.
506
+ * @summary Get version document metadata
507
+ * @param {string} applicationId
508
+ * @param {string} version
509
+ * @param {string} name
510
+ * @param {*} [options] Override http request option.
511
+ * @throws {RequiredError}
512
+ */
513
+ getVersionDocument: async (applicationId, version, name, options = {}) => {
514
+ assertParamExists("getVersionDocument", "applicationId", applicationId);
515
+ assertParamExists("getVersionDocument", "version", version);
516
+ assertParamExists("getVersionDocument", "name", name);
517
+ 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)));
518
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
519
+ let baseOptions;
520
+ if (configuration) {
521
+ baseOptions = configuration.baseOptions;
522
+ }
523
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
524
+ const localVarHeaderParameter = {};
525
+ const localVarQueryParameter = {};
526
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
527
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
528
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
529
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
530
+ return {
531
+ url: toPathString(localVarUrlObj),
532
+ options: localVarRequestOptions
533
+ };
534
+ },
535
+ /**
536
+ * 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``.
537
+ * @summary Stream version document content (programmatic)
538
+ * @param {string} applicationId
539
+ * @param {string} version
540
+ * @param {string} name
541
+ * @param {*} [options] Override http request option.
542
+ * @throws {RequiredError}
543
+ */
544
+ getVersionDocumentContent: async (applicationId, version, name, options = {}) => {
545
+ assertParamExists("getVersionDocumentContent", "applicationId", applicationId);
546
+ assertParamExists("getVersionDocumentContent", "version", version);
547
+ assertParamExists("getVersionDocumentContent", "name", name);
548
+ 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)));
549
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
550
+ let baseOptions;
551
+ if (configuration) {
552
+ baseOptions = configuration.baseOptions;
553
+ }
554
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
555
+ const localVarHeaderParameter = {};
556
+ const localVarQueryParameter = {};
557
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
558
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
559
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
560
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
561
+ return {
562
+ url: toPathString(localVarUrlObj),
563
+ options: localVarRequestOptions
564
+ };
565
+ },
566
+ /**
567
+ * 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``.
568
+ * @summary Download version document (browser)
569
+ * @param {string} applicationId
570
+ * @param {string} version
571
+ * @param {string} name
572
+ * @param {*} [options] Override http request option.
573
+ * @throws {RequiredError}
574
+ */
575
+ getVersionDocumentFile: async (applicationId, version, name, options = {}) => {
576
+ assertParamExists("getVersionDocumentFile", "applicationId", applicationId);
577
+ assertParamExists("getVersionDocumentFile", "version", version);
578
+ assertParamExists("getVersionDocumentFile", "name", name);
579
+ 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)));
580
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
581
+ let baseOptions;
582
+ if (configuration) {
583
+ baseOptions = configuration.baseOptions;
584
+ }
585
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
586
+ const localVarHeaderParameter = {};
587
+ const localVarQueryParameter = {};
588
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
351
589
  setSearchParams(localVarUrlObj, localVarQueryParameter);
352
590
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
353
591
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -393,10 +631,68 @@ var PublicApiAxiosParamCreator = function(configuration) {
393
631
  options: localVarRequestOptions
394
632
  };
395
633
  },
634
+ /**
635
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
636
+ * @summary List Grants
637
+ * @param {ResourceType | null} [resourceType]
638
+ * @param {string | null} [resourceId]
639
+ * @param {SubjectType | null} [subjectType]
640
+ * @param {string | null} [subjectId]
641
+ * @param {boolean | null} [revoked]
642
+ * @param {number} [page]
643
+ * @param {number} [pageSize]
644
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
645
+ * @param {*} [options] Override http request option.
646
+ * @throws {RequiredError}
647
+ */
648
+ listGrantsV1AccessGrantsGet: async (resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options = {}) => {
649
+ const localVarPath = `/v1/access/grants`;
650
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
651
+ let baseOptions;
652
+ if (configuration) {
653
+ baseOptions = configuration.baseOptions;
654
+ }
655
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
656
+ const localVarHeaderParameter = {};
657
+ const localVarQueryParameter = {};
658
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
659
+ if (resourceType !== void 0) {
660
+ localVarQueryParameter["resource_type"] = resourceType;
661
+ }
662
+ if (resourceId !== void 0) {
663
+ localVarQueryParameter["resource_id"] = resourceId;
664
+ }
665
+ if (subjectType !== void 0) {
666
+ localVarQueryParameter["subject_type"] = subjectType;
667
+ }
668
+ if (subjectId !== void 0) {
669
+ localVarQueryParameter["subject_id"] = subjectId;
670
+ }
671
+ if (revoked !== void 0) {
672
+ localVarQueryParameter["revoked"] = revoked;
673
+ }
674
+ if (page !== void 0) {
675
+ localVarQueryParameter["page"] = page;
676
+ }
677
+ if (pageSize !== void 0) {
678
+ localVarQueryParameter["page_size"] = pageSize;
679
+ }
680
+ if (sort) {
681
+ localVarQueryParameter["sort"] = sort;
682
+ }
683
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
684
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
685
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
686
+ return {
687
+ url: toPathString(localVarUrlObj),
688
+ options: localVarRequestOptions
689
+ };
690
+ },
396
691
  /**
397
692
  * 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
398
693
  * @summary List Run Items
399
694
  * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
695
+ * @param {string | null} [shareToken] Share token for accessing shared runs
400
696
  * @param {Array<string> | null} [itemIdIn] Filter for item ids
401
697
  * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
402
698
  * @param {ItemState | null} [state] Filter items by their state
@@ -408,7 +704,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
408
704
  * @param {*} [options] Override http request option.
409
705
  * @throws {RequiredError}
410
706
  */
411
- listRunItemsV1RunsRunIdItemsGet: async (runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
707
+ listRunItemsV1RunsRunIdItemsGet: async (runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
412
708
  assertParamExists("listRunItemsV1RunsRunIdItemsGet", "runId", runId);
413
709
  const localVarPath = `/v1/runs/{run_id}/items`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
414
710
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -420,6 +716,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
420
716
  const localVarHeaderParameter = {};
421
717
  const localVarQueryParameter = {};
422
718
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
719
+ if (shareToken !== void 0) {
720
+ localVarQueryParameter["share_token"] = shareToken;
721
+ }
423
722
  if (itemIdIn) {
424
723
  localVarQueryParameter["item_id__in"] = itemIdIn;
425
724
  }
@@ -509,6 +808,84 @@ var PublicApiAxiosParamCreator = function(configuration) {
509
808
  options: localVarRequestOptions
510
809
  };
511
810
  },
811
+ /**
812
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
813
+ * @summary List Share Tokens
814
+ * @param {string | null} [runId] Filter by run ID
815
+ * @param {string | null} [createdBy] Filter by share token creator
816
+ * @param {boolean | null} [revoked]
817
+ * @param {number} [page]
818
+ * @param {number} [pageSize]
819
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
820
+ * @param {*} [options] Override http request option.
821
+ * @throws {RequiredError}
822
+ */
823
+ listShareTokensV1AccessShareTokensGet: async (runId, createdBy, revoked, page, pageSize, sort, options = {}) => {
824
+ const localVarPath = `/v1/access/share-tokens`;
825
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
826
+ let baseOptions;
827
+ if (configuration) {
828
+ baseOptions = configuration.baseOptions;
829
+ }
830
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
831
+ const localVarHeaderParameter = {};
832
+ const localVarQueryParameter = {};
833
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
834
+ if (runId !== void 0) {
835
+ localVarQueryParameter["run_id"] = runId;
836
+ }
837
+ if (createdBy !== void 0) {
838
+ localVarQueryParameter["created_by"] = createdBy;
839
+ }
840
+ if (revoked !== void 0) {
841
+ localVarQueryParameter["revoked"] = revoked;
842
+ }
843
+ if (page !== void 0) {
844
+ localVarQueryParameter["page"] = page;
845
+ }
846
+ if (pageSize !== void 0) {
847
+ localVarQueryParameter["page_size"] = pageSize;
848
+ }
849
+ if (sort) {
850
+ localVarQueryParameter["sort"] = sort;
851
+ }
852
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
853
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
854
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
855
+ return {
856
+ url: toPathString(localVarUrlObj),
857
+ options: localVarRequestOptions
858
+ };
859
+ },
860
+ /**
861
+ * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
862
+ * @summary List version documents
863
+ * @param {string} applicationId
864
+ * @param {string} version
865
+ * @param {*} [options] Override http request option.
866
+ * @throws {RequiredError}
867
+ */
868
+ listVersionDocuments: async (applicationId, version, options = {}) => {
869
+ assertParamExists("listVersionDocuments", "applicationId", applicationId);
870
+ assertParamExists("listVersionDocuments", "version", version);
871
+ const localVarPath = `/v1/applications/{application_id}/versions/{version}/documents`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version)));
872
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
873
+ let baseOptions;
874
+ if (configuration) {
875
+ baseOptions = configuration.baseOptions;
876
+ }
877
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
878
+ const localVarHeaderParameter = {};
879
+ const localVarQueryParameter = {};
880
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
881
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
882
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
883
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
884
+ return {
885
+ url: toPathString(localVarUrlObj),
886
+ options: localVarRequestOptions
887
+ };
888
+ },
512
889
  /**
513
890
  * 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`.
514
891
  * @summary Put Item Custom Metadata By Run
@@ -599,6 +976,60 @@ var PublicApiAxiosParamCreator = function(configuration) {
599
976
  url: toPathString(localVarUrlObj),
600
977
  options: localVarRequestOptions
601
978
  };
979
+ },
980
+ /**
981
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
982
+ * @summary Revoke Grant
983
+ * @param {string} grantId Grant ID
984
+ * @param {*} [options] Override http request option.
985
+ * @throws {RequiredError}
986
+ */
987
+ revokeGrantV1AccessGrantsGrantIdDelete: async (grantId, options = {}) => {
988
+ assertParamExists("revokeGrantV1AccessGrantsGrantIdDelete", "grantId", grantId);
989
+ const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
990
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
991
+ let baseOptions;
992
+ if (configuration) {
993
+ baseOptions = configuration.baseOptions;
994
+ }
995
+ const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
996
+ const localVarHeaderParameter = {};
997
+ const localVarQueryParameter = {};
998
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
999
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1000
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1001
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1002
+ return {
1003
+ url: toPathString(localVarUrlObj),
1004
+ options: localVarRequestOptions
1005
+ };
1006
+ },
1007
+ /**
1008
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1009
+ * @summary Revoke Share Token
1010
+ * @param {string} shareTokenId Share token ID
1011
+ * @param {*} [options] Override http request option.
1012
+ * @throws {RequiredError}
1013
+ */
1014
+ revokeShareTokenV1AccessShareTokensShareTokenIdDelete: async (shareTokenId, options = {}) => {
1015
+ assertParamExists("revokeShareTokenV1AccessShareTokensShareTokenIdDelete", "shareTokenId", shareTokenId);
1016
+ const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
1017
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1018
+ let baseOptions;
1019
+ if (configuration) {
1020
+ baseOptions = configuration.baseOptions;
1021
+ }
1022
+ const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
1023
+ const localVarHeaderParameter = {};
1024
+ const localVarQueryParameter = {};
1025
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
1026
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1027
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1028
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1029
+ return {
1030
+ url: toPathString(localVarUrlObj),
1031
+ options: localVarRequestOptions
1032
+ };
602
1033
  }
603
1034
  };
604
1035
  };
@@ -632,6 +1063,19 @@ var PublicApiFp = function(configuration) {
632
1063
  const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelRunV1RunsRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
633
1064
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
634
1065
  },
1066
+ /**
1067
+ * Create a grant to share access to a resource with a subject (user or organization).
1068
+ * @summary Create Grant
1069
+ * @param {GrantCreateRequest} grantCreateRequest
1070
+ * @param {*} [options] Override http request option.
1071
+ * @throws {RequiredError}
1072
+ */
1073
+ async createGrantV1AccessGrantsPost(grantCreateRequest, options) {
1074
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createGrantV1AccessGrantsPost(grantCreateRequest, options);
1075
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1076
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.createGrantV1AccessGrantsPost"]?.[localVarOperationServerIndex]?.url;
1077
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1078
+ },
635
1079
  /**
636
1080
  * 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
637
1081
  * @summary Initiate Run
@@ -645,6 +1089,19 @@ var PublicApiFp = function(configuration) {
645
1089
  const localVarOperationServerBasePath = operationServerMap["PublicApi.createRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
646
1090
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
647
1091
  },
1092
+ /**
1093
+ * 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.
1094
+ * @summary Create Share Token
1095
+ * @param {ShareTokenCreateRequest} shareTokenCreateRequest
1096
+ * @param {*} [options] Override http request option.
1097
+ * @throws {RequiredError}
1098
+ */
1099
+ async createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options) {
1100
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options);
1101
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1102
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.createShareTokenV1AccessShareTokensPost"]?.[localVarOperationServerIndex]?.url;
1103
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1104
+ },
648
1105
  /**
649
1106
  * 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.
650
1107
  * @summary Delete Run Items
@@ -663,25 +1120,40 @@ var PublicApiFp = function(configuration) {
663
1120
  * @summary Get Artifact Url
664
1121
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
665
1122
  * @param {string} artifactId The artifact id to download
1123
+ * @param {string | null} [shareToken] Share token for accessing shared runs
666
1124
  * @param {*} [options] Override http request option.
667
1125
  * @throws {RequiredError}
668
1126
  */
669
- async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options) {
670
- const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options);
1127
+ async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options) {
1128
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options);
671
1129
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
672
1130
  const localVarOperationServerBasePath = operationServerMap["PublicApi.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet"]?.[localVarOperationServerIndex]?.url;
673
1131
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
674
1132
  },
1133
+ /**
1134
+ * Get a grant by its ID.
1135
+ * @summary Get Grant
1136
+ * @param {string} grantId Grant ID
1137
+ * @param {*} [options] Override http request option.
1138
+ * @throws {RequiredError}
1139
+ */
1140
+ async getGrantV1AccessGrantsGrantIdGet(grantId, options) {
1141
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGrantV1AccessGrantsGrantIdGet(grantId, options);
1142
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1143
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getGrantV1AccessGrantsGrantIdGet"]?.[localVarOperationServerIndex]?.url;
1144
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1145
+ },
675
1146
  /**
676
1147
  * Retrieve details of a specific item (slide) by its external ID and the run ID.
677
1148
  * @summary Get Item By Run
678
1149
  * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
679
1150
  * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1151
+ * @param {string | null} [shareToken] Share token for accessing shared runs
680
1152
  * @param {*} [options] Override http request option.
681
1153
  * @throws {RequiredError}
682
1154
  */
683
- async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options) {
684
- const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options);
1155
+ async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options) {
1156
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options);
685
1157
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
686
1158
  const localVarOperationServerBasePath = operationServerMap["PublicApi.getItemByRunV1RunsRunIdItemsExternalIdGet"]?.[localVarOperationServerIndex]?.url;
687
1159
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -699,18 +1171,77 @@ var PublicApiFp = function(configuration) {
699
1171
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
700
1172
  },
701
1173
  /**
702
- * 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.
1174
+ * 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.
703
1175
  * @summary Get run details
704
1176
  * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1177
+ * @param {string | null} [shareToken] Share token for accessing shared runs
705
1178
  * @param {*} [options] Override http request option.
706
1179
  * @throws {RequiredError}
707
1180
  */
708
- async getRunV1RunsRunIdGet(runId, options) {
709
- const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, options);
1181
+ async getRunV1RunsRunIdGet(runId, shareToken, options) {
1182
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, shareToken, options);
710
1183
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
711
1184
  const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsRunIdGet"]?.[localVarOperationServerIndex]?.url;
712
1185
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
713
1186
  },
1187
+ /**
1188
+ * Get a share token by its ID.
1189
+ * @summary Get Share Token
1190
+ * @param {string} shareTokenId Share token ID
1191
+ * @param {*} [options] Override http request option.
1192
+ * @throws {RequiredError}
1193
+ */
1194
+ async getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options) {
1195
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options);
1196
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1197
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getShareTokenV1AccessShareTokensShareTokenIdGet"]?.[localVarOperationServerIndex]?.url;
1198
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1199
+ },
1200
+ /**
1201
+ * Return metadata for a single public document attached to an application version.
1202
+ * @summary Get version document metadata
1203
+ * @param {string} applicationId
1204
+ * @param {string} version
1205
+ * @param {string} name
1206
+ * @param {*} [options] Override http request option.
1207
+ * @throws {RequiredError}
1208
+ */
1209
+ async getVersionDocument(applicationId, version, name, options) {
1210
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVersionDocument(applicationId, version, name, options);
1211
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1212
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getVersionDocument"]?.[localVarOperationServerIndex]?.url;
1213
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1214
+ },
1215
+ /**
1216
+ * 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``.
1217
+ * @summary Stream version document content (programmatic)
1218
+ * @param {string} applicationId
1219
+ * @param {string} version
1220
+ * @param {string} name
1221
+ * @param {*} [options] Override http request option.
1222
+ * @throws {RequiredError}
1223
+ */
1224
+ async getVersionDocumentContent(applicationId, version, name, options) {
1225
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVersionDocumentContent(applicationId, version, name, options);
1226
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1227
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getVersionDocumentContent"]?.[localVarOperationServerIndex]?.url;
1228
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1229
+ },
1230
+ /**
1231
+ * 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``.
1232
+ * @summary Download version document (browser)
1233
+ * @param {string} applicationId
1234
+ * @param {string} version
1235
+ * @param {string} name
1236
+ * @param {*} [options] Override http request option.
1237
+ * @throws {RequiredError}
1238
+ */
1239
+ async getVersionDocumentFile(applicationId, version, name, options) {
1240
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVersionDocumentFile(applicationId, version, name, options);
1241
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1242
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getVersionDocumentFile"]?.[localVarOperationServerIndex]?.url;
1243
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1244
+ },
714
1245
  /**
715
1246
  * 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.
716
1247
  * @summary List available applications
@@ -723,13 +1254,34 @@ var PublicApiFp = function(configuration) {
723
1254
  async listApplicationsV1ApplicationsGet(page, pageSize, sort, options) {
724
1255
  const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationsV1ApplicationsGet(page, pageSize, sort, options);
725
1256
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
726
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
1257
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
1258
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1259
+ },
1260
+ /**
1261
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1262
+ * @summary List Grants
1263
+ * @param {ResourceType | null} [resourceType]
1264
+ * @param {string | null} [resourceId]
1265
+ * @param {SubjectType | null} [subjectType]
1266
+ * @param {string | null} [subjectId]
1267
+ * @param {boolean | null} [revoked]
1268
+ * @param {number} [page]
1269
+ * @param {number} [pageSize]
1270
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
1271
+ * @param {*} [options] Override http request option.
1272
+ * @throws {RequiredError}
1273
+ */
1274
+ async listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options) {
1275
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options);
1276
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1277
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listGrantsV1AccessGrantsGet"]?.[localVarOperationServerIndex]?.url;
727
1278
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
728
1279
  },
729
1280
  /**
730
1281
  * 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
731
1282
  * @summary List Run Items
732
1283
  * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1284
+ * @param {string | null} [shareToken] Share token for accessing shared runs
733
1285
  * @param {Array<string> | null} [itemIdIn] Filter for item ids
734
1286
  * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
735
1287
  * @param {ItemState | null} [state] Filter items by their state
@@ -741,8 +1293,8 @@ var PublicApiFp = function(configuration) {
741
1293
  * @param {*} [options] Override http request option.
742
1294
  * @throws {RequiredError}
743
1295
  */
744
- async listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
745
- const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
1296
+ async listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
1297
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
746
1298
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
747
1299
  const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunItemsV1RunsRunIdItemsGet"]?.[localVarOperationServerIndex]?.url;
748
1300
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -767,6 +1319,38 @@ var PublicApiFp = function(configuration) {
767
1319
  const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
768
1320
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
769
1321
  },
1322
+ /**
1323
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1324
+ * @summary List Share Tokens
1325
+ * @param {string | null} [runId] Filter by run ID
1326
+ * @param {string | null} [createdBy] Filter by share token creator
1327
+ * @param {boolean | null} [revoked]
1328
+ * @param {number} [page]
1329
+ * @param {number} [pageSize]
1330
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
1331
+ * @param {*} [options] Override http request option.
1332
+ * @throws {RequiredError}
1333
+ */
1334
+ async listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options) {
1335
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options);
1336
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1337
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listShareTokensV1AccessShareTokensGet"]?.[localVarOperationServerIndex]?.url;
1338
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1339
+ },
1340
+ /**
1341
+ * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
1342
+ * @summary List version documents
1343
+ * @param {string} applicationId
1344
+ * @param {string} version
1345
+ * @param {*} [options] Override http request option.
1346
+ * @throws {RequiredError}
1347
+ */
1348
+ async listVersionDocuments(applicationId, version, options) {
1349
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listVersionDocuments(applicationId, version, options);
1350
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1351
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listVersionDocuments"]?.[localVarOperationServerIndex]?.url;
1352
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1353
+ },
770
1354
  /**
771
1355
  * 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`.
772
1356
  * @summary Put Item Custom Metadata By Run
@@ -808,6 +1392,32 @@ var PublicApiFp = function(configuration) {
808
1392
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
809
1393
  const localVarOperationServerBasePath = operationServerMap["PublicApi.readApplicationByIdV1ApplicationsApplicationIdGet"]?.[localVarOperationServerIndex]?.url;
810
1394
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1395
+ },
1396
+ /**
1397
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1398
+ * @summary Revoke Grant
1399
+ * @param {string} grantId Grant ID
1400
+ * @param {*} [options] Override http request option.
1401
+ * @throws {RequiredError}
1402
+ */
1403
+ async revokeGrantV1AccessGrantsGrantIdDelete(grantId, options) {
1404
+ const localVarAxiosArgs = await localVarAxiosParamCreator.revokeGrantV1AccessGrantsGrantIdDelete(grantId, options);
1405
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1406
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeGrantV1AccessGrantsGrantIdDelete"]?.[localVarOperationServerIndex]?.url;
1407
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1408
+ },
1409
+ /**
1410
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1411
+ * @summary Revoke Share Token
1412
+ * @param {string} shareTokenId Share token ID
1413
+ * @param {*} [options] Override http request option.
1414
+ * @throws {RequiredError}
1415
+ */
1416
+ async revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options) {
1417
+ const localVarAxiosArgs = await localVarAxiosParamCreator.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options);
1418
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1419
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeShareTokenV1AccessShareTokensShareTokenIdDelete"]?.[localVarOperationServerIndex]?.url;
1420
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
811
1421
  }
812
1422
  };
813
1423
  };
@@ -834,6 +1444,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
834
1444
  cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
835
1445
  return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
836
1446
  },
1447
+ /**
1448
+ * Create a grant to share access to a resource with a subject (user or organization).
1449
+ * @summary Create Grant
1450
+ * @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
1451
+ * @param {*} [options] Override http request option.
1452
+ * @throws {RequiredError}
1453
+ */
1454
+ createGrantV1AccessGrantsPost(requestParameters, options) {
1455
+ return localVarFp.createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(axios, basePath));
1456
+ },
837
1457
  /**
838
1458
  * 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
839
1459
  * @summary Initiate Run
@@ -844,6 +1464,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
844
1464
  createRunV1RunsPost(requestParameters, options) {
845
1465
  return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
846
1466
  },
1467
+ /**
1468
+ * 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.
1469
+ * @summary Create Share Token
1470
+ * @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
1471
+ * @param {*} [options] Override http request option.
1472
+ * @throws {RequiredError}
1473
+ */
1474
+ createShareTokenV1AccessShareTokensPost(requestParameters, options) {
1475
+ return localVarFp.createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(axios, basePath));
1476
+ },
847
1477
  /**
848
1478
  * 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.
849
1479
  * @summary Delete Run Items
@@ -862,7 +1492,17 @@ var PublicApiFactory = function(configuration, basePath, axios) {
862
1492
  * @throws {RequiredError}
863
1493
  */
864
1494
  getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
865
- return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(axios, basePath));
1495
+ return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
1496
+ },
1497
+ /**
1498
+ * Get a grant by its ID.
1499
+ * @summary Get Grant
1500
+ * @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
1501
+ * @param {*} [options] Override http request option.
1502
+ * @throws {RequiredError}
1503
+ */
1504
+ getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
1505
+ return localVarFp.getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(axios, basePath));
866
1506
  },
867
1507
  /**
868
1508
  * Retrieve details of a specific item (slide) by its external ID and the run ID.
@@ -872,7 +1512,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
872
1512
  * @throws {RequiredError}
873
1513
  */
874
1514
  getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
875
- return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(axios, basePath));
1515
+ return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
876
1516
  },
877
1517
  /**
878
1518
  * 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)
@@ -884,14 +1524,54 @@ var PublicApiFactory = function(configuration, basePath, axios) {
884
1524
  return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
885
1525
  },
886
1526
  /**
887
- * 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.
1527
+ * 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.
888
1528
  * @summary Get run details
889
1529
  * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
890
1530
  * @param {*} [options] Override http request option.
891
1531
  * @throws {RequiredError}
892
1532
  */
893
1533
  getRunV1RunsRunIdGet(requestParameters, options) {
894
- return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
1534
+ return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
1535
+ },
1536
+ /**
1537
+ * Get a share token by its ID.
1538
+ * @summary Get Share Token
1539
+ * @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
1540
+ * @param {*} [options] Override http request option.
1541
+ * @throws {RequiredError}
1542
+ */
1543
+ getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
1544
+ return localVarFp.getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
1545
+ },
1546
+ /**
1547
+ * Return metadata for a single public document attached to an application version.
1548
+ * @summary Get version document metadata
1549
+ * @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
1550
+ * @param {*} [options] Override http request option.
1551
+ * @throws {RequiredError}
1552
+ */
1553
+ getVersionDocument(requestParameters, options) {
1554
+ return localVarFp.getVersionDocument(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(axios, basePath));
1555
+ },
1556
+ /**
1557
+ * 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``.
1558
+ * @summary Stream version document content (programmatic)
1559
+ * @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
1560
+ * @param {*} [options] Override http request option.
1561
+ * @throws {RequiredError}
1562
+ */
1563
+ getVersionDocumentContent(requestParameters, options) {
1564
+ return localVarFp.getVersionDocumentContent(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(axios, basePath));
1565
+ },
1566
+ /**
1567
+ * 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``.
1568
+ * @summary Download version document (browser)
1569
+ * @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
1570
+ * @param {*} [options] Override http request option.
1571
+ * @throws {RequiredError}
1572
+ */
1573
+ getVersionDocumentFile(requestParameters, options) {
1574
+ return localVarFp.getVersionDocumentFile(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(axios, basePath));
895
1575
  },
896
1576
  /**
897
1577
  * 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.
@@ -903,6 +1583,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
903
1583
  listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
904
1584
  return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
905
1585
  },
1586
+ /**
1587
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1588
+ * @summary List Grants
1589
+ * @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
1590
+ * @param {*} [options] Override http request option.
1591
+ * @throws {RequiredError}
1592
+ */
1593
+ listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
1594
+ 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));
1595
+ },
906
1596
  /**
907
1597
  * 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
908
1598
  * @summary List Run Items
@@ -911,7 +1601,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
911
1601
  * @throws {RequiredError}
912
1602
  */
913
1603
  listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
914
- 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));
1604
+ 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));
915
1605
  },
916
1606
  /**
917
1607
  * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
@@ -923,6 +1613,26 @@ var PublicApiFactory = function(configuration, basePath, axios) {
923
1613
  listRunsV1RunsGet(requestParameters = {}, options) {
924
1614
  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));
925
1615
  },
1616
+ /**
1617
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1618
+ * @summary List Share Tokens
1619
+ * @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
1620
+ * @param {*} [options] Override http request option.
1621
+ * @throws {RequiredError}
1622
+ */
1623
+ listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
1624
+ return localVarFp.listShareTokensV1AccessShareTokensGet(requestParameters.runId, requestParameters.createdBy, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
1625
+ },
1626
+ /**
1627
+ * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
1628
+ * @summary List version documents
1629
+ * @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
1630
+ * @param {*} [options] Override http request option.
1631
+ * @throws {RequiredError}
1632
+ */
1633
+ listVersionDocuments(requestParameters, options) {
1634
+ return localVarFp.listVersionDocuments(requestParameters.applicationId, requestParameters.version, options).then((request) => request(axios, basePath));
1635
+ },
926
1636
  /**
927
1637
  * 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`.
928
1638
  * @summary Put Item Custom Metadata By Run
@@ -952,6 +1662,26 @@ var PublicApiFactory = function(configuration, basePath, axios) {
952
1662
  */
953
1663
  readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
954
1664
  return localVarFp.readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(axios, basePath));
1665
+ },
1666
+ /**
1667
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1668
+ * @summary Revoke Grant
1669
+ * @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
1670
+ * @param {*} [options] Override http request option.
1671
+ * @throws {RequiredError}
1672
+ */
1673
+ revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
1674
+ return localVarFp.revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(axios, basePath));
1675
+ },
1676
+ /**
1677
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1678
+ * @summary Revoke Share Token
1679
+ * @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
1680
+ * @param {*} [options] Override http request option.
1681
+ * @throws {RequiredError}
1682
+ */
1683
+ revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
1684
+ return localVarFp.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
955
1685
  }
956
1686
  };
957
1687
  };
@@ -978,6 +1708,17 @@ var PublicApi = class extends BaseAPI {
978
1708
  cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
979
1709
  return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
980
1710
  }
1711
+ /**
1712
+ * Create a grant to share access to a resource with a subject (user or organization).
1713
+ * @summary Create Grant
1714
+ * @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
1715
+ * @param {*} [options] Override http request option.
1716
+ * @throws {RequiredError}
1717
+ * @memberof PublicApi
1718
+ */
1719
+ createGrantV1AccessGrantsPost(requestParameters, options) {
1720
+ return PublicApiFp(this.configuration).createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(this.axios, this.basePath));
1721
+ }
981
1722
  /**
982
1723
  * 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
983
1724
  * @summary Initiate Run
@@ -989,6 +1730,17 @@ var PublicApi = class extends BaseAPI {
989
1730
  createRunV1RunsPost(requestParameters, options) {
990
1731
  return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
991
1732
  }
1733
+ /**
1734
+ * 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.
1735
+ * @summary Create Share Token
1736
+ * @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
1737
+ * @param {*} [options] Override http request option.
1738
+ * @throws {RequiredError}
1739
+ * @memberof PublicApi
1740
+ */
1741
+ createShareTokenV1AccessShareTokensPost(requestParameters, options) {
1742
+ return PublicApiFp(this.configuration).createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(this.axios, this.basePath));
1743
+ }
992
1744
  /**
993
1745
  * 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.
994
1746
  * @summary Delete Run Items
@@ -1009,7 +1761,18 @@ var PublicApi = class extends BaseAPI {
1009
1761
  * @memberof PublicApi
1010
1762
  */
1011
1763
  getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
1012
- return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(this.axios, this.basePath));
1764
+ return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
1765
+ }
1766
+ /**
1767
+ * Get a grant by its ID.
1768
+ * @summary Get Grant
1769
+ * @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
1770
+ * @param {*} [options] Override http request option.
1771
+ * @throws {RequiredError}
1772
+ * @memberof PublicApi
1773
+ */
1774
+ getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
1775
+ return PublicApiFp(this.configuration).getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
1013
1776
  }
1014
1777
  /**
1015
1778
  * Retrieve details of a specific item (slide) by its external ID and the run ID.
@@ -1020,7 +1783,7 @@ var PublicApi = class extends BaseAPI {
1020
1783
  * @memberof PublicApi
1021
1784
  */
1022
1785
  getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
1023
- return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(this.axios, this.basePath));
1786
+ return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
1024
1787
  }
1025
1788
  /**
1026
1789
  * 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)
@@ -1033,7 +1796,7 @@ var PublicApi = class extends BaseAPI {
1033
1796
  return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
1034
1797
  }
1035
1798
  /**
1036
- * 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.
1799
+ * 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.
1037
1800
  * @summary Get run details
1038
1801
  * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1039
1802
  * @param {*} [options] Override http request option.
@@ -1041,7 +1804,51 @@ var PublicApi = class extends BaseAPI {
1041
1804
  * @memberof PublicApi
1042
1805
  */
1043
1806
  getRunV1RunsRunIdGet(requestParameters, options) {
1044
- return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
1807
+ return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
1808
+ }
1809
+ /**
1810
+ * Get a share token by its ID.
1811
+ * @summary Get Share Token
1812
+ * @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
1813
+ * @param {*} [options] Override http request option.
1814
+ * @throws {RequiredError}
1815
+ * @memberof PublicApi
1816
+ */
1817
+ getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
1818
+ return PublicApiFp(this.configuration).getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
1819
+ }
1820
+ /**
1821
+ * Return metadata for a single public document attached to an application version.
1822
+ * @summary Get version document metadata
1823
+ * @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
1824
+ * @param {*} [options] Override http request option.
1825
+ * @throws {RequiredError}
1826
+ * @memberof PublicApi
1827
+ */
1828
+ getVersionDocument(requestParameters, options) {
1829
+ return PublicApiFp(this.configuration).getVersionDocument(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(this.axios, this.basePath));
1830
+ }
1831
+ /**
1832
+ * 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``.
1833
+ * @summary Stream version document content (programmatic)
1834
+ * @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
1835
+ * @param {*} [options] Override http request option.
1836
+ * @throws {RequiredError}
1837
+ * @memberof PublicApi
1838
+ */
1839
+ getVersionDocumentContent(requestParameters, options) {
1840
+ return PublicApiFp(this.configuration).getVersionDocumentContent(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(this.axios, this.basePath));
1841
+ }
1842
+ /**
1843
+ * 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``.
1844
+ * @summary Download version document (browser)
1845
+ * @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
1846
+ * @param {*} [options] Override http request option.
1847
+ * @throws {RequiredError}
1848
+ * @memberof PublicApi
1849
+ */
1850
+ getVersionDocumentFile(requestParameters, options) {
1851
+ return PublicApiFp(this.configuration).getVersionDocumentFile(requestParameters.applicationId, requestParameters.version, requestParameters.name, options).then((request) => request(this.axios, this.basePath));
1045
1852
  }
1046
1853
  /**
1047
1854
  * 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.
@@ -1054,6 +1861,17 @@ var PublicApi = class extends BaseAPI {
1054
1861
  listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
1055
1862
  return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1056
1863
  }
1864
+ /**
1865
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1866
+ * @summary List Grants
1867
+ * @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
1868
+ * @param {*} [options] Override http request option.
1869
+ * @throws {RequiredError}
1870
+ * @memberof PublicApi
1871
+ */
1872
+ listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
1873
+ 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));
1874
+ }
1057
1875
  /**
1058
1876
  * 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
1059
1877
  * @summary List Run Items
@@ -1063,7 +1881,7 @@ var PublicApi = class extends BaseAPI {
1063
1881
  * @memberof PublicApi
1064
1882
  */
1065
1883
  listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
1066
- 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));
1884
+ 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));
1067
1885
  }
1068
1886
  /**
1069
1887
  * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
@@ -1076,6 +1894,28 @@ var PublicApi = class extends BaseAPI {
1076
1894
  listRunsV1RunsGet(requestParameters = {}, options) {
1077
1895
  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));
1078
1896
  }
1897
+ /**
1898
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1899
+ * @summary List Share Tokens
1900
+ * @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
1901
+ * @param {*} [options] Override http request option.
1902
+ * @throws {RequiredError}
1903
+ * @memberof PublicApi
1904
+ */
1905
+ listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
1906
+ 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));
1907
+ }
1908
+ /**
1909
+ * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
1910
+ * @summary List version documents
1911
+ * @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
1912
+ * @param {*} [options] Override http request option.
1913
+ * @throws {RequiredError}
1914
+ * @memberof PublicApi
1915
+ */
1916
+ listVersionDocuments(requestParameters, options) {
1917
+ return PublicApiFp(this.configuration).listVersionDocuments(requestParameters.applicationId, requestParameters.version, options).then((request) => request(this.axios, this.basePath));
1918
+ }
1079
1919
  /**
1080
1920
  * 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`.
1081
1921
  * @summary Put Item Custom Metadata By Run
@@ -1109,6 +1949,28 @@ var PublicApi = class extends BaseAPI {
1109
1949
  readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
1110
1950
  return PublicApiFp(this.configuration).readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(this.axios, this.basePath));
1111
1951
  }
1952
+ /**
1953
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1954
+ * @summary Revoke Grant
1955
+ * @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
1956
+ * @param {*} [options] Override http request option.
1957
+ * @throws {RequiredError}
1958
+ * @memberof PublicApi
1959
+ */
1960
+ revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
1961
+ return PublicApiFp(this.configuration).revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
1962
+ }
1963
+ /**
1964
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1965
+ * @summary Revoke Share Token
1966
+ * @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
1967
+ * @param {*} [options] Override http request option.
1968
+ * @throws {RequiredError}
1969
+ * @memberof PublicApi
1970
+ */
1971
+ revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
1972
+ return PublicApiFp(this.configuration).revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
1973
+ }
1112
1974
  };
1113
1975
 
1114
1976
  // src/generated/configuration.ts
@@ -1364,6 +2226,256 @@ var processRunItem = (item) => {
1364
2226
  };
1365
2227
  };
1366
2228
 
2229
+ // ../../node_modules/is-network-error/index.js
2230
+ var objectToString = Object.prototype.toString;
2231
+ var isError = (value) => objectToString.call(value) === "[object Error]";
2232
+ var errorMessages = /* @__PURE__ */ new Set([
2233
+ "network error",
2234
+ // Chrome
2235
+ "NetworkError when attempting to fetch resource.",
2236
+ // Firefox
2237
+ "The Internet connection appears to be offline.",
2238
+ // Safari 16
2239
+ "Network request failed",
2240
+ // `cross-fetch`
2241
+ "fetch failed",
2242
+ // Undici (Node.js)
2243
+ "terminated",
2244
+ // Undici (Node.js)
2245
+ " A network error occurred.",
2246
+ // Bun (WebKit)
2247
+ "Network connection lost"
2248
+ // Cloudflare Workers (fetch)
2249
+ ]);
2250
+ function isNetworkError(error) {
2251
+ const isValid = error && isError(error) && error.name === "TypeError" && typeof error.message === "string";
2252
+ if (!isValid) {
2253
+ return false;
2254
+ }
2255
+ const { message, stack } = error;
2256
+ if (message === "Load failed") {
2257
+ return stack === void 0 || "__sentry_captured__" in error;
2258
+ }
2259
+ if (message.startsWith("error sending request for url")) {
2260
+ return true;
2261
+ }
2262
+ if (message === "Failed to fetch" || message.startsWith("Failed to fetch (") && message.endsWith(")")) {
2263
+ return true;
2264
+ }
2265
+ return errorMessages.has(message);
2266
+ }
2267
+
2268
+ // ../../node_modules/p-retry/index.js
2269
+ function validateRetries(retries) {
2270
+ if (typeof retries === "number") {
2271
+ if (retries < 0) {
2272
+ throw new TypeError("Expected `retries` to be a non-negative number.");
2273
+ }
2274
+ if (Number.isNaN(retries)) {
2275
+ throw new TypeError("Expected `retries` to be a valid number or Infinity, got NaN.");
2276
+ }
2277
+ } else if (retries !== void 0) {
2278
+ throw new TypeError("Expected `retries` to be a number or Infinity.");
2279
+ }
2280
+ }
2281
+ function validateNumberOption(name, value, { min = 0, allowInfinity = false } = {}) {
2282
+ if (value === void 0) {
2283
+ return;
2284
+ }
2285
+ if (typeof value !== "number" || Number.isNaN(value)) {
2286
+ throw new TypeError(`Expected \`${name}\` to be a number${allowInfinity ? " or Infinity" : ""}.`);
2287
+ }
2288
+ if (!allowInfinity && !Number.isFinite(value)) {
2289
+ throw new TypeError(`Expected \`${name}\` to be a finite number.`);
2290
+ }
2291
+ if (value < min) {
2292
+ throw new TypeError(`Expected \`${name}\` to be \u2265 ${min}.`);
2293
+ }
2294
+ }
2295
+ function validateFunctionOption(name, value) {
2296
+ if (value === void 0) {
2297
+ return;
2298
+ }
2299
+ if (typeof value !== "function") {
2300
+ throw new TypeError(`Expected \`${name}\` to be a function.`);
2301
+ }
2302
+ }
2303
+ var AbortError = class extends Error {
2304
+ constructor(message) {
2305
+ super();
2306
+ if (message instanceof Error) {
2307
+ this.originalError = message;
2308
+ ({ message } = message);
2309
+ } else {
2310
+ this.originalError = new Error(message);
2311
+ this.originalError.stack = this.stack;
2312
+ }
2313
+ this.name = "AbortError";
2314
+ this.message = message;
2315
+ }
2316
+ };
2317
+ function calculateDelay(retriesConsumed, options) {
2318
+ const attempt = Math.max(1, retriesConsumed + 1);
2319
+ const random = options.randomize ? Math.random() + 1 : 1;
2320
+ let timeout = Math.round(random * options.minTimeout * options.factor ** (attempt - 1));
2321
+ timeout = Math.min(timeout, options.maxTimeout);
2322
+ return timeout;
2323
+ }
2324
+ function calculateRemainingTime(start, max) {
2325
+ if (!Number.isFinite(max)) {
2326
+ return max;
2327
+ }
2328
+ return max - (performance.now() - start);
2329
+ }
2330
+ async function delayForRetry(delay, options) {
2331
+ if (delay <= 0) {
2332
+ return;
2333
+ }
2334
+ await new Promise((resolve, reject) => {
2335
+ const onAbort = () => {
2336
+ clearTimeout(timeoutToken);
2337
+ options.signal?.removeEventListener("abort", onAbort);
2338
+ reject(options.signal.reason);
2339
+ };
2340
+ const timeoutToken = setTimeout(() => {
2341
+ options.signal?.removeEventListener("abort", onAbort);
2342
+ resolve();
2343
+ }, delay);
2344
+ if (options.unref) {
2345
+ timeoutToken.unref?.();
2346
+ }
2347
+ options.signal?.addEventListener("abort", onAbort, { once: true });
2348
+ });
2349
+ }
2350
+ async function onAttemptFailure({ error, attemptNumber, retriesConsumed, startTime, options }) {
2351
+ const normalizedError = error instanceof Error ? error : new TypeError(`Non-error was thrown: "${error}". You should only throw errors.`);
2352
+ if (normalizedError instanceof AbortError) {
2353
+ throw normalizedError.originalError;
2354
+ }
2355
+ const retriesLeft = Number.isFinite(options.retries) ? Math.max(0, options.retries - retriesConsumed) : options.retries;
2356
+ const maxRetryTime = options.maxRetryTime ?? Number.POSITIVE_INFINITY;
2357
+ const delayTime = calculateDelay(retriesConsumed, options);
2358
+ const remainingTimeBeforeCallbacks = calculateRemainingTime(startTime, maxRetryTime);
2359
+ if (remainingTimeBeforeCallbacks <= 0) {
2360
+ const context2 = Object.freeze({
2361
+ error: normalizedError,
2362
+ attemptNumber,
2363
+ retriesLeft,
2364
+ retriesConsumed,
2365
+ retryDelay: 0
2366
+ });
2367
+ await options.onFailedAttempt(context2);
2368
+ throw normalizedError;
2369
+ }
2370
+ const consumeRetryContext = Object.freeze({
2371
+ error: normalizedError,
2372
+ attemptNumber,
2373
+ retriesLeft,
2374
+ retriesConsumed,
2375
+ retryDelay: retriesLeft > 0 ? delayTime : 0
2376
+ });
2377
+ const consumeRetry = await options.shouldConsumeRetry(consumeRetryContext);
2378
+ const effectiveDelay = consumeRetry && retriesLeft > 0 ? delayTime : 0;
2379
+ const context = Object.freeze({
2380
+ error: normalizedError,
2381
+ attemptNumber,
2382
+ retriesLeft,
2383
+ retriesConsumed,
2384
+ retryDelay: effectiveDelay
2385
+ });
2386
+ await options.onFailedAttempt(context);
2387
+ if (calculateRemainingTime(startTime, maxRetryTime) <= 0) {
2388
+ throw normalizedError;
2389
+ }
2390
+ const remainingTime = calculateRemainingTime(startTime, maxRetryTime);
2391
+ if (remainingTime <= 0 || retriesLeft <= 0) {
2392
+ throw normalizedError;
2393
+ }
2394
+ if (normalizedError instanceof TypeError && !isNetworkError(normalizedError)) {
2395
+ throw normalizedError;
2396
+ }
2397
+ if (!await options.shouldRetry(context)) {
2398
+ throw normalizedError;
2399
+ }
2400
+ const remainingTimeAfterShouldRetry = calculateRemainingTime(startTime, maxRetryTime);
2401
+ if (remainingTimeAfterShouldRetry <= 0) {
2402
+ throw normalizedError;
2403
+ }
2404
+ if (!consumeRetry) {
2405
+ options.signal?.throwIfAborted();
2406
+ return false;
2407
+ }
2408
+ const finalDelay = Math.min(effectiveDelay, remainingTimeAfterShouldRetry);
2409
+ options.signal?.throwIfAborted();
2410
+ await delayForRetry(finalDelay, options);
2411
+ options.signal?.throwIfAborted();
2412
+ return true;
2413
+ }
2414
+ async function pRetry(input, options = {}) {
2415
+ options = { ...options };
2416
+ validateRetries(options.retries);
2417
+ if (Object.hasOwn(options, "forever")) {
2418
+ throw new Error("The `forever` option is no longer supported. For many use-cases, you can set `retries: Infinity` instead.");
2419
+ }
2420
+ options.retries ??= 10;
2421
+ options.factor ??= 2;
2422
+ options.minTimeout ??= 1e3;
2423
+ options.maxTimeout ??= Number.POSITIVE_INFINITY;
2424
+ options.maxRetryTime ??= Number.POSITIVE_INFINITY;
2425
+ options.randomize ??= false;
2426
+ options.onFailedAttempt ??= () => {
2427
+ };
2428
+ options.shouldRetry ??= () => true;
2429
+ options.shouldConsumeRetry ??= () => true;
2430
+ validateFunctionOption("onFailedAttempt", options.onFailedAttempt);
2431
+ validateFunctionOption("shouldRetry", options.shouldRetry);
2432
+ validateFunctionOption("shouldConsumeRetry", options.shouldConsumeRetry);
2433
+ validateNumberOption("factor", options.factor, { min: 0, allowInfinity: false });
2434
+ validateNumberOption("minTimeout", options.minTimeout, { min: 0, allowInfinity: false });
2435
+ validateNumberOption("maxTimeout", options.maxTimeout, { min: 0, allowInfinity: true });
2436
+ validateNumberOption("maxRetryTime", options.maxRetryTime, { min: 0, allowInfinity: true });
2437
+ if (!(options.factor > 0)) {
2438
+ options.factor = 1;
2439
+ }
2440
+ options.signal?.throwIfAborted();
2441
+ let attemptNumber = 0;
2442
+ let retriesConsumed = 0;
2443
+ const startTime = performance.now();
2444
+ while (Number.isFinite(options.retries) ? retriesConsumed <= options.retries : true) {
2445
+ attemptNumber++;
2446
+ try {
2447
+ options.signal?.throwIfAborted();
2448
+ const result = await input(attemptNumber);
2449
+ options.signal?.throwIfAborted();
2450
+ return result;
2451
+ } catch (error) {
2452
+ if (await onAttemptFailure({
2453
+ error,
2454
+ attemptNumber,
2455
+ retriesConsumed,
2456
+ startTime,
2457
+ options
2458
+ })) {
2459
+ retriesConsumed++;
2460
+ }
2461
+ }
2462
+ }
2463
+ throw new Error("Retry attempts exhausted without throwing an error.");
2464
+ }
2465
+
2466
+ // src/utils/downloadWithRetry.ts
2467
+ var downloadWithRetry = async (callbackFn, abortStatuses = [404]) => {
2468
+ return await pRetry(callbackFn, {
2469
+ retries: 3,
2470
+ shouldRetry: ({ error }) => {
2471
+ if (isAxiosError(error) && abortStatuses.includes(error.response?.status ?? 0)) {
2472
+ return false;
2473
+ }
2474
+ return true;
2475
+ }
2476
+ });
2477
+ };
2478
+
1367
2479
  // src/platform-sdk.ts
1368
2480
  var validationErrorSchema = z.object({
1369
2481
  detail: z.array(
@@ -1396,6 +2508,24 @@ function handleRequestError(error) {
1396
2508
  statusCode: 404
1397
2509
  });
1398
2510
  }
2511
+ case 403: {
2512
+ throw new APIError(`Access forbidden: ${error.message}`, {
2513
+ context: {
2514
+ responseBody: errorResponseSchema.parse(error.response?.data)
2515
+ },
2516
+ originalError: error,
2517
+ statusCode: 403
2518
+ });
2519
+ }
2520
+ case 410: {
2521
+ throw new APIError(`Resource gone: ${error.message}`, {
2522
+ context: {
2523
+ responseBody: errorResponseSchema.parse(error.response?.data)
2524
+ },
2525
+ originalError: error,
2526
+ statusCode: 410
2527
+ });
2528
+ }
1399
2529
  default: {
1400
2530
  throw new APIError(`API request failed: ${error.message}`, {
1401
2531
  context: {
@@ -1854,11 +2984,63 @@ var PlatformSDKHttp = class {
1854
2984
  getConfig() {
1855
2985
  return { ...this.#config };
1856
2986
  }
2987
+ /**
2988
+ * Download an artifact file from a completed application run
2989
+ *
2990
+ * This method retrieves the binary content of a specific artifact produced
2991
+ * during an application run. Artifacts can include generated reports, processed
2992
+ * images, or other output files from the AI model execution.
2993
+ *
2994
+ * The download is performed with automatic retries for transient failures.
2995
+ * Non-retryable HTTP status codes (403, 404, 410, 422) will abort immediately.
2996
+ *
2997
+ * @param runId - The unique identifier of the application run
2998
+ * @param artifactId - The unique identifier of the artifact to download
2999
+ * @returns A promise that resolves to an ArrayBuffer containing the artifact's binary content
3000
+ * @throws {AuthenticationError} If no valid authentication token is available
3001
+ * @throws {APIError} If the API request fails (e.g., 403, 404, 410, 422, or other HTTP errors)
3002
+ * @throws {UnexpectedError} If a non-HTTP error occurs
3003
+ *
3004
+ * @example
3005
+ * ```typescript
3006
+ * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
3007
+ *
3008
+ * try {
3009
+ * const buffer = await sdk.downloadArtifact('run-123', 'artifact-456');
3010
+ * console.log(`Downloaded ${buffer.byteLength} bytes`);
3011
+ *
3012
+ * // Write to file (Node.js)
3013
+ * fs.writeFileSync('output.bin', Buffer.from(buffer));
3014
+ * } catch (error) {
3015
+ * console.error('Failed to download artifact:', error.message);
3016
+ * }
3017
+ * ```
3018
+ */
3019
+ async downloadArtifact(runId, artifactId) {
3020
+ const client = await this.#getClient();
3021
+ try {
3022
+ const response = await downloadWithRetry(
3023
+ () => client.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(
3024
+ {
3025
+ runId,
3026
+ artifactId
3027
+ },
3028
+ {
3029
+ responseType: "arraybuffer"
3030
+ }
3031
+ ),
3032
+ [403, 404, 410, 422]
3033
+ );
3034
+ return response.data;
3035
+ } catch (error) {
3036
+ handleRequestError(error);
3037
+ }
3038
+ }
1857
3039
  };
1858
3040
 
1859
3041
  // src/index.ts
1860
3042
  var index_default = PlatformSDKHttp;
1861
3043
 
1862
- export { APIError, ArtifactOutput, ArtifactState, ArtifactTerminationReason, AuthenticationError, BaseError, Configuration, ConfigurationError, ItemOutput, ItemState, ItemTerminationReason, OutputArtifactScope, OutputArtifactVisibility, PlatformSDKHttp, PublicApi, PublicApiAxiosParamCreator, PublicApiFactory, PublicApiFp, RunOutput, RunState, RunTerminationReason, canDownloadItem, canDownloadRunItems, index_default as default, getItemStatus, getRunProgress, getRunStatus, processApplicationRun, processRunItem };
3044
+ export { APIError, ArtifactOutput, ArtifactState, ArtifactTerminationReason, AuthenticationError, BaseError, Configuration, ConfigurationError, GrantRelation, ItemOutput, ItemState, ItemTerminationReason, OutputArtifactScope, OutputArtifactVisibility, PlatformSDKHttp, PublicApi, PublicApiAxiosParamCreator, PublicApiFactory, PublicApiFp, ResourceType, RunOutput, RunState, RunTerminationReason, SubjectType, VersionDocumentVisibility, canDownloadItem, canDownloadRunItems, index_default as default, getItemStatus, getRunProgress, getRunStatus, processApplicationRun, processRunItem };
1863
3045
  //# sourceMappingURL=index.js.map
1864
3046
  //# sourceMappingURL=index.js.map