prioritize-client 1.3.0

package/dist/apis/ProcessDefinitionsApi.js

@@ -0,0 +1,260 @@
+"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.ProcessDefinitionsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ProcessDefinitionsApi extends runtime.BaseAPI {
+    /**
+     * Activate a definition (deploy it to the engine and make it startable)
+     */
+    processDefinitionActivateRaw(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 processDefinitionActivate().');
+            }
+            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-definitions/{id}/activate`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessDefinitionDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Activate a definition (deploy it to the engine and make it startable)
+     */
+    processDefinitionActivate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processDefinitionActivateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deactivate a definition (stop new instances; running ones continue)
+     */
+    processDefinitionDeactivateRaw(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 processDefinitionDeactivate().');
+            }
+            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-definitions/{id}/deactivate`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessDefinitionDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Deactivate a definition (stop new instances; running ones continue)
+     */
+    processDefinitionDeactivate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processDefinitionDeactivateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get a process definition
+     */
+    processDefinitionGetRaw(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 processDefinitionGet().');
+            }
+            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-definitions/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessDefinitionDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get a process definition
+     */
+    processDefinitionGet(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processDefinitionGetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List all process definitions (deployed or draft)
+     */
+    processDefinitionGetAllRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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-definitions`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ProcessDefinitionDTOFromJSON));
+        });
+    }
+    /**
+     * List all process definitions (deployed or draft)
+     */
+    processDefinitionGetAll(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processDefinitionGetAllRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Register a document as a process definition (draft, not yet deployed)
+     */
+    processDefinitionRegisterRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentInfoId'] == null) {
+                throw new runtime.RequiredError('documentInfoId', 'Required parameter "documentInfoId" was null or undefined when calling processDefinitionRegister().');
+            }
+            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/documents/{documentInfoId}/process-definition`.replace(`{${"documentInfoId"}}`, encodeURIComponent(String(requestParameters['documentInfoId']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProcessDefinitionDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Register a document as a process definition (draft, not yet deployed)
+     */
+    processDefinitionRegister(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.processDefinitionRegisterRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Remove a definition (drafts freely; deployed only with ?force=true)
+     */
+    processDefinitionUnregisterRaw(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 processDefinitionUnregister().');
+            }
+            const queryParameters = {};
+            if (requestParameters['force'] != null) {
+                queryParameters['force'] = requestParameters['force'];
+            }
+            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-definitions/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Remove a definition (drafts freely; deployed only with ?force=true)
+     */
+    processDefinitionUnregister(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.processDefinitionUnregisterRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.ProcessDefinitionsApi = ProcessDefinitionsApi;

package/dist/apis/ProcessInstancesApi.d.ts

@@ -0,0 +1,176 @@
+/**
+ * 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 { CancelProcessInstanceRequest, ProcessInstanceDTO, StartProcessInstanceRequest } from '../models/index';
+export interface ProcessInstanceCancelRequest {
+    id: string;
+    cancelProcessInstanceRequest?: CancelProcessInstanceRequest;
+}
+export interface ProcessInstanceGetRequest {
+    id: string;
+}
+export interface ProcessInstanceGetForProjectRequest {
+    projectId: number;
+}
+export interface ProcessInstanceGetForTaskRequest {
+    taskId: number;
+}
+export interface ProcessInstanceStartForProjectRequest {
+    projectId: number;
+    startProcessInstanceRequest: StartProcessInstanceRequest;
+}
+export interface ProcessInstanceStartForTaskRequest {
+    taskId: number;
+    startProcessInstanceRequest: StartProcessInstanceRequest;
+}
+/**
+ * ProcessInstancesApi - interface
+ *
+ * @export
+ * @interface ProcessInstancesApiInterface
+ */
+export interface ProcessInstancesApiInterface {
+    /**
+     *
+     * @summary Stops a running instance
+     * @param {string} id
+     * @param {CancelProcessInstanceRequest} [cancelProcessInstanceRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessInstancesApiInterface
+     */
+    processInstanceCancelRaw(requestParameters: ProcessInstanceCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Stops a running instance
+     */
+    processInstanceCancel(requestParameters: ProcessInstanceCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary A single instance by its engine id
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessInstancesApiInterface
+     */
+    processInstanceGetRaw(requestParameters: ProcessInstanceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * A single instance by its engine id
+     */
+    processInstanceGet(requestParameters: ProcessInstanceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+    /**
+     *
+     * @summary All instances belonging to a project — its own and those of its tasks, running or finished
+     * @param {number} projectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessInstancesApiInterface
+     */
+    processInstanceGetForProjectRaw(requestParameters: ProcessInstanceGetForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProcessInstanceDTO>>>;
+    /**
+     * All instances belonging to a project — its own and those of its tasks, running or finished
+     */
+    processInstanceGetForProject(requestParameters: ProcessInstanceGetForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProcessInstanceDTO>>;
+    /**
+     *
+     * @summary The instance a task is linked to
+     * @param {number} taskId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessInstancesApiInterface
+     */
+    processInstanceGetForTaskRaw(requestParameters: ProcessInstanceGetForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * The instance a task is linked to
+     */
+    processInstanceGetForTask(requestParameters: ProcessInstanceGetForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+    /**
+     *
+     * @summary Starts a process for a whole project
+     * @param {number} projectId
+     * @param {StartProcessInstanceRequest} startProcessInstanceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessInstancesApiInterface
+     */
+    processInstanceStartForProjectRaw(requestParameters: ProcessInstanceStartForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * Starts a process for a whole project
+     */
+    processInstanceStartForProject(requestParameters: ProcessInstanceStartForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+    /**
+     *
+     * @summary Starts a process for a single task and links the two
+     * @param {number} taskId
+     * @param {StartProcessInstanceRequest} startProcessInstanceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessInstancesApiInterface
+     */
+    processInstanceStartForTaskRaw(requestParameters: ProcessInstanceStartForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * Starts a process for a single task and links the two
+     */
+    processInstanceStartForTask(requestParameters: ProcessInstanceStartForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+}
+/**
+ *
+ */
+export declare class ProcessInstancesApi extends runtime.BaseAPI implements ProcessInstancesApiInterface {
+    /**
+     * Stops a running instance
+     */
+    processInstanceCancelRaw(requestParameters: ProcessInstanceCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Stops a running instance
+     */
+    processInstanceCancel(requestParameters: ProcessInstanceCancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * A single instance by its engine id
+     */
+    processInstanceGetRaw(requestParameters: ProcessInstanceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * A single instance by its engine id
+     */
+    processInstanceGet(requestParameters: ProcessInstanceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+    /**
+     * All instances belonging to a project — its own and those of its tasks, running or finished
+     */
+    processInstanceGetForProjectRaw(requestParameters: ProcessInstanceGetForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProcessInstanceDTO>>>;
+    /**
+     * All instances belonging to a project — its own and those of its tasks, running or finished
+     */
+    processInstanceGetForProject(requestParameters: ProcessInstanceGetForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProcessInstanceDTO>>;
+    /**
+     * The instance a task is linked to
+     */
+    processInstanceGetForTaskRaw(requestParameters: ProcessInstanceGetForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * The instance a task is linked to
+     */
+    processInstanceGetForTask(requestParameters: ProcessInstanceGetForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+    /**
+     * Starts a process for a whole project
+     */
+    processInstanceStartForProjectRaw(requestParameters: ProcessInstanceStartForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * Starts a process for a whole project
+     */
+    processInstanceStartForProject(requestParameters: ProcessInstanceStartForProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+    /**
+     * Starts a process for a single task and links the two
+     */
+    processInstanceStartForTaskRaw(requestParameters: ProcessInstanceStartForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessInstanceDTO>>;
+    /**
+     * Starts a process for a single task and links the two
+     */
+    processInstanceStartForTask(requestParameters: ProcessInstanceStartForTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessInstanceDTO>;
+}