Stevan/onspring-api-sdk-javascript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
944e84802cdb7ce8cf5725ae88391a741b28a91f
onspring-api-sdk-javascript/docs/classes/ApiResponse.html
T

311 lines
76 KiB
HTML
Raw Normal View History

chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ApiResponse | 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="ApiResponse.html">ApiResponse</a></li></ul><h1>Class ApiResponse&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ApiResponse - A generic response object for API requests.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:53</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="ApiResponse.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>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ApiResponse.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
<a href="ApiResponse.html#isSuccessful" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Successful</span></a>
<a href="ApiResponse.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
<a href="ApiResponse.html#statusCode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Code</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ApiResponse.html#asAppCollectionType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>App<wbr/>Collection<wbr/>Type</span></a>
<a href="ApiResponse.html#asAppType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>App<wbr/>Type</span></a>
<a href="ApiResponse.html#asCreatedWithIdResponseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span></a>
<a href="ApiResponse.html#asFieldCollectionType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Field<wbr/>Collection<wbr/>Type</span></a>
<a href="ApiResponse.html#asFieldType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Field<wbr/>Type</span></a>
<a href="ApiResponse.html#asFileInfoType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>File<wbr/>Info<wbr/>Type</span></a>
<a href="ApiResponse.html#asFileType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>File<wbr/>Type</span></a>
<a href="ApiResponse.html#asGetPagedAppsResponseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Get<wbr/>Paged<wbr/>Apps<wbr/>Response<wbr/>Type</span></a>
<a href="ApiResponse.html#asGetPagedFieldsResponseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Get<wbr/>Paged<wbr/>Fields<wbr/>Response<wbr/>Type</span></a>
<a href="ApiResponse.html#asGetPagedRecordsResponseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Get<wbr/>Paged<wbr/>Records<wbr/>Response<wbr/>Type</span></a>
<a href="ApiResponse.html#asGetPagedReportsResponseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Get<wbr/>Paged<wbr/>Reports<wbr/>Response<wbr/>Type</span></a>
<a href="ApiResponse.html#asListItemResponseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>List<wbr/>Item<wbr/>Response<wbr/>Type</span></a>
<a href="ApiResponse.html#asRecordCollectionType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Record<wbr/>Collection<wbr/>Type</span></a>
<a href="ApiResponse.html#asRecordType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Record<wbr/>Type</span></a>
<a href="ApiResponse.html#asReportDataType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Report<wbr/>Data<wbr/>Type</span></a>
<a href="ApiResponse.html#asSaveRecordResponseType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Save<wbr/>Record<wbr/>Response<wbr/>Type</span></a>
<a href="ApiResponse.html#convertToAttachment" 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>convert<wbr/>To<wbr/>Attachment</span></a>
<a href="ApiResponse.html#convertToDelegate" 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>convert<wbr/>To<wbr/>Delegate</span></a>
<a href="ApiResponse.html#convertToScoringGroup" 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>convert<wbr/>To<wbr/>Scoring<wbr/>Group</span></a>
<a href="ApiResponse.html#convertToTimeSpanData" 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>convert<wbr/>To<wbr/>Time<wbr/>Span<wbr/>Data</span></a>
<a href="ApiResponse.html#getFieldByType" 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<wbr/>Field<wbr/>By<wbr/>Type</span></a>
<a href="ApiResponse.html#getListValues" 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<wbr/>List<wbr/>Values</span></a>
<a href="ApiResponse.html#getRecordValueByType" 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<wbr/>Record<wbr/>Value<wbr/>By<wbr/>Type</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_ApiResponse" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Api<wbr/>Response</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">statusCode</span>, <span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_ApiResponse" 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="constructor.new_ApiResponse.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">statusCode</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The status code of the response.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The message of the response.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The data of the response.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<li>A new instance of the ApiResponse class.</li>
</ul>
docs: update docs
2024-07-19 04:16:56 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:81</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" 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">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#constructor.new_ApiResponse.T-1">T</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:72</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isSuccessful" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Successful</span><a href="#isSuccessful" 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">is<wbr/>Successful</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:62</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:67</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="statusCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" 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">status<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:57</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="asAppCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>App<wbr/>Collection<wbr/>Type</span><a href="#asAppCollectionType" 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="asAppCollectionType.asAppCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>App<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#asAppCollectionType.asAppCollectionType-1" aria-label="Permalink" class="t
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse&lt;CollectionResponse<App>&gt;.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAppCollectionType - Converts the ApiResponse to an ApiResponse&lt;CollectionResponse<App>&gt;.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:138</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asAppType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>App<wbr/>Type</span><a href="#asAppType" 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="asAppType.asAppType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>App<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">&gt;</span><a href="#asAppType.asAppType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="App.html" class="tsd-signature-type tsd-kind-class">App</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<App>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asAppType - Converts the ApiResponse to an ApiResponse<App>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:118</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asCreatedWithIdResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span><a href="#asCreatedWithIdResponseType" 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="asCreatedWithIdResponseType.asCreatedWithIdResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#asCreatedWithIdResponseType.asCreatedWithIdResponseType-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="asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ApiResponse.html#asCreatedWithIdResponseType.asCreatedWithIdResponseType-1.T-2">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse&lt;CreatedWithIdResponse<T>&gt;.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asCreatedWithIdResponseType - Converts the ApiResponse to an ApiResponse&lt;CreatedWithIdResponse<T>&gt;.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:225</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFieldCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Field<wbr/>Collection<wbr/>Type</span><a href="#asFieldCollectionType" 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="asFieldCollectionType.asFieldCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Field<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#asFieldCollectionType.asFieldCollectionType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse&lt;CollectionResponse<Field>&gt;.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFieldCollectionType - Converts the ApiResponse to an ApiResponse&lt;CollectionResponse<Field>&gt;.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:176</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFieldType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Field<wbr/>Type</span><a href="#asFieldType" 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="asFieldType.asFieldType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Field<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">&gt;</span><a href="#asFieldType.asFieldType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<Field>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFieldType - Converts the ApiResponse to an ApiResponse<Field>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:161</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFileInfoType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>File<wbr/>Info<wbr/>Type</span><a href="#asFileInfoType" 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="asFileInfoType.asFileInfoType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>File<wbr/>Info<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">&gt;</span><a href="#asFileInfoType.asFileInfoType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="FileInfo.html" class="tsd-signature-type tsd-kind-class">FileInfo</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<FileInfo>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFileInfoType - Converts the ApiResponse to an ApiResponse<FileInfo>.</p>
docs: update docs
2026-03-25 19:54:58 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:245</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asFileType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>File<wbr/>Type</span><a href="#asFileType" 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="asFileType.asFileType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>File<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">&gt;</span><a href="#asFileType.asFileType-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">response</span>: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="File.html" class="tsd-signature-type tsd-kind-class">File</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<File>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asFileType - Converts the ApiResponse to an ApiResponse<File>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:270</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedAppsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Apps<wbr/>Response<wbr/>Type</span><a href="#asGetPagedAppsResponseType" 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="asGetPagedAppsResponseType.asGetPagedAppsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Apps<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#asGetPagedAppsResponseType.asGetPagedAppsResponseType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="GetPagedAppsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedAppsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<GetPagedAppsResponse>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedAppsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedAppsResponse>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:92</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedFieldsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Fields<wbr/>Response<wbr/>Type</span><a href="#asGetPagedFieldsResponseType" 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="asGetPagedFieldsResponseType.asGetPagedFieldsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Fields<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#asGetPagedFieldsResponseType.asGetPagedFieldsResponseType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="GetPagedFieldsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedFieldsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<GetPagedFieldsResponse>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedFieldsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedFieldsResponse>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:199</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedRecordsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Records<wbr/>Response<wbr/>Type</span><a href="#asGetPagedRecordsResponseType" 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="asGetPagedRecordsResponseType.asGetPagedRecordsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Records<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#asGetPagedRecordsResponseType.asGetPagedRecordsResponseType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="GetPagedRecordsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedRecordsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<GetPagedRecordsResponse>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedRecordsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedRecordsResponse>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:368</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asGetPagedReportsResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Get<wbr/>Paged<wbr/>Reports<wbr/>Response<wbr/>Type</span><a href="#asGetPagedReportsResponseType" 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="asGetPagedReportsResponseType.asGetPagedReportsResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Get<wbr/>Paged<wbr/>Reports<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#asGetPagedReportsResponseType.asGetPagedReportsResponseType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="GetPagedReportsResponse.html" class="tsd-signature-type tsd-kind-class">GetPagedReportsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<GetPagedReportsResponse>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asGetPagedReportsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedReportsResponse>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:322</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asListItemResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>List<wbr/>Item<wbr/>Response<wbr/>Type</span><a href="#asListItemResponseType" 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="asListItemResponseType.asListItemResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>List<wbr/>Item<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#asListItemResponseType.asListItemResponseType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<ListItemResponse>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asListItemResponseType - Converts the ApiResponse to an ApiResponse<ListItemResponse>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:306</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asRecordCollectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Record<wbr/>Collection<wbr/>Type</span><a href="#asRecordCollectionType" 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="asRecordCollectionType.asRecordCollectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Record<wbr/>Collection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#asRecordCollectionType.asRecordCollectionType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="CollectionResponse.html" class="tsd-signature-type tsd-kind-class">CollectionResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse&lt;CollectionResponse<Record>&gt;.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asRecordCollectionType - Converts the ApiResponse to an ApiResponse&lt;CollectionResponse<Record>&gt;.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:423</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asRecordType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Record<wbr/>Type</span><a href="#asRecordType" 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="asRecordType.asRecordType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Record<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">&gt;</span><a href="#asRecordType.asRecordType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<Record>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asRecordType - Converts the ApiResponse to an ApiResponse<Record>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:398</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asReportDataType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Report<wbr/>Data<wbr/>Type</span><a href="#asReportDataType" 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="asReportDataType.asReportDataType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Report<wbr/>Data<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">&gt;</span><a href="#asReportDataType.asReportDataType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="ReportData.html" class="tsd-signature-type tsd-kind-class">ReportData</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<ReportData>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asReportDataType - Converts the ApiResponse to an ApiResponse<ReportData>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:348</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="asSaveRecordResponseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>as<wbr/>Save<wbr/>Record<wbr/>Response<wbr/>Type</span><a href="#asSaveRecordResponseType" 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="asSaveRecordResponseType.asSaveRecordResponseType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">as<wbr/>Save<wbr/>Record<wbr/>Response<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">&lt;</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#asSaveRecordResponseType.asSaveRecordResponseType-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 <a href="ApiResponse.html" class="tsd-signature-type tsd-kind-class">ApiResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
<li>An ApiResponse<SaveRecordResponse>.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>asSaveRecordResponseType - Converts the ApiResponse to an ApiResponse<SaveRecordResponse>.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:450</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToAttachment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Attachment</span><a href="#convertToAttachment" 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="convertToAttachment.convertToAttachment-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Attachment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attachmentItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a><a href="#convertToAttachment.convertToAttachment-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">attachmentItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The attachment item to convert.</p>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Attachment.html" class="tsd-signature-type tsd-kind-class">Attachment</a></h4><ul>
<li>The converted attachment object.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToAttachment - Converts the attachment item to the appropriate attachment object.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:706</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToDelegate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Delegate</span><a href="#convertToDelegate" 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="convertToDelegate.convertToDelegate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Delegate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">delegateItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a><a href="#convertToDelegate.convertToDelegate-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">delegateItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The delegate item to convert.</p>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Delegate.html" class="tsd-signature-type tsd-kind-class">Delegate</a></h4><ul>
<li>The converted Delegate object.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToDelegate - Converts the delegate item to a Delegate object.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:655</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToScoringGroup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Scoring<wbr/>Group</span><a href="#convertToScoringGroup" 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="convertToScoringGroup.convertToScoringGroup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Scoring<wbr/>Group</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scoringGroupItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a><a href="#convertToScoringGroup.convertToScoringGroup-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">scoringGroupItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The scoring group item to convert.</p>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ScoringGroup.html" class="tsd-signature-type tsd-kind-class">ScoringGroup</a></h4><ul>
<li>The converted scoring group object.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToScoringGroup - Converts the scoring group item to the appropriate scoring group object.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:692</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="convertToTimeSpanData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>convert<wbr/>To<wbr/>Time<wbr/>Span<wbr/>Data</span><a href="#convertToTimeSpanData" 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="convertToTimeSpanData.convertToTimeSpanData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Time<wbr/>Span<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeSpanItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a><a href="#convertToTimeSpanData.convertToTimeSpanData-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">timeSpanItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The time span item to convert.</p>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TimeSpanData.html" class="tsd-signature-type tsd-kind-class">TimeSpanData</a></h4><ul>
<li>The converted time span data object.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToTimeSpanData - Converts the time span item to the appropriate time span data object.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:735</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getFieldByType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Field<wbr/>By<wbr/>Type</span><a href="#getFieldByType" 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="getFieldByType.getFieldByType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Field<wbr/>By<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a><a href="#getFieldByType.getFieldByType-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">fieldItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The field item to convert.</p>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Field.html" class="tsd-signature-type tsd-kind-class">Field</a></h4><ul>
<li>The converted field object.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getFieldByType - Converts the field item to the appropriate field object based upon the field item&#39;s type.</p>
<h4>Throws</h4><ul>
<li>If the field item&#39;s type is unknown.</li>
</ul>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:579</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getListValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>List<wbr/>Values</span><a href="#getListValues" 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="getListValues.getListValues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>List<wbr/>Values</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListValue.html" class="tsd-signature-type tsd-kind-class">ListValue</a><span class="tsd-signature-symbol">[]</span><a href="#getListValues.getListValues-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">fieldItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The field item whose values should be converted.</p>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ListValue.html" class="tsd-signature-type tsd-kind-class">ListValue</a><span class="tsd-signature-symbol">[]</span></h4><ul>
<li>The converted list values.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getListValues - Converts the field items list values to a ListValue[].</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:786</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="getRecordValueByType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Record<wbr/>Value<wbr/>By<wbr/>Type</span><a href="#getRecordValueByType" 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="getRecordValueByType.getRecordValueByType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Record<wbr/>Value<wbr/>By<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">recordValueItem</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRecordValueByType.getRecordValueByType-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">recordValueItem</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The record value item.</p>
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<li>The RecordValue.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>getRecordValueByType - Gets the RecordValue by by type.</p>
docs: update docs
2024-07-19 04:16:56 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in models/ApiResponse.ts:468</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="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#isSuccessful" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Successful</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#statusCode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status<wbr/>Code</span></a><a href="#asAppCollectionType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>App<wbr/>Collection<wbr/>Type</span></a><a href
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 15:44:49 -05:00
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>
Reference in New Issue Copy Permalink