docs: update docs
This commit is contained in:
1 parent
2a67ead01a
commit
d99d00e450
71 files changed
+411
-414
No files matched your search
+1
-1
@@ -313,7 +313,7 @@ BASE_URL=https://api.onspring.com
|
||||
<p>You can set your own page size and page number (max is 1,000) as well.</p>
|
||||
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">PagingRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getReportsByAppId</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">PagingRequest</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">));</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">reports</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">report</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">reports</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">report</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
||||
</code><button>Copy</button></pre>
|
||||
</div></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="#md:onspring-api-javascript-sdk"><span>Onspring API <wbr/>Javascript SDK</span></a><ul><li><a href="#md:🛠️-dependencies"><span>🛠️ <wbr/>Dependencies</span></a></li><li><ul><li><a href="#md:nodejs"><span>Node.js</span></a></li><li><a href="#md:axios"><span>Axios</span></a></li><li><a href="#md:form-data"><span>Form-<wbr/>Data</span></a></li></ul></li><li><a href="#md:💾-installation"><span>💾 <wbr/>Installation</span></a></li><li><a href="#md:🔑-api-key"><span>🔑 API <wbr/>Key</span></a></li><li><ul><li><a href="#md:🔒-permission-considerations"><span>🔒 <wbr/>Permission <wbr/>Considerations</span></a></li></ul></li><li><a href="#md:🧑🏻💻-start-coding"><span>🧑🏻💻 <wbr/>Start <wbr/>Coding</span></a></li><li><ul><li><a href="#md:onspringclient"><span>Onspring<wbr/>Client</span></a></li><li><a href="#md:axios-instance-configuration"><span>Axios <wbr/>Instance <wbr/>Configuration</span></a></li><li><a href="#md:apiresponse"><span>Api<wbr/>Response</span></a></li><li><a href="#md:commonjs-or-es-modules"><span>CommonJS or ES <wbr/>Modules</span></a></li><li><a href="#md:types"><span>Types</span></a></li><li><a href="#md:full-api-documentation"><span>Full API <wbr/>Documentation</span></a></li></ul></li><li><a href="#md:📋-examples"><span>📋 <wbr/>Examples</span></a></li><li><ul><li><a href="#md:connectivity"><span>Connectivity</span></a></li><li><ul><li><a href="#md:verify-connectivity"><span>Verify connectivity</span></a></li></ul></li><li><a href="#md:apps"><span>Apps</span></a></li><li><ul><li><a href="#md:get-apps"><span>Get <wbr/>Apps</span></a></li><li><a href="#md:get-app-by-id"><span>Get <wbr/>App <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-apps-by-ids"><span>Get <wbr/>Apps <wbr/>By <wbr/>Ids</span></a></li></ul></li><li><a href="#md:fields"><span>Fields</span></a></li><li><ul><li><a href="#md:get-field-by-id"><span>Get <wbr/>Field <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-fields-by-ids"><span>Get <wbr/>Fields <wbr/Line truncated
|
||||
</div></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="#md:onspring-api-javascript-sdk"><span>Onspring API <wbr/>Javascript SDK</span></a><ul><li><a href="#md:🛠️-dependencies"><span>🛠️ <wbr/>Dependencies</span></a></li><li><ul><li><a href="#md:nodejs"><span>Node.js</span></a></li><li><a href="#md:axios"><span>Axios</span></a></li><li><a href="#md:form-data"><span>Form-<wbr/>Data</span></a></li></ul></li><li><a href="#md:💾-installation"><span>💾 <wbr/>Installation</span></a></li><li><a href="#md:🔑-api-key"><span>🔑 API <wbr/>Key</span></a></li><li><ul><li><a href="#md:🔒-permission-considerations"><span>🔒 <wbr/>Permission <wbr/>Considerations</span></a></li></ul></li><li><a href="#md:🧑🏻💻-start-coding"><span>🧑🏻💻 <wbr/>Start <wbr/>Coding</span></a></li><li><ul><li><a href="#md:onspringclient"><span>Onspring<wbr/>Client</span></a></li><li><a href="#md:axios-instance-configuration"><span>Axios <wbr/>Instance <wbr/>Configuration</span></a></li><li><a href="#md:apiresponse"><span>Api<wbr/>Response</span></a></li><li><a href="#md:commonjs-or-es-modules"><span>CommonJS or ES <wbr/>Modules</span></a></li><li><a href="#md:types"><span>Types</span></a></li><li><a href="#md:full-api-documentation"><span>Full API <wbr/>Documentation</span></a></li></ul></li><li><a href="#md:📋-examples"><span>📋 <wbr/>Examples</span></a></li><li><ul><li><a href="#md:connectivity"><span>Connectivity</span></a></li><li><ul><li><a href="#md:verify-connectivity"><span>Verify connectivity</span></a></li></ul></li><li><a href="#md:apps"><span>Apps</span></a></li><li><ul><li><a href="#md:get-apps"><span>Get <wbr/>Apps</span></a></li><li><a href="#md:get-app-by-id"><span>Get <wbr/>App <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-apps-by-ids"><span>Get <wbr/>Apps <wbr/>By <wbr/>Ids</span></a></li></ul></li><li><a href="#md:fields"><span>Fields</span></a></li><li><ul><li><a href="#md:get-field-by-id"><span>Get <wbr/>Field <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-fields-by-ids"><span>Get <wbr/>Fields <wbr/Line truncated
|
||||
try {
|
||||
const generateLinkElement = document.querySelector(".tsd-generator a");
|
||||
const link = document.createElement("a");
|
||||
|
||||
Reference in new issue
Block a user