npm - @openfort/openfort-node - Versions diffs - 0.6.26 → 0.6.28 - Mend

@openfort/openfort-node 0.6.26 → 0.6.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (394) hide show

package/docs/assets/widgets.png DELETED Viewed

Binary file

package/docs/assets/widgets@2x.png DELETED Viewed

Binary file

package/docs/classes/apis_baseApiWrapper.BaseApiWrapper.html DELETED Viewed

@@ -1 +0,0 @@

- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseApiWrapper | @openfort/openfort-node</title><meta name="description" content="Documentation for @openfort/openfort-node"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@openfort/openfort-node</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@openfort/openfort-node</a></li><li><a href="../modules/apis_baseApiWrapper.html">apis/baseApiWrapper</a></li><li><a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a></li></ul><h1>Class BaseApiWrapper<T> </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-type-parameters"><h3>Type Parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BaseApiWrapper</span><ul class="tsd-hierarchy"><li><a href="apis_contractsApiWrapper.ContractsApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">ContractsApiWrapper</a></li><li><a href="apis_iamApiWrapper.IamApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">IamApiWrapper</a></li><li><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">InventoriesApiWrapper</a></li><li><a href="apis_oauthApiWrapper.OAuthApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthApiWrapper</a></li><li><a href="apis_playersApiWrapper.PlayersApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">PlayersApiWrapper</a></li><li><a href="apis_policiesApiWrapper.PoliciesApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">PoliciesApiWrapper</a></li><li><a href="apis_policyRulesApiWrapper.PolicyRulesApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRulesApiWrapper</a></li><li><a href="apis_sessionsApiWrapper.SessionsApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">SessionsApiWrapper</a></li><li><a href="apis_settingsApiWrapper.SettingsApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">SettingsApiWrapper</a></li><li><a href="apis_transactionIntentsApiWrapper.TransactionIntentsApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionIntentsApiWrapper</a></li><li><a href="apis_web3ConnectionsApiWrapper.Web3ConnectionsApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">Web3ConnectionsApiWrapper</a></li></ul></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/utilities_observable.Observable.html" class="tsd-signature-type" data-tsd-kind="Interface">Observable</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="apis_baseApiWrapper.BaseApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="apis_baseApiWrapper.BaseApiWrapper.html#_observers" class="tsd-kind-icon">_observers</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="apis_baseApiWrapper.BaseApiWrapper.html#api" class="tsd-kind-icon">api</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="apis_baseApiWrapper.BaseApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_baseApiWrapper.BaseApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Base<wbr/>Api<wbr/>Wrapper<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">new </span><span class="tsd-signature-symbol">(</span>_configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, basePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="apis_baseApiWrapper.BaseApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">BaseApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L11">src/apis/baseApiWrapper.ts:11</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type Parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">new </span><span class="tsd-signature-symbol">(</span>_configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-constructor"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">new </span><span class="tsd-signature-symbol">(</span>_configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>_configuration: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li></ul></li></ul></li><li><h5>accessToken: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> basePath: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="apis_baseApiWrapper.BaseApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">BaseApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_observers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> _observers<a href="#_observers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">_observers<span class="tsd-signature-symbol">:</span> <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L8">src/apis/baseApiWrapper.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> api<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L9">src/apis/baseApiWrapper.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="observers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">observers<a href="#observers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> observers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of Observable.observers</p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L34">src/apis/baseApiWrapper.ts:34</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link">subscribe<a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>observer<span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/utilities_observable.Observable.html">Observable</a>.<a href="../interfaces/utilities_observable.Observable.html#subscribe">subscribe</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L30">src/apis/baseApiWrapper.ts:30</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>observer: <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/apis_baseApiWrapper.html">apis/base<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_contractsApiWrapper.html">apis/contracts<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_iamApiWrapper.html">apis/iam<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventories<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_oauthApiWrapper.html">apis/oauth<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_playersApiWrapper.html">apis/players<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policiesApiWrapper.html">apis/policies<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policyRulesApiWrapper.html">apis/policy<wbr/>Rules<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_sessionsApiWrapper.html">apis/sessions<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_settingsApiWrapper.html">apis/settings<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_transactionIntentsApiWrapper.html">apis/transaction<wbr/>Intents<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_web3ConnectionsApiWrapper.html">apis/web3<wbr/>Connections<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class=" tsd-kind-module"><a href="../modules/generated_configuration.html">generated/configuration</a></li><li class=" tsd-kind-module"><a href="../modules/generated_middleware.html">generated/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/generated_rxjsStub.html">generated/rxjs<wbr/>Stub</a></li><li class=" tsd-kind-module"><a href="../modules/generated_servers.html">generated/servers</a></li><li class=" tsd-kind-module"><a href="../modules/generated_util.html">generated/util</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/models.html">models</a></li><li class=" tsd-kind-module"><a href="../modules/models_accountInventoryListQueries.html">models/account<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_baseListRequest.html">models/base<wbr/>List<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_cancelTransferOwnershipRequest.html">models/cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_completeRecoveryRequest.html">models/complete<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_createPlayerSessionRequest.html">models/create<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountInventoryRequest.html">models/get<wbr/>Account<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountRequest.html">models/get<wbr/>Account<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAllowFunctionsRequest.html">models/get<wbr/>Allow<wbr/>Functions<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getContractRequest.html">models/get<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerByExternalIdRequest.html">models/get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerInventoryRequest.html">models/get<wbr/>Player<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerRequest.html">models/get<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyRequest.html">models/get<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyTotalGasUsageRequest.html">models/get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getSessionRequest.html">models/get<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getTransactionIntentRequest.html">models/get<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ActionsList.html">models/get<wbr/>Web3<wbr/>Actions<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ConnectionRequest.html">models/get<wbr/>Web3<wbr/>Connection<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerCancelTransferOwnershipRequest.html">models/player<wbr/>Cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerInventoryListQueries.html">models/player<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerTransferOwnershipRequest.html">models/player<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_revokePlayerSessionRequest.html">models/revoke<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signPayloadRequest.html">models/sign<wbr/>Payload<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureSessionRequest.html">models/signature<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureTransactionIntentRequest.html">models/signature<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_startRecoveryRequest.html">models/start<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_submitWeb3ActionRequest.html">models/submit<wbr/>Web3<wbr/>Action<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_transferOwnershipRequest.html">models/transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateContractRequest.html">models/update<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePlayerRequest.html">models/update<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyAllowFunctionRequest.html">models/update<wbr/>Policy<wbr/>Allow<wbr/>Function<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRequest.html">models/update<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRuleRequest.html">models/update<wbr/>Policy<wbr/>Rule<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateProjectRequest.html">models/update<wbr/>Project<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_validationError.html">models/validation<wbr/>Error</a></li><li class=" tsd-kind-module"><a href="../modules/models_verifyOAuthTokenRequest.html">models/verifyOAuth<wbr/>Token<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_webHookEvent.html">models/web<wbr/>Hook<wbr/>Event</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_httpErrorHandler.html">utilities/http<wbr/>Error<wbr/>Handler</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_middleware.html">utilities/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observable.html">utilities/observable</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observer.html">utilities/observer</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="apis_baseApiWrapper.BaseApiWrapper.html" class="tsd-kind-icon">Base<wbr/>Api<wbr/>Wrapper</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="apis_baseApiWrapper.BaseApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="apis_baseApiWrapper.BaseApiWrapper.html#_observers" class="tsd-kind-icon">_observers</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="apis_baseApiWrapper.BaseApiWrapper.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="apis_baseApiWrapper.BaseApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_baseApiWrapper.BaseApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/docs/classes/apis_contractsApiWrapper.ContractsApiWrapper.html DELETED Viewed

@@ -1,21 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ContractsApiWrapper | @openfort/openfort-node</title><meta name="description" content="Documentation for @openfort/openfort-node"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@openfort/openfort-node</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@openfort/openfort-node</a></li><li><a href="../modules/apis_contractsApiWrapper.html">apis/contractsApiWrapper</a></li><li><a href="apis_contractsApiWrapper.ContractsApiWrapper.html">ContractsApiWrapper</a></li></ul><h1>Class ContractsApiWrapper </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="apis_baseApiWrapper.BaseApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">BaseApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><a href="generated.ContractsApi.html" class="tsd-signature-type" data-tsd-kind="Class">ContractsApi</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">ContractsApiWrapper</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#api" class="tsd-kind-icon">api</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#delete" class="tsd-kind-icon">delete</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#update" class="tsd-kind-icon">update</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Contracts<wbr/>Api<wbr/>Wrapper<span class="tsd-signature-symbol">(</span>accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, basePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="apis_contractsApiWrapper.ContractsApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">ContractsApiWrapper</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/contractsApiWrapper.ts#L16">src/apis/contractsApiWrapper.ts:16</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>accessToken: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> basePath: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="apis_contractsApiWrapper.ContractsApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">ContractsApiWrapper</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> api<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <a href="generated.ContractsApi.html" class="tsd-signature-type" data-tsd-kind="Class">ContractsApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#api">api</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L9">src/apis/baseApiWrapper.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="observers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">observers<a href="#observers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> observers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from BaseApiWrapper.observers</p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L34">src/apis/baseApiWrapper.ts:34</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="index.CreateContractRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreateContractRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/contractsApiWrapper.ts#L24">src/apis/contractsApiWrapper.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Creates a contract object.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="index.CreateContractRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreateContractRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Parameters to create contract</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractDeleteResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractDeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/contractsApiWrapper.ts#L41">src/apis/contractsApiWrapper.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Deletes a contract object.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Id of the contract to delete</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractDeleteResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractDeleteResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_getContractRequest.GetContractRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetContractRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/contractsApiWrapper.ts#L49">src/apis/contractsApiWrapper.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the details of an existing contract. Supply the unique contract ID from either a contract creation request or the contract list, and Openfort will return the corresponding contract information.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_getContractRequest.GetContractRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetContractRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Criteria to get the contract.</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="list" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">?: </span><a href="index.ContractListQueries.html" class="tsd-signature-type" data-tsd-kind="Class">ContractListQueries</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractListResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/contractsApiWrapper.ts#L57">src/apis/contractsApiWrapper.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Returns a list of your contracts. The contracts are returned sorted by creation date, with the most recently created contracts appearing first.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> req: <a href="index.ContractListQueries.html" class="tsd-signature-type" data-tsd-kind="Class">ContractListQueries</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Criteria to retrieve list of contracts.</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link">subscribe<a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>observer<span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#subscribe">subscribe</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L30">src/apis/baseApiWrapper.ts:30</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>observer: <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="update" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_updateContractRequest.UpdateContractRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateContractRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/contractsApiWrapper.ts#L32">src/apis/contractsApiWrapper.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Updates a contract object.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_updateContractRequest.UpdateContractRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateContractRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Parameters to update the contract</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ContractResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ContractResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/apis_baseApiWrapper.html">apis/base<wbr/>Api<wbr/>Wrapper</a></li><li class="current tsd-kind-module"><a href="../modules/apis_contractsApiWrapper.html">apis/contracts<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_iamApiWrapper.html">apis/iam<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventories<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_oauthApiWrapper.html">apis/oauth<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_playersApiWrapper.html">apis/players<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policiesApiWrapper.html">apis/policies<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policyRulesApiWrapper.html">apis/policy<wbr/>Rules<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_sessionsApiWrapper.html">apis/sessions<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_settingsApiWrapper.html">apis/settings<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_transactionIntentsApiWrapper.html">apis/transaction<wbr/>Intents<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_web3ConnectionsApiWrapper.html">apis/web3<wbr/>Connections<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class=" tsd-kind-module"><a href="../modules/generated_configuration.html">generated/configuration</a></li><li class=" tsd-kind-module"><a href="../modules/generated_middleware.html">generated/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/generated_rxjsStub.html">generated/rxjs<wbr/>Stub</a></li><li class=" tsd-kind-module"><a href="../modules/generated_servers.html">generated/servers</a></li><li class=" tsd-kind-module"><a href="../modules/generated_util.html">generated/util</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/models.html">models</a></li><li class=" tsd-kind-module"><a href="../modules/models_accountInventoryListQueries.html">models/account<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_baseListRequest.html">models/base<wbr/>List<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_cancelTransferOwnershipRequest.html">models/cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_completeRecoveryRequest.html">models/complete<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_createPlayerSessionRequest.html">models/create<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountInventoryRequest.html">models/get<wbr/>Account<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountRequest.html">models/get<wbr/>Account<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAllowFunctionsRequest.html">models/get<wbr/>Allow<wbr/>Functions<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getContractRequest.html">models/get<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerByExternalIdRequest.html">models/get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerInventoryRequest.html">models/get<wbr/>Player<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerRequest.html">models/get<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyRequest.html">models/get<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyTotalGasUsageRequest.html">models/get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getSessionRequest.html">models/get<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getTransactionIntentRequest.html">models/get<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ActionsList.html">models/get<wbr/>Web3<wbr/>Actions<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ConnectionRequest.html">models/get<wbr/>Web3<wbr/>Connection<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerCancelTransferOwnershipRequest.html">models/player<wbr/>Cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerInventoryListQueries.html">models/player<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerTransferOwnershipRequest.html">models/player<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_revokePlayerSessionRequest.html">models/revoke<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signPayloadRequest.html">models/sign<wbr/>Payload<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureSessionRequest.html">models/signature<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureTransactionIntentRequest.html">models/signature<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_startRecoveryRequest.html">models/start<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_submitWeb3ActionRequest.html">models/submit<wbr/>Web3<wbr/>Action<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_transferOwnershipRequest.html">models/transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateContractRequest.html">models/update<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePlayerRequest.html">models/update<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyAllowFunctionRequest.html">models/update<wbr/>Policy<wbr/>Allow<wbr/>Function<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRequest.html">models/update<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRuleRequest.html">models/update<wbr/>Policy<wbr/>Rule<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateProjectRequest.html">models/update<wbr/>Project<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_validationError.html">models/validation<wbr/>Error</a></li><li class=" tsd-kind-module"><a href="../modules/models_verifyOAuthTokenRequest.html">models/verifyOAuth<wbr/>Token<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_webHookEvent.html">models/web<wbr/>Hook<wbr/>Event</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_httpErrorHandler.html">utilities/http<wbr/>Error<wbr/>Handler</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_middleware.html">utilities/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observable.html">utilities/observable</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observer.html">utilities/observer</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html" class="tsd-kind-icon">Contracts<wbr/>Api<wbr/>Wrapper</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#delete" class="tsd-kind-icon">delete</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#list" class="tsd-kind-icon">list</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_contractsApiWrapper.ContractsApiWrapper.html#update" class="tsd-kind-icon">update</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/docs/classes/apis_iamApiWrapper.IamApiWrapper.html DELETED Viewed

@@ -1,5 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IamApiWrapper | @openfort/openfort-node</title><meta name="description" content="Documentation for @openfort/openfort-node"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@openfort/openfort-node</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@openfort/openfort-node</a></li><li><a href="../modules/apis_iamApiWrapper.html">apis/iamApiWrapper</a></li><li><a href="apis_iamApiWrapper.IamApiWrapper.html">IamApiWrapper</a></li></ul><h1>Class IamApiWrapper </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="apis_baseApiWrapper.BaseApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">BaseApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><a href="generated.AuthenticationApi.html" class="tsd-signature-type" data-tsd-kind="Class">AuthenticationApi</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">IamApiWrapper</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="apis_iamApiWrapper.IamApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="apis_iamApiWrapper.IamApiWrapper.html#api" class="tsd-kind-icon">api</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="apis_iamApiWrapper.IamApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="apis_iamApiWrapper.IamApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_iamApiWrapper.IamApiWrapper.html#verifyToken" class="tsd-kind-icon">verify<wbr/>Token</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Iam<wbr/>Api<wbr/>Wrapper<span class="tsd-signature-symbol">(</span>accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, basePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="apis_iamApiWrapper.IamApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">IamApiWrapper</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/iamApiWrapper.ts#L7">src/apis/iamApiWrapper.ts:7</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>accessToken: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> basePath: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="apis_iamApiWrapper.IamApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">IamApiWrapper</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> api<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <a href="generated.AuthenticationApi.html" class="tsd-signature-type" data-tsd-kind="Class">AuthenticationApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#api">api</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L9">src/apis/baseApiWrapper.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="observers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">observers<a href="#observers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> observers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from BaseApiWrapper.observers</p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L34">src/apis/baseApiWrapper.ts:34</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link">subscribe<a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>observer<span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#subscribe">subscribe</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L30">src/apis/baseApiWrapper.ts:30</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>observer: <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="verifyToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">verify<wbr/>Token<a href="#verifyToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">verify<wbr/>Token<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.PlayerResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PlayerResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/iamApiWrapper.ts#L15">src/apis/iamApiWrapper.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Verify an auth token.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>token: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the auth token.</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.PlayerResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PlayerResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/apis_baseApiWrapper.html">apis/base<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_contractsApiWrapper.html">apis/contracts<wbr/>Api<wbr/>Wrapper</a></li><li class="current tsd-kind-module"><a href="../modules/apis_iamApiWrapper.html">apis/iam<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventories<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_oauthApiWrapper.html">apis/oauth<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_playersApiWrapper.html">apis/players<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policiesApiWrapper.html">apis/policies<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policyRulesApiWrapper.html">apis/policy<wbr/>Rules<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_sessionsApiWrapper.html">apis/sessions<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_settingsApiWrapper.html">apis/settings<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_transactionIntentsApiWrapper.html">apis/transaction<wbr/>Intents<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_web3ConnectionsApiWrapper.html">apis/web3<wbr/>Connections<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class=" tsd-kind-module"><a href="../modules/generated_configuration.html">generated/configuration</a></li><li class=" tsd-kind-module"><a href="../modules/generated_middleware.html">generated/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/generated_rxjsStub.html">generated/rxjs<wbr/>Stub</a></li><li class=" tsd-kind-module"><a href="../modules/generated_servers.html">generated/servers</a></li><li class=" tsd-kind-module"><a href="../modules/generated_util.html">generated/util</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/models.html">models</a></li><li class=" tsd-kind-module"><a href="../modules/models_accountInventoryListQueries.html">models/account<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_baseListRequest.html">models/base<wbr/>List<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_cancelTransferOwnershipRequest.html">models/cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_completeRecoveryRequest.html">models/complete<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_createPlayerSessionRequest.html">models/create<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountInventoryRequest.html">models/get<wbr/>Account<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountRequest.html">models/get<wbr/>Account<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAllowFunctionsRequest.html">models/get<wbr/>Allow<wbr/>Functions<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getContractRequest.html">models/get<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerByExternalIdRequest.html">models/get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerInventoryRequest.html">models/get<wbr/>Player<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerRequest.html">models/get<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyRequest.html">models/get<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyTotalGasUsageRequest.html">models/get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getSessionRequest.html">models/get<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getTransactionIntentRequest.html">models/get<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ActionsList.html">models/get<wbr/>Web3<wbr/>Actions<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ConnectionRequest.html">models/get<wbr/>Web3<wbr/>Connection<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerCancelTransferOwnershipRequest.html">models/player<wbr/>Cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerInventoryListQueries.html">models/player<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerTransferOwnershipRequest.html">models/player<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_revokePlayerSessionRequest.html">models/revoke<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signPayloadRequest.html">models/sign<wbr/>Payload<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureSessionRequest.html">models/signature<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureTransactionIntentRequest.html">models/signature<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_startRecoveryRequest.html">models/start<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_submitWeb3ActionRequest.html">models/submit<wbr/>Web3<wbr/>Action<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_transferOwnershipRequest.html">models/transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateContractRequest.html">models/update<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePlayerRequest.html">models/update<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyAllowFunctionRequest.html">models/update<wbr/>Policy<wbr/>Allow<wbr/>Function<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRequest.html">models/update<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRuleRequest.html">models/update<wbr/>Policy<wbr/>Rule<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateProjectRequest.html">models/update<wbr/>Project<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_validationError.html">models/validation<wbr/>Error</a></li><li class=" tsd-kind-module"><a href="../modules/models_verifyOAuthTokenRequest.html">models/verifyOAuth<wbr/>Token<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_webHookEvent.html">models/web<wbr/>Hook<wbr/>Event</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_httpErrorHandler.html">utilities/http<wbr/>Error<wbr/>Handler</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_middleware.html">utilities/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observable.html">utilities/observable</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observer.html">utilities/observer</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="apis_iamApiWrapper.IamApiWrapper.html" class="tsd-kind-icon">Iam<wbr/>Api<wbr/>Wrapper</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="apis_iamApiWrapper.IamApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="apis_iamApiWrapper.IamApiWrapper.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="apis_iamApiWrapper.IamApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="apis_iamApiWrapper.IamApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_iamApiWrapper.IamApiWrapper.html#verifyToken" class="tsd-kind-icon">verify<wbr/>Token</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/docs/classes/apis_inventoriesApiWrapper.InventoriesApiWrapper.html DELETED Viewed

@@ -1,13 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InventoriesApiWrapper | @openfort/openfort-node</title><meta name="description" content="Documentation for @openfort/openfort-node"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@openfort/openfort-node</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@openfort/openfort-node</a></li><li><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventoriesApiWrapper</a></li><li><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html">InventoriesApiWrapper</a></li></ul><h1>Class InventoriesApiWrapper </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="apis_baseApiWrapper.BaseApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">BaseApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><a href="generated.InventoriesApi.html" class="tsd-signature-type" data-tsd-kind="Class">InventoriesApi</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">InventoriesApiWrapper</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#api" class="tsd-kind-icon">api</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getAccountCryptoCurrencyInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Crypto<wbr/>Currency<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getAccountNativeInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Native<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getAccountNftInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Nft<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getPlayerCryptoCurrencyInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Crypto<wbr/>Currency<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getPlayerNativeInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Native<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getPlayerNftInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Nft<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Inventories<wbr/>Api<wbr/>Wrapper<span class="tsd-signature-symbol">(</span>accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, basePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">InventoriesApiWrapper</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/inventoriesApiWrapper.ts#L15">src/apis/inventoriesApiWrapper.ts:15</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>accessToken: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> basePath: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">InventoriesApiWrapper</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> api<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <a href="generated.InventoriesApi.html" class="tsd-signature-type" data-tsd-kind="Class">InventoriesApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#api">api</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L9">src/apis/baseApiWrapper.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a id="observers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">observers<a href="#observers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> observers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from BaseApiWrapper.observers</p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L34">src/apis/baseApiWrapper.ts:34</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAccountCryptoCurrencyInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Account<wbr/>Crypto<wbr/>Currency<wbr/>Inventory<a href="#getAccountCryptoCurrencyInventory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Crypto<wbr/>Currency<wbr/>Inventory<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_accountInventoryListQueries.AccountInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInventoryListQueries</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/inventoriesApiWrapper.ts#L57">src/apis/inventoriesApiWrapper.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_accountInventoryListQueries.AccountInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInventoryListQueries</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAccountNativeInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Account<wbr/>Native<wbr/>Inventory<a href="#getAccountNativeInventory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Native<wbr/>Inventory<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_getAccountInventoryRequest.GetAccountInventoryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInventoryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/inventoriesApiWrapper.ts#L77">src/apis/inventoriesApiWrapper.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_getAccountInventoryRequest.GetAccountInventoryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetAccountInventoryRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAccountNftInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Account<wbr/>Nft<wbr/>Inventory<a href="#getAccountNftInventory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Account<wbr/>Nft<wbr/>Inventory<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_accountInventoryListQueries.AccountInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInventoryListQueries</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/inventoriesApiWrapper.ts#L36">src/apis/inventoriesApiWrapper.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_accountInventoryListQueries.AccountInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInventoryListQueries</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPlayerCryptoCurrencyInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Player<wbr/>Crypto<wbr/>Currency<wbr/>Inventory<a href="#getPlayerCryptoCurrencyInventory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Player<wbr/>Crypto<wbr/>Currency<wbr/>Inventory<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_playerInventoryListQueries.PlayerInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayerInventoryListQueries</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/inventoriesApiWrapper.ts#L43">src/apis/inventoriesApiWrapper.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_playerInventoryListQueries.PlayerInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayerInventoryListQueries</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPlayerNativeInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Player<wbr/>Native<wbr/>Inventory<a href="#getPlayerNativeInventory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Player<wbr/>Native<wbr/>Inventory<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_getPlayerInventoryRequest.GetPlayerInventoryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetPlayerInventoryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/inventoriesApiWrapper.ts#L70">src/apis/inventoriesApiWrapper.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_getPlayerInventoryRequest.GetPlayerInventoryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GetPlayerInventoryRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPlayerNftInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Player<wbr/>Nft<wbr/>Inventory<a href="#getPlayerNftInventory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Player<wbr/>Nft<wbr/>Inventory<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/models_playerInventoryListQueries.PlayerInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayerInventoryListQueries</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/inventoriesApiWrapper.ts#L22">src/apis/inventoriesApiWrapper.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>req: <a href="../interfaces/models_playerInventoryListQueries.PlayerInventoryListQueries.html" class="tsd-signature-type" data-tsd-kind="Interface">PlayerInventoryListQueries</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.InventoryListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">InventoryListResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="subscribe" class="tsd-anchor"></a><h3 class="tsd-anchor-link">subscribe<a href="#subscribe" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>observer<span class="tsd-signature-symbol">: </span><a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="apis_baseApiWrapper.BaseApiWrapper.html">BaseApiWrapper</a>.<a href="apis_baseApiWrapper.BaseApiWrapper.html#subscribe">subscribe</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/apis/baseApiWrapper.ts#L30">src/apis/baseApiWrapper.ts:30</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>observer: <a href="../interfaces/utilities_observer.Observer.html" class="tsd-signature-type" data-tsd-kind="Interface">Observer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/apis_baseApiWrapper.html">apis/base<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_contractsApiWrapper.html">apis/contracts<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_iamApiWrapper.html">apis/iam<wbr/>Api<wbr/>Wrapper</a></li><li class="current tsd-kind-module"><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventories<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_oauthApiWrapper.html">apis/oauth<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_playersApiWrapper.html">apis/players<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policiesApiWrapper.html">apis/policies<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policyRulesApiWrapper.html">apis/policy<wbr/>Rules<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_sessionsApiWrapper.html">apis/sessions<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_settingsApiWrapper.html">apis/settings<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_transactionIntentsApiWrapper.html">apis/transaction<wbr/>Intents<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_web3ConnectionsApiWrapper.html">apis/web3<wbr/>Connections<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class=" tsd-kind-module"><a href="../modules/generated_configuration.html">generated/configuration</a></li><li class=" tsd-kind-module"><a href="../modules/generated_middleware.html">generated/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/generated_rxjsStub.html">generated/rxjs<wbr/>Stub</a></li><li class=" tsd-kind-module"><a href="../modules/generated_servers.html">generated/servers</a></li><li class=" tsd-kind-module"><a href="../modules/generated_util.html">generated/util</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/models.html">models</a></li><li class=" tsd-kind-module"><a href="../modules/models_accountInventoryListQueries.html">models/account<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_baseListRequest.html">models/base<wbr/>List<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_cancelTransferOwnershipRequest.html">models/cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_completeRecoveryRequest.html">models/complete<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_createPlayerSessionRequest.html">models/create<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountInventoryRequest.html">models/get<wbr/>Account<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountRequest.html">models/get<wbr/>Account<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAllowFunctionsRequest.html">models/get<wbr/>Allow<wbr/>Functions<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getContractRequest.html">models/get<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerByExternalIdRequest.html">models/get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerInventoryRequest.html">models/get<wbr/>Player<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerRequest.html">models/get<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyRequest.html">models/get<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyTotalGasUsageRequest.html">models/get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getSessionRequest.html">models/get<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getTransactionIntentRequest.html">models/get<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ActionsList.html">models/get<wbr/>Web3<wbr/>Actions<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ConnectionRequest.html">models/get<wbr/>Web3<wbr/>Connection<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerCancelTransferOwnershipRequest.html">models/player<wbr/>Cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerInventoryListQueries.html">models/player<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerTransferOwnershipRequest.html">models/player<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_revokePlayerSessionRequest.html">models/revoke<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signPayloadRequest.html">models/sign<wbr/>Payload<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureSessionRequest.html">models/signature<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureTransactionIntentRequest.html">models/signature<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_startRecoveryRequest.html">models/start<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_submitWeb3ActionRequest.html">models/submit<wbr/>Web3<wbr/>Action<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_transferOwnershipRequest.html">models/transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateContractRequest.html">models/update<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePlayerRequest.html">models/update<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyAllowFunctionRequest.html">models/update<wbr/>Policy<wbr/>Allow<wbr/>Function<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRequest.html">models/update<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRuleRequest.html">models/update<wbr/>Policy<wbr/>Rule<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateProjectRequest.html">models/update<wbr/>Project<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_validationError.html">models/validation<wbr/>Error</a></li><li class=" tsd-kind-module"><a href="../modules/models_verifyOAuthTokenRequest.html">models/verifyOAuth<wbr/>Token<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_webHookEvent.html">models/web<wbr/>Hook<wbr/>Event</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_httpErrorHandler.html">utilities/http<wbr/>Error<wbr/>Handler</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_middleware.html">utilities/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observable.html">utilities/observable</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observer.html">utilities/observer</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html" class="tsd-kind-icon">Inventories<wbr/>Api<wbr/>Wrapper</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#observers" class="tsd-kind-icon">observers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getAccountCryptoCurrencyInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Crypto<wbr/>Currency<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getAccountNativeInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Native<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getAccountNftInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Nft<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getPlayerCryptoCurrencyInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Crypto<wbr/>Currency<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getPlayerNativeInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Native<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#getPlayerNftInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Nft<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="apis_inventoriesApiWrapper.InventoriesApiWrapper.html#subscribe" class="tsd-kind-icon">subscribe</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>