@cirrobio/api-client 0.12.15 → 0.12.16

package/dist/apis/ExecutionApi.d.ts

@@ -24,6 +24,12 @@ export interface GetProjectSummaryRequest {
     projectId: string;
     numberOfDays?: number;
 }
+export interface GetTaskRequest {
+    datasetId: string;
+    projectId: string;
+    taskId: string;
+    forceLive?: boolean;
+}
 export interface GetTaskLogsRequest {
     datasetId: string;
     projectId: string;
@@ -81,6 +87,16 @@ export declare class ExecutionApi extends runtime.BaseAPI {
     getProjectSummary(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
         [key: string]: Array<Task>;
     }>;
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTaskRaw(requestParameters: GetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Task>>;
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTask(requestParameters: GetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Task>;
     /**
      * Gets the log output from an individual task
      * Get task logs

package/dist/apis/ExecutionApi.js

@@ -152,6 +152,52 @@ class ExecutionApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTaskRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getTask.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getTask.');
+            }
+            if (requestParameters.taskId === null || requestParameters.taskId === undefined) {
+                throw new runtime.RequiredError('taskId', 'Required parameter requestParameters.taskId was null or undefined when calling getTask.');
+            }
+            const queryParameters = {};
+            if (requestParameters.forceLive !== undefined) {
+                queryParameters['forceLive'] = requestParameters.forceLive;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/tasks/{taskId}`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters.taskId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TaskFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTask(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTaskRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Gets the log output from an individual task
      * Get task logs

package/dist/esm/apis/ExecutionApi.d.ts

@@ -24,6 +24,12 @@ export interface GetProjectSummaryRequest {
     projectId: string;
     numberOfDays?: number;
 }
+export interface GetTaskRequest {
+    datasetId: string;
+    projectId: string;
+    taskId: string;
+    forceLive?: boolean;
+}
 export interface GetTaskLogsRequest {
     datasetId: string;
     projectId: string;
@@ -81,6 +87,16 @@ export declare class ExecutionApi extends runtime.BaseAPI {
     getProjectSummary(requestParameters: GetProjectSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
         [key: string]: Array<Task>;
     }>;
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTaskRaw(requestParameters: GetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Task>>;
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTask(requestParameters: GetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Task>;
     /**
      * Gets the log output from an individual task
      * Get task logs

package/dist/esm/apis/ExecutionApi.js

@@ -149,6 +149,52 @@ export class ExecutionApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTaskRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+                throw new runtime.RequiredError('datasetId', 'Required parameter requestParameters.datasetId was null or undefined when calling getTask.');
+            }
+            if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+                throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getTask.');
+            }
+            if (requestParameters.taskId === null || requestParameters.taskId === undefined) {
+                throw new runtime.RequiredError('taskId', 'Required parameter requestParameters.taskId was null or undefined when calling getTask.');
+            }
+            const queryParameters = {};
+            if (requestParameters.forceLive !== undefined) {
+                queryParameters['forceLive'] = requestParameters.forceLive;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/projects/{projectId}/execution/{datasetId}/tasks/{taskId}`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters.taskId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => TaskFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Gets detailed information on the individual task
+     * Get task
+     */
+    getTask(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTaskRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Gets the log output from an individual task
      * Get task logs

package/dist/esm/models/Task.d.ts

@@ -33,6 +33,12 @@ export interface Task {
      * @memberof Task
      */
     status: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Task
+     */
+    statusMessage?: string | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/Task.js

@@ -32,6 +32,7 @@ export function TaskFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'nativeJobId': !exists(json, 'nativeJobId') ? undefined : json['nativeJobId'],
         'status': json['status'],
+        'statusMessage': !exists(json, 'statusMessage') ? undefined : json['statusMessage'],
         'requestedAt': !exists(json, 'requestedAt') ? undefined : (json['requestedAt'] === null ? null : new Date(json['requestedAt'])),
         'startedAt': !exists(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
         'stoppedAt': !exists(json, 'stoppedAt') ? undefined : (json['stoppedAt'] === null ? null : new Date(json['stoppedAt'])),
@@ -51,6 +52,7 @@ export function TaskToJSON(value) {
         'name': value.name,
         'nativeJobId': value.nativeJobId,
         'status': value.status,
+        'statusMessage': value.statusMessage,
         'requestedAt': value.requestedAt === undefined ? undefined : (value.requestedAt === null ? null : value.requestedAt.toISOString()),
         'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
         'stoppedAt': value.stoppedAt === undefined ? undefined : (value.stoppedAt === null ? null : value.stoppedAt.toISOString()),

package/dist/models/Task.d.ts

@@ -33,6 +33,12 @@ export interface Task {
      * @memberof Task
      */
     status: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Task
+     */
+    statusMessage?: string | null;
     /**
      *
      * @type {Date}

package/dist/models/Task.js

@@ -37,6 +37,7 @@ function TaskFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'nativeJobId': !(0, runtime_1.exists)(json, 'nativeJobId') ? undefined : json['nativeJobId'],
         'status': json['status'],
+        'statusMessage': !(0, runtime_1.exists)(json, 'statusMessage') ? undefined : json['statusMessage'],
         'requestedAt': !(0, runtime_1.exists)(json, 'requestedAt') ? undefined : (json['requestedAt'] === null ? null : new Date(json['requestedAt'])),
         'startedAt': !(0, runtime_1.exists)(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
         'stoppedAt': !(0, runtime_1.exists)(json, 'stoppedAt') ? undefined : (json['stoppedAt'] === null ? null : new Date(json['stoppedAt'])),
@@ -57,6 +58,7 @@ function TaskToJSON(value) {
         'name': value.name,
         'nativeJobId': value.nativeJobId,
         'status': value.status,
+        'statusMessage': value.statusMessage,
         'requestedAt': value.requestedAt === undefined ? undefined : (value.requestedAt === null ? null : value.requestedAt.toISOString()),
         'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
         'stoppedAt': value.stoppedAt === undefined ? undefined : (value.stoppedAt === null ? null : value.stoppedAt.toISOString()),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.12.15",
+  "version": "0.12.16",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {