@aignostics/sdk 3.0.0 → 3.2.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,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-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';
1
+ import { A as ApplicationReadShortResponse, a as ApplicationReadResponse, R as RunReadResponse, b as RunCreationRequest, c as RunCreationResponse, I as ItemState, d as ItemTerminationReason, e as ItemResultReadResponse, V as VersionReadResponse } from './api-Ce-0fPc3.cjs';
2
+ export { f as ApplicationVersion, g as ArtifactOutput, h as ArtifactState, i as ArtifactTerminationReason, Z as Configuration, Y as ConfigurationParameters, C as CustomMetadataUpdateRequest, j as CustomMetadataUpdateResponse, H as HTTPValidationError, k as InputArtifact, l as InputArtifactCreationRequest, m as ItemCreationRequest, n as ItemOutput, 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-Ce-0fPc3.cjs';
3
3
  import 'axios';
4
4
 
5
5
  /**
@@ -33,11 +33,23 @@ interface PlatformSDK {
33
33
  listApplicationRuns(options?: {
34
34
  applicationId?: string;
35
35
  applicationVersion?: string;
36
+ page?: number;
37
+ pageSize?: number;
38
+ customMetadata?: string;
39
+ sort?: string[];
36
40
  }): Promise<RunReadResponse[]>;
37
41
  createApplicationRun(request: RunCreationRequest): Promise<RunCreationResponse>;
38
42
  getRun(applicationRunId: string): Promise<RunReadResponse>;
39
43
  cancelApplicationRun(applicationRunId: string): Promise<void>;
40
- listRunResults(applicationRunId: string): Promise<ItemResultReadResponse[]>;
44
+ listRunResults(applicationRunId: string, options?: {
45
+ page?: number;
46
+ pageSize?: number;
47
+ sort?: string[];
48
+ externalIdIn?: string[];
49
+ state?: ItemState;
50
+ terminationReason?: ItemTerminationReason;
51
+ }): Promise<ItemResultReadResponse[]>;
52
+ getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
41
53
  }
42
54
  /**
43
55
  * Main SDK class for interacting with the Aignostics Platform
@@ -100,6 +112,33 @@ declare class PlatformSDKHttp implements PlatformSDK {
100
112
  * ```
101
113
  */
102
114
  listApplications(): Promise<ApplicationReadShortResponse[]>;
115
+ /**
116
+ * Retrieve detailed information about a specific application version
117
+ *
118
+ * This method fetches comprehensive details about a specific version of an
119
+ * application, including its changelog, release date, and any version-specific
120
+ * configurations or features.
121
+ *
122
+ * @param applicationId - The unique identifier of the application
123
+ * @param version - The version string of the application to retrieve
124
+ * @returns A promise that resolves to the application version details
125
+ * @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID or version, or API errors
126
+ *
127
+ * @example
128
+ * ```typescript
129
+ * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
130
+ *
131
+ * try {
132
+ * const appVersion = await sdk.getApplicationVersionDetails('app-123', 'v1.2.0');
133
+ * console.log(`Application Version: ${appVersion.version}`);
134
+ * console.log(`Release Date: ${appVersion.release_date}`);
135
+ * console.log(`Changelog: ${appVersion.changelog}`);
136
+ * } catch (error) {
137
+ * console.error('Failed to get application version details:', error.message);
138
+ * }
139
+ * ```
140
+ */
141
+ getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
103
142
  /**
104
143
  * Retrieve detailed information about a specific application
105
144
  *
@@ -172,6 +211,10 @@ declare class PlatformSDKHttp implements PlatformSDK {
172
211
  listApplicationRuns(options?: {
173
212
  applicationId?: string;
174
213
  applicationVersion?: string;
214
+ customMetadata?: string;
215
+ sort?: string[];
216
+ page?: number;
217
+ pageSize?: number;
175
218
  }): Promise<RunReadResponse[]>;
176
219
  /**
177
220
  * Create and submit a new application run for processing
@@ -296,7 +339,14 @@ declare class PlatformSDKHttp implements PlatformSDK {
296
339
  * }
297
340
  * ```
298
341
  */
299
- listRunResults(applicationRunId: string): Promise<ItemResultReadResponse[]>;
342
+ listRunResults(applicationRunId: string, { page, pageSize, sort, externalIdIn, state, terminationReason, }?: {
343
+ page?: number;
344
+ pageSize?: number;
345
+ sort?: string[];
346
+ externalIdIn?: string[];
347
+ state?: ItemState;
348
+ terminationReason?: ItemTerminationReason;
349
+ }): Promise<ItemResultReadResponse[]>;
300
350
  /**
301
351
  * Get the current version of the SDK
302
352
  *
@@ -424,4 +474,4 @@ declare class ConfigurationError extends BaseError {
424
474
  constructor(message: string, options?: BaseErrorOptions);
425
475
  }
426
476
 
427
- export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, PlatformSDKHttp as default };
477
+ export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, ItemState, ItemTerminationReason, 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-3iWGLFaA.js';
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.js';
1
+ import { A as ApplicationReadShortResponse, a as ApplicationReadResponse, R as RunReadResponse, b as RunCreationRequest, c as RunCreationResponse, I as ItemState, d as ItemTerminationReason, e as ItemResultReadResponse, V as VersionReadResponse } from './api-Ce-0fPc3.js';
2
+ export { f as ApplicationVersion, g as ArtifactOutput, h as ArtifactState, i as ArtifactTerminationReason, Z as Configuration, Y as ConfigurationParameters, C as CustomMetadataUpdateRequest, j as CustomMetadataUpdateResponse, H as HTTPValidationError, k as InputArtifact, l as InputArtifactCreationRequest, m as ItemCreationRequest, n as ItemOutput, 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-Ce-0fPc3.js';
3
3
  import 'axios';
4
4
 
5
5
  /**
@@ -33,11 +33,23 @@ interface PlatformSDK {
33
33
  listApplicationRuns(options?: {
34
34
  applicationId?: string;
35
35
  applicationVersion?: string;
36
+ page?: number;
37
+ pageSize?: number;
38
+ customMetadata?: string;
39
+ sort?: string[];
36
40
  }): Promise<RunReadResponse[]>;
37
41
  createApplicationRun(request: RunCreationRequest): Promise<RunCreationResponse>;
38
42
  getRun(applicationRunId: string): Promise<RunReadResponse>;
39
43
  cancelApplicationRun(applicationRunId: string): Promise<void>;
40
- listRunResults(applicationRunId: string): Promise<ItemResultReadResponse[]>;
44
+ listRunResults(applicationRunId: string, options?: {
45
+ page?: number;
46
+ pageSize?: number;
47
+ sort?: string[];
48
+ externalIdIn?: string[];
49
+ state?: ItemState;
50
+ terminationReason?: ItemTerminationReason;
51
+ }): Promise<ItemResultReadResponse[]>;
52
+ getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
41
53
  }
42
54
  /**
43
55
  * Main SDK class for interacting with the Aignostics Platform
@@ -100,6 +112,33 @@ declare class PlatformSDKHttp implements PlatformSDK {
100
112
  * ```
101
113
  */
102
114
  listApplications(): Promise<ApplicationReadShortResponse[]>;
115
+ /**
116
+ * Retrieve detailed information about a specific application version
117
+ *
118
+ * This method fetches comprehensive details about a specific version of an
119
+ * application, including its changelog, release date, and any version-specific
120
+ * configurations or features.
121
+ *
122
+ * @param applicationId - The unique identifier of the application
123
+ * @param version - The version string of the application to retrieve
124
+ * @returns A promise that resolves to the application version details
125
+ * @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID or version, or API errors
126
+ *
127
+ * @example
128
+ * ```typescript
129
+ * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
130
+ *
131
+ * try {
132
+ * const appVersion = await sdk.getApplicationVersionDetails('app-123', 'v1.2.0');
133
+ * console.log(`Application Version: ${appVersion.version}`);
134
+ * console.log(`Release Date: ${appVersion.release_date}`);
135
+ * console.log(`Changelog: ${appVersion.changelog}`);
136
+ * } catch (error) {
137
+ * console.error('Failed to get application version details:', error.message);
138
+ * }
139
+ * ```
140
+ */
141
+ getApplicationVersionDetails(applicationId: string, version: string): Promise<VersionReadResponse>;
103
142
  /**
104
143
  * Retrieve detailed information about a specific application
105
144
  *
@@ -172,6 +211,10 @@ declare class PlatformSDKHttp implements PlatformSDK {
172
211
  listApplicationRuns(options?: {
173
212
  applicationId?: string;
174
213
  applicationVersion?: string;
214
+ customMetadata?: string;
215
+ sort?: string[];
216
+ page?: number;
217
+ pageSize?: number;
175
218
  }): Promise<RunReadResponse[]>;
176
219
  /**
177
220
  * Create and submit a new application run for processing
@@ -296,7 +339,14 @@ declare class PlatformSDKHttp implements PlatformSDK {
296
339
  * }
297
340
  * ```
298
341
  */
299
- listRunResults(applicationRunId: string): Promise<ItemResultReadResponse[]>;
342
+ listRunResults(applicationRunId: string, { page, pageSize, sort, externalIdIn, state, terminationReason, }?: {
343
+ page?: number;
344
+ pageSize?: number;
345
+ sort?: string[];
346
+ externalIdIn?: string[];
347
+ state?: ItemState;
348
+ terminationReason?: ItemTerminationReason;
349
+ }): Promise<ItemResultReadResponse[]>;
300
350
  /**
301
351
  * Get the current version of the SDK
302
352
  *
@@ -424,4 +474,4 @@ declare class ConfigurationError extends BaseError {
424
474
  constructor(message: string, options?: BaseErrorOptions);
425
475
  }
426
476
 
427
- export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, PlatformSDKHttp as default };
477
+ export { APIError, ApplicationReadResponse, ApplicationReadShortResponse, AuthenticationError, BaseError, ConfigurationError, ItemResultReadResponse, ItemState, ItemTerminationReason, type PlatformSDK, type PlatformSDKConfig, PlatformSDKHttp, RunCreationRequest, RunCreationResponse, RunReadResponse, type TokenProvider, VersionReadResponse, PlatformSDKHttp as default };