@twinfinity/twin 6.1.0 → 6.1.2-ci.30738
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -2
- package/dist/BuildInfo.js +3 -3
- package/dist/TwinClient.d.ts +312 -9
- package/dist/TwinClient.d.ts.map +1 -1
- package/dist/TwinClient.js +321 -6
- package/dist/TwinClient.js.map +1 -1
- package/dist/errors.d.ts +120 -5
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +116 -2
- package/dist/errors.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/types/generated.d.ts +93 -31
- package/dist/types/generated.d.ts.map +1 -1
- package/dist/types/twin-api.d.ts +54 -1
- package/dist/types/twin-api.d.ts.map +1 -1
- package/dist/types/twin-permissions-api.d.ts +226 -6
- package/dist/types/twin-permissions-api.d.ts.map +1 -1
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/AssetAttachmentConflictError.html +1 -1
- package/docs/classes/AssetAttachmentNotFoundError.html +1 -1
- package/docs/classes/AssetBatchError.html +1 -1
- package/docs/classes/AssetCatalogTooLargeError.html +1 -1
- package/docs/classes/AssetCategoryConflictError.html +1 -1
- package/docs/classes/AssetCategoryForbiddenError.html +1 -1
- package/docs/classes/AssetCategoryNotFoundError.html +1 -1
- package/docs/classes/AssetCategoryValidationError.html +1 -1
- package/docs/classes/AssetConflictError.html +1 -1
- package/docs/classes/AssetForbiddenError.html +1 -1
- package/docs/classes/AssetNotFoundError.html +1 -1
- package/docs/classes/AssetPermissionsConflictError.html +16 -0
- package/docs/classes/AssetTypeConflictError.html +1 -1
- package/docs/classes/AssetTypeForbiddenError.html +1 -1
- package/docs/classes/AssetTypeNotFoundError.html +1 -1
- package/docs/classes/AssetTypeValidationError.html +1 -1
- package/docs/classes/AssetValidationError.html +1 -1
- package/docs/classes/ProcessorNotFoundError.html +1 -1
- package/docs/classes/TwinClient.html +251 -73
- package/docs/classes/TwinConflictError.html +1 -1
- package/docs/classes/TwinFileConflictError.html +1 -1
- package/docs/classes/TwinFileNotFoundError.html +1 -1
- package/docs/classes/TwinFileValidationError.html +1 -1
- package/docs/classes/TwinNotFoundError.html +4 -2
- package/docs/classes/TwinPermissionsConflictError.html +19 -0
- package/docs/classes/TwinPermissionsForbiddenError.html +12 -0
- package/docs/classes/TwinPrincipalNotFoundError.html +5 -0
- package/docs/classes/TwinTemporarilyUnavailableError.html +10 -0
- package/docs/classes/TwinUnauthenticatedError.html +1 -1
- package/docs/classes/TwinValidationError.html +1 -1
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +56 -4
- package/docs/interfaces/AssetCatalogTooLargeErrorBody.html +2 -2
- package/docs/interfaces/AssetGroupGet.html +9 -0
- package/docs/interfaces/AssetGroupsGet.html +3 -0
- package/docs/interfaces/AssetPermissionsConflictErrorBody.html +12 -0
- package/docs/interfaces/AssetPermissionsPut.html +9 -0
- package/docs/interfaces/AssetPrincipalPermissionsGet.html +23 -0
- package/docs/interfaces/Coordinates.html +6 -0
- package/docs/interfaces/EntityCollection.html +7 -2
- package/docs/interfaces/EntityRepresentation.html +12 -0
- package/docs/interfaces/Facility.html +8 -3
- package/docs/interfaces/FacilityPart.html +5 -3
- package/docs/interfaces/ITwinClient.html +251 -73
- package/docs/interfaces/InheritedPermissions.html +8 -0
- package/docs/interfaces/ListTwinItem.html +18 -2
- package/docs/interfaces/Location.html +4 -1
- package/docs/interfaces/MyPermissions.html +2 -2
- package/docs/interfaces/MyTwinPermissions.html +5 -0
- package/docs/interfaces/Site.html +11 -4
- package/docs/interfaces/Space.html +6 -3
- package/docs/interfaces/TwinErrorBody.html +2 -2
- package/docs/interfaces/TwinGet.html +29 -11
- package/docs/interfaces/TwinGroupGet.html +10 -0
- package/docs/interfaces/TwinGroupsGet.html +3 -0
- package/docs/interfaces/TwinPermissionsConflictErrorBody.html +8 -0
- package/docs/interfaces/TwinPermissionsPut.html +11 -0
- package/docs/interfaces/TwinPrincipalPermissionsGet.html +34 -0
- package/docs/interfaces/TwinPut.html +8 -10
- package/docs/interfaces/TwinReference.html +4 -0
- package/docs/interfaces/TwinSpecification.html +7 -9
- package/docs/media/twin-management.md +197 -0
- package/docs/modules.html +1 -1
- package/docs/types/TwinBoundCapabilityName.html +8 -0
- package/docs/types/TwinCapability.html +11 -5
- package/docs/types/TwinCapabilityName.html +8 -0
- package/docs/types/TwinErrorCause.html +1 -1
- package/docs/types/TwinErrorItemKind.html +1 -1
- package/docs/types/TwinPermissionsConflictCause.html +6 -0
- package/docs/types/TwinScopedCapability.html +9 -0
- package/docs/types/TwinScopedCapabilityName.html +8 -0
- package/package.json +3 -3
- package/src/TwinClient.ts +776 -15
- package/src/errors.ts +191 -4
- package/src/types/generated.ts +93 -33
- package/src/types/twin-api.ts +55 -1
- package/src/types/twin-permissions-api.ts +243 -6
|
@@ -11,18 +11,22 @@
|
|
|
11
11
|
<a href="#deleteasset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset</span></a>
|
|
12
12
|
<a href="#deleteassetattachment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Attachment</span></a>
|
|
13
13
|
<a href="#deleteassetcategory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Category</span></a>
|
|
14
|
+
<a href="#deleteassetpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Permissions</span></a>
|
|
14
15
|
<a href="#deleteassettype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Type</span></a>
|
|
15
16
|
<a href="#deletetwin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin</span></a>
|
|
16
17
|
<a href="#deletetwinfile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin<wbr/>File</span></a>
|
|
18
|
+
<a href="#deletetwinpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin<wbr/>Permissions</span></a>
|
|
17
19
|
<a href="#downloadtwincontent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Twin<wbr/>Content</span></a>
|
|
18
20
|
<a href="#getasset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a>
|
|
19
21
|
<a href="#getassetattachmentblob" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Blob</span></a>
|
|
20
22
|
<a href="#getassetattachmentuploadstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Upload<wbr/>Status</span></a>
|
|
21
23
|
<a href="#getassetcategory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Category</span></a>
|
|
24
|
+
<a href="#getassetgroup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Group</span></a>
|
|
22
25
|
<a href="#getassettype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type</span></a>
|
|
23
26
|
<a href="#getassettypecatalog" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type<wbr/>Catalog</span></a>
|
|
24
27
|
<a href="#getassettypemetaschema" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type<wbr/>Meta<wbr/>Schema</span></a>
|
|
25
28
|
<a href="#getmypermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>My<wbr/>Permissions</span></a>
|
|
29
|
+
<a href="#getmytwinpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>My<wbr/>Twin<wbr/>Permissions</span></a>
|
|
26
30
|
<a href="#getprocessorevents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Processor<wbr/>Events</span></a>
|
|
27
31
|
<a href="#gettwin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin</span></a>
|
|
28
32
|
<a href="#gettwincontent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Content</span></a>
|
|
@@ -31,18 +35,25 @@
|
|
|
31
35
|
<a href="#gettwinfilecontent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Content</span></a>
|
|
32
36
|
<a href="#gettwinfileversion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Version</span></a>
|
|
33
37
|
<a href="#gettwinfileversioncontent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Version<wbr/>Content</span></a>
|
|
38
|
+
<a href="#gettwingroup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Group</span></a>
|
|
34
39
|
<a href="#gettwinversioncontent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Content</span></a>
|
|
35
40
|
<a href="#gettwinversiondiagnostics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Diagnostics</span></a>
|
|
36
41
|
<a href="#gettwinversionevents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Events</span></a>
|
|
42
|
+
<a href="#listallassetpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>All<wbr/>Asset<wbr/>Permissions</span></a>
|
|
43
|
+
<a href="#listalltwinpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>All<wbr/>Twin<wbr/>Permissions</span></a>
|
|
37
44
|
<a href="#listalltwins" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>All<wbr/>Twins</span></a>
|
|
38
45
|
<a href="#listassetattachments" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Attachments</span></a>
|
|
39
46
|
<a href="#listassetcategories" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Categories</span></a>
|
|
40
47
|
<a href="#listassetcategoryversions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Category<wbr/>Versions</span></a>
|
|
48
|
+
<a href="#listassetgroups" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Groups</span></a>
|
|
49
|
+
<a href="#listassetpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Permissions</span></a>
|
|
41
50
|
<a href="#listassets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Assets</span></a>
|
|
42
51
|
<a href="#listassettypes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Types</span></a>
|
|
43
52
|
<a href="#listassettypeversions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Type<wbr/>Versions</span></a>
|
|
44
53
|
<a href="#listtwinfiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Files</span></a>
|
|
45
54
|
<a href="#listtwinfileversions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>File<wbr/>Versions</span></a>
|
|
55
|
+
<a href="#listtwingroups" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Groups</span></a>
|
|
56
|
+
<a href="#listtwinpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Permissions</span></a>
|
|
46
57
|
<a href="#listtwins" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twins</span></a>
|
|
47
58
|
<a href="#listtwinversions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Versions</span></a>
|
|
48
59
|
<a href="#loadgeometryinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Geometry<wbr/>Info</span></a>
|
|
@@ -59,6 +70,8 @@
|
|
|
59
70
|
<a href="#restoreassettype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset<wbr/>Type</span></a>
|
|
60
71
|
<a href="#restoretwin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Twin</span></a>
|
|
61
72
|
<a href="#restoretwinfile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Twin<wbr/>File</span></a>
|
|
73
|
+
<a href="#setassetpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Asset<wbr/>Permissions</span></a>
|
|
74
|
+
<a href="#settwinpermissions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Twin<wbr/>Permissions</span></a>
|
|
62
75
|
<a href="#updateasset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Asset</span></a>
|
|
63
76
|
<a href="#updatetwin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Twin</span></a>
|
|
64
77
|
<a href="#uploadassetattachmentfile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>upload<wbr/>Asset<wbr/>Attachment<wbr/>File</span></a>
|
|
@@ -70,9 +83,12 @@ on all deployments.</p>
|
|
|
70
83
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#baseurl">baseUrl</a></p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="batchassets"><span>batch<wbr/>Assets</span><a href="#batchassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="batchassets-1"><span class="tsd-kind-call-signature">batchAssets</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">operations</span><span class="tsd-signature-symbol">:</span> <a href="../types/AssetBatchOperation.html" class="tsd-signature-type tsd-kind-type-alias">AssetBatchOperation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetBatchResponse.html" class="tsd-signature-type tsd-kind-interface">AssetBatchResponse</a><span class="tsd-signature-symbol">></span><a href="#batchassets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Executes a batch of asset operations (upsert, delete, restore) atomically.
|
|
71
84
|
All operations succeed or all are rolled back.</p>
|
|
72
85
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">operations</span>: <a href="../types/AssetBatchOperation.html" class="tsd-signature-type tsd-kind-type-alias">AssetBatchOperation</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Array of batch operations (max 1000).</p>
|
|
73
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetBatchResponse.html" class="tsd-signature-type tsd-kind-interface">AssetBatchResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>
|
|
74
|
-
|
|
75
|
-
|
|
86
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetBatchResponse.html" class="tsd-signature-type tsd-kind-interface">AssetBatchResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the batch rolled back. The error's <code>response</code> has per-item
|
|
87
|
+
results with reverted statuses, and is thrown for any status the failing item carried --
|
|
88
|
+
400, 404 or 409.</p>
|
|
89
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the whole request was rejected before any item ran (400):
|
|
90
|
+
an empty batch, duplicate ids, a body/URL twin mismatch, oversized metadata.</p>
|
|
91
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On insufficient permissions (403).</p>
|
|
76
92
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#batchassets">batchAssets</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="batchgetassets"><span>batch<wbr/>Get<wbr/>Assets</span><a href="#batchgetassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="batchgetassets-1"><span class="tsd-kind-call-signature">batchGetAssets</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetBatchGetResponse.html" class="tsd-signature-type tsd-kind-interface">AssetBatchGetResponse</a><span class="tsd-signature-symbol">></span><a href="#batchgetassets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves multiple assets by ID in a single request.</p>
|
|
77
93
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">ids</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Array of asset IDs (max 1000).</p>
|
|
78
94
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetBatchGetResponse.html" class="tsd-signature-type tsd-kind-interface">AssetBatchGetResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On validation failure (400).</p>
|
|
@@ -97,22 +113,61 @@ for the given id (409); retries must use a new attachmentId.</p>
|
|
|
97
113
|
<code>is_deleted=true</code>; the previous version is retained as an audit trail.</p>
|
|
98
114
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-14">Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the category does not exist (404).</p>
|
|
99
115
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-15">Throws<a href="#throws-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409).</p>
|
|
100
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deleteassetcategory">deleteAssetCategory</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
116
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deleteassetcategory">deleteAssetCategory</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteassetpermissions"><span>delete<wbr/>Asset<wbr/>Permissions</span><a href="#deleteassetpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleteassetpermissions-1"><span class="tsd-kind-call-signature">deleteAssetPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">principalId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><a href="#deleteassetpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the principal from the domain's access control list entirely, answering with it and
|
|
117
|
+
an empty capability list.</p>
|
|
118
|
+
<p>The answer carries the <code>etag</code> the revocation wrote: it belongs to the domain, not to the
|
|
119
|
+
principal, so a revoked principal having no listing entry does not cost the caller one. Chain
|
|
120
|
+
the next write on it exactly as with <a href="../interfaces/ITwinClient.html#setassetpermissions" class="tsd-kind-method">setAssetPermissions</a>, without re-reading
|
|
121
|
+
<a href="../interfaces/ITwinClient.html#listassetpermissions" class="tsd-kind-method">listAssetPermissions</a>.</p>
|
|
122
|
+
<p>The etag is always required — a revocation always replaces existing grants — and a request
|
|
123
|
+
naming none is refused with a <code>400</code> rather than a conflict, before anything else is asked.</p>
|
|
124
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">principalId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-16">Throws<a href="#throws-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No group in the tenant carries this id, or it holds
|
|
125
|
+
nothing here for a revocation to remove (404).</p>
|
|
126
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-17">Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>SystemPrincipalImmutable</code> or <code>EtagRequired</code> (400).</p>
|
|
127
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-18">Throws<a href="#throws-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>EtagMismatch</code> (409).</p>
|
|
128
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-19">Throws<a href="#throws-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The caller does not hold <code>ManageAssetPermissions</code>
|
|
129
|
+
(403).</p>
|
|
130
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-20">Throws<a href="#throws-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No valid auth context (401).</p>
|
|
131
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-21">Throws<a href="#throws-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
132
|
+
safe to retry unchanged.</p>
|
|
133
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deleteassetpermissions">deleteAssetPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteassettype"><span>delete<wbr/>Asset<wbr/>Type</span><a href="#deleteassettype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleteassettype-1"><span class="tsd-kind-call-signature">deleteAssetType</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">typeId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><a href="#deleteassettype-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Soft-deletes a type. Inserts a new asset_type_versions row with
|
|
101
134
|
<code>is_deleted=true</code>; the previous version is retained as an audit trail.</p>
|
|
102
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
103
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
104
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deleteassettype">deleteAssetType</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletetwin"><span>delete<wbr/>Twin</span><a href="#deletetwin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deletetwin-1"><span class="tsd-kind-call-signature">deleteTwin</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span><a href="#deletetwin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
105
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
106
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deletetwin">deleteTwin</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletetwinfile"><span>delete<wbr/>Twin<wbr/>File</span><a href="#deletetwinfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deletetwinfile-1"><span class="tsd-kind-call-signature">deleteTwinFile</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">deleteRequest</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TwinFileDelete.html" class="tsd-signature-type tsd-kind-interface">TwinFileDelete</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#deletetwinfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">deleteRequest</span>: <a href="../interfaces/TwinFileDelete.html" class="tsd-signature-type tsd-kind-interface">TwinFileDelete</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
107
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
108
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
109
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deletetwinfile">deleteTwinFile</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
135
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-22">Throws<a href="#throws-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the type does not exist (404).</p>
|
|
136
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-23">Throws<a href="#throws-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409).</p>
|
|
137
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deleteassettype">deleteAssetType</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletetwin"><span>delete<wbr/>Twin</span><a href="#deletetwin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deletetwin-1"><span class="tsd-kind-call-signature">deleteTwin</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span><a href="#deletetwin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-24">Throws<a href="#throws-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin does not exist (404).</p>
|
|
138
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-25">Throws<a href="#throws-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentTwin</code> contains the server's current state.</p>
|
|
139
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deletetwin">deleteTwin</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletetwinfile"><span>delete<wbr/>Twin<wbr/>File</span><a href="#deletetwinfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deletetwinfile-1"><span class="tsd-kind-call-signature">deleteTwinFile</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">deleteRequest</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TwinFileDelete.html" class="tsd-signature-type tsd-kind-interface">TwinFileDelete</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#deletetwinfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">deleteRequest</span>: <a href="../interfaces/TwinFileDelete.html" class="tsd-signature-type tsd-kind-interface">TwinFileDelete</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-26">Throws<a href="#throws-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the file does not exist (404).</p>
|
|
140
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-27">Throws<a href="#throws-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentTwinFile</code> contains the server's current state.</p>
|
|
141
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-28">Throws<a href="#throws-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid request (400).</p>
|
|
142
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deletetwinfile">deleteTwinFile</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletetwinpermissions"><span>delete<wbr/>Twin<wbr/>Permissions</span><a href="#deletetwinpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deletetwinpermissions-1"><span class="tsd-kind-call-signature">deleteTwinPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">principalId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><a href="#deletetwinpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the principal from the twin's access control list entirely — including any
|
|
143
|
+
bits outside this capability vocabulary, which is what separates it from a
|
|
144
|
+
<a href="../interfaces/ITwinClient.html#settwinpermissions" class="tsd-kind-method">setTwinPermissions</a> call with an empty list.</p>
|
|
145
|
+
<p>The etag is always required: a delete always replaces existing grants.</p>
|
|
146
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">principalId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-29">Throws<a href="#throws-29" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The principal holds nothing on the twin, so there is
|
|
147
|
+
nothing to revoke and no entry to have read an etag from — whatever value was sent (404).</p>
|
|
148
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-30">Throws<a href="#throws-30" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The principal is immutable through this surface (400), decided
|
|
149
|
+
before the etag is looked at.</p>
|
|
150
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-31">Throws<a href="#throws-31" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The twin does not exist or the caller cannot see it (404).</p>
|
|
151
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-32">Throws<a href="#throws-32" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>ManageTwinPermissions</code> is required (403).</p>
|
|
152
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-33">Throws<a href="#throws-33" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>EtagMismatch</code> or <code>ScopesNotProvisioned</code> (409).</p>
|
|
153
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-34">Throws<a href="#throws-34" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
154
|
+
safe to retry unchanged.</p>
|
|
155
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#deletetwinpermissions">deleteTwinPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="downloadtwincontent"><span>download<wbr/>Twin<wbr/>Content</span><a href="#downloadtwincontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="downloadtwincontent-1"><span class="tsd-kind-call-signature">downloadTwinContent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">twinVersion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">content</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TwinContentResponse.html" class="tsd-signature-type tsd-kind-interface">TwinContentResponse</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span><a href="#downloadtwincontent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">twinVersion</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">content</span>: <a href="../interfaces/TwinContentResponse.html" class="tsd-signature-type tsd-kind-interface">TwinContentResponse</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#downloadtwincontent">downloadTwinContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getasset"><span>get<wbr/>Asset</span><a href="#getasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getasset-1"><span class="tsd-kind-call-signature">getAsset</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span><a href="#getasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-35">Throws<a href="#throws-35" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the asset does not exist (404).</p>
|
|
110
156
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getasset">getAsset</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassetattachmentblob"><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Blob</span><a href="#getassetattachmentblob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getassetattachmentblob-1"><span class="tsd-kind-call-signature">getAssetAttachmentBlob</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">attachmentId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><a href="#getassetattachmentblob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads an attachment's blob as a <code>Response</code>. The caller decides
|
|
111
157
|
whether to consume it as text, ArrayBuffer, or Blob.</p>
|
|
112
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">attachmentId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
158
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">attachmentId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-36">Throws<a href="#throws-36" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the attachment does not exist (404).</p>
|
|
113
159
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassetattachmentblob">getAssetAttachmentBlob</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassetattachmentuploadstatus"><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Upload<wbr/>Status</span><a href="#getassetattachmentuploadstatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getassetattachmentuploadstatus-1"><span class="tsd-kind-call-signature">getAssetAttachmentUploadStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UploadStatusGet.html" class="tsd-signature-type tsd-kind-interface">UploadStatusGet</a><span class="tsd-signature-symbol">></span><a href="#getassetattachmentuploadstatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Polls the in-memory upload-session cache for an attachment that's being uploaded.</p>
|
|
114
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UploadStatusGet.html" class="tsd-signature-type tsd-kind-interface">UploadStatusGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassetattachmentuploadstatus">getAssetAttachmentUploadStatus</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassetcategory"><span>get<wbr/>Asset<wbr/>Category</span><a href="#getassetcategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getassetcategory-1"><span class="tsd-kind-call-signature">getAssetCategory</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><a href="#getassetcategory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
115
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassetcategory">getAssetCategory</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
160
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UploadStatusGet.html" class="tsd-signature-type tsd-kind-interface">UploadStatusGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassetattachmentuploadstatus">getAssetAttachmentUploadStatus</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassetcategory"><span>get<wbr/>Asset<wbr/>Category</span><a href="#getassetcategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getassetcategory-1"><span class="tsd-kind-call-signature">getAssetCategory</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><a href="#getassetcategory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-37">Throws<a href="#throws-37" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the category does not exist (404).</p>
|
|
161
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassetcategory">getAssetCategory</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassetgroup"><span>get<wbr/>Asset<wbr/>Group</span><a href="#getassetgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getassetgroup-1"><span class="tsd-kind-call-signature">getAssetGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGroupGet.html" class="tsd-signature-type tsd-kind-interface">AssetGroupGet</a><span class="tsd-signature-symbol">></span><a href="#getassetgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns one default group by its stable name, case-insensitively.</p>
|
|
162
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGroupGet.html" class="tsd-signature-type tsd-kind-interface">AssetGroupGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-38">Throws<a href="#throws-38" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The name is one of the three but its group has not been
|
|
163
|
+
seeded for this customer yet — safe to retry (404).</p>
|
|
164
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-39">Throws<a href="#throws-39" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The name is not one of the three; retrying will not help (404).</p>
|
|
165
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-40">Throws<a href="#throws-40" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The caller does not hold <code>ManageAssetPermissions</code>
|
|
166
|
+
(403).</p>
|
|
167
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-41">Throws<a href="#throws-41" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No valid auth context (401).</p>
|
|
168
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-42">Throws<a href="#throws-42" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The title could not be resolved (503); safe to
|
|
169
|
+
retry unchanged.</p>
|
|
170
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassetgroup">getAssetGroup</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassettype"><span>get<wbr/>Asset<wbr/>Type</span><a href="#getassettype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getassettype-1"><span class="tsd-kind-call-signature">getAssetType</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">typeId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><a href="#getassettype-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-43">Throws<a href="#throws-43" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the category or type does not exist (404).</p>
|
|
116
171
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassettype">getAssetType</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassettypecatalog"><span>get<wbr/>Asset<wbr/>Type<wbr/>Catalog</span><a href="#getassettypecatalog" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getassettypecatalog-1"><span class="tsd-kind-call-signature">getAssetTypeCatalog</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCatalogResponse.html" class="tsd-signature-type tsd-kind-interface">AssetCatalogResponse</a><span class="tsd-signature-symbol">></span><a href="#getassettypecatalog-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the customer's asset-type catalog: categories nested with
|
|
117
172
|
their latest non-deleted types and full metadata schemas inline. One
|
|
118
173
|
round-trip is enough to populate a picker dropdown and render any
|
|
@@ -124,9 +179,10 @@ JSON editors, schema-aware tooling) fetch this at runtime so their
|
|
|
124
179
|
in-editor diagnostics line up with what the server will accept,
|
|
125
180
|
decoupled from the FE bundle's build time.</p>
|
|
126
181
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getassettypemetaschema">getAssetTypeMetaSchema</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmypermissions"><span>get<wbr/>My<wbr/>Permissions</span><a href="#getmypermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getmypermissions-1"><span class="tsd-kind-call-signature">getMyPermissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MyPermissions.html" class="tsd-signature-type tsd-kind-interface">MyPermissions</a><span class="tsd-signature-symbol">></span><a href="#getmypermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the caller's named, customer-scoped capabilities against the
|
|
127
|
-
Twin service
|
|
128
|
-
|
|
129
|
-
|
|
182
|
+
Twin service — the asset-domain vocabulary <code>ViewAssets</code>, <code>EditAssets</code>,
|
|
183
|
+
<code>DeleteAssets</code>, <code>EditAssetTypes</code> and <code>ManageAssetPermissions</code>.
|
|
184
|
+
The admin app uses this to enable or disable
|
|
185
|
+
buttons instead of letting the user click through to a 403.</p>
|
|
130
186
|
<p>No client-side cache — every call hits the wire. Underlying scope
|
|
131
187
|
grants don't shift within a session, so callers are expected to
|
|
132
188
|
memoise the result themselves (e.g. via React Query / a once-on-mount
|
|
@@ -136,96 +192,218 @@ caller should redirect to login). Returns an empty <code>permissions</code> arra
|
|
|
136
192
|
on 403 (authenticated but no Twin-service capabilities). Unknown
|
|
137
193
|
capability strings should be ignored — adding a new capability is a
|
|
138
194
|
non-breaking change.</p>
|
|
139
|
-
|
|
140
|
-
|
|
195
|
+
<p>A 503 throws rather than answering with an empty array: the Permission
|
|
196
|
+
service gave no answer, so the capabilities are unknown rather than
|
|
197
|
+
absent, and the call is safe to retry unchanged.</p>
|
|
198
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MyPermissions.html" class="tsd-signature-type tsd-kind-interface">MyPermissions</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getmypermissions">getMyPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmytwinpermissions"><span>get<wbr/>My<wbr/>Twin<wbr/>Permissions</span><a href="#getmytwinpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getmytwinpermissions-1"><span class="tsd-kind-call-signature">getMyTwinPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MyTwinPermissions.html" class="tsd-signature-type tsd-kind-interface">MyTwinPermissions</a><span class="tsd-signature-symbol">></span><a href="#getmytwinpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the capabilities the caller holds on one specific twin. Open to every
|
|
199
|
+
authenticated caller — an empty list is an honest answer rather than a refusal —
|
|
200
|
+
so a UI can gate its controls on this before it knows anything about the caller.</p>
|
|
201
|
+
<p>The answer mixes vocabularies: the twin's own <code>TwinScopedCapability</code> values, plus the
|
|
202
|
+
asset-instance capabilities <code>ViewAssets</code>, <code>EditAssets</code> and <code>DeleteAssets</code>, which gate the
|
|
203
|
+
assets hanging off this twin. The catalog capabilities and <code>ManageAssetPermissions</code> are not
|
|
204
|
+
twin-bound and are absent here.</p>
|
|
205
|
+
<p>Distinct from <a href="../interfaces/ITwinClient.html#getmypermissions" class="tsd-kind-method">getMyPermissions</a>, which answers the customer-scoped question over the
|
|
206
|
+
whole asset domain. That one returns an empty list on 403; this route has no capability gate
|
|
207
|
+
to refuse at, so a 403 here means something outside the Twin service refused, and is thrown.</p>
|
|
208
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MyTwinPermissions.html" class="tsd-signature-type tsd-kind-interface">MyTwinPermissions</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-44">Throws<a href="#throws-44" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The twin does not exist, or the caller cannot see it — the
|
|
209
|
+
surface does not distinguish the two.</p>
|
|
210
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-45">Throws<a href="#throws-45" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No valid auth context (401).</p>
|
|
211
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-46">Throws<a href="#throws-46" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
212
|
+
safe to retry unchanged.</p>
|
|
213
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getmytwinpermissions">getMyTwinPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getprocessorevents"><span>get<wbr/>Processor<wbr/>Events</span><a href="#getprocessorevents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getprocessorevents-1"><span class="tsd-kind-call-signature">getProcessorEvents</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">twinVersion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">processorId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinProcessorEvent.html" class="tsd-signature-type tsd-kind-interface">TwinProcessorEvent</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getprocessorevents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">twinVersion</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">processorId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">offset</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li><li><span><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 100</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinProcessorEvent.html" class="tsd-signature-type tsd-kind-interface">TwinProcessorEvent</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-47">Throws<a href="#throws-47" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
214
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-48">Throws<a href="#throws-48" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the processor does not exist for this twin version (404).</p>
|
|
141
215
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#getprocessorevents">getProcessorEvents</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwin"><span>get<wbr/>Twin</span><a href="#gettwin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwin-1"><span class="tsd-kind-call-signature">getTwin</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span><a href="#gettwin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twin</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Twin ID string, or <code>{id, version}</code> to fetch a specific version.</p>
|
|
142
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
216
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-49">Throws<a href="#throws-49" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin or version does not exist (404).</p>
|
|
143
217
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwin">getTwin</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwincontent"><span>get<wbr/>Twin<wbr/>Content</span><a href="#gettwincontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwincontent-1"><span class="tsd-kind-call-signature">getTwinContent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinVersionContentResponse.html" class="tsd-signature-type tsd-kind-interface">TwinVersionContentResponse</a><span class="tsd-signature-symbol">></span><a href="#gettwincontent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns content for the latest twin version.</p>
|
|
144
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinVersionContentResponse.html" class="tsd-signature-type tsd-kind-interface">TwinVersionContentResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
145
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwincontent">getTwinContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwindiagnostics"><span>get<wbr/>Twin<wbr/>Diagnostics</span><a href="#gettwindiagnostics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwindiagnostics-1"><span class="tsd-kind-call-signature">getTwinDiagnostics</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinDiagnosticsResponse.html" class="tsd-signature-type tsd-kind-interface">TwinDiagnosticsResponse</a><span class="tsd-signature-symbol">></span><a href="#gettwindiagnostics-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinDiagnosticsResponse.html" class="tsd-signature-type tsd-kind-interface">TwinDiagnosticsResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
146
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwindiagnostics">getTwinDiagnostics</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfile"><span>get<wbr/>Twin<wbr/>File</span><a href="#gettwinfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfile-1"><span class="tsd-kind-call-signature">getTwinFile</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#gettwinfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
147
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
148
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfile">getTwinFile</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfilecontent"><span>get<wbr/>Twin<wbr/>File<wbr/>Content</span><a href="#gettwinfilecontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfilecontent-1"><span class="tsd-kind-call-signature">getTwinFileContent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span><a href="#gettwinfilecontent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
149
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfilecontent">getTwinFileContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfileversion"><span>get<wbr/>Twin<wbr/>File<wbr/>Version</span><a href="#gettwinfileversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfileversion-1"><span class="tsd-kind-call-signature">getTwinFileVersion</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#gettwinfileversion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
150
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfileversion">getTwinFileVersion</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfileversioncontent"><span>get<wbr/>Twin<wbr/>File<wbr/>Version<wbr/>Content</span><a href="#gettwinfileversioncontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfileversioncontent-1"><span class="tsd-kind-call-signature">getTwinFileVersionContent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span><a href="#gettwinfileversioncontent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
151
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfileversioncontent">getTwinFileVersionContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
152
|
-
</div
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
</div
|
|
156
|
-
</div><div class="tsd-
|
|
157
|
-
</div><div class="tsd-
|
|
158
|
-
</div><div class="tsd-
|
|
218
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinVersionContentResponse.html" class="tsd-signature-type tsd-kind-interface">TwinVersionContentResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-50">Throws<a href="#throws-50" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin does not exist (404).</p>
|
|
219
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwincontent">getTwinContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwindiagnostics"><span>get<wbr/>Twin<wbr/>Diagnostics</span><a href="#gettwindiagnostics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwindiagnostics-1"><span class="tsd-kind-call-signature">getTwinDiagnostics</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinDiagnosticsResponse.html" class="tsd-signature-type tsd-kind-interface">TwinDiagnosticsResponse</a><span class="tsd-signature-symbol">></span><a href="#gettwindiagnostics-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinDiagnosticsResponse.html" class="tsd-signature-type tsd-kind-interface">TwinDiagnosticsResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-51">Throws<a href="#throws-51" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin does not exist (404).</p>
|
|
220
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwindiagnostics">getTwinDiagnostics</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfile"><span>get<wbr/>Twin<wbr/>File</span><a href="#gettwinfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfile-1"><span class="tsd-kind-call-signature">getTwinFile</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#gettwinfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-52">Throws<a href="#throws-52" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the file does not exist (404).</p>
|
|
221
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-53">Throws<a href="#throws-53" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid request (400).</p>
|
|
222
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfile">getTwinFile</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfilecontent"><span>get<wbr/>Twin<wbr/>File<wbr/>Content</span><a href="#gettwinfilecontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfilecontent-1"><span class="tsd-kind-call-signature">getTwinFileContent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span><a href="#gettwinfilecontent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-54">Throws<a href="#throws-54" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the file does not exist (404).</p>
|
|
223
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfilecontent">getTwinFileContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfileversion"><span>get<wbr/>Twin<wbr/>File<wbr/>Version</span><a href="#gettwinfileversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfileversion-1"><span class="tsd-kind-call-signature">getTwinFileVersion</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#gettwinfileversion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-55">Throws<a href="#throws-55" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the file or version does not exist (404).</p>
|
|
224
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfileversion">getTwinFileVersion</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinfileversioncontent"><span>get<wbr/>Twin<wbr/>File<wbr/>Version<wbr/>Content</span><a href="#gettwinfileversioncontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinfileversioncontent-1"><span class="tsd-kind-call-signature">getTwinFileVersionContent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span><a href="#gettwinfileversioncontent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-56">Throws<a href="#throws-56" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the file or version does not exist (404).</p>
|
|
225
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinfileversioncontent">getTwinFileVersionContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwingroup"><span>get<wbr/>Twin<wbr/>Group</span><a href="#gettwingroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwingroup-1"><span class="tsd-kind-call-signature">getTwinGroup</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">groupId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGroupGet.html" class="tsd-signature-type tsd-kind-interface">TwinGroupGet</a><span class="tsd-signature-symbol">></span><a href="#gettwingroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns one of the twin's own default groups.</p>
|
|
226
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGroupGet.html" class="tsd-signature-type tsd-kind-interface">TwinGroupGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-57">Throws<a href="#throws-57" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The twin does not own this group — thrown even when the
|
|
227
|
+
group exists in the tenant and holds capabilities on this twin, since ownership, not
|
|
228
|
+
existence, is what this route answers (404).</p>
|
|
229
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-58">Throws<a href="#throws-58" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The twin does not exist or the caller cannot see it (404).</p>
|
|
230
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-59">Throws<a href="#throws-59" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>ManageTwinPermissions</code> is required (403).</p>
|
|
231
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-60">Throws<a href="#throws-60" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>ScopesNotProvisioned</code> (409).</p>
|
|
232
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-61">Throws<a href="#throws-61" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
233
|
+
safe to retry unchanged.</p>
|
|
234
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwingroup">getTwinGroup</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinversioncontent"><span>get<wbr/>Twin<wbr/>Version<wbr/>Content</span><a href="#gettwinversioncontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinversioncontent-1"><span class="tsd-kind-call-signature">getTwinVersionContent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">twinVersion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinVersionContentResponse.html" class="tsd-signature-type tsd-kind-interface">TwinVersionContentResponse</a><span class="tsd-signature-symbol">></span><a href="#gettwinversioncontent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">twinVersion</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinVersionContentResponse.html" class="tsd-signature-type tsd-kind-interface">TwinVersionContentResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-62">Throws<a href="#throws-62" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin or version does not exist (404).</p>
|
|
235
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinversioncontent">getTwinVersionContent</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinversiondiagnostics"><span>get<wbr/>Twin<wbr/>Version<wbr/>Diagnostics</span><a href="#gettwinversiondiagnostics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinversiondiagnostics-1"><span class="tsd-kind-call-signature">getTwinVersionDiagnostics</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">twinVersion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinDiagnosticsResponse.html" class="tsd-signature-type tsd-kind-interface">TwinDiagnosticsResponse</a><span class="tsd-signature-symbol">></span><a href="#gettwinversiondiagnostics-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">twinVersion</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinDiagnosticsResponse.html" class="tsd-signature-type tsd-kind-interface">TwinDiagnosticsResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-63">Throws<a href="#throws-63" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin or version does not exist (404).</p>
|
|
236
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinversiondiagnostics">getTwinVersionDiagnostics</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettwinversionevents"><span>get<wbr/>Twin<wbr/>Version<wbr/>Events</span><a href="#gettwinversionevents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettwinversionevents-1"><span class="tsd-kind-call-signature">getTwinVersionEvents</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">twinVersion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinProcessorEvent.html" class="tsd-signature-type tsd-kind-interface">TwinProcessorEvent</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#gettwinversionevents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">twinVersion</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">offset</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li><li><span><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 100</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinProcessorEvent.html" class="tsd-signature-type tsd-kind-interface">TwinProcessorEvent</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-64">Throws<a href="#throws-64" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
237
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-65">Throws<a href="#throws-65" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin or version does not exist (404).</p>
|
|
238
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#gettwinversionevents">getTwinVersionEvents</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listallassetpermissions"><span>list<wbr/>All<wbr/>Asset<wbr/>Permissions</span><a href="#listallassetpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listallassetpermissions-1"><span class="tsd-kind-call-signature">listAllAssetPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listallassetpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Every entry of <a href="../interfaces/ITwinClient.html#listassetpermissions" class="tsd-kind-method">listAssetPermissions</a>, paged to exhaustion.</p>
|
|
239
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listallassetpermissions">listAllAssetPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listalltwinpermissions"><span>list<wbr/>All<wbr/>Twin<wbr/>Permissions</span><a href="#listalltwinpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listalltwinpermissions-1"><span class="tsd-kind-call-signature">listAllTwinPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listalltwinpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Every permission entry on the twin, following the pagination to the end. The whole
|
|
240
|
+
access-control list of one twin is a handful of entries, and reviewing it is the point of
|
|
241
|
+
the surface, so this — rather than <a href="../interfaces/ITwinClient.html#listtwinpermissions" class="tsd-kind-method">listTwinPermissions</a> — is what most callers want.</p>
|
|
242
|
+
<p>Throws whatever <a href="../interfaces/ITwinClient.html#listtwinpermissions" class="tsd-kind-method">listTwinPermissions</a> throws, from whichever page hit it.</p>
|
|
243
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listalltwinpermissions">listAllTwinPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listalltwins"><span>list<wbr/>All<wbr/>Twins</span><a href="#listalltwins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listalltwins-1"><span class="tsd-kind-call-signature">listAllTwins</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">relatedTo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listalltwins-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches all twins by auto-paginating through <a href="../interfaces/ITwinClient.html#listtwins" class="tsd-kind-method">listTwins</a>. Caps at 1000 pages.</p>
|
|
244
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">relatedTo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p><code>relatedTo</code> filters by container ID; <code>includeDeleted</code> includes soft-deleted twins
|
|
245
|
+
(returned redacted, default false).</p>
|
|
246
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listalltwins">listAllTwins</a></p></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="listalltwins-2"><span class="tsd-kind-call-signature">listAllTwins</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">relatedTo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listalltwins-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">relatedTo</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use the options-object form: <code>listAllTwins({ relatedTo }, signal)</code>.
|
|
247
|
+
The positional form has no <code>includeDeleted</code> parameter; that is only reachable via the options object.</p>
|
|
248
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listalltwins">listAllTwins</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassetattachments"><span>list<wbr/>Asset<wbr/>Attachments</span><a href="#listassetattachments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassetattachments-1"><span class="tsd-kind-call-signature">listAssetAttachments</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listassetattachments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists attachments for a single asset.</p>
|
|
249
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassetattachments">listAssetAttachments</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassetcategories"><span>list<wbr/>Asset<wbr/>Categories</span><a href="#listassetcategories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassetcategories-1"><span class="tsd-kind-call-signature">listAssetCategories</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listassetcategories-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-66">Throws<a href="#throws-66" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
159
250
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassetcategories">listAssetCategories</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassetcategoryversions"><span>list<wbr/>Asset<wbr/>Category<wbr/>Versions</span><a href="#listassetcategoryversions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassetcategoryversions-1"><span class="tsd-kind-call-signature">listAssetCategoryVersions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listassetcategoryversions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns every version of a single asset category, newest first. Mirrors
|
|
160
251
|
<code>listAssetTypeVersions</code> and <code>twin.get_twin_versions</code>.</p>
|
|
161
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
162
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassetcategoryversions">listAssetCategoryVersions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
163
|
-
</
|
|
164
|
-
|
|
252
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-67">Throws<a href="#throws-67" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the category's header row does not exist (404).</p>
|
|
253
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassetcategoryversions">listAssetCategoryVersions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassetgroups"><span>list<wbr/>Asset<wbr/>Groups</span><a href="#listassetgroups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassetgroups-1"><span class="tsd-kind-call-signature">listAssetGroups</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGroupsGet.html" class="tsd-signature-type tsd-kind-interface">AssetGroupsGet</a><span class="tsd-signature-symbol">></span><a href="#listassetgroups-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the asset domain's default groups — <code>AssetsReaders</code>, <code>AssetsContributors</code>,
|
|
254
|
+
<code>AssetsAdministrators</code> — under the ids whose membership confers their preset capabilities.</p>
|
|
255
|
+
<p>A group whose seeding has not completed for this customer is omitted rather than listed under
|
|
256
|
+
a placeholder title, so a short list is a state to poll rather than an error.</p>
|
|
257
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGroupsGet.html" class="tsd-signature-type tsd-kind-interface">AssetGroupsGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-68">Throws<a href="#throws-68" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The caller does not hold <code>ManageAssetPermissions</code>
|
|
258
|
+
(403).</p>
|
|
259
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-69">Throws<a href="#throws-69" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No valid auth context (401).</p>
|
|
260
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-70">Throws<a href="#throws-70" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The titles could not be resolved (503); safe to
|
|
261
|
+
retry unchanged.</p>
|
|
262
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassetgroups">listAssetGroups</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassetpermissions"><span>list<wbr/>Asset<wbr/>Permissions</span><a href="#listassetpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassetpermissions-1"><span class="tsd-kind-call-signature">listAssetPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listassetpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists one page of the principals holding capabilities on the customer-wide asset domain, with
|
|
263
|
+
the capabilities each of them holds. The companion administration surface to
|
|
264
|
+
<a href="../interfaces/ITwinClient.html#getmypermissions" class="tsd-kind-method">getMyPermissions</a>, which answers only for the caller.</p>
|
|
265
|
+
<p><code>pagination.nextPage</code> is emitted unconditionally — it is non-null on the last page too — so it
|
|
266
|
+
is not a termination signal. Page until a response comes back with fewer entries than the
|
|
267
|
+
limit asked for, or use <a href="../interfaces/ITwinClient.html#listallassetpermissions" class="tsd-kind-method">listAllAssetPermissions</a>, which does that. On an access-review
|
|
268
|
+
surface, stopping early under-reports who holds capabilities.</p>
|
|
269
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-71">Throws<a href="#throws-71" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The caller does not hold <code>ManageAssetPermissions</code>
|
|
270
|
+
(403).</p>
|
|
271
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-72">Throws<a href="#throws-72" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The limit is out of range, or the pagination token is invalid
|
|
272
|
+
(400).</p>
|
|
273
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-73">Throws<a href="#throws-73" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No valid auth context (401).</p>
|
|
274
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-74">Throws<a href="#throws-74" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
275
|
+
safe to retry unchanged.</p>
|
|
276
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassetpermissions">listAssetPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassets"><span>list<wbr/>Assets</span><a href="#listassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassets-1"><span class="tsd-kind-call-signature">listAssets</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetListItem.html" class="tsd-signature-type tsd-kind-interface">AssetListItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listassets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">offset</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li><li><span><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 100</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetListItem.html" class="tsd-signature-type tsd-kind-interface">AssetListItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-75">Throws<a href="#throws-75" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
277
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-76">Throws<a href="#throws-76" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin does not exist (404).</p>
|
|
278
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassets">listAssets</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassettypes"><span>list<wbr/>Asset<wbr/>Types</span><a href="#listassettypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassettypes-1"><span class="tsd-kind-call-signature">listAssetTypes</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listassettypes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-77">Throws<a href="#throws-77" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
165
279
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassettypes">listAssetTypes</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listassettypeversions"><span>list<wbr/>Asset<wbr/>Type<wbr/>Versions</span><a href="#listassettypeversions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listassettypeversions-1"><span class="tsd-kind-call-signature">listAssetTypeVersions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">typeId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listassettypeversions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns every version of a single asset type, newest first. Mirrors
|
|
166
280
|
<code>twin.get_twin_versions</code>.</p>
|
|
167
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
168
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassettypeversions">listAssetTypeVersions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwinfiles"><span>list<wbr/>Twin<wbr/>Files</span><a href="#listtwinfiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwinfiles-1"><span class="tsd-kind-call-signature">listTwinFiles</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/TwinFileListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileListOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwinfiles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/TwinFileListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileListOptions</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
169
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwinfiles">listTwinFiles</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwinfileversions"><span>list<wbr/>Twin<wbr/>File<wbr/>Versions</span><a href="#listtwinfileversions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwinfileversions-1"><span class="tsd-kind-call-signature">listTwinFileVersions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/TwinFileVersionListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileVersionListOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwinfileversions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/TwinFileVersionListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileVersionListOptions</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
170
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwinfileversions">listTwinFileVersions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
171
|
-
|
|
172
|
-
|
|
281
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-78">Throws<a href="#throws-78" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the type's header row does not exist (404).</p>
|
|
282
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listassettypeversions">listAssetTypeVersions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwinfiles"><span>list<wbr/>Twin<wbr/>Files</span><a href="#listtwinfiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwinfiles-1"><span class="tsd-kind-call-signature">listTwinFiles</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/TwinFileListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileListOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwinfiles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/TwinFileListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileListOptions</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-79">Throws<a href="#throws-79" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
283
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwinfiles">listTwinFiles</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwinfileversions"><span>list<wbr/>Twin<wbr/>File<wbr/>Versions</span><a href="#listtwinfileversions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwinfileversions-1"><span class="tsd-kind-call-signature">listTwinFileVersions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/TwinFileVersionListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileVersionListOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwinfileversions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/TwinFileVersionListOptions.html" class="tsd-signature-type tsd-kind-interface">TwinFileVersionListOptions</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-80">Throws<a href="#throws-80" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
284
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwinfileversions">listTwinFileVersions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwingroups"><span>list<wbr/>Twin<wbr/>Groups</span><a href="#listtwingroups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwingroups-1"><span class="tsd-kind-call-signature">listTwinGroups</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGroupsGet.html" class="tsd-signature-type tsd-kind-interface">TwinGroupsGet</a><span class="tsd-signature-symbol">></span><a href="#listtwingroups-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the three default groups the twin owns — <code>TwinReaders</code>, <code>TwinContributors</code>,
|
|
285
|
+
<code>TwinAdministrators</code> — under the ids to name in <a href="../interfaces/ITwinClient.html#settwinpermissions" class="tsd-kind-method">setTwinPermissions</a>.</p>
|
|
286
|
+
<p>Not a picker for the principals a twin can be granted to: that is every group in the
|
|
287
|
+
tenant, which the Permission service lists. These are the groups the twin itself
|
|
288
|
+
owns, whose membership confers its preset capability levels.</p>
|
|
289
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGroupsGet.html" class="tsd-signature-type tsd-kind-interface">TwinGroupsGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-81">Throws<a href="#throws-81" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>ManageTwinPermissions</code> is required (403).</p>
|
|
290
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-82">Throws<a href="#throws-82" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The twin does not exist or the caller cannot see it (404).</p>
|
|
291
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-83">Throws<a href="#throws-83" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>ScopesNotProvisioned</code> (409).</p>
|
|
292
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-84">Throws<a href="#throws-84" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
293
|
+
safe to retry unchanged.</p>
|
|
294
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwingroups">listTwinGroups</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwinpermissions"><span>list<wbr/>Twin<wbr/>Permissions</span><a href="#listtwinpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwinpermissions-1"><span class="tsd-kind-call-signature">listTwinPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwinpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists one page of the permission entries on every scope the twin owns. Each entry carries
|
|
295
|
+
the etag of the scope it lives on, which is the value to send back when mutating that
|
|
296
|
+
principal.</p>
|
|
297
|
+
<p><code>pagination.nextPage</code> is emitted unconditionally — it is non-null on the last page too — so
|
|
298
|
+
it is not a termination signal. Page until a response comes back with fewer entries than the
|
|
299
|
+
limit asked for, or use <a href="../interfaces/ITwinClient.html#listalltwinpermissions" class="tsd-kind-method">listAllTwinPermissions</a>, which does that. On an access-review
|
|
300
|
+
surface, stopping early under-reports who holds capabilities on the twin.</p>
|
|
301
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-85">Throws<a href="#throws-85" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The caller may see the twin but does not hold
|
|
302
|
+
<code>ManageTwinPermissions</code> on it (403).</p>
|
|
303
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-86">Throws<a href="#throws-86" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The twin does not exist or the caller cannot see it (404).</p>
|
|
304
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-87">Throws<a href="#throws-87" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The limit is out of range, or the pagination token is invalid
|
|
305
|
+
or does not match the query it was issued for (400).</p>
|
|
306
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-88">Throws<a href="#throws-88" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>ScopesNotProvisioned</code> — the twin owns no Twinfinity
|
|
307
|
+
scope, so there is no permission state to read (409). Retrying will not help.</p>
|
|
308
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-89">Throws<a href="#throws-89" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
309
|
+
safe to retry unchanged.</p>
|
|
310
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwinpermissions">listTwinPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwins"><span>list<wbr/>Twins</span><a href="#listtwins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwins-1"><span class="tsd-kind-call-signature">listTwins</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">relatedTo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwins-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">relatedTo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p><code>relatedTo</code> filters by container ID; <code>includeDeleted</code> includes soft-deleted twins
|
|
311
|
+
(returned redacted, default false); <code>page</code>/<code>limit</code> control pagination.</p>
|
|
312
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-90">Throws<a href="#throws-90" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
313
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwins">listTwins</a></p></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwins-2"><span class="tsd-kind-call-signature">listTwins</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">relatedTo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwins-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">relatedTo</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use the options-object form: <code>listTwins({ relatedTo, page, limit }, signal)</code>.
|
|
314
|
+
The positional form has no <code>includeDeleted</code> parameter; that is only reachable via the options object.</p>
|
|
315
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwins">listTwins</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listtwinversions"><span>list<wbr/>Twin<wbr/>Versions</span><a href="#listtwinversions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listtwinversions-1"><span class="tsd-kind-call-signature">listTwinVersions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#listtwinversions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeDeleted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PaginatedResponse.html" class="tsd-signature-type tsd-kind-interface">PaginatedResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ListTwinItem.html" class="tsd-signature-type tsd-kind-interface">ListTwinItem</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-91">Throws<a href="#throws-91" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid query parameters (400).</p>
|
|
173
316
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#listtwinversions">listTwinVersions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="loadgeometryinfo"><span>load<wbr/>Geometry<wbr/>Info</span><a href="#loadgeometryinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="loadgeometryinfo-1"><span class="tsd-kind-call-signature">loadGeometryInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TwinGeometryInfo</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8GIMeshDescriptor</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8GIStyle</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8GIRegion</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#loadgeometryinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads and deserializes geometry info (t8gi) using default types.
|
|
174
317
|
When no version is specified, searches versions newest-first for one containing t8gi content.</p>
|
|
175
318
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twin</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Twin ID string, or <code>{id, version}</code> to load a specific version.</p>
|
|
176
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TwinGeometryInfo</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8GIMeshDescriptor</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8GIStyle</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8GIRegion</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
319
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TwinGeometryInfo</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8GIMeshDescriptor</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8GIStyle</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8GIRegion</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-92">Throws<a href="#throws-92" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When no version has t8gi content.</p>
|
|
177
320
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#loadgeometryinfo">loadGeometryInfo</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="loadgeometryinfowithfactories"><span>load<wbr/>Geometry<wbr/>Info<wbr/>With<wbr/>Factories</span><a href="#loadgeometryinfowithfactories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="loadgeometryinfowithfactories-1"><span class="tsd-kind-call-signature">loadGeometryInfoWithFactories</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestmeshdescriptor">TMeshDescriptor</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactorieststyle">TStyle</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestregion">TRegion</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">meshDescriptorFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIMeshDescriptorDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestmeshdescriptor">TMeshDescriptor</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">styleFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIStyleDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactorieststyle">TStyle</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">regionFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIRegionDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestregion">TRegion</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TwinGeometryInfo</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestmeshdescriptor">TMeshDescriptor</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactorieststyle">TStyle</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestregion">TRegion</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#loadgeometryinfowithfactories-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads and deserializes geometry info (t8gi) using custom factory functions.
|
|
178
321
|
When no version is specified, searches versions newest-first for one containing t8gi content.</p>
|
|
179
322
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="loadgeometryinfowithfactoriestmeshdescriptor"><span class="tsd-kind-type-parameter">TMeshDescriptor</span></span></li><li><span id="loadgeometryinfowithfactorieststyle"><span class="tsd-kind-type-parameter">TStyle</span></span></li><li><span id="loadgeometryinfowithfactoriestregion"><span class="tsd-kind-type-parameter">TRegion</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twin</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Twin ID string, or <code>{id, version}</code> to load a specific version.</p>
|
|
180
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">meshDescriptorFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIMeshDescriptorDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestmeshdescriptor">TMeshDescriptor</a></span></li><li><span><span class="tsd-kind-parameter">styleFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIStyleDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactorieststyle">TStyle</a></span></li><li><span><span class="tsd-kind-parameter">regionFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIRegionDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestregion">TRegion</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TwinGeometryInfo</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestmeshdescriptor">TMeshDescriptor</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactorieststyle">TStyle</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestregion">TRegion</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
323
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">meshDescriptorFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIMeshDescriptorDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestmeshdescriptor">TMeshDescriptor</a></span></li><li><span><span class="tsd-kind-parameter">styleFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIStyleDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactorieststyle">TStyle</a></span></li><li><span><span class="tsd-kind-parameter">regionFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8GIRegionDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestregion">TRegion</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TwinGeometryInfo</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestmeshdescriptor">TMeshDescriptor</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactorieststyle">TStyle</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadgeometryinfowithfactoriestregion">TRegion</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-93">Throws<a href="#throws-93" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When no version has t8gi content.</p>
|
|
181
324
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#loadgeometryinfowithfactories">loadGeometryInfoWithFactories</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="loadtwin"><span>load<wbr/>Twin</span><a href="#loadtwin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="loadtwin-1"><span class="tsd-kind-call-signature">loadTwin</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">T8Project</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Product</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Product</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#loadtwin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads and deserializes the T8 client model (t8cm + t8cm-ext) using default types.
|
|
182
325
|
When no version is specified, searches versions newest-first for one containing t8cm content.</p>
|
|
183
326
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twin</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Twin ID string, or <code>{id, version}</code> to load a specific version.</p>
|
|
184
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">T8Project</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Product</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Product</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
327
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">T8Project</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Product</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Product</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-94">Throws<a href="#throws-94" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When no version has t8cm content.</p>
|
|
185
328
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#loadtwin">loadTwin</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="loadtwinwithfactories"><span>load<wbr/>Twin<wbr/>With<wbr/>Factories</span><a href="#loadtwinwithfactories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="loadtwinwithfactories-1"><span class="tsd-kind-call-signature">loadTwinWithFactories</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">projectFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProjectDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">productFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProductDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">entityTypeFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientEntityTypeDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">unitFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientUnitDTO</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">dataModel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientModelDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">connectProject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProjectConnectionsDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">connectProduct</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProductConnectionsDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">product</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#loadtwinwithfactories-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads and deserializes the T8 client model using custom factory functions for domain-specific types.
|
|
186
329
|
When no version is specified, searches versions newest-first for one containing t8cm content.</p>
|
|
187
330
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="loadtwinwithfactoriestproject"><span class="tsd-kind-type-parameter">TProject</span></span></li><li><span id="loadtwinwithfactoriestproduct"><span class="tsd-kind-type-parameter">TProduct</span></span></li><li><span id="loadtwinwithfactoriestentitytype"><span class="tsd-kind-type-parameter">TEntityType</span></span></li><li><span id="loadtwinwithfactoriestunit"><span class="tsd-kind-type-parameter">TUnit</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twin</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Twin ID string, or <code>{id, version}</code> to load a specific version.</p>
|
|
188
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">projectFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProjectDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a></span></li><li><span><span class="tsd-kind-parameter">productFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProductDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a></span></li><li><span><span class="tsd-kind-parameter">entityTypeFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientEntityTypeDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a></span></li><li><span><span class="tsd-kind-parameter">unitFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientUnitDTO</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">dataModel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientModelDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a></span></li><li><span><span class="tsd-kind-parameter">connectProject</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProjectConnectionsDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span></li><li><span><span class="tsd-kind-parameter">connectProduct</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProductConnectionsDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">product</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
331
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">projectFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProjectDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a></span></li><li><span><span class="tsd-kind-parameter">productFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProductDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a></span></li><li><span><span class="tsd-kind-parameter">entityTypeFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientEntityTypeDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a></span></li><li><span><span class="tsd-kind-parameter">unitFactory</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientUnitDTO</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">dataModel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientModelDTO</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a></span></li><li><span><span class="tsd-kind-parameter">connectProject</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProjectConnectionsDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span></li><li><span><span class="tsd-kind-parameter">connectProduct</span>: <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">dto</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T8ClientProductConnectionsDTO</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">product</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproject">TProject</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestproduct">TProduct</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestentitytype">TEntityType</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#loadtwinwithfactoriestunit">TUnit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-95">Throws<a href="#throws-95" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When no version has t8cm content.</p>
|
|
189
332
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#loadtwinwithfactories">loadTwinWithFactories</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="loadtwinwithgeometry"><span>load<wbr/>Twin<wbr/>With<wbr/>Geometry</span><a href="#loadtwinwithgeometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="loadtwinwithgeometry-1"><span class="tsd-kind-call-signature">loadTwinWithGeometry</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">T8ProjectWithGeometry</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8ProductWithGeometry</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#loadtwinwithgeometry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads and deserializes both the client model (t8cm) and geometry (t8gi/t8gd) into a combined result.
|
|
190
333
|
When no version is specified, searches versions newest-first for one containing both t8cm and t8gi content.</p>
|
|
191
334
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twin</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Twin ID string, or <code>{id, version}</code> to load a specific version.</p>
|
|
192
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">T8ProjectWithGeometry</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8ProductWithGeometry</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
335
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Twin</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">T8ProjectWithGeometry</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8ProductWithGeometry</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8EntityType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">T8Unit</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-96">Throws<a href="#throws-96" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When no version has both t8cm and t8gi content.</p>
|
|
193
336
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#loadtwinwithgeometry">loadTwinWithGeometry</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="putassetattachment"><span>put<wbr/>Asset<wbr/>Attachment</span><a href="#putassetattachment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="putassetattachment-1"><span class="tsd-kind-call-signature">putAssetAttachment</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">attachmentId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AssetAttachmentPut.html" class="tsd-signature-type tsd-kind-interface">AssetAttachmentPut</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span><a href="#putassetattachment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates an attachment's description / soft-delete flag. <code>documentId</code>
|
|
194
337
|
is immutable — rebinding is rejected.</p>
|
|
195
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">attachmentId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/AssetAttachmentPut.html" class="tsd-signature-type tsd-kind-interface">AssetAttachmentPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
338
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">attachmentId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/AssetAttachmentPut.html" class="tsd-signature-type tsd-kind-interface">AssetAttachmentPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-97">Throws<a href="#throws-97" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The
|
|
196
339
|
error's <code>currentAttachment</code> carries the server's current state.</p>
|
|
197
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
340
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-98">Throws<a href="#throws-98" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the attachment does not exist (404).</p>
|
|
198
341
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#putassetattachment">putAssetAttachment</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="putassetcategory"><span>put<wbr/>Asset<wbr/>Category</span><a href="#putassetcategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="putassetcategory-1"><span class="tsd-kind-call-signature">putAssetCategory</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AssetCategoryPut.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryPut</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><a href="#putassetcategory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Upserts an asset category. Provide an empty/missing etag for first writes
|
|
199
342
|
and the existing etag to update.</p>
|
|
200
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/AssetCategoryPut.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
201
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
343
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/AssetCategoryPut.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-99">Throws<a href="#throws-99" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid request body (400).</p>
|
|
344
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-100">Throws<a href="#throws-100" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentCategory</code> contains the server's current state.</p>
|
|
202
345
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#putassetcategory">putAssetCategory</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="putassettype"><span>put<wbr/>Asset<wbr/>Type</span><a href="#putassettype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="putassettype-1"><span class="tsd-kind-call-signature">putAssetType</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">typeId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AssetTypePut.html" class="tsd-signature-type tsd-kind-interface">AssetTypePut</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><a href="#putassettype-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Upserts an asset type. The metadata schema is validated against the
|
|
203
346
|
Twinfinity meta-schema at the API boundary; invalid schemas surface as
|
|
204
347
|
a 400 with <code>cause: MetadataSchemaInvalid</code>.</p>
|
|
205
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/AssetTypePut.html" class="tsd-signature-type tsd-kind-interface">AssetTypePut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
206
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
207
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#putassettype">putAssetType</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoreasset"><span>restore<wbr/>Asset</span><a href="#restoreasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoreasset-1"><span class="tsd-kind-call-signature">restoreAsset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span><a href="#restoreasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
208
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
348
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/AssetTypePut.html" class="tsd-signature-type tsd-kind-interface">AssetTypePut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-101">Throws<a href="#throws-101" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid request body (400). The error's <code>errorBody</code> carries the structured cause.</p>
|
|
349
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-102">Throws<a href="#throws-102" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentType</code> contains the server's current state.</p>
|
|
350
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#putassettype">putAssetType</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoreasset"><span>restore<wbr/>Asset</span><a href="#restoreasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoreasset-1"><span class="tsd-kind-call-signature">restoreAsset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span><a href="#restoreasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-103">Throws<a href="#throws-103" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the asset does not exist (404).</p>
|
|
351
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-104">Throws<a href="#throws-104" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentAsset</code> contains the server's current state.</p>
|
|
209
352
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoreasset">restoreAsset</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoreassetattachment"><span>restore<wbr/>Asset<wbr/>Attachment</span><a href="#restoreassetattachment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoreassetattachment-1"><span class="tsd-kind-call-signature">restoreAssetAttachment</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">attachmentId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span><a href="#restoreassetattachment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Restores a soft-deleted attachment.</p>
|
|
210
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">attachmentId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
211
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
353
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">attachmentId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AttachmentGet.html" class="tsd-signature-type tsd-kind-interface">AttachmentGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-105">Throws<a href="#throws-105" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409).</p>
|
|
354
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-106">Throws<a href="#throws-106" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the attachment does not exist (404).</p>
|
|
212
355
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoreassetattachment">restoreAssetAttachment</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoreassetcategory"><span>restore<wbr/>Asset<wbr/>Category</span><a href="#restoreassetcategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoreassetcategory-1"><span class="tsd-kind-call-signature">restoreAssetCategory</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span><a href="#restoreassetcategory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Restores a soft-deleted category. Inserts a new asset_category_versions
|
|
213
356
|
row with <code>is_deleted=false</code>; mirrors twin restore.</p>
|
|
214
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
215
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
357
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetCategoryGet.html" class="tsd-signature-type tsd-kind-interface">AssetCategoryGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-107">Throws<a href="#throws-107" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the category does not exist (404).</p>
|
|
358
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-108">Throws<a href="#throws-108" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409).</p>
|
|
216
359
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoreassetcategory">restoreAssetCategory</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoreassettype"><span>restore<wbr/>Asset<wbr/>Type</span><a href="#restoreassettype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoreassettype-1"><span class="tsd-kind-call-signature">restoreAssetType</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">categoryId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">typeId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span><a href="#restoreassettype-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Restores a soft-deleted type. Inserts a new asset_type_versions row with
|
|
217
360
|
<code>is_deleted=false</code>; mirrors twin restore.</p>
|
|
218
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
219
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
220
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoreassettype">restoreAssetType</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoretwin"><span>restore<wbr/>Twin</span><a href="#restoretwin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoretwin-1"><span class="tsd-kind-call-signature">restoreTwin</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span><a href="#restoretwin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
221
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
222
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoretwin">restoreTwin</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoretwinfile"><span>restore<wbr/>Twin<wbr/>File</span><a href="#restoretwinfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoretwinfile-1"><span class="tsd-kind-call-signature">restoreTwinFile</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#restoretwinfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
223
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
224
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-
|
|
225
|
-
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoretwinfile">restoreTwinFile</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="
|
|
226
|
-
</
|
|
361
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">categoryId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">typeId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetTypeGet.html" class="tsd-signature-type tsd-kind-interface">AssetTypeGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-109">Throws<a href="#throws-109" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the type does not exist (404).</p>
|
|
362
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-110">Throws<a href="#throws-110" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409).</p>
|
|
363
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoreassettype">restoreAssetType</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoretwin"><span>restore<wbr/>Twin</span><a href="#restoretwin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoretwin-1"><span class="tsd-kind-call-signature">restoreTwin</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span><a href="#restoretwin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-111">Throws<a href="#throws-111" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the twin does not exist (404).</p>
|
|
364
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-112">Throws<a href="#throws-112" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentTwin</code> contains the server's current state.</p>
|
|
365
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoretwin">restoreTwin</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restoretwinfile"><span>restore<wbr/>Twin<wbr/>File</span><a href="#restoretwinfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restoretwinfile-1"><span class="tsd-kind-call-signature">restoreTwinFile</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fileId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">etag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span><a href="#restoretwinfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">etag</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinFileGet.html" class="tsd-signature-type tsd-kind-interface">TwinFileGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-113">Throws<a href="#throws-113" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the file does not exist (404).</p>
|
|
366
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-114">Throws<a href="#throws-114" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentTwinFile</code> contains the server's current state.</p>
|
|
367
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-115">Throws<a href="#throws-115" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid request (400).</p>
|
|
368
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#restoretwinfile">restoreTwinFile</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setassetpermissions"><span>set<wbr/>Asset<wbr/>Permissions</span><a href="#setassetpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setassetpermissions-1"><span class="tsd-kind-call-signature">setAssetPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">principalId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AssetPermissionsPut.html" class="tsd-signature-type tsd-kind-interface">AssetPermissionsPut</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><a href="#setassetpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Replaces what one principal holds on the asset domain. Capabilities absent from
|
|
369
|
+
<code>body.permissions</code> are revoked, and an empty list revokes everything — leaving the principal
|
|
370
|
+
with no listing entry at all, exactly as <a href="../interfaces/ITwinClient.html#deleteassetpermissions" class="tsd-kind-method">deleteAssetPermissions</a> does.</p>
|
|
371
|
+
<p><code>body.etag</code> is required whenever the principal already holds capabilities, and may be omitted
|
|
372
|
+
only to create the grants of one that holds none.</p>
|
|
373
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">principalId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/AssetPermissionsPut.html" class="tsd-signature-type tsd-kind-interface">AssetPermissionsPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">AssetPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-116">Throws<a href="#throws-116" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No group in the tenant carries this id (404).</p>
|
|
374
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-117">Throws<a href="#throws-117" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>SystemPrincipalImmutable</code> — a seeded default group, whose
|
|
375
|
+
preset is conferred by membership rather than by writing here — or
|
|
376
|
+
<code>ManagePermissionsNotGrantableToAllAuthenticated</code> (400).</p>
|
|
377
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-118">Throws<a href="#throws-118" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>EtagRequired</code> or <code>EtagMismatch</code> (409), carrying the
|
|
378
|
+
current state to retry from.</p>
|
|
379
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-119">Throws<a href="#throws-119" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The caller does not hold <code>ManageAssetPermissions</code>
|
|
380
|
+
(403).</p>
|
|
381
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-120">Throws<a href="#throws-120" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No valid auth context (401).</p>
|
|
382
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-121">Throws<a href="#throws-121" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
383
|
+
safe to retry unchanged.</p>
|
|
384
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#setassetpermissions">setAssetPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="settwinpermissions"><span>set<wbr/>Twin<wbr/>Permissions</span><a href="#settwinpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="settwinpermissions-1"><span class="tsd-kind-call-signature">setTwinPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">principalId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TwinPermissionsPut.html" class="tsd-signature-type tsd-kind-interface">TwinPermissionsPut</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span><a href="#settwinpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Replaces the principal's capabilities on the twin, and returns the entry as stored
|
|
385
|
+
along with the etag to chain the next write on. <code>permissions: []</code> revokes all four
|
|
386
|
+
capabilities without removing an entry that carries bits outside this vocabulary.</p>
|
|
387
|
+
<p><code>body.etag</code> may be omitted only for a principal that holds nothing on the twin yet;
|
|
388
|
+
see <a href="../interfaces/TwinPermissionsPut.html" class="tsd-kind-interface">TwinPermissionsPut</a>. Both etag refusals arrive as
|
|
389
|
+
<a href="TwinPermissionsConflictError.html" class="tsd-kind-class">TwinPermissionsConflictError</a>, carrying the current state to retry from.</p>
|
|
390
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">principalId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../interfaces/TwinPermissionsPut.html" class="tsd-signature-type tsd-kind-interface">TwinPermissionsPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinPrincipalPermissionsGet.html" class="tsd-signature-type tsd-kind-interface">TwinPrincipalPermissionsGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-122">Throws<a href="#throws-122" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The target is immutable through this surface — the twin's own
|
|
391
|
+
default groups and the seeded system principals, marked by
|
|
392
|
+
<a href="../interfaces/TwinPrincipalPermissionsGet.html#readonly" class="tsd-kind-property">TwinPrincipalPermissionsGet.readOnly</a> (cause <code>SystemPrincipalImmutable</code>) — or the
|
|
393
|
+
write asked for <code>ManageTwinPermissions</code> on the all-authenticated principal (cause
|
|
394
|
+
<code>ManagePermissionsNotGrantableToAllAuthenticated</code>), which would make the whole tenant an
|
|
395
|
+
administrator of the twin (400).</p>
|
|
396
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-123">Throws<a href="#throws-123" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>No principal carries this id (404).</p>
|
|
397
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-124">Throws<a href="#throws-124" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The twin does not exist or the caller cannot see it (404).</p>
|
|
398
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-125">Throws<a href="#throws-125" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>ManageTwinPermissions</code> is required (403).</p>
|
|
399
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-126">Throws<a href="#throws-126" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>EtagRequired</code>, <code>EtagMismatch</code> or
|
|
400
|
+
<code>ScopesNotProvisioned</code> (409); the first two carry <code>currentState</code>.</p>
|
|
401
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-127">Throws<a href="#throws-127" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The request could not be completed (503);
|
|
402
|
+
safe to retry unchanged.</p>
|
|
403
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#settwinpermissions">setTwinPermissions</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updateasset"><span>update<wbr/>Asset</span><a href="#updateasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updateasset-1"><span class="tsd-kind-call-signature">updateAsset</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">assetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">asset</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AssetPut.html" class="tsd-signature-type tsd-kind-interface">AssetPut</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span><a href="#updateasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">assetId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">asset</span>: <a href="../interfaces/AssetPut.html" class="tsd-signature-type tsd-kind-interface">AssetPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AssetGet.html" class="tsd-signature-type tsd-kind-interface">AssetGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-128">Throws<a href="#throws-128" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On invalid request body (400). The error's <code>errorBody</code> has structured detail.</p>
|
|
404
|
+
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-129">Throws<a href="#throws-129" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On etag mismatch (409). The error's <code>currentAsset</code> contains the server's current state.</p>
|
|
227
405
|
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#updateasset">updateAsset</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatetwin"><span>update<wbr/>Twin</span><a href="#updatetwin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updatetwin-1"><span class="tsd-kind-call-signature">updateTwin</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">twinId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">twin</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TwinPut.html" class="tsd-signature-type tsd-kind-interface">TwinPut</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span><a href="#updatetwin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Alias for <a href="../interfaces/ITwinClient.html#createorupdatetwin" class="tsd-kind-method">createOrUpdateTwin</a>.</p>
|
|
228
406
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">twinId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">twin</span>: <a href="../interfaces/TwinPut.html" class="tsd-signature-type tsd-kind-interface">TwinPut</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TwinGet.html" class="tsd-signature-type tsd-kind-interface">TwinGet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#updatetwin">updateTwin</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="uploadassetattachmentfile"><span>upload<wbr/>Asset<wbr/>Attachment<wbr/>File</span><a href="#uploadassetattachmentfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="uploadassetattachmentfile-1"><span class="tsd-kind-call-signature">uploadAssetAttachmentFile</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">session</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ApiCreateUploadSessionResponse.html" class="tsd-signature-type tsd-kind-interface">ApiCreateUploadSessionResponse</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#uploadassetattachmentfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Uploads a <code>File</code> / <code>Blob</code> to an existing upload session in one or more
|
|
229
407
|
chunks, then resolves the upload token so the caller can poll
|
|
230
408
|
<a href="../interfaces/ITwinClient.html#getassetattachmentuploadstatus" class="tsd-kind-method">getAssetAttachmentUploadStatus</a>.</p>
|
|
231
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">session</span>: <a href="../interfaces/ApiCreateUploadSessionResponse.html" class="tsd-signature-type tsd-kind-interface">ApiCreateUploadSessionResponse</a></span></li><li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">Blob</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#uploadassetattachmentfile">uploadAssetAttachmentFile</a></p></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#baseurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>base<wbr/>Url</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#batchassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Assets</span></a><a href="#batchgetassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Get<wbr/>Assets</span></a><a href="#createassetattachmentuploadsession"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Asset<wbr/>Attachment<wbr/>Upload<wbr/>Session</span></a><a href="#createassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Assets</span></a><a href="#createorupdatetwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin</span></a><a href="#createorupdatetwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin<wbr/>File</span></a><a href="#createorupdatetwinfileraw"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin<wbr/>File<wbr/>Raw</span></a><a href="#createorupdatetwinraw"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin<wbr/>Raw</span></a><a href="#deleteasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset</span></a><a href="#deleteassetattachment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Attachment</span></a><a href="#deleteassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Category</span></a><a href="#deleteassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Type</span></a><a href="#deletetwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin</span></a><a href="#deletetwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin<wbr/>File</span></a><a href="#downloadtwincontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Twin<wbr/>Content</span></a><a href="#getasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a><a href="#getassetattachmentblob"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Blob</span></a><a href="#getassetattachmentuploadstatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Upload<wbr/>Status</span></a><a href="#getassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Category</span></a><a href="#getassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type</span></a><a href="#getassettypecatalog"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type<wbr/>Catalog</span></a><a href="#getassettypemetaschema"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type<wbr/>Meta<wbr/>Schema</span></a><a href="#getmypermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>My<wbr/>Permissions</span></a><a href="#getprocessorevents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Processor<wbr/>Events</span></a><a href="#gettwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin</span></a><a href="#gettwincontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Content</span></a><a href="#gettwindiagnostics"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Diagnostics</span></a><a href="#gettwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File</span></a><a href="#gettwinfilecontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Content</span></a><a href="#gettwinfileversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Version</span></a><a href="#gettwinfileversioncontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Version<wbr/>Content</span></a><a href="#gettwinversioncontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Content</span></a><a href="#gettwinversiondiagnostics"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Diagnostics</span></a><a href="#gettwinversionevents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Events</span></a><a href="#listalltwins"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>All<wbr/>Twins</span></a><a href="#listassetattachments"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Attachments</span></a><a href="#listassetcategories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Categories</span></a><a href="#listassetcategoryversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Category<wbr/>Versions</span></a><a href="#listassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Assets</span></a><a href="#listassettypes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Types</span></a><a href="#listassettypeversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Type<wbr/>Versions</span></a><a href="#listtwinfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Files</span></a><a href="#listtwinfileversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>File<wbr/>Versions</span></a><a href="#listtwins"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twins</span></a><a href="#listtwinversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Versions</span></a><a href="#loadgeometryinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Geometry<wbr/>Info</span></a><a href="#loadgeometryinfowithfactories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Geometry<wbr/>Info<wbr/>With<wbr/>Factories</span></a><a href="#loadtwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Twin</span></a><a href="#loadtwinwithfactories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Twin<wbr/>With<wbr/>Factories</span></a><a href="#loadtwinwithgeometry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Twin<wbr/>With<wbr/>Geometry</span></a><a href="#putassetattachment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Asset<wbr/>Attachment</span></a><a href="#putassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Asset<wbr/>Category</span></a><a href="#putassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Asset<wbr/>Type</span></a><a href="#restoreasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset</span></a><a href="#restoreassetattachment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset<wbr/>Attachment</span></a><a href="#restoreassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset<wbr/>Category</span></a><a href="#restoreassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset<wbr/>Type</span></a><a href="#restoretwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Twin</span></a><a href="#restoretwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Twin<wbr/>File</span></a><a href="#updateasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Asset</span></a><a href="#updatetwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Twin</span></a><a href="#uploadassetattachmentfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>upload<wbr/>Asset<wbr/>Attachment<wbr/>File</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@twinfinity/twin</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
|
409
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">session</span>: <a href="../interfaces/ApiCreateUploadSessionResponse.html" class="tsd-signature-type tsd-kind-interface">ApiCreateUploadSessionResponse</a></span></li><li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">Blob</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">AbortSignal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/ITwinClient.html">ITwinClient</a>.<a href="../interfaces/ITwinClient.html#uploadassetattachmentfile">uploadAssetAttachmentFile</a></p></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#baseurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>base<wbr/>Url</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#batchassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Assets</span></a><a href="#batchgetassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Get<wbr/>Assets</span></a><a href="#createassetattachmentuploadsession"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Asset<wbr/>Attachment<wbr/>Upload<wbr/>Session</span></a><a href="#createassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Assets</span></a><a href="#createorupdatetwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin</span></a><a href="#createorupdatetwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin<wbr/>File</span></a><a href="#createorupdatetwinfileraw"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin<wbr/>File<wbr/>Raw</span></a><a href="#createorupdatetwinraw"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Or<wbr/>Update<wbr/>Twin<wbr/>Raw</span></a><a href="#deleteasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset</span></a><a href="#deleteassetattachment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Attachment</span></a><a href="#deleteassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Category</span></a><a href="#deleteassetpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Permissions</span></a><a href="#deleteassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset<wbr/>Type</span></a><a href="#deletetwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin</span></a><a href="#deletetwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin<wbr/>File</span></a><a href="#deletetwinpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Twin<wbr/>Permissions</span></a><a href="#downloadtwincontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Twin<wbr/>Content</span></a><a href="#getasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a><a href="#getassetattachmentblob"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Blob</span></a><a href="#getassetattachmentuploadstatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Attachment<wbr/>Upload<wbr/>Status</span></a><a href="#getassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Category</span></a><a href="#getassetgroup"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Group</span></a><a href="#getassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type</span></a><a href="#getassettypecatalog"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type<wbr/>Catalog</span></a><a href="#getassettypemetaschema"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset<wbr/>Type<wbr/>Meta<wbr/>Schema</span></a><a href="#getmypermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>My<wbr/>Permissions</span></a><a href="#getmytwinpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>My<wbr/>Twin<wbr/>Permissions</span></a><a href="#getprocessorevents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Processor<wbr/>Events</span></a><a href="#gettwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin</span></a><a href="#gettwincontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Content</span></a><a href="#gettwindiagnostics"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Diagnostics</span></a><a href="#gettwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File</span></a><a href="#gettwinfilecontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Content</span></a><a href="#gettwinfileversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Version</span></a><a href="#gettwinfileversioncontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>File<wbr/>Version<wbr/>Content</span></a><a href="#gettwingroup"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Group</span></a><a href="#gettwinversioncontent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Content</span></a><a href="#gettwinversiondiagnostics"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Diagnostics</span></a><a href="#gettwinversionevents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Twin<wbr/>Version<wbr/>Events</span></a><a href="#listallassetpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>All<wbr/>Asset<wbr/>Permissions</span></a><a href="#listalltwinpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>All<wbr/>Twin<wbr/>Permissions</span></a><a href="#listalltwins"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>All<wbr/>Twins</span></a><a href="#listassetattachments"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Attachments</span></a><a href="#listassetcategories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Categories</span></a><a href="#listassetcategoryversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Category<wbr/>Versions</span></a><a href="#listassetgroups"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Groups</span></a><a href="#listassetpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Permissions</span></a><a href="#listassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Assets</span></a><a href="#listassettypes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Types</span></a><a href="#listassettypeversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Asset<wbr/>Type<wbr/>Versions</span></a><a href="#listtwinfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Files</span></a><a href="#listtwinfileversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>File<wbr/>Versions</span></a><a href="#listtwingroups"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Groups</span></a><a href="#listtwinpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Permissions</span></a><a href="#listtwins"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twins</span></a><a href="#listtwinversions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Twin<wbr/>Versions</span></a><a href="#loadgeometryinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Geometry<wbr/>Info</span></a><a href="#loadgeometryinfowithfactories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Geometry<wbr/>Info<wbr/>With<wbr/>Factories</span></a><a href="#loadtwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Twin</span></a><a href="#loadtwinwithfactories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Twin<wbr/>With<wbr/>Factories</span></a><a href="#loadtwinwithgeometry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Twin<wbr/>With<wbr/>Geometry</span></a><a href="#putassetattachment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Asset<wbr/>Attachment</span></a><a href="#putassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Asset<wbr/>Category</span></a><a href="#putassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Asset<wbr/>Type</span></a><a href="#restoreasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset</span></a><a href="#restoreassetattachment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset<wbr/>Attachment</span></a><a href="#restoreassetcategory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset<wbr/>Category</span></a><a href="#restoreassettype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Asset<wbr/>Type</span></a><a href="#restoretwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Twin</span></a><a href="#restoretwinfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Twin<wbr/>File</span></a><a href="#setassetpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Asset<wbr/>Permissions</span></a><a href="#settwinpermissions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Twin<wbr/>Permissions</span></a><a href="#updateasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Asset</span></a><a href="#updatetwin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Twin</span></a><a href="#uploadassetattachmentfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>upload<wbr/>Asset<wbr/>Attachment<wbr/>File</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@twinfinity/twin</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|