@ignos/api-client 20250116.0.10991 → 20250121.0.10997

package/lib/ignosportal-api.js

@@ -2162,6 +2162,243 @@ export class PulseClient extends AuthorizedApiBase {
         return Promise.resolve(null);
     }
 }
+export class UtilizationClient extends AuthorizedApiBase {
+    constructor(configuration, baseUrl, http) {
+        super(configuration);
+        this.jsonParseReviver = undefined;
+        this.http = http ? http : window;
+        this.baseUrl = baseUrl !== null && baseUrl !== void 0 ? baseUrl : "";
+    }
+    getCompanyUtilization(utilizationType, startTime, endTime) {
+        let url_ = this.baseUrl + "/utilization?";
+        if (utilizationType === null)
+            throw new Error("The parameter 'utilizationType' cannot be null.");
+        else if (utilizationType !== undefined)
+            url_ += "utilizationType=" + encodeURIComponent("" + utilizationType) + "&";
+        if (startTime !== undefined && startTime !== null)
+            url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
+        if (endTime !== undefined && endTime !== null)
+            url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response) => {
+            return this.processGetCompanyUtilization(_response);
+        });
+    }
+    processGetCompanyUtilization(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result200 = CompanyUtilizationDto.fromJS(resultData200);
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+    getCrossCompanyUtilization(utilizationType, startTime, endTime) {
+        let url_ = this.baseUrl + "/utilization/cross-company?";
+        if (utilizationType === null)
+            throw new Error("The parameter 'utilizationType' cannot be null.");
+        else if (utilizationType !== undefined)
+            url_ += "utilizationType=" + encodeURIComponent("" + utilizationType) + "&";
+        if (startTime !== undefined && startTime !== null)
+            url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
+        if (endTime !== undefined && endTime !== null)
+            url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response) => {
+            return this.processGetCrossCompanyUtilization(_response);
+        });
+    }
+    processGetCrossCompanyUtilization(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result200 = CrossCompanyUtilizationDto.fromJS(resultData200);
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+    getUtilizationDatapoints(utilizationType, startTime, endTime, assetId, assetExternalId) {
+        let url_ = this.baseUrl + "/utilization/datapoints?";
+        if (utilizationType === null)
+            throw new Error("The parameter 'utilizationType' cannot be null.");
+        else if (utilizationType !== undefined)
+            url_ += "utilizationType=" + encodeURIComponent("" + utilizationType) + "&";
+        if (startTime !== undefined && startTime !== null)
+            url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
+        if (endTime !== undefined && endTime !== null)
+            url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
+        if (assetId !== undefined && assetId !== null)
+            url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
+        if (assetExternalId !== undefined && assetExternalId !== null)
+            url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response) => {
+            return this.processGetUtilizationDatapoints(_response);
+        });
+    }
+    processGetUtilizationDatapoints(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result200 = MachineUtilizationDatapointListDto.fromJS(resultData200);
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+    getCompanyUtilizationDatapoints(utilizationType, startTime, endTime) {
+        let url_ = this.baseUrl + "/utilization/datapoints/company?";
+        if (utilizationType === null)
+            throw new Error("The parameter 'utilizationType' cannot be null.");
+        else if (utilizationType !== undefined)
+            url_ += "utilizationType=" + encodeURIComponent("" + utilizationType) + "&";
+        if (startTime !== undefined && startTime !== null)
+            url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
+        if (endTime !== undefined && endTime !== null)
+            url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response) => {
+            return this.processGetCompanyUtilizationDatapoints(_response);
+        });
+    }
+    processGetCompanyUtilizationDatapoints(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result200 = CompanyUtilizationDatapointListDto.fromJS(resultData200);
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+    getCrossCompanyUtilizationDatapoints(utilizationType, startTime, endTime) {
+        let url_ = this.baseUrl + "/utilization/datapoints/cross-company?";
+        if (utilizationType === null)
+            throw new Error("The parameter 'utilizationType' cannot be null.");
+        else if (utilizationType !== undefined)
+            url_ += "utilizationType=" + encodeURIComponent("" + utilizationType) + "&";
+        if (startTime !== undefined && startTime !== null)
+            url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
+        if (endTime !== undefined && endTime !== null)
+            url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response) => {
+            return this.processGetCrossCompanyUtilizationDatapoints(_response);
+        });
+    }
+    processGetCrossCompanyUtilizationDatapoints(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result200 = CrossCompanyUtilizationDatapointListDto.fromJS(resultData200);
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+}
 export class MrbClient extends AuthorizedApiBase {
     constructor(configuration, baseUrl, http) {
         super(configuration);
@@ -22515,6 +22752,332 @@ export class UpdatePulseSettings {
         return data;
     }
 }
+export class CompanyUtilizationDto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+        if (!data) {
+            this.companyUtilization = new UtilizationDetailsV2Dto();
+            this.groups = [];
+            this.ungroupedMachines = [];
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.utilizationType = _data["utilizationType"];
+            this.companyUtilization = _data["companyUtilization"] ? UtilizationDetailsV2Dto.fromJS(_data["companyUtilization"]) : new UtilizationDetailsV2Dto();
+            if (Array.isArray(_data["groups"])) {
+                this.groups = [];
+                for (let item of _data["groups"])
+                    this.groups.push(MachineGroupUtilizationV2Dto.fromJS(item));
+            }
+            if (Array.isArray(_data["ungroupedMachines"])) {
+                this.ungroupedMachines = [];
+                for (let item of _data["ungroupedMachines"])
+                    this.ungroupedMachines.push(MachineUtilizationV3Dto.fromJS(item));
+            }
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new CompanyUtilizationDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["utilizationType"] = this.utilizationType;
+        data["companyUtilization"] = this.companyUtilization ? this.companyUtilization.toJSON() : undefined;
+        if (Array.isArray(this.groups)) {
+            data["groups"] = [];
+            for (let item of this.groups)
+                data["groups"].push(item.toJSON());
+        }
+        if (Array.isArray(this.ungroupedMachines)) {
+            data["ungroupedMachines"] = [];
+            for (let item of this.ungroupedMachines)
+                data["ungroupedMachines"].push(item.toJSON());
+        }
+        return data;
+    }
+}
+export class UtilizationDetailsV2Dto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.utilizationPercent = _data["utilizationPercent"];
+            this.uptimeInSeconds = _data["uptimeInSeconds"];
+            this.downtimeInSeconds = _data["downtimeInSeconds"];
+            this.totalTimeInSeconds = _data["totalTimeInSeconds"];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new UtilizationDetailsV2Dto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["utilizationPercent"] = this.utilizationPercent;
+        data["uptimeInSeconds"] = this.uptimeInSeconds;
+        data["downtimeInSeconds"] = this.downtimeInSeconds;
+        data["totalTimeInSeconds"] = this.totalTimeInSeconds;
+        return data;
+    }
+}
+export class MachineGroupUtilizationV2Dto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+        if (!data) {
+            this.utilization = new UtilizationDetailsV2Dto();
+            this.machines = [];
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.name = _data["name"];
+            this.utilization = _data["utilization"] ? UtilizationDetailsV2Dto.fromJS(_data["utilization"]) : new UtilizationDetailsV2Dto();
+            if (Array.isArray(_data["machines"])) {
+                this.machines = [];
+                for (let item of _data["machines"])
+                    this.machines.push(MachineUtilizationV3Dto.fromJS(item));
+            }
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new MachineGroupUtilizationV2Dto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["name"] = this.name;
+        data["utilization"] = this.utilization ? this.utilization.toJSON() : undefined;
+        if (Array.isArray(this.machines)) {
+            data["machines"] = [];
+            for (let item of this.machines)
+                data["machines"].push(item.toJSON());
+        }
+        return data;
+    }
+}
+export class MachineUtilizationV3Dto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+        if (!data) {
+            this.utilization = new UtilizationDetailsV2Dto();
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.id = _data["id"];
+            this.name = _data["name"];
+            this.description = _data["description"];
+            this.utilization = _data["utilization"] ? UtilizationDetailsV2Dto.fromJS(_data["utilization"]) : new UtilizationDetailsV2Dto();
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new MachineUtilizationV3Dto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["id"] = this.id;
+        data["name"] = this.name;
+        data["description"] = this.description;
+        data["utilization"] = this.utilization ? this.utilization.toJSON() : undefined;
+        return data;
+    }
+}
+export class CrossCompanyUtilizationDto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+        if (!data) {
+            this.crossCompanyUtilization = new UtilizationDetailsV2Dto();
+            this.companies = [];
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.utilizationType = _data["utilizationType"];
+            this.crossCompanyUtilization = _data["crossCompanyUtilization"] ? UtilizationDetailsV2Dto.fromJS(_data["crossCompanyUtilization"]) : new UtilizationDetailsV2Dto();
+            if (Array.isArray(_data["companies"])) {
+                this.companies = [];
+                for (let item of _data["companies"])
+                    this.companies.push(CompanyUtilizationDto.fromJS(item));
+            }
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new CrossCompanyUtilizationDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["utilizationType"] = this.utilizationType;
+        data["crossCompanyUtilization"] = this.crossCompanyUtilization ? this.crossCompanyUtilization.toJSON() : undefined;
+        if (Array.isArray(this.companies)) {
+            data["companies"] = [];
+            for (let item of this.companies)
+                data["companies"].push(item.toJSON());
+        }
+        return data;
+    }
+}
+export class UtilizationDatapointListDto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            if (Array.isArray(_data["datapoints"])) {
+                this.datapoints = [];
+                for (let item of _data["datapoints"])
+                    this.datapoints.push(NumericNullableValueWithTimestamp.fromJS(item));
+            }
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new UtilizationDatapointListDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        if (Array.isArray(this.datapoints)) {
+            data["datapoints"] = [];
+            for (let item of this.datapoints)
+                data["datapoints"].push(item.toJSON());
+        }
+        return data;
+    }
+}
+export class MachineUtilizationDatapointListDto extends UtilizationDatapointListDto {
+    constructor(data) {
+        super(data);
+    }
+    init(_data) {
+        super.init(_data);
+        if (_data) {
+            this.externalId = _data["externalId"];
+            this.id = _data["id"];
+            this.name = _data["name"];
+            this.description = _data["description"];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new MachineUtilizationDatapointListDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["externalId"] = this.externalId;
+        data["id"] = this.id;
+        data["name"] = this.name;
+        data["description"] = this.description;
+        super.toJSON(data);
+        return data;
+    }
+}
+export class CompanyUtilizationDatapointListDto extends UtilizationDatapointListDto {
+    constructor(data) {
+        super(data);
+    }
+    init(_data) {
+        super.init(_data);
+        if (_data) {
+            this.companyId = _data["companyId"];
+            this.companyName = _data["companyName"];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new CompanyUtilizationDatapointListDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["companyId"] = this.companyId;
+        data["companyName"] = this.companyName;
+        super.toJSON(data);
+        return data;
+    }
+}
+export class CrossCompanyUtilizationDatapointListDto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            if (Array.isArray(_data["companies"])) {
+                this.companies = [];
+                for (let item of _data["companies"])
+                    this.companies.push(CompanyUtilizationDatapointListDto.fromJS(item));
+            }
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new CrossCompanyUtilizationDatapointListDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        if (Array.isArray(this.companies)) {
+            data["companies"] = [];
+            for (let item of this.companies)
+                data["companies"].push(item.toJSON());
+        }
+        return data;
+    }
+}
 export class MrbInstanceDto {
     constructor(data) {
         if (data) {
@@ -26388,6 +26951,7 @@ export class MachineCapacityDto {
         if (_data) {
             this.machineExternalId = _data["machineExternalId"];
             this.name = _data["name"];
+            this.description = _data["description"];
             this.utilizationPercent = _data["utilizationPercent"];
             this.comment = _data["comment"];
             if (Array.isArray(_data["capacity"])) {
@@ -26410,6 +26974,7 @@ export class MachineCapacityDto {
         data = typeof data === 'object' ? data : {};
         data["machineExternalId"] = this.machineExternalId;
         data["name"] = this.name;
+        data["description"] = this.description;
         data["utilizationPercent"] = this.utilizationPercent;
         data["comment"] = this.comment;
         if (Array.isArray(this.capacity)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ignos/api-client",
-  "version": "20250116.0.10991",
+  "version": "20250121.0.10997",
   "description": "IGNOS API Client",
   "type": "module",
   "main": "lib/index.js",