@aignostics/sdk 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aignostics-sdk-3.4.0.tgz +0 -0
- package/dist/{api-CWohsFN3.d.cts → api-DXw7V8bK.d.cts} +371 -3
- package/dist/{api-CWohsFN3.d.ts → api-DXw7V8bK.d.ts} +371 -3
- package/dist/index.cjs +590 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +36 -2
- package/dist/index.d.ts +36 -2
- package/dist/index.js +590 -1
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +26 -1
- package/dist/test-utils/http-mocks.cjs.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +1 -1
- package/dist/test-utils/http-mocks.d.ts +1 -1
- package/dist/test-utils/http-mocks.js +26 -1
- package/dist/test-utils/http-mocks.js.map +1 -1
- package/package.json +2 -1
- package/dist/aignostics-sdk-3.3.0.tgz +0 -0
|
@@ -5,7 +5,7 @@ import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
|
|
|
5
5
|
* Aignostics Platform API
|
|
6
6
|
* The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.5.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -97,7 +97,7 @@ declare class Configuration {
|
|
|
97
97
|
* Aignostics Platform API
|
|
98
98
|
* The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
|
|
99
99
|
*
|
|
100
|
-
* The version of the OpenAPI document: 1.
|
|
100
|
+
* The version of the OpenAPI document: 1.5.0
|
|
101
101
|
*
|
|
102
102
|
*
|
|
103
103
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -355,6 +355,39 @@ interface InputArtifactCreationRequest {
|
|
|
355
355
|
[key: string]: any;
|
|
356
356
|
};
|
|
357
357
|
}
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @export
|
|
361
|
+
* @interface InputArtifactResultReadResponse
|
|
362
|
+
*/
|
|
363
|
+
interface InputArtifactResultReadResponse {
|
|
364
|
+
/**
|
|
365
|
+
* The Id of the artifact. Used internally
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof InputArtifactResultReadResponse
|
|
368
|
+
*/
|
|
369
|
+
'input_artifact_id': string;
|
|
370
|
+
/**
|
|
371
|
+
* Name of the input from the schema from the `/v1/versions/{version_id}` endpoint.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof InputArtifactResultReadResponse
|
|
374
|
+
*/
|
|
375
|
+
'name': string;
|
|
376
|
+
/**
|
|
377
|
+
*
|
|
378
|
+
* @type {{ [key: string]: any; }}
|
|
379
|
+
* @memberof InputArtifactResultReadResponse
|
|
380
|
+
*/
|
|
381
|
+
'metadata'?: {
|
|
382
|
+
[key: string]: any;
|
|
383
|
+
} | null;
|
|
384
|
+
/**
|
|
385
|
+
*
|
|
386
|
+
* @type {string}
|
|
387
|
+
* @memberof InputArtifactResultReadResponse
|
|
388
|
+
*/
|
|
389
|
+
'download_url'?: string | null;
|
|
390
|
+
}
|
|
358
391
|
/**
|
|
359
392
|
* Individual item (slide) to be processed in a run.
|
|
360
393
|
* @export
|
|
@@ -472,6 +505,12 @@ interface ItemResultReadResponse {
|
|
|
472
505
|
* @memberof ItemResultReadResponse
|
|
473
506
|
*/
|
|
474
507
|
'terminated_at'?: string | null;
|
|
508
|
+
/**
|
|
509
|
+
* The input artifact(s) provided by the user. For most applications, this will be one artifact that defines the whole slide image to be processed.
|
|
510
|
+
* @type {Array<InputArtifactResultReadResponse>}
|
|
511
|
+
* @memberof ItemResultReadResponse
|
|
512
|
+
*/
|
|
513
|
+
'input_artifacts': Array<InputArtifactResultReadResponse>;
|
|
475
514
|
/**
|
|
476
515
|
* The list of the results generated by the application algorithm. The number of files and their types depend on the particular application version, call `/v1/versions/{version_id}` to get the details.
|
|
477
516
|
* @type {Array<OutputArtifactResultReadResponse>}
|
|
@@ -1092,6 +1131,59 @@ interface ValidationError {
|
|
|
1092
1131
|
*/
|
|
1093
1132
|
interface ValidationErrorLocInner {
|
|
1094
1133
|
}
|
|
1134
|
+
/**
|
|
1135
|
+
*
|
|
1136
|
+
* @export
|
|
1137
|
+
* @interface VersionDocumentResponse
|
|
1138
|
+
*/
|
|
1139
|
+
interface VersionDocumentResponse {
|
|
1140
|
+
/**
|
|
1141
|
+
*
|
|
1142
|
+
* @type {string}
|
|
1143
|
+
* @memberof VersionDocumentResponse
|
|
1144
|
+
*/
|
|
1145
|
+
'id': string;
|
|
1146
|
+
/**
|
|
1147
|
+
*
|
|
1148
|
+
* @type {string}
|
|
1149
|
+
* @memberof VersionDocumentResponse
|
|
1150
|
+
*/
|
|
1151
|
+
'name': string;
|
|
1152
|
+
/**
|
|
1153
|
+
*
|
|
1154
|
+
* @type {string}
|
|
1155
|
+
* @memberof VersionDocumentResponse
|
|
1156
|
+
*/
|
|
1157
|
+
'mime_type': string;
|
|
1158
|
+
/**
|
|
1159
|
+
*
|
|
1160
|
+
* @type {VersionDocumentVisibility}
|
|
1161
|
+
* @memberof VersionDocumentResponse
|
|
1162
|
+
*/
|
|
1163
|
+
'visibility': VersionDocumentVisibility;
|
|
1164
|
+
/**
|
|
1165
|
+
*
|
|
1166
|
+
* @type {string}
|
|
1167
|
+
* @memberof VersionDocumentResponse
|
|
1168
|
+
*/
|
|
1169
|
+
'created_at': string;
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @type {string}
|
|
1173
|
+
* @memberof VersionDocumentResponse
|
|
1174
|
+
*/
|
|
1175
|
+
'updated_at': string;
|
|
1176
|
+
}
|
|
1177
|
+
/**
|
|
1178
|
+
*
|
|
1179
|
+
* @export
|
|
1180
|
+
* @enum {string}
|
|
1181
|
+
*/
|
|
1182
|
+
declare const VersionDocumentVisibility: {
|
|
1183
|
+
readonly Public: "public";
|
|
1184
|
+
readonly Internal: "internal";
|
|
1185
|
+
};
|
|
1186
|
+
type VersionDocumentVisibility = typeof VersionDocumentVisibility[keyof typeof VersionDocumentVisibility];
|
|
1095
1187
|
/**
|
|
1096
1188
|
* Base Response schema for the `Application Version Details` endpoint
|
|
1097
1189
|
* @export
|
|
@@ -1200,6 +1292,36 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1200
1292
|
* @throws {RequiredError}
|
|
1201
1293
|
*/
|
|
1202
1294
|
getRunV1RunsRunIdGet: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1295
|
+
/**
|
|
1296
|
+
* Return metadata for a single public document attached to an application version.
|
|
1297
|
+
* @summary Get version document metadata
|
|
1298
|
+
* @param {string} applicationId
|
|
1299
|
+
* @param {string} version
|
|
1300
|
+
* @param {string} name
|
|
1301
|
+
* @param {*} [options] Override http request option.
|
|
1302
|
+
* @throws {RequiredError}
|
|
1303
|
+
*/
|
|
1304
|
+
getVersionDocument: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1305
|
+
/**
|
|
1306
|
+
* 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``.
|
|
1307
|
+
* @summary Stream version document content (programmatic)
|
|
1308
|
+
* @param {string} applicationId
|
|
1309
|
+
* @param {string} version
|
|
1310
|
+
* @param {string} name
|
|
1311
|
+
* @param {*} [options] Override http request option.
|
|
1312
|
+
* @throws {RequiredError}
|
|
1313
|
+
*/
|
|
1314
|
+
getVersionDocumentContent: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1315
|
+
/**
|
|
1316
|
+
* 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``.
|
|
1317
|
+
* @summary Download version document (browser)
|
|
1318
|
+
* @param {string} applicationId
|
|
1319
|
+
* @param {string} version
|
|
1320
|
+
* @param {string} name
|
|
1321
|
+
* @param {*} [options] Override http request option.
|
|
1322
|
+
* @throws {RequiredError}
|
|
1323
|
+
*/
|
|
1324
|
+
getVersionDocumentFile: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1203
1325
|
/**
|
|
1204
1326
|
* 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.
|
|
1205
1327
|
* @summary List available applications
|
|
@@ -1241,6 +1363,15 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1241
1363
|
* @throws {RequiredError}
|
|
1242
1364
|
*/
|
|
1243
1365
|
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1366
|
+
/**
|
|
1367
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1368
|
+
* @summary List version documents
|
|
1369
|
+
* @param {string} applicationId
|
|
1370
|
+
* @param {string} version
|
|
1371
|
+
* @param {*} [options] Override http request option.
|
|
1372
|
+
* @throws {RequiredError}
|
|
1373
|
+
*/
|
|
1374
|
+
listVersionDocuments: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1244
1375
|
/**
|
|
1245
1376
|
* 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`.
|
|
1246
1377
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1340,6 +1471,36 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1340
1471
|
* @throws {RequiredError}
|
|
1341
1472
|
*/
|
|
1342
1473
|
getRunV1RunsRunIdGet(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
|
|
1474
|
+
/**
|
|
1475
|
+
* Return metadata for a single public document attached to an application version.
|
|
1476
|
+
* @summary Get version document metadata
|
|
1477
|
+
* @param {string} applicationId
|
|
1478
|
+
* @param {string} version
|
|
1479
|
+
* @param {string} name
|
|
1480
|
+
* @param {*} [options] Override http request option.
|
|
1481
|
+
* @throws {RequiredError}
|
|
1482
|
+
*/
|
|
1483
|
+
getVersionDocument(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionDocumentResponse>>;
|
|
1484
|
+
/**
|
|
1485
|
+
* 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``.
|
|
1486
|
+
* @summary Stream version document content (programmatic)
|
|
1487
|
+
* @param {string} applicationId
|
|
1488
|
+
* @param {string} version
|
|
1489
|
+
* @param {string} name
|
|
1490
|
+
* @param {*} [options] Override http request option.
|
|
1491
|
+
* @throws {RequiredError}
|
|
1492
|
+
*/
|
|
1493
|
+
getVersionDocumentContent(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1494
|
+
/**
|
|
1495
|
+
* 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``.
|
|
1496
|
+
* @summary Download version document (browser)
|
|
1497
|
+
* @param {string} applicationId
|
|
1498
|
+
* @param {string} version
|
|
1499
|
+
* @param {string} name
|
|
1500
|
+
* @param {*} [options] Override http request option.
|
|
1501
|
+
* @throws {RequiredError}
|
|
1502
|
+
*/
|
|
1503
|
+
getVersionDocumentFile(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1343
1504
|
/**
|
|
1344
1505
|
* 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.
|
|
1345
1506
|
* @summary List available applications
|
|
@@ -1381,6 +1542,15 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1381
1542
|
* @throws {RequiredError}
|
|
1382
1543
|
*/
|
|
1383
1544
|
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1545
|
+
/**
|
|
1546
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1547
|
+
* @summary List version documents
|
|
1548
|
+
* @param {string} applicationId
|
|
1549
|
+
* @param {string} version
|
|
1550
|
+
* @param {*} [options] Override http request option.
|
|
1551
|
+
* @throws {RequiredError}
|
|
1552
|
+
*/
|
|
1553
|
+
listVersionDocuments(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VersionDocumentResponse>>>;
|
|
1384
1554
|
/**
|
|
1385
1555
|
* 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`.
|
|
1386
1556
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1477,6 +1647,30 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1477
1647
|
* @throws {RequiredError}
|
|
1478
1648
|
*/
|
|
1479
1649
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
1650
|
+
/**
|
|
1651
|
+
* Return metadata for a single public document attached to an application version.
|
|
1652
|
+
* @summary Get version document metadata
|
|
1653
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
1654
|
+
* @param {*} [options] Override http request option.
|
|
1655
|
+
* @throws {RequiredError}
|
|
1656
|
+
*/
|
|
1657
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
|
|
1658
|
+
/**
|
|
1659
|
+
* 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``.
|
|
1660
|
+
* @summary Stream version document content (programmatic)
|
|
1661
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
1662
|
+
* @param {*} [options] Override http request option.
|
|
1663
|
+
* @throws {RequiredError}
|
|
1664
|
+
*/
|
|
1665
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1666
|
+
/**
|
|
1667
|
+
* 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``.
|
|
1668
|
+
* @summary Download version document (browser)
|
|
1669
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
1670
|
+
* @param {*} [options] Override http request option.
|
|
1671
|
+
* @throws {RequiredError}
|
|
1672
|
+
*/
|
|
1673
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1480
1674
|
/**
|
|
1481
1675
|
* 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.
|
|
1482
1676
|
* @summary List available applications
|
|
@@ -1501,6 +1695,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1501
1695
|
* @throws {RequiredError}
|
|
1502
1696
|
*/
|
|
1503
1697
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
1698
|
+
/**
|
|
1699
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1700
|
+
* @summary List version documents
|
|
1701
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
1702
|
+
* @param {*} [options] Override http request option.
|
|
1703
|
+
* @throws {RequiredError}
|
|
1704
|
+
*/
|
|
1705
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
|
|
1504
1706
|
/**
|
|
1505
1707
|
* 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`.
|
|
1506
1708
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1603,6 +1805,33 @@ interface PublicApiInterface {
|
|
|
1603
1805
|
* @memberof PublicApiInterface
|
|
1604
1806
|
*/
|
|
1605
1807
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
1808
|
+
/**
|
|
1809
|
+
* Return metadata for a single public document attached to an application version.
|
|
1810
|
+
* @summary Get version document metadata
|
|
1811
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
1812
|
+
* @param {*} [options] Override http request option.
|
|
1813
|
+
* @throws {RequiredError}
|
|
1814
|
+
* @memberof PublicApiInterface
|
|
1815
|
+
*/
|
|
1816
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
|
|
1817
|
+
/**
|
|
1818
|
+
* 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``.
|
|
1819
|
+
* @summary Stream version document content (programmatic)
|
|
1820
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
1821
|
+
* @param {*} [options] Override http request option.
|
|
1822
|
+
* @throws {RequiredError}
|
|
1823
|
+
* @memberof PublicApiInterface
|
|
1824
|
+
*/
|
|
1825
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1826
|
+
/**
|
|
1827
|
+
* 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``.
|
|
1828
|
+
* @summary Download version document (browser)
|
|
1829
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
1830
|
+
* @param {*} [options] Override http request option.
|
|
1831
|
+
* @throws {RequiredError}
|
|
1832
|
+
* @memberof PublicApiInterface
|
|
1833
|
+
*/
|
|
1834
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1606
1835
|
/**
|
|
1607
1836
|
* 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.
|
|
1608
1837
|
* @summary List available applications
|
|
@@ -1630,6 +1859,15 @@ interface PublicApiInterface {
|
|
|
1630
1859
|
* @memberof PublicApiInterface
|
|
1631
1860
|
*/
|
|
1632
1861
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
1862
|
+
/**
|
|
1863
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1864
|
+
* @summary List version documents
|
|
1865
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
1866
|
+
* @param {*} [options] Override http request option.
|
|
1867
|
+
* @throws {RequiredError}
|
|
1868
|
+
* @memberof PublicApiInterface
|
|
1869
|
+
*/
|
|
1870
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
|
|
1633
1871
|
/**
|
|
1634
1872
|
* 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`.
|
|
1635
1873
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1767,6 +2005,81 @@ interface PublicApiGetRunV1RunsRunIdGetRequest {
|
|
|
1767
2005
|
*/
|
|
1768
2006
|
readonly runId: string;
|
|
1769
2007
|
}
|
|
2008
|
+
/**
|
|
2009
|
+
* Request parameters for getVersionDocument operation in PublicApi.
|
|
2010
|
+
* @export
|
|
2011
|
+
* @interface PublicApiGetVersionDocumentRequest
|
|
2012
|
+
*/
|
|
2013
|
+
interface PublicApiGetVersionDocumentRequest {
|
|
2014
|
+
/**
|
|
2015
|
+
*
|
|
2016
|
+
* @type {string}
|
|
2017
|
+
* @memberof PublicApiGetVersionDocument
|
|
2018
|
+
*/
|
|
2019
|
+
readonly applicationId: string;
|
|
2020
|
+
/**
|
|
2021
|
+
*
|
|
2022
|
+
* @type {string}
|
|
2023
|
+
* @memberof PublicApiGetVersionDocument
|
|
2024
|
+
*/
|
|
2025
|
+
readonly version: string;
|
|
2026
|
+
/**
|
|
2027
|
+
*
|
|
2028
|
+
* @type {string}
|
|
2029
|
+
* @memberof PublicApiGetVersionDocument
|
|
2030
|
+
*/
|
|
2031
|
+
readonly name: string;
|
|
2032
|
+
}
|
|
2033
|
+
/**
|
|
2034
|
+
* Request parameters for getVersionDocumentContent operation in PublicApi.
|
|
2035
|
+
* @export
|
|
2036
|
+
* @interface PublicApiGetVersionDocumentContentRequest
|
|
2037
|
+
*/
|
|
2038
|
+
interface PublicApiGetVersionDocumentContentRequest {
|
|
2039
|
+
/**
|
|
2040
|
+
*
|
|
2041
|
+
* @type {string}
|
|
2042
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2043
|
+
*/
|
|
2044
|
+
readonly applicationId: string;
|
|
2045
|
+
/**
|
|
2046
|
+
*
|
|
2047
|
+
* @type {string}
|
|
2048
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2049
|
+
*/
|
|
2050
|
+
readonly version: string;
|
|
2051
|
+
/**
|
|
2052
|
+
*
|
|
2053
|
+
* @type {string}
|
|
2054
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2055
|
+
*/
|
|
2056
|
+
readonly name: string;
|
|
2057
|
+
}
|
|
2058
|
+
/**
|
|
2059
|
+
* Request parameters for getVersionDocumentFile operation in PublicApi.
|
|
2060
|
+
* @export
|
|
2061
|
+
* @interface PublicApiGetVersionDocumentFileRequest
|
|
2062
|
+
*/
|
|
2063
|
+
interface PublicApiGetVersionDocumentFileRequest {
|
|
2064
|
+
/**
|
|
2065
|
+
*
|
|
2066
|
+
* @type {string}
|
|
2067
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2068
|
+
*/
|
|
2069
|
+
readonly applicationId: string;
|
|
2070
|
+
/**
|
|
2071
|
+
*
|
|
2072
|
+
* @type {string}
|
|
2073
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2074
|
+
*/
|
|
2075
|
+
readonly version: string;
|
|
2076
|
+
/**
|
|
2077
|
+
*
|
|
2078
|
+
* @type {string}
|
|
2079
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2080
|
+
*/
|
|
2081
|
+
readonly name: string;
|
|
2082
|
+
}
|
|
1770
2083
|
/**
|
|
1771
2084
|
* Request parameters for listApplicationsV1ApplicationsGet operation in PublicApi.
|
|
1772
2085
|
* @export
|
|
@@ -1908,6 +2221,25 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
1908
2221
|
*/
|
|
1909
2222
|
readonly sort?: Array<string> | null;
|
|
1910
2223
|
}
|
|
2224
|
+
/**
|
|
2225
|
+
* Request parameters for listVersionDocuments operation in PublicApi.
|
|
2226
|
+
* @export
|
|
2227
|
+
* @interface PublicApiListVersionDocumentsRequest
|
|
2228
|
+
*/
|
|
2229
|
+
interface PublicApiListVersionDocumentsRequest {
|
|
2230
|
+
/**
|
|
2231
|
+
*
|
|
2232
|
+
* @type {string}
|
|
2233
|
+
* @memberof PublicApiListVersionDocuments
|
|
2234
|
+
*/
|
|
2235
|
+
readonly applicationId: string;
|
|
2236
|
+
/**
|
|
2237
|
+
*
|
|
2238
|
+
* @type {string}
|
|
2239
|
+
* @memberof PublicApiListVersionDocuments
|
|
2240
|
+
*/
|
|
2241
|
+
readonly version: string;
|
|
2242
|
+
}
|
|
1911
2243
|
/**
|
|
1912
2244
|
* Request parameters for putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut operation in PublicApi.
|
|
1913
2245
|
* @export
|
|
@@ -2043,6 +2375,33 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2043
2375
|
* @memberof PublicApi
|
|
2044
2376
|
*/
|
|
2045
2377
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
|
|
2378
|
+
/**
|
|
2379
|
+
* Return metadata for a single public document attached to an application version.
|
|
2380
|
+
* @summary Get version document metadata
|
|
2381
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
2382
|
+
* @param {*} [options] Override http request option.
|
|
2383
|
+
* @throws {RequiredError}
|
|
2384
|
+
* @memberof PublicApi
|
|
2385
|
+
*/
|
|
2386
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse, any, {}>>;
|
|
2387
|
+
/**
|
|
2388
|
+
* 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``.
|
|
2389
|
+
* @summary Stream version document content (programmatic)
|
|
2390
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
2391
|
+
* @param {*} [options] Override http request option.
|
|
2392
|
+
* @throws {RequiredError}
|
|
2393
|
+
* @memberof PublicApi
|
|
2394
|
+
*/
|
|
2395
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
2396
|
+
/**
|
|
2397
|
+
* 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``.
|
|
2398
|
+
* @summary Download version document (browser)
|
|
2399
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
2400
|
+
* @param {*} [options] Override http request option.
|
|
2401
|
+
* @throws {RequiredError}
|
|
2402
|
+
* @memberof PublicApi
|
|
2403
|
+
*/
|
|
2404
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
2046
2405
|
/**
|
|
2047
2406
|
* 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.
|
|
2048
2407
|
* @summary List available applications
|
|
@@ -2070,6 +2429,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2070
2429
|
* @memberof PublicApi
|
|
2071
2430
|
*/
|
|
2072
2431
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
|
|
2432
|
+
/**
|
|
2433
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
2434
|
+
* @summary List version documents
|
|
2435
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
2436
|
+
* @param {*} [options] Override http request option.
|
|
2437
|
+
* @throws {RequiredError}
|
|
2438
|
+
* @memberof PublicApi
|
|
2439
|
+
*/
|
|
2440
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse[], any, {}>>;
|
|
2073
2441
|
/**
|
|
2074
2442
|
* 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`.
|
|
2075
2443
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -2099,4 +2467,4 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2099
2467
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
|
|
2100
2468
|
}
|
|
2101
2469
|
|
|
2102
|
-
export { type
|
|
2470
|
+
export { type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as $, type ApplicationReadShortResponse as A, type VersionDocumentResponse as B, type CustomMetadataUpdateRequest as C, VersionDocumentVisibility as D, PublicApiFp as E, PublicApiFactory as F, type PublicApiInterface as G, type HTTPValidationError as H, type ItemResultReadResponse as I, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as J, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as K, type PublicApiCreateRunV1RunsPostRequest as L, type MeReadResponse as M, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as N, type OrganizationReadResponse as O, PublicApiAxiosParamCreator as P, type PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest as Q, type RunReadResponse as R, type SchedulingRequest as S, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as T, type UserReadResponse as U, type VersionReadResponse as V, type PublicApiGetRunV1RunsRunIdGetRequest as W, type PublicApiGetVersionDocumentRequest as X, type PublicApiGetVersionDocumentContentRequest as Y, type PublicApiGetVersionDocumentFileRequest as Z, type PublicApiListApplicationsV1ApplicationsGetRequest as _, type ApplicationReadResponse as a, type PublicApiListRunsV1RunsGetRequest as a0, type PublicApiListVersionDocumentsRequest as a1, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as a2, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as a3, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as a4, PublicApi as a5, type ConfigurationParameters as a6, Configuration as a7, type RunCreationRequest as b, type RunCreationResponse as c, ItemState as d, ItemTerminationReason as e, type ApplicationVersion as f, ArtifactOutput as g, ArtifactState as h, ArtifactTerminationReason as i, type CustomMetadataUpdateResponse as j, type InputArtifact as k, type InputArtifactCreationRequest as l, type InputArtifactResultReadResponse as m, type ItemCreationRequest as n, ItemOutput as o, type OutputArtifact as p, type OutputArtifactResultReadResponse as q, OutputArtifactScope as r, OutputArtifactVisibility as s, type RunItemStatistics as t, RunOutput as u, RunState as v, RunTerminationReason as w, type SchedulingResponse as x, type ValidationError as y, type ValidationErrorLocInner as z };
|