.. This page is generated by scripts/generate_dataclass_docs.py. Do not edit manually. Models / Review =============== .. automodule:: teksi_hooks.models.review ChangeCreationResult -------------------- .. autoclass:: teksi_hooks.models.review.ChangeCreationResult :members: Fields ~~~~~~ ``job_id`` Type: ``str | None`` Database-generated identifier of the inserted review-job metadata row. ``import_model`` Type: ``str | None`` Name of the import model. ``incremental_import_model`` Type: ``str | None`` Name of the incremental import model. ``created_models`` Type: ``list[str]`` List of created models. ``incremental_created_models`` Type: ``list[str]`` List of created incremental models. ``effect_document`` Type: ``EffectDocument | None`` Effect Document of the corresponding workflow. ``changes`` Type: ``list[Change]`` Changes of the corresponding workflow. ``validation_findings`` Type: ``list[ValidationFinding]`` Validation findings of the corresponding workflow. ``classified_changes`` Type: ``ClassifiedChanges | None`` Classified Changes of the corresponding workflow. ``features_by_class`` Type: ``dict[str, list[ReviewFeature]]`` List of review features by class. ``diff_schema_result`` Type: ``DiffSchemaWriteResult | None`` Result of the Diff Schema Writer. DiffReviewDecisionResult ------------------------ .. autoclass:: teksi_hooks.models.review.DiffReviewDecisionResult :members: Fields ~~~~~~ ``job_id`` Type: ``str`` Logical identifier of the diff review job that was resolved. ``snapshot_id`` Type: ``UUID`` Identifier of the immutable diff snapshot to which the decision was applied. ``decision`` Type: ``DiffReviewDecision`` Decision taken for the pending review job. ``job_status`` Type: ``DiffReviewJobStatus`` Resulting lifecycle status of the diff review job. ``persistence_result`` Type: ``PersistenceResult | None`` Aggregate result of persisting accepted canonical changes. This is None when the review job was rejected. DiffReviewJob ------------- .. autoclass:: teksi_hooks.models.review.DiffReviewJob :members: Fields ~~~~~~ ``job_db_id`` Type: ``int`` Database-generated identifier of the review-job metadata row. Review-feature rows may reference this value through their job foreign key. ``job_id`` Type: ``str`` Stable external identifier used to retrieve, replace, accept or reject the review job. ``job_status`` Type: ``str`` Current lifecycle status of the review job, such as 'pending', 'rejected' or 'applied'. ``validation_success`` Type: ``bool`` Whether validation of the imported data completed successfully before the review job was created. ``metadata`` Type: ``Mapping[str, Any]`` Workflow and model-specific metadata associated with the review job. This may include source models, source files, schema names, provider context, mapping provenance and snapshot identifiers. ``features_by_class`` Type: ``Mapping[str, Sequence[ReviewFeature,]]`` Review features grouped by canonical class identifier. Feature ordering within each class is preserved. DiffSchemaWriteResult --------------------- .. autoclass:: teksi_hooks.models.review.DiffSchemaWriteResult :members: Fields ~~~~~~ ``job_db_id`` Type: ``int`` Database-generated identifier of the inserted review-job metadata row. ``job_id`` Type: ``str`` Stable external identifier of the written review job. ``row_count`` Type: ``int`` Total number of review-feature rows written across all canonical class tables. The metadata row is not included. PreparedSource -------------- .. autoclass:: teksi_hooks.models.review.PreparedSource :members: Fields ~~~~~~ ``source_model`` Type: ``str`` Exact source-model identifier used to import and project the source delivery. ``created_models`` Type: ``tuple[str, ...]`` Concrete INTERLIS model identifiers used to create the quarantine schema. Models are ordered dependency-first, with the primary source model appearing last. ``effect_document`` Type: ``EffectDocument`` Canonical effect document projected from the validated source quarantine. A later incremental source may override matching effects before the pending review job is created. ``metadata`` Type: ``Mapping[str, Any]`` Workflow and source-specific metadata associated with the prepared projection. This may include the source role, XTF path, quarantine schema, semantic model group, model language, provider context and mapping provenance. ReviewFeature ------------- .. autoclass:: teksi_hooks.models.review.ReviewFeature :members: Fields ~~~~~~ ``class_id`` Type: ``str`` Canonical class identifier represented by this review feature. ``object_id`` Type: ``str`` Canonical object identifier represented by this review feature. ``attributes`` Type: ``dict[str, Any]`` Canonical attribute values and review metadata attributes to be exported for this feature. ``geometries`` Type: ``dict[str, Any]`` Geometry values keyed by canonical geometry attribute name. Multiple geometry attributes are supported because some canonical classes may expose more than one geometry.