prioritize-client 1.3.0

package/src/apis/NFCApi.ts

@@ -0,0 +1,443 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  NfcUnitDTO,
+  NfcUnitRequest,
+  ScanResult,
+} from '../models/index';
+import {
+    NfcUnitDTOFromJSON,
+    NfcUnitDTOToJSON,
+    NfcUnitRequestFromJSON,
+    NfcUnitRequestToJSON,
+    ScanResultFromJSON,
+    ScanResultToJSON,
+} from '../models/index';
+
+export interface NfcUnitBindTaskRequest {
+    id: number;
+    taskId: number;
+}
+
+export interface NfcUnitDeleteNfcUnitRequest {
+    id: number;
+}
+
+export interface NfcUnitGetNfcUnitsRequest {
+    resourceId: number;
+}
+
+export interface NfcUnitRegisterNfcUnitRequest {
+    resourceId: number;
+    nfcUnitRequest: NfcUnitRequest;
+}
+
+export interface NfcUnitScanRequest {
+    uuid: string;
+}
+
+export interface NfcUnitUnbindTaskRequest {
+    id: number;
+}
+
+/**
+ * NFCApi - interface
+ * 
+ * @export
+ * @interface NFCApiInterface
+ */
+export interface NFCApiInterface {
+    /**
+     * 
+     * @summary Bind task
+     * @param {number} id 
+     * @param {number} taskId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NFCApiInterface
+     */
+    nfcUnitBindTaskRaw(requestParameters: NfcUnitBindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NfcUnitDTO>>;
+
+    /**
+     * Bind task
+     */
+    nfcUnitBindTask(requestParameters: NfcUnitBindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NfcUnitDTO>;
+
+    /**
+     * 
+     * @summary Delete an NFC unit
+     * @param {number} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NFCApiInterface
+     */
+    nfcUnitDeleteNfcUnitRaw(requestParameters: NfcUnitDeleteNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete an NFC unit
+     */
+    nfcUnitDeleteNfcUnit(requestParameters: NfcUnitDeleteNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @summary Get the NFC units
+     * @param {number} resourceId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NFCApiInterface
+     */
+    nfcUnitGetNfcUnitsRaw(requestParameters: NfcUnitGetNfcUnitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NfcUnitDTO>>>;
+
+    /**
+     * Get the NFC units
+     */
+    nfcUnitGetNfcUnits(requestParameters: NfcUnitGetNfcUnitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NfcUnitDTO>>;
+
+    /**
+     * 
+     * @summary Register an NFC unit
+     * @param {number} resourceId 
+     * @param {NfcUnitRequest} nfcUnitRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NFCApiInterface
+     */
+    nfcUnitRegisterNfcUnitRaw(requestParameters: NfcUnitRegisterNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NfcUnitDTO>>;
+
+    /**
+     * Register an NFC unit
+     */
+    nfcUnitRegisterNfcUnit(requestParameters: NfcUnitRegisterNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NfcUnitDTO>;
+
+    /**
+     * 
+     * @summary Process an NFC tag scan by its uuid
+     * @param {string} uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NFCApiInterface
+     */
+    nfcUnitScanRaw(requestParameters: NfcUnitScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScanResult>>;
+
+    /**
+     * Process an NFC tag scan by its uuid
+     */
+    nfcUnitScan(requestParameters: NfcUnitScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScanResult>;
+
+    /**
+     * 
+     * @summary Unbind task
+     * @param {number} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NFCApiInterface
+     */
+    nfcUnitUnbindTaskRaw(requestParameters: NfcUnitUnbindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NfcUnitDTO>>;
+
+    /**
+     * Unbind task
+     */
+    nfcUnitUnbindTask(requestParameters: NfcUnitUnbindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NfcUnitDTO>;
+
+}
+
+/**
+ * 
+ */
+export class NFCApi extends runtime.BaseAPI implements NFCApiInterface {
+
+    /**
+     * Bind task
+     */
+    async nfcUnitBindTaskRaw(requestParameters: NfcUnitBindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NfcUnitDTO>> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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 = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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) => NfcUnitDTOFromJSON(jsonValue));
+    }
+
+    /**
+     * Bind task
+     */
+    async nfcUnitBindTask(requestParameters: NfcUnitBindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NfcUnitDTO> {
+        const response = await this.nfcUnitBindTaskRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete an NFC unit
+     */
+    async nfcUnitDeleteNfcUnitRaw(requestParameters: NfcUnitDeleteNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling nfcUnitDeleteNfcUnit().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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 = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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
+     */
+    async nfcUnitDeleteNfcUnit(requestParameters: NfcUnitDeleteNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.nfcUnitDeleteNfcUnitRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get the NFC units
+     */
+    async nfcUnitGetNfcUnitsRaw(requestParameters: NfcUnitGetNfcUnitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NfcUnitDTO>>> {
+        if (requestParameters['resourceId'] == null) {
+            throw new runtime.RequiredError(
+                'resourceId',
+                'Required parameter "resourceId" was null or undefined when calling nfcUnitGetNfcUnits().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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 = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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(NfcUnitDTOFromJSON));
+    }
+
+    /**
+     * Get the NFC units
+     */
+    async nfcUnitGetNfcUnits(requestParameters: NfcUnitGetNfcUnitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NfcUnitDTO>> {
+        const response = await this.nfcUnitGetNfcUnitsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Register an NFC unit
+     */
+    async nfcUnitRegisterNfcUnitRaw(requestParameters: NfcUnitRegisterNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NfcUnitDTO>> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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 = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/resources/{resourceId}/nfc-units`.replace(`{${"resourceId"}}`, encodeURIComponent(String(requestParameters['resourceId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: NfcUnitRequestToJSON(requestParameters['nfcUnitRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NfcUnitDTOFromJSON(jsonValue));
+    }
+
+    /**
+     * Register an NFC unit
+     */
+    async nfcUnitRegisterNfcUnit(requestParameters: NfcUnitRegisterNfcUnitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NfcUnitDTO> {
+        const response = await this.nfcUnitRegisterNfcUnitRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Process an NFC tag scan by its uuid
+     */
+    async nfcUnitScanRaw(requestParameters: NfcUnitScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScanResult>> {
+        if (requestParameters['uuid'] == null) {
+            throw new runtime.RequiredError(
+                'uuid',
+                'Required parameter "uuid" was null or undefined when calling nfcUnitScan().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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 = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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) => ScanResultFromJSON(jsonValue));
+    }
+
+    /**
+     * Process an NFC tag scan by its uuid
+     */
+    async nfcUnitScan(requestParameters: NfcUnitScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScanResult> {
+        const response = await this.nfcUnitScanRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Unbind task
+     */
+    async nfcUnitUnbindTaskRaw(requestParameters: NfcUnitUnbindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NfcUnitDTO>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling nfcUnitUnbindTask().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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 = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await 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) => NfcUnitDTOFromJSON(jsonValue));
+    }
+
+    /**
+     * Unbind task
+     */
+    async nfcUnitUnbindTask(requestParameters: NfcUnitUnbindTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NfcUnitDTO> {
+        const response = await this.nfcUnitUnbindTaskRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}