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/classes/generated.InventoriesApi.html DELETED Viewed

@@ -1,71 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>InventoriesApi | @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/generated.html">generated</a></li><li><a href="generated.InventoriesApi.html">InventoriesApi</a></li></ul><h1>Class InventoriesApi </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><span class="target">InventoriesApi</span></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"><a href="generated.InventoriesApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private 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="generated.InventoriesApi.html#api" class="tsd-kind-icon">api</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="generated.InventoriesApi.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="generated.InventoriesApi.html#getAccountInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.InventoriesApi.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="generated.InventoriesApi.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="generated.InventoriesApi.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="generated.InventoriesApi.html#getPlayerInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.InventoriesApi.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="generated.InventoriesApi.html#getPlayerNftInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Nft<wbr/>Inventory</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"><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"><li class="tsd-signature tsd-kind-icon">new <wbr/>Inventories<wbr/>Api<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>, requestFactory<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">InventoriesApiRequestFactory</span>, responseProcessor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">InventoriesApiResponseProcessor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.InventoriesApi.html" class="tsd-signature-type" data-tsd-kind="Class">InventoriesApi</a></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/generated/types/PromiseAPI.ts#L504">src/generated/types/PromiseAPI.ts:504</a></li></ul></aside><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><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> requestFactory: <span class="tsd-signature-type">InventoriesApiRequestFactory</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> responseProcessor: <span class="tsd-signature-type">InventoriesApiResponseProcessor</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="generated.InventoriesApi.html" class="tsd-signature-type" data-tsd-kind="Class">InventoriesApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private 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="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</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">ObservableInventoriesApi</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L502">src/generated/types/PromiseAPI.ts:502</a></li></ul></aside></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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, order<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a>, contractId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, _options<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">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/generated/types/PromiseAPI.ts#L520">src/generated/types/PromiseAPI.ts:520</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the cryptocurrency assets of an existing account.</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>Specifies the unique account ID.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the maximum number of records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the offset for the first records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> order: <a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the order in which to sort the results.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> contractId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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="getAccountInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Account<wbr/>Inventory<a href="#getAccountInventory" 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/>Inventory<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ObsoleteInventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ObsoleteInventoryResponse</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/generated/types/PromiseAPI.ts#L529">src/generated/types/PromiseAPI.ts:529</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Get inventory of account.</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>Specifies the unique account ID.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ObsoleteInventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ObsoleteInventoryResponse</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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<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">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/generated/types/PromiseAPI.ts#L538">src/generated/types/PromiseAPI.ts:538</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the native asset of an existing account.</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>Specifies the unique account ID.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, order<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a>, contractId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, _options<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">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/generated/types/PromiseAPI.ts#L551">src/generated/types/PromiseAPI.ts:551</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the NFT assets of an existing account.</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>Specifies the unique account ID.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the maximum number of records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the offset for the first records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> order: <a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the order in which to sort the results.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> contractId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chainId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, order<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a>, contractId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, _options<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">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/generated/types/PromiseAPI.ts#L565">src/generated/types/PromiseAPI.ts:565</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Get cryptocurrency list of player.</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>Specifies the unique player ID (starts with pla_).</p>
-</div></div></li><li><h5>chainId: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Filter by chain id.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the maximum number of records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the offset for the first records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> order: <a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the order in which to sort the results.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> contractId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Filter by contract ID (starts with con_).</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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="getPlayerInventory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Player<wbr/>Inventory<a href="#getPlayerInventory" 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/>Inventory<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chainId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, _options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ObsoleteInventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ObsoleteInventoryResponse</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/generated/types/PromiseAPI.ts#L575">src/generated/types/PromiseAPI.ts:575</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Get inventory of player.</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>Specifies the unique player ID (starts with pla_).</p>
-</div></div></li><li><h5>chainId: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Filter by chain id.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.ObsoleteInventoryResponse.html" class="tsd-signature-type" data-tsd-kind="Class">ObsoleteInventoryResponse</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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chainId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, _options<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">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/generated/types/PromiseAPI.ts#L585">src/generated/types/PromiseAPI.ts:585</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Get native token list of player.</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>Specifies the unique player ID (starts with pla_).</p>
-</div></div></li><li><h5>chainId: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Filter by chain id.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chainId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, order<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a>, contractId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, _options<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">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/generated/types/PromiseAPI.ts#L599">src/generated/types/PromiseAPI.ts:599</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Get NFTs list of player.</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>Specifies the unique player ID (starts with pla_).</p>
-</div></div></li><li><h5>chainId: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Filter by chain id.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the maximum number of records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the offset for the first records to return.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> order: <a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the order in which to sort the results.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> contractId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Filter by contract ID (starts with con_).</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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></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=" 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="current 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="generated.InventoriesApi.html" class="tsd-kind-icon">Inventories<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.InventoriesApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.InventoriesApi.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.InventoriesApi.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="generated.InventoriesApi.html#getAccountInventory" class="tsd-kind-icon">get<wbr/>Account<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.InventoriesApi.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="generated.InventoriesApi.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="generated.InventoriesApi.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="generated.InventoriesApi.html#getPlayerInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Inventory</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.InventoriesApi.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="generated.InventoriesApi.html#getPlayerNftInventory" class="tsd-kind-icon">get<wbr/>Player<wbr/>Nft<wbr/>Inventory</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-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/generated.IsomorphicFetchHttpLibrary.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>IsomorphicFetchHttpLibrary | @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/generated.html">generated</a></li><li><a href="generated.IsomorphicFetchHttpLibrary.html">IsomorphicFetchHttpLibrary</a></li></ul><h1>Class IsomorphicFetchHttpLibrary </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><span class="target">IsomorphicFetchHttpLibrary</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/generated.HttpLibrary.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpLibrary</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"><a href="generated.IsomorphicFetchHttpLibrary.html#constructor" class="tsd-kind-icon">constructor</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="generated.IsomorphicFetchHttpLibrary.html#send" class="tsd-kind-icon">send</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"><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"><li class="tsd-signature tsd-kind-icon">new <wbr/>Isomorphic<wbr/>Fetch<wbr/>Http<wbr/>Library<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.IsomorphicFetchHttpLibrary.html" class="tsd-signature-type" data-tsd-kind="Class">IsomorphicFetchHttpLibrary</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="generated.IsomorphicFetchHttpLibrary.html" class="tsd-signature-type" data-tsd-kind="Class">IsomorphicFetchHttpLibrary</a></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="send" class="tsd-anchor"></a><h3 class="tsd-anchor-link">send<a href="#send" 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">send<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="generated.RequestContext.html" class="tsd-signature-type" data-tsd-kind="Class">RequestContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated_rxjsStub.Observable.html" class="tsd-signature-type" data-tsd-kind="Class">Observable</a><span class="tsd-signature-symbol"><</span><a href="generated.ResponseContext.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseContext</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/generated.HttpLibrary.html">HttpLibrary</a>.<a href="../interfaces/generated.HttpLibrary.html#send">send</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/http/isomorphic-fetch.ts#L7">src/generated/http/isomorphic-fetch.ts:7</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>request: <a href="generated.RequestContext.html" class="tsd-signature-type" data-tsd-kind="Class">RequestContext</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="generated_rxjsStub.Observable.html" class="tsd-signature-type" data-tsd-kind="Class">Observable</a><span class="tsd-signature-symbol"><</span><a href="generated.ResponseContext.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseContext</a><span class="tsd-signature-symbol">></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=" 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="current 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="generated.IsomorphicFetchHttpLibrary.html" class="tsd-kind-icon">Isomorphic<wbr/>Fetch<wbr/>Http<wbr/>Library</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.IsomorphicFetchHttpLibrary.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.IsomorphicFetchHttpLibrary.html#send" class="tsd-kind-icon">send</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></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/generated.OAuthApi.html DELETED Viewed

@@ -1,40 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OAuthApi | @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/generated.html">generated</a></li><li><a href="generated.OAuthApi.html">OAuthApi</a></li></ul><h1>Class OAuthApi </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><span class="target">OAuthApi</span></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"><a href="generated.OAuthApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private 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="generated.OAuthApi.html#api" class="tsd-kind-icon">api</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="generated.OAuthApi.html#authorizeWithOAuthToken" class="tsd-kind-icon">authorize<wbr/>WithOAuth<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#createOAuthConfig" class="tsd-kind-icon">createOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#deleteOAuthConfig" class="tsd-kind-icon">deleteOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#getOAuthConfig" class="tsd-kind-icon">getOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#getPlayerByExternalId" class="tsd-kind-icon">get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#listOAuthConfig" class="tsd-kind-icon">listOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#verifyOAuthToken" class="tsd-kind-icon">verifyOAuth<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"><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"><li class="tsd-signature tsd-kind-icon">new OAuth<wbr/>Api<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>, requestFactory<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OAuthApiRequestFactory</span>, responseProcessor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OAuthApiResponseProcessor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.OAuthApi.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthApi</a></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/generated/types/PromiseAPI.ts#L615">src/generated/types/PromiseAPI.ts:615</a></li></ul></aside><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><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> requestFactory: <span class="tsd-signature-type">OAuthApiRequestFactory</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> responseProcessor: <span class="tsd-signature-type">OAuthApiResponseProcessor</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="generated.OAuthApi.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private 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="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</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">ObservableOAuthApi</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L613">src/generated/types/PromiseAPI.ts:613</a></li></ul></aside></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="authorizeWithOAuthToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">authorize<wbr/>WithOAuth<wbr/>Token<a href="#authorizeWithOAuthToken" 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">authorize<wbr/>WithOAuth<wbr/>Token<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a>, oAuthRequest<span class="tsd-signature-symbol">: </span><a href="index.OAuthRequest.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthRequest</a>, _options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.AuthorizeWithOAuthToken200Response.html" class="tsd-signature-type" data-tsd-kind="Class">AuthorizeWithOAuthToken200Response</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/generated/types/PromiseAPI.ts#L629">src/generated/types/PromiseAPI.ts:629</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>The endpoint verifies the token generated by OAuth provider, creates or retrieves a player based on his email, and returns the jwt token for the player together with the player id.
-Authorize player with token.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>provider: <a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>OAuth provider</p>
-</div></div></li><li><h5>oAuthRequest: <a href="index.OAuthRequest.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Request body</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.AuthorizeWithOAuthToken200Response.html" class="tsd-signature-type" data-tsd-kind="Class">AuthorizeWithOAuthToken200Response</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="createOAuthConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">createOAuth<wbr/>Config<a href="#createOAuthConfig" 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">createOAuth<wbr/>Config<span class="tsd-signature-symbol">(</span>body<span class="tsd-signature-symbol">: </span><a href="index.OAuthConfig.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfig</a>, _options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.OAuthConfig.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfig</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/generated/types/PromiseAPI.ts#L639">src/generated/types/PromiseAPI.ts:639</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>The endpoint creates oauth configuration for the current project environment.
-Create oauth configuration.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>body: <a href="index.OAuthConfig.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfig</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the oauth provider specific configuration.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.OAuthConfig.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfig</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="deleteOAuthConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">deleteOAuth<wbr/>Config<a href="#deleteOAuthConfig" 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">deleteOAuth<wbr/>Config<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a>, _options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><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/generated/types/PromiseAPI.ts#L649">src/generated/types/PromiseAPI.ts:649</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>The endpoint deletes oauth configuration for specified provider for the current project environment.
-Delete oauth configuration.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>provider: <a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the oauth provider type.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><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="getOAuthConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">getOAuth<wbr/>Config<a href="#getOAuthConfig" 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">getOAuth<wbr/>Config<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a>, _options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.OAuthConfig.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfig</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/generated/types/PromiseAPI.ts#L659">src/generated/types/PromiseAPI.ts:659</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>The endpoint retrieves oauth configuration for specified provider for the current project environment.
-Get oauth configuration.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>provider: <a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Specifies the oauth provider type.</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.OAuthConfig.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfig</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="getPlayerByExternalId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<a href="#getPlayerByExternalId" 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/>By<wbr/>External<wbr/>Id<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a>, externalUserId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<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">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/generated/types/PromiseAPI.ts#L670">src/generated/types/PromiseAPI.ts:670</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the player based on his id in the external provider system.
-Retrieve player by external id.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>provider: <a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>OAuth provider</p>
-</div></div></li><li><h5>externalUserId: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>External user id</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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 class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="listOAuthConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">listOAuth<wbr/>Config<a href="#listOAuthConfig" 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">listOAuth<wbr/>Config<span class="tsd-signature-symbol">(</span>_options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.OAuthConfigListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfigListResponse</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/generated/types/PromiseAPI.ts#L679">src/generated/types/PromiseAPI.ts:679</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>The endpoint retrieves the list of oauth configurations for the current project environment.
-List of oauth configurations.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="index.OAuthConfigListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthConfigListResponse</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="verifyOAuthToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">verifyOAuth<wbr/>Token<a href="#verifyOAuthToken" 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">verifyOAuth<wbr/>Token<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a>, oAuthRequest<span class="tsd-signature-symbol">: </span><a href="index.OAuthRequest.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthRequest</a>, _options<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">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/generated/types/PromiseAPI.ts#L690">src/generated/types/PromiseAPI.ts:690</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
-Retrieve player by token.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>provider: <a href="../modules/index.html#OAuthProvider" class="tsd-signature-type" data-tsd-kind="Type alias">OAuthProvider</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>OAuth provider</p>
-</div></div></li><li><h5>oAuthRequest: <a href="index.OAuthRequest.html" class="tsd-signature-type" data-tsd-kind="Class">OAuthRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Request body</p>
-</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <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">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=" 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="current 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="generated.OAuthApi.html" class="tsd-kind-icon">OAuth<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.OAuthApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.OAuthApi.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#authorizeWithOAuthToken" class="tsd-kind-icon">authorize<wbr/>WithOAuth<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#createOAuthConfig" class="tsd-kind-icon">createOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#deleteOAuthConfig" class="tsd-kind-icon">deleteOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#getOAuthConfig" class="tsd-kind-icon">getOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#getPlayerByExternalId" class="tsd-kind-icon">get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#listOAuthConfig" class="tsd-kind-icon">listOAuth<wbr/>Config</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.OAuthApi.html#verifyOAuthToken" class="tsd-kind-icon">verifyOAuth<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-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/generated.PkAuthentication.html DELETED Viewed

@@ -1,9 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PkAuthentication | @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/generated.html">generated</a></li><li><a href="generated.PkAuthentication.html">PkAuthentication</a></li></ul><h1>Class PkAuthentication </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Applies http authentication to the request context.</p>
-</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PkAuthentication</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/generated.SecurityAuthentication.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityAuthentication</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"><a href="generated.PkAuthentication.html#constructor" class="tsd-kind-icon">constructor</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="generated.PkAuthentication.html#applySecurityAuthentication" class="tsd-kind-icon">apply<wbr/>Security<wbr/>Authentication</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PkAuthentication.html#getName" class="tsd-kind-icon">get<wbr/>Name</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"><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"><li class="tsd-signature tsd-kind-icon">new <wbr/>Pk<wbr/>Authentication<span class="tsd-signature-symbol">(</span>tokenProvider<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.TokenProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TokenProvider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.PkAuthentication.html" class="tsd-signature-type" data-tsd-kind="Class">PkAuthentication</a></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/generated/auth/auth.ts#L33">src/generated/auth/auth.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Configures the http authentication with the required details.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tokenProvider: <a href="../interfaces/generated.TokenProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TokenProvider</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>service that can provide the up-to-date token when needed</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="generated.PkAuthentication.html" class="tsd-signature-type" data-tsd-kind="Class">PkAuthentication</a></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="applySecurityAuthentication" class="tsd-anchor"></a><h3 class="tsd-anchor-link">apply<wbr/>Security<wbr/>Authentication<a href="#applySecurityAuthentication" 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">apply<wbr/>Security<wbr/>Authentication<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="generated.RequestContext.html" class="tsd-signature-type" data-tsd-kind="Class">RequestContext</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/generated.SecurityAuthentication.html">SecurityAuthentication</a>.<a href="../interfaces/generated.SecurityAuthentication.html#applySecurityAuthentication">applySecurityAuthentication</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/auth/auth.ts#L39">src/generated/auth/auth.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Applies the authentication scheme to the request context</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>context: <a href="generated.RequestContext.html" class="tsd-signature-type" data-tsd-kind="Class">RequestContext</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><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="getName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Name<a href="#getName" 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/>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/generated.SecurityAuthentication.html">SecurityAuthentication</a>.<a href="../interfaces/generated.SecurityAuthentication.html#getName">getName</a></p><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/auth/auth.ts#L35">src/generated/auth/auth.ts:35</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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=" 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="current 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="generated.PkAuthentication.html" class="tsd-kind-icon">Pk<wbr/>Authentication</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.PkAuthentication.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PkAuthentication.html#applySecurityAuthentication" class="tsd-kind-icon">apply<wbr/>Security<wbr/>Authentication</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PkAuthentication.html#getName" class="tsd-kind-icon">get<wbr/>Name</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></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>