forge-server-utils
Version:
Tools for accessing Autodesk Forge APIs from Node.js apps and from browser.
108 lines • 206 kB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DesignAutomationClient | 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="DesignAutomationClient.html">DesignAutomationClient</a></li></ul><h1>Class DesignAutomationClient</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/design-automation/v3|design">automation APIs</a>.</p>
</div><div class="tsd-comment tsd-typography"><h4>Tutorial</h4><p>design-automation</p>
</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#DesignAutomationClient">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">DesignAutomationClient</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/design-automation.ts#L167">design-automation.ts:167</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="DesignAutomationClient.html#constructor" class="tsd-index-link deprecated"><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="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.html#_collect" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_collect</span></a>
<a href="DesignAutomationClient.html#_pager" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_pager</span></a>
<a href="DesignAutomationClient.html#createActivity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Activity</span></a>
<a href="DesignAutomationClient.html#createActivityAlias" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Activity<wbr/>Alias</span></a>
<a href="DesignAutomationClient.html#createAppBundle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>App<wbr/>Bundle</span></a>
<a href="DesignAutomationClient.html#createAppBundleAlias" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>App<wbr/>Bundle<wbr/>Alias</span></a>
<a href="DesignAutomationClient.html#createWorkItem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Work<wbr/>Item</span></a>
<a href="DesignAutomationClient.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="DesignAutomationClient.html#deleteActivity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Activity</span></a>
<a href="DesignAutomationClient.html#deleteActivityAlias" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Activity<wbr/>Alias</span></a>
<a href="DesignAutomationClient.html#deleteActivityVersion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Activity<wbr/>Version</span></a>
<a href="DesignAutomationClient.html#deleteAppBundle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>App<wbr/>Bundle</span></a>
<a href="DesignAutomationClient.html#deleteAppBundleAlias" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>App<wbr/>Bundle<wbr/>Alias</span></a>
<a href="DesignAutomationClient.html#deleteAppBundleVersion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>App<wbr/>Bundle<wbr/>Version</span></a>
<a href="DesignAutomationClient.html#deleteNickname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Nickname</span></a>
<a href="DesignAutomationClient.html#deleteWorkItem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Work<wbr/>Item</span></a>
<a href="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.html#getActivity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Activity</span></a>
<a href="DesignAutomationClient.html#getActivityVersion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Activity<wbr/>Version</span></a>
<a href="DesignAutomationClient.html#getAppBundle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>App<wbr/>Bundle</span></a>
<a href="DesignAutomationClient.html#getAppBundleVersion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>App<wbr/>Bundle<wbr/>Version</span></a>
<a href="DesignAutomationClient.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="DesignAutomationClient.html#getEngine" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Engine</span></a>
<a href="DesignAutomationClient.html#getNickname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Nickname</span></a>
<a href="DesignAutomationClient.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="DesignAutomationClient.html#getWorkItem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Work<wbr/>Item</span></a>
<a href="DesignAutomationClient.html#iterateActivities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterate<wbr/>Activities</span></a>
<a href="DesignAutomationClient.html#iterateActivityAliases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterate<wbr/>Activity<wbr/>Aliases</span></a>
<a href="DesignAutomationClient.html#iterateActivityVersions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterate<wbr/>Activity<wbr/>Versions</span></a>
<a href="DesignAutomationClient.html#iterateAppBundleAliases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterate<wbr/>App<wbr/>Bundle<wbr/>Aliases</span></a>
<a href="DesignAutomationClient.html#iterateAppBundleVersions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterate<wbr/>App<wbr/>Bundle<wbr/>Versions</span></a>
<a href="DesignAutomationClient.html#iterateAppBundles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterate<wbr/>App<wbr/>Bundles</span></a>
<a href="DesignAutomationClient.html#iterateEngines" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterate<wbr/>Engines</span></a>
<a href="DesignAutomationClient.html#listActivities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Activities</span></a>
<a href="DesignAutomationClient.html#listActivityAliases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Activity<wbr/>Aliases</span></a>
<a href="DesignAutomationClient.html#listActivityVersions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Activity<wbr/>Versions</span></a>
<a href="DesignAutomationClient.html#listAppBundleAliases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>App<wbr/>Bundle<wbr/>Aliases</span></a>
<a href="DesignAutomationClient.html#listAppBundleVersions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>App<wbr/>Bundle<wbr/>Versions</span></a>
<a href="DesignAutomationClient.html#listAppBundles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>App<wbr/>Bundles</span></a>
<a href="DesignAutomationClient.html#listEngines" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Engines</span></a>
<a href="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.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="DesignAutomationClient.html#reset" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reset</span></a>
<a href="DesignAutomationClient.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="DesignAutomationClient.html#setNickname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Nickname</span></a>
<a href="DesignAutomationClient.html#updateActivity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Activity</span></a>
<a href="DesignAutomationClient.html#updateActivityAlias" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Activity<wbr/>Alias</span></a>
<a href="DesignAutomationClient.html#updateAppBundle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>App<wbr/>Bundle</span></a>
<a href="DesignAutomationClient.html#updateAppBundleAlias" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>App<wbr/>Bundle<wbr/>Alias</span></a>
<a href="DesignAutomationClient.html#uploadAppBundleArchive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>upload<wbr/>App<wbr/>Bundle<wbr/>Archive</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 class="deprecated">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_DesignAutomationClient" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Design<wbr/>Automation<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-kind-parameter">region</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DesignAutomationClient.html" class="tsd-signature-type tsd-kind-class">DesignAutomationClient</a><a href="#constructor.new_DesignAutomationClient" 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"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">region</span>: <a href="../enums/DesignAutomationRegion.html" class="tsd-signature-type tsd-kind-enum">DesignAutomationRegion</a></h5><div class="tsd-comment tsd-typography"><p>Design Automation specific availability region.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DesignAutomationClient.html" class="tsd-signature-type tsd-kind-class">DesignAutomationClient</a></h4><div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Will be removed in next major version.</p>
</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/design-automation.ts#L177">design-automation.ts:177</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-private"><a id="_collect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_collect</span><a href="#_collect" 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-private"><li class="tsd-signature tsd-anchor-link"><a id="_collect._collect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">_collect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</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="#_collect._collect-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">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"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/design-automation.ts#L210">design-automation.ts:210</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_pager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_pager</span><a href="#_pager" 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-private"><li class="tsd-signature tsd-anchor-link"><a id="_pager._pager-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">_pager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</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">AsyncGenerator</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">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#_pager._pager-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">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">AsyncGenerator</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">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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/design-automation.ts#L199">design-automation.ts:199</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createActivity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Activity</span><a href="#createActivity" 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="createActivity.createActivity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Activity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">engine</span>, <span class="tsd-kind-parameter">commands</span>, <span class="tsd-kind-parameter">appBundleIDs</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">settings</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">description</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/IActivityDetail.html" class="tsd-signature-type tsd-kind-interface">IActivityDetail</a><span class="tsd-signature-symbol">></span><a href="#createActivity.createActivity-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>Creates new activity
(<a href="https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-POST|docs">https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-POST|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">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>New activity ID.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">engine</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>ID of one of the supported engines.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">commands</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></h5><div class="tsd-comment tsd-typography"><p>One or more CLI commands to be executed within the activity.</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">appBundleIDs</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></h5><div class="tsd-comment tsd-typography"><p>Fully qualified IDs of zero or more app bundles used by the activity.</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">parameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><a href="../interfaces/IActivityParam.html" class="tsd-signature-type tsd-kind-interface">IActivityParam</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Input/output parameter descriptors.</p>
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../interfaces/IActivityParam.html" class="tsd-signature-type tsd-kind-interface">IActivityParam</a></h5></li></ul></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">settings</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><a href="../interfaces/ICodeOnEngineStringSetting.html" class="tsd-signature-type tsd-kind-interface">ICodeOnEngineStringSetting</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ICodeOnEngineUrlSetting.html" class="tsd-signature-type tsd-kind-interface">ICodeOnEngineUrlSetting</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Additional activity settings.</p>
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../interfaces/ICodeOnEngineStringSetting.html" class="tsd-signature-type tsd-kind-interface">ICodeOnEngineStringSetting</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ICodeOnEngineUrlSetting.html" class="tsd-signature-type tsd-kind-interface">ICodeOnEngineUrlSetting</a></h5></li></ul></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Activity description.</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/IActivityDetail.html" class="tsd-signature-type tsd-kind-interface">IActivityDetail</a><span class="tsd-signature-symbol">></span></h4><p>Details of created activity.</p>
<div class="tsd-comment tsd-typography"><h4>Async</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/design-automation.ts#L613">design-automation.ts:613</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createActivityAlias" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Activity<wbr/>Alias</span><a href="#createActivityAlias" 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="createActivityAlias.createActivityAlias-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Activity<wbr/>Alias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">alias</span>, <span class="tsd-kind-parameter">version</span>, <span class="tsd-kind-parameter">receiver</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/IAlias.html" class="tsd-signature-type tsd-kind-interface">IAlias</a><span class="tsd-signature-symbol">></span><a href="#createActivityAlias.createActivityAlias-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>Creates new alias for an activity
(<a href="https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-aliases-POST|docs">https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-aliases-POST|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">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Activity ID.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">alias</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>New alias name.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Activity version to link to this alias.</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">receiver</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional ID of another Forge application to share this activity with.</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/IAlias.html" class="tsd-signature-type tsd-kind-interface">IAlias</a><span class="tsd-signature-symbol">></span></h4><p>Details of created alias.</p>
<div class="tsd-comment tsd-typography"><h4>Async</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/petrbroz/forge-server-utils/blob/cdaa7a5/src/design-automation.ts#L743">design-automation.ts:743</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createAppBundle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>App<wbr/>Bundle</span><a href="#createAppBundle" 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="createAppBundle.createAppBundle-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>App<wbr/>Bundle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">engine</span>, <span class="tsd-kind-parameter">settings</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">description</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/IAppBundleUploadParams.html" class="tsd-signature-type tsd-kind-interface">IAppBundleUploadParams</a><span class="tsd-signature-symbol">></span><a href="#createAppBundle.createAppBundle-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>Creates a new app bundle
(<a href="https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-POST|docs">https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-POST|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">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Unique name of the bundle.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">engine</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>ID of one of the supported engines.</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">settings</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Additional app bundle settings.</p>
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>App bundle description.</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/IAppBundleUploadParams.html" class="tsd-signature-type tsd-kind-interface">IAppBundleUploadParams</a><span class="tsd-signature-symbol">></span></h4><p>Details of the created app bundle,
incl. parameters for uploading the actual zip file with app bundle binaries.</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/design-automation.ts#L351">design-automation.ts:351</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createAppBundleAlias" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>App<wbr/>Bundle<wbr/>Alias</span><a href="#createAppBundleAlias" 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="createAppBundleAlias.createAppBundleAlias-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>App<wbr/>Bundle<wbr/>Alias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">alias</span>, <span class="tsd-kind-parameter">version</span>, <span class="tsd-kind-parameter">receiver</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/IAlias.html" class="tsd-signature-type tsd-kind-interface">IAlias</a><span class="tsd-signature-symbol">></span><a href="#createAppBundleAlias.createAppBundleAlias-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>Creates new alias for an app bundle
(<a href="https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-aliases-POST/|docs">https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-aliases-POST/|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">name</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Name of the app bundle.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">alias</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Alias name.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Version of app bundle to link to this alias.</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">receiver</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional ID of another Forge application to share this app bundle with.</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/IAlias.html" class="tsd-signature-type tsd-kind-interface">IAlias</a><span class="tsd-signature-symbol">></span></h4><p>Details of the created alias.</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/design-automation.ts#L489">design-automation.ts:489</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createWorkItem" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Work<wbr/>Item</span><a href="#createWorkItem" 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="createWorkItem.createWorkItem-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Work<wbr/>Item</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">activityId</span>, <span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">signatures</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">limitProcessingTimeSec</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#createWorkItem.createWorkItem-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>Creates new work item
(<a href="https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/workitems-POST|docs">https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/workitems-POST|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">activityId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Activity ID.</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">args</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><a href="../interfaces/IWorkItemParam.html" class="tsd-signature-type tsd-kind-interface">IWorkItemParam</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Arguments to pass in as activity parameters.</p>
</div><div class="tsd-comment tsd-typography"></div><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><a href="../interfaces/IWorkItemParam.html" class="tsd-signature-type tsd-kind-interface">IWorkItemParam</a></h5></li></ul></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signatures</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">activityId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">baseUrls</span><span class="tsd-signature-symbol">?: </span><span class=