mirror of
https://github.com/sasjs/adapter.git
synced 2025-12-11 01:14:36 +00:00
239 lines
110 KiB
HTML
239 lines
110 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SASViyaApiClient | @sasjs/adapter</title><meta name="description" content="Documentation for @sasjs/adapter"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@sasjs/adapter</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@sasjs/adapter</a></li><li><a href="../modules/SASViyaApiClient.html">SASViyaApiClient</a></li><li><a href="SASViyaApiClient.SASViyaApiClient-1.html">SASViyaApiClient</a></li></ul><h1>Class SASViyaApiClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A client for interfacing with the SAS Viya REST API.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SASViyaApiClient</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#debug" class="tsd-kind-icon">debug</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#appendRequest" class="tsd-kind-icon">append<wbr/>Request</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createComputeContext" class="tsd-kind-icon">create<wbr/>Compute<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createFile" class="tsd-kind-icon">create<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createFolder" class="tsd-kind-icon">create<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createJobDefinition" class="tsd-kind-icon">create<wbr/>Job<wbr/>Definition</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createLauncherContext" class="tsd-kind-icon">create<wbr/>Launcher<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createSession" class="tsd-kind-icon">create<wbr/>Session</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#deleteClient" class="tsd-kind-icon">delete<wbr/>Client</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#deleteComputeContext" class="tsd-kind-icon">delete<wbr/>Compute<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#deleteFolder" class="tsd-kind-icon">delete<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#editComputeContext" class="tsd-kind-icon">edit<wbr/>Compute<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#executeComputeJob" class="tsd-kind-icon">execute<wbr/>Compute<wbr/>Job</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#executeJob" class="tsd-kind-icon">execute<wbr/>Job</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#executeScript" class="tsd-kind-icon">execute<wbr/>Script</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getAccessToken" class="tsd-kind-icon">get<wbr/>Access<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getAuthCode" class="tsd-kind-icon">get<wbr/>Auth<wbr/>Code</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getComputeContextById" class="tsd-kind-icon">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getComputeContextByName" class="tsd-kind-icon">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getComputeContexts" class="tsd-kind-icon">get<wbr/>Compute<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getConfig" class="tsd-kind-icon">get<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getDefaultComputeContexts" class="tsd-kind-icon">get<wbr/>Default<wbr/>Compute<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getExecutableContexts" class="tsd-kind-icon">get<wbr/>Executable<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getFolder" class="tsd-kind-icon">get<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getJobsInFolder" class="tsd-kind-icon">get<wbr/>Jobs<wbr/>In<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getLauncherContexts" class="tsd-kind-icon">get<wbr/>Launcher<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#listFolder" class="tsd-kind-icon">list<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#moveFolder" class="tsd-kind-icon">move<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#refreshTokens" class="tsd-kind-icon">refresh<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#setConfig" class="tsd-kind-icon">set<wbr/>Config</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new SASViya<wbr/>Api<wbr/>Client<span class="tsd-signature-symbol">(</span>serverUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, rootFolderName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestClient</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SASViyaApiClient.SASViyaApiClient-1.html" class="tsd-signature-type" data-tsd-kind="Class">SASViyaApiClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L33">SASViyaApiClient.ts:33</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>serverUrl: <span class="tsd-signature-type">string</span></h5></li><li><h5>rootFolderName: <span class="tsd-signature-type">string</span></h5></li><li><h5>contextName: <span class="tsd-signature-type">string</span></h5></li><li><h5>requestClient: <span class="tsd-signature-type">RequestClient</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="SASViyaApiClient.SASViyaApiClient-1.html" class="tsd-signature-type" data-tsd-kind="Class">SASViyaApiClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link">debug<a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> debug<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> debug<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L64">SASViyaApiClient.ts:64</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L68">SASViyaApiClient.ts:68</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="appendRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link">append<wbr/>Request<a href="#appendRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">append<wbr/>Request<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, program<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, debug<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L60">SASViyaApiClient.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A helper method used to call appendRequest method of RequestClient</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>response: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>response from sasjs request</p>
|
|
</div></div></li><li><h5>program: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>name of program</p>
|
|
</div></div></li><li><h5>debug: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>a boolean that indicates whether debug was enabled or not</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createComputeContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Compute<wbr/>Context<a href="#createComputeContext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Compute<wbr/>Context<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, launchContextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sharedAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, autoExecLines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, authorizedUsers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L190">SASViyaApiClient.ts:190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a compute context on the given server.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the context to be created.</p>
|
|
</div></div></li><li><h5>launchContextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the launcher context used by the compute service.</p>
|
|
</div></div></li><li><h5>sharedAccountId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the ID of the account to run the servers for this context.</p>
|
|
</div></div></li><li><h5>autoExecLines: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the lines of code to execute during session initialization.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> authorizedUsers: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an optional list of authorized user IDs.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>File<a href="#createFile" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>File<span class="tsd-signature-symbol">(</span>fileName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contentBuffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, parentFolderPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, parentFolderUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.File.html" class="tsd-signature-type" data-tsd-kind="Interface">File</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L325">SASViyaApiClient.ts:325</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a file. Path to or URI of the parent folder is required.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fileName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the new file.</p>
|
|
</div></div></li><li><h5>contentBuffer: <span class="tsd-signature-type">Buffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the content of the new file in Buffer.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderPath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the full path to the parent folder. If not
|
|
provided, the parentFolderUri must be provided.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderUri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the URI (eg /folders/folders/UUID) of the parent
|
|
folder. If not provided, the parentFolderPath must be provided.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.File.html" class="tsd-signature-type" data-tsd-kind="Interface">File</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Folder<a href="#createFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Folder<span class="tsd-signature-symbol">(</span>folderName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parentFolderPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, parentFolderUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, isForced<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L369">SASViyaApiClient.ts:369</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a folder. Path to or URI of the parent folder is required.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>folderName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the new folder.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderPath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the full path to the parent folder. If not
|
|
provided, the parentFolderUri must be provided.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderUri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the URI (eg /folders/folders/UUID) of the parent
|
|
folder. If not provided, the parentFolderPath must be provided.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> isForced: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>flag that indicates if target folder already exists, it and all subfolders have to be deleted.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createJobDefinition" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Job<wbr/>Definition<a href="#createJobDefinition" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Job<wbr/>Definition<span class="tsd-signature-symbol">(</span>jobName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parentFolderPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, parentFolderUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Job.html" class="tsd-signature-type" data-tsd-kind="Interface">Job</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L452">SASViyaApiClient.ts:452</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a Job in the specified folder (or folder uri).</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jobName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the new job to be created.</p>
|
|
</div></div></li><li><h5>code: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the SAS code for the new job.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderPath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the location of the new job.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderUri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the URI location of the new job. The function is a
|
|
little faster if the folder URI is supplied instead of the path.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Job.html" class="tsd-signature-type" data-tsd-kind="Interface">Job</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createLauncherContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Launcher<wbr/>Context<a href="#createLauncherContext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Launcher<wbr/>Context<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, launchType<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L215">SASViyaApiClient.ts:215</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a launcher context on the given server.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the context to be created.</p>
|
|
</div></div></li><li><h5>description: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the description of the context to be created.</p>
|
|
</div></div></li><li><h5>launchType: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'direct'</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>launch type of the context to be created.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSession" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Session<a href="#createSession" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Session<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Session.html" class="tsd-signature-type" data-tsd-kind="Interface">Session</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L151">SASViyaApiClient.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a session on the given context.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the context to create a session on.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Session.html" class="tsd-signature-type" data-tsd-kind="Interface">Session</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<wbr/>Client<a href="#deleteClient" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Client<span class="tsd-signature-symbol">(</span>clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L569">SASViyaApiClient.ts:569</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Deletes the client representing the supplied ID.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>clientId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the client ID to authenticate with.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteComputeContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<wbr/>Compute<wbr/>Context<a href="#deleteComputeContext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Compute<wbr/>Context<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L252">SASViyaApiClient.ts:252</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Deletes a compute context on the given server.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the context to be deleted.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<wbr/>Folder<a href="#deleteFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Folder<span class="tsd-signature-symbol">(</span>folderPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L1045">SASViyaApiClient.ts:1045</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>For performance (and in case of accidental error) the <code>deleteFolder</code> function does not actually delete the folder (and all its content and subfolder content). Instead the folder is simply moved to the recycle bin. Deletion time will be added to the folder name.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>folderPath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the full path (eg <code>/Public/example/deleteThis</code>) of the folder to be deleted.</p>
|
|
</div></div></li><li><h5>accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="editComputeContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link">edit<wbr/>Compute<wbr/>Context<a href="#editComputeContext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">edit<wbr/>Compute<wbr/>Context<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, editedContext<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.EditContextInput.html" class="tsd-signature-type" data-tsd-kind="Interface">EditContextInput</a>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L235">SASViyaApiClient.ts:235</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Updates a compute context on the given server.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the original name of the context to be updated.</p>
|
|
</div></div></li><li><h5>editedContext: <a href="../interfaces/types.EditContextInput.html" class="tsd-signature-type" data-tsd-kind="Interface">EditContextInput</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an object with the properties to be updated.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="executeComputeJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link">execute<wbr/>Compute<wbr/>Job<a href="#executeComputeJob" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">execute<wbr/>Compute<wbr/>Job<span class="tsd-signature-symbol">(</span>sasJob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, authConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AuthConfig</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, expectWebout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.PollOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PollOptions</a>, printPid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, variables<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MacroVar</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L594">SASViyaApiClient.ts:594</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Executes a job via the SAS Viya Compute API.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sasJob: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the relative path to the job.</p>
|
|
</div></div></li><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the context where the job is to be executed.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> debug: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>sets the _debug flag in the job arguments.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>any data to be passed in as input to the job.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> authConfig: <span class="tsd-signature-type">AuthConfig</span></h5></li><li><h5>waitForResult: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>a boolean indicating if the function should wait for a result.</p>
|
|
</div></div></li><li><h5>expectWebout: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>a boolean indicating whether to expect a _webout response.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> pollOptions: <a href="../interfaces/types.PollOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PollOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.</p>
|
|
</div></div></li><li><h5>printPid: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>a boolean that indicates whether the function should print (PID) of the started job.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> variables: <span class="tsd-signature-type">MacroVar</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an object that represents macro variables.</p>
|
|
</div></div></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="executeJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link">execute<wbr/>Job<a href="#executeJob" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">execute<wbr/>Job<span class="tsd-signature-symbol">(</span>sasJob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, debug<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, authConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AuthConfig</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-symbol">{ </span>log<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>result<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L695">SASViyaApiClient.ts:695</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Executes a job via the SAS Viya Job Execution API</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sasJob: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the relative or absolute path to the job.</p>
|
|
</div></div></li><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the context where the job is to be executed.</p>
|
|
</div></div></li><li><h5>debug: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>sets the _debug flag in the job arguments.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>any data to be passed in as input to the job.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> authConfig: <span class="tsd-signature-type">AuthConfig</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>log<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>result<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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="executeScript" class="tsd-anchor"></a><h3 class="tsd-anchor-link">execute<wbr/>Script<a href="#executeScript" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">execute<wbr/>Script<span class="tsd-signature-symbol">(</span>jobPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, linesOfCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AuthConfig</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span>, debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, expectWebout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.PollOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PollOptions</a>, printPid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, variables<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MacroVar</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L273">SASViyaApiClient.ts:273</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Executes code on the current SAS Viya server.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jobPath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the path to the file being submitted for execution.</p>
|
|
</div></div></li><li><h5>linesOfCode: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an array of code lines to execute.</p>
|
|
</div></div></li><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the context to execute the code in.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> authConfig: <span class="tsd-signature-type">AuthConfig</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an object containing an access token, refresh token, client ID and secret.</p>
|
|
</div></div></li><li><h5>data: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>execution data.</p>
|
|
</div></div></li><li><h5>debug: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>when set to true, the log will be returned.</p>
|
|
</div></div></li><li><h5>expectWebout: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).</p>
|
|
</div></div></li><li><h5>waitForResult: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>when set to true, function will return the session</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> pollOptions: <a href="../interfaces/types.PollOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PollOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.</p>
|
|
</div></div></li><li><h5>printPid: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>a boolean that indicates whether the function should print (PID) of the started job.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> variables: <span class="tsd-signature-type">MacroVar</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an object that represents macro variables.</p>
|
|
</div></div></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAccessToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Access<wbr/>Token<a href="#getAccessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Access<wbr/>Token<span class="tsd-signature-symbol">(</span>clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientSecret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SasAuthResponse</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L532">SASViyaApiClient.ts:532</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Exchanges the auth code for an access token for the given client.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>clientId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the client ID to authenticate with.</p>
|
|
</div></div></li><li><h5>clientSecret: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the client secret to authenticate with.</p>
|
|
</div></div></li><li><h5>authCode: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the auth code received from the server.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SasAuthResponse</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAuthCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Auth<wbr/>Code<a href="#getAuthCode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Auth<wbr/>Code<span class="tsd-signature-symbol">(</span>clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L489">SASViyaApiClient.ts:489</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Performs a login redirect and returns an auth code for the given client.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>clientId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the client ID to authenticate with.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getComputeContextById" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id<a href="#getComputeContextById" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id<span class="tsd-signature-symbol">(</span>contextId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.ContextAllAttributes.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextAllAttributes</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L930">SASViyaApiClient.ts:930</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a JSON representation of a compute context.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>contextId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an id of the context to return.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.ContextAllAttributes.html" class="tsd-signature-type" data-tsd-kind="Interface">ContextAllAttributes</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getComputeContextByName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name<a href="#getComputeContextByName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L915">SASViyaApiClient.ts:915</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a JSON representation of a compute context.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>example:</dt><dd><p>{ "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>contextName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the context to return.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getComputeContexts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Compute<wbr/>Contexts<a href="#getComputeContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Compute<wbr/>Contexts<span class="tsd-signature-symbol">(</span>accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>version<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><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L114">SASViyaApiClient.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns all available compute contexts on this server.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>version<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><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Config<a href="#getConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Config<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>rootFolderName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>serverUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L93">SASViyaApiClient.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns an object containing the server URL and root folder name.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>rootFolderName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>serverUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>root<wbr/>Folder<wbr/>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>server<wbr/>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getDefaultComputeContexts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Default<wbr/>Compute<wbr/>Contexts<a href="#getDefaultComputeContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Default<wbr/>Compute<wbr/>Contexts<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L121">SASViyaApiClient.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns default(system) compute contexts.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getExecutableContexts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Executable<wbr/>Contexts<a href="#getExecutableContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Executable<wbr/>Contexts<span class="tsd-signature-symbol">(</span>authConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AuthConfig</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><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L137">SASViyaApiClient.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns all compute contexts on this server that the user has access to.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> authConfig: <span class="tsd-signature-type">AuthConfig</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token, refresh token, client and secret for an authorized user.</p>
|
|
</div></div></li></ul><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><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Folder<a href="#getFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Folder<span class="tsd-signature-symbol">(</span>folderPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L309">SASViyaApiClient.ts:309</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Fetches a folder. Path to the folder is required.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>folderPath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the absolute path to the folder.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getJobsInFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Jobs<wbr/>In<wbr/>Folder<a href="#getJobsInFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Jobs<wbr/>In<wbr/>Folder<span class="tsd-signature-symbol">(</span>folderPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Job.html" class="tsd-signature-type" data-tsd-kind="Interface">Job</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L78">SASViyaApiClient.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a list of jobs in the currently set root folder.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>folderPath: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Job.html" class="tsd-signature-type" data-tsd-kind="Interface">Job</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLauncherContexts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Launcher<wbr/>Contexts<a href="#getLauncherContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Launcher<wbr/>Contexts<span class="tsd-signature-symbol">(</span>accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>version<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><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L129">SASViyaApiClient.ts:129</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns all available launcher contexts on this server.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for an authorized user.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>version<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><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="listFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<wbr/>Folder<a href="#listFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<wbr/>Folder<span class="tsd-signature-symbol">(</span>sourceFolder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L945">SASViyaApiClient.ts:945</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Lists children folders for given Viya folder.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sourceFolder: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the full path (eg <code>/Public/example/myFolder</code>) or URI of the source folder listed. Providing URI instead of path will save one extra request.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 20</span></h5></li></ul><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><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="moveFolder" class="tsd-anchor"></a><h3 class="tsd-anchor-link">move<wbr/>Folder<a href="#moveFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">move<wbr/>Folder<span class="tsd-signature-symbol">(</span>sourceFolder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, targetParentFolder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, targetFolderName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L974">SASViyaApiClient.ts:974</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Moves Viya folder to a new location. The folder may be renamed at the same time.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sourceFolder: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the full path (eg <code>/Public/example/myFolder</code>) or URI of the source folder to be moved. Providing URI instead of path will save one extra request.</p>
|
|
</div></div></li><li><h5>targetParentFolder: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the full path or URI of the <em>parent</em> folder to which the <code>sourceFolder</code> will be moved (eg <code>/Public/newDestination</code>). To move a folder, a user has to have write permissions in targetParentFolder. Providing URI instead of the path will save one extra request.</p>
|
|
</div></div></li><li><h5>targetFolderName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name of the "moved" folder. If left blank, the original folder name will be used (eg <code>myFolder</code> in <code>/Public/newDestination/myFolder</code> for the example above). Optional field.</p>
|
|
</div></div></li><li><h5>accessToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="refreshTokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link">refresh<wbr/>Tokens<a href="#refreshTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">refresh<wbr/>Tokens<span class="tsd-signature-symbol">(</span>clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientSecret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, refreshToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SasAuthResponse</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L551">SASViyaApiClient.ts:551</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Exchanges the refresh token for an access token for the given client.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>clientId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the client ID to authenticate with.</p>
|
|
</div></div></li><li><h5>clientSecret: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the client secret to authenticate with.</p>
|
|
</div></div></li><li><h5>refreshToken: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the refresh token received from the server.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SasAuthResponse</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Config<a href="#setConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Config<span class="tsd-signature-symbol">(</span>serverUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, rootFolderName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sasjs/adapter/blob/1ee07ee/src/SASViyaApiClient.ts#L105">SASViyaApiClient.ts:105</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Updates server URL and root folder name, if it was not set.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>serverUrl: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the URL of the server.</p>
|
|
</div></div></li><li><h5>rootFolderName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>the name for root folder.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/SAS9ApiClient.html">SAS9<wbr/>Api<wbr/>Client</a></li><li class="current tsd-kind-module"><a href="../modules/SASViyaApiClient.html">SASViya<wbr/>Api<wbr/>Client</a></li><li class=" tsd-kind-module"><a href="../modules/SASjs.html">SASjs</a></li><li class=" tsd-kind-module"><a href="../modules/SASjsApiClient.html">SASjs<wbr/>Api<wbr/>Client</a></li><li class=" tsd-kind-module"><a href="../modules/types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="SASViyaApiClient.SASViyaApiClient-1.html" class="tsd-kind-icon">SASViya<wbr/>Api<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#appendRequest" class="tsd-kind-icon">append<wbr/>Request</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createComputeContext" class="tsd-kind-icon">create<wbr/>Compute<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createFile" class="tsd-kind-icon">create<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createFolder" class="tsd-kind-icon">create<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createJobDefinition" class="tsd-kind-icon">create<wbr/>Job<wbr/>Definition</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createLauncherContext" class="tsd-kind-icon">create<wbr/>Launcher<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#createSession" class="tsd-kind-icon">create<wbr/>Session</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#deleteClient" class="tsd-kind-icon">delete<wbr/>Client</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#deleteComputeContext" class="tsd-kind-icon">delete<wbr/>Compute<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#deleteFolder" class="tsd-kind-icon">delete<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#editComputeContext" class="tsd-kind-icon">edit<wbr/>Compute<wbr/>Context</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#executeComputeJob" class="tsd-kind-icon">execute<wbr/>Compute<wbr/>Job</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#executeJob" class="tsd-kind-icon">execute<wbr/>Job</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#executeScript" class="tsd-kind-icon">execute<wbr/>Script</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getAccessToken" class="tsd-kind-icon">get<wbr/>Access<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getAuthCode" class="tsd-kind-icon">get<wbr/>Auth<wbr/>Code</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getComputeContextById" class="tsd-kind-icon">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getComputeContextByName" class="tsd-kind-icon">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getComputeContexts" class="tsd-kind-icon">get<wbr/>Compute<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getConfig" class="tsd-kind-icon">get<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getDefaultComputeContexts" class="tsd-kind-icon">get<wbr/>Default<wbr/>Compute<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getExecutableContexts" class="tsd-kind-icon">get<wbr/>Executable<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getFolder" class="tsd-kind-icon">get<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getJobsInFolder" class="tsd-kind-icon">get<wbr/>Jobs<wbr/>In<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#getLauncherContexts" class="tsd-kind-icon">get<wbr/>Launcher<wbr/>Contexts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#listFolder" class="tsd-kind-icon">list<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#moveFolder" class="tsd-kind-icon">move<wbr/>Folder</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#refreshTokens" class="tsd-kind-icon">refresh<wbr/>Tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="SASViyaApiClient.SASViyaApiClient-1.html#setConfig" class="tsd-kind-icon">set<wbr/>Config</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |