@aignostics/sdk 3.0.0 → 3.1.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.1.0.tgz +0 -0
- package/dist/{api-3iWGLFaA.d.cts → api-CZ17GBr_.d.cts} +108 -71
- package/dist/{api-3iWGLFaA.d.ts → api-CZ17GBr_.d.ts} +108 -71
- package/dist/index.cjs +87 -47
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +33 -3
- package/dist/index.d.ts +33 -3
- package/dist/index.js +87 -47
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +58 -0
- package/dist/test-utils/http-mocks.cjs.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +5 -1
- package/dist/test-utils/http-mocks.d.ts +5 -1
- package/dist/test-utils/http-mocks.js +58 -0
- package/dist/test-utils/http-mocks.js.map +1 -1
- package/package.json +1 -1
- package/dist/aignostics-sdk-3.0.0.tgz +0 -0
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as ApplicationReadShortResponse, a as ApplicationReadResponse, R as RunReadResponse, b as RunCreationRequest, c as RunCreationResponse, I as ItemResultReadResponse } from './api-
|
|
2
|
-
export { d as ApplicationVersion, e as ArtifactOutput, f as ArtifactState, g as ArtifactTerminationReason,
|
|
1
|
+
import { A as ApplicationReadShortResponse, a as ApplicationReadResponse, R as RunReadResponse, b as RunCreationRequest, c as RunCreationResponse, I as ItemResultReadResponse, V as VersionReadResponse } from './api-CZ17GBr_.cjs';
|
|
2
|
+
export { d as ApplicationVersion, e as ArtifactOutput, f as ArtifactState, g as ArtifactTerminationReason, Z as Configuration, Y as ConfigurationParameters, C as CustomMetadataUpdateRequest, h as CustomMetadataUpdateResponse, H as HTTPValidationError, i as InputArtifact, j as InputArtifactCreationRequest, k as ItemCreationRequest, l as ItemOutput, m as ItemState, n as ItemTerminationReason, M as MeReadResponse, O as OrganizationReadResponse, o as OutputArtifact, p as OutputArtifactResultReadResponse, q as OutputArtifactScope, r as OutputArtifactVisibility, X as PublicApi, D as PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, P as PublicApiAxiosParamCreator, E as PublicApiCancelRunV1RunsRunIdCancelPostRequest, F as PublicApiCreateRunV1RunsPostRequest, G as PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, z as PublicApiFactory, y as PublicApiFp, J as PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, K as PublicApiGetRunV1RunsRunIdGetRequest, B as PublicApiInterface, L as PublicApiListApplicationsV1ApplicationsGetRequest, N as PublicApiListRunItemsV1RunsRunIdItemsGetRequest, Q as PublicApiListRunsV1RunsGetRequest, S as PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, T as PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, W as PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, s as RunItemStatistics, t as RunOutput, u as RunState, v as RunTerminationReason, U as UserReadResponse, w as ValidationError, x as ValidationErrorLocInner } from './api-CZ17GBr_.cjs';
|
|
3
3
|
import 'axios';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -38,6 +38,7 @@ interface PlatformSDK {
|
|
|
38
38
|
getRun(applicationRunId: string): Promise<RunReadResponse>;
|
|
39
39
|
cancelApplicationRun(applicationRunId: string): Promise<void>;
|
|
40
40
|
listRunResults(applicationRunId: string): Promise<ItemResultReadResponse[]>;
|
|
41
|
+
getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
|
|
41
42
|
}
|
|
42
43
|
/**
|
|
43
44
|
* Main SDK class for interacting with the Aignostics Platform
|
|
@@ -100,6 +101,33 @@ declare class PlatformSDKHttp implements PlatformSDK {
|
|
|
100
101
|
* ```
|
|
101
102
|
*/
|
|
102
103
|
listApplications(): Promise<ApplicationReadShortResponse[]>;
|
|
104
|
+
/**
|
|
105
|
+
* Retrieve detailed information about a specific application version
|
|
106
|
+
*
|
|
107
|
+
* This method fetches comprehensive details about a specific version of an
|
|
108
|
+
* application, including its changelog, release date, and any version-specific
|
|
109
|
+
* configurations or features.
|
|
110
|
+
*
|
|
111
|
+
* @param applicationId - The unique identifier of the application
|
|
112
|
+
* @param version - The version string of the application to retrieve
|
|
113
|
+
* @returns A promise that resolves to the application version details
|
|
114
|
+
* @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID or version, or API errors
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```typescript
|
|
118
|
+
* const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
|
|
119
|
+
*
|
|
120
|
+
* try {
|
|
121
|
+
* const appVersion = await sdk.getApplicationVersionDetails('app-123', 'v1.2.0');
|
|
122
|
+
* console.log(`Application Version: ${appVersion.version}`);
|
|
123
|
+
* console.log(`Release Date: ${appVersion.release_date}`);
|
|
124
|
+
* console.log(`Changelog: ${appVersion.changelog}`);
|
|
125
|
+
* } catch (error) {
|
|
126
|
+
* console.error('Failed to get application version details:', error.message);
|
|
127
|
+
* }
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
|
|
103
131
|
/**
|
|
104
132
|
* Retrieve detailed information about a specific application
|
|
105
133
|
*
|
|
@@ -172,6 +200,8 @@ declare class PlatformSDKHttp implements PlatformSDK {
|
|
|
172
200
|
listApplicationRuns(options?: {
|
|
173
201
|
applicationId?: string;
|
|
174
202
|
applicationVersion?: string;
|
|
203
|
+
customMetadata?: string;
|
|
204
|
+
sort?: string[];
|
|
175
205
|
}): Promise<RunReadResponse[]>;
|
|
176
206
|
/**
|
|
177
207
|
* Create and submit a new application run for processing
|
|
@@ -424,4 +454,4 @@ declare class ConfigurationError extends BaseError {
|
|
|
424
454
|
constructor(message: string, options?: BaseErrorOptions);
|
|
425
455
|
}
|
|
426
456
|
|
|
427
|
-
export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, PlatformSDKHttp as default };
|
|
457
|
+
export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, VersionReadResponse, PlatformSDKHttp as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as ApplicationReadShortResponse, a as ApplicationReadResponse, R as RunReadResponse, b as RunCreationRequest, c as RunCreationResponse, I as ItemResultReadResponse } from './api-
|
|
2
|
-
export { d as ApplicationVersion, e as ArtifactOutput, f as ArtifactState, g as ArtifactTerminationReason,
|
|
1
|
+
import { A as ApplicationReadShortResponse, a as ApplicationReadResponse, R as RunReadResponse, b as RunCreationRequest, c as RunCreationResponse, I as ItemResultReadResponse, V as VersionReadResponse } from './api-CZ17GBr_.js';
|
|
2
|
+
export { d as ApplicationVersion, e as ArtifactOutput, f as ArtifactState, g as ArtifactTerminationReason, Z as Configuration, Y as ConfigurationParameters, C as CustomMetadataUpdateRequest, h as CustomMetadataUpdateResponse, H as HTTPValidationError, i as InputArtifact, j as InputArtifactCreationRequest, k as ItemCreationRequest, l as ItemOutput, m as ItemState, n as ItemTerminationReason, M as MeReadResponse, O as OrganizationReadResponse, o as OutputArtifact, p as OutputArtifactResultReadResponse, q as OutputArtifactScope, r as OutputArtifactVisibility, X as PublicApi, D as PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, P as PublicApiAxiosParamCreator, E as PublicApiCancelRunV1RunsRunIdCancelPostRequest, F as PublicApiCreateRunV1RunsPostRequest, G as PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, z as PublicApiFactory, y as PublicApiFp, J as PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, K as PublicApiGetRunV1RunsRunIdGetRequest, B as PublicApiInterface, L as PublicApiListApplicationsV1ApplicationsGetRequest, N as PublicApiListRunItemsV1RunsRunIdItemsGetRequest, Q as PublicApiListRunsV1RunsGetRequest, S as PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, T as PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, W as PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, s as RunItemStatistics, t as RunOutput, u as RunState, v as RunTerminationReason, U as UserReadResponse, w as ValidationError, x as ValidationErrorLocInner } from './api-CZ17GBr_.js';
|
|
3
3
|
import 'axios';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -38,6 +38,7 @@ interface PlatformSDK {
|
|
|
38
38
|
getRun(applicationRunId: string): Promise<RunReadResponse>;
|
|
39
39
|
cancelApplicationRun(applicationRunId: string): Promise<void>;
|
|
40
40
|
listRunResults(applicationRunId: string): Promise<ItemResultReadResponse[]>;
|
|
41
|
+
getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
|
|
41
42
|
}
|
|
42
43
|
/**
|
|
43
44
|
* Main SDK class for interacting with the Aignostics Platform
|
|
@@ -100,6 +101,33 @@ declare class PlatformSDKHttp implements PlatformSDK {
|
|
|
100
101
|
* ```
|
|
101
102
|
*/
|
|
102
103
|
listApplications(): Promise<ApplicationReadShortResponse[]>;
|
|
104
|
+
/**
|
|
105
|
+
* Retrieve detailed information about a specific application version
|
|
106
|
+
*
|
|
107
|
+
* This method fetches comprehensive details about a specific version of an
|
|
108
|
+
* application, including its changelog, release date, and any version-specific
|
|
109
|
+
* configurations or features.
|
|
110
|
+
*
|
|
111
|
+
* @param applicationId - The unique identifier of the application
|
|
112
|
+
* @param version - The version string of the application to retrieve
|
|
113
|
+
* @returns A promise that resolves to the application version details
|
|
114
|
+
* @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID or version, or API errors
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```typescript
|
|
118
|
+
* const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
|
|
119
|
+
*
|
|
120
|
+
* try {
|
|
121
|
+
* const appVersion = await sdk.getApplicationVersionDetails('app-123', 'v1.2.0');
|
|
122
|
+
* console.log(`Application Version: ${appVersion.version}`);
|
|
123
|
+
* console.log(`Release Date: ${appVersion.release_date}`);
|
|
124
|
+
* console.log(`Changelog: ${appVersion.changelog}`);
|
|
125
|
+
* } catch (error) {
|
|
126
|
+
* console.error('Failed to get application version details:', error.message);
|
|
127
|
+
* }
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
|
|
103
131
|
/**
|
|
104
132
|
* Retrieve detailed information about a specific application
|
|
105
133
|
*
|
|
@@ -172,6 +200,8 @@ declare class PlatformSDKHttp implements PlatformSDK {
|
|
|
172
200
|
listApplicationRuns(options?: {
|
|
173
201
|
applicationId?: string;
|
|
174
202
|
applicationVersion?: string;
|
|
203
|
+
customMetadata?: string;
|
|
204
|
+
sort?: string[];
|
|
175
205
|
}): Promise<RunReadResponse[]>;
|
|
176
206
|
/**
|
|
177
207
|
* Create and submit a new application run for processing
|
|
@@ -424,4 +454,4 @@ declare class ConfigurationError extends BaseError {
|
|
|
424
454
|
constructor(message: string, options?: BaseErrorOptions);
|
|
425
455
|
}
|
|
426
456
|
|
|
427
|
-
export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, PlatformSDKHttp as default };
|
|
457
|
+
export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, VersionReadResponse, PlatformSDKHttp as default };
|