@ignos/api-client 20260908.263.1 → 20260909.265.1-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.
@@ -2933,6 +2933,99 @@ export declare class InspectMatchSpecificationsClient extends AuthorizedApiBase
2933
2933
  listSpecifications(): Promise<ImaSpecificationLiteDto[]>;
2934
2934
  protected processListSpecifications(response: Response): Promise<ImaSpecificationLiteDto[]>;
2935
2935
  }
2936
+ export interface IInspectSchemaCreatorClient {
2937
+ getSchemaCreatorState(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
2938
+ /**
2939
+ * Creates the initial creator state for a schema version. Returns 409 if
2940
+ state already exists; the caller should re-fetch it instead of writing.
2941
+ */
2942
+ createSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
2943
+ updateSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
2944
+ /**
2945
+ * Geometry only (no values), derived from the schema's retained
2946
+ InspectionXpert XML - used to seed a not-yet-created state with real
2947
+ drawing positions. Throws BadRequest if the schema has no such XML +
2948
+ drawing to derive it from.
2949
+ */
2950
+ getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
2951
+ /**
2952
+ * Starts a full drawing AI parse: clears every element and locks the
2953
+ schema for every viewer until it completes. If one is already in
2954
+ progress, returns that instead of starting a second one.
2955
+ */
2956
+ requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
2957
+ /**
2958
+ * Stamps the creator state's balloons onto the schema's drawing PDF and
2959
+ returns a temporary download link.
2960
+ */
2961
+ exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
2962
+ /**
2963
+ * Starts an async snip resolve; the result is delivered through the
2964
+ SchemaCreatorSnipResolved SignalR notification.
2965
+ * @param image (optional)
2966
+ */
2967
+ requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void>;
2968
+ /**
2969
+ * Renders the legacy-format image for one element's current snip.
2970
+ Fire-and-forget from the client on every snip commit - the resulting
2971
+ image isn't returned here, it's only ever read back once the schema
2972
+ is released (SchemaCreatorLegacyMapper).
2973
+ */
2974
+ renderSchemaCreatorElementSnipImage(schemaVersionId: string, elementId: string, request: RenderSchemaCreatorElementSnipImageRequest): Promise<void>;
2975
+ }
2976
+ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implements IInspectSchemaCreatorClient {
2977
+ private http;
2978
+ private baseUrl;
2979
+ constructor(configuration: IApiClientConfig, baseUrl?: string, http?: {
2980
+ fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
2981
+ });
2982
+ getSchemaCreatorState(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
2983
+ protected processGetSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
2984
+ /**
2985
+ * Creates the initial creator state for a schema version. Returns 409 if
2986
+ state already exists; the caller should re-fetch it instead of writing.
2987
+ */
2988
+ createSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
2989
+ protected processCreateSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
2990
+ updateSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
2991
+ protected processUpdateSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
2992
+ /**
2993
+ * Geometry only (no values), derived from the schema's retained
2994
+ InspectionXpert XML - used to seed a not-yet-created state with real
2995
+ drawing positions. Throws BadRequest if the schema has no such XML +
2996
+ drawing to derive it from.
2997
+ */
2998
+ getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
2999
+ protected processGetSchemaCreatorXmlGeometry(response: Response): Promise<SchemaCreatorXmlGeometryDto[]>;
3000
+ /**
3001
+ * Starts a full drawing AI parse: clears every element and locks the
3002
+ schema for every viewer until it completes. If one is already in
3003
+ progress, returns that instead of starting a second one.
3004
+ */
3005
+ requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
3006
+ protected processRequestSchemaCreatorDocumentParse(response: Response): Promise<SchemaCreatorStateDto>;
3007
+ /**
3008
+ * Stamps the creator state's balloons onto the schema's drawing PDF and
3009
+ returns a temporary download link.
3010
+ */
3011
+ exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
3012
+ protected processExportSchemaCreatorDrawing(response: Response): Promise<DownloadDto>;
3013
+ /**
3014
+ * Starts an async snip resolve; the result is delivered through the
3015
+ SchemaCreatorSnipResolved SignalR notification.
3016
+ * @param image (optional)
3017
+ */
3018
+ requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void>;
3019
+ protected processRequestSchemaCreatorSnipParse(response: Response): Promise<void>;
3020
+ /**
3021
+ * Renders the legacy-format image for one element's current snip.
3022
+ Fire-and-forget from the client on every snip commit - the resulting
3023
+ image isn't returned here, it's only ever read back once the schema
3024
+ is released (SchemaCreatorLegacyMapper).
3025
+ */
3026
+ renderSchemaCreatorElementSnipImage(schemaVersionId: string, elementId: string, request: RenderSchemaCreatorElementSnipImageRequest): Promise<void>;
3027
+ protected processRenderSchemaCreatorElementSnipImage(response: Response): Promise<void>;
3028
+ }
2936
3029
  export interface IMeasurementFormSchemasAdminClient {
2937
3030
  getArchivedMeasurementFormSchema(id: string): Promise<MeasurementFormSchemaDto>;
2938
3031
  createMeasurementForm(request: CreateMeasurementFormSchema): Promise<MeasurementFormDto>;
@@ -2944,6 +3037,10 @@ export interface IMeasurementFormSchemasAdminClient {
2944
3037
  deleteSchemaRows(id: string, request: DeleteSchemaGroupedElementRowsDto): Promise<MeasurementFormSchemaDto>;
2945
3038
  uploadMeasurementImage(id: string, request: UploadMeasurementImageRequest): Promise<MeasurementFormSchemaDto>;
2946
3039
  updateSchemaSettings(id: string, request: UpdateSchemaSettingsRequest): Promise<UpdateSchemaSettingsRequest>;
3040
+ uploadSchemaMarkedDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
3041
+ /**
3042
+ * @deprecated
3043
+ */
2947
3044
  uploadSchemaDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
2948
3045
  uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
2949
3046
  getMeasurementFormImportStatus(id: string): Promise<MeasurementFormImportStatusDto>;
@@ -3027,6 +3124,11 @@ export declare class MeasurementFormSchemasAdminClient extends AuthorizedApiBase
3027
3124
  protected processUploadMeasurementImage(response: Response): Promise<MeasurementFormSchemaDto>;
3028
3125
  updateSchemaSettings(id: string, request: UpdateSchemaSettingsRequest): Promise<UpdateSchemaSettingsRequest>;
3029
3126
  protected processUpdateSchemaSettings(response: Response): Promise<UpdateSchemaSettingsRequest>;
3127
+ uploadSchemaMarkedDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
3128
+ protected processUploadSchemaMarkedDrawing(response: Response): Promise<MeasurementFormSchemaDto>;
3129
+ /**
3130
+ * @deprecated
3131
+ */
3030
3132
  uploadSchemaDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
3031
3133
  protected processUploadSchemaDrawing(response: Response): Promise<MeasurementFormSchemaDto>;
3032
3134
  uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
@@ -3190,6 +3292,7 @@ export interface IMeasurementFormsInstancesClient {
3190
3292
  completeMeasurementFormInstance(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceDto>;
3191
3293
  completeMeasurementFormInstanceV2(id: string, tenantId: string | null | undefined): Promise<CompleteMeasurementFormInstanceResult>;
3192
3294
  getMeasurementFormInstanceSchema(id: string, schemaId: string, serialNumber: string | null | undefined, tenantId: string | null | undefined): Promise<MeasurementFormInstanceSchemaDto>;
3295
+ getMeasurementFormInstanceSchemaCreatorState(id: string, schemaId: string, tenantId: string | null | undefined): Promise<SchemaCreatorStateDto>;
3193
3296
  getWorkorderMeasurementFormProgress(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceProgressDto>;
3194
3297
  getAuditLog(id: string, tenantId: string | null | undefined, schemaId: string | null | undefined, serialNumber: string | null | undefined, elementId: string | null | undefined): Promise<MeasurementFormElementValueAuditDto[]>;
3195
3298
  getValidationRules(): Promise<ValidationRuleDto[]>;
@@ -3228,6 +3331,8 @@ export declare class MeasurementFormsInstancesClient extends AuthorizedApiBase i
3228
3331
  protected processCompleteMeasurementFormInstanceV2(response: Response): Promise<CompleteMeasurementFormInstanceResult>;
3229
3332
  getMeasurementFormInstanceSchema(id: string, schemaId: string, serialNumber: string | null | undefined, tenantId: string | null | undefined): Promise<MeasurementFormInstanceSchemaDto>;
3230
3333
  protected processGetMeasurementFormInstanceSchema(response: Response): Promise<MeasurementFormInstanceSchemaDto>;
3334
+ getMeasurementFormInstanceSchemaCreatorState(id: string, schemaId: string, tenantId: string | null | undefined): Promise<SchemaCreatorStateDto>;
3335
+ protected processGetMeasurementFormInstanceSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
3231
3336
  getWorkorderMeasurementFormProgress(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceProgressDto>;
3232
3337
  protected processGetWorkorderMeasurementFormProgress(response: Response): Promise<MeasurementFormInstanceProgressDto>;
3233
3338
  getAuditLog(id: string, tenantId: string | null | undefined, schemaId: string | null | undefined, serialNumber: string | null | undefined, elementId: string | null | undefined): Promise<MeasurementFormElementValueAuditDto[]>;
@@ -9306,6 +9411,115 @@ export interface ImaSpecificationLiteDto {
9306
9411
  updated: Date;
9307
9412
  isDeleted: boolean;
9308
9413
  }
9414
+ export interface SchemaCreatorStateDto {
9415
+ settings: SchemaCreatorSettingsDto;
9416
+ elements: SchemaCreatorElementDto[];
9417
+ documentParseStatus?: SchemaCreatorDocumentParseStatusDto | null;
9418
+ isAutoGenerated?: boolean;
9419
+ createdBy?: SchemaCreatorAuditInfoDto | null;
9420
+ createdAt?: Date | null;
9421
+ updatedBy?: SchemaCreatorAuditInfoDto | null;
9422
+ updatedAt?: Date | null;
9423
+ }
9424
+ export interface SchemaCreatorSettingsDto {
9425
+ unit?: SchemaCreatorUnitOfMeasureDto;
9426
+ tolerance?: GeneralToleranceDto;
9427
+ balloonSize?: number;
9428
+ transparentBalloons?: boolean;
9429
+ }
9430
+ export type SchemaCreatorUnitOfMeasureDto = "Millimeter" | "Inch" | "Mixed";
9431
+ export type GeneralToleranceDto = "NotSet" | "Fine" | "Medium" | "Coarse" | "VeryCoarse";
9432
+ export interface SchemaCreatorElementDto {
9433
+ id: string;
9434
+ kind: SchemaCreatorElementKindDto;
9435
+ drawings: SchemaCreatorElementDrawingsDto;
9436
+ isDirty?: boolean | null;
9437
+ values?: SchemaCreatorElementValuesDto | null;
9438
+ parseResult?: SchemaCreatorSnipResultDto | null;
9439
+ resolveAttempt?: SchemaCreatorParseAttemptDto | null;
9440
+ createdBy?: SchemaCreatorAuditInfoDto | null;
9441
+ createdAt?: Date | null;
9442
+ updatedBy?: SchemaCreatorAuditInfoDto | null;
9443
+ updatedAt?: Date | null;
9444
+ }
9445
+ export type SchemaCreatorElementKindDto = "Pending" | "Auto" | "Manual";
9446
+ export interface SchemaCreatorElementDrawingsDto {
9447
+ snip: SchemaCreatorSnipDto;
9448
+ balloon: SchemaCreatorPointDto;
9449
+ pageIndex: number;
9450
+ }
9451
+ export interface SchemaCreatorSnipDto {
9452
+ rect: SchemaCreatorRectDto;
9453
+ rotation?: number | null;
9454
+ unrotatedRect?: SchemaCreatorRectDto | null;
9455
+ }
9456
+ export interface SchemaCreatorRectDto {
9457
+ origin: SchemaCreatorPointDto;
9458
+ size: SchemaCreatorSizeDto;
9459
+ }
9460
+ export interface SchemaCreatorPointDto {
9461
+ x: number;
9462
+ y: number;
9463
+ }
9464
+ export interface SchemaCreatorSizeDto {
9465
+ width: number;
9466
+ height: number;
9467
+ }
9468
+ export interface SchemaCreatorElementValuesDto {
9469
+ reference: number;
9470
+ unit?: UnitOfMeasureDto | null;
9471
+ nominal?: number | null;
9472
+ nominalText?: string | null;
9473
+ upperLimit?: number | null;
9474
+ lowerLimit?: number | null;
9475
+ plusTolerance?: number | null;
9476
+ minusTolerance?: number | null;
9477
+ coatingThickness?: number | null;
9478
+ measurementFrequency: MeasurementFrequency;
9479
+ measurementFrequencyParameter?: number | null;
9480
+ type?: string | null;
9481
+ count?: number | null;
9482
+ comment?: string | null;
9483
+ canCopy: boolean;
9484
+ visibleToCustomer: boolean;
9485
+ isDocumentedExternally: boolean;
9486
+ }
9487
+ export type UnitOfMeasureDto = "Millimeter" | "Inch";
9488
+ export type MeasurementFrequency = "All" | "FirstArticle" | "NFirst" | "NPercent" | "ISO2859" | "Nth" | "FirstAndLast" | "None";
9489
+ export interface SchemaCreatorSnipResultDto {
9490
+ nominal?: number | null;
9491
+ nominalText?: string | null;
9492
+ upperLimit?: number | null;
9493
+ lowerLimit?: number | null;
9494
+ plusTolerance?: number | null;
9495
+ minusTolerance?: number | null;
9496
+ count?: number | null;
9497
+ }
9498
+ export interface SchemaCreatorParseAttemptDto {
9499
+ startedAt: Date;
9500
+ errorType?: SchemaCreatorParseErrorTypeDto | null;
9501
+ errorMessage?: string | null;
9502
+ }
9503
+ export type SchemaCreatorParseErrorTypeDto = "Timeout" | "ParseError";
9504
+ export interface SchemaCreatorAuditInfoDto {
9505
+ objectId: string;
9506
+ userId: string;
9507
+ userFullName?: string | null;
9508
+ }
9509
+ export interface SchemaCreatorDocumentParseStatusDto {
9510
+ inProgress: boolean;
9511
+ attempt?: SchemaCreatorParseAttemptDto | null;
9512
+ }
9513
+ export interface SchemaCreatorXmlGeometryDto {
9514
+ xmlAttributeId: number;
9515
+ snipRect: SchemaCreatorRectDto;
9516
+ balloon: SchemaCreatorPointDto;
9517
+ pageIndex: number;
9518
+ }
9519
+ export interface RenderSchemaCreatorElementSnipImageRequest {
9520
+ pageIndex: number;
9521
+ snip: SchemaCreatorSnipDto;
9522
+ }
9309
9523
  export interface MeasurementFormSchemaDto {
9310
9524
  id: string;
9311
9525
  versionId: number;
@@ -9337,9 +9551,7 @@ export interface MeasurementFormSchemaDto {
9337
9551
  }
9338
9552
  export type MeasurementFormStatus = "Draft" | "Released" | "Revoked";
9339
9553
  export type MeasurementFormSource = "Unknown" | "InspectionXpert" | "Excel" | "Manual";
9340
- export type UnitOfMeasureDto = "Millimeter" | "Inch";
9341
9554
  export type DimensionSettingDto = "Tolerance" | "MinMaxDimension";
9342
- export type GeneralToleranceDto = "NotSet" | "Fine" | "Medium" | "Coarse" | "VeryCoarse";
9343
9555
  export interface MeasurementFormSchemaAttachmentDto {
9344
9556
  url: string;
9345
9557
  title: string;
@@ -9348,6 +9560,7 @@ export interface MeasurementFormGroupedElementDto {
9348
9560
  id: string;
9349
9561
  balloonId?: string | null;
9350
9562
  reference: number;
9563
+ originalXmlId?: number | null;
9351
9564
  imageUrl?: string | null;
9352
9565
  thumbnailUrl?: string | null;
9353
9566
  section?: string | null;
@@ -9388,7 +9601,6 @@ export interface MeasurementFormGroupedElementDto {
9388
9601
  isValid: boolean;
9389
9602
  validationErrorMessage?: string | null;
9390
9603
  }
9391
- export type MeasurementFrequency = "All" | "FirstArticle" | "NFirst" | "NPercent" | "ISO2859" | "Nth" | "FirstAndLast" | "None";
9392
9604
  export type MeasurementFormValueType = "None" | "Bool" | "Decimal" | "String";
9393
9605
  export type BonusType = "None" | "Positive" | "PositiveAndNegative";
9394
9606
  export interface MeasurementFormLinkedSchemaDto {
@@ -9501,6 +9713,7 @@ export interface UploadDrawingRequest {
9501
9713
  export interface UploadRequest {
9502
9714
  uploadKey: string;
9503
9715
  filename: string;
9716
+ isMarkedDrawing?: boolean | null;
9504
9717
  }
9505
9718
  export interface MeasurementFormImportStatusDto {
9506
9719
  progress: number;
@@ -9576,6 +9789,8 @@ export interface MeasurementFormCustomerSettingsDto {
9576
9789
  validationRuleId?: string | null;
9577
9790
  requireCalibratedTools: boolean;
9578
9791
  allowEmptyToolListInValue: boolean;
9792
+ disableAiParseDocument: boolean;
9793
+ disableAiParseSnip: boolean;
9579
9794
  }
9580
9795
  export interface UpdateMeasurementFormCustomerSettings {
9581
9796
  customerId: string;
@@ -9584,6 +9799,8 @@ export interface UpdateMeasurementFormCustomerSettings {
9584
9799
  validationRuleId?: string | null;
9585
9800
  requireCalibratedTools: boolean;
9586
9801
  allowEmptyToolListInValue: boolean;
9802
+ disableAiParseDocument: boolean;
9803
+ disableAiParseSnip: boolean;
9587
9804
  }
9588
9805
  export interface MeasurementFormMappingDto {
9589
9806
  id: string;