prioritize-client 1.3.0

package/dist/apis/ProcessInstancesApi.js

@@ -0,0 +1,272 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Prioritize API
+ * REST API of Prioritize, a resource, project and IoT orchestration platform. All endpoints live under /api/v1. From 1.0.0 on this REST surface is the stable public contract (SemVer); the Vaadin admin GUI and its @Route URLs are an implementation detail and NOT part of that promise. A few areas are marked \'experimental\' in their schema and may still change within the 1.x line.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * Contact: peter.haller@prioritize-iot.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessInstancesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ProcessInstancesApi extends runtime.BaseAPI {
+    /**
+     * Stops a running instance
+     */
+    processInstanceCancelRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling processInstanceCancel().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/api/v1/process-instances/{id}/cancel`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CancelProcessInstanceRequestToJSON)(requestParameters['cancelProcessInstanceRequest']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Stops a running instance
+     */
+    processInstanceCancel(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.processInstanceCancelRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * A single instance by its engine id
+     */
+    processInstanceGetRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling processInstanceGet().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/api/v1/process-instances/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessInstanceDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * A single instance by its engine id
+     */
+    processInstanceGet(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processInstanceGetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * All instances belonging to a project — its own and those of its tasks, running or finished
+     */
+    processInstanceGetForProjectRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling processInstanceGetForProject().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/api/v1/projects/{projectId}/process-instances`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters['projectId']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ProcessInstanceDTOFromJSON));
+        });
+    }
+    /**
+     * All instances belonging to a project — its own and those of its tasks, running or finished
+     */
+    processInstanceGetForProject(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processInstanceGetForProjectRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * The instance a task is linked to
+     */
+    processInstanceGetForTaskRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['taskId'] == null) {
+                throw new runtime.RequiredError('taskId', 'Required parameter "taskId" was null or undefined when calling processInstanceGetForTask().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/api/v1/tasks/{taskId}/process-instance`.replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters['taskId']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessInstanceDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * The instance a task is linked to
+     */
+    processInstanceGetForTask(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processInstanceGetForTaskRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Starts a process for a whole project
+     */
+    processInstanceStartForProjectRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling processInstanceStartForProject().');
+            }
+            if (requestParameters['startProcessInstanceRequest'] == null) {
+                throw new runtime.RequiredError('startProcessInstanceRequest', 'Required parameter "startProcessInstanceRequest" was null or undefined when calling processInstanceStartForProject().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/api/v1/projects/{projectId}/process-instances`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters['projectId']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.StartProcessInstanceRequestToJSON)(requestParameters['startProcessInstanceRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessInstanceDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Starts a process for a whole project
+     */
+    processInstanceStartForProject(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processInstanceStartForProjectRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Starts a process for a single task and links the two
+     */
+    processInstanceStartForTaskRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['taskId'] == null) {
+                throw new runtime.RequiredError('taskId', 'Required parameter "taskId" was null or undefined when calling processInstanceStartForTask().');
+            }
+            if (requestParameters['startProcessInstanceRequest'] == null) {
+                throw new runtime.RequiredError('startProcessInstanceRequest', 'Required parameter "startProcessInstanceRequest" was null or undefined when calling processInstanceStartForTask().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/api/v1/tasks/{taskId}/process-instances`.replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters['taskId']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.StartProcessInstanceRequestToJSON)(requestParameters['startProcessInstanceRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessInstanceDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Starts a process for a single task and links the two
+     */
+    processInstanceStartForTask(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processInstanceStartForTaskRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.ProcessInstancesApi = ProcessInstancesApi;

package/dist/apis/ProjectGoalsApi.d.ts

@@ -0,0 +1,180 @@
+/**
+ * Prioritize API
+ * REST API of Prioritize, a resource, project and IoT orchestration platform. All endpoints live under /api/v1. From 1.0.0 on this REST surface is the stable public contract (SemVer); the Vaadin admin GUI and its @Route URLs are an implementation detail and NOT part of that promise. A few areas are marked \'experimental\' in their schema and may still change within the 1.x line.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * Contact: peter.haller@prioritize-iot.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { GoalRequest, ProjectGoalDTO, ProjectProgress } from '../models/index';
+export interface ProjectGoalCreateGoalRequest {
+    projectId: number;
+    goalRequest: GoalRequest;
+}
+export interface ProjectGoalDeleteGoalRequest {
+    projectId: number;
+    goalId: number;
+}
+export interface ProjectGoalGetGoalRequest {
+    projectId: number;
+    goalId: number;
+}
+export interface ProjectGoalGetGoalsRequest {
+    projectId: number;
+}
+export interface ProjectGoalGetProgressRequest {
+    projectId: number;
+}
+export interface ProjectGoalUpdateGoalRequest {
+    projectId: number;
+    goalId: number;
+    goalRequest: GoalRequest;
+}
+/**
+ * ProjectGoalsApi - interface
+ *
+ * @export
+ * @interface ProjectGoalsApiInterface
+ */
+export interface ProjectGoalsApiInterface {
+    /**
+     *
+     * @summary Create goal
+     * @param {number} projectId
+     * @param {GoalRequest} goalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectGoalsApiInterface
+     */
+    projectGoalCreateGoalRaw(requestParameters: ProjectGoalCreateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectGoalDTO>>;
+    /**
+     * Create goal
+     */
+    projectGoalCreateGoal(requestParameters: ProjectGoalCreateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectGoalDTO>;
+    /**
+     *
+     * @summary Delete goal
+     * @param {number} projectId
+     * @param {number} goalId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectGoalsApiInterface
+     */
+    projectGoalDeleteGoalRaw(requestParameters: ProjectGoalDeleteGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete goal
+     */
+    projectGoalDeleteGoal(requestParameters: ProjectGoalDeleteGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Get goal
+     * @param {number} projectId
+     * @param {number} goalId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectGoalsApiInterface
+     */
+    projectGoalGetGoalRaw(requestParameters: ProjectGoalGetGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectGoalDTO>>;
+    /**
+     * Get goal
+     */
+    projectGoalGetGoal(requestParameters: ProjectGoalGetGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectGoalDTO>;
+    /**
+     *
+     * @summary Get goals
+     * @param {number} projectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectGoalsApiInterface
+     */
+    projectGoalGetGoalsRaw(requestParameters: ProjectGoalGetGoalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectGoalDTO>>>;
+    /**
+     * Get goals
+     */
+    projectGoalGetGoals(requestParameters: ProjectGoalGetGoalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectGoalDTO>>;
+    /**
+     *
+     * @summary Returns the project\'s progress derived from its goals and their tasks
+     * @param {number} projectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectGoalsApiInterface
+     */
+    projectGoalGetProgressRaw(requestParameters: ProjectGoalGetProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectProgress>>;
+    /**
+     * Returns the project\'s progress derived from its goals and their tasks
+     */
+    projectGoalGetProgress(requestParameters: ProjectGoalGetProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectProgress>;
+    /**
+     *
+     * @summary Update goal
+     * @param {number} projectId
+     * @param {number} goalId
+     * @param {GoalRequest} goalRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectGoalsApiInterface
+     */
+    projectGoalUpdateGoalRaw(requestParameters: ProjectGoalUpdateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectGoalDTO>>;
+    /**
+     * Update goal
+     */
+    projectGoalUpdateGoal(requestParameters: ProjectGoalUpdateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectGoalDTO>;
+}
+/**
+ *
+ */
+export declare class ProjectGoalsApi extends runtime.BaseAPI implements ProjectGoalsApiInterface {
+    /**
+     * Create goal
+     */
+    projectGoalCreateGoalRaw(requestParameters: ProjectGoalCreateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectGoalDTO>>;
+    /**
+     * Create goal
+     */
+    projectGoalCreateGoal(requestParameters: ProjectGoalCreateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectGoalDTO>;
+    /**
+     * Delete goal
+     */
+    projectGoalDeleteGoalRaw(requestParameters: ProjectGoalDeleteGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete goal
+     */
+    projectGoalDeleteGoal(requestParameters: ProjectGoalDeleteGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get goal
+     */
+    projectGoalGetGoalRaw(requestParameters: ProjectGoalGetGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectGoalDTO>>;
+    /**
+     * Get goal
+     */
+    projectGoalGetGoal(requestParameters: ProjectGoalGetGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectGoalDTO>;
+    /**
+     * Get goals
+     */
+    projectGoalGetGoalsRaw(requestParameters: ProjectGoalGetGoalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectGoalDTO>>>;
+    /**
+     * Get goals
+     */
+    projectGoalGetGoals(requestParameters: ProjectGoalGetGoalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectGoalDTO>>;
+    /**
+     * Returns the project\'s progress derived from its goals and their tasks
+     */
+    projectGoalGetProgressRaw(requestParameters: ProjectGoalGetProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectProgress>>;
+    /**
+     * Returns the project\'s progress derived from its goals and their tasks
+     */
+    projectGoalGetProgress(requestParameters: ProjectGoalGetProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectProgress>;
+    /**
+     * Update goal
+     */
+    projectGoalUpdateGoalRaw(requestParameters: ProjectGoalUpdateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectGoalDTO>>;
+    /**
+     * Update goal
+     */
+    projectGoalUpdateGoal(requestParameters: ProjectGoalUpdateGoalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectGoalDTO>;
+}