@aignostics/sdk 2.3.1 → 3.0.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.d.cts CHANGED
@@ -1,1491 +1,6 @@
1
- import * as axios from 'axios';
2
- import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
3
-
4
- /**
5
- * Aignostics Platform API reference
6
- * Pagination is done via `page` and `page_size`. Sorting via `sort` query parameter. The `sort` query parameter can be provided multiple times. The sorting direction can be indicated via `+` (ascending) or `-` (descending) (e.g. `/v1/applications?sort=+name)`.
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- interface ConfigurationParameters {
16
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
17
- username?: string;
18
- password?: string;
19
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
20
- basePath?: string;
21
- serverIndex?: number;
22
- baseOptions?: any;
23
- formDataCtor?: new () => any;
24
- }
25
- declare class Configuration {
26
- /**
27
- * parameter for apiKey security
28
- * @param name security name
29
- * @memberof Configuration
30
- */
31
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
32
- /**
33
- * parameter for basic security
34
- *
35
- * @type {string}
36
- * @memberof Configuration
37
- */
38
- username?: string;
39
- /**
40
- * parameter for basic security
41
- *
42
- * @type {string}
43
- * @memberof Configuration
44
- */
45
- password?: string;
46
- /**
47
- * parameter for oauth2 security
48
- * @param name security name
49
- * @param scopes oauth2 scope
50
- * @memberof Configuration
51
- */
52
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
53
- /**
54
- * override base path
55
- *
56
- * @type {string}
57
- * @memberof Configuration
58
- */
59
- basePath?: string;
60
- /**
61
- * override server index
62
- *
63
- * @type {number}
64
- * @memberof Configuration
65
- */
66
- serverIndex?: number;
67
- /**
68
- * base options for axios calls
69
- *
70
- * @type {any}
71
- * @memberof Configuration
72
- */
73
- baseOptions?: any;
74
- /**
75
- * The FormData constructor that will be used to create multipart form data
76
- * requests. You can inject this here so that execution environments that
77
- * do not support the FormData class can still run the generated client.
78
- *
79
- * @type {new () => FormData}
80
- */
81
- formDataCtor?: new () => any;
82
- constructor(param?: ConfigurationParameters);
83
- /**
84
- * Check if the given MIME is a JSON MIME.
85
- * JSON MIME examples:
86
- * application/json
87
- * application/json; charset=UTF8
88
- * APPLICATION/JSON
89
- * application/vnd.company+json
90
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
91
- * @return True if the given MIME is JSON, false otherwise.
92
- */
93
- isJsonMime(mime: string): boolean;
94
- }
95
-
96
- /**
97
- * Aignostics Platform API reference
98
- * Pagination is done via `page` and `page_size`. Sorting via `sort` query parameter. The `sort` query parameter can be provided multiple times. The sorting direction can be indicated via `+` (ascending) or `-` (descending) (e.g. `/v1/applications?sort=+name)`.
99
- *
100
- * The version of the OpenAPI document: 1.0.0
101
- *
102
- *
103
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
104
- * https://openapi-generator.tech
105
- * Do not edit the class manually.
106
- */
107
-
108
- /**
109
- *
110
- * @export
111
- * @interface RequestArgs
112
- */
113
- interface RequestArgs {
114
- url: string;
115
- options: RawAxiosRequestConfig;
116
- }
117
- /**
118
- *
119
- * @export
120
- * @class BaseAPI
121
- */
122
- declare class BaseAPI {
123
- protected basePath: string;
124
- protected axios: AxiosInstance;
125
- protected configuration: Configuration | undefined;
126
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
127
- }
128
-
129
- /**
130
- *
131
- * @export
132
- * @interface ApplicationReadResponse
133
- */
134
- interface ApplicationReadResponse {
135
- /**
136
- * Application ID
137
- * @type {string}
138
- * @memberof ApplicationReadResponse
139
- */
140
- 'application_id': string;
141
- /**
142
- * Application display name
143
- * @type {string}
144
- * @memberof ApplicationReadResponse
145
- */
146
- 'name': string;
147
- /**
148
- * Regulatory class, to which the applications compliance
149
- * @type {Array<string>}
150
- * @memberof ApplicationReadResponse
151
- */
152
- 'regulatory_classes': Array<string>;
153
- /**
154
- * Application documentations
155
- * @type {string}
156
- * @memberof ApplicationReadResponse
157
- */
158
- 'description': string;
159
- }
160
- /**
161
- *
162
- * @export
163
- * @enum {string}
164
- */
165
- declare const ApplicationRunStatus: {
166
- readonly CanceledSystem: "CANCELED_SYSTEM";
167
- readonly CanceledUser: "CANCELED_USER";
168
- readonly Completed: "COMPLETED";
169
- readonly CompletedWithError: "COMPLETED_WITH_ERROR";
170
- readonly Received: "RECEIVED";
171
- readonly Rejected: "REJECTED";
172
- readonly Running: "RUNNING";
173
- readonly Scheduled: "SCHEDULED";
174
- };
175
- type ApplicationRunStatus = typeof ApplicationRunStatus[keyof typeof ApplicationRunStatus];
176
- /**
177
- *
178
- * @export
179
- * @interface ApplicationVersionReadResponse
180
- */
181
- interface ApplicationVersionReadResponse {
182
- /**
183
- * Application version ID
184
- * @type {string}
185
- * @memberof ApplicationVersionReadResponse
186
- */
187
- 'application_version_id': string;
188
- /**
189
- * Semantic version of the application
190
- * @type {string}
191
- * @memberof ApplicationVersionReadResponse
192
- */
193
- 'version': string;
194
- /**
195
- * Application ID
196
- * @type {string}
197
- * @memberof ApplicationVersionReadResponse
198
- */
199
- 'application_id': string;
200
- /**
201
- *
202
- * @type {string}
203
- * @memberof ApplicationVersionReadResponse
204
- */
205
- 'flow_id'?: string | null;
206
- /**
207
- * Description of the changes relative to the previous version
208
- * @type {string}
209
- * @memberof ApplicationVersionReadResponse
210
- */
211
- 'changelog': string;
212
- /**
213
- * List of the input fields, provided by the User
214
- * @type {Array<InputArtifactReadResponse>}
215
- * @memberof ApplicationVersionReadResponse
216
- */
217
- 'input_artifacts': Array<InputArtifactReadResponse>;
218
- /**
219
- * List of the output fields, generated by the application
220
- * @type {Array<OutputArtifactReadResponse>}
221
- * @memberof ApplicationVersionReadResponse
222
- */
223
- 'output_artifacts': Array<OutputArtifactReadResponse>;
224
- /**
225
- * The timestamp when the application version was registered
226
- * @type {string}
227
- * @memberof ApplicationVersionReadResponse
228
- */
229
- 'created_at': string;
230
- }
231
- /**
232
- *
233
- * @export
234
- * @interface HTTPValidationError
235
- */
236
- interface HTTPValidationError {
237
- /**
238
- *
239
- * @type {Array<ValidationError>}
240
- * @memberof HTTPValidationError
241
- */
242
- 'detail'?: Array<ValidationError>;
243
- }
244
- /**
245
- *
246
- * @export
247
- * @interface InputArtifactCreationRequest
248
- */
249
- interface InputArtifactCreationRequest {
250
- /**
251
- * The artifact name according to the application version. List of required artifacts is returned by `/v1/versions/{application_version_id}`. The artifact names are located in the `input_artifacts.[].name` value
252
- * @type {string}
253
- * @memberof InputArtifactCreationRequest
254
- */
255
- 'name': string;
256
- /**
257
- * [Signed URL](https://cloud.google.com/cdn/docs/using-signed-urls) to the input artifact file. The URL should be valid for at least 6 days from the payload submission time.
258
- * @type {string}
259
- * @memberof InputArtifactCreationRequest
260
- */
261
- 'download_url': string;
262
- /**
263
- * The metadata of the artifact, required by the application version. The JSON schema of the metadata can be requested by `/v1/versions/{application_version_id}`. The schema is located in `input_artifacts.[].metadata_schema`
264
- * @type {object}
265
- * @memberof InputArtifactCreationRequest
266
- */
267
- 'metadata': object;
268
- }
269
- /**
270
- *
271
- * @export
272
- * @interface InputArtifactReadResponse
273
- */
274
- interface InputArtifactReadResponse {
275
- /**
276
- *
277
- * @type {string}
278
- * @memberof InputArtifactReadResponse
279
- */
280
- 'name': string;
281
- /**
282
- *
283
- * @type {string}
284
- * @memberof InputArtifactReadResponse
285
- */
286
- 'mime_type': string;
287
- /**
288
- *
289
- * @type {object}
290
- * @memberof InputArtifactReadResponse
291
- */
292
- 'metadata_schema': object;
293
- }
294
- /**
295
- *
296
- * @export
297
- * @interface ItemCreationRequest
298
- */
299
- interface ItemCreationRequest {
300
- /**
301
- * The ID of the slide provided by the caller. The reference should be unique across all items of the application run
302
- * @type {string}
303
- * @memberof ItemCreationRequest
304
- */
305
- 'reference': string;
306
- /**
307
- * All the input files of the item, required by the application version
308
- * @type {Array<InputArtifactCreationRequest>}
309
- * @memberof ItemCreationRequest
310
- */
311
- 'input_artifacts': Array<InputArtifactCreationRequest>;
312
- }
313
- /**
314
- *
315
- * @export
316
- * @interface ItemResultReadResponse
317
- */
318
- interface ItemResultReadResponse {
319
- /**
320
- * Item UUID generated by the Platform
321
- * @type {string}
322
- * @memberof ItemResultReadResponse
323
- */
324
- 'item_id': string;
325
- /**
326
- * Application run UUID to which the item belongs
327
- * @type {string}
328
- * @memberof ItemResultReadResponse
329
- */
330
- 'application_run_id': string;
331
- /**
332
- * The reference of the item from the user payload
333
- * @type {string}
334
- * @memberof ItemResultReadResponse
335
- */
336
- 'reference': string;
337
- /**
338
- * When the item is not processed yet, the status is set to `pending`. When the item is successfully finished, status is set to `succeeded`, and the processing results become available for download in `output_artifacts` field. When the item processing is failed because the provided item is invalid, the status is set to `error_user`. When the item processing failed because of the error in the model or platform, the status is set to `error_system`. When the application_run is canceled, the status of all pending items is set to either `cancelled_user` or `cancelled_system`.
339
- * @type {ItemStatus}
340
- * @memberof ItemResultReadResponse
341
- */
342
- 'status': ItemStatus;
343
- /**
344
- *
345
- * @type {string}
346
- * @memberof ItemResultReadResponse
347
- */
348
- 'error': string | null;
349
- /**
350
- * 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.
351
- * @type {Array<OutputArtifactResultReadResponse>}
352
- * @memberof ItemResultReadResponse
353
- */
354
- 'output_artifacts': Array<OutputArtifactResultReadResponse>;
355
- }
356
- /**
357
- *
358
- * @export
359
- * @enum {string}
360
- */
361
- declare const ItemStatus: {
362
- readonly Pending: "PENDING";
363
- readonly CanceledUser: "CANCELED_USER";
364
- readonly CanceledSystem: "CANCELED_SYSTEM";
365
- readonly ErrorUser: "ERROR_USER";
366
- readonly ErrorSystem: "ERROR_SYSTEM";
367
- readonly Succeeded: "SUCCEEDED";
368
- };
369
- type ItemStatus = typeof ItemStatus[keyof typeof ItemStatus];
370
- /**
371
- *
372
- * @export
373
- * @interface MeReadResponse
374
- */
375
- interface MeReadResponse {
376
- /**
377
- *
378
- * @type {UserReadResponse}
379
- * @memberof MeReadResponse
380
- */
381
- 'user': UserReadResponse;
382
- /**
383
- *
384
- * @type {OrganizationReadResponse}
385
- * @memberof MeReadResponse
386
- */
387
- 'organization': OrganizationReadResponse;
388
- }
389
- /**
390
- * This model corresponds to the response schema returned from Auth0 GET /v2/organizations/{id} endpoint, flattens out the metadata out and doesn\'t return branding or token_quota objects. For details, see: https://auth0.com/docs/api/management/v2/organizations/get-organizations-by-id
391
- * @export
392
- * @interface OrganizationReadResponse
393
- */
394
- interface OrganizationReadResponse {
395
- /**
396
- *
397
- * @type {string}
398
- * @memberof OrganizationReadResponse
399
- */
400
- 'id': string;
401
- /**
402
- *
403
- * @type {string}
404
- * @memberof OrganizationReadResponse
405
- */
406
- 'name'?: string | null;
407
- /**
408
- *
409
- * @type {string}
410
- * @memberof OrganizationReadResponse
411
- */
412
- 'display_name'?: string | null;
413
- /**
414
- *
415
- * @type {string}
416
- * @memberof OrganizationReadResponse
417
- */
418
- 'aignostics_bucket_hmac_access_key_id': string;
419
- /**
420
- *
421
- * @type {string}
422
- * @memberof OrganizationReadResponse
423
- */
424
- 'aignostics_bucket_hmac_secret_access_key': string;
425
- /**
426
- *
427
- * @type {string}
428
- * @memberof OrganizationReadResponse
429
- */
430
- 'aignostics_bucket_name': string;
431
- /**
432
- *
433
- * @type {string}
434
- * @memberof OrganizationReadResponse
435
- */
436
- 'aignostics_bucket_protocol': string;
437
- /**
438
- *
439
- * @type {string}
440
- * @memberof OrganizationReadResponse
441
- */
442
- 'aignostics_logfire_token': string;
443
- /**
444
- *
445
- * @type {string}
446
- * @memberof OrganizationReadResponse
447
- */
448
- 'aignostics_sentry_dsn': string;
449
- }
450
- /**
451
- *
452
- * @export
453
- * @interface OutputArtifactReadResponse
454
- */
455
- interface OutputArtifactReadResponse {
456
- /**
457
- *
458
- * @type {string}
459
- * @memberof OutputArtifactReadResponse
460
- */
461
- 'name': string;
462
- /**
463
- *
464
- * @type {string}
465
- * @memberof OutputArtifactReadResponse
466
- */
467
- 'mime_type': string;
468
- /**
469
- *
470
- * @type {object}
471
- * @memberof OutputArtifactReadResponse
472
- */
473
- 'metadata_schema': object;
474
- /**
475
- *
476
- * @type {OutputArtifactScope}
477
- * @memberof OutputArtifactReadResponse
478
- */
479
- 'scope': OutputArtifactScope;
480
- }
481
- /**
482
- *
483
- * @export
484
- * @interface OutputArtifactResultReadResponse
485
- */
486
- interface OutputArtifactResultReadResponse {
487
- /**
488
- * The Id of the artifact. Used internally
489
- * @type {string}
490
- * @memberof OutputArtifactResultReadResponse
491
- */
492
- 'output_artifact_id': string;
493
- /**
494
- * Name of the output from the output schema from the `/v1/versions/{version_id}` endpoint.
495
- * @type {string}
496
- * @memberof OutputArtifactResultReadResponse
497
- */
498
- 'name': string;
499
- /**
500
- * The metadata of the output artifact, provided by the application
501
- * @type {object}
502
- * @memberof OutputArtifactResultReadResponse
503
- */
504
- 'metadata': object;
505
- /**
506
- *
507
- * @type {string}
508
- * @memberof OutputArtifactResultReadResponse
509
- */
510
- 'download_url': string | null;
511
- }
512
- /**
513
- *
514
- * @export
515
- * @enum {string}
516
- */
517
- declare const OutputArtifactScope: {
518
- readonly Item: "ITEM";
519
- readonly Global: "GLOBAL";
520
- };
521
- type OutputArtifactScope = typeof OutputArtifactScope[keyof typeof OutputArtifactScope];
522
- /**
523
- *
524
- * @export
525
- * @interface PayloadInputArtifact
526
- */
527
- interface PayloadInputArtifact {
528
- /**
529
- *
530
- * @type {string}
531
- * @memberof PayloadInputArtifact
532
- */
533
- 'input_artifact_id'?: string;
534
- /**
535
- *
536
- * @type {object}
537
- * @memberof PayloadInputArtifact
538
- */
539
- 'metadata': object;
540
- /**
541
- *
542
- * @type {string}
543
- * @memberof PayloadInputArtifact
544
- */
545
- 'download_url': string;
546
- }
547
- /**
548
- *
549
- * @export
550
- * @interface PayloadItem
551
- */
552
- interface PayloadItem {
553
- /**
554
- *
555
- * @type {string}
556
- * @memberof PayloadItem
557
- */
558
- 'item_id': string;
559
- /**
560
- *
561
- * @type {{ [key: string]: PayloadInputArtifact; }}
562
- * @memberof PayloadItem
563
- */
564
- 'input_artifacts': {
565
- [key: string]: PayloadInputArtifact;
566
- };
567
- /**
568
- *
569
- * @type {{ [key: string]: PayloadOutputArtifact; }}
570
- * @memberof PayloadItem
571
- */
572
- 'output_artifacts': {
573
- [key: string]: PayloadOutputArtifact;
574
- };
575
- }
576
- /**
577
- *
578
- * @export
579
- * @interface PayloadOutputArtifact
580
- */
581
- interface PayloadOutputArtifact {
582
- /**
583
- *
584
- * @type {string}
585
- * @memberof PayloadOutputArtifact
586
- */
587
- 'output_artifact_id': string;
588
- /**
589
- *
590
- * @type {TransferUrls}
591
- * @memberof PayloadOutputArtifact
592
- */
593
- 'data': TransferUrls;
594
- /**
595
- *
596
- * @type {TransferUrls}
597
- * @memberof PayloadOutputArtifact
598
- */
599
- 'metadata': TransferUrls;
600
- }
601
- /**
602
- * Application run payload. It describes which application version is chosen, and which user data should be processed.
603
- * @export
604
- * @interface RunCreationRequest
605
- */
606
- interface RunCreationRequest {
607
- /**
608
- * Application version ID
609
- * @type {string}
610
- * @memberof RunCreationRequest
611
- */
612
- 'application_version_id': string;
613
- /**
614
- * List of the items to process by the application
615
- * @type {Array<ItemCreationRequest>}
616
- * @memberof RunCreationRequest
617
- */
618
- 'items': Array<ItemCreationRequest>;
619
- }
620
- /**
621
- *
622
- * @export
623
- * @interface RunCreationResponse
624
- */
625
- interface RunCreationResponse {
626
- /**
627
- *
628
- * @type {string}
629
- * @memberof RunCreationResponse
630
- */
631
- 'application_run_id'?: string;
632
- }
633
- /**
634
- *
635
- * @export
636
- * @interface RunReadResponse
637
- */
638
- interface RunReadResponse {
639
- /**
640
- * UUID of the application
641
- * @type {string}
642
- * @memberof RunReadResponse
643
- */
644
- 'application_run_id': string;
645
- /**
646
- * ID of the application version
647
- * @type {string}
648
- * @memberof RunReadResponse
649
- */
650
- 'application_version_id': string;
651
- /**
652
- * Organization of the owner of the application run
653
- * @type {string}
654
- * @memberof RunReadResponse
655
- */
656
- 'organization_id': string;
657
- /**
658
- *
659
- * @type {UserPayload}
660
- * @memberof RunReadResponse
661
- */
662
- 'user_payload'?: UserPayload | null;
663
- /**
664
- * When the application run request is received by the Platform, the `status` of it is set to `received`. Then it is transitioned to `scheduled`, when it is scheduled for the processing. When the application run is scheduled, it will process the input items and generate the result incrementally. As soon as the first result is generated, the state is changed to `running`. The results can be downloaded via `/v1/runs/{run_id}/results` endpoint. When all items are processed and all results are generated, the application status is set to `completed`. If the processing is done, but some items fail, the status is set to `completed_with_error`. When the application run request is rejected by the Platform before scheduling, it is transferred to `rejected`. When the application run reaches the threshold of number of failed items, the whole application run is set to `canceled_system` and the remaining pending items are not processed. When the application run fails, the finished item results are available for download. If the application run is canceled by calling `POST /v1/runs/{run_id}/cancel` endpoint, the processing of the items is stopped, and the application status is set to `cancelled_user`
665
- * @type {ApplicationRunStatus}
666
- * @memberof RunReadResponse
667
- */
668
- 'status': ApplicationRunStatus;
669
- /**
670
- * Timestamp showing when the application run was triggered
671
- * @type {string}
672
- * @memberof RunReadResponse
673
- */
674
- 'triggered_at': string;
675
- /**
676
- * Id of the user who triggered the application run
677
- * @type {string}
678
- * @memberof RunReadResponse
679
- */
680
- 'triggered_by': string;
681
- }
682
- /**
683
- *
684
- * @export
685
- * @interface TransferUrls
686
- */
687
- interface TransferUrls {
688
- /**
689
- *
690
- * @type {string}
691
- * @memberof TransferUrls
692
- */
693
- 'upload_url': string;
694
- /**
695
- *
696
- * @type {string}
697
- * @memberof TransferUrls
698
- */
699
- 'download_url': string;
700
- }
701
- /**
702
- *
703
- * @export
704
- * @interface UserPayload
705
- */
706
- interface UserPayload {
707
- /**
708
- *
709
- * @type {string}
710
- * @memberof UserPayload
711
- */
712
- 'application_id': string;
713
- /**
714
- *
715
- * @type {string}
716
- * @memberof UserPayload
717
- */
718
- 'application_run_id': string;
719
- /**
720
- *
721
- * @type {{ [key: string]: PayloadOutputArtifact; }}
722
- * @memberof UserPayload
723
- */
724
- 'global_output_artifacts': {
725
- [key: string]: PayloadOutputArtifact;
726
- } | null;
727
- /**
728
- *
729
- * @type {Array<PayloadItem>}
730
- * @memberof UserPayload
731
- */
732
- 'items': Array<PayloadItem>;
733
- }
734
- /**
735
- * This model corresponds to the response schema returned from Auth0 GET /v2/users/{id} endpoint. For details, see: https://auth0.com/docs/api/management/v2/users/get-users-by-id
736
- * @export
737
- * @interface UserReadResponse
738
- */
739
- interface UserReadResponse {
740
- /**
741
- *
742
- * @type {string}
743
- * @memberof UserReadResponse
744
- */
745
- 'id': string;
746
- /**
747
- *
748
- * @type {string}
749
- * @memberof UserReadResponse
750
- */
751
- 'email'?: string | null;
752
- /**
753
- *
754
- * @type {boolean}
755
- * @memberof UserReadResponse
756
- */
757
- 'email_verified'?: boolean | null;
758
- /**
759
- *
760
- * @type {string}
761
- * @memberof UserReadResponse
762
- */
763
- 'name'?: string | null;
764
- /**
765
- *
766
- * @type {string}
767
- * @memberof UserReadResponse
768
- */
769
- 'given_name'?: string | null;
770
- /**
771
- *
772
- * @type {string}
773
- * @memberof UserReadResponse
774
- */
775
- 'family_name'?: string | null;
776
- /**
777
- *
778
- * @type {string}
779
- * @memberof UserReadResponse
780
- */
781
- 'nickname'?: string | null;
782
- /**
783
- *
784
- * @type {string}
785
- * @memberof UserReadResponse
786
- */
787
- 'picture'?: string | null;
788
- /**
789
- *
790
- * @type {string}
791
- * @memberof UserReadResponse
792
- */
793
- 'updated_at'?: string | null;
794
- }
795
- /**
796
- *
797
- * @export
798
- * @interface ValidationError
799
- */
800
- interface ValidationError {
801
- /**
802
- *
803
- * @type {Array<ValidationErrorLocInner>}
804
- * @memberof ValidationError
805
- */
806
- 'loc': Array<ValidationErrorLocInner>;
807
- /**
808
- *
809
- * @type {string}
810
- * @memberof ValidationError
811
- */
812
- 'msg': string;
813
- /**
814
- *
815
- * @type {string}
816
- * @memberof ValidationError
817
- */
818
- 'type': string;
819
- }
820
- /**
821
- *
822
- * @export
823
- * @interface ValidationErrorLocInner
824
- */
825
- interface ValidationErrorLocInner {
826
- }
827
- /**
828
- * PublicApi - axios parameter creator
829
- * @export
830
- */
831
- declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
832
- /**
833
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
834
- * @summary Cancel Application Run
835
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
836
- * @param {*} [options] Override http request option.
837
- * @throws {RequiredError}
838
- */
839
- cancelApplicationRunV1RunsApplicationRunIdCancelPost: (applicationRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
840
- /**
841
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
842
- * @summary Create Application Run
843
- * @param {RunCreationRequest} runCreationRequest
844
- * @param {*} [options] Override http request option.
845
- * @throws {RequiredError}
846
- */
847
- createApplicationRunV1RunsPost: (runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
848
- /**
849
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
850
- * @summary Delete Application Run Results
851
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
852
- * @param {*} [options] Override http request option.
853
- * @throws {RequiredError}
854
- */
855
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete: (applicationRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
856
- /**
857
- *
858
- * @summary Get Me
859
- * @param {*} [options] Override http request option.
860
- * @throws {RequiredError}
861
- */
862
- getMeV1MeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
863
- /**
864
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
865
- * @summary Get Run
866
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
867
- * @param {Array<any> | null} [include]
868
- * @param {*} [options] Override http request option.
869
- * @throws {RequiredError}
870
- */
871
- getRunV1RunsApplicationRunIdGet: (applicationRunId: string, include?: Array<any> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
872
- /**
873
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
874
- * @summary List Application Runs
875
- * @param {string | null} [applicationId] Optional application ID filter
876
- * @param {string | null} [applicationVersion] Optional application version filter
877
- * @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
878
- * @param {number} [page]
879
- * @param {number} [pageSize]
880
- * @param {Array<string> | null} [sort]
881
- * @param {*} [options] Override http request option.
882
- * @throws {RequiredError}
883
- */
884
- listApplicationRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, include?: Array<any> | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
885
- /**
886
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
887
- * @summary List Applications
888
- * @param {number} [page]
889
- * @param {number} [pageSize]
890
- * @param {Array<string> | null} [sort]
891
- * @param {*} [options] Override http request option.
892
- * @throws {RequiredError}
893
- */
894
- listApplicationsV1ApplicationsGet: (page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
895
- /**
896
- * Get the list of the results for the run items
897
- * @summary List Run Results
898
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
899
- * @param {Array<string> | null} [itemIdIn] Filter for items ids
900
- * @param {Array<string> | null} [referenceIn] Filter for items by their reference from the input payload
901
- * @param {Array<ItemStatus> | null} [statusIn] Filter for items in certain statuses
902
- * @param {number} [page]
903
- * @param {number} [pageSize]
904
- * @param {Array<string> | null} [sort]
905
- * @param {*} [options] Override http request option.
906
- * @throws {RequiredError}
907
- */
908
- listRunResultsV1RunsApplicationRunIdResultsGet: (applicationRunId: string, itemIdIn?: Array<string> | null, referenceIn?: Array<string> | null, statusIn?: Array<ItemStatus> | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
909
- /**
910
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
911
- * @summary List Versions By Application Id
912
- * @param {string} applicationId
913
- * @param {number} [page]
914
- * @param {number} [pageSize]
915
- * @param {string | null} [version]
916
- * @param {Array<any> | null} [include]
917
- * @param {Array<string> | null} [sort]
918
- * @param {*} [options] Override http request option.
919
- * @throws {RequiredError}
920
- */
921
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet: (applicationId: string, page?: number, pageSize?: number, version?: string | null, include?: Array<any> | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
922
- };
923
- /**
924
- * PublicApi - functional programming interface
925
- * @export
926
- */
927
- declare const PublicApiFp: (configuration?: Configuration) => {
928
- /**
929
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
930
- * @summary Cancel Application Run
931
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
932
- * @param {*} [options] Override http request option.
933
- * @throws {RequiredError}
934
- */
935
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(applicationRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
936
- /**
937
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
938
- * @summary Create Application Run
939
- * @param {RunCreationRequest} runCreationRequest
940
- * @param {*} [options] Override http request option.
941
- * @throws {RequiredError}
942
- */
943
- createApplicationRunV1RunsPost(runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCreationResponse>>;
944
- /**
945
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
946
- * @summary Delete Application Run Results
947
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
948
- * @param {*} [options] Override http request option.
949
- * @throws {RequiredError}
950
- */
951
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(applicationRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
952
- /**
953
- *
954
- * @summary Get Me
955
- * @param {*} [options] Override http request option.
956
- * @throws {RequiredError}
957
- */
958
- getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeReadResponse>>;
959
- /**
960
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
961
- * @summary Get Run
962
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
963
- * @param {Array<any> | null} [include]
964
- * @param {*} [options] Override http request option.
965
- * @throws {RequiredError}
966
- */
967
- getRunV1RunsApplicationRunIdGet(applicationRunId: string, include?: Array<any> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
968
- /**
969
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
970
- * @summary List Application Runs
971
- * @param {string | null} [applicationId] Optional application ID filter
972
- * @param {string | null} [applicationVersion] Optional application version filter
973
- * @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
974
- * @param {number} [page]
975
- * @param {number} [pageSize]
976
- * @param {Array<string> | null} [sort]
977
- * @param {*} [options] Override http request option.
978
- * @throws {RequiredError}
979
- */
980
- listApplicationRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, include?: Array<any> | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
981
- /**
982
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
983
- * @summary List Applications
984
- * @param {number} [page]
985
- * @param {number} [pageSize]
986
- * @param {Array<string> | null} [sort]
987
- * @param {*} [options] Override http request option.
988
- * @throws {RequiredError}
989
- */
990
- listApplicationsV1ApplicationsGet(page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationReadResponse>>>;
991
- /**
992
- * Get the list of the results for the run items
993
- * @summary List Run Results
994
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
995
- * @param {Array<string> | null} [itemIdIn] Filter for items ids
996
- * @param {Array<string> | null} [referenceIn] Filter for items by their reference from the input payload
997
- * @param {Array<ItemStatus> | null} [statusIn] Filter for items in certain statuses
998
- * @param {number} [page]
999
- * @param {number} [pageSize]
1000
- * @param {Array<string> | null} [sort]
1001
- * @param {*} [options] Override http request option.
1002
- * @throws {RequiredError}
1003
- */
1004
- listRunResultsV1RunsApplicationRunIdResultsGet(applicationRunId: string, itemIdIn?: Array<string> | null, referenceIn?: Array<string> | null, statusIn?: Array<ItemStatus> | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemResultReadResponse>>>;
1005
- /**
1006
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
1007
- * @summary List Versions By Application Id
1008
- * @param {string} applicationId
1009
- * @param {number} [page]
1010
- * @param {number} [pageSize]
1011
- * @param {string | null} [version]
1012
- * @param {Array<any> | null} [include]
1013
- * @param {Array<string> | null} [sort]
1014
- * @param {*} [options] Override http request option.
1015
- * @throws {RequiredError}
1016
- */
1017
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(applicationId: string, page?: number, pageSize?: number, version?: string | null, include?: Array<any> | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationVersionReadResponse>>>;
1018
- };
1019
- /**
1020
- * PublicApi - factory interface
1021
- * @export
1022
- */
1023
- declare const PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1024
- /**
1025
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1026
- * @summary Cancel Application Run
1027
- * @param {PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest} requestParameters Request parameters.
1028
- * @param {*} [options] Override http request option.
1029
- * @throws {RequiredError}
1030
- */
1031
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters: PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1032
- /**
1033
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1034
- * @summary Create Application Run
1035
- * @param {PublicApiCreateApplicationRunV1RunsPostRequest} requestParameters Request parameters.
1036
- * @param {*} [options] Override http request option.
1037
- * @throws {RequiredError}
1038
- */
1039
- createApplicationRunV1RunsPost(requestParameters: PublicApiCreateApplicationRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
1040
- /**
1041
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
1042
- * @summary Delete Application Run Results
1043
- * @param {PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest} requestParameters Request parameters.
1044
- * @param {*} [options] Override http request option.
1045
- * @throws {RequiredError}
1046
- */
1047
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters: PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1048
- /**
1049
- *
1050
- * @summary Get Me
1051
- * @param {*} [options] Override http request option.
1052
- * @throws {RequiredError}
1053
- */
1054
- getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
1055
- /**
1056
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
1057
- * @summary Get Run
1058
- * @param {PublicApiGetRunV1RunsApplicationRunIdGetRequest} requestParameters Request parameters.
1059
- * @param {*} [options] Override http request option.
1060
- * @throws {RequiredError}
1061
- */
1062
- getRunV1RunsApplicationRunIdGet(requestParameters: PublicApiGetRunV1RunsApplicationRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
1063
- /**
1064
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
1065
- * @summary List Application Runs
1066
- * @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
1067
- * @param {*} [options] Override http request option.
1068
- * @throws {RequiredError}
1069
- */
1070
- listApplicationRunsV1RunsGet(requestParameters?: PublicApiListApplicationRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
1071
- /**
1072
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
1073
- * @summary List Applications
1074
- * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1075
- * @param {*} [options] Override http request option.
1076
- * @throws {RequiredError}
1077
- */
1078
- listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadResponse>>;
1079
- /**
1080
- * Get the list of the results for the run items
1081
- * @summary List Run Results
1082
- * @param {PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest} requestParameters Request parameters.
1083
- * @param {*} [options] Override http request option.
1084
- * @throws {RequiredError}
1085
- */
1086
- listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters: PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
1087
- /**
1088
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
1089
- * @summary List Versions By Application Id
1090
- * @param {PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest} requestParameters Request parameters.
1091
- * @param {*} [options] Override http request option.
1092
- * @throws {RequiredError}
1093
- */
1094
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters: PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationVersionReadResponse>>;
1095
- };
1096
- /**
1097
- * PublicApi - interface
1098
- * @export
1099
- * @interface PublicApi
1100
- */
1101
- interface PublicApiInterface {
1102
- /**
1103
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1104
- * @summary Cancel Application Run
1105
- * @param {PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest} requestParameters Request parameters.
1106
- * @param {*} [options] Override http request option.
1107
- * @throws {RequiredError}
1108
- * @memberof PublicApiInterface
1109
- */
1110
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters: PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1111
- /**
1112
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1113
- * @summary Create Application Run
1114
- * @param {PublicApiCreateApplicationRunV1RunsPostRequest} requestParameters Request parameters.
1115
- * @param {*} [options] Override http request option.
1116
- * @throws {RequiredError}
1117
- * @memberof PublicApiInterface
1118
- */
1119
- createApplicationRunV1RunsPost(requestParameters: PublicApiCreateApplicationRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
1120
- /**
1121
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
1122
- * @summary Delete Application Run Results
1123
- * @param {PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest} requestParameters Request parameters.
1124
- * @param {*} [options] Override http request option.
1125
- * @throws {RequiredError}
1126
- * @memberof PublicApiInterface
1127
- */
1128
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters: PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1129
- /**
1130
- *
1131
- * @summary Get Me
1132
- * @param {*} [options] Override http request option.
1133
- * @throws {RequiredError}
1134
- * @memberof PublicApiInterface
1135
- */
1136
- getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
1137
- /**
1138
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
1139
- * @summary Get Run
1140
- * @param {PublicApiGetRunV1RunsApplicationRunIdGetRequest} requestParameters Request parameters.
1141
- * @param {*} [options] Override http request option.
1142
- * @throws {RequiredError}
1143
- * @memberof PublicApiInterface
1144
- */
1145
- getRunV1RunsApplicationRunIdGet(requestParameters: PublicApiGetRunV1RunsApplicationRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
1146
- /**
1147
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
1148
- * @summary List Application Runs
1149
- * @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
1150
- * @param {*} [options] Override http request option.
1151
- * @throws {RequiredError}
1152
- * @memberof PublicApiInterface
1153
- */
1154
- listApplicationRunsV1RunsGet(requestParameters?: PublicApiListApplicationRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
1155
- /**
1156
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
1157
- * @summary List Applications
1158
- * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1159
- * @param {*} [options] Override http request option.
1160
- * @throws {RequiredError}
1161
- * @memberof PublicApiInterface
1162
- */
1163
- listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadResponse>>;
1164
- /**
1165
- * Get the list of the results for the run items
1166
- * @summary List Run Results
1167
- * @param {PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest} requestParameters Request parameters.
1168
- * @param {*} [options] Override http request option.
1169
- * @throws {RequiredError}
1170
- * @memberof PublicApiInterface
1171
- */
1172
- listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters: PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
1173
- /**
1174
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
1175
- * @summary List Versions By Application Id
1176
- * @param {PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest} requestParameters Request parameters.
1177
- * @param {*} [options] Override http request option.
1178
- * @throws {RequiredError}
1179
- * @memberof PublicApiInterface
1180
- */
1181
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters: PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationVersionReadResponse>>;
1182
- }
1183
- /**
1184
- * Request parameters for cancelApplicationRunV1RunsApplicationRunIdCancelPost operation in PublicApi.
1185
- * @export
1186
- * @interface PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest
1187
- */
1188
- interface PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest {
1189
- /**
1190
- * Application run id, returned by &#x60;POST /runs/&#x60; endpoint
1191
- * @type {string}
1192
- * @memberof PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPost
1193
- */
1194
- readonly applicationRunId: string;
1195
- }
1196
- /**
1197
- * Request parameters for createApplicationRunV1RunsPost operation in PublicApi.
1198
- * @export
1199
- * @interface PublicApiCreateApplicationRunV1RunsPostRequest
1200
- */
1201
- interface PublicApiCreateApplicationRunV1RunsPostRequest {
1202
- /**
1203
- *
1204
- * @type {RunCreationRequest}
1205
- * @memberof PublicApiCreateApplicationRunV1RunsPost
1206
- */
1207
- readonly runCreationRequest: RunCreationRequest;
1208
- }
1209
- /**
1210
- * Request parameters for deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete operation in PublicApi.
1211
- * @export
1212
- * @interface PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest
1213
- */
1214
- interface PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest {
1215
- /**
1216
- * Application run id, returned by &#x60;POST /runs/&#x60; endpoint
1217
- * @type {string}
1218
- * @memberof PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete
1219
- */
1220
- readonly applicationRunId: string;
1221
- }
1222
- /**
1223
- * Request parameters for getRunV1RunsApplicationRunIdGet operation in PublicApi.
1224
- * @export
1225
- * @interface PublicApiGetRunV1RunsApplicationRunIdGetRequest
1226
- */
1227
- interface PublicApiGetRunV1RunsApplicationRunIdGetRequest {
1228
- /**
1229
- * Application run id, returned by &#x60;POST /runs/&#x60; endpoint
1230
- * @type {string}
1231
- * @memberof PublicApiGetRunV1RunsApplicationRunIdGet
1232
- */
1233
- readonly applicationRunId: string;
1234
- /**
1235
- *
1236
- * @type {Array<any>}
1237
- * @memberof PublicApiGetRunV1RunsApplicationRunIdGet
1238
- */
1239
- readonly include?: Array<any> | null;
1240
- }
1241
- /**
1242
- * Request parameters for listApplicationRunsV1RunsGet operation in PublicApi.
1243
- * @export
1244
- * @interface PublicApiListApplicationRunsV1RunsGetRequest
1245
- */
1246
- interface PublicApiListApplicationRunsV1RunsGetRequest {
1247
- /**
1248
- * Optional application ID filter
1249
- * @type {string}
1250
- * @memberof PublicApiListApplicationRunsV1RunsGet
1251
- */
1252
- readonly applicationId?: string | null;
1253
- /**
1254
- * Optional application version filter
1255
- * @type {string}
1256
- * @memberof PublicApiListApplicationRunsV1RunsGet
1257
- */
1258
- readonly applicationVersion?: string | null;
1259
- /**
1260
- * Request optional output values. Used internally by the platform
1261
- * @type {Array<any>}
1262
- * @memberof PublicApiListApplicationRunsV1RunsGet
1263
- */
1264
- readonly include?: Array<any> | null;
1265
- /**
1266
- *
1267
- * @type {number}
1268
- * @memberof PublicApiListApplicationRunsV1RunsGet
1269
- */
1270
- readonly page?: number;
1271
- /**
1272
- *
1273
- * @type {number}
1274
- * @memberof PublicApiListApplicationRunsV1RunsGet
1275
- */
1276
- readonly pageSize?: number;
1277
- /**
1278
- *
1279
- * @type {Array<string>}
1280
- * @memberof PublicApiListApplicationRunsV1RunsGet
1281
- */
1282
- readonly sort?: Array<string> | null;
1283
- }
1284
- /**
1285
- * Request parameters for listApplicationsV1ApplicationsGet operation in PublicApi.
1286
- * @export
1287
- * @interface PublicApiListApplicationsV1ApplicationsGetRequest
1288
- */
1289
- interface PublicApiListApplicationsV1ApplicationsGetRequest {
1290
- /**
1291
- *
1292
- * @type {number}
1293
- * @memberof PublicApiListApplicationsV1ApplicationsGet
1294
- */
1295
- readonly page?: number;
1296
- /**
1297
- *
1298
- * @type {number}
1299
- * @memberof PublicApiListApplicationsV1ApplicationsGet
1300
- */
1301
- readonly pageSize?: number;
1302
- /**
1303
- *
1304
- * @type {Array<string>}
1305
- * @memberof PublicApiListApplicationsV1ApplicationsGet
1306
- */
1307
- readonly sort?: Array<string> | null;
1308
- }
1309
- /**
1310
- * Request parameters for listRunResultsV1RunsApplicationRunIdResultsGet operation in PublicApi.
1311
- * @export
1312
- * @interface PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest
1313
- */
1314
- interface PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest {
1315
- /**
1316
- * Application run id, returned by &#x60;POST /runs/&#x60; endpoint
1317
- * @type {string}
1318
- * @memberof PublicApiListRunResultsV1RunsApplicationRunIdResultsGet
1319
- */
1320
- readonly applicationRunId: string;
1321
- /**
1322
- * Filter for items ids
1323
- * @type {Array<string>}
1324
- * @memberof PublicApiListRunResultsV1RunsApplicationRunIdResultsGet
1325
- */
1326
- readonly itemIdIn?: Array<string> | null;
1327
- /**
1328
- * Filter for items by their reference from the input payload
1329
- * @type {Array<string>}
1330
- * @memberof PublicApiListRunResultsV1RunsApplicationRunIdResultsGet
1331
- */
1332
- readonly referenceIn?: Array<string> | null;
1333
- /**
1334
- * Filter for items in certain statuses
1335
- * @type {Array<ItemStatus>}
1336
- * @memberof PublicApiListRunResultsV1RunsApplicationRunIdResultsGet
1337
- */
1338
- readonly statusIn?: Array<ItemStatus> | null;
1339
- /**
1340
- *
1341
- * @type {number}
1342
- * @memberof PublicApiListRunResultsV1RunsApplicationRunIdResultsGet
1343
- */
1344
- readonly page?: number;
1345
- /**
1346
- *
1347
- * @type {number}
1348
- * @memberof PublicApiListRunResultsV1RunsApplicationRunIdResultsGet
1349
- */
1350
- readonly pageSize?: number;
1351
- /**
1352
- *
1353
- * @type {Array<string>}
1354
- * @memberof PublicApiListRunResultsV1RunsApplicationRunIdResultsGet
1355
- */
1356
- readonly sort?: Array<string> | null;
1357
- }
1358
- /**
1359
- * Request parameters for listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet operation in PublicApi.
1360
- * @export
1361
- * @interface PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest
1362
- */
1363
- interface PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest {
1364
- /**
1365
- *
1366
- * @type {string}
1367
- * @memberof PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet
1368
- */
1369
- readonly applicationId: string;
1370
- /**
1371
- *
1372
- * @type {number}
1373
- * @memberof PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet
1374
- */
1375
- readonly page?: number;
1376
- /**
1377
- *
1378
- * @type {number}
1379
- * @memberof PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet
1380
- */
1381
- readonly pageSize?: number;
1382
- /**
1383
- *
1384
- * @type {string}
1385
- * @memberof PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet
1386
- */
1387
- readonly version?: string | null;
1388
- /**
1389
- *
1390
- * @type {Array<any>}
1391
- * @memberof PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet
1392
- */
1393
- readonly include?: Array<any> | null;
1394
- /**
1395
- *
1396
- * @type {Array<string>}
1397
- * @memberof PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet
1398
- */
1399
- readonly sort?: Array<string> | null;
1400
- }
1401
- /**
1402
- * PublicApi - object-oriented interface
1403
- * @export
1404
- * @class PublicApi
1405
- * @extends {BaseAPI}
1406
- */
1407
- declare class PublicApi extends BaseAPI implements PublicApiInterface {
1408
- /**
1409
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
1410
- * @summary Cancel Application Run
1411
- * @param {PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest} requestParameters Request parameters.
1412
- * @param {*} [options] Override http request option.
1413
- * @throws {RequiredError}
1414
- * @memberof PublicApi
1415
- */
1416
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters: PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any>>;
1417
- /**
1418
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
1419
- * @summary Create Application Run
1420
- * @param {PublicApiCreateApplicationRunV1RunsPostRequest} requestParameters Request parameters.
1421
- * @param {*} [options] Override http request option.
1422
- * @throws {RequiredError}
1423
- * @memberof PublicApi
1424
- */
1425
- createApplicationRunV1RunsPost(requestParameters: PublicApiCreateApplicationRunV1RunsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunCreationResponse, any>>;
1426
- /**
1427
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
1428
- * @summary Delete Application Run Results
1429
- * @param {PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest} requestParameters Request parameters.
1430
- * @param {*} [options] Override http request option.
1431
- * @throws {RequiredError}
1432
- * @memberof PublicApi
1433
- */
1434
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters: PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any>>;
1435
- /**
1436
- *
1437
- * @summary Get Me
1438
- * @param {*} [options] Override http request option.
1439
- * @throws {RequiredError}
1440
- * @memberof PublicApi
1441
- */
1442
- getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MeReadResponse, any>>;
1443
- /**
1444
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
1445
- * @summary Get Run
1446
- * @param {PublicApiGetRunV1RunsApplicationRunIdGetRequest} requestParameters Request parameters.
1447
- * @param {*} [options] Override http request option.
1448
- * @throws {RequiredError}
1449
- * @memberof PublicApi
1450
- */
1451
- getRunV1RunsApplicationRunIdGet(requestParameters: PublicApiGetRunV1RunsApplicationRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any>>;
1452
- /**
1453
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
1454
- * @summary List Application Runs
1455
- * @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
1456
- * @param {*} [options] Override http request option.
1457
- * @throws {RequiredError}
1458
- * @memberof PublicApi
1459
- */
1460
- listApplicationRunsV1RunsGet(requestParameters?: PublicApiListApplicationRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any>>;
1461
- /**
1462
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
1463
- * @summary List Applications
1464
- * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1465
- * @param {*} [options] Override http request option.
1466
- * @throws {RequiredError}
1467
- * @memberof PublicApi
1468
- */
1469
- listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse[], any>>;
1470
- /**
1471
- * Get the list of the results for the run items
1472
- * @summary List Run Results
1473
- * @param {PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest} requestParameters Request parameters.
1474
- * @param {*} [options] Override http request option.
1475
- * @throws {RequiredError}
1476
- * @memberof PublicApi
1477
- */
1478
- listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters: PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ItemResultReadResponse[], any>>;
1479
- /**
1480
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
1481
- * @summary List Versions By Application Id
1482
- * @param {PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest} requestParameters Request parameters.
1483
- * @param {*} [options] Override http request option.
1484
- * @throws {RequiredError}
1485
- * @memberof PublicApi
1486
- */
1487
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters: PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationVersionReadResponse[], any>>;
1488
- }
1
+ import { A as ApplicationReadShortResponse, a as ApplicationReadResponse, R as RunReadResponse, b as RunCreationRequest, c as RunCreationResponse, I as ItemResultReadResponse } from './api-3iWGLFaA.cjs';
2
+ export { d as ApplicationVersion, e as ArtifactOutput, f as ArtifactState, g as ArtifactTerminationReason, Y as Configuration, X as ConfigurationParameters, C as CustomMetadataUpdateRequest, H as HTTPValidationError, h as InputArtifact, i as InputArtifactCreationRequest, j as ItemCreationRequest, k as ItemOutput, l as ItemState, m as ItemTerminationReason, M as MeReadResponse, O as OrganizationReadResponse, n as OutputArtifact, o as OutputArtifactResultReadResponse, p as OutputArtifactScope, q as OutputArtifactVisibility, W as PublicApi, B as PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, P as PublicApiAxiosParamCreator, D as PublicApiCancelRunV1RunsRunIdCancelPostRequest, E as PublicApiCreateRunV1RunsPostRequest, F as PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, y as PublicApiFactory, x as PublicApiFp, G as PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, J as PublicApiGetRunV1RunsRunIdGetRequest, z as PublicApiInterface, K as PublicApiListApplicationsV1ApplicationsGetRequest, L as PublicApiListRunItemsV1RunsRunIdItemsGetRequest, N as PublicApiListRunsV1RunsGetRequest, Q as PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, S as PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, T as PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, r as RunItemStatistics, s as RunOutput, t as RunState, u as RunTerminationReason, U as UserReadResponse, V as ValidationError, v as ValidationErrorLocInner, w as VersionReadResponse } from './api-3iWGLFaA.cjs';
3
+ import 'axios';
1489
4
 
1490
5
  /**
1491
6
  * Token provider function that returns a valid access token
@@ -1513,8 +28,8 @@ interface PlatformSDK {
1513
28
  getVersion(): string;
1514
29
  getConfig(): PlatformSDKConfig;
1515
30
  testConnection(): Promise<boolean>;
1516
- listApplications(): Promise<ApplicationReadResponse[]>;
1517
- listApplicationVersions(applicationId: string): Promise<ApplicationVersionReadResponse[]>;
31
+ listApplications(): Promise<ApplicationReadShortResponse[]>;
32
+ getApplication(applicationId: string): Promise<ApplicationReadResponse>;
1518
33
  listApplicationRuns(options?: {
1519
34
  applicationId?: string;
1520
35
  applicationVersion?: string;
@@ -1584,35 +99,38 @@ declare class PlatformSDKHttp implements PlatformSDK {
1584
99
  * }
1585
100
  * ```
1586
101
  */
1587
- listApplications(): Promise<ApplicationReadResponse[]>;
102
+ listApplications(): Promise<ApplicationReadShortResponse[]>;
1588
103
  /**
1589
- * Retrieve all versions of a specific application
104
+ * Retrieve detailed information about a specific application
1590
105
  *
1591
- * This method fetches all available versions for a given application ID.
1592
- * Application versions represent different iterations or configurations of
1593
- * an AI model, allowing you to choose specific versions for processing.
106
+ * This method fetches comprehensive details about an application, including
107
+ * its name, description, regulatory classes, and all available versions.
108
+ * This provides more detailed information compared to the summary returned
109
+ * by `listApplications()`.
1594
110
  *
1595
- * @param applicationId - The unique identifier of the application
1596
- * @returns A promise that resolves to an array of application version objects
1597
- * @throws {AuthenticationError} If no valid authentication token is available
1598
- * @throws {Error} If the request fails due to network issues, invalid application ID, or API errors
111
+ * @param applicationId - The unique identifier of the application to retrieve
112
+ * @returns A promise that resolves to the complete application details
113
+ * @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID, or API errors
1599
114
  *
1600
115
  * @example
1601
116
  * ```typescript
1602
117
  * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
1603
118
  *
1604
119
  * try {
1605
- * const versions = await sdk.listApplicationVersions('app-123');
1606
- * console.log(`Found ${versions.length} versions for application`);
1607
- * versions.forEach(version => {
1608
- * console.log(`- Version ${version.version} (ID: ${version.id})`);
120
+ * const application = await sdk.getApplication('app-123');
121
+ * console.log(`Application: ${application.name}`);
122
+ * console.log(`Description: ${application.description}`);
123
+ * console.log(`Available versions: ${application.versions.length}`);
124
+ *
125
+ * application.versions.forEach(version => {
126
+ * console.log(`- ${version.version} (ID: ${version.application_version_id})`);
1609
127
  * });
1610
128
  * } catch (error) {
1611
- * console.error('Failed to list application versions:', error.message);
129
+ * console.error('Failed to get application details:', error.message);
1612
130
  * }
1613
131
  * ```
1614
132
  */
1615
- listApplicationVersions(applicationId: string): Promise<ApplicationVersionReadResponse[]>;
133
+ getApplication(applicationId: string): Promise<ApplicationReadResponse>;
1616
134
  /**
1617
135
  * Retrieve a list of application runs with optional filtering
1618
136
  *
@@ -1906,4 +424,4 @@ declare class ConfigurationError extends BaseError {
1906
424
  constructor(message: string, options?: BaseErrorOptions);
1907
425
  }
1908
426
 
1909
- export { APIError, type ApplicationReadResponse, ApplicationRunStatus, type ApplicationVersionReadResponse, AuthenticationError, BaseError, Configuration, ConfigurationError, type ConfigurationParameters, type HTTPValidationError, type InputArtifactCreationRequest, type InputArtifactReadResponse, type ItemCreationRequest, type ItemResultReadResponse, ItemStatus, type MeReadResponse, type OrganizationReadResponse, type OutputArtifactReadResponse, type OutputArtifactResultReadResponse, OutputArtifactScope, type PayloadInputArtifact, type PayloadItem, type PayloadOutputArtifact, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, PublicApi, PublicApiAxiosParamCreator, type PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest, type PublicApiCreateApplicationRunV1RunsPostRequest, type PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest, PublicApiFactory, PublicApiFp, type PublicApiGetRunV1RunsApplicationRunIdGetRequest, type PublicApiInterface, type PublicApiListApplicationRunsV1RunsGetRequest, type PublicApiListApplicationsV1ApplicationsGetRequest, type PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest, type PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest, type RunCreationRequest, type RunCreationResponse, type RunReadResponse, type TokenProvider, type TransferUrls, type UserPayload, type UserReadResponse, type ValidationError, type ValidationErrorLocInner, PlatformSDKHttp as default };
427
+ export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, PlatformSDKHttp as default };