@ignos/api-client 20260106.0.13658 → 20260108.0.13688-alpha
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 +146 -0
- package/lib/ignosportal-api.js +648 -0
- package/package.json +1 -1
- package/src/ignosportal-api.ts +761 -0
package/lib/ignosportal-api.d.ts
CHANGED
|
@@ -224,6 +224,67 @@ export declare class MachineUtilizationClient extends AuthorizedApiBase implemen
|
|
|
224
224
|
getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
|
|
225
225
|
protected processGetProgramTimeline(response: Response): Promise<ProgramDatapoint[]>;
|
|
226
226
|
}
|
|
227
|
+
export interface IResourceUtilizationClient {
|
|
228
|
+
/**
|
|
229
|
+
* Get machine utilization data. Historic utilizations start from now, whereas the start for current utilization is
|
|
230
|
+
calculated based on startTimeToday or utcOffset. An UTC offset is
|
|
231
|
+
obtained either from startTimeToday, utcOffset or the server's local
|
|
232
|
+
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
233
|
+
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
234
|
+
client and server
|
|
235
|
+
* @param assetId (optional)
|
|
236
|
+
* @param favorites (optional)
|
|
237
|
+
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
238
|
+
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
239
|
+
*/
|
|
240
|
+
getResourceUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
241
|
+
getResourceUtilization(id: number, startTime: Date | undefined, endTime: Date | null | undefined): Promise<ResourceUtilizationDetailsDto>;
|
|
242
|
+
getResourceTimelines(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
243
|
+
listMachineStates(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
244
|
+
getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
245
|
+
listResourceUptimesToday(request: ListResourceUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
246
|
+
listPowerOnUtilizationDatapoints(id: number | null | undefined, externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
247
|
+
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
248
|
+
getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
|
|
249
|
+
}
|
|
250
|
+
export declare class ResourceUtilizationClient extends AuthorizedApiBase implements IResourceUtilizationClient {
|
|
251
|
+
private http;
|
|
252
|
+
private baseUrl;
|
|
253
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
254
|
+
constructor(configuration: IAccessTokenProvider, baseUrl?: string, http?: {
|
|
255
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
256
|
+
});
|
|
257
|
+
/**
|
|
258
|
+
* Get machine utilization data. Historic utilizations start from now, whereas the start for current utilization is
|
|
259
|
+
calculated based on startTimeToday or utcOffset. An UTC offset is
|
|
260
|
+
obtained either from startTimeToday, utcOffset or the server's local
|
|
261
|
+
time zone. The current utilization is calculated starting from the start of the current date offset from UTC
|
|
262
|
+
by the offset used. Pass in utcOffset to avoid problems relating to clock drift between
|
|
263
|
+
client and server
|
|
264
|
+
* @param assetId (optional)
|
|
265
|
+
* @param favorites (optional)
|
|
266
|
+
* @param startTimeToday (optional) UTC offset for start of today's utilization is extracted from this value
|
|
267
|
+
* @param utcOffset (optional) Explicit UTC offset for start of today's utilization
|
|
268
|
+
*/
|
|
269
|
+
getResourceUtilizations(assetId: number | null | undefined, favorites: boolean | undefined, startTimeToday: Date | null | undefined, utcOffset: number | null | undefined): Promise<ResourceUtilizationListDto>;
|
|
270
|
+
protected processGetResourceUtilizations(response: Response): Promise<ResourceUtilizationListDto>;
|
|
271
|
+
getResourceUtilization(id: number, startTime: Date | undefined, endTime: Date | null | undefined): Promise<ResourceUtilizationDetailsDto>;
|
|
272
|
+
protected processGetResourceUtilization(response: Response): Promise<ResourceUtilizationDetailsDto>;
|
|
273
|
+
getResourceTimelines(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined, filter: TimelineFilterDto | undefined): Promise<TimelinesDto>;
|
|
274
|
+
protected processGetResourceTimelines(response: Response): Promise<TimelinesDto>;
|
|
275
|
+
listMachineStates(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStateDatapoint[]>;
|
|
276
|
+
protected processListMachineStates(response: Response): Promise<MachineStateDatapoint[]>;
|
|
277
|
+
getMachineStatesSummary(id: number, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<MachineStatesSummaryDto>;
|
|
278
|
+
protected processGetMachineStatesSummary(response: Response): Promise<MachineStatesSummaryDto>;
|
|
279
|
+
listResourceUptimesToday(request: ListResourceUptimesTodayRequest): Promise<MachineUptimesAggregateDto>;
|
|
280
|
+
protected processListResourceUptimesToday(response: Response): Promise<MachineUptimesAggregateDto>;
|
|
281
|
+
listPowerOnUtilizationDatapoints(id: number | null | undefined, externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
|
|
282
|
+
protected processListPowerOnUtilizationDatapoints(response: Response): Promise<PowerOnUtilizationList>;
|
|
283
|
+
getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
|
|
284
|
+
protected processGetFactoryUtilization(response: Response): Promise<PowerOnUtilizationDto>;
|
|
285
|
+
getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
|
|
286
|
+
protected processGetProgramTimeline(response: Response): Promise<ProgramDatapoint[]>;
|
|
287
|
+
}
|
|
227
288
|
export interface IMeClient {
|
|
228
289
|
getMyApps(): Promise<UserAppDto[]>;
|
|
229
290
|
getCurrentUser(): Promise<UserDetailsDto>;
|
|
@@ -2469,6 +2530,7 @@ export interface IMeasurementFormsInstancesClient {
|
|
|
2469
2530
|
getMeasurementFormInstance(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceDto>;
|
|
2470
2531
|
listMeasurementFormInstanceFeedback(id: string): Promise<MeasurementFormInstanceFeedbackDto[]>;
|
|
2471
2532
|
completeMeasurementFormInstance(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceDto>;
|
|
2533
|
+
completeMeasurementFormInstanceV2(id: string, tenantId: string | null | undefined): Promise<CompleteMeasurementFormInstanceResult>;
|
|
2472
2534
|
getMeasurementFormInstanceSchema(id: string, schemaId: string, serialNumber: string | null | undefined, tenantId: string | null | undefined): Promise<MeasurementFormInstanceSchemaDto>;
|
|
2473
2535
|
getWorkorderMeasurementFormProgress(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceProgressDto>;
|
|
2474
2536
|
getAuditLog(id: string, tenantId: string | null | undefined, schemaId: string | null | undefined, serialNumber: string | null | undefined, elementId: string | null | undefined): Promise<MeasurementFormElementValueAuditDto[]>;
|
|
@@ -2505,6 +2567,8 @@ export declare class MeasurementFormsInstancesClient extends AuthorizedApiBase i
|
|
|
2505
2567
|
protected processListMeasurementFormInstanceFeedback(response: Response): Promise<MeasurementFormInstanceFeedbackDto[]>;
|
|
2506
2568
|
completeMeasurementFormInstance(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceDto>;
|
|
2507
2569
|
protected processCompleteMeasurementFormInstance(response: Response): Promise<MeasurementFormInstanceDto>;
|
|
2570
|
+
completeMeasurementFormInstanceV2(id: string, tenantId: string | null | undefined): Promise<CompleteMeasurementFormInstanceResult>;
|
|
2571
|
+
protected processCompleteMeasurementFormInstanceV2(response: Response): Promise<CompleteMeasurementFormInstanceResult>;
|
|
2508
2572
|
getMeasurementFormInstanceSchema(id: string, schemaId: string, serialNumber: string | null | undefined, tenantId: string | null | undefined): Promise<MeasurementFormInstanceSchemaDto>;
|
|
2509
2573
|
protected processGetMeasurementFormInstanceSchema(response: Response): Promise<MeasurementFormInstanceSchemaDto>;
|
|
2510
2574
|
getWorkorderMeasurementFormProgress(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceProgressDto>;
|
|
@@ -3372,6 +3436,72 @@ export interface INumericNullableValueWithTimestamp {
|
|
|
3372
3436
|
timestamp?: number;
|
|
3373
3437
|
value?: number | null;
|
|
3374
3438
|
}
|
|
3439
|
+
export declare class ResourceUtilizationListDto implements IResourceUtilizationListDto {
|
|
3440
|
+
resources?: ResourceUtilizationDto[] | null;
|
|
3441
|
+
constructor(data?: IResourceUtilizationListDto);
|
|
3442
|
+
init(_data?: any): void;
|
|
3443
|
+
static fromJS(data: any): ResourceUtilizationListDto;
|
|
3444
|
+
toJSON(data?: any): any;
|
|
3445
|
+
}
|
|
3446
|
+
export interface IResourceUtilizationListDto {
|
|
3447
|
+
resources?: ResourceUtilizationDto[] | null;
|
|
3448
|
+
}
|
|
3449
|
+
export declare class ResourceUtilizationDto implements IResourceUtilizationDto {
|
|
3450
|
+
assetId: number;
|
|
3451
|
+
name: string;
|
|
3452
|
+
description?: string | null;
|
|
3453
|
+
state: string;
|
|
3454
|
+
machineState: MachineState;
|
|
3455
|
+
startTime?: Date;
|
|
3456
|
+
workorder?: UtilizationWorkorderDto | null;
|
|
3457
|
+
powerOn?: PowerOnUtilizationDto | null;
|
|
3458
|
+
constructor(data?: IResourceUtilizationDto);
|
|
3459
|
+
init(_data?: any): void;
|
|
3460
|
+
static fromJS(data: any): ResourceUtilizationDto;
|
|
3461
|
+
toJSON(data?: any): any;
|
|
3462
|
+
}
|
|
3463
|
+
export interface IResourceUtilizationDto {
|
|
3464
|
+
assetId: number;
|
|
3465
|
+
name: string;
|
|
3466
|
+
description?: string | null;
|
|
3467
|
+
state: string;
|
|
3468
|
+
machineState: MachineState;
|
|
3469
|
+
startTime?: Date;
|
|
3470
|
+
workorder?: UtilizationWorkorderDto | null;
|
|
3471
|
+
powerOn?: PowerOnUtilizationDto | null;
|
|
3472
|
+
}
|
|
3473
|
+
export declare class ResourceUtilizationDetailsDto implements IResourceUtilizationDetailsDto {
|
|
3474
|
+
resourceId: number;
|
|
3475
|
+
resourceName: string;
|
|
3476
|
+
machineStateText?: string | null;
|
|
3477
|
+
machineState?: MachineState | null;
|
|
3478
|
+
startTime?: Date | null;
|
|
3479
|
+
powerOnUtilization?: number | null;
|
|
3480
|
+
constructor(data?: IResourceUtilizationDetailsDto);
|
|
3481
|
+
init(_data?: any): void;
|
|
3482
|
+
static fromJS(data: any): ResourceUtilizationDetailsDto;
|
|
3483
|
+
toJSON(data?: any): any;
|
|
3484
|
+
}
|
|
3485
|
+
export interface IResourceUtilizationDetailsDto {
|
|
3486
|
+
resourceId: number;
|
|
3487
|
+
resourceName: string;
|
|
3488
|
+
machineStateText?: string | null;
|
|
3489
|
+
machineState?: MachineState | null;
|
|
3490
|
+
startTime?: Date | null;
|
|
3491
|
+
powerOnUtilization?: number | null;
|
|
3492
|
+
}
|
|
3493
|
+
export declare class ListResourceUptimesTodayRequest implements IListResourceUptimesTodayRequest {
|
|
3494
|
+
resourceExternalIds?: string[] | null;
|
|
3495
|
+
utcOffset?: number;
|
|
3496
|
+
constructor(data?: IListResourceUptimesTodayRequest);
|
|
3497
|
+
init(_data?: any): void;
|
|
3498
|
+
static fromJS(data: any): ListResourceUptimesTodayRequest;
|
|
3499
|
+
toJSON(data?: any): any;
|
|
3500
|
+
}
|
|
3501
|
+
export interface IListResourceUptimesTodayRequest {
|
|
3502
|
+
resourceExternalIds?: string[] | null;
|
|
3503
|
+
utcOffset?: number;
|
|
3504
|
+
}
|
|
3375
3505
|
export declare class UserAppDto implements IUserAppDto {
|
|
3376
3506
|
key: string;
|
|
3377
3507
|
name: string;
|
|
@@ -11124,6 +11254,7 @@ export declare class ProductionOrderDto implements IProductionOrderDto {
|
|
|
11124
11254
|
attachments?: WorkOrderAttachmentDto[] | null;
|
|
11125
11255
|
startDate?: Date | null;
|
|
11126
11256
|
endDate?: Date | null;
|
|
11257
|
+
deliveryDate?: Date | null;
|
|
11127
11258
|
bomPosition?: string | null;
|
|
11128
11259
|
drawing?: DrawingDto | null;
|
|
11129
11260
|
orderReference?: OrderReferenceDto | null;
|
|
@@ -11151,6 +11282,7 @@ export interface IProductionOrderDto {
|
|
|
11151
11282
|
attachments?: WorkOrderAttachmentDto[] | null;
|
|
11152
11283
|
startDate?: Date | null;
|
|
11153
11284
|
endDate?: Date | null;
|
|
11285
|
+
deliveryDate?: Date | null;
|
|
11154
11286
|
bomPosition?: string | null;
|
|
11155
11287
|
drawing?: DrawingDto | null;
|
|
11156
11288
|
orderReference?: OrderReferenceDto | null;
|
|
@@ -13790,6 +13922,20 @@ export interface IMeasurementFormInstanceFeedbackDto {
|
|
|
13790
13922
|
from: string;
|
|
13791
13923
|
created: Date;
|
|
13792
13924
|
}
|
|
13925
|
+
export declare class CompleteMeasurementFormInstanceResult implements ICompleteMeasurementFormInstanceResult {
|
|
13926
|
+
hasWarning?: boolean;
|
|
13927
|
+
warningMessage?: string | null;
|
|
13928
|
+
result?: MeasurementFormInstanceDto | null;
|
|
13929
|
+
constructor(data?: ICompleteMeasurementFormInstanceResult);
|
|
13930
|
+
init(_data?: any): void;
|
|
13931
|
+
static fromJS(data: any): CompleteMeasurementFormInstanceResult;
|
|
13932
|
+
toJSON(data?: any): any;
|
|
13933
|
+
}
|
|
13934
|
+
export interface ICompleteMeasurementFormInstanceResult {
|
|
13935
|
+
hasWarning?: boolean;
|
|
13936
|
+
warningMessage?: string | null;
|
|
13937
|
+
result?: MeasurementFormInstanceDto | null;
|
|
13938
|
+
}
|
|
13793
13939
|
export declare class MeasurementFormInstanceSchemaDto implements IMeasurementFormInstanceSchemaDto {
|
|
13794
13940
|
elements: MeasurementFormInstanceElementDto[];
|
|
13795
13941
|
isCompleted: boolean;
|