@ignos/api-client 20250827.0.12448-alpha → 20250829.0.12463
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 +83 -108
- package/lib/ignosportal-api.js +232 -343
- package/package.json +1 -1
- package/src/ignosportal-api.ts +305 -442
package/lib/ignosportal-api.d.ts
CHANGED
|
@@ -171,6 +171,7 @@ export interface IMachineUtilizationClient {
|
|
|
171
171
|
* @deprecated
|
|
172
172
|
*/
|
|
173
173
|
getUtilizationDetailsForMachine(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
174
|
+
getResourceTimelines(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
174
175
|
listMachineStates(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
175
176
|
getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
176
177
|
listMachineUptimesToday(request: ListMachineUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
@@ -208,6 +209,8 @@ export declare class MachineUtilizationClient extends AuthorizedApiBase implemen
|
|
|
208
209
|
*/
|
|
209
210
|
getUtilizationDetailsForMachine(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
210
211
|
protected processGetUtilizationDetailsForMachine(response: Response): Promise<MachineStatesSummaryDto>;
|
|
212
|
+
getResourceTimelines(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
213
|
+
protected processGetResourceTimelines(response: Response): Promise<TimelinesDto>;
|
|
211
214
|
listMachineStates(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
212
215
|
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
213
216
|
getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
@@ -746,10 +749,6 @@ export interface IDowntimeReasonsAdminClient {
|
|
|
746
749
|
updateDowntimeReason(id: string, request: UpdateDowntimeReasonRequest): Promise<DowntimeReasonDto>;
|
|
747
750
|
deleteDowntimeReason(id: string): Promise<void>;
|
|
748
751
|
listMachineTypes(): Promise<MachineTypeDto[]>;
|
|
749
|
-
listParentTopics(): Promise<ParentTopicDto[]>;
|
|
750
|
-
createParentTopic(request: CreateParentTopicRequest): Promise<ParentTopicDto>;
|
|
751
|
-
updateParentTopic(id: string, request: UpdateParentTopicRequest): Promise<ParentTopicDto>;
|
|
752
|
-
deleteParentTopic(id: string): Promise<void>;
|
|
753
752
|
}
|
|
754
753
|
export declare class DowntimeReasonsAdminClient extends AuthorizedApiBase implements IDowntimeReasonsAdminClient {
|
|
755
754
|
private http;
|
|
@@ -768,14 +767,6 @@ export declare class DowntimeReasonsAdminClient extends AuthorizedApiBase implem
|
|
|
768
767
|
protected processDeleteDowntimeReason(response: Response): Promise<void>;
|
|
769
768
|
listMachineTypes(): Promise<MachineTypeDto[]>;
|
|
770
769
|
protected processListMachineTypes(response: Response): Promise<MachineTypeDto[]>;
|
|
771
|
-
listParentTopics(): Promise<ParentTopicDto[]>;
|
|
772
|
-
protected processListParentTopics(response: Response): Promise<ParentTopicDto[]>;
|
|
773
|
-
createParentTopic(request: CreateParentTopicRequest): Promise<ParentTopicDto>;
|
|
774
|
-
protected processCreateParentTopic(response: Response): Promise<ParentTopicDto>;
|
|
775
|
-
updateParentTopic(id: string, request: UpdateParentTopicRequest): Promise<ParentTopicDto>;
|
|
776
|
-
protected processUpdateParentTopic(response: Response): Promise<ParentTopicDto>;
|
|
777
|
-
deleteParentTopic(id: string): Promise<void>;
|
|
778
|
-
protected processDeleteParentTopic(response: Response): Promise<void>;
|
|
779
770
|
}
|
|
780
771
|
export interface IDowntimeReasonsClient {
|
|
781
772
|
createDowntimePeriodReason(request: CreateDowntimePeriodReason): Promise<DowntimePeriodReasonDto>;
|
|
@@ -868,6 +859,11 @@ export interface IMachinesClient {
|
|
|
868
859
|
getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
869
860
|
listMachineErpData(): Promise<MachineErpDataListDto>;
|
|
870
861
|
getMachineErpData(id: number): Promise<MachineErpDataDto>;
|
|
862
|
+
/**
|
|
863
|
+
* @param startTime (optional)
|
|
864
|
+
* @param endTime (optional)
|
|
865
|
+
* @deprecated
|
|
866
|
+
*/
|
|
871
867
|
getWorkOrderTimeline(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<WorkOrderDatapoint[]>;
|
|
872
868
|
getMachineUtilizationSummary(): Promise<UtilizationSummaryDto>;
|
|
873
869
|
getCrossCompanyUtilizationSummary(): Promise<CrossCompanyUtilizationSummaryDto>;
|
|
@@ -908,6 +904,11 @@ export declare class MachinesClient extends AuthorizedApiBase implements IMachin
|
|
|
908
904
|
protected processListMachineErpData(response: Response): Promise<MachineErpDataListDto>;
|
|
909
905
|
getMachineErpData(id: number): Promise<MachineErpDataDto>;
|
|
910
906
|
protected processGetMachineErpData(response: Response): Promise<MachineErpDataDto>;
|
|
907
|
+
/**
|
|
908
|
+
* @param startTime (optional)
|
|
909
|
+
* @param endTime (optional)
|
|
910
|
+
* @deprecated
|
|
911
|
+
*/
|
|
911
912
|
getWorkOrderTimeline(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<WorkOrderDatapoint[]>;
|
|
912
913
|
protected processGetWorkOrderTimeline(response: Response): Promise<WorkOrderDatapoint[]>;
|
|
913
914
|
getMachineUtilizationSummary(): Promise<UtilizationSummaryDto>;
|
|
@@ -3008,6 +3009,22 @@ export interface IStateDto {
|
|
|
3008
3009
|
machineState: MachineState;
|
|
3009
3010
|
seconds: number;
|
|
3010
3011
|
}
|
|
3012
|
+
export declare class TimelinesDto implements ITimelinesDto {
|
|
3013
|
+
machineStateTimeline: MachineStateDatapoint[];
|
|
3014
|
+
workorderTimeline: WorkOrderDatapoint[];
|
|
3015
|
+
downtimeReasonsTimeline: DowntimePeriodReasonDto[];
|
|
3016
|
+
programTimeline: ProgramDatapoint[];
|
|
3017
|
+
constructor(data?: ITimelinesDto);
|
|
3018
|
+
init(_data?: any): void;
|
|
3019
|
+
static fromJS(data: any): TimelinesDto;
|
|
3020
|
+
toJSON(data?: any): any;
|
|
3021
|
+
}
|
|
3022
|
+
export interface ITimelinesDto {
|
|
3023
|
+
machineStateTimeline: MachineStateDatapoint[];
|
|
3024
|
+
workorderTimeline: WorkOrderDatapoint[];
|
|
3025
|
+
downtimeReasonsTimeline: DowntimePeriodReasonDto[];
|
|
3026
|
+
programTimeline: ProgramDatapoint[];
|
|
3027
|
+
}
|
|
3011
3028
|
export declare class MachineStateDatapoint implements IMachineStateDatapoint {
|
|
3012
3029
|
machineStateText: string;
|
|
3013
3030
|
machineState: MachineState;
|
|
@@ -3073,6 +3090,60 @@ export interface IEmployeeDto {
|
|
|
3073
3090
|
upn?: string | null;
|
|
3074
3091
|
azureAdObjectId?: string | null;
|
|
3075
3092
|
}
|
|
3093
|
+
export declare class WorkOrderDatapoint implements IWorkOrderDatapoint {
|
|
3094
|
+
workOrder: string;
|
|
3095
|
+
id: number;
|
|
3096
|
+
externalId: string;
|
|
3097
|
+
subType?: string | null;
|
|
3098
|
+
startTime: number;
|
|
3099
|
+
endTime?: number | null;
|
|
3100
|
+
metaData?: {
|
|
3101
|
+
[key: string]: string;
|
|
3102
|
+
} | null;
|
|
3103
|
+
constructor(data?: IWorkOrderDatapoint);
|
|
3104
|
+
init(_data?: any): void;
|
|
3105
|
+
static fromJS(data: any): WorkOrderDatapoint;
|
|
3106
|
+
toJSON(data?: any): any;
|
|
3107
|
+
}
|
|
3108
|
+
export interface IWorkOrderDatapoint {
|
|
3109
|
+
workOrder: string;
|
|
3110
|
+
id: number;
|
|
3111
|
+
externalId: string;
|
|
3112
|
+
subType?: string | null;
|
|
3113
|
+
startTime: number;
|
|
3114
|
+
endTime?: number | null;
|
|
3115
|
+
metaData?: {
|
|
3116
|
+
[key: string]: string;
|
|
3117
|
+
} | null;
|
|
3118
|
+
}
|
|
3119
|
+
export declare class ProgramDatapoint implements IProgramDatapoint {
|
|
3120
|
+
timestamp?: number;
|
|
3121
|
+
programValue?: string;
|
|
3122
|
+
constructor(data?: IProgramDatapoint);
|
|
3123
|
+
init(_data?: any): void;
|
|
3124
|
+
static fromJS(data: any): ProgramDatapoint;
|
|
3125
|
+
toJSON(data?: any): any;
|
|
3126
|
+
}
|
|
3127
|
+
export interface IProgramDatapoint {
|
|
3128
|
+
timestamp?: number;
|
|
3129
|
+
programValue?: string;
|
|
3130
|
+
}
|
|
3131
|
+
export declare class TimelineFilterDto implements ITimelineFilterDto {
|
|
3132
|
+
includeMachineState?: boolean | null;
|
|
3133
|
+
includeWorkorder?: boolean | null;
|
|
3134
|
+
includeDowntimeReasons?: boolean | null;
|
|
3135
|
+
includeProgram?: boolean | null;
|
|
3136
|
+
constructor(data?: ITimelineFilterDto);
|
|
3137
|
+
init(_data?: any): void;
|
|
3138
|
+
static fromJS(data: any): TimelineFilterDto;
|
|
3139
|
+
toJSON(data?: any): any;
|
|
3140
|
+
}
|
|
3141
|
+
export interface ITimelineFilterDto {
|
|
3142
|
+
includeMachineState?: boolean | null;
|
|
3143
|
+
includeWorkorder?: boolean | null;
|
|
3144
|
+
includeDowntimeReasons?: boolean | null;
|
|
3145
|
+
includeProgram?: boolean | null;
|
|
3146
|
+
}
|
|
3076
3147
|
export declare class MachineUptimesAggregateDto implements IMachineUptimesAggregateDto {
|
|
3077
3148
|
machineUptimes: MachineUptimeDto[];
|
|
3078
3149
|
sum: MachineUptimeSumDto;
|
|
@@ -3163,18 +3234,6 @@ export interface INumericNullableValueWithTimestamp {
|
|
|
3163
3234
|
timestamp?: number;
|
|
3164
3235
|
value?: number | null;
|
|
3165
3236
|
}
|
|
3166
|
-
export declare class ProgramDatapoint implements IProgramDatapoint {
|
|
3167
|
-
timestamp?: number;
|
|
3168
|
-
programValue?: string;
|
|
3169
|
-
constructor(data?: IProgramDatapoint);
|
|
3170
|
-
init(_data?: any): void;
|
|
3171
|
-
static fromJS(data: any): ProgramDatapoint;
|
|
3172
|
-
toJSON(data?: any): any;
|
|
3173
|
-
}
|
|
3174
|
-
export interface IProgramDatapoint {
|
|
3175
|
-
timestamp?: number;
|
|
3176
|
-
programValue?: string;
|
|
3177
|
-
}
|
|
3178
3237
|
export declare class UserAppDto implements IUserAppDto {
|
|
3179
3238
|
key: string;
|
|
3180
3239
|
name: string;
|
|
@@ -5696,8 +5755,6 @@ export declare class DowntimeReasonDto implements IDowntimeReasonDto {
|
|
|
5696
5755
|
machineTypes: string[];
|
|
5697
5756
|
reasonType: DowntimeReasonTypeDto;
|
|
5698
5757
|
description?: string | null;
|
|
5699
|
-
parentId?: string | null;
|
|
5700
|
-
displayOrder?: number | null;
|
|
5701
5758
|
constructor(data?: IDowntimeReasonDto);
|
|
5702
5759
|
init(_data?: any): void;
|
|
5703
5760
|
static fromJS(data: any): DowntimeReasonDto;
|
|
@@ -5709,8 +5766,6 @@ export interface IDowntimeReasonDto {
|
|
|
5709
5766
|
machineTypes: string[];
|
|
5710
5767
|
reasonType: DowntimeReasonTypeDto;
|
|
5711
5768
|
description?: string | null;
|
|
5712
|
-
parentId?: string | null;
|
|
5713
|
-
displayOrder?: number | null;
|
|
5714
5769
|
}
|
|
5715
5770
|
export declare class CreateDowntimeReason implements ICreateDowntimeReason {
|
|
5716
5771
|
reason: string;
|
|
@@ -5733,8 +5788,6 @@ export declare class UpdateDowntimeReasonRequest implements IUpdateDowntimeReaso
|
|
|
5733
5788
|
machineTypes: string[];
|
|
5734
5789
|
reasonType: DowntimeReasonTypeDto;
|
|
5735
5790
|
description?: string | null;
|
|
5736
|
-
parentId?: string | null;
|
|
5737
|
-
displayOrder?: number | null;
|
|
5738
5791
|
constructor(data?: IUpdateDowntimeReasonRequest);
|
|
5739
5792
|
init(_data?: any): void;
|
|
5740
5793
|
static fromJS(data: any): UpdateDowntimeReasonRequest;
|
|
@@ -5745,8 +5798,6 @@ export interface IUpdateDowntimeReasonRequest {
|
|
|
5745
5798
|
machineTypes: string[];
|
|
5746
5799
|
reasonType: DowntimeReasonTypeDto;
|
|
5747
5800
|
description?: string | null;
|
|
5748
|
-
parentId?: string | null;
|
|
5749
|
-
displayOrder?: number | null;
|
|
5750
5801
|
}
|
|
5751
5802
|
export declare class MachineTypeDto implements IMachineTypeDto {
|
|
5752
5803
|
machineType: string;
|
|
@@ -5758,56 +5809,6 @@ export declare class MachineTypeDto implements IMachineTypeDto {
|
|
|
5758
5809
|
export interface IMachineTypeDto {
|
|
5759
5810
|
machineType: string;
|
|
5760
5811
|
}
|
|
5761
|
-
export declare class ParentTopicDto implements IParentTopicDto {
|
|
5762
|
-
id: string;
|
|
5763
|
-
name: string;
|
|
5764
|
-
reasonType: DowntimeReasonTypeDto;
|
|
5765
|
-
description?: string | null;
|
|
5766
|
-
displayOrder?: number;
|
|
5767
|
-
constructor(data?: IParentTopicDto);
|
|
5768
|
-
init(_data?: any): void;
|
|
5769
|
-
static fromJS(data: any): ParentTopicDto;
|
|
5770
|
-
toJSON(data?: any): any;
|
|
5771
|
-
}
|
|
5772
|
-
export interface IParentTopicDto {
|
|
5773
|
-
id: string;
|
|
5774
|
-
name: string;
|
|
5775
|
-
reasonType: DowntimeReasonTypeDto;
|
|
5776
|
-
description?: string | null;
|
|
5777
|
-
displayOrder?: number;
|
|
5778
|
-
}
|
|
5779
|
-
export declare class CreateParentTopicRequest implements ICreateParentTopicRequest {
|
|
5780
|
-
name: string;
|
|
5781
|
-
reasonType: DowntimeReasonTypeDto;
|
|
5782
|
-
description?: string | null;
|
|
5783
|
-
displayOrder?: number | null;
|
|
5784
|
-
constructor(data?: ICreateParentTopicRequest);
|
|
5785
|
-
init(_data?: any): void;
|
|
5786
|
-
static fromJS(data: any): CreateParentTopicRequest;
|
|
5787
|
-
toJSON(data?: any): any;
|
|
5788
|
-
}
|
|
5789
|
-
export interface ICreateParentTopicRequest {
|
|
5790
|
-
name: string;
|
|
5791
|
-
reasonType: DowntimeReasonTypeDto;
|
|
5792
|
-
description?: string | null;
|
|
5793
|
-
displayOrder?: number | null;
|
|
5794
|
-
}
|
|
5795
|
-
export declare class UpdateParentTopicRequest implements IUpdateParentTopicRequest {
|
|
5796
|
-
name: string;
|
|
5797
|
-
reasonType: DowntimeReasonTypeDto;
|
|
5798
|
-
description?: string | null;
|
|
5799
|
-
displayOrder?: number | null;
|
|
5800
|
-
constructor(data?: IUpdateParentTopicRequest);
|
|
5801
|
-
init(_data?: any): void;
|
|
5802
|
-
static fromJS(data: any): UpdateParentTopicRequest;
|
|
5803
|
-
toJSON(data?: any): any;
|
|
5804
|
-
}
|
|
5805
|
-
export interface IUpdateParentTopicRequest {
|
|
5806
|
-
name: string;
|
|
5807
|
-
reasonType: DowntimeReasonTypeDto;
|
|
5808
|
-
description?: string | null;
|
|
5809
|
-
displayOrder?: number | null;
|
|
5810
|
-
}
|
|
5811
5812
|
export declare class CreateDowntimePeriodReason implements ICreateDowntimePeriodReason {
|
|
5812
5813
|
reasonId: string;
|
|
5813
5814
|
assetId: number;
|
|
@@ -6376,32 +6377,6 @@ export interface IWorkOrderProjectDto {
|
|
|
6376
6377
|
name?: string | null;
|
|
6377
6378
|
projectManager?: string | null;
|
|
6378
6379
|
}
|
|
6379
|
-
export declare class WorkOrderDatapoint implements IWorkOrderDatapoint {
|
|
6380
|
-
workOrder: string;
|
|
6381
|
-
id: number;
|
|
6382
|
-
externalId: string;
|
|
6383
|
-
subType?: string | null;
|
|
6384
|
-
startTime: number;
|
|
6385
|
-
endTime?: number | null;
|
|
6386
|
-
metaData?: {
|
|
6387
|
-
[key: string]: string;
|
|
6388
|
-
} | null;
|
|
6389
|
-
constructor(data?: IWorkOrderDatapoint);
|
|
6390
|
-
init(_data?: any): void;
|
|
6391
|
-
static fromJS(data: any): WorkOrderDatapoint;
|
|
6392
|
-
toJSON(data?: any): any;
|
|
6393
|
-
}
|
|
6394
|
-
export interface IWorkOrderDatapoint {
|
|
6395
|
-
workOrder: string;
|
|
6396
|
-
id: number;
|
|
6397
|
-
externalId: string;
|
|
6398
|
-
subType?: string | null;
|
|
6399
|
-
startTime: number;
|
|
6400
|
-
endTime?: number | null;
|
|
6401
|
-
metaData?: {
|
|
6402
|
-
[key: string]: string;
|
|
6403
|
-
} | null;
|
|
6404
|
-
}
|
|
6405
6380
|
export declare class UtilizationSummaryDto implements IUtilizationSummaryDto {
|
|
6406
6381
|
factory: FactoryUtilizationDto;
|
|
6407
6382
|
groups: MachineGroupUtilizationDto[];
|