docs: update docs to v4.0.0-beta.57

idexio · Nov 15, 2024 · b4798c8 · b4798c8
1 parent a444472
commit b4798c8
Show file tree

Hide file tree

Showing 265 changed files with 1,841 additions and 1,843 deletions.
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/OrderBookRealTimeClient.html b/classes/OrderBookRealTimeClient.html
diff --git a/classes/RestAuthenticatedClient.html b/classes/RestAuthenticatedClient.html
diff --git a/classes/RestPublicClient.html b/classes/RestPublicClient.html
diff --git a/classes/WebSocketClient.html b/classes/WebSocketClient.html
diff --git a/enums/BridgeTarget.html b/enums/BridgeTarget.html
diff --git a/enums/CandleInterval.html b/enums/CandleInterval.html
diff --git a/enums/ChainTransactionStatus.html b/enums/ChainTransactionStatus.html
diff --git a/enums/FillAction.html b/enums/FillAction.html
diff --git a/enums/FillType.html b/enums/FillType.html
diff --git a/enums/LiquidityProvider.html b/enums/LiquidityProvider.html
diff --git a/enums/MarketStatus.html b/enums/MarketStatus.html
diff --git a/enums/MessageEventType.html b/enums/MessageEventType.html
diff --git a/enums/OrderBookLevelType.html b/enums/OrderBookLevelType.html
@@ -1,9 +1,9 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OrderBookLevelType | IDEX SDK Reference</title><meta name="description" content="IDEX v4's TypeScript/Javascript Developer SDK Reference, designed for low-latency and guaranteed execution in a secure trading environment. This documentation outlines a platform where control and transparency are paramount, offering gas-free settlements and Ethereum-backed security. Ensuring only you have the power to move funds, it exemplifies a commitment to security and efficiency for developers seeking robust integration solutions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1731616231272"/><link rel="stylesheet" href="../assets/highlight.css?cache=1731616231272"/><link rel="stylesheet" href="../assets/custom.css?cache=1731616231272"/><script defer src="../assets/main.js?cache=1731616231272"></script><script async src="../assets/icons.js?cache=1731616231272" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1731616231272" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1731616231272" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
-</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">IDEX SDK Reference</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">IDEX SDK Reference</a></li><li><a href="OrderBookLevelType.html">OrderBookLevelType</a></li></ul><h1>Enumeration OrderBookLevelType</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/idexio/idex-sdk-js/blob/7180e59d40c690c7adf7fdb2ba21e127f043077b/src/types/enums/response.ts#L265">src/types/enums/response.ts:265</a></li><li>Defined in <a href="https://github.com/idexio/idex-sdk-js/blob/7180e59d40c690c7adf7fdb2ba21e127f043077b/src/types/enums/response.ts#L269">src/types/enums/response.ts:269</a></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">Enumeration Members</h3><div class="tsd-index-list"><a href="OrderBookLevelType.html#limit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>limit</span></a>
-</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="limit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>limit</span><a href="#limit" 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-enum-member">limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;limit&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/idexio/idex-sdk-js/blob/7180e59d40c690c7adf7fdb2ba21e127f043077b/src/types/enums/response.ts#L266">src/types/enums/response.ts:266</a></li></ul></aside></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-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-deprecated" name="deprecated"/><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>Deprecated</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="#limit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>limit</span></a></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://idex.io">IDEX Home</a><a href="https://api-docs-v4.idex.io">IDEX API Docs</a><a href="https://github.com/idexio/idex-sdk-js">SDK GitHub</a><a href="https://exchange-sandbox.idex.io">Exchange Sandbox</a></nav><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>IDEX SDK Reference</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OrderBookLevelType | IDEX SDK Reference</title><meta name="description" content="IDEX v4's TypeScript/Javascript Developer SDK Reference, designed for low-latency and guaranteed execution in a secure trading environment. This documentation outlines a platform where control and transparency are paramount, offering gas-free settlements and Ethereum-backed security. Ensuring only you have the power to move funds, it exemplifies a commitment to security and efficiency for developers seeking robust integration solutions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1731706891490"/><link rel="stylesheet" href="../assets/highlight.css?cache=1731706891490"/><link rel="stylesheet" href="../assets/custom.css?cache=1731706891490"/><script defer src="../assets/main.js?cache=1731706891490"></script><script async src="../assets/icons.js?cache=1731706891490" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1731706891490" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1731706891490" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
+</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">IDEX SDK Reference</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">IDEX SDK Reference</a></li><li><a href="OrderBookLevelType.html">OrderBookLevelType</a></li></ul><h1>Enumeration OrderBookLevelType</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/idexio/idex-sdk-js/blob/84b4f65bf36f16b08e471037ed6fdd50e6131930/src/types/enums/response.ts#L264">src/types/enums/response.ts:264</a></li><li>Defined in <a href="https://github.com/idexio/idex-sdk-js/blob/84b4f65bf36f16b08e471037ed6fdd50e6131930/src/types/enums/response.ts#L268">src/types/enums/response.ts:268</a></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">Enumeration Members</h3><div class="tsd-index-list"><a href="OrderBookLevelType.html#limit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>limit</span></a>
+</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="limit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>limit</span><a href="#limit" 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-enum-member">limit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;limit&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/idexio/idex-sdk-js/blob/84b4f65bf36f16b08e471037ed6fdd50e6131930/src/types/enums/response.ts#L265">src/types/enums/response.ts:265</a></li></ul></aside></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-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-deprecated" name="deprecated"/><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>Deprecated</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="#limit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>limit</span></a></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://idex.io">IDEX Home</a><a href="https://api-docs-v4.idex.io">IDEX API Docs</a><a href="https://github.com/idexio/idex-sdk-js">SDK GitHub</a><a href="https://exchange-sandbox.idex.io">Exchange Sandbox</a></nav><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>IDEX SDK Reference</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
             <span id="generation-date"></span>
             <script>
-                window.GENERATION_DATE = 1731616232236;
+                window.GENERATION_DATE = 1731706892500;
 
                 (() => {