Skip to main content

@twinfinity/twin

Index

Classes

Functions

Interfaces

Type Aliases

Type Aliases

AssetBatchGetStatus

AssetBatchGetStatus: found | notFound

AssetBatchOperation

AssetBatchOperationStatus

AssetBatchOperationStatus: upserted | deleted | restored | reverted | conflicted | notFound | forbidden | badRequest

DiagnosticCategory

DiagnosticCategory: InvalidData | Geometry

The category of the diagnostic event.

DiagnosticLevel

DiagnosticLevel: Fatal | Error | Warning | Information | Debug

The severity level of the diagnostic event.

EpsgType

EpsgType: 4326

FacilityClass

FacilityClass: IfcBridge | IfcBuilding | IfcMarineFacility | IfcRailway | IfcRoad

Type of facility (e.g. IfcBuilding)

Types of facilities

FacilityPartClass

FacilityPartClass: IfcBridgePart | IfcBuildingStorey | IfcMarinePart | IfcRailwayPart | IfcRoadPart

Type of facility part (e.g. IfcBuildingStorey)

Types of facility parts

IfcDiagnosticCode

IfcDiagnosticCode: CompletelyTransparent | HighVertexCount | IncorrectAttributeDataType | InvalidBound | InvalidColor | InvalidElementQuantity | InvalidEnumValue | InvalidFace | InvalidMesh | InvalidObjectReference | InvalidPosition | InvalidProperty | InvalidPropertySet | InvalidQuantity | InvalidRelation | InvalidSpecularHighlight | InvalidWorldCoordinateSystem | InvalidUnit | LargeMeshNotHealed | MappedItemWithoutTarget | MaterialHasMultipleStyles | MeshFarFromOrigo | MeshOmitted | MissingOrInvalidSurfaceColor | MissingPlacement | MultipleProjects | NamedUnitWithoutName | NonUnitEntityReferredAsUnit | NoProject | NotEnoughAttributes | OpenSpace | PropertySetWithoutName | PropertyWithoutName | QuantityWithoutName | RepresentationItemWithoutContext | StyleContainsMultipleSurfaceStyles | SubContextInProjectRepresentationContexts | UnitWithoutType | UnknownMaterialType | UnknownPrefix | UnknownUnitType | UnsupportedRepresentationItem | UnsupportedStyleElement | UnsupportedUnitType

Op

Op: replace | remove

The patch operation type

SinglePropertyValueType

SinglePropertyValueType: IfcAbsorbedDoseMeasure | IfcAccelerationMeasure | IfcAmountOfSubstanceMeasure | IfcAngularVelocityMeasure | IfcAreaMeasure | IfcBinary | IfcBoolean | IfcCountMeasure | IfcDate | IfcDateTime | IfcDescriptiveMeasure | IfcDoseEquivalentMeasure | IfcDuration | IfcDynamicViscosityMeasure | IfcElectricCapacitanceMeasure | IfcElectricChargeMeasure | IfcElectricConductanceMeasure | IfcElectricCurrentMeasure | IfcElectricResistanceMeasure | IfcElectricVoltageMeasure | IfcEnergyMeasure | IfcForceMeasure | IfcFrequencyMeasure | IfcHeatFluxDensityMeasure | IfcHeatingValueMeasure | IfcIdentifier | IfcIlluminanceMeasure | IfcInductanceMeasure | IfcInteger | IfcIntegerCountRateMeasure | IfcIonConcentrationMeasure | IfcIsothermalMoistureCapacityMeasure | IfcKinematicViscosityMeasure | IfcLabel | IfcLengthMeasure | IfcLinearForceMeasure | IfcLinearMomentMeasure | IfcLinearStiffnessMeasure | IfcLinearVelocityMeasure | IfcLogical | IfcLuminousFluxMeasure | IfcLuminousIntensityDistributionMeasure | IfcLuminousIntensityMeasure | IfcMagneticFluxDensityMeasure | IfcMagneticFluxMeasure | IfcMassDensityMeasure | IfcMassFlowRateMeasure | IfcMassMeasure | IfcMassPerLengthMeasure | IfcModulusOfElasticityMeasure | IfcModulusOfLinearSubgradeReactionMeasure | IfcModulusOfRotationalSubgradeReactionMeasure | IfcModulusOfSubgradeReactionMeasure | IfcMoistureDiffusivityMeasure | IfcMolecularWeightMeasure | IfcMomentOfInertiaMeasure | IfcMonetaryMeasure | IfcNonNegativeLengthMeasure | IfcNormalisedRatioMeasure | IfcNumericMeasure | IfcParameterValue | IfcPHMeasure | IfcPlanarForceMeasure | IfcPlaneAngleMeasure | IfcPositiveInteger | IfcPositiveLengthMeasure | IfcPositivePlaneAngleMeasure | IfcPositiveRatioMeasure | IfcPowerMeasure | IfcPressureMeasure | IfcRadioActivityMeasure | IfcRatioMeasure | IfcReal | IfcRotationalFrequencyMeasure | IfcRotationalMassMeasure | IfcRotationalStiffnessMeasure | IfcSectionModulusMeasure | IfcSolidAngleMeasure | IfcSoundPowerMeasure | IfcSoundPressureLevelMeasure | IfcSoundPressureMeasure | IfcSpecificHeatCapacityMeasure | IfcTemperatureGradientMeasure | IfcTemperatureRateOfChangeMeasure | IfcText | IfcThermalAdmittanceMeasure | IfcThermalConductivityMeasure | IfcThermalExpansionCoefficientMeasure | IfcThermalResistanceMeasure | IfcThermalTransmittanceMeasure | IfcThermodynamicTemperatureMeasure | IfcTime | IfcTimeMeasure | IfcTimeStamp | IfcTorqueMeasure | IfcURIReference | IfcVaporPermeabilityMeasure | IfcVolumeMeasure | IfcVolumetricFlowRateMeasure | IfcWarpingConstantMeasure | IfcWarpingMomentMeasure

Type of value (e.g IfcDate, IfcAreaMeasure, IfcInteger, IfcElectricCurrentMeasure)

Types of property values that consists of a single value

SingleQuantityValueType

SingleQuantityValueType: IfcQuantityArea | IfcQuantityCount | IfcQuantityLength | IfcQuantityNumber | IfcQuantityVolume | IfcQuantityTime | IfcQuantityWeight

Type of value (e.g IfcQuantityArea, IfcQuantityNumber)

Types of qunatity values that consists of a single value

SiteType

SiteType: IfcSite

Type of site (i.e. IfcSite)

Types of Twins

SpaceType

SpaceType: IfcSpace

Type of space (e.g. IfcSpace)

TwinCapability

TwinCapability: ViewAssetTypes | EditAssetTypes

Named, customer-scoped capability the caller can exercise against the Twin service. Returned by GET /twins/permissions/me. Forward-compatible: unknown strings should be treated as "not granted" and ignored, so adding a new capability on the backend is a non-breaking change for clients compiled against older types.

TwinDiagnosticCode

TwinDiagnosticCode: CircularHierarchy | FacilityPartNotMapped | GeometryReferenceEmpty | GeometryReferenceShadowed | InvalidInsertionPoint | InvalidStructure | MissingElement | MissingFile | PatchTargetNotFound

TwinErrorCause

TwinErrorCause: NotAllowedToEditDeletedItem | NotAllowedToDeleteItem | ImmutableField | ReferencedItemNotFound | ReferencedItemDeleted | FileNotOwnedByTwin | DuplicateFileReference | MultipleVersionsOfSameFileOnSameNode | LimitOutOfRange | OffsetOutOfRange | IdMismatchBetweenUrlAndBody | BatchSizeEmpty | BatchSizeExceedsMaximum | InvalidParameterCombination | DocumentChangeNotFound | DeletePermissionRequired | CannotEditDeletedFile | CannotMoveFileBetweenTwins | ContainerDoesNotExist | DuplicateContainerIds | InsufficientPermissionsOnContainer | DuplicateId | MetadataTooLarge | InvalidTransform | InvalidFilePatches | MetadataValidationFailed | MetadataSchemaInvalid | AssetTypeNotFound | AssetCategoryAndTypeRequired | StringIdInUse | CatalogTooLarge | EtagRequired | (string & {})

Closed union of cause values the Twin service emits on a 400 response. Mirrors TwinBadRequestCause in backend/services/Twinfinity.Twin/Controllers/Model/TwinStatus.cs. The trailing (string & {}) keeps autocomplete on the known values while still accepting unknown causes at the type level — a forward-compat pattern: a new cause emitted by a newer server doesn't break older clients that pattern-match on the union. Matches the shape of TwinCapability in types/twin-permissions-api.ts.

TwinErrorItemKind

TwinErrorItemKind: Twin | Asset | File | DocumentChange | AssetCategory | AssetType | (string & {})

Closed union of item.kind values the server emits. Mirrors ItemKind in backend/services/Twinfinity.Twin/Model/ItemReference.cs. Same forward-compat shape as TwinErrorCause.

UploadStatus

UploadStatus: NotFound | InProgress | Completed | Cancelled | Failed