ITwinClient

Implemented by

• TwinClient

Index

Properties

• baseUrl

Methods

• batchAssets
• batchGetAssets
• createAssetAttachmentUploadSession
• createAssets
• createOrUpdateTwin
• createOrUpdateTwinFile
• deleteAsset
• deleteAssetAttachment
• deleteAssetCategory
• deleteAssetType
• deleteTwin
• deleteTwinFile
• downloadTwinContent
• getAsset
• getAssetAttachmentBlob
• getAssetAttachmentUploadStatus
• getAssetCategory
• getAssetType
• getAssetTypeCatalog
• getAssetTypeMetaSchema
• getMyPermissions
• getProcessorEvents
• getTwin
• getTwinContent
• getTwinDiagnostics
• getTwinFile
• getTwinFileContent
• getTwinFileVersion
• getTwinFileVersionContent
• getTwinVersionContent
• getTwinVersionDiagnostics
• getTwinVersionEvents
• listAllTwins
• listAssetAttachments
• listAssetCategories
• listAssetCategoryVersions
• listAssetTypeVersions
• listAssetTypes
• listAssets
• listTwinFileVersions
• listTwinFiles
• listTwinVersions
• listTwins
• loadGeometryInfo
• loadGeometryInfoWithFactories
• loadTwin
• loadTwinWithFactories
• loadTwinWithGeometry
• putAssetAttachment
• putAssetCategory
• putAssetType
• restoreAsset
• restoreAssetAttachment
• restoreAssetCategory
• restoreAssetType
• restoreTwin
• restoreTwinFile
• updateAsset
• updateTwin
• uploadAssetAttachmentFile

Properties

readonlybaseUrl

baseUrl: string

Rooted twins base URL — typically <host>/sites/<container>/_ps/twins. Use this when constructing related URLs (e.g. twin content) that need to live in the same auth scope as the metadata calls.

Methods

batchAssets

• batchAssets(twinId: string, operations: AssetBatchOperation[], signal?: AbortSignal): Promise<AssetBatchResponse>

• Executes a batch of asset operations (upsert, delete, restore) atomically. All operations succeed or all are rolled back.

  @throws

  On validation failure (400).

  @throws

  On insufficient permissions (403).

  @throws

  On conflict (409) or not found (404). The error's response has per-item results with reverted statuses.

  ---

  Parameters

  • twinId: string

  • operations: AssetBatchOperation[]

    Array of batch operations (max 1000).

  • optionalsignal: AbortSignal

  Returns Promise<AssetBatchResponse>

batchGetAssets

• batchGetAssets(twinId: string, ids: string[], signal?: AbortSignal): Promise<AssetBatchGetResponse>

• Retrieves multiple assets by ID in a single request.

  @throws

  On validation failure (400).

  ---

  Parameters

  • twinId: string

  • ids: string[]

    Array of asset IDs (max 1000).

  • optionalsignal: AbortSignal

  Returns Promise<AssetBatchGetResponse>

createAssetAttachmentUploadSession

• createAssetAttachmentUploadSession(twinId: string, assetId: string, attachmentId: string, body: AttachmentPost, signal?: AbortSignal): Promise<ApiCreateUploadSessionResponse>

• Creates an upload session for a new attachment. The actual file bytes are uploaded out-of-band to ApiCreateUploadSessionResponse.uploadUrl; use uploadAssetAttachmentFile for the canonical chunked-upload flow. The attachment row is materialized server-side when the blob lands.

  @throws

  When an attachment already exists for the given id (409); retries must use a new attachmentId.

  ---

  Parameters

  • twinId: string

  • assetId: string

  • attachmentId: string

  • body: AttachmentPost

  • optionalsignal: AbortSignal

  Returns Promise<ApiCreateUploadSessionResponse>

createAssets

• createAssets(twinId: string, assets: AssetPost[], signal?: AbortSignal): Promise<AssetGet[]>

• @throws

  On invalid request body (400). The error's errorBody has structured detail.

  ---

  Parameters

  • twinId: string

  • assets: AssetPost[]

  • optionalsignal: AbortSignal

  Returns Promise<AssetGet[]>

createOrUpdateTwin

• createOrUpdateTwin(twinId: string, twin: TwinPut, signal?: AbortSignal): Promise<TwinGet>

• Creates a new twin or updates an existing one (upsert). Provide etag in the twin body to update.

  @throws

  On invalid request body (400).

  @throws

  On etag mismatch (409). The error's currentTwin contains the server's current state.

  ---

  Parameters

  • twinId: string

  • twin: TwinPut

  • optionalsignal: AbortSignal

  Returns Promise<TwinGet>

createOrUpdateTwinFile

• createOrUpdateTwinFile(twinId: string, fileId: string, twinFile: TwinFilePut, signal?: AbortSignal): Promise<TwinFileGet>

• @throws

  On invalid request body (400).

  @throws

  On etag mismatch (409). The error's currentTwinFile contains the server's current state.

  ---

  Parameters

  • twinId: string

  • fileId: string

  • twinFile: TwinFilePut

  • optionalsignal: AbortSignal

  Returns Promise<TwinFileGet>

deleteAsset

• deleteAsset(twinId: string, assetId: string, etag: string, signal?: AbortSignal): Promise<AssetGet>

• @throws

  When the asset does not exist (404).

  @throws

  On etag mismatch (409). The error's currentAsset contains the server's current state.

  ---

  Parameters

  • twinId: string

  • assetId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetGet>

deleteAssetAttachment

• deleteAssetAttachment(twinId: string, assetId: string, attachmentId: string, etag: string, signal?: AbortSignal): Promise<AttachmentGet>

• Soft-deletes an attachment.

  @throws

  On etag mismatch (409).

  @throws

  When the attachment does not exist (404).

  ---

  Parameters

  • twinId: string

  • assetId: string

  • attachmentId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AttachmentGet>

deleteAssetCategory

• deleteAssetCategory(categoryId: string, etag: string, signal?: AbortSignal): Promise<AssetCategoryGet>

• Soft-deletes a category. Inserts a new asset_category_versions row with is_deleted=true; the previous version is retained as an audit trail.

  @throws

  When the category does not exist (404).

  @throws

  On etag mismatch (409).

  ---

  Parameters

  • categoryId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetCategoryGet>

deleteAssetType

• deleteAssetType(categoryId: string, typeId: string, etag: string, signal?: AbortSignal): Promise<AssetTypeGet>

• Soft-deletes a type. Inserts a new asset_type_versions row with is_deleted=true; the previous version is retained as an audit trail.

  @throws

  When the type does not exist (404).

  @throws

  On etag mismatch (409).

  ---

  Parameters

  • categoryId: string

  • typeId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetTypeGet>

deleteTwin

• deleteTwin(twinId: string, etag: string, signal?: AbortSignal): Promise<TwinGet>

• @throws

  When the twin does not exist (404).

  @throws

  On etag mismatch (409). The error's currentTwin contains the server's current state.

  ---

  Parameters

  • twinId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<TwinGet>

deleteTwinFile

• deleteTwinFile(twinId: string, fileId: string, deleteRequest: TwinFileDelete, signal?: AbortSignal): Promise<TwinFileGet>

• @throws

  When the file does not exist (404).

  @throws

  On etag mismatch (409). The error's currentTwinFile contains the server's current state.

  @throws

  On invalid request (400).

  ---

  Parameters

  • twinId: string

  • fileId: string

  • deleteRequest: TwinFileDelete

  • optionalsignal: AbortSignal

  Returns Promise<TwinFileGet>

downloadTwinContent

• downloadTwinContent(twinId: string, twinVersion: number, content: TwinContentResponse, signal?: AbortSignal): Promise<ArrayBuffer>

• Parameters

  • twinId: string

  • twinVersion: number

  • content: TwinContentResponse

  • optionalsignal: AbortSignal

  Returns Promise<ArrayBuffer>

getAsset

• getAsset(twinId: string, assetId: string, signal?: AbortSignal): Promise<AssetGet>

• @throws

  When the asset does not exist (404).

  ---

  Parameters

  • twinId: string

  • assetId: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetGet>

getAssetAttachmentBlob

• getAssetAttachmentBlob(twinId: string, assetId: string, attachmentId: string, signal?: AbortSignal): Promise<Response>

• Downloads an attachment's blob as a Response. The caller decides whether to consume it as text, ArrayBuffer, or Blob.

  @throws

  When the attachment does not exist (404).

  ---

  Parameters

  • twinId: string

  • assetId: string

  • attachmentId: string

  • optionalsignal: AbortSignal

  Returns Promise<Response>

getAssetAttachmentUploadStatus

• getAssetAttachmentUploadStatus(twinId: string, assetId: string, token: string, signal?: AbortSignal): Promise<UploadStatusGet>

• Polls the in-memory upload-session cache for an attachment that's being uploaded.

  ---

  Parameters

  • twinId: string

  • assetId: string

  • token: string

  • optionalsignal: AbortSignal

  Returns Promise<UploadStatusGet>

getAssetCategory

• getAssetCategory(categoryId: string, signal?: AbortSignal): Promise<AssetCategoryGet>

• @throws

  When the category does not exist (404).

  ---

  Parameters

  • categoryId: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetCategoryGet>

getAssetType

• getAssetType(categoryId: string, typeId: string, signal?: AbortSignal): Promise<AssetTypeGet>

• @throws

  When the category or type does not exist (404).

  ---

  Parameters

  • categoryId: string

  • typeId: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetTypeGet>

getAssetTypeCatalog

• getAssetTypeCatalog(signal?: AbortSignal): Promise<AssetCatalogResponse>

• Returns the customer's asset-type catalog: categories nested with their latest non-deleted types and full metadata schemas inline. One round-trip is enough to populate a picker dropdown and render any per-type metadata form.

  ---

  Parameters

  • optionalsignal: AbortSignal

  Returns Promise<AssetCatalogResponse>

getAssetTypeMetaSchema

• getAssetTypeMetaSchema(signal?: AbortSignal): Promise<Record<string, unknown>>

• Returns the Twinfinity meta-schema document — the JSON Schema describing valid asset-type metadata schemas. The bytes the backend itself validates against, served verbatim. Power-user tools (Monaco-backed JSON editors, schema-aware tooling) fetch this at runtime so their in-editor diagnostics line up with what the server will accept, decoupled from the FE bundle's build time.

  ---

  Parameters

  • optionalsignal: AbortSignal

  Returns Promise<Record<string, unknown>>

getMyPermissions

• getMyPermissions(signal?: AbortSignal): Promise<MyPermissions>

• Returns the caller's named, customer-scoped capabilities against the Twin service (e.g. ViewAssetTypes, EditAssetTypes). The admin app uses this to enable or disable buttons instead of letting the user click through to a 403.

  No client-side cache — every call hits the wire. Underlying scope grants don't shift within a session, so callers are expected to memoise the result themselves (e.g. via React Query / a once-on-mount fetch) rather than calling this on every render.

  Throws TwinUnauthenticatedError on 401 (no valid auth context; caller should redirect to login). Returns an empty permissions array on 403 (authenticated but no Twin-service capabilities). Unknown capability strings should be ignored — adding a new capability is a non-breaking change.

  ---

  Parameters

  • optionalsignal: AbortSignal

  Returns Promise<MyPermissions>

getProcessorEvents

• getProcessorEvents(twinId: string, twinVersion: number, processorId: string, offset?: number, limit?: number, signal?: AbortSignal): Promise<PaginatedResponse<TwinProcessorEvent>>

• @throws

  On invalid query parameters (400).

  @throws

  When the processor does not exist for this twin version (404).

  ---

  Parameters

  • twinId: string

  • twinVersion: number

  • processorId: string

  • optionaloffset: number

  • optionallimit: number

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<TwinProcessorEvent>>

getTwin

• getTwin(twin: string | { id: string; version: number }, signal?: AbortSignal): Promise<TwinGet>

• @throws

  When the twin or version does not exist (404).

  ---

  Parameters

  • twin: string | { id: string; version: number }

    Twin ID string, or {id, version} to fetch a specific version.

  • id: string

  • version: number

  • optionalsignal: AbortSignal

  Returns Promise<TwinGet>

getTwinContent

• getTwinContent(twinId: string, signal?: AbortSignal): Promise<TwinVersionContentResponse>

• Returns content for the latest twin version.

  @throws

  When the twin does not exist (404).

  ---

  Parameters

  • twinId: string

  • optionalsignal: AbortSignal

  Returns Promise<TwinVersionContentResponse>

getTwinDiagnostics

• getTwinDiagnostics(twinId: string, signal?: AbortSignal): Promise<TwinDiagnosticsResponse>

• @throws

  When the twin does not exist (404).

  ---

  Parameters

  • twinId: string

  • optionalsignal: AbortSignal

  Returns Promise<TwinDiagnosticsResponse>

getTwinFile

• getTwinFile(twinId: string, fileId: string, signal?: AbortSignal): Promise<TwinFileGet>

• @throws

  When the file does not exist (404).

  @throws

  On invalid request (400).

  ---

  Parameters

  • twinId: string

  • fileId: string

  • optionalsignal: AbortSignal

  Returns Promise<TwinFileGet>

getTwinFileContent

• getTwinFileContent(twinId: string, fileId: string, signal?: AbortSignal): Promise<Blob>

• @throws

  When the file does not exist (404).

  ---

  Parameters

  • twinId: string

  • fileId: string

  • optionalsignal: AbortSignal

  Returns Promise<Blob>

getTwinFileVersion

• getTwinFileVersion(twinId: string, fileId: string, version: number, signal?: AbortSignal): Promise<TwinFileGet>

• @throws

  When the file or version does not exist (404).

  ---

  Parameters

  • twinId: string

  • fileId: string

  • version: number

  • optionalsignal: AbortSignal

  Returns Promise<TwinFileGet>

getTwinFileVersionContent

• getTwinFileVersionContent(twinId: string, fileId: string, version: number, signal?: AbortSignal): Promise<Blob>

• @throws

  When the file or version does not exist (404).

  ---

  Parameters

  • twinId: string

  • fileId: string

  • version: number

  • optionalsignal: AbortSignal

  Returns Promise<Blob>

getTwinVersionContent

• getTwinVersionContent(twinId: string, twinVersion: number, signal?: AbortSignal): Promise<TwinVersionContentResponse>

• @throws

  When the twin or version does not exist (404).

  ---

  Parameters

  • twinId: string

  • twinVersion: number

  • optionalsignal: AbortSignal

  Returns Promise<TwinVersionContentResponse>

getTwinVersionDiagnostics

• getTwinVersionDiagnostics(twinId: string, twinVersion: number, signal?: AbortSignal): Promise<TwinDiagnosticsResponse>

• @throws

  When the twin or version does not exist (404).

  ---

  Parameters

  • twinId: string

  • twinVersion: number

  • optionalsignal: AbortSignal

  Returns Promise<TwinDiagnosticsResponse>

getTwinVersionEvents

• getTwinVersionEvents(twinId: string, twinVersion: number, offset?: number, limit?: number, signal?: AbortSignal): Promise<PaginatedResponse<TwinProcessorEvent>>

• @throws

  On invalid query parameters (400).

  @throws

  When the twin or version does not exist (404).

  ---

  Parameters

  • twinId: string

  • twinVersion: number

  • optionaloffset: number

  • optionallimit: number

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<TwinProcessorEvent>>

listAllTwins

• listAllTwins(relatedTo?: string, signal?: AbortSignal): Promise<ListTwinItem[]>

• Fetches all twins by auto-paginating through listTwins. Caps at 1000 pages.

  ---

  Parameters

  • optionalrelatedTo: string

    Filter twins by container ID.

  • optionalsignal: AbortSignal

  Returns Promise<ListTwinItem[]>

listAssetAttachments

• listAssetAttachments(twinId: string, assetId: string, options?: { includeDeleted?: boolean; limit?: number; offset?: number; page?: string }, signal?: AbortSignal): Promise<PaginatedResponse<AttachmentGet>>

• Lists attachments for a single asset.

  ---

  Parameters

  • twinId: string

  • assetId: string

  • optionaloptions: { includeDeleted?: boolean; limit?: number; offset?: number; page?: string }

  • optionalincludeDeleted: boolean

  • optionallimit: number

  • optionaloffset: number

  • optionalpage: string

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<AttachmentGet>>

listAssetCategories

• listAssetCategories(options?: { includeDeleted?: boolean; limit?: number; page?: string }, signal?: AbortSignal): Promise<PaginatedResponse<AssetCategoryGet>>

• @throws

  On invalid query parameters (400).

  ---

  Parameters

  • optionaloptions: { includeDeleted?: boolean; limit?: number; page?: string }

  • optionalincludeDeleted: boolean

  • optionallimit: number

  • optionalpage: string

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<AssetCategoryGet>>

listAssetCategoryVersions

• listAssetCategoryVersions(categoryId: string, options?: { includeDeleted?: boolean; limit?: number; page?: string }, signal?: AbortSignal): Promise<PaginatedResponse<AssetCategoryGet>>

• Returns every version of a single asset category, newest first. Mirrors listAssetTypeVersions and twin.get_twin_versions.

  @throws

  When the category's header row does not exist (404).

  ---

  Parameters

  • categoryId: string

  • optionaloptions: { includeDeleted?: boolean; limit?: number; page?: string }

  • optionalincludeDeleted: boolean

  • optionallimit: number

  • optionalpage: string

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<AssetCategoryGet>>

listAssetTypeVersions

• listAssetTypeVersions(categoryId: string, typeId: string, options?: { includeDeleted?: boolean; limit?: number; page?: string }, signal?: AbortSignal): Promise<PaginatedResponse<AssetTypeGet>>

• Returns every version of a single asset type, newest first. Mirrors twin.get_twin_versions.

  @throws

  When the type's header row does not exist (404).

  ---

  Parameters

  • categoryId: string

  • typeId: string

  • optionaloptions: { includeDeleted?: boolean; limit?: number; page?: string }

  • optionalincludeDeleted: boolean

  • optionallimit: number

  • optionalpage: string

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<AssetTypeGet>>

listAssetTypes

• listAssetTypes(categoryId: string, options?: { includeDeleted?: boolean; limit?: number; page?: string }, signal?: AbortSignal): Promise<PaginatedResponse<AssetTypeGet>>

• @throws

  On invalid query parameters (400).

  ---

  Parameters

  • categoryId: string

  • optionaloptions: { includeDeleted?: boolean; limit?: number; page?: string }

  • optionalincludeDeleted: boolean

  • optionallimit: number

  • optionalpage: string

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<AssetTypeGet>>

listAssets

• listAssets(twinId: string, offset?: number, limit?: number, options?: { includeDeleted?: boolean }, signal?: AbortSignal): Promise<PaginatedResponse<AssetListItem>>

• @throws

  On invalid query parameters (400).

  @throws

  When the twin does not exist (404).

  ---

  Parameters

  • twinId: string

  • optionaloffset: number

  • optionallimit: number

  • optionaloptions: { includeDeleted?: boolean }

  • optionalincludeDeleted: boolean

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<AssetListItem>>

listTwinFileVersions

• listTwinFileVersions(twinId: string, fileId: string, options?: TwinFileVersionListOptions, signal?: AbortSignal): Promise<PaginatedResponse<TwinFileGet>>

• @throws

  On invalid query parameters (400).

  ---

  Parameters

  • twinId: string

  • fileId: string

  • optionaloptions: TwinFileVersionListOptions

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<TwinFileGet>>

listTwinFiles

• listTwinFiles(twinId: string, options?: TwinFileListOptions, signal?: AbortSignal): Promise<PaginatedResponse<TwinFileGet>>

• @throws

  On invalid query parameters (400).

  ---

  Parameters

  • twinId: string

  • optionaloptions: TwinFileListOptions

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<TwinFileGet>>

listTwinVersions

• listTwinVersions(id: string, options?: { includeDeleted?: boolean; limit?: number; page?: string }, signal?: AbortSignal): Promise<PaginatedResponse<ListTwinItem>>

• @throws

  On invalid query parameters (400).

  ---

  Parameters

  • id: string

  • optionaloptions: { includeDeleted?: boolean; limit?: number; page?: string }

  • optionalincludeDeleted: boolean

  • optionallimit: number

  • optionalpage: string

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<ListTwinItem>>

listTwins

• listTwins(relatedTo?: string, page?: string, limit?: number, signal?: AbortSignal): Promise<PaginatedResponse<ListTwinItem>>

• @throws

  On invalid query parameters (400).

  ---

  Parameters

  • optionalrelatedTo: string

    Filter twins by container ID.

  • optionalpage: string

  • optionallimit: number

  • optionalsignal: AbortSignal

  Returns Promise<PaginatedResponse<ListTwinItem>>

loadGeometryInfo

• loadGeometryInfo(twin: string | { id: string; version: number }, signal?: AbortSignal): Promise<TwinGeometryInfo<T8GIMeshDescriptor, T8GIStyle, T8GIRegion>>

• Downloads and deserializes geometry info (t8gi) using default types. When no version is specified, searches versions newest-first for one containing t8gi content.

  @throws

  When no version has t8gi content.

  ---

  Parameters

  • twin: string | { id: string; version: number }

    Twin ID string, or {id, version} to load a specific version.

  • id: string

  • version: number

  • optionalsignal: AbortSignal

  Returns Promise<TwinGeometryInfo<T8GIMeshDescriptor, T8GIStyle, T8GIRegion>>

loadGeometryInfoWithFactories

• loadGeometryInfoWithFactories<TMeshDescriptor, TStyle, TRegion>(twin: string | { id: string; version: number }, meshDescriptorFactory: (dto: T8GIMeshDescriptorDTO) => TMeshDescriptor, styleFactory: (dto: T8GIStyleDTO) => TStyle, regionFactory: (dto: T8GIRegionDTO) => TRegion, signal?: AbortSignal): Promise<TwinGeometryInfo<TMeshDescriptor, TStyle, TRegion>>

• Downloads and deserializes geometry info (t8gi) using custom factory functions. When no version is specified, searches versions newest-first for one containing t8gi content.

  @throws

  When no version has t8gi content.

  ---

  Type parameters

  • TMeshDescriptor
  • TStyle
  • TRegion

  Parameters

  • twin: string | { id: string; version: number }

    Twin ID string, or {id, version} to load a specific version.

  • id: string

  • version: number

  • meshDescriptorFactory: (dto: T8GIMeshDescriptorDTO) => TMeshDescriptor

  • styleFactory: (dto: T8GIStyleDTO) => TStyle

  • regionFactory: (dto: T8GIRegionDTO) => TRegion

  • optionalsignal: AbortSignal

  Returns Promise<TwinGeometryInfo<TMeshDescriptor, TStyle, TRegion>>

loadTwin

• loadTwin(twin: string | { id: string; version: number }, signal?: AbortSignal): Promise<Twin<T8Project<T8Product<T8EntityType<T8Unit>, T8Unit>, T8Unit>, T8Product<T8EntityType<T8Unit>, T8Unit>, T8EntityType<T8Unit>, T8Unit>>

• Downloads and deserializes the T8 client model (t8cm + t8cm-ext) using default types. When no version is specified, searches versions newest-first for one containing t8cm content.

  @throws

  When no version has t8cm content.

  ---

  Parameters

  • twin: string | { id: string; version: number }

    Twin ID string, or {id, version} to load a specific version.

  • id: string

  • version: number

  • optionalsignal: AbortSignal

  Returns Promise<Twin<T8Project<T8Product<T8EntityType<T8Unit>, T8Unit>, T8Unit>, T8Product<T8EntityType<T8Unit>, T8Unit>, T8EntityType<T8Unit>, T8Unit>>

loadTwinWithFactories

• loadTwinWithFactories<TProject, TProduct, TEntityType, TUnit>(twin: string | { id: string; version: number }, projectFactory: (dto: T8ClientProjectDTO<TUnit>) => TProject, productFactory: (dto: T8ClientProductDTO<TUnit>) => TProduct, entityTypeFactory: (dto: T8ClientEntityTypeDTO<TUnit>) => TEntityType, unitFactory: (dto: T8ClientUnitDTO, dataModel: T8ClientModelDTO) => TUnit, connectProject: (dto: T8ClientProjectConnectionsDTO<TProduct>, project: TProject) => void, connectProduct: (dto: T8ClientProductConnectionsDTO<TProduct, TEntityType>, product: TProduct) => void, signal?: AbortSignal): Promise<Twin<TProject, TProduct, TEntityType, TUnit>>

• Downloads and deserializes the T8 client model using custom factory functions for domain-specific types. When no version is specified, searches versions newest-first for one containing t8cm content.

  @throws

  When no version has t8cm content.

  ---

  Type parameters

  • TProject
  • TProduct
  • TEntityType
  • TUnit

  Parameters

  • twin: string | { id: string; version: number }

    Twin ID string, or {id, version} to load a specific version.

  • id: string

  • version: number

  • projectFactory: (dto: T8ClientProjectDTO<TUnit>) => TProject

  • productFactory: (dto: T8ClientProductDTO<TUnit>) => TProduct

  • entityTypeFactory: (dto: T8ClientEntityTypeDTO<TUnit>) => TEntityType

  • unitFactory: (dto: T8ClientUnitDTO, dataModel: T8ClientModelDTO) => TUnit

  • connectProject: (dto: T8ClientProjectConnectionsDTO<TProduct>, project: TProject) => void

  • connectProduct: (dto: T8ClientProductConnectionsDTO<TProduct, TEntityType>, product: TProduct) => void

  • optionalsignal: AbortSignal

  Returns Promise<Twin<TProject, TProduct, TEntityType, TUnit>>

loadTwinWithGeometry

• loadTwinWithGeometry(twin: string | { id: string; version: number }, signal?: AbortSignal): Promise<Twin<T8ProjectWithGeometry, T8ProductWithGeometry<T8EntityType<T8Unit>>, T8EntityType<T8Unit>, T8Unit>>

• Downloads and deserializes both the client model (t8cm) and geometry (t8gi/t8gd) into a combined result. When no version is specified, searches versions newest-first for one containing both t8cm and t8gi content.

  @throws

  When no version has both t8cm and t8gi content.

  ---

  Parameters

  • twin: string | { id: string; version: number }

    Twin ID string, or {id, version} to load a specific version.

  • id: string

  • version: number

  • optionalsignal: AbortSignal

  Returns Promise<Twin<T8ProjectWithGeometry, T8ProductWithGeometry<T8EntityType<T8Unit>>, T8EntityType<T8Unit>, T8Unit>>

putAssetAttachment

• putAssetAttachment(twinId: string, assetId: string, attachmentId: string, body: AssetAttachmentPut, signal?: AbortSignal): Promise<AttachmentGet>

• Updates an attachment's description / soft-delete flag. documentId is immutable — rebinding is rejected.

  @throws

  On etag mismatch (409). The error's currentAttachment carries the server's current state.

  @throws

  When the attachment does not exist (404).

  ---

  Parameters

  • twinId: string

  • assetId: string

  • attachmentId: string

  • body: AssetAttachmentPut

  • optionalsignal: AbortSignal

  Returns Promise<AttachmentGet>

putAssetCategory

• putAssetCategory(categoryId: string, body: AssetCategoryPut, signal?: AbortSignal): Promise<AssetCategoryGet>

• Upserts an asset category. Provide an empty/missing etag for first writes and the existing etag to update.

  @throws

  On invalid request body (400).

  @throws

  On etag mismatch (409). The error's currentCategory contains the server's current state.

  ---

  Parameters

  • categoryId: string

  • body: AssetCategoryPut

  • optionalsignal: AbortSignal

  Returns Promise<AssetCategoryGet>

putAssetType

• putAssetType(categoryId: string, typeId: string, body: AssetTypePut, signal?: AbortSignal): Promise<AssetTypeGet>

• Upserts an asset type. The metadata schema is validated against the Twinfinity meta-schema at the API boundary; invalid schemas surface as a 400 with cause: MetadataSchemaInvalid.

  @throws

  On invalid request body (400). The error's errorBody carries the structured cause.

  @throws

  On etag mismatch (409). The error's currentType contains the server's current state.

  ---

  Parameters

  • categoryId: string

  • typeId: string

  • body: AssetTypePut

  • optionalsignal: AbortSignal

  Returns Promise<AssetTypeGet>

restoreAsset

• restoreAsset(twinId: string, assetId: string, etag: string, signal?: AbortSignal): Promise<AssetGet>

• @throws

  When the asset does not exist (404).

  @throws

  On etag mismatch (409). The error's currentAsset contains the server's current state.

  ---

  Parameters

  • twinId: string

  • assetId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetGet>

restoreAssetAttachment

• restoreAssetAttachment(twinId: string, assetId: string, attachmentId: string, etag: string, signal?: AbortSignal): Promise<AttachmentGet>

• Restores a soft-deleted attachment.

  @throws

  On etag mismatch (409).

  @throws

  When the attachment does not exist (404).

  ---

  Parameters

  • twinId: string

  • assetId: string

  • attachmentId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AttachmentGet>

restoreAssetCategory

• restoreAssetCategory(categoryId: string, etag: string, signal?: AbortSignal): Promise<AssetCategoryGet>

• Restores a soft-deleted category. Inserts a new asset_category_versions row with is_deleted=false; mirrors twin restore.

  @throws

  When the category does not exist (404).

  @throws

  On etag mismatch (409).

  ---

  Parameters

  • categoryId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetCategoryGet>

restoreAssetType

• restoreAssetType(categoryId: string, typeId: string, etag: string, signal?: AbortSignal): Promise<AssetTypeGet>

• Restores a soft-deleted type. Inserts a new asset_type_versions row with is_deleted=false; mirrors twin restore.

  @throws

  When the type does not exist (404).

  @throws

  On etag mismatch (409).

  ---

  Parameters

  • categoryId: string

  • typeId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<AssetTypeGet>

restoreTwin

• restoreTwin(twinId: string, etag: string, signal?: AbortSignal): Promise<TwinGet>

• @throws

  When the twin does not exist (404).

  @throws

  On etag mismatch (409). The error's currentTwin contains the server's current state.

  ---

  Parameters

  • twinId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<TwinGet>

restoreTwinFile

• restoreTwinFile(twinId: string, fileId: string, etag: string, signal?: AbortSignal): Promise<TwinFileGet>

• @throws

  When the file does not exist (404).

  @throws

  On etag mismatch (409). The error's currentTwinFile contains the server's current state.

  @throws

  On invalid request (400).

  ---

  Parameters

  • twinId: string

  • fileId: string

  • etag: string

  • optionalsignal: AbortSignal

  Returns Promise<TwinFileGet>

updateAsset

• updateAsset(twinId: string, assetId: string, asset: AssetPut, signal?: AbortSignal): Promise<AssetGet>

• @throws

  On invalid request body (400). The error's errorBody has structured detail.

  @throws

  On etag mismatch (409). The error's currentAsset contains the server's current state.

  ---

  Parameters

  • twinId: string

  • assetId: string

  • asset: AssetPut

  • optionalsignal: AbortSignal

  Returns Promise<AssetGet>

updateTwin

• updateTwin(twinId: string, twin: TwinPut, signal?: AbortSignal): Promise<TwinGet>

• Alias for createOrUpdateTwin.

  ---

  Parameters

  • twinId: string

  • twin: TwinPut

  • optionalsignal: AbortSignal

  Returns Promise<TwinGet>

uploadAssetAttachmentFile

• uploadAssetAttachmentFile(session: ApiCreateUploadSessionResponse, file: Blob, signal?: AbortSignal): Promise<{ token: string }>

• Uploads a File / Blob to an existing upload session in one or more chunks, then resolves the upload token so the caller can poll getAssetAttachmentUploadStatus.

  ---

  Parameters

  • session: ApiCreateUploadSessionResponse

  • file: Blob

  • optionalsignal: AbortSignal

  Returns Promise<{ token: string }>