forge-server-utils

Version:

Tools for accessing Autodesk Forge APIs from Node.js apps and from browser.

82 lines • 126 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ModelDerivativeClient | forge-server-utils</title><meta name="description" content="Documentation for forge-server-utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">forge-server-utils</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">forge-server-utils</a></li><li><a href="ModelDerivativeClient.html">ModelDerivativeClient</a></li></ul><h1>Class ModelDerivativeClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Client providing access to Autodesk Forge <a href="https://forge.autodesk.com/en/docs/model-derivative/v2|model">derivative APIs</a>.</p> </div><div class="tsd-comment tsd-typography"><h4>Tutorial</h4><p>model-derivative</p> </div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ModelDerivativeClient">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="ForgeClient.html" class="tsd-signature-type tsd-kind-class">ForgeClient</a><ul class="tsd-hierarchy"><li><span class="target">ModelDerivativeClient</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L264">model-derivative.ts:264</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ModelDerivativeClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ModelDerivativeClient.html#auth" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auth?</span></a> <a href="ModelDerivativeClient.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>axios</span></a> <a href="ModelDerivativeClient.html#host" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>host</span></a> <a href="ModelDerivativeClient.html#region" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>region</span></a> <a href="ModelDerivativeClient.html#root" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>root</span></a> <a href="ModelDerivativeClient.html#token" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>token?</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ModelDerivativeClient.html#delete" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete</span></a> <a href="ModelDerivativeClient.html#deleteManifest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Manifest</span></a> <a href="ModelDerivativeClient.html#fetch" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fetch</span></a> <a href="ModelDerivativeClient.html#formats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>formats</span></a> <a href="ModelDerivativeClient.html#get" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get</span></a> <a href="ModelDerivativeClient.html#getBuffer" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Buffer</span></a> <a href="ModelDerivativeClient.html#getDerivative" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Derivative</span></a> <a href="ModelDerivativeClient.html#getDerivativeChunked" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Derivative<wbr/>Chunked</span></a> <a href="ModelDerivativeClient.html#getDerivativeDownloadUrl" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Derivative<wbr/>Download<wbr/>Url</span></a> <a href="ModelDerivativeClient.html#getDerivativeStream" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Derivative<wbr/>Stream</span></a> <a href="ModelDerivativeClient.html#getManifest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Manifest</span></a> <a href="ModelDerivativeClient.html#getMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Metadata</span></a> <a href="ModelDerivativeClient.html#getMetadataStream" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Metadata<wbr/>Stream</span></a> <a href="ModelDerivativeClient.html#getStream" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Stream</span></a> <a href="ModelDerivativeClient.html#getThumbnail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Thumbnail</span></a> <a href="ModelDerivativeClient.html#getThumbnailStream" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Thumbnail<wbr/>Stream</span></a> <a href="ModelDerivativeClient.html#getUrl" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Url</span></a> <a href="ModelDerivativeClient.html#getViewableProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Viewable<wbr/>Properties</span></a> <a href="ModelDerivativeClient.html#getViewablePropertiesStream" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Viewable<wbr/>Properties<wbr/>Stream</span></a> <a href="ModelDerivativeClient.html#getViewableTree" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Viewable<wbr/>Tree</span></a> <a href="ModelDerivativeClient.html#getViewableTreeStream" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Viewable<wbr/>Tree<wbr/>Stream</span></a> <a href="ModelDerivativeClient.html#patch" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>patch</span></a> <a href="ModelDerivativeClient.html#post" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>post</span></a> <a href="ModelDerivativeClient.html#put" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>put</span></a> <a href="ModelDerivativeClient.html#reset" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reset</span></a> <a href="ModelDerivativeClient.html#setAuthorization" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Authorization</span></a> <a href="ModelDerivativeClient.html#submitJob" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>submit<wbr/>Job</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ModelDerivativeClient" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Model<wbr/>Derivative<wbr/>Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">auth</span>, <span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">region</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ModelDerivativeClient.html" class="tsd-signature-type tsd-kind-class">ModelDerivativeClient</a><a href="#constructor.new_ModelDerivativeClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes new client with specific authentication method.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">auth</span>: <span class="tsd-signature-type">IAuthOptions</span></h5><div class="tsd-comment tsd-typography"><p>Authentication object, containing either <code>client_id</code> and <code>client_secret</code> properties (for 2-legged authentication), or a single <code>token</code> property (for 2-legged or 3-legged authentication with pre-generated access token).</p> </div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">host</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Forge API host.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">region</span>: <span class="tsd-signature-type">Region</span></h5><div class="tsd-comment tsd-typography"><p>Forge availability region.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ModelDerivativeClient.html" class="tsd-signature-type tsd-kind-class">ModelDerivativeClient</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L273">model-derivative.ts:273</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="auth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>auth</span><a href="#auth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">auth</span><span class="tsd-signature-symbol">?:</span> <a href="AuthenticationClient.html" class="tsd-signature-type tsd-kind-class">AuthenticationClient</a></div><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#auth">auth</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L23">common.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span></div><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#axios">axios</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L28">common.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="host" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>host</span><a href="#host" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">host</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#host">host</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L26">common.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="region" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>region</span><a href="#region" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">region</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Region</span></div><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#region">region</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L27">common.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="root" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>root</span><a href="#root" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">root</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#root">root</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L25">common.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="token" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>token</span><a href="#token" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">token</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#token">token</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L24">common.ts:24</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">headers</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</span>: <span class="tsd-signature-type">string</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></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li><h5><span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></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">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#delete">delete</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L161">common.ts:161</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteManifest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Manifest</span><a href="#deleteManifest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteManifest.deleteManifest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Manifest</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">urn</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#deleteManifest.deleteManifest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes manifest (<a href="https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-DELETE|docs">https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-DELETE|docs</a>).</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">urn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Document derivative URN.</p> </div><div class="tsd-comment tsd-typography"></div></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">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Async</h4><h4>Throws</h4><p>Error when the request fails, for example, due to insufficient rights, or incorrect scopes.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L358">model-derivative.ts:358</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>fetch</span><a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="fetch.fetch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</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><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#fetch.fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></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">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#fetch">fetch</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L101">common.ts:101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="formats" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>formats</span><a href="#formats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="formats.formats-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">formats</span><span class="tsd-signature-symbol">(</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/IDerivativeFormats.html" class="tsd-signature-type tsd-kind-interface">IDerivativeFormats</a><span class="tsd-signature-symbol">></span><a href="#formats.formats-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets a list of supported translation formats (<a href="https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/formats-GET|docs">https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/formats-GET|docs</a>).</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/IDerivativeFormats.html" class="tsd-signature-type tsd-kind-interface">IDerivativeFormats</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Async</h4><h4>Yields</h4><p>Dictionary of all supported output formats mapped to arrays of formats these outputs can be obtained from.</p> <h4>Throws</h4><p>Error when the request fails, for example, due to insufficient rights.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L289">model-derivative.ts:289</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">headers</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</span>: <span class="tsd-signature-type">string</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></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li><h5><span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></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">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#get">get</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L107">common.ts:107</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getBuffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Buffer</span><a href="#getBuffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getBuffer.getBuffer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Buffer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">headers</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">scopes</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getBuffer.getBuffer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</span>: <span class="tsd-signature-type">string</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></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li><li><h5><span class="tsd-kind-parameter">scopes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></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">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="ForgeClient.html">ForgeClient</a>.<a href="ForgeClient.html#getBuffer">getBuffer</a></p><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/common.ts#L116">common.ts:116</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDerivative" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Derivative</span><a href="#getDerivative" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDerivative.getDerivative-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Derivative</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">modelUrn</span>, <span class="tsd-kind-parameter">derivativeUrn</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><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span><a href="#getDerivative.getDerivative-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads content of a specific model derivative (<a href="https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs">https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs</a>).</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">modelUrn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Model URN.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">derivativeUrn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Derivative URN.</p> </div><div class="tsd-comment tsd-typography"></div></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><p>Derivative content.</p> <div class="tsd-comment tsd-typography"><h4>Async</h4><h4>Throws</h4><p>Error when the request fails, for example, due to insufficient rights, or incorrect scopes.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L399">model-derivative.ts:399</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDerivativeChunked" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Derivative<wbr/>Chunked</span><a href="#getDerivativeChunked" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDerivativeChunked.getDerivativeChunked-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Derivative<wbr/>Chunked</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">modelUrn</span>, <span class="tsd-kind-parameter">derivativeUrn</span>, <span class="tsd-kind-parameter">maxChunkSize</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readable</span><a href="#getDerivativeChunked.getDerivativeChunked-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads content of a specific model derivative asset in chunks (<a href="https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs">https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs</a>).</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">modelUrn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Model URN.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">derivativeUrn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Derivative URN.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">maxChunkSize</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></h5><div class="tsd-comment tsd-typography"><p>Maximum size (in bytes) of a single downloaded chunk.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Readable</span></h4><p>Readable stream with the content of the downloaded derivative asset.</p> <div class="tsd-comment tsd-typography"><h4>Throws</h4><p>Error when the request fails, for example, due to insufficient rights, or incorrect scopes.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L438">model-derivative.ts:438</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="getDerivativeDownloadUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Derivative<wbr/>Download<wbr/>Url</span><a href="#getDerivativeDownloadUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="getDerivativeDownloadUrl.getDerivativeDownloadUrl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Derivative<wbr/>Download<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">modelUrn</span>, <span class="tsd-kind-parameter">derivativeUrn</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><span class="tsd-signature-type">IDerivativeDownloadInfo</span><span class="tsd-signature-symbol">></span><a href="#getDerivativeDownloadUrl.getDerivativeDownloadUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">modelUrn</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-kind-parameter">derivativeUrn</span>: <span class="tsd-signature-type">string</span></h5></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">IDerivativeDownloadInfo</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L364">model-derivative.ts:364</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDerivativeStream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Derivative<wbr/>Stream</span><a href="#getDerivativeStream" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDerivativeStream.getDerivativeStream-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Derivative<wbr/>Stream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">modelUrn</span>, <span class="tsd-kind-parameter">derivativeUrn</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><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getDerivativeStream.getDerivativeStream-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Downloads content of a specific model derivative (<a href="https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs">https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET/|docs</a>).</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">modelUrn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Model URN.</p> </div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">derivativeUrn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Derivative URN.</p> </div><div class="tsd-comment tsd-typography"></div></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">ReadableStream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>Derivative content stream.</p> <div class="tsd-comment tsd-typography"><h4>Async</h4><h4>Throws</h4><p>Error when the request fails, for example, due to insufficient rights, or incorrect scopes.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L420">model-derivative.ts:420</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getManifest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Manifest</span><a href="#getManifest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getManifest.getManifest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Manifest</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">urn</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/IDerivativeManifest.html" class="tsd-signature-type tsd-kind-interface">IDerivativeManifest</a><span class="tsd-signature-symbol">></span><a href="#getManifest.getManifest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves manifest of a derivative (<a href="https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-GET|docs">https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-GET|docs</a>).</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">urn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Document derivative URN.</p> </div><div class="tsd-comment tsd-typography"></div></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/IDerivativeManifest.html" class="tsd-signature-type tsd-kind-interface">IDerivativeManifest</a><span class="tsd-signature-symbol">></span></h4><p>Document derivative manifest.</p> <div class="tsd-comment tsd-typography"><h4>Async</h4><h4>Throws</h4><p>Error when the request fails, for example, due to insufficient rights.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L347">model-derivative.ts:347</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Metadata</span><a href="#getMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getMetadata.getMetadata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Metadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">urn</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/IDerivativeMetadata.html" class="tsd-signature-type tsd-kind-interface">IDerivativeMetadata</a><span class="tsd-signature-symbol">></span><a href="#getMetadata.getMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves metadata of a derivative (<a href="https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-GET|docs">https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-GET|docs</a>).</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">urn</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Document derivative URN.</p> </div><div class="tsd-comment tsd-typography"></div></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/IDerivativeMetadata.html" class="tsd-signature-type tsd-kind-interface">IDerivativeMetadata</a><span class="tsd-signature-symbol">></span></h4><p>Document derivative metadata.</p> <div class="tsd-comment tsd-typography"><h4>Async</h4><h4>Throws</h4><p>Error when the request fails, for example, due to insufficient rights.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/model-derivative.ts#L469">model-derivative.ts:469</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getMetadataStream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Metadata<wbr/>Stream</span><a hre