@ignos/api-client 20250214.0.11147 → 20250219.0.11204

package/lib/ignosportal-api.d.ts

@@ -807,7 +807,7 @@ export declare class KpiAdminClient extends AuthorizedApiBase implements IKpiAdm
     protected processUpdateCalenderCapacityAdmin(response: Response): Promise<CalenderCapacityDto>;
 }
 export interface IKpiClient {
-    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto[]>;
+    getMachineKpi(machineExternalId: string | undefined, previousPeriodStartDate: Date | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto>;
     getMachineDailyUptime(machineExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<MachineDailyUptimeDto>;
 }
 export declare class KpiClient extends AuthorizedApiBase implements IKpiClient {
@@ -817,8 +817,8 @@ export declare class KpiClient extends AuthorizedApiBase implements IKpiClient {
     constructor(configuration: IAccessTokenProvider, baseUrl?: string, http?: {
         fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
     });
-    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto[]>;
-    protected processGetMachineKpi(response: Response): Promise<MachineKpiDto[]>;
+    getMachineKpi(machineExternalId: string | undefined, previousPeriodStartDate: Date | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto>;
+    protected processGetMachineKpi(response: Response): Promise<MachineKpiDto>;
     getMachineDailyUptime(machineExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<MachineDailyUptimeDto>;
     protected processGetMachineDailyUptime(response: Response): Promise<MachineDailyUptimeDto>;
 }
@@ -5567,8 +5567,8 @@ export declare class MachineCapacityDto implements IMachineCapacityDto {
     machineExternalId: string;
     name: string;
     description?: string | null;
-    utilizationPercent: number;
     comment?: string | null;
+    utilizationPercent: number;
     capacity: MachineCapacitySettingsDto[];
     created?: Date | null;
     updatedBy?: string | null;
@@ -5582,8 +5582,8 @@ export interface IMachineCapacityDto {
     machineExternalId: string;
     name: string;
     description?: string | null;
-    utilizationPercent: number;
     comment?: string | null;
+    utilizationPercent: number;
     capacity: MachineCapacitySettingsDto[];
     created?: Date | null;
     updatedBy?: string | null;
@@ -5643,20 +5643,36 @@ export interface IUpdateCalenderCapacity {
     dayCapacity?: CalenderDayCapacityDto;
 }
 export declare class MachineKpiDto implements IMachineKpiDto {
-    date?: Date;
-    uptime?: number;
-    capacity?: number;
-    utilizationGoal?: number;
+    uptimeToNow: number;
+    uptimeToNowPreviousPeriod: number;
+    averageUpTime: number;
+    uptimeTargetReached: number;
+    days: MachineDayKpiDto[];
     constructor(data?: IMachineKpiDto);
     init(_data?: any): void;
     static fromJS(data: any): MachineKpiDto;
     toJSON(data?: any): any;
 }
 export interface IMachineKpiDto {
-    date?: Date;
-    uptime?: number;
-    capacity?: number;
-    utilizationGoal?: number;
+    uptimeToNow: number;
+    uptimeToNowPreviousPeriod: number;
+    averageUpTime: number;
+    uptimeTargetReached: number;
+    days: MachineDayKpiDto[];
+}
+export declare class MachineDayKpiDto implements IMachineDayKpiDto {
+    date: Date;
+    uptime: number;
+    utilizationGoal: number;
+    constructor(data?: IMachineDayKpiDto);
+    init(_data?: any): void;
+    static fromJS(data: any): MachineDayKpiDto;
+    toJSON(data?: any): any;
+}
+export interface IMachineDayKpiDto {
+    date: Date;
+    uptime: number;
+    utilizationGoal: number;
 }
 export declare class MachineDailyUptimeDto implements IMachineDailyUptimeDto {
     date?: Date;
@@ -10683,8 +10699,8 @@ export interface IResourceGroupDto {
     department?: DepartmentDto | null;
 }
 export declare class ProductionResourceDto implements IProductionResourceDto {
-    id?: string;
-    name?: string;
+    id?: string | null;
+    name?: string | null;
     department?: DepartmentDto | null;
     constructor(data?: IProductionResourceDto);
     init(_data?: any): void;
@@ -10692,8 +10708,8 @@ export declare class ProductionResourceDto implements IProductionResourceDto {
     toJSON(data?: any): any;
 }
 export interface IProductionResourceDto {
-    id?: string;
-    name?: string;
+    id?: string | null;
+    name?: string | null;
     department?: DepartmentDto | null;
 }
 export declare class PagedResultOfMeasurementFormListDto implements IPagedResultOfMeasurementFormListDto {

package/lib/ignosportal-api.js

@@ -6117,12 +6117,16 @@ export class KpiClient extends AuthorizedApiBase {
         this.http = http ? http : window;
         this.baseUrl = baseUrl !== null && baseUrl !== void 0 ? baseUrl : "";
     }
-    getMachineKpi(machineExternalId, startDate, endDate, utcOffset) {
+    getMachineKpi(machineExternalId, previousPeriodStartDate, startDate, endDate, utcOffset) {
         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 (previousPeriodStartDate === null)
+            throw new Error("The parameter 'previousPeriodStartDate' cannot be null.");
+        else if (previousPeriodStartDate !== undefined)
+            url_ += "previousPeriodStartDate=" + encodeURIComponent(previousPeriodStartDate ? "" + previousPeriodStartDate.toISOString() : "") + "&";
         if (startDate === null)
             throw new Error("The parameter 'startDate' cannot be null.");
         else if (startDate !== undefined)
@@ -6159,11 +6163,7 @@ export class KpiClient extends AuthorizedApiBase {
             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));
-                }
+                result200 = MachineKpiDto.fromJS(resultData200);
                 return result200;
             });
         }
@@ -27293,8 +27293,8 @@ export class MachineCapacityDto {
             this.machineExternalId = _data["machineExternalId"];
             this.name = _data["name"];
             this.description = _data["description"];
-            this.utilizationPercent = _data["utilizationPercent"];
             this.comment = _data["comment"];
+            this.utilizationPercent = _data["utilizationPercent"];
             if (Array.isArray(_data["capacity"])) {
                 this.capacity = [];
                 for (let item of _data["capacity"])
@@ -27316,8 +27316,8 @@ export class MachineCapacityDto {
         data["machineExternalId"] = this.machineExternalId;
         data["name"] = this.name;
         data["description"] = this.description;
-        data["utilizationPercent"] = this.utilizationPercent;
         data["comment"] = this.comment;
+        data["utilizationPercent"] = this.utilizationPercent;
         if (Array.isArray(this.capacity)) {
             data["capacity"] = [];
             for (let item of this.capacity)
@@ -27454,6 +27454,51 @@ export class UpdateCalenderCapacity {
     }
 }
 export class MachineKpiDto {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+        if (!data) {
+            this.days = [];
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.uptimeToNow = _data["uptimeToNow"];
+            this.uptimeToNowPreviousPeriod = _data["uptimeToNowPreviousPeriod"];
+            this.averageUpTime = _data["averageUpTime"];
+            this.uptimeTargetReached = _data["uptimeTargetReached"];
+            if (Array.isArray(_data["days"])) {
+                this.days = [];
+                for (let item of _data["days"])
+                    this.days.push(MachineDayKpiDto.fromJS(item));
+            }
+        }
+    }
+    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["uptimeToNow"] = this.uptimeToNow;
+        data["uptimeToNowPreviousPeriod"] = this.uptimeToNowPreviousPeriod;
+        data["averageUpTime"] = this.averageUpTime;
+        data["uptimeTargetReached"] = this.uptimeTargetReached;
+        if (Array.isArray(this.days)) {
+            data["days"] = [];
+            for (let item of this.days)
+                data["days"].push(item.toJSON());
+        }
+        return data;
+    }
+}
+export class MachineDayKpiDto {
     constructor(data) {
         if (data) {
             for (var property in data) {
@@ -27466,13 +27511,12 @@ export class MachineKpiDto {
         if (_data) {
             this.date = _data["date"] ? new Date(_data["date"].toString()) : undefined;
             this.uptime = _data["uptime"];
-            this.capacity = _data["capacity"];
             this.utilizationGoal = _data["utilizationGoal"];
         }
     }
     static fromJS(data) {
         data = typeof data === 'object' ? data : {};
-        let result = new MachineKpiDto();
+        let result = new MachineDayKpiDto();
         result.init(data);
         return result;
     }
@@ -27480,7 +27524,6 @@ export class MachineKpiDto {
         data = typeof data === 'object' ? data : {};
         data["date"] = this.date ? this.date.toISOString() : undefined;
         data["uptime"] = this.uptime;
-        data["capacity"] = this.capacity;
         data["utilizationGoal"] = this.utilizationGoal;
         return data;
     }

package/package.json

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

package/src/ignosportal-api.ts

@@ -6560,7 +6560,7 @@ export class KpiAdminClient extends AuthorizedApiBase implements IKpiAdminClient
 
 export interface IKpiClient {
 
-    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto[]>;
+    getMachineKpi(machineExternalId: string | undefined, previousPeriodStartDate: Date | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto>;
 
     getMachineDailyUptime(machineExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<MachineDailyUptimeDto>;
 }
@@ -6576,12 +6576,16 @@ export class KpiClient extends AuthorizedApiBase implements IKpiClient {
         this.baseUrl = baseUrl ?? "";
     }
 
-    getMachineKpi(machineExternalId: string | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto[]> {
+    getMachineKpi(machineExternalId: string | undefined, previousPeriodStartDate: Date | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | 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 (previousPeriodStartDate === null)
+            throw new Error("The parameter 'previousPeriodStartDate' cannot be null.");
+        else if (previousPeriodStartDate !== undefined)
+            url_ += "previousPeriodStartDate=" + encodeURIComponent(previousPeriodStartDate ? "" + previousPeriodStartDate.toISOString() : "") + "&";
         if (startDate === null)
             throw new Error("The parameter 'startDate' cannot be null.");
         else if (startDate !== undefined)
@@ -6610,18 +6614,14 @@ export class KpiClient extends AuthorizedApiBase implements IKpiClient {
         });
     }
 
-    protected processGetMachineKpi(response: Response): Promise<MachineKpiDto[]> {
+    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));
-            }
+            result200 = MachineKpiDto.fromJS(resultData200);
             return result200;
             });
         } else if (status !== 200 && status !== 204) {
@@ -6629,7 +6629,7 @@ export class KpiClient extends AuthorizedApiBase implements IKpiClient {
             return throwException("An unexpected server error occurred.", status, _responseText, _headers);
             });
         }
-        return Promise.resolve<MachineKpiDto[]>(null as any);
+        return Promise.resolve<MachineKpiDto>(null as any);
     }
 
     getMachineDailyUptime(machineExternalId: string | undefined, date: Date | undefined, utcOffset: number | undefined): Promise<MachineDailyUptimeDto> {
@@ -31743,8 +31743,8 @@ export class MachineCapacityDto implements IMachineCapacityDto {
     machineExternalId!: string;
     name!: string;
     description?: string | null;
-    utilizationPercent!: number;
     comment?: string | null;
+    utilizationPercent!: number;
     capacity!: MachineCapacitySettingsDto[];
     created?: Date | null;
     updatedBy?: string | null;
@@ -31767,8 +31767,8 @@ export class MachineCapacityDto implements IMachineCapacityDto {
             this.machineExternalId = _data["machineExternalId"];
             this.name = _data["name"];
             this.description = _data["description"];
-            this.utilizationPercent = _data["utilizationPercent"];
             this.comment = _data["comment"];
+            this.utilizationPercent = _data["utilizationPercent"];
             if (Array.isArray(_data["capacity"])) {
                 this.capacity = [] as any;
                 for (let item of _data["capacity"])
@@ -31792,8 +31792,8 @@ export class MachineCapacityDto implements IMachineCapacityDto {
         data["machineExternalId"] = this.machineExternalId;
         data["name"] = this.name;
         data["description"] = this.description;
-        data["utilizationPercent"] = this.utilizationPercent;
         data["comment"] = this.comment;
+        data["utilizationPercent"] = this.utilizationPercent;
         if (Array.isArray(this.capacity)) {
             data["capacity"] = [];
             for (let item of this.capacity)
@@ -31810,8 +31810,8 @@ export interface IMachineCapacityDto {
     machineExternalId: string;
     name: string;
     description?: string | null;
-    utilizationPercent: number;
     comment?: string | null;
+    utilizationPercent: number;
     capacity: MachineCapacitySettingsDto[];
     created?: Date | null;
     updatedBy?: string | null;
@@ -31997,10 +31997,11 @@ export interface IUpdateCalenderCapacity {
 }
 
 export class MachineKpiDto implements IMachineKpiDto {
-    date?: Date;
-    uptime?: number;
-    capacity?: number;
-    utilizationGoal?: number;
+    uptimeToNow!: number;
+    uptimeToNowPreviousPeriod!: number;
+    averageUpTime!: number;
+    uptimeTargetReached!: number;
+    days!: MachineDayKpiDto[];
 
     constructor(data?: IMachineKpiDto) {
         if (data) {
@@ -32009,20 +32010,80 @@ export class MachineKpiDto implements IMachineKpiDto {
                     (<any>this)[property] = (<any>data)[property];
             }
         }
+        if (!data) {
+            this.days = [];
+        }
+    }
+
+    init(_data?: any) {
+        if (_data) {
+            this.uptimeToNow = _data["uptimeToNow"];
+            this.uptimeToNowPreviousPeriod = _data["uptimeToNowPreviousPeriod"];
+            this.averageUpTime = _data["averageUpTime"];
+            this.uptimeTargetReached = _data["uptimeTargetReached"];
+            if (Array.isArray(_data["days"])) {
+                this.days = [] as any;
+                for (let item of _data["days"])
+                    this.days!.push(MachineDayKpiDto.fromJS(item));
+            }
+        }
+    }
+
+    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["uptimeToNow"] = this.uptimeToNow;
+        data["uptimeToNowPreviousPeriod"] = this.uptimeToNowPreviousPeriod;
+        data["averageUpTime"] = this.averageUpTime;
+        data["uptimeTargetReached"] = this.uptimeTargetReached;
+        if (Array.isArray(this.days)) {
+            data["days"] = [];
+            for (let item of this.days)
+                data["days"].push(item.toJSON());
+        }
+        return data;
+    }
+}
+
+export interface IMachineKpiDto {
+    uptimeToNow: number;
+    uptimeToNowPreviousPeriod: number;
+    averageUpTime: number;
+    uptimeTargetReached: number;
+    days: MachineDayKpiDto[];
+}
+
+export class MachineDayKpiDto implements IMachineDayKpiDto {
+    date!: Date;
+    uptime!: number;
+    utilizationGoal!: number;
+
+    constructor(data?: IMachineDayKpiDto) {
+        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.uptime = _data["uptime"];
-            this.capacity = _data["capacity"];
             this.utilizationGoal = _data["utilizationGoal"];
         }
     }
 
-    static fromJS(data: any): MachineKpiDto {
+    static fromJS(data: any): MachineDayKpiDto {
         data = typeof data === 'object' ? data : {};
-        let result = new MachineKpiDto();
+        let result = new MachineDayKpiDto();
         result.init(data);
         return result;
     }
@@ -32031,17 +32092,15 @@ export class MachineKpiDto implements IMachineKpiDto {
         data = typeof data === 'object' ? data : {};
         data["date"] = this.date ? this.date.toISOString() : <any>undefined;
         data["uptime"] = this.uptime;
-        data["capacity"] = this.capacity;
         data["utilizationGoal"] = this.utilizationGoal;
         return data;
     }
 }
 
-export interface IMachineKpiDto {
-    date?: Date;
-    uptime?: number;
-    capacity?: number;
-    utilizationGoal?: number;
+export interface IMachineDayKpiDto {
+    date: Date;
+    uptime: number;
+    utilizationGoal: number;
 }
 
 export class MachineDailyUptimeDto implements IMachineDailyUptimeDto {
@@ -47351,8 +47410,8 @@ export interface IResourceGroupDto {
 }
 
 export class ProductionResourceDto implements IProductionResourceDto {
-    id?: string;
-    name?: string;
+    id?: string | null;
+    name?: string | null;
     department?: DepartmentDto | null;
 
     constructor(data?: IProductionResourceDto) {
@@ -47389,8 +47448,8 @@ export class ProductionResourceDto implements IProductionResourceDto {
 }
 
 export interface IProductionResourceDto {
-    id?: string;
-    name?: string;
+    id?: string | null;
+    name?: string | null;
     department?: DepartmentDto | null;
 }