363 lines
100 KiB
HTML
363 lines
100 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OnspringClient | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
|
|
@media (prefers-color-scheme: dark) {
|
|
:root {
|
|
--md-sys-color-primary: #adc6ff;
|
|
--md-sys-color-on-primary: #002e6a;
|
|
--md-sys-color-primary-container: #10448f;
|
|
--md-sys-color-on-primary-container: #d8e2ff;
|
|
--md-sys-color-secondary: #bfc6dc;
|
|
--md-sys-color-on-secondary: #293041;
|
|
--md-sys-color-secondary-container: #3f4759;
|
|
--md-sys-color-on-secondary-container: #dbe2f9;
|
|
--md-sys-color-tertiary: #debcdf;
|
|
--md-sys-color-on-tertiary: #402843;
|
|
--md-sys-color-tertiary-container: #583e5b;
|
|
--md-sys-color-on-tertiary-container: #fcd7fb;
|
|
--md-sys-color-error: #ffb4ab;
|
|
--md-sys-color-on-error: #690005;
|
|
--md-sys-color-error-container: #93000a;
|
|
--md-sys-color-on-error-container: #ffb4ab;
|
|
--md-sys-color-background: #1b1b1f;
|
|
--md-sys-color-on-background: #e3e2e6;
|
|
--md-sys-color-surface: #1b1b1f;
|
|
--md-sys-color-on-surface: #e3e2e6;
|
|
--md-sys-color-surface-variant: #44474f;
|
|
--md-sys-color-on-surface-variant: #c4c6d0;
|
|
--md-sys-color-outline: #8e9099;
|
|
--md-sys-color-outline-variant: #44474f;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #e3e2e6;
|
|
--md-sys-color-inverse-on-surface: #303034;
|
|
--md-sys-color-inverse-primary: #325da8;
|
|
--md-sys-color-surface-dim: #121316;
|
|
--md-sys-color-surface-bright: #38393c;
|
|
--md-sys-color-surface-container-lowest: #0d0e11;
|
|
--md-sys-color-surface-container-low: #1b1b1f;
|
|
--md-sys-color-surface-container: #1f1f23;
|
|
--md-sys-color-surface-container-high: #292a2d;
|
|
--md-sys-color-surface-container-highest: #343538
|
|
}
|
|
}
|
|
:root[data-theme="dark"] {
|
|
--md-sys-color-primary: #adc6ff;
|
|
--md-sys-color-on-primary: #002e6a;
|
|
--md-sys-color-primary-container: #10448f;
|
|
--md-sys-color-on-primary-container: #d8e2ff;
|
|
--md-sys-color-secondary: #bfc6dc;
|
|
--md-sys-color-on-secondary: #293041;
|
|
--md-sys-color-secondary-container: #3f4759;
|
|
--md-sys-color-on-secondary-container: #dbe2f9;
|
|
--md-sys-color-tertiary: #debcdf;
|
|
--md-sys-color-on-tertiary: #402843;
|
|
--md-sys-color-tertiary-container: #583e5b;
|
|
--md-sys-color-on-tertiary-container: #fcd7fb;
|
|
--md-sys-color-error: #ffb4ab;
|
|
--md-sys-color-on-error: #690005;
|
|
--md-sys-color-error-container: #93000a;
|
|
--md-sys-color-on-error-container: #ffb4ab;
|
|
--md-sys-color-background: #1b1b1f;
|
|
--md-sys-color-on-background: #e3e2e6;
|
|
--md-sys-color-surface: #1b1b1f;
|
|
--md-sys-color-on-surface: #e3e2e6;
|
|
--md-sys-color-surface-variant: #44474f;
|
|
--md-sys-color-on-surface-variant: #c4c6d0;
|
|
--md-sys-color-outline: #8e9099;
|
|
--md-sys-color-outline-variant: #44474f;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #e3e2e6;
|
|
--md-sys-color-inverse-on-surface: #303034;
|
|
--md-sys-color-inverse-primary: #325da8;
|
|
--md-sys-color-surface-dim: #121316;
|
|
--md-sys-color-surface-bright: #38393c;
|
|
--md-sys-color-surface-container-lowest: #0d0e11;
|
|
--md-sys-color-surface-container-low: #1b1b1f;
|
|
--md-sys-color-surface-container: #1f1f23;
|
|
--md-sys-color-surface-container-high: #292a2d;
|
|
--md-sys-color-surface-container-highest: #343538
|
|
}
|
|
|
|
@media (prefers-color-scheme: light) {
|
|
:root {
|
|
--md-sys-color-primary: #325da8;
|
|
--md-sys-color-on-primary: #ffffff;
|
|
--md-sys-color-primary-container: #d8e2ff;
|
|
--md-sys-color-on-primary-container: #001a42;
|
|
--md-sys-color-secondary: #575e71;
|
|
--md-sys-color-on-secondary: #ffffff;
|
|
--md-sys-color-secondary-container: #dbe2f9;
|
|
--md-sys-color-on-secondary-container: #141b2c;
|
|
--md-sys-color-tertiary: #715573;
|
|
--md-sys-color-on-tertiary: #ffffff;
|
|
--md-sys-color-tertiary-container: #fcd7fb;
|
|
--md-sys-color-on-tertiary-container: #29132d;
|
|
--md-sys-color-error: #ba1a1a;
|
|
--md-sys-color-on-error: #ffffff;
|
|
--md-sys-color-error-container: #ffdad6;
|
|
--md-sys-color-on-error-container: #410002;
|
|
--md-sys-color-background: #fefbff;
|
|
--md-sys-color-on-background: #1b1b1f;
|
|
--md-sys-color-surface: #fefbff;
|
|
--md-sys-color-on-surface: #1b1b1f;
|
|
--md-sys-color-surface-variant: #e1e2ec;
|
|
--md-sys-color-on-surface-variant: #44474f;
|
|
--md-sys-color-outline: #75777f;
|
|
--md-sys-color-outline-variant: #c4c6d0;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #303034;
|
|
--md-sys-color-inverse-on-surface: #f2f0f4;
|
|
--md-sys-color-inverse-primary: #adc6ff;
|
|
--md-sys-color-surface-dim: #dbd9dd;
|
|
--md-sys-color-surface-bright: #faf8fd;
|
|
--md-sys-color-surface-container-lowest: #ffffff;
|
|
--md-sys-color-surface-container-low: #f5f3f7;
|
|
--md-sys-color-surface-container: #efedf1;
|
|
--md-sys-color-surface-container-high: #e9e7ec;
|
|
--md-sys-color-surface-container-highest: #e3e2e6
|
|
}
|
|
}
|
|
:root[data-theme="light"] {
|
|
--md-sys-color-primary: #325da8;
|
|
--md-sys-color-on-primary: #ffffff;
|
|
--md-sys-color-primary-container: #d8e2ff;
|
|
--md-sys-color-on-primary-container: #001a42;
|
|
--md-sys-color-secondary: #575e71;
|
|
--md-sys-color-on-secondary: #ffffff;
|
|
--md-sys-color-secondary-container: #dbe2f9;
|
|
--md-sys-color-on-secondary-container: #141b2c;
|
|
--md-sys-color-tertiary: #715573;
|
|
--md-sys-color-on-tertiary: #ffffff;
|
|
--md-sys-color-tertiary-container: #fcd7fb;
|
|
--md-sys-color-on-tertiary-container: #29132d;
|
|
--md-sys-color-error: #ba1a1a;
|
|
--md-sys-color-on-error: #ffffff;
|
|
--md-sys-color-error-container: #ffdad6;
|
|
--md-sys-color-on-error-container: #410002;
|
|
--md-sys-color-background: #fefbff;
|
|
--md-sys-color-on-background: #1b1b1f;
|
|
--md-sys-color-surface: #fefbff;
|
|
--md-sys-color-on-surface: #1b1b1f;
|
|
--md-sys-color-surface-variant: #e1e2ec;
|
|
--md-sys-color-on-surface-variant: #44474f;
|
|
--md-sys-color-outline: #75777f;
|
|
--md-sys-color-outline-variant: #c4c6d0;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #303034;
|
|
--md-sys-color-inverse-on-surface: #f2f0f4;
|
|
--md-sys-color-inverse-primary: #adc6ff;
|
|
--md-sys-color-surface-dim: #dbd9dd;
|
|
--md-sys-color-surface-bright: #faf8fd;
|
|
--md-sys-color-surface-container-lowest: #ffffff;
|
|
--md-sys-color-surface-container-low: #f5f3f7;
|
|
--md-sys-color-surface-container: #efedf1;
|
|
--md-sys-color-surface-container-high: #e9e7ec;
|
|
--md-sys-color-surface-container-highest: #e3e2e6
|
|
}
|
|
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="OnspringClient.html">OnspringClient</a></li></ul><h1>Class OnspringClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>OnspringClient - A client that can communicate with the Onspring API.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:38</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="OnspringClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="OnspringClient.html#_client" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_client</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="OnspringClient.html#addOrUpdateListItem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span></a>
|
|
<a href="OnspringClient.html#canConnect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Connect</span></a>
|
|
<a href="OnspringClient.html#delete" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a>
|
|
<a href="OnspringClient.html#deleteFileById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>File<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#deleteListItemById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#deleteRecordById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#deleteRecordsByIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span></a>
|
|
<a href="OnspringClient.html#get" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a>
|
|
<a href="OnspringClient.html#getAppById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>App<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getApps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps</span></a>
|
|
<a href="OnspringClient.html#getAppsByIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps<wbr/>By<wbr/>Ids</span></a>
|
|
<a href="OnspringClient.html#getFieldById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Field<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getFieldsByAppId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getFieldsByIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Fields<wbr/>By<wbr/>Ids</span></a>
|
|
<a href="OnspringClient.html#getFileById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>File<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getFileInfoById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getRecordById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Record<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getRecordsByAppId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getRecordsByIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>By<wbr/>Ids</span></a>
|
|
<a href="OnspringClient.html#getReportById" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Report<wbr/>By<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#getReportsByAppId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span></a>
|
|
<a href="OnspringClient.html#post" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post</span></a>
|
|
<a href="OnspringClient.html#put" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put</span></a>
|
|
<a href="OnspringClient.html#queryRecords" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Records</span></a>
|
|
<a href="OnspringClient.html#saveFile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>File</span></a>
|
|
<a href="OnspringClient.html#saveRecord" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Record</span></a>
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_OnspringClient" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Onspring<wbr/>Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">baseUrl</span>, <span class="tsd-kind-parameter">apiKey</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="OnspringClient.html" class="tsd-signature-type tsd-kind-class">OnspringClient</a><a href="#constructor.new_OnspringClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">baseUrl</span>: <span class="tsd-signature-type">undefined</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><div class="tsd-comment tsd-typography"><p>The base url that will be used to make requests to the Onspring API.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">apiKey</span>: <span class="tsd-signature-type">undefined</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><div class="tsd-comment tsd-typography"><p>The api key that will be used to authorize requests made by this client.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">CreateAxiosDefaults</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></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="OnspringClient.html" class="tsd-signature-type tsd-kind-class">OnspringClient</a></h4><ul>
|
|
<li>A new instance of the OnspringClient class.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Throws</h4><ul>
|
|
<li>Thrown when the baseUrl is not a valid url.</li>
|
|
</ul>
|
|
<h4>Throws</h4><ul>
|
|
<li>Thrown when the apiKey is null/undefined/empty/whitespace.</li>
|
|
</ul>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:52</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="_client" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>_client</span><a href="#_client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span></div><div class="tsd-comment tsd-typography"><p>client - The axios instance that will be used to make requests to the Onspring API.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:42</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addOrUpdateListItem" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><a href="#addOrUpdateListItem" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addOrUpdateListItem.addOrUpdateListItem-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listItemRequest</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#addOrUpdateListItem.addOrUpdateListItem-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">listItemRequest</span>: <a href="ListItemRequest.html" class="tsd-signature-type tsd-kind-class">ListItemRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to add or update the list item.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type ListItemResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>addOrUpdateListItem - Adds or updates a list item depending on if an id is provided or not.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:312</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="canConnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Connect</span><a href="#canConnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="canConnect.canConnect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#canConnect.canConnect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to a boolean indicating if the client can connect to the Onspring API.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>canConnect - Determines if the client can connect to the Onspring API.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:88</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">config</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="delete.delete-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#delete.delete-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type T.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>delete - Makes a DELETE request to the specified endpoint.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:588</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteFileById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>File<wbr/>By<wbr/>Id</span><a href="#deleteFileById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteFileById.deleteFileById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>File<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteFileById.deleteFileById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is held on.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field that the file is held in.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file to delete.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><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><ul>
|
|
<li>A promise that resolves to an ApiResponse of type any.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteFileById - Deletes a file by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:292</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteListItemById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><a href="#deleteListItemById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteListItemById.deleteListItemById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">listId</span>, <span class="tsd-kind-parameter">itemId</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteListItemById.deleteListItemById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">listId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the list that the list item belongs to.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">itemId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the list item to delete.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><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><ul>
|
|
<li>A promise that resolves to an ApiResponse of type any.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteListItemById - Deletes a list item by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:334</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteRecordById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span><a href="#deleteRecordById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteRecordById.deleteRecordById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Record<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteRecordById.deleteRecordById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app that the record belongs to.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record to delete.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><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><ul>
|
|
<li>A promise that resolves to an ApiResponse of type any.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteRecordById - Deletes a record by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:455</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteRecordsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span><a href="#deleteRecordsByIds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteRecordsByIds.deleteRecordsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Records<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordIds</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#deleteRecordsByIds.deleteRecordsByIds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app that the records belong to.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the records to delete.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><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><ul>
|
|
<li>A promise that resolves to an ApiResponse of type any.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>deleteRecordsByIds - Deletes records by their ids.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:473</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">config</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="get.get-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#get.get-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type T.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>get - Makes a GET request to the specified endpoint.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:539</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>App<wbr/>By<wbr/>Id</span><a href="#getAppById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAppById.getAppById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>App<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAppById.getAppById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type App.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAppById - Gets an app by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:119</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getApps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Apps</span><a href="#getApps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getApps.getApps-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pagingRequest</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getApps.getApps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pagingRequest</span>: <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The paging request that will be used to get the apps.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type GetPagedAppsResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getApps - Gets a paged list of apps.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:100</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAppsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Apps<wbr/>By<wbr/>Ids</span><a href="#getAppsByIds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAppsByIds.getAppsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Apps<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appIds</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getAppsByIds.getAppsByIds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the apps to get.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type CollectionResponse<App>.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getAppsByIds - Gets a list of apps by their ids.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:136</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Field<wbr/>By<wbr/>Id</span><a href="#getFieldById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFieldById.getFieldById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldId</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldById.getFieldById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field to get.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type Field.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldById - Gets a field by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:155</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getFieldsByAppId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFieldsByAppId.getFieldsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">pagingRequest</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldsByAppId.getFieldsByAppId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get the fields for.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pagingRequest</span>: <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The paging request that will be used to get the fields.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type GetPagedFieldsResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldsByAppId - Gets a paged list of fields by an app id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:191</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFieldsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Fields<wbr/>By<wbr/>Ids</span><a href="#getFieldsByIds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFieldsByIds.getFieldsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldIds</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFieldsByIds.getFieldsByIds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fieldIds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The ids of the fields to get.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type CollectionResponse<Field>.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldsByIds - Gets a list of fields by their ids.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:171</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>By<wbr/>Id</span><a href="#getFileById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFileById.getFileById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFileById.getFileById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field that the file is attached to.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file to get.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type File.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFileById - Gets a file by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:240</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFileInfoById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><a href="#getFileInfoById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFileInfoById.getFileInfoById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">fileId</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getFileInfoById.getFileInfoById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field that the file is attached to.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the file to get the information for.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type FileInfo.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFileInfoById - Gets a file's information by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:213</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Record<wbr/>By<wbr/>Id</span><a href="#getRecordById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRecordById.getRecordById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getRecordById.getRecordById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="GetRecordRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the record.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type Record.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordById - Gets a record by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:372</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getRecordsByAppId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRecordsByAppId.getRecordsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getRecordsByAppId.getRecordsByAppId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="GetRecordsByAppIdRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsByAppIdRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type GetPagedRecordsResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByAppId - Gets records by an app id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:348</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRecordsByIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>Ids</span><a href="#getRecordsByIds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRecordsByIds.getRecordsByIds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>Ids</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getRecordsByIds.getRecordsByIds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="GetRecordsRequest.html" class="tsd-signature-type tsd-kind-class">GetRecordsRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol"><</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type CollectionResponse of type Record.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByIds - Gets records by their ids.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:392</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportById" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Report<wbr/>By<wbr/>Id</span><a href="#getReportById" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getReportById.getReportById-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Report<wbr/>By<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reportId</span>, <span class="tsd-kind-parameter">apiDataFormat</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">dataType</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getReportById.getReportById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">reportId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the report to get.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">apiDataFormat</span>: <a href="../enums/DataFormat.html" class="tsd-signature-type tsd-kind-enum">DataFormat</a><span class="tsd-signature-symbol"> = DataFormat.Raw</span></span><div class="tsd-comment tsd-typography"><p>The data format that the report data will be returned in.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">dataType</span>: <a href="../enums/ReportDataType.html" class="tsd-signature-type tsd-kind-enum">ReportDataType</a><span class="tsd-signature-symbol"> = ReportDataType.ReportData</span></span><div class="tsd-comment tsd-typography"><p>The type of data that will be returned.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type ReportData.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getReportById - Gets a report by its id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:513</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getReportsByAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><a href="#getReportsByAppId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getReportsByAppId.getReportsByAppId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">pagingRequest</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#getReportsByAppId.getReportsByAppId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app to get the reports for.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pagingRequest</span>: <a href="PagingRequest.html" class="tsd-signature-type tsd-kind-class">PagingRequest</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The paging request that will be used to get the reports.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type GetPagedReportsResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getReportsByAppId - Gets a paged list of reports by the app id.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:491</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="post" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>post</span><a href="#post" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="post.post-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">post</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">config</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#post.post-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="post.post-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The data that will be sent with the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#post.post-1.T-2">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type T.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>post - Makes a POST request to the specified endpoint.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:555</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="put" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>put</span><a href="#put" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private"><li class="tsd-signature tsd-anchor-link"><a id="put.put-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">put</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">endpoint</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">config</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#put.put-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="put.put-1.T-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The data that will be sent with the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OnspringClient.html#put.put-1.T-3">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type T.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>put - Makes a PUT request to the specified endpoint.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:572</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="queryRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Records</span><a href="#queryRecords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="queryRecords.queryRecords-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">query<wbr/>Records</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#queryRecords.queryRecords-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="QueryRecordsRequest.html" class="tsd-signature-type tsd-kind-class">QueryRecordsRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to query for records.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type GetPagedRecordsResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordsByQuery - Gets records by a query.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:410</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>File</span><a href="#saveFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="saveFile.saveFile-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><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-symbol">></span><a href="#saveFile.saveFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="SaveFileRequest.html" class="tsd-signature-type tsd-kind-class">SaveFileRequest</a></span><div class="tsd-comment tsd-typography"><p>The request that will be used to save the file.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><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-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type CreatedWithIdResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>saveFile - Saves a file to a record in Onspring.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:269</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveRecord" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Record</span><a href="#saveRecord" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="saveRecord.saveRecord-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Record</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</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="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#saveRecord.saveRecord-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><span class="tsd-signature-symbol"> | </span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a></span><div class="tsd-comment tsd-typography"><p>The record or request that will be used to save the record.</p>
|
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><ul>
|
|
<li>A promise that resolves to an ApiResponse of type SaveRecordResponse.</li>
|
|
</ul>
|
|
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>saveRecord - Saves a record.</p>
|
|
</div><aside class="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:431</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#_client" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_client</span></a><a href="#addOrUpdateListItem" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span></a><a href="#canConnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Connect</span></a><a href="#delete" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#deleteFileById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>File<wbr/>By<wbr/>Id</span></a><a href="#deleteListItemById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span></a><a href="#deleteRecordById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span></a><a href="#deleteRecordsByIds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span></a><a href="#get" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#getAppById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>App<wbr/>By<wbr/>Id</span></a><a href="#getApps" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps</span></a><a href="#getAppsByIds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Apps<wbr/>By<wbr/>Ids</span></a><a href="#getFieldById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Field<wbr/>By<wbr/>Id</span></a><a href="#getFieldsByAppId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span></a><a href="#getFieldsByIds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Fields<wbr/>By<wbr/>Ids</span></a><a href="#getFileById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>File<wbr/>By<wbr/>Id</span></a><a href="#getFileInfoById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span></a><a href="#getRecordById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Record<wbr/>By<wbr/>Id</span></a><a href="#getRecordsByAppId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span></a><a href="#getRecordsByIds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Records<wbr/>By<wbr/>Ids</span></a><a href="#getReportById" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Report<wbr/>By<wbr/>Id</span></a><a href="#getReportsByAppId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span></a><a href="#post" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post</span></a><a href="#put" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put</span></a><a href="#queryRecords" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Records</span></a><a href="#saveFile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>File</span></a><a href="#saveRecord" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Record</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
|
|
try {
|
|
const generateLinkElement = document.querySelector(".tsd-generator a");
|
|
const link = document.createElement("a");
|
|
Object.assign(link, {
|
|
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
|
target: "_blank",
|
|
rel: "noreferrer",
|
|
innerText: "typedoc-material-theme."
|
|
});
|
|
generateLinkElement.insertAdjacentElement("afterend", link);
|
|
generateLinkElement.insertAdjacentText("afterend", " with ");
|
|
} catch (error) {
|
|
|
|
}
|
|
</script></body></html> |