@ignos/api-client 20260908.263.1 → 20260908.264.1-alpha

package/lib/ignosportal-api.d.ts

@@ -2933,6 +2933,99 @@ export declare class InspectMatchSpecificationsClient extends AuthorizedApiBase
     listSpecifications(): Promise<ImaSpecificationLiteDto[]>;
     protected processListSpecifications(response: Response): Promise<ImaSpecificationLiteDto[]>;
 }
+export interface IInspectSchemaCreatorClient {
+    getSchemaCreatorState(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
+    /**
+     * Creates the initial creator state for a schema version. Returns 409 if
+    state already exists; the caller should re-fetch it instead of writing.
+     */
+    createSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
+    updateSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
+    /**
+     * Geometry only (no values), derived from the schema's retained
+    InspectionXpert XML - used to seed a not-yet-created state with real
+    drawing positions. Throws BadRequest if the schema has no such XML +
+    drawing to derive it from.
+     */
+    getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
+    /**
+     * Starts a full drawing AI parse: clears every element and locks the
+    schema for every viewer until it completes. If one is already in
+    progress, returns that instead of starting a second one.
+     */
+    requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
+    /**
+     * Stamps the creator state's balloons onto the schema's drawing PDF and
+    returns a temporary download link.
+     */
+    exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
+    /**
+     * Starts an async snip resolve; the result is delivered through the
+    SchemaCreatorSnipResolved SignalR notification.
+     * @param image (optional)
+     */
+    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void>;
+    /**
+     * Renders the legacy-format image for one element's current snip.
+    Fire-and-forget from the client on every snip commit - the resulting
+    image isn't returned here, it's only ever read back once the schema
+    is released (SchemaCreatorLegacyMapper).
+     */
+    renderSchemaCreatorElementSnipImage(schemaVersionId: string, elementId: string, request: RenderSchemaCreatorElementSnipImageRequest): Promise<void>;
+}
+export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implements IInspectSchemaCreatorClient {
+    private http;
+    private baseUrl;
+    constructor(configuration: IApiClientConfig, baseUrl?: string, http?: {
+        fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+    });
+    getSchemaCreatorState(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
+    protected processGetSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
+    /**
+     * Creates the initial creator state for a schema version. Returns 409 if
+    state already exists; the caller should re-fetch it instead of writing.
+     */
+    createSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
+    protected processCreateSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
+    updateSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
+    protected processUpdateSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
+    /**
+     * Geometry only (no values), derived from the schema's retained
+    InspectionXpert XML - used to seed a not-yet-created state with real
+    drawing positions. Throws BadRequest if the schema has no such XML +
+    drawing to derive it from.
+     */
+    getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
+    protected processGetSchemaCreatorXmlGeometry(response: Response): Promise<SchemaCreatorXmlGeometryDto[]>;
+    /**
+     * Starts a full drawing AI parse: clears every element and locks the
+    schema for every viewer until it completes. If one is already in
+    progress, returns that instead of starting a second one.
+     */
+    requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
+    protected processRequestSchemaCreatorDocumentParse(response: Response): Promise<SchemaCreatorStateDto>;
+    /**
+     * Stamps the creator state's balloons onto the schema's drawing PDF and
+    returns a temporary download link.
+     */
+    exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
+    protected processExportSchemaCreatorDrawing(response: Response): Promise<DownloadDto>;
+    /**
+     * Starts an async snip resolve; the result is delivered through the
+    SchemaCreatorSnipResolved SignalR notification.
+     * @param image (optional)
+     */
+    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void>;
+    protected processRequestSchemaCreatorSnipParse(response: Response): Promise<void>;
+    /**
+     * Renders the legacy-format image for one element's current snip.
+    Fire-and-forget from the client on every snip commit - the resulting
+    image isn't returned here, it's only ever read back once the schema
+    is released (SchemaCreatorLegacyMapper).
+     */
+    renderSchemaCreatorElementSnipImage(schemaVersionId: string, elementId: string, request: RenderSchemaCreatorElementSnipImageRequest): Promise<void>;
+    protected processRenderSchemaCreatorElementSnipImage(response: Response): Promise<void>;
+}
 export interface IMeasurementFormSchemasAdminClient {
     getArchivedMeasurementFormSchema(id: string): Promise<MeasurementFormSchemaDto>;
     createMeasurementForm(request: CreateMeasurementFormSchema): Promise<MeasurementFormDto>;
@@ -2944,7 +3037,7 @@ export interface IMeasurementFormSchemasAdminClient {
     deleteSchemaRows(id: string, request: DeleteSchemaGroupedElementRowsDto): Promise<MeasurementFormSchemaDto>;
     uploadMeasurementImage(id: string, request: UploadMeasurementImageRequest): Promise<MeasurementFormSchemaDto>;
     updateSchemaSettings(id: string, request: UpdateSchemaSettingsRequest): Promise<UpdateSchemaSettingsRequest>;
-    uploadSchemaDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
+    uploadSchemaMarkedDrawing(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
     uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
     getMeasurementFormImportStatus(id: string): Promise<MeasurementFormImportStatusDto>;
     listLinkableMeasurementFormSchemas(schemaId: string, pageSize: number | undefined, filter: string | null | undefined, continuationToken: string | null | undefined): Promise<PagedResultOfMeasurementFormListDto>;
@@ -3027,8 +3120,8 @@ export declare class MeasurementFormSchemasAdminClient extends AuthorizedApiBase
     protected processUploadMeasurementImage(response: Response): Promise<MeasurementFormSchemaDto>;
     updateSchemaSettings(id: string, request: UpdateSchemaSettingsRequest): Promise<UpdateSchemaSettingsRequest>;
     protected processUpdateSchemaSettings(response: Response): Promise<UpdateSchemaSettingsRequest>;
-    uploadSchemaDrawing(id: string, request: UploadDrawingRequest): Promise<MeasurementFormSchemaDto>;
-    protected processUploadSchemaDrawing(response: Response): Promise<MeasurementFormSchemaDto>;
+    uploadSchemaMarkedDrawing(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
+    protected processUploadSchemaMarkedDrawing(response: Response): Promise<MeasurementFormSchemaDto>;
     uploadSchemaAttachment(id: string, request: UploadRequest): Promise<MeasurementFormSchemaDto>;
     protected processUploadSchemaAttachment(response: Response): Promise<MeasurementFormSchemaDto>;
     getMeasurementFormImportStatus(id: string): Promise<MeasurementFormImportStatusDto>;
@@ -3190,6 +3283,7 @@ export interface IMeasurementFormsInstancesClient {
     completeMeasurementFormInstance(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceDto>;
     completeMeasurementFormInstanceV2(id: string, tenantId: string | null | undefined): Promise<CompleteMeasurementFormInstanceResult>;
     getMeasurementFormInstanceSchema(id: string, schemaId: string, serialNumber: string | null | undefined, tenantId: string | null | undefined): Promise<MeasurementFormInstanceSchemaDto>;
+    getMeasurementFormInstanceSchemaCreatorState(id: string, schemaId: string, tenantId: string | null | undefined): Promise<SchemaCreatorStateDto>;
     getWorkorderMeasurementFormProgress(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceProgressDto>;
     getAuditLog(id: string, tenantId: string | null | undefined, schemaId: string | null | undefined, serialNumber: string | null | undefined, elementId: string | null | undefined): Promise<MeasurementFormElementValueAuditDto[]>;
     getValidationRules(): Promise<ValidationRuleDto[]>;
@@ -3228,6 +3322,8 @@ export declare class MeasurementFormsInstancesClient extends AuthorizedApiBase i
     protected processCompleteMeasurementFormInstanceV2(response: Response): Promise<CompleteMeasurementFormInstanceResult>;
     getMeasurementFormInstanceSchema(id: string, schemaId: string, serialNumber: string | null | undefined, tenantId: string | null | undefined): Promise<MeasurementFormInstanceSchemaDto>;
     protected processGetMeasurementFormInstanceSchema(response: Response): Promise<MeasurementFormInstanceSchemaDto>;
+    getMeasurementFormInstanceSchemaCreatorState(id: string, schemaId: string, tenantId: string | null | undefined): Promise<SchemaCreatorStateDto>;
+    protected processGetMeasurementFormInstanceSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
     getWorkorderMeasurementFormProgress(id: string, tenantId: string | null | undefined): Promise<MeasurementFormInstanceProgressDto>;
     protected processGetWorkorderMeasurementFormProgress(response: Response): Promise<MeasurementFormInstanceProgressDto>;
     getAuditLog(id: string, tenantId: string | null | undefined, schemaId: string | null | undefined, serialNumber: string | null | undefined, elementId: string | null | undefined): Promise<MeasurementFormElementValueAuditDto[]>;
@@ -9306,6 +9402,115 @@ export interface ImaSpecificationLiteDto {
     updated: Date;
     isDeleted: boolean;
 }
+export interface SchemaCreatorStateDto {
+    settings: SchemaCreatorSettingsDto;
+    elements: SchemaCreatorElementDto[];
+    documentParseStatus?: SchemaCreatorDocumentParseStatusDto | null;
+    isAutoGenerated?: boolean;
+    createdBy?: SchemaCreatorAuditInfoDto | null;
+    createdAt?: Date | null;
+    updatedBy?: SchemaCreatorAuditInfoDto | null;
+    updatedAt?: Date | null;
+}
+export interface SchemaCreatorSettingsDto {
+    unit?: SchemaCreatorUnitOfMeasureDto;
+    tolerance?: GeneralToleranceDto;
+    balloonSize?: number;
+    transparentBalloons?: boolean;
+}
+export type SchemaCreatorUnitOfMeasureDto = "Millimeter" | "Inch" | "Mixed";
+export type GeneralToleranceDto = "NotSet" | "Fine" | "Medium" | "Coarse" | "VeryCoarse";
+export interface SchemaCreatorElementDto {
+    id: string;
+    kind: SchemaCreatorElementKindDto;
+    drawings: SchemaCreatorElementDrawingsDto;
+    isDirty?: boolean | null;
+    values?: SchemaCreatorElementValuesDto | null;
+    parseResult?: SchemaCreatorSnipResultDto | null;
+    resolveAttempt?: SchemaCreatorParseAttemptDto | null;
+    createdBy?: SchemaCreatorAuditInfoDto | null;
+    createdAt?: Date | null;
+    updatedBy?: SchemaCreatorAuditInfoDto | null;
+    updatedAt?: Date | null;
+}
+export type SchemaCreatorElementKindDto = "Pending" | "Auto" | "Manual";
+export interface SchemaCreatorElementDrawingsDto {
+    snip: SchemaCreatorSnipDto;
+    balloon: SchemaCreatorPointDto;
+    pageIndex: number;
+}
+export interface SchemaCreatorSnipDto {
+    rect: SchemaCreatorRectDto;
+    rotation?: number | null;
+    unrotatedRect?: SchemaCreatorRectDto | null;
+}
+export interface SchemaCreatorRectDto {
+    origin: SchemaCreatorPointDto;
+    size: SchemaCreatorSizeDto;
+}
+export interface SchemaCreatorPointDto {
+    x: number;
+    y: number;
+}
+export interface SchemaCreatorSizeDto {
+    width: number;
+    height: number;
+}
+export interface SchemaCreatorElementValuesDto {
+    reference: number;
+    unit?: UnitOfMeasureDto | null;
+    nominal?: number | null;
+    nominalText?: string | null;
+    upperLimit?: number | null;
+    lowerLimit?: number | null;
+    plusTolerance?: number | null;
+    minusTolerance?: number | null;
+    coatingThickness?: number | null;
+    measurementFrequency: MeasurementFrequency;
+    measurementFrequencyParameter?: number | null;
+    type?: string | null;
+    count?: number | null;
+    comment?: string | null;
+    canCopy: boolean;
+    visibleToCustomer: boolean;
+    isDocumentedExternally: boolean;
+}
+export type UnitOfMeasureDto = "Millimeter" | "Inch";
+export type MeasurementFrequency = "All" | "FirstArticle" | "NFirst" | "NPercent" | "ISO2859" | "Nth" | "FirstAndLast" | "None";
+export interface SchemaCreatorSnipResultDto {
+    nominal?: number | null;
+    nominalText?: string | null;
+    upperLimit?: number | null;
+    lowerLimit?: number | null;
+    plusTolerance?: number | null;
+    minusTolerance?: number | null;
+    count?: number | null;
+}
+export interface SchemaCreatorParseAttemptDto {
+    startedAt: Date;
+    errorType?: SchemaCreatorParseErrorTypeDto | null;
+    errorMessage?: string | null;
+}
+export type SchemaCreatorParseErrorTypeDto = "Timeout" | "ParseError";
+export interface SchemaCreatorAuditInfoDto {
+    objectId: string;
+    userId: string;
+    userFullName?: string | null;
+}
+export interface SchemaCreatorDocumentParseStatusDto {
+    inProgress: boolean;
+    attempt?: SchemaCreatorParseAttemptDto | null;
+}
+export interface SchemaCreatorXmlGeometryDto {
+    xmlAttributeId: number;
+    snipRect: SchemaCreatorRectDto;
+    balloon: SchemaCreatorPointDto;
+    pageIndex: number;
+}
+export interface RenderSchemaCreatorElementSnipImageRequest {
+    pageIndex: number;
+    snip: SchemaCreatorSnipDto;
+}
 export interface MeasurementFormSchemaDto {
     id: string;
     versionId: number;
@@ -9337,9 +9542,7 @@ export interface MeasurementFormSchemaDto {
 }
 export type MeasurementFormStatus = "Draft" | "Released" | "Revoked";
 export type MeasurementFormSource = "Unknown" | "InspectionXpert" | "Excel" | "Manual";
-export type UnitOfMeasureDto = "Millimeter" | "Inch";
 export type DimensionSettingDto = "Tolerance" | "MinMaxDimension";
-export type GeneralToleranceDto = "NotSet" | "Fine" | "Medium" | "Coarse" | "VeryCoarse";
 export interface MeasurementFormSchemaAttachmentDto {
     url: string;
     title: string;
@@ -9348,6 +9551,7 @@ export interface MeasurementFormGroupedElementDto {
     id: string;
     balloonId?: string | null;
     reference: number;
+    originalXmlId?: number | null;
     imageUrl?: string | null;
     thumbnailUrl?: string | null;
     section?: string | null;
@@ -9388,7 +9592,6 @@ export interface MeasurementFormGroupedElementDto {
     isValid: boolean;
     validationErrorMessage?: string | null;
 }
-export type MeasurementFrequency = "All" | "FirstArticle" | "NFirst" | "NPercent" | "ISO2859" | "Nth" | "FirstAndLast" | "None";
 export type MeasurementFormValueType = "None" | "Bool" | "Decimal" | "String";
 export type BonusType = "None" | "Positive" | "PositiveAndNegative";
 export interface MeasurementFormLinkedSchemaDto {
@@ -9494,10 +9697,6 @@ export interface UpdateSchemaSettingsRequest {
     dimensionSetting: DimensionSettingDto;
     generalTolerance: GeneralToleranceDto;
 }
-export interface UploadDrawingRequest {
-    uploadKey: string;
-    filename: string;
-}
 export interface UploadRequest {
     uploadKey: string;
     filename: string;
@@ -9576,6 +9775,8 @@ export interface MeasurementFormCustomerSettingsDto {
     validationRuleId?: string | null;
     requireCalibratedTools: boolean;
     allowEmptyToolListInValue: boolean;
+    disableAiParseDocument: boolean;
+    disableAiParseSnip: boolean;
 }
 export interface UpdateMeasurementFormCustomerSettings {
     customerId: string;
@@ -9584,6 +9785,8 @@ export interface UpdateMeasurementFormCustomerSettings {
     validationRuleId?: string | null;
     requireCalibratedTools: boolean;
     allowEmptyToolListInValue: boolean;
+    disableAiParseDocument: boolean;
+    disableAiParseSnip: boolean;
 }
 export interface MeasurementFormMappingDto {
     id: string;
@@ -9676,6 +9879,10 @@ export interface MeasurementFormSchemaNotNeededDto {
 export interface SetMeasurementFormNeedAsNotNeededRequest {
     comment?: string | null;
 }
+export interface UploadDrawingRequest {
+    uploadKey: string;
+    filename: string;
+}
 export interface PagedResultOfMeasurementFormSchemaNotNeededDto {
     results: MeasurementFormSchemaNotNeededDto[];
     continuationToken?: string | null;