TwinClient

Implements

ITwinClient

Index

Constructors

constructor

new TwinClient(baseUrl: string | URL, _httpClient: TwinfinityHttpClient): TwinClient

Parameters
- baseUrl: string | URL
- _httpClient: TwinfinityHttpClient
Returns TwinClient

Accessors

baseUrl

get baseUrl(): string

Implementation of ITwinClient.baseUrl
Rooted twins base URL — typically <host>/sites/<container>/_ps/twins. Exposed so callers that want to build content URLs in the same auth scope as the metadata calls can derive them from here. The bare <host>/_ps/twins/... variant is not necessarily an authorized route on all deployments.
Returns string

Methods

batchAssets

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

Implementation of ITwinClient.batchAssets
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>

Implementation of ITwinClient.batchGetAssets
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>

Implementation of ITwinClient.createAssetAttachmentUploadSession
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[]>

Implementation of ITwinClient.createAssets
@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>

Implementation of ITwinClient.createOrUpdateTwin
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>

Implementation of ITwinClient.createOrUpdateTwinFile
@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>

createOrUpdateTwinFileRaw

createOrUpdateTwinFileRaw(twinId: string, fileId: string, twinFile: unknown, signal?: AbortSignal): Promise<Response>

Parameters
- twinId: string
- fileId: string
- twinFile: unknown
- optionalsignal: AbortSignal
Returns Promise<Response>

createOrUpdateTwinRaw

createOrUpdateTwinRaw(twinId: string, twin: unknown, signal?: AbortSignal): Promise<Response>

Parameters
- twinId: string
- twin: unknown
- optionalsignal: AbortSignal
Returns Promise<Response>

deleteAsset

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

Implementation of ITwinClient.deleteAsset
@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>

Implementation of ITwinClient.deleteAssetAttachment
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>

Implementation of ITwinClient.deleteAssetCategory
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>

Implementation of ITwinClient.deleteAssetType
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>

Implementation of ITwinClient.deleteTwin
@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>

Implementation of ITwinClient.deleteTwinFile
@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>

Implementation of ITwinClient.downloadTwinContent
Parameters
- twinId: string
- twinVersion: number
- content: TwinContentResponse
- optionalsignal: AbortSignal
Returns Promise<ArrayBuffer>

getAsset

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

Implementation of ITwinClient.getAsset
@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>

Implementation of ITwinClient.getAssetAttachmentBlob
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>

Implementation of ITwinClient.getAssetAttachmentUploadStatus
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>

Implementation of ITwinClient.getAssetCategory
@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>

Implementation of ITwinClient.getAssetType
@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>

Implementation of ITwinClient.getAssetTypeCatalog
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>>

Implementation of ITwinClient.getAssetTypeMetaSchema
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>

Implementation of ITwinClient.getMyPermissions
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>>

Implementation of ITwinClient.getProcessorEvents
@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
- offset: number = 0
- limit: number = 100
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<TwinProcessorEvent>>

getTwin

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

Implementation of ITwinClient.getTwin
@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.
- optionalsignal: AbortSignal
Returns Promise<TwinGet>

getTwinContent

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

Implementation of ITwinClient.getTwinContent
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>

Implementation of ITwinClient.getTwinDiagnostics
@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>

Implementation of ITwinClient.getTwinFile
@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>

Implementation of ITwinClient.getTwinFileContent
@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>

Implementation of ITwinClient.getTwinFileVersion
@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>

Implementation of ITwinClient.getTwinFileVersionContent
@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>

Implementation of ITwinClient.getTwinVersionContent
@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>

Implementation of ITwinClient.getTwinVersionDiagnostics
@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>>

Implementation of ITwinClient.getTwinVersionEvents
@throws
On invalid query parameters (400).
@throws
When the twin or version does not exist (404).
Parameters
- twinId: string
- twinVersion: number
- offset: number = 0
- limit: number = 100
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<TwinProcessorEvent>>

listAllTwins

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

Implementation of ITwinClient.listAllTwins
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>>

Implementation of ITwinClient.listAssetAttachments
Lists attachments for a single asset.
Parameters
- twinId: string
- assetId: string
- optionaloptions: { includeDeleted?: boolean; limit?: number; offset?: number; page?: string }
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<AttachmentGet>>

listAssetCategories

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

Implementation of ITwinClient.listAssetCategories
@throws
On invalid query parameters (400).
Parameters
- optionaloptions: { includeDeleted?: boolean; limit?: number; page?: string }
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<AssetCategoryGet>>

listAssetCategoryVersions

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

Implementation of ITwinClient.listAssetCategoryVersions
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 }
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<AssetCategoryGet>>

listAssetTypeVersions

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

Implementation of ITwinClient.listAssetTypeVersions
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 }
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<AssetTypeGet>>

listAssetTypes

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

Implementation of ITwinClient.listAssetTypes
@throws
On invalid query parameters (400).
Parameters
- categoryId: string
- optionaloptions: { includeDeleted?: boolean; limit?: number; page?: string }
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<AssetTypeGet>>

listAssets

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

Implementation of ITwinClient.listAssets
@throws
On invalid query parameters (400).
@throws
When the twin does not exist (404).
Parameters
- twinId: string
- offset: number = 0
- limit: number = 100
- optionaloptions: { includeDeleted?: boolean }
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<AssetListItem>>

listTwinFileVersions

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

Implementation of ITwinClient.listTwinFileVersions
@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>>

Implementation of ITwinClient.listTwinFiles
@throws
On invalid query parameters (400).
Parameters
- twinId: string
- options: TwinFileListOptions = {}
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<TwinFileGet>>

listTwinVersions

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

Implementation of ITwinClient.listTwinVersions
@throws
On invalid query parameters (400).
Parameters
- id: string
- optionaloptions: { includeDeleted?: boolean; limit?: number; page: undefined | string }
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<ListTwinItem>>

listTwins

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

Implementation of ITwinClient.listTwins
@throws
On invalid query parameters (400).
Parameters
- optionalrelatedTo: string
  Filter twins by container ID.
- page: undefined | string = undefined
- limit: number = 100
- optionalsignal: AbortSignal
Returns Promise<PaginatedResponse<ListTwinItem>>

loadGeometryInfo

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

Implementation of ITwinClient.loadGeometryInfo
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.
- 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>>

Implementation of ITwinClient.loadGeometryInfoWithFactories
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.
- 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>>

Implementation of ITwinClient.loadTwin
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.
- 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>>

Implementation of ITwinClient.loadTwinWithFactories
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.
- 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>>

Implementation of ITwinClient.loadTwinWithGeometry
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.
- 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>

Implementation of ITwinClient.putAssetAttachment
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>

Implementation of ITwinClient.putAssetCategory
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>

Implementation of ITwinClient.putAssetType
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): Promise<AssetGet>

Implementation of ITwinClient.restoreAsset
@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
Returns Promise<AssetGet>

restoreAssetAttachment

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

Implementation of ITwinClient.restoreAssetAttachment
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>

Implementation of ITwinClient.restoreAssetCategory
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>

Implementation of ITwinClient.restoreAssetType
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>

Implementation of ITwinClient.restoreTwin
@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>

Implementation of ITwinClient.restoreTwinFile
@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>

Implementation of ITwinClient.updateAsset
@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>

Implementation of ITwinClient.updateTwin
Alias for createOrUpdateTwin.
Parameters
- twinId: string
- twin: TwinPut
- optionalsignal: AbortSignal
Returns Promise<TwinGet>

uploadAssetAttachmentFile

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

Implementation of ITwinClient.uploadAssetAttachmentFile
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 }>

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

baseUrl: string | URL

_httpClient: TwinfinityHttpClient

Returns TwinClient

Accessors

baseUrl

Returns string

Methods

batchAssets

Parameters

twinId: string

operations: AssetBatchOperation[]

optionalsignal: AbortSignal

Returns Promise<AssetBatchResponse>

batchGetAssets

Parameters

twinId: string

ids: string[]

optionalsignal: AbortSignal

Returns Promise<AssetBatchGetResponse>

createAssetAttachmentUploadSession

Parameters

twinId: string

assetId: string

attachmentId: string

body: AttachmentPost

optionalsignal: AbortSignal

Returns Promise<ApiCreateUploadSessionResponse>

createAssets

Parameters

twinId: string

assets: AssetPost[]

optionalsignal: AbortSignal

Returns Promise<AssetGet[]>

createOrUpdateTwin

Parameters

twinId: string

twin: TwinPut

optionalsignal: AbortSignal

Returns Promise<TwinGet>

createOrUpdateTwinFile

Parameters

twinId: string

fileId: string

twinFile: TwinFilePut

optionalsignal: AbortSignal

Returns Promise<TwinFileGet>

createOrUpdateTwinFileRaw

Parameters

twinId: string

fileId: string

twinFile: unknown

optionalsignal: AbortSignal

Returns Promise<Response>

createOrUpdateTwinRaw

Parameters

twinId: string

twin: unknown

optionalsignal: AbortSignal

Returns Promise<Response>

deleteAsset

Parameters

twinId: string

assetId: string

etag: string

optionalsignal: AbortSignal

Returns Promise<AssetGet>

deleteAssetAttachment

Parameters

twinId: string

assetId: string

attachmentId: string

etag: string