@ignos/api-client 20250707.0.12102 → 20250708.0.12110

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.
@@ -176,6 +176,7 @@ 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[]>;
179
180
  }
180
181
  export declare class MachineUtilizationClient extends AuthorizedApiBase implements IMachineUtilizationClient {
181
182
  private http;
@@ -217,6 +218,8 @@ export declare class MachineUtilizationClient extends AuthorizedApiBase implemen
217
218
  protected processListPowerOnUtilizationDatapoints(response: Response): Promise<PowerOnUtilizationList>;
218
219
  getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
219
220
  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[]>;
220
223
  }
221
224
  export interface IMeClient {
222
225
  getMyApps(): Promise<UserAppDto[]>;
@@ -392,7 +395,7 @@ export declare class PulseClient extends AuthorizedApiBase implements IPulseClie
392
395
  export interface IUtilizationClient {
393
396
  getCompanyUtilization(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CompanyUtilizationDto>;
394
397
  getCrossCompanyUtilization(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CrossCompanyUtilizationDto>;
395
- getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
398
+ getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
396
399
  getCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CompanyUtilizationDatapointListDto>;
397
400
  getCrossCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CrossCompanyUtilizationDatapointListDto>;
398
401
  }
@@ -407,7 +410,7 @@ export declare class UtilizationClient extends AuthorizedApiBase implements IUti
407
410
  protected processGetCompanyUtilization(response: Response): Promise<CompanyUtilizationDto>;
408
411
  getCrossCompanyUtilization(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CrossCompanyUtilizationDto>;
409
412
  protected processGetCrossCompanyUtilization(response: Response): Promise<CrossCompanyUtilizationDto>;
410
- getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
413
+ getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
411
414
  protected processGetUtilizationDatapoints(response: Response): Promise<MachineUtilizationDatapointListDto>;
412
415
  getCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CompanyUtilizationDatapointListDto>;
413
416
  protected processGetCompanyUtilizationDatapoints(response: Response): Promise<CompanyUtilizationDatapointListDto>;
@@ -3112,6 +3115,18 @@ export interface INumericNullableValueWithTimestamp {
3112
3115
  timestamp?: number;
3113
3116
  value?: number | null;
3114
3117
  }
3118
+ export declare class ProgramDatapoint implements IProgramDatapoint {
3119
+ timestamp?: number;
3120
+ programValue?: string;
3121
+ constructor(data?: IProgramDatapoint);
3122
+ init(_data?: any): void;
3123
+ static fromJS(data: any): ProgramDatapoint;
3124
+ toJSON(data?: any): any;
3125
+ }
3126
+ export interface IProgramDatapoint {
3127
+ timestamp?: number;
3128
+ programValue?: string;
3129
+ }
3115
3130
  export declare class UserAppDto implements IUserAppDto {
3116
3131
  key: string;
3117
3132
  name: string;
@@ -970,6 +970,58 @@ export class MachineUtilizationClient extends AuthorizedApiBase {
970
970
  }
971
971
  return Promise.resolve(null);
972
972
  }
973
+ getProgramTimeline(id, startTime, endTime) {
974
+ let url_ = this.baseUrl + "/machineutilization/{id}/program-timeline?";
975
+ if (id === undefined || id === null)
976
+ throw new Error("The parameter 'id' must be defined.");
977
+ url_ = url_.replace("{id}", encodeURIComponent("" + id));
978
+ if (startTime === null)
979
+ throw new Error("The parameter 'startTime' cannot be null.");
980
+ else if (startTime !== undefined)
981
+ url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
982
+ if (endTime === null)
983
+ throw new Error("The parameter 'endTime' cannot be null.");
984
+ else if (endTime !== undefined)
985
+ url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
986
+ url_ = url_.replace(/[?&]$/, "");
987
+ let options_ = {
988
+ method: "GET",
989
+ headers: {
990
+ "Accept": "application/json"
991
+ }
992
+ };
993
+ return this.transformOptions(options_).then(transformedOptions_ => {
994
+ return this.http.fetch(url_, transformedOptions_);
995
+ }).then((_response) => {
996
+ return this.processGetProgramTimeline(_response);
997
+ });
998
+ }
999
+ processGetProgramTimeline(response) {
1000
+ const status = response.status;
1001
+ let _headers = {};
1002
+ if (response.headers && response.headers.forEach) {
1003
+ response.headers.forEach((v, k) => _headers[k] = v);
1004
+ }
1005
+ ;
1006
+ if (status === 200) {
1007
+ return response.text().then((_responseText) => {
1008
+ let result200 = null;
1009
+ let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
1010
+ if (Array.isArray(resultData200)) {
1011
+ result200 = [];
1012
+ for (let item of resultData200)
1013
+ result200.push(ProgramDatapoint.fromJS(item));
1014
+ }
1015
+ return result200;
1016
+ });
1017
+ }
1018
+ else if (status !== 200 && status !== 204) {
1019
+ return response.text().then((_responseText) => {
1020
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
1021
+ });
1022
+ }
1023
+ return Promise.resolve(null);
1024
+ }
973
1025
  }
974
1026
  export class MeClient extends AuthorizedApiBase {
975
1027
  constructor(configuration, baseUrl, http) {
@@ -2259,7 +2311,7 @@ export class UtilizationClient extends AuthorizedApiBase {
2259
2311
  }
2260
2312
  return Promise.resolve(null);
2261
2313
  }
2262
- getUtilizationDatapoints(utilizationType, startTime, endTime, assetExternalId) {
2314
+ getUtilizationDatapoints(utilizationType, startTime, endTime, assetId, assetExternalId) {
2263
2315
  let url_ = this.baseUrl + "/utilization/datapoints?";
2264
2316
  if (utilizationType === null)
2265
2317
  throw new Error("The parameter 'utilizationType' cannot be null.");
@@ -2269,6 +2321,8 @@ export class UtilizationClient extends AuthorizedApiBase {
2269
2321
  url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
2270
2322
  if (endTime !== undefined && endTime !== null)
2271
2323
  url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
2324
+ if (assetId !== undefined && assetId !== null)
2325
+ url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
2272
2326
  if (assetExternalId !== undefined && assetExternalId !== null)
2273
2327
  url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
2274
2328
  url_ = url_.replace(/[?&]$/, "");
@@ -23418,6 +23472,34 @@ export class NumericNullableValueWithTimestamp {
23418
23472
  return data;
23419
23473
  }
23420
23474
  }
23475
+ export class ProgramDatapoint {
23476
+ constructor(data) {
23477
+ if (data) {
23478
+ for (var property in data) {
23479
+ if (data.hasOwnProperty(property))
23480
+ this[property] = data[property];
23481
+ }
23482
+ }
23483
+ }
23484
+ init(_data) {
23485
+ if (_data) {
23486
+ this.timestamp = _data["timestamp"];
23487
+ this.programValue = _data["programValue"];
23488
+ }
23489
+ }
23490
+ static fromJS(data) {
23491
+ data = typeof data === 'object' ? data : {};
23492
+ let result = new ProgramDatapoint();
23493
+ result.init(data);
23494
+ return result;
23495
+ }
23496
+ toJSON(data) {
23497
+ data = typeof data === 'object' ? data : {};
23498
+ data["timestamp"] = this.timestamp;
23499
+ data["programValue"] = this.programValue;
23500
+ return data;
23501
+ }
23502
+ }
23421
23503
  export class UserAppDto {
23422
23504
  constructor(data) {
23423
23505
  if (data) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ignos/api-client",
3
- "version": "20250707.0.12102",
3
+ "version": "20250708.0.12110",
4
4
  "description": "IGNOS API Client",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
@@ -716,6 +716,8 @@ export interface IMachineUtilizationClient {
716
716
  listPowerOnUtilizationDatapoints(id: number | null | undefined, externalId: string | null | undefined, nDays: number | null | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<PowerOnUtilizationList>;
717
717
 
718
718
  getFactoryUtilization(): Promise<PowerOnUtilizationDto>;
719
+
720
+ getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]>;
719
721
  }
720
722
 
721
723
  export class MachineUtilizationClient extends AuthorizedApiBase implements IMachineUtilizationClient {
@@ -1091,6 +1093,57 @@ export class MachineUtilizationClient extends AuthorizedApiBase implements IMach
1091
1093
  }
1092
1094
  return Promise.resolve<PowerOnUtilizationDto>(null as any);
1093
1095
  }
1096
+
1097
+ getProgramTimeline(id: string, startTime: Date | undefined, endTime: Date | undefined): Promise<ProgramDatapoint[]> {
1098
+ let url_ = this.baseUrl + "/machineutilization/{id}/program-timeline?";
1099
+ if (id === undefined || id === null)
1100
+ throw new Error("The parameter 'id' must be defined.");
1101
+ url_ = url_.replace("{id}", encodeURIComponent("" + id));
1102
+ if (startTime === null)
1103
+ throw new Error("The parameter 'startTime' cannot be null.");
1104
+ else if (startTime !== undefined)
1105
+ url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
1106
+ if (endTime === null)
1107
+ throw new Error("The parameter 'endTime' cannot be null.");
1108
+ else if (endTime !== undefined)
1109
+ url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
1110
+ url_ = url_.replace(/[?&]$/, "");
1111
+
1112
+ let options_: RequestInit = {
1113
+ method: "GET",
1114
+ headers: {
1115
+ "Accept": "application/json"
1116
+ }
1117
+ };
1118
+
1119
+ return this.transformOptions(options_).then(transformedOptions_ => {
1120
+ return this.http.fetch(url_, transformedOptions_);
1121
+ }).then((_response: Response) => {
1122
+ return this.processGetProgramTimeline(_response);
1123
+ });
1124
+ }
1125
+
1126
+ protected processGetProgramTimeline(response: Response): Promise<ProgramDatapoint[]> {
1127
+ const status = response.status;
1128
+ let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
1129
+ if (status === 200) {
1130
+ return response.text().then((_responseText) => {
1131
+ let result200: any = null;
1132
+ let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
1133
+ if (Array.isArray(resultData200)) {
1134
+ result200 = [] as any;
1135
+ for (let item of resultData200)
1136
+ result200!.push(ProgramDatapoint.fromJS(item));
1137
+ }
1138
+ return result200;
1139
+ });
1140
+ } else if (status !== 200 && status !== 204) {
1141
+ return response.text().then((_responseText) => {
1142
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
1143
+ });
1144
+ }
1145
+ return Promise.resolve<ProgramDatapoint[]>(null as any);
1146
+ }
1094
1147
  }
1095
1148
 
1096
1149
  export interface IMeClient {
@@ -2391,7 +2444,7 @@ export interface IUtilizationClient {
2391
2444
 
2392
2445
  getCrossCompanyUtilization(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CrossCompanyUtilizationDto>;
2393
2446
 
2394
- getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
2447
+ getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto>;
2395
2448
 
2396
2449
  getCompanyUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined): Promise<CompanyUtilizationDatapointListDto>;
2397
2450
 
@@ -2497,7 +2550,7 @@ export class UtilizationClient extends AuthorizedApiBase implements IUtilization
2497
2550
  return Promise.resolve<CrossCompanyUtilizationDto>(null as any);
2498
2551
  }
2499
2552
 
2500
- getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto> {
2553
+ getUtilizationDatapoints(utilizationType: UtilizationTypeDto | undefined, startTime: Date | null | undefined, endTime: Date | null | undefined, assetId: number | null | undefined, assetExternalId: string | null | undefined): Promise<MachineUtilizationDatapointListDto> {
2501
2554
  let url_ = this.baseUrl + "/utilization/datapoints?";
2502
2555
  if (utilizationType === null)
2503
2556
  throw new Error("The parameter 'utilizationType' cannot be null.");
@@ -2507,6 +2560,8 @@ export class UtilizationClient extends AuthorizedApiBase implements IUtilization
2507
2560
  url_ += "startTime=" + encodeURIComponent(startTime ? "" + startTime.toISOString() : "") + "&";
2508
2561
  if (endTime !== undefined && endTime !== null)
2509
2562
  url_ += "endTime=" + encodeURIComponent(endTime ? "" + endTime.toISOString() : "") + "&";
2563
+ if (assetId !== undefined && assetId !== null)
2564
+ url_ += "assetId=" + encodeURIComponent("" + assetId) + "&";
2510
2565
  if (assetExternalId !== undefined && assetExternalId !== null)
2511
2566
  url_ += "assetExternalId=" + encodeURIComponent("" + assetExternalId) + "&";
2512
2567
  url_ = url_.replace(/[?&]$/, "");
@@ -25328,6 +25383,46 @@ export interface INumericNullableValueWithTimestamp {
25328
25383
  value?: number | null;
25329
25384
  }
25330
25385
 
25386
+ export class ProgramDatapoint implements IProgramDatapoint {
25387
+ timestamp?: number;
25388
+ programValue?: string;
25389
+
25390
+ constructor(data?: IProgramDatapoint) {
25391
+ if (data) {
25392
+ for (var property in data) {
25393
+ if (data.hasOwnProperty(property))
25394
+ (<any>this)[property] = (<any>data)[property];
25395
+ }
25396
+ }
25397
+ }
25398
+
25399
+ init(_data?: any) {
25400
+ if (_data) {
25401
+ this.timestamp = _data["timestamp"];
25402
+ this.programValue = _data["programValue"];
25403
+ }
25404
+ }
25405
+
25406
+ static fromJS(data: any): ProgramDatapoint {
25407
+ data = typeof data === 'object' ? data : {};
25408
+ let result = new ProgramDatapoint();
25409
+ result.init(data);
25410
+ return result;
25411
+ }
25412
+
25413
+ toJSON(data?: any) {
25414
+ data = typeof data === 'object' ? data : {};
25415
+ data["timestamp"] = this.timestamp;
25416
+ data["programValue"] = this.programValue;
25417
+ return data;
25418
+ }
25419
+ }
25420
+
25421
+ export interface IProgramDatapoint {
25422
+ timestamp?: number;
25423
+ programValue?: string;
25424
+ }
25425
+
25331
25426
  export class UserAppDto implements IUserAppDto {
25332
25427
  key!: string;
25333
25428
  name!: string;