<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharSet="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>OnspringClient | onspring-api-sdk</title><metaname="description"content="Documentation for onspring-api-sdk"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../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><linkrel="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><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">onspring-api-sdk</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../modules.html">onspring-api-sdk</a></li><li><ahref="OnspringClient.html">OnspringClient</a></li></ul><h1>Class OnspringClient</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>OnspringClient - A client that can communicate with the Onspring API.</p>
</div></section></div></details></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Constructors</h2><sectionclass="tsd-panel tsd-member"><aid="constructor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>constructor</span><ahref="#constructor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="constructor.new_OnspringClient"class="tsd-anchor"></a><spanclass="tsd-kind-constructor-signature">new <wbr/>Onspring<wbr/>Client</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">baseUrl</span>, <spanclass="tsd-kind-parameter">apiKey</span>, <spanclass="tsd-kind-parameter">config</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="OnspringClient.html"class="tsd-signature-type tsd-kind-class">OnspringClient</a><ahref="#constructor.new_OnspringClient"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">baseUrl</span>: <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The base url that will be used to make requests to the Onspring API.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">apiKey</span>: <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The api key that will be used to authorize requests made by this client.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:52</li></ul></aside></li></ul></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Properties</h2><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="_client"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><codeclass="tsd-tag ts-flagReadonly">Readonly</code><span>_client</span><ahref="#_client"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">_client</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">AxiosInstance</span></div><divclass="tsd-comment tsd-typography"><p>client - The axios instance that will be used to make requests to the Onspring API.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:42</li></ul></aside></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Methods</h2><sectionclass="tsd-panel tsd-member"><aid="addOrUpdateListItem"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><ahref="#addOrUpdateListItem"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="addOrUpdateListItem.addOrUpdateListItem-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add<wbr/>Or<wbr/>Update<wbr/>List<wbr/>Item</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">listItemRequest</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="ListItemResponse.html"class="tsd-signature-type tsd-kind-class">ListItemResponse</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#addOrUpdateListItem.addOrUpdateListItem-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">listItemRequest</span>: <ahref="ListItemRequest.html"class="tsd-signature-type tsd-kind-class">ListItemRequest</a></span><divclass="tsd-comment tsd-typography"><p>The request that will be used to add or update the list item.</p>
<li>A promise that resolves to an ApiResponse of type ListItemResponse.</li>
</ul>
<divclass="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><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:88</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="delete"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>delete</span><ahref="#delete"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-private"><liclass="tsd-signature tsd-anchor-link"><aid="delete.delete-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">delete</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#delete.delete-1.T">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">endpoint</span>, <spanclass="tsd-kind-parameter">config</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#delete.delete-1.T">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#delete.delete-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="delete.delete-1.T"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">endpoint</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">config</span>: <spanclass="tsd-signature-type">AxiosRequestConfig</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol"> = {}</span></span><divclass="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:588</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="deleteFileById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>delete<wbr/>File<wbr/>By<wbr/>Id</span><ahref="#deleteFileById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="deleteFileById.deleteFileById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">delete<wbr/>File<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">recordId</span>, <spanclass="tsd-kind-parameter">fieldId</span>, <spanclass="tsd-kind-parameter">fileId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#deleteFileById.deleteFileById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">recordId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the record that the file is held on.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">fieldId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the field that the file is held in.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">fileId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the file to delete.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:292</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="deleteListItemById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><ahref="#deleteListItemById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="deleteListItemById.deleteListItemById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">delete<wbr/>List<wbr/>Item<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">listId</span>, <spanclass="tsd-kind-parameter">itemId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#deleteListItemById.deleteListItemById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">listId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the list that the list item belongs to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">itemId</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The id of the list item to delete.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:334</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="deleteRecordById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>delete<wbr/>Record<wbr/>By<wbr/>Id</span><ahref="#deleteRecordById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="deleteRecordById.deleteRecordById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">delete<wbr/>Record<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">appId</span>, <spanclass="tsd-kind-parameter">recordId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#deleteRecordById.deleteRecordById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">appId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the app that the record belongs to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">recordId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the record to delete.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:455</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="deleteRecordsByIds"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>delete<wbr/>Records<wbr/>By<wbr/>Ids</span><ahref="#deleteRecordsByIds"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="deleteRecordsByIds.deleteRecordsByIds-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">delete<wbr/>Records<wbr/>By<wbr/>Ids</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">appId</span>, <spanclass="tsd-kind-parameter">recordIds</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#deleteRecordsByIds.deleteRecordsByIds-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">appId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the app that the records belong to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">recordIds</span>: <spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The ids of the records to delete.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:473</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="get"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>get</span><ahref="#get"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-private"><liclass="tsd-signature tsd-anchor-link"><aid="get.get-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#get.get-1.T-1">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">endpoint</span>, <spanclass="tsd-kind-parameter">config</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#get.get-1.T-1">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#get.get-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="get.get-1.T-1"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">endpoint</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">config</span>: <spanclass="tsd-signature-type">AxiosRequestConfig</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol"> = {}</span></span><divclass="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:539</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getAppById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>App<wbr/>By<wbr/>Id</span><ahref="#getAppById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getAppById.getAppById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>App<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">appId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="App.html"class="tsd-signature-type tsd-kind-class">App</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getAppById.getAppById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">appId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the app to get.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:119</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getApps"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Apps</span><ahref="#getApps"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getApps.getApps-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Apps</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">pagingRequest</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="GetPagedAppsResponse.html"class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getApps.getApps-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pagingRequest</span>: <ahref="PagingRequest.html"class="tsd-signature-type tsd-kind-class">PagingRequest</a><spanclass="tsd-signature-symbol"> = ...</span></span><divclass="tsd-comment tsd-typography"><p>The paging request that will be used to get the apps.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:136</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getFieldById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Field<wbr/>By<wbr/>Id</span><ahref="#getFieldById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getFieldById.getFieldById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">fieldId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="Field.html"class="tsd-signature-type tsd-kind-class">Field</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getFieldById.getFieldById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">fieldId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the field to get.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:155</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getFieldsByAppId"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><ahref="#getFieldsByAppId"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getFieldsByAppId.getFieldsByAppId-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Fields<wbr/>By<wbr/>App<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">appId</span>, <spanclass="tsd-kind-parameter">pagingRequest</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="GetPagedFieldsResponse.html"class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getFieldsByAppId.getFieldsByAppId-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">appId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the app to get the fields for.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">pagingRequest</span>: <ahref="PagingRequest.html"class="tsd-signature-type tsd-kind-class">PagingRequest</a><spanclass="tsd-signature-symbol"> = ...</span></span><divclass="tsd-comment tsd-typography"><p>The paging request that will be used to get the fields.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:171</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getFileById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>File<wbr/>By<wbr/>Id</span><ahref="#getFileById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getFileById.getFileById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>File<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">recordId</span>, <spanclass="tsd-kind-parameter">fieldId</span>, <spanclass="tsd-kind-parameter">fileId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="File.html"class="tsd-signature-type tsd-kind-class">File</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getFileById.getFileById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">recordId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">fieldId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the field that the file is attached to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">fileId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the file to get.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:240</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getFileInfoById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><ahref="#getFileInfoById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getFileInfoById.getFileInfoById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>File<wbr/>Info<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">recordId</span>, <spanclass="tsd-kind-parameter">fieldId</span>, <spanclass="tsd-kind-parameter">fileId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="FileInfo.html"class="tsd-signature-type tsd-kind-class">FileInfo</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getFileInfoById.getFileInfoById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">recordId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the record that the file is attached to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">fieldId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the field that the file is attached to.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">fileId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the file to get the information for.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:213</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getRecordById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Record<wbr/>By<wbr/>Id</span><ahref="#getRecordById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getRecordById.getRecordById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Record<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">request</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="Record.html"class="tsd-signature-type tsd-kind-class">Record</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getRecordById.getRecordById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">request</span>: <ahref="GetRecordRequest.html"class="tsd-signature-type tsd-kind-class">GetRecordRequest</a></span><divclass="tsd-comment tsd-typography"><p>The request that will be used to get the record.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:372</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getRecordsByAppId"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><ahref="#getRecordsByAppId"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getRecordsByAppId.getRecordsByAppId-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">request</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="GetPagedRecordsResponse.html"class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getRecordsByAppId.getRecordsByAppId-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">request</span>: <ahref="GetRecordsByAppIdRequest.html"class="tsd-signature-type tsd-kind-class">GetRecordsByAppIdRequest</a></span><divclass="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:348</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getRecordsByIds"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Records<wbr/>By<wbr/>Ids</span><ahref="#getRecordsByIds"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getRecordsByIds.getRecordsByIds-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Records<wbr/>By<wbr/>Ids</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">request</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="CollectionResponse.html"class="tsd-signature-type tsd-kind-class">CollectionResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="Record.html"class="tsd-signature-type tsd-kind-class">Record</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getRecordsByIds.getRecordsByIds-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">request</span>: <ahref="GetRecordsRequest.html"class="tsd-signature-type tsd-kind-class">GetRecordsRequest</a></span><divclass="tsd-comment tsd-typography"><p>The request that will be used to get the records.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:392</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getReportById"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Report<wbr/>By<wbr/>Id</span><ahref="#getReportById"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getReportById.getReportById-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Report<wbr/>By<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">reportId</span>, <spanclass="tsd-kind-parameter">apiDataFormat</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">dataType</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="ReportData.html"class="tsd-signature-type tsd-kind-class">ReportData</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getReportById.getReportById-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">reportId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the report to get.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">apiDataFormat</span>: <ahref="../enums/DataFormat.html"class="tsd-signature-type tsd-kind-enum">DataFormat</a><spanclass="tsd-signature-symbol"> = DataFormat.Raw</span></span><divclass="tsd-comment tsd-typography"><p>The data format that the report data will be returned in.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">dataType</span>: <ahref="../enums/ReportDataType.html"class="tsd-signature-type tsd-kind-enum">ReportDataType</a><spanclass="tsd-signature-symbol"> = ReportDataType.ReportData</span></span><divclass="tsd-comment tsd-typography"><p>The type of data that will be returned.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:513</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getReportsByAppId"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><ahref="#getReportsByAppId"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getReportsByAppId.getReportsByAppId-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Reports<wbr/>By<wbr/>App<wbr/>Id</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">appId</span>, <spanclass="tsd-kind-parameter">pagingRequest</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="GetPagedReportsResponse.html"class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#getReportsByAppId.getReportsByAppId-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">appId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The id of the app to get the reports for.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">pagingRequest</span>: <ahref="PagingRequest.html"class="tsd-signature-type tsd-kind-class">PagingRequest</a><spanclass="tsd-signature-symbol"> = ...</span></span><divclass="tsd-comment tsd-typography"><p>The paging request that will be used to get the reports.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:491</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="post"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>post</span><ahref="#post"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-private"><liclass="tsd-signature tsd-anchor-link"><aid="post.post-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">post</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#post.post-1.T-2">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">endpoint</span>, <spanclass="tsd-kind-parameter">data</span>, <spanclass="tsd-kind-parameter">config</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#post.post-1.T-2">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#post.post-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="post.post-1.T-2"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">endpoint</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">data</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The data that will be sent with the request.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">config</span>: <spanclass="tsd-signature-type">AxiosRequestConfig</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol"> = {}</span></span><divclass="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:555</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="put"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>put</span><ahref="#put"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-private"><liclass="tsd-signature tsd-anchor-link"><aid="put.put-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">put</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#put.put-1.T-3">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">endpoint</span>, <spanclass="tsd-kind-parameter">data</span>, <spanclass="tsd-kind-parameter">config</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="OnspringClient.html#put.put-1.T-3">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#put.put-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="put.put-1.T-3"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">endpoint</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The endpoint that will be used to make the request.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">data</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The data that will be sent with the request.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">config</span>: <spanclass="tsd-signature-type">AxiosRequestConfig</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol"> = {}</span></span><divclass="tsd-comment tsd-typography"><p>The configuration that will be used to make the request.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:572</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="queryRecords"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>query<wbr/>Records</span><ahref="#queryRecords"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="queryRecords.queryRecords-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">query<wbr/>Records</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">request</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="GetPagedRecordsResponse.html"class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#queryRecords.queryRecords-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">request</span>: <ahref="QueryRecordsRequest.html"class="tsd-signature-type tsd-kind-class">QueryRecordsRequest</a></span><divclass="tsd-comment tsd-typography"><p>The request that will be used to query for records.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:410</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="saveFile"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>save<wbr/>File</span><ahref="#saveFile"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="saveFile.saveFile-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">save<wbr/>File</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">request</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="CreatedWithIdResponse.html"class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#saveFile.saveFile-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">request</span>: <ahref="SaveFileRequest.html"class="tsd-signature-type tsd-kind-class">SaveFileRequest</a></span><divclass="tsd-comment tsd-typography"><p>The request that will be used to save the file.</p>
</div><asideclass="tsd-sources"><ul><li>Defined in models/OnspringClient.ts:269</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="saveRecord"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>save<wbr/>Record</span><ahref="#saveRecord"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="saveRecord.saveRecord-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">save<wbr/>Record</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">request</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="ApiResponse.html"class="tsd-signature-type tsd-kind-class">ApiResponse</a><spanclass="tsd-signature-symbol"><</span><ahref="SaveRecordResponse.html"class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#saveRecord.saveRecord-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">request</span>: <ahref="SaveRecordRequest.html"class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><spanclass="tsd-signature-symbol"> | </span><ahref="Record.html"class="tsd-signature-type tsd-kind-class">Record</a></span><divclass="tsd-comment tsd-typography"><p>The record or request that will be used to save the record.</p>
