@ignos/api-client 20250704.0.12089-alpha → 20250707.0.12102
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/ignosportal-api.d.ts +94 -38
- package/lib/ignosportal-api.js +220 -97
- package/package.json +1 -1
- package/src/ignosportal-api.ts +299 -128
package/lib/ignosportal-api.d.ts
CHANGED
|
@@ -176,7 +176,6 @@ export interface IMachineUtilizationClient {
|
|
|
176
176
|
listMachineUptimesToday(request: ListMachineUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
177
177
|
listPowerOnUtilizationDatapoints(id: number | null | undefined, externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
178
178
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
179
|
-
getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
|
|
180
179
|
}
|
|
181
180
|
export declare class MachineUtilizationClient extends AuthorizedApiBase implements IMachineUtilizationClient {
|
|
182
181
|
private http;
|
|
@@ -218,8 +217,6 @@ export declare class MachineUtilizationClient extends AuthorizedApiBase implemen
|
|
|
218
217
|
protected processListPowerOnUtilizationDatapoints(response: Response): Promise<PowerOnUtilizationList>;
|
|
219
218
|
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
220
219
|
protected processGetFactoryUtilization(response: Response): Promise<PowerOnUtilizationDto>;
|
|
221
|
-
getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
|
|
222
|
-
protected processGetProgramTimeline(response: Response): Promise<ProgramDatapoint[]>;
|
|
223
220
|
}
|
|
224
221
|
export interface IMeClient {
|
|
225
222
|
getMyApps(): Promise<UserAppDto[]>;
|
|
@@ -395,7 +392,7 @@ export declare class PulseClient extends AuthorizedApiBase implements IPulseClie
|
|
|
395
392
|
export interface IUtilizationClient {
|
|
396
393
|
getCompanyUtilization(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CompanyUtilizationDto>;
|
|
397
394
|
getCrossCompanyUtilization(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CrossCompanyUtilizationDto>;
|
|
398
|
-
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined,
|
|
395
|
+
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
|
|
399
396
|
getCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CompanyUtilizationDatapointListDto>;
|
|
400
397
|
getCrossCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CrossCompanyUtilizationDatapointListDto>;
|
|
401
398
|
}
|
|
@@ -410,7 +407,7 @@ export declare class UtilizationClient extends AuthorizedApiBase implements IUti
|
|
|
410
407
|
protected processGetCompanyUtilization(response: Response): Promise<CompanyUtilizationDto>;
|
|
411
408
|
getCrossCompanyUtilization(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CrossCompanyUtilizationDto>;
|
|
412
409
|
protected processGetCrossCompanyUtilization(response: Response): Promise<CrossCompanyUtilizationDto>;
|
|
413
|
-
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined,
|
|
410
|
+
getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
|
|
414
411
|
protected processGetUtilizationDatapoints(response: Response): Promise<MachineUtilizationDatapointListDto>;
|
|
415
412
|
getCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CompanyUtilizationDatapointListDto>;
|
|
416
413
|
protected processGetCompanyUtilizationDatapoints(response: Response): Promise<CompanyUtilizationDatapointListDto>;
|
|
@@ -790,8 +787,10 @@ export declare class DowntimeReasonsClient extends AuthorizedApiBase implements
|
|
|
790
787
|
export interface IKpiAdminClient {
|
|
791
788
|
getMachineCapacityAdmin(): Promise<MachineGroupCapacityDto[]>;
|
|
792
789
|
updateMachineCapacityAdmin(request: UpdateMachinesCapacity): Promise<MachineCapacityDto>;
|
|
793
|
-
|
|
794
|
-
|
|
790
|
+
getCalendarCapacityAdmin(startDate: Date | undefined, endDate: Date | undefined): Promise<CalendarDayDto[]>;
|
|
791
|
+
updateCalendarCapacityAdmin(request: UpdateCalendarCapacity): Promise<CalendarCapacityDto>;
|
|
792
|
+
getCalendarSettings(): Promise<CalendarSettingsDto>;
|
|
793
|
+
updateCalendarSettings(cmd: UpdateCalendarSettingsCommand): Promise<CalendarSettingsDto>;
|
|
795
794
|
}
|
|
796
795
|
export declare class KpiAdminClient extends AuthorizedApiBase implements IKpiAdminClient {
|
|
797
796
|
private http;
|
|
@@ -804,10 +803,14 @@ export declare class KpiAdminClient extends AuthorizedApiBase implements IKpiAdm
|
|
|
804
803
|
protected processGetMachineCapacityAdmin(response: Response): Promise<MachineGroupCapacityDto[]>;
|
|
805
804
|
updateMachineCapacityAdmin(request: UpdateMachinesCapacity): Promise<MachineCapacityDto>;
|
|
806
805
|
protected processUpdateMachineCapacityAdmin(response: Response): Promise<MachineCapacityDto>;
|
|
807
|
-
|
|
808
|
-
protected
|
|
809
|
-
|
|
810
|
-
protected
|
|
806
|
+
getCalendarCapacityAdmin(startDate: Date | undefined, endDate: Date | undefined): Promise<CalendarDayDto[]>;
|
|
807
|
+
protected processGetCalendarCapacityAdmin(response: Response): Promise<CalendarDayDto[]>;
|
|
808
|
+
updateCalendarCapacityAdmin(request: UpdateCalendarCapacity): Promise<CalendarCapacityDto>;
|
|
809
|
+
protected processUpdateCalendarCapacityAdmin(response: Response): Promise<CalendarCapacityDto>;
|
|
810
|
+
getCalendarSettings(): Promise<CalendarSettingsDto>;
|
|
811
|
+
protected processGetCalendarSettings(response: Response): Promise<CalendarSettingsDto>;
|
|
812
|
+
updateCalendarSettings(cmd: UpdateCalendarSettingsCommand): Promise<CalendarSettingsDto>;
|
|
813
|
+
protected processUpdateCalendarSettings(response: Response): Promise<CalendarSettingsDto>;
|
|
811
814
|
}
|
|
812
815
|
export interface IKpiClient {
|
|
813
816
|
getMachineKpi(machineExternalId: string | undefined, previousPeriodStartDate: Date | undefined, startDate: Date | undefined, endDate: Date | undefined, utcOffset: number | undefined): Promise<MachineKpiDto>;
|
|
@@ -3109,18 +3112,6 @@ export interface INumericNullableValueWithTimestamp {
|
|
|
3109
3112
|
timestamp?: number;
|
|
3110
3113
|
value?: number | null;
|
|
3111
3114
|
}
|
|
3112
|
-
export declare class ProgramDatapoint implements IProgramDatapoint {
|
|
3113
|
-
timestamp?: number;
|
|
3114
|
-
programValue?: string;
|
|
3115
|
-
constructor(data?: IProgramDatapoint);
|
|
3116
|
-
init(_data?: any): void;
|
|
3117
|
-
static fromJS(data: any): ProgramDatapoint;
|
|
3118
|
-
toJSON(data?: any): any;
|
|
3119
|
-
}
|
|
3120
|
-
export interface IProgramDatapoint {
|
|
3121
|
-
timestamp?: number;
|
|
3122
|
-
programValue?: string;
|
|
3123
|
-
}
|
|
3124
3115
|
export declare class UserAppDto implements IUserAppDto {
|
|
3125
3116
|
key: string;
|
|
3126
3117
|
name: string;
|
|
@@ -3744,11 +3735,13 @@ export interface IPulseSettingsDto {
|
|
|
3744
3735
|
defaultUtilizationType: UtilizationTypeDto;
|
|
3745
3736
|
utilizationTypeEnabling: UtilizationTypeEnablingDto;
|
|
3746
3737
|
}
|
|
3747
|
-
export type UtilizationTypeDto = "PowerOn" | "TwentyFourSeven" | "ActiveOrder";
|
|
3738
|
+
export type UtilizationTypeDto = "PowerOn" | "TwentyFourSeven" | "ActiveOrder" | "MachineCalendar" | "FactoryCalendar";
|
|
3748
3739
|
export declare class UtilizationTypeEnablingDto implements IUtilizationTypeEnablingDto {
|
|
3749
3740
|
powerOnEnabled: boolean;
|
|
3750
3741
|
twentyFourSevenEnabled: boolean;
|
|
3751
3742
|
activeOrderEnabled: boolean;
|
|
3743
|
+
machineCalendarEnabled: boolean;
|
|
3744
|
+
factoryCalendarEnabled: boolean;
|
|
3752
3745
|
constructor(data?: IUtilizationTypeEnablingDto);
|
|
3753
3746
|
init(_data?: any): void;
|
|
3754
3747
|
static fromJS(data: any): UtilizationTypeEnablingDto;
|
|
@@ -3758,12 +3751,16 @@ export interface IUtilizationTypeEnablingDto {
|
|
|
3758
3751
|
powerOnEnabled: boolean;
|
|
3759
3752
|
twentyFourSevenEnabled: boolean;
|
|
3760
3753
|
activeOrderEnabled: boolean;
|
|
3754
|
+
machineCalendarEnabled: boolean;
|
|
3755
|
+
factoryCalendarEnabled: boolean;
|
|
3761
3756
|
}
|
|
3762
3757
|
export declare class UpdatePulseSettings implements IUpdatePulseSettings {
|
|
3763
3758
|
defaultUtilizationType: UtilizationTypeDto;
|
|
3764
3759
|
powerOnEnabled: boolean;
|
|
3765
3760
|
twentyfourSevenEnabled: boolean;
|
|
3766
3761
|
activeOrderEnabled: boolean;
|
|
3762
|
+
machineCalendarEnabled: boolean;
|
|
3763
|
+
factoryCalendarEnabled: boolean;
|
|
3767
3764
|
constructor(data?: IUpdatePulseSettings);
|
|
3768
3765
|
init(_data?: any): void;
|
|
3769
3766
|
static fromJS(data: any): UpdatePulseSettings;
|
|
@@ -3774,6 +3771,8 @@ export interface IUpdatePulseSettings {
|
|
|
3774
3771
|
powerOnEnabled: boolean;
|
|
3775
3772
|
twentyfourSevenEnabled: boolean;
|
|
3776
3773
|
activeOrderEnabled: boolean;
|
|
3774
|
+
machineCalendarEnabled: boolean;
|
|
3775
|
+
factoryCalendarEnabled: boolean;
|
|
3777
3776
|
}
|
|
3778
3777
|
export declare class CompanyUtilizationDto implements ICompanyUtilizationDto {
|
|
3779
3778
|
utilizationType: UtilizationTypeDto;
|
|
@@ -3793,6 +3792,7 @@ export interface ICompanyUtilizationDto {
|
|
|
3793
3792
|
}
|
|
3794
3793
|
export declare class UtilizationDetailsV2Dto implements IUtilizationDetailsV2Dto {
|
|
3795
3794
|
utilizationPercent?: number | null;
|
|
3795
|
+
capacityInMilliseconds?: number;
|
|
3796
3796
|
uptimeInSeconds?: number | null;
|
|
3797
3797
|
downtimeInSeconds?: number | null;
|
|
3798
3798
|
totalTimeInSeconds?: number | null;
|
|
@@ -3806,6 +3806,7 @@ export declare class UtilizationDetailsV2Dto implements IUtilizationDetailsV2Dto
|
|
|
3806
3806
|
}
|
|
3807
3807
|
export interface IUtilizationDetailsV2Dto {
|
|
3808
3808
|
utilizationPercent?: number | null;
|
|
3809
|
+
capacityInMilliseconds?: number;
|
|
3809
3810
|
uptimeInSeconds?: number | null;
|
|
3810
3811
|
downtimeInSeconds?: number | null;
|
|
3811
3812
|
totalTimeInSeconds?: number | null;
|
|
@@ -5866,30 +5867,81 @@ export interface IUpdateMachinesCapacity {
|
|
|
5866
5867
|
utilizationPercent?: number | null;
|
|
5867
5868
|
capacity?: MachineCapacitySettingsDto[] | null;
|
|
5868
5869
|
}
|
|
5869
|
-
export declare class
|
|
5870
|
+
export declare class CalendarDayDto implements ICalendarDayDto {
|
|
5870
5871
|
date?: Date;
|
|
5871
|
-
dayCapacity?:
|
|
5872
|
-
|
|
5872
|
+
dayCapacity?: CalendarDayCapacityDto;
|
|
5873
|
+
capacityHours?: number;
|
|
5874
|
+
constructor(data?: ICalendarDayDto);
|
|
5873
5875
|
init(_data?: any): void;
|
|
5874
|
-
static fromJS(data: any):
|
|
5876
|
+
static fromJS(data: any): CalendarDayDto;
|
|
5875
5877
|
toJSON(data?: any): any;
|
|
5876
5878
|
}
|
|
5877
|
-
export interface
|
|
5879
|
+
export interface ICalendarDayDto {
|
|
5878
5880
|
date?: Date;
|
|
5879
|
-
dayCapacity?:
|
|
5881
|
+
dayCapacity?: CalendarDayCapacityDto;
|
|
5882
|
+
capacityHours?: number;
|
|
5880
5883
|
}
|
|
5881
|
-
export type
|
|
5882
|
-
export declare class
|
|
5884
|
+
export type CalendarDayCapacityDto = "WorkingDay" | "HalfDay" | "Holiday";
|
|
5885
|
+
export declare class CalendarCapacityDto implements ICalendarCapacityDto {
|
|
5883
5886
|
date?: Date;
|
|
5884
|
-
dayCapacity?:
|
|
5885
|
-
constructor(data?:
|
|
5887
|
+
dayCapacity?: CalendarDayCapacityDto;
|
|
5888
|
+
constructor(data?: ICalendarCapacityDto);
|
|
5886
5889
|
init(_data?: any): void;
|
|
5887
|
-
static fromJS(data: any):
|
|
5890
|
+
static fromJS(data: any): CalendarCapacityDto;
|
|
5888
5891
|
toJSON(data?: any): any;
|
|
5889
5892
|
}
|
|
5890
|
-
export interface
|
|
5893
|
+
export interface ICalendarCapacityDto {
|
|
5891
5894
|
date?: Date;
|
|
5892
|
-
dayCapacity?:
|
|
5895
|
+
dayCapacity?: CalendarDayCapacityDto;
|
|
5896
|
+
}
|
|
5897
|
+
export declare class UpdateCalendarCapacity implements IUpdateCalendarCapacity {
|
|
5898
|
+
date?: Date;
|
|
5899
|
+
dayCapacity?: CalendarDayCapacityDto;
|
|
5900
|
+
constructor(data?: IUpdateCalendarCapacity);
|
|
5901
|
+
init(_data?: any): void;
|
|
5902
|
+
static fromJS(data: any): UpdateCalendarCapacity;
|
|
5903
|
+
toJSON(data?: any): any;
|
|
5904
|
+
}
|
|
5905
|
+
export interface IUpdateCalendarCapacity {
|
|
5906
|
+
date?: Date;
|
|
5907
|
+
dayCapacity?: CalendarDayCapacityDto;
|
|
5908
|
+
}
|
|
5909
|
+
export declare class CalendarSettingsDto implements ICalendarSettingsDto {
|
|
5910
|
+
defaultHoursPerWeekday?: {
|
|
5911
|
+
[key in DayOfWeek]?: number;
|
|
5912
|
+
};
|
|
5913
|
+
halfDayHours?: number;
|
|
5914
|
+
holidayHours?: number;
|
|
5915
|
+
constructor(data?: ICalendarSettingsDto);
|
|
5916
|
+
init(_data?: any): void;
|
|
5917
|
+
static fromJS(data: any): CalendarSettingsDto;
|
|
5918
|
+
toJSON(data?: any): any;
|
|
5919
|
+
}
|
|
5920
|
+
export interface ICalendarSettingsDto {
|
|
5921
|
+
defaultHoursPerWeekday?: {
|
|
5922
|
+
[key in DayOfWeek]?: number;
|
|
5923
|
+
};
|
|
5924
|
+
halfDayHours?: number;
|
|
5925
|
+
holidayHours?: number;
|
|
5926
|
+
}
|
|
5927
|
+
export type DayOfWeek = 0 | 1 | 2 | 3 | 4 | 5 | 6;
|
|
5928
|
+
export declare class UpdateCalendarSettingsCommand implements IUpdateCalendarSettingsCommand {
|
|
5929
|
+
defaultHoursPerWeekday?: {
|
|
5930
|
+
[key in DayOfWeek]?: number;
|
|
5931
|
+
};
|
|
5932
|
+
halfDayHours?: number;
|
|
5933
|
+
holidayHours?: number;
|
|
5934
|
+
constructor(data?: IUpdateCalendarSettingsCommand);
|
|
5935
|
+
init(_data?: any): void;
|
|
5936
|
+
static fromJS(data: any): UpdateCalendarSettingsCommand;
|
|
5937
|
+
toJSON(data?: any): any;
|
|
5938
|
+
}
|
|
5939
|
+
export interface IUpdateCalendarSettingsCommand {
|
|
5940
|
+
defaultHoursPerWeekday?: {
|
|
5941
|
+
[key in DayOfWeek]?: number;
|
|
5942
|
+
};
|
|
5943
|
+
halfDayHours?: number;
|
|
5944
|
+
holidayHours?: number;
|
|
5893
5945
|
}
|
|
5894
5946
|
export declare class MachineKpiDto implements IMachineKpiDto {
|
|
5895
5947
|
uptimeToNow: number;
|
|
@@ -11722,6 +11774,7 @@ export declare class MeasurementFormGroupedElementDto implements IMeasurementFor
|
|
|
11722
11774
|
machiningDimension?: number | null;
|
|
11723
11775
|
nominalInch?: number | null;
|
|
11724
11776
|
isValid: boolean;
|
|
11777
|
+
validationErrorMessage?: string | null;
|
|
11725
11778
|
constructor(data?: IMeasurementFormGroupedElementDto);
|
|
11726
11779
|
init(_data?: any): void;
|
|
11727
11780
|
static fromJS(data: any): MeasurementFormGroupedElementDto;
|
|
@@ -11767,8 +11820,9 @@ export interface IMeasurementFormGroupedElementDto {
|
|
|
11767
11820
|
machiningDimension?: number | null;
|
|
11768
11821
|
nominalInch?: number | null;
|
|
11769
11822
|
isValid: boolean;
|
|
11823
|
+
validationErrorMessage?: string | null;
|
|
11770
11824
|
}
|
|
11771
|
-
export type MeasurementFrequency = "All" | "FirstArticle" | "NFirst" | "NPercent" | "ISO2859" | "Nth" | "None";
|
|
11825
|
+
export type MeasurementFrequency = "All" | "FirstArticle" | "NFirst" | "NPercent" | "ISO2859" | "Nth" | "FirstAndLast" | "None";
|
|
11772
11826
|
export type MeasurementFormValueType = "None" | "Bool" | "Decimal" | "String";
|
|
11773
11827
|
export type BonusType = "None" | "Positive" | "PositiveAndNegative";
|
|
11774
11828
|
export declare class MeasurementFormLinkedSchemaDto implements IMeasurementFormLinkedSchemaDto {
|
|
@@ -11910,6 +11964,7 @@ export declare class UpdateSchemaGroupedElementDto implements IUpdateSchemaGroup
|
|
|
11910
11964
|
includeInCustomerDocumentation: boolean;
|
|
11911
11965
|
canCopy?: boolean | null;
|
|
11912
11966
|
isDocumentedExternally: boolean;
|
|
11967
|
+
coatingThickness?: number | null;
|
|
11913
11968
|
constructor(data?: IUpdateSchemaGroupedElementDto);
|
|
11914
11969
|
init(_data?: any): void;
|
|
11915
11970
|
static fromJS(data: any): UpdateSchemaGroupedElementDto;
|
|
@@ -11922,6 +11977,7 @@ export interface IUpdateSchemaGroupedElementDto {
|
|
|
11922
11977
|
includeInCustomerDocumentation: boolean;
|
|
11923
11978
|
canCopy?: boolean | null;
|
|
11924
11979
|
isDocumentedExternally: boolean;
|
|
11980
|
+
coatingThickness?: number | null;
|
|
11925
11981
|
}
|
|
11926
11982
|
export declare class UpdateSchemaGroupedElementRowDto implements IUpdateSchemaGroupedElementRowDto {
|
|
11927
11983
|
id: string;
|