prioritize-client 1.3.0

package/dist/apis/NFCApi.js

@@ -0,0 +1,268 @@
+"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.NFCApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class NFCApi extends runtime.BaseAPI {
+    /**
+     * Bind task
+     */
+    nfcUnitBindTaskRaw(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 nfcUnitBindTask().');
+            }
+            if (requestParameters['taskId'] == null) {
+                throw new runtime.RequiredError('taskId', 'Required parameter "taskId" was null or undefined when calling nfcUnitBindTask().');
+            }
+            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/nfc-units/{id}/task/{taskId}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))).replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters['taskId']))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NfcUnitDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Bind task
+     */
+    nfcUnitBindTask(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.nfcUnitBindTaskRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Delete an NFC unit
+     */
+    nfcUnitDeleteNfcUnitRaw(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 nfcUnitDeleteNfcUnit().');
+            }
+            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/nfc-units/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete an NFC unit
+     */
+    nfcUnitDeleteNfcUnit(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.nfcUnitDeleteNfcUnitRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Get the NFC units
+     */
+    nfcUnitGetNfcUnitsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['resourceId'] == null) {
+                throw new runtime.RequiredError('resourceId', 'Required parameter "resourceId" was null or undefined when calling nfcUnitGetNfcUnits().');
+            }
+            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/resources/{resourceId}/nfc-units`.replace(`{${"resourceId"}}`, encodeURIComponent(String(requestParameters['resourceId']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.NfcUnitDTOFromJSON));
+        });
+    }
+    /**
+     * Get the NFC units
+     */
+    nfcUnitGetNfcUnits(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.nfcUnitGetNfcUnitsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Register an NFC unit
+     */
+    nfcUnitRegisterNfcUnitRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['resourceId'] == null) {
+                throw new runtime.RequiredError('resourceId', 'Required parameter "resourceId" was null or undefined when calling nfcUnitRegisterNfcUnit().');
+            }
+            if (requestParameters['nfcUnitRequest'] == null) {
+                throw new runtime.RequiredError('nfcUnitRequest', 'Required parameter "nfcUnitRequest" was null or undefined when calling nfcUnitRegisterNfcUnit().');
+            }
+            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/resources/{resourceId}/nfc-units`.replace(`{${"resourceId"}}`, encodeURIComponent(String(requestParameters['resourceId']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.NfcUnitRequestToJSON)(requestParameters['nfcUnitRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NfcUnitDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Register an NFC unit
+     */
+    nfcUnitRegisterNfcUnit(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.nfcUnitRegisterNfcUnitRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Process an NFC tag scan by its uuid
+     */
+    nfcUnitScanRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['uuid'] == null) {
+                throw new runtime.RequiredError('uuid', 'Required parameter "uuid" was null or undefined when calling nfcUnitScan().');
+            }
+            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/nfc/scan/{uuid}`.replace(`{${"uuid"}}`, encodeURIComponent(String(requestParameters['uuid']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScanResultFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Process an NFC tag scan by its uuid
+     */
+    nfcUnitScan(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.nfcUnitScanRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Unbind task
+     */
+    nfcUnitUnbindTaskRaw(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 nfcUnitUnbindTask().');
+            }
+            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/nfc-units/{id}/task`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NfcUnitDTOFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Unbind task
+     */
+    nfcUnitUnbindTask(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.nfcUnitUnbindTaskRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.NFCApi = NFCApi;

package/dist/apis/ProcessDefinitionsApi.d.ts

@@ -0,0 +1,168 @@
+/**
+ * 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 { ProcessDefinitionDTO } from '../models/index';
+export interface ProcessDefinitionActivateRequest {
+    id: number;
+}
+export interface ProcessDefinitionDeactivateRequest {
+    id: number;
+}
+export interface ProcessDefinitionGetRequest {
+    id: number;
+}
+export interface ProcessDefinitionRegisterRequest {
+    documentInfoId: number;
+}
+export interface ProcessDefinitionUnregisterRequest {
+    id: number;
+    force?: boolean;
+}
+/**
+ * ProcessDefinitionsApi - interface
+ *
+ * @export
+ * @interface ProcessDefinitionsApiInterface
+ */
+export interface ProcessDefinitionsApiInterface {
+    /**
+     *
+     * @summary Activate a definition (deploy it to the engine and make it startable)
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessDefinitionsApiInterface
+     */
+    processDefinitionActivateRaw(requestParameters: ProcessDefinitionActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Activate a definition (deploy it to the engine and make it startable)
+     */
+    processDefinitionActivate(requestParameters: ProcessDefinitionActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     *
+     * @summary Deactivate a definition (stop new instances; running ones continue)
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessDefinitionsApiInterface
+     */
+    processDefinitionDeactivateRaw(requestParameters: ProcessDefinitionDeactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Deactivate a definition (stop new instances; running ones continue)
+     */
+    processDefinitionDeactivate(requestParameters: ProcessDefinitionDeactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     *
+     * @summary Get a process definition
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessDefinitionsApiInterface
+     */
+    processDefinitionGetRaw(requestParameters: ProcessDefinitionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Get a process definition
+     */
+    processDefinitionGet(requestParameters: ProcessDefinitionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     *
+     * @summary List all process definitions (deployed or draft)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessDefinitionsApiInterface
+     */
+    processDefinitionGetAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProcessDefinitionDTO>>>;
+    /**
+     * List all process definitions (deployed or draft)
+     */
+    processDefinitionGetAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProcessDefinitionDTO>>;
+    /**
+     *
+     * @summary Register a document as a process definition (draft, not yet deployed)
+     * @param {number} documentInfoId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessDefinitionsApiInterface
+     */
+    processDefinitionRegisterRaw(requestParameters: ProcessDefinitionRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Register a document as a process definition (draft, not yet deployed)
+     */
+    processDefinitionRegister(requestParameters: ProcessDefinitionRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     *
+     * @summary Remove a definition (drafts freely; deployed only with ?force=true)
+     * @param {number} id
+     * @param {boolean} [force]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessDefinitionsApiInterface
+     */
+    processDefinitionUnregisterRaw(requestParameters: ProcessDefinitionUnregisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a definition (drafts freely; deployed only with ?force=true)
+     */
+    processDefinitionUnregister(requestParameters: ProcessDefinitionUnregisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class ProcessDefinitionsApi extends runtime.BaseAPI implements ProcessDefinitionsApiInterface {
+    /**
+     * Activate a definition (deploy it to the engine and make it startable)
+     */
+    processDefinitionActivateRaw(requestParameters: ProcessDefinitionActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Activate a definition (deploy it to the engine and make it startable)
+     */
+    processDefinitionActivate(requestParameters: ProcessDefinitionActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     * Deactivate a definition (stop new instances; running ones continue)
+     */
+    processDefinitionDeactivateRaw(requestParameters: ProcessDefinitionDeactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Deactivate a definition (stop new instances; running ones continue)
+     */
+    processDefinitionDeactivate(requestParameters: ProcessDefinitionDeactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     * Get a process definition
+     */
+    processDefinitionGetRaw(requestParameters: ProcessDefinitionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Get a process definition
+     */
+    processDefinitionGet(requestParameters: ProcessDefinitionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     * List all process definitions (deployed or draft)
+     */
+    processDefinitionGetAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProcessDefinitionDTO>>>;
+    /**
+     * List all process definitions (deployed or draft)
+     */
+    processDefinitionGetAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProcessDefinitionDTO>>;
+    /**
+     * Register a document as a process definition (draft, not yet deployed)
+     */
+    processDefinitionRegisterRaw(requestParameters: ProcessDefinitionRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProcessDefinitionDTO>>;
+    /**
+     * Register a document as a process definition (draft, not yet deployed)
+     */
+    processDefinitionRegister(requestParameters: ProcessDefinitionRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessDefinitionDTO>;
+    /**
+     * Remove a definition (drafts freely; deployed only with ?force=true)
+     */
+    processDefinitionUnregisterRaw(requestParameters: ProcessDefinitionUnregisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a definition (drafts freely; deployed only with ?force=true)
+     */
+    processDefinitionUnregister(requestParameters: ProcessDefinitionUnregisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}