@ignos/api-client 20250130.0.11040-alpha → 20250130.0.11051

package/lib/ignosportal-api.d.ts

@@ -806,6 +806,19 @@ export declare class KpiAdminClient extends AuthorizedApiBase implements IKpiAdm
     updateCalenderCapacityAdmin(request: UpdateCalenderCapacity): Promise<CalenderCapacityDto>;
     protected processUpdateCalenderCapacityAdmin(response: Response): Promise<CalenderCapacityDto>;
 }
+export interface IKpiClient {
+    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined): Promise<MachineKpiDto[]>;
+}
+export declare class KpiClient extends AuthorizedApiBase implements IKpiClient {
+    private http;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: IAccessTokenProvider, baseUrl?: string, http?: {
+        fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+    });
+    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined): Promise<MachineKpiDto[]>;
+    protected processGetMachineKpi(response: Response): Promise<MachineKpiDto[]>;
+}
 export interface IMachinesClient {
     listMachines(onlyConnectedMachines: boolean | undefined): Promise<MachineDto[]>;
     listMachineGroups(): Promise<MachineGroupDto[]>;
@@ -814,6 +827,7 @@ export interface IMachinesClient {
     deleteMachineGroup(id: string): Promise<void>;
     listCurrentMachineStates(assetId: number | null | undefined): Promise<MachineStateListDto>;
     listMachineStates(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
+    listLastDowntimeMachineStates(id: number, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
     getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
     listMachineErpData(): Promise<MachineErpDataListDto>;
     getMachineErpData(id: number): Promise<MachineErpDataDto>;
@@ -846,6 +860,8 @@ export declare class MachinesClient extends AuthorizedApiBase implements IMachin
     protected processListCurrentMachineStates(response: Response): Promise<MachineStateListDto>;
     listMachineStates(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
     protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
+    listLastDowntimeMachineStates(id: number, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
+    protected processListLastDowntimeMachineStates(response: Response): Promise<DowntimeMachineStateDto[]>;
     getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
     protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
     listMachineErpData(): Promise<MachineErpDataListDto>;
@@ -5598,6 +5614,22 @@ export interface IUpdateCalenderCapacity {
     date?: Date;
     dayCapacity?: CalenderDayCapacityDto;
 }
+export declare class MachineKpiDto implements IMachineKpiDto {
+    date?: Date;
+    hoursCapacity?: number;
+    uptime?: number;
+    utilizationGoal?: number;
+    constructor(data?: IMachineKpiDto);
+    init(_data?: any): void;
+    static fromJS(data: any): MachineKpiDto;
+    toJSON(data?: any): any;
+}
+export interface IMachineKpiDto {
+    date?: Date;
+    hoursCapacity?: number;
+    uptime?: number;
+    utilizationGoal?: number;
+}
 export declare class MachineDto implements IMachineDto {
     id: number;
     externalId: string;
@@ -5724,6 +5756,20 @@ export interface IMachineStateDto {
     machineState: MachineState;
     startTime?: Date;
 }
+export declare class DowntimeMachineStateDto implements IDowntimeMachineStateDto {
+    datapoint?: MachineStateDatapoint;
+    startTime?: Date;
+    endTime?: Date;
+    constructor(data?: IDowntimeMachineStateDto);
+    init(_data?: any): void;
+    static fromJS(data: any): DowntimeMachineStateDto;
+    toJSON(data?: any): any;
+}
+export interface IDowntimeMachineStateDto {
+    datapoint?: MachineStateDatapoint;
+    startTime?: Date;
+    endTime?: Date;
+}
 export declare class MachineErpDataListDto implements IMachineErpDataListDto {
     machines?: SingleMachineErpDataListDto[];
     constructor(data?: IMachineErpDataListDto);

package/lib/ignosportal-api.js

@@ -6110,6 +6110,67 @@ export class KpiAdminClient extends AuthorizedApiBase {
         return Promise.resolve(null);
     }
 }
+export class KpiClient extends AuthorizedApiBase {
+    constructor(configuration, baseUrl, http) {
+        super(configuration);
+        this.jsonParseReviver = undefined;
+        this.http = http ? http : window;
+        this.baseUrl = baseUrl !== null && baseUrl !== void 0 ? baseUrl : "";
+    }
+    getMachineKpi(machineExternalId, startDate, endDate) {
+        let url_ = this.baseUrl + "/kpi/capacity?";
+        if (machineExternalId === null)
+            throw new Error("The parameter 'machineExternalId' cannot be null.");
+        else if (machineExternalId !== undefined)
+            url_ += "machineExternalId=" + encodeURIComponent("" + machineExternalId) + "&";
+        if (startDate === null)
+            throw new Error("The parameter 'startDate' cannot be null.");
+        else if (startDate !== undefined)
+            url_ += "startDate=" + encodeURIComponent(startDate ? "" + startDate.toISOString() : "") + "&";
+        if (endDate === null)
+            throw new Error("The parameter 'endDate' cannot be null.");
+        else if (endDate !== undefined)
+            url_ += "endDate=" + encodeURIComponent(endDate ? "" + endDate.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.processGetMachineKpi(_response);
+        });
+    }
+    processGetMachineKpi(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);
+                if (Array.isArray(resultData200)) {
+                    result200 = [];
+                    for (let item of resultData200)
+                        result200.push(MachineKpiDto.fromJS(item));
+                }
+                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 MachinesClient extends AuthorizedApiBase {
     constructor(configuration, baseUrl, http) {
         super(configuration);
@@ -6404,6 +6465,54 @@ export class MachinesClient extends AuthorizedApiBase {
         }
         return Promise.resolve(null);
     }
+    listLastDowntimeMachineStates(id, endTime, maxStates) {
+        let url_ = this.baseUrl + "/machines/{id}/lastdowntimestates?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (endTime !== undefined && endTime !== null)
+            url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
+        if (maxStates !== undefined && maxStates !== null)
+            url_ += "maxStates=" + encodeURIComponent("" + maxStates) + "&";
+        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.processListLastDowntimeMachineStates(_response);
+        });
+    }
+    processListLastDowntimeMachineStates(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);
+                if (Array.isArray(resultData200)) {
+                    result200 = [];
+                    for (let item of resultData200)
+                        result200.push(DowntimeMachineStateDto.fromJS(item));
+                }
+                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);
+    }
     getMachineStatesSummary(id, startTime, endTime) {
         let url_ = this.baseUrl + "/machines/{id}/states/summary?";
         if (id === undefined || id === null)
@@ -27192,6 +27301,38 @@ export class UpdateCalenderCapacity {
         return data;
     }
 }
+export class MachineKpiDto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.date = _data["date"] ? new Date(_data["date"].toString()) : undefined;
+            this.hoursCapacity = _data["hoursCapacity"];
+            this.uptime = _data["uptime"];
+            this.utilizationGoal = _data["utilizationGoal"];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new MachineKpiDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["date"] = this.date ? this.date.toISOString() : undefined;
+        data["hoursCapacity"] = this.hoursCapacity;
+        data["uptime"] = this.uptime;
+        data["utilizationGoal"] = this.utilizationGoal;
+        return data;
+    }
+}
 export class MachineDto {
     constructor(data) {
         if (data) {
@@ -27489,6 +27630,36 @@ export class MachineStateDto {
         return data;
     }
 }
+export class DowntimeMachineStateDto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.datapoint = _data["datapoint"] ? MachineStateDatapoint.fromJS(_data["datapoint"]) : undefined;
+            this.startTime = _data["startTime"] ? new Date(_data["startTime"].toString()) : undefined;
+            this.endTime = _data["endTime"] ? new Date(_data["endTime"].toString()) : undefined;
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new DowntimeMachineStateDto();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["datapoint"] = this.datapoint ? this.datapoint.toJSON() : undefined;
+        data["startTime"] = this.startTime ? this.startTime.toISOString() : undefined;
+        data["endTime"] = this.endTime ? this.endTime.toISOString() : undefined;
+        return data;
+    }
+}
 export class MachineErpDataListDto {
     constructor(data) {
         if (data) {

package/package.json

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

package/src/ignosportal-api.ts

@@ -6558,6 +6558,75 @@ export class KpiAdminClient extends AuthorizedApiBase implements IKpiAdminClient
     }
 }
 
+export interface IKpiClient {
+
+    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined): Promise<MachineKpiDto[]>;
+}
+
+export class KpiClient extends AuthorizedApiBase implements IKpiClient {
+    private http: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> };
+    private baseUrl: string;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined = undefined;
+
+    constructor(configuration: IAccessTokenProvider, baseUrl?: string, http?: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> }) {
+        super(configuration);
+        this.http = http ? http : window as any;
+        this.baseUrl = baseUrl ?? "";
+    }
+
+    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined): Promise<MachineKpiDto[]> {
+        let url_ = this.baseUrl + "/kpi/capacity?";
+        if (machineExternalId === null)
+            throw new Error("The parameter 'machineExternalId' cannot be null.");
+        else if (machineExternalId !== undefined)
+            url_ += "machineExternalId=" + encodeURIComponent("" + machineExternalId) + "&";
+        if (startDate === null)
+            throw new Error("The parameter 'startDate' cannot be null.");
+        else if (startDate !== undefined)
+            url_ += "startDate=" + encodeURIComponent(startDate ? "" + startDate.toISOString() : "") + "&";
+        if (endDate === null)
+            throw new Error("The parameter 'endDate' cannot be null.");
+        else if (endDate !== undefined)
+            url_ += "endDate=" + encodeURIComponent(endDate ? "" + endDate.toISOString() : "") + "&";
+        url_ = url_.replace(/[?&]$/, "");
+
+        let options_: RequestInit = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response: Response) => {
+            return this.processGetMachineKpi(_response);
+        });
+    }
+
+    protected processGetMachineKpi(response: Response): Promise<MachineKpiDto[]> {
+        const status = response.status;
+        let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+            let result200: any = null;
+            let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            if (Array.isArray(resultData200)) {
+                result200 = [] as any;
+                for (let item of resultData200)
+                    result200!.push(MachineKpiDto.fromJS(item));
+            }
+            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<MachineKpiDto[]>(null as any);
+    }
+}
+
 export interface IMachinesClient {
 
     listMachines(onlyConnectedMachines: boolean | undefined): Promise<MachineDto[]>;
@@ -6574,6 +6643,8 @@ export interface IMachinesClient {
 
     listMachineStates(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
 
+    listLastDowntimeMachineStates(id: number, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]>;
+
     getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
 
     listMachineErpData(): Promise<MachineErpDataListDto>;
@@ -6889,6 +6960,53 @@ export class MachinesClient extends AuthorizedApiBase implements IMachinesClient
         return Promise.resolve<MachineStateDatapoint[]>(null as any);
     }
 
+    listLastDowntimeMachineStates(id: number, endTime: Date | null | undefined, maxStates: number | null | undefined): Promise<DowntimeMachineStateDto[]> {
+        let url_ = this.baseUrl + "/machines/{id}/lastdowntimestates?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (endTime !== undefined && endTime !== null)
+            url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
+        if (maxStates !== undefined && maxStates !== null)
+            url_ += "maxStates=" + encodeURIComponent("" + maxStates) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+
+        let options_: RequestInit = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response: Response) => {
+            return this.processListLastDowntimeMachineStates(_response);
+        });
+    }
+
+    protected processListLastDowntimeMachineStates(response: Response): Promise<DowntimeMachineStateDto[]> {
+        const status = response.status;
+        let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+            let result200: any = null;
+            let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            if (Array.isArray(resultData200)) {
+                result200 = [] as any;
+                for (let item of resultData200)
+                    result200!.push(DowntimeMachineStateDto.fromJS(item));
+            }
+            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<DowntimeMachineStateDto[]>(null as any);
+    }
+
     getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto> {
         let url_ = this.baseUrl + "/machines/{id}/states/summary?";
         if (id === undefined || id === null)
@@ -31702,6 +31820,54 @@ export interface IUpdateCalenderCapacity {
     dayCapacity?: CalenderDayCapacityDto;
 }
 
+export class MachineKpiDto implements IMachineKpiDto {
+    date?: Date;
+    hoursCapacity?: number;
+    uptime?: number;
+    utilizationGoal?: number;
+
+    constructor(data?: IMachineKpiDto) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    (<any>this)[property] = (<any>data)[property];
+            }
+        }
+    }
+
+    init(_data?: any) {
+        if (_data) {
+            this.date = _data["date"] ? new Date(_data["date"].toString()) : <any>undefined;
+            this.hoursCapacity = _data["hoursCapacity"];
+            this.uptime = _data["uptime"];
+            this.utilizationGoal = _data["utilizationGoal"];
+        }
+    }
+
+    static fromJS(data: any): MachineKpiDto {
+        data = typeof data === 'object' ? data : {};
+        let result = new MachineKpiDto();
+        result.init(data);
+        return result;
+    }
+
+    toJSON(data?: any) {
+        data = typeof data === 'object' ? data : {};
+        data["date"] = this.date ? this.date.toISOString() : <any>undefined;
+        data["hoursCapacity"] = this.hoursCapacity;
+        data["uptime"] = this.uptime;
+        data["utilizationGoal"] = this.utilizationGoal;
+        return data;
+    }
+}
+
+export interface IMachineKpiDto {
+    date?: Date;
+    hoursCapacity?: number;
+    uptime?: number;
+    utilizationGoal?: number;
+}
+
 export class MachineDto implements IMachineDto {
     id!: number;
     externalId!: string;
@@ -32125,6 +32291,50 @@ export interface IMachineStateDto {
     startTime?: Date;
 }
 
+export class DowntimeMachineStateDto implements IDowntimeMachineStateDto {
+    datapoint?: MachineStateDatapoint;
+    startTime?: Date;
+    endTime?: Date;
+
+    constructor(data?: IDowntimeMachineStateDto) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    (<any>this)[property] = (<any>data)[property];
+            }
+        }
+    }
+
+    init(_data?: any) {
+        if (_data) {
+            this.datapoint = _data["datapoint"] ? MachineStateDatapoint.fromJS(_data["datapoint"]) : <any>undefined;
+            this.startTime = _data["startTime"] ? new Date(_data["startTime"].toString()) : <any>undefined;
+            this.endTime = _data["endTime"] ? new Date(_data["endTime"].toString()) : <any>undefined;
+        }
+    }
+
+    static fromJS(data: any): DowntimeMachineStateDto {
+        data = typeof data === 'object' ? data : {};
+        let result = new DowntimeMachineStateDto();
+        result.init(data);
+        return result;
+    }
+
+    toJSON(data?: any) {
+        data = typeof data === 'object' ? data : {};
+        data["datapoint"] = this.datapoint ? this.datapoint.toJSON() : <any>undefined;
+        data["startTime"] = this.startTime ? this.startTime.toISOString() : <any>undefined;
+        data["endTime"] = this.endTime ? this.endTime.toISOString() : <any>undefined;
+        return data;
+    }
+}
+
+export interface IDowntimeMachineStateDto {
+    datapoint?: MachineStateDatapoint;
+    startTime?: Date;
+    endTime?: Date;
+}
+
 export class MachineErpDataListDto implements IMachineErpDataListDto {
     machines?: SingleMachineErpDataListDto[];