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/interfaces/generated.PromiseHttpLibrary.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>PromiseHttpLibrary | @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.PromiseHttpLibrary.html">PromiseHttpLibrary</a></li></ul><h1>Interface PromiseHttpLibrary </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">PromiseHttpLibrary</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.PromiseHttpLibrary.html#send" class="tsd-kind-icon">send</a></li></ul></section></div></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-interface"><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-interface"><li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="../classes/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"><</span><a href="../classes/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"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/http/http.ts#L220">src/generated/http/http.ts:220</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>request: <a href="../classes/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"><</span><a href="../classes/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-interface tsd-parent-kind-module"><a href="generated.PromiseHttpLibrary.html" class="tsd-kind-icon">Promise<wbr/>Http<wbr/>Library</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.PromiseHttpLibrary.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-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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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></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/interfaces/generated.ResponseBody.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>ResponseBody | @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.ResponseBody.html">ResponseBody</a></li></ul><h1>Interface ResponseBody </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">ResponseBody</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/generated.SelfDecodingBody.html" class="tsd-signature-type" data-tsd-kind="Class">SelfDecodingBody</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.ResponseBody.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.ResponseBody.html#text" class="tsd-kind-icon">text</a></li></ul></section></div></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-interface"><a id="binary" class="tsd-anchor"></a><h3 class="tsd-anchor-link">binary<a href="#binary" 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-interface"><li class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/http/http.ts#L136">src/generated/http/http.ts:136</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="text" class="tsd-anchor"></a><h3 class="tsd-anchor-link">text<a href="#text" 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-interface"><li class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/http/http.ts#L135">src/generated/http/http.ts:135</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><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-interface tsd-parent-kind-module"><a href="generated.ResponseBody.html" class="tsd-kind-icon">Response<wbr/>Body</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.ResponseBody.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.ResponseBody.html#text" class="tsd-kind-icon">text</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-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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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></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/interfaces/generated.SecurityAuthentication.html DELETED Viewed

@@ -1,6 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityAuthentication | @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.SecurityAuthentication.html">SecurityAuthentication</a></li></ul><h1>Interface SecurityAuthentication </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>Interface authentication schemes.</p>
-</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SecurityAuthentication</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/generated.PkAuthentication.html" class="tsd-signature-type" data-tsd-kind="Class">PkAuthentication</a></li><li><a href="../classes/generated.SkAuthentication.html" class="tsd-signature-type" data-tsd-kind="Class">SkAuthentication</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.SecurityAuthentication.html#applySecurityAuthentication" class="tsd-kind-icon">apply<wbr/>Security<wbr/>Authentication</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.SecurityAuthentication.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>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><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-interface"><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="../classes/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">void</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/auth/auth.ts#L17">src/generated/auth/auth.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Applies the authentication scheme to the request context</p>
-</div><dl class="tsd-comment-tags"><dt>params</dt><dd><p>context the request context which should use this authentication scheme</p>
-</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>context: <a href="../classes/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">void</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></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><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-interface"><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"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/auth/auth.ts#L10">src/generated/auth/auth.ts:10</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-interface tsd-parent-kind-module"><a href="generated.SecurityAuthentication.html" class="tsd-kind-icon">Security<wbr/>Authentication</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.SecurityAuthentication.html#applySecurityAuthentication" class="tsd-kind-icon">apply<wbr/>Security<wbr/>Authentication</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.SecurityAuthentication.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-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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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></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/interfaces/generated.TokenProvider.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>TokenProvider | @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.TokenProvider.html">TokenProvider</a></li></ul><h1>Interface TokenProvider </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">TokenProvider</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.TokenProvider.html#getToken" class="tsd-kind-icon">get<wbr/>Token</a></li></ul></section></div></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-interface"><a id="getToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<a href="#getToken" 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-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/auth/auth.ts#L21">src/generated/auth/auth.ts:21</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><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-interface tsd-parent-kind-module"><a href="generated.TokenProvider.html" class="tsd-kind-icon">Token<wbr/>Provider</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated.TokenProvider.html#getToken" class="tsd-kind-icon">get<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-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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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></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/interfaces/generated_configuration.Configuration.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>Configuration | @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_configuration.html">generated/configuration</a></li><li><a href="generated_configuration.Configuration.html">Configuration</a></li></ul><h1>Interface Configuration </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">Configuration</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#authMethods" class="tsd-kind-icon">auth<wbr/>Methods</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#baseServer" class="tsd-kind-icon">base<wbr/>Server</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#httpApi" class="tsd-kind-icon">http<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#middleware" class="tsd-kind-icon">middleware</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="authMethods" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> auth<wbr/>Methods<a href="#authMethods" 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">auth<wbr/>Methods<span class="tsd-signature-symbol">:</span> <a href="../modules/generated.html#AuthMethods" class="tsd-signature-type" data-tsd-kind="Type alias">AuthMethods</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L11">src/generated/configuration.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="baseServer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> base<wbr/>Server<a href="#baseServer" 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">base<wbr/>Server<span class="tsd-signature-symbol">:</span> <a href="generated_servers.BaseServerConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseServerConfiguration</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L8">src/generated/configuration.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="httpApi" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> http<wbr/>Api<a href="#httpApi" 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">http<wbr/>Api<span class="tsd-signature-symbol">:</span> <a href="generated.HttpLibrary.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpLibrary</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L9">src/generated/configuration.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="middleware" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> middleware<a href="#middleware" 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">middleware<span class="tsd-signature-symbol">:</span> <a href="generated_middleware.Middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L10">src/generated/configuration.ts:10</a></li></ul></aside></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=" tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class="current 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-interface tsd-parent-kind-module"><a href="generated_configuration.Configuration.html" class="tsd-kind-icon">Configuration</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#authMethods" class="tsd-kind-icon">auth<wbr/>Methods</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#baseServer" class="tsd-kind-icon">base<wbr/>Server</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#httpApi" class="tsd-kind-icon">http<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.Configuration.html#middleware" class="tsd-kind-icon">middleware</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-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><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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></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/interfaces/generated_configuration.ConfigurationParameters.html DELETED Viewed

@@ -1,26 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConfigurationParameters | @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_configuration.html">generated/configuration</a></li><li><a href="generated_configuration.ConfigurationParameters.html">ConfigurationParameters</a></li></ul><h1>Interface ConfigurationParameters </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>Interface with which a configuration object can be configured.</p>
-</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ConfigurationParameters</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#authMethods" class="tsd-kind-icon">auth<wbr/>Methods</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#baseServer" class="tsd-kind-icon">base<wbr/>Server</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#httpApi" class="tsd-kind-icon">http<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#middleware" class="tsd-kind-icon">middleware</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#promiseMiddleware" class="tsd-kind-icon">promise<wbr/>Middleware</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="authMethods" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> auth<wbr/>Methods<a href="#authMethods" 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">auth<wbr/>Methods<span class="tsd-signature-symbol">?:</span> <a href="../modules/generated.html#AuthMethodsConfiguration" class="tsd-signature-type" data-tsd-kind="Type alias">AuthMethodsConfiguration</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L52">src/generated/configuration.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Configuration for the available authentication methods (e.g., api keys)
-according to the OpenAPI yaml definition. For the definition, please refer to
-<code>./auth/auth</code></p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="baseServer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> base<wbr/>Server<a href="#baseServer" 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">base<wbr/>Server<span class="tsd-signature-symbol">?:</span> <a href="generated_servers.BaseServerConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseServerConfiguration</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L25">src/generated/configuration.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Default server to use - a list of available servers (according to the
-OpenAPI yaml definition) is included in the <code>servers</code> const in <code>./servers</code>. You can also
-create your own server with the <code>ServerConfiguration</code> class from the same
-file.</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="httpApi" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> http<wbr/>Api<a href="#httpApi" 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">http<wbr/>Api<span class="tsd-signature-symbol">?:</span> <a href="generated.HttpLibrary.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpLibrary</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L31">src/generated/configuration.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>HTTP library to use e.g. IsomorphicFetch. This can usually be skipped as
-all generators come with a default library.
-If available, additional libraries can be imported from <code>./http/*</code></p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="middleware" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> middleware<a href="#middleware" 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">middleware<span class="tsd-signature-symbol">?:</span> <a href="generated_middleware.Middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L39">src/generated/configuration.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>The middlewares which will be applied to requests and responses. You can
-add any number of middleware components to modify requests before they
-are sent or before they are deserialized by implementing the <code>Middleware</code>
-interface defined in <code>./middleware</code></p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="promiseMiddleware" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> promise<wbr/>Middleware<a href="#promiseMiddleware" 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">promise<wbr/>Middleware<span class="tsd-signature-symbol">?:</span> <a href="generated_middleware.PromiseMiddleware.html" class="tsd-signature-type" data-tsd-kind="Interface">PromiseMiddleware</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/configuration.ts#L46">src/generated/configuration.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Configures middleware functions that return promises instead of
-Observables (which are used by <code>middleware</code>). Otherwise allows for the
-same functionality as <code>middleware</code>, i.e., modifying requests before they
-are sent and before they are deserialized.</p>
-</div></div></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=" tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class="current 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-interface tsd-parent-kind-module"><a href="generated_configuration.ConfigurationParameters.html" class="tsd-kind-icon">Configuration<wbr/>Parameters</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#authMethods" class="tsd-kind-icon">auth<wbr/>Methods</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#baseServer" class="tsd-kind-icon">base<wbr/>Server</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#httpApi" class="tsd-kind-icon">http<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#middleware" class="tsd-kind-icon">middleware</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated_configuration.ConfigurationParameters.html#promiseMiddleware" class="tsd-kind-icon">promise<wbr/>Middleware</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-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><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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></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/interfaces/generated_middleware.Middleware.html DELETED Viewed

@@ -1,15 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Middleware | @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_middleware.html">generated/middleware</a></li><li><a href="generated_middleware.Middleware.html">Middleware</a></li></ul><h1>Interface Middleware </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>Defines the contract for a middleware intercepting requests before
-they are sent (but after the RequestContext was created)
-and before the ResponseContext is unwrapped.</p>
-</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Middleware</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/generated_middleware.PromiseMiddlewareWrapper.html" class="tsd-signature-type" data-tsd-kind="Class">PromiseMiddlewareWrapper</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated_middleware.Middleware.html#post" class="tsd-kind-icon">post</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated_middleware.Middleware.html#pre" class="tsd-kind-icon">pre</a></li></ul></section></div></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-interface"><a id="post" class="tsd-anchor"></a><h3 class="tsd-anchor-link">post<a href="#post" 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-interface"><li class="tsd-signature tsd-kind-icon">post<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../classes/generated.ResponseContext.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/generated_rxjsStub.Observable.html" class="tsd-signature-type" data-tsd-kind="Class">Observable</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/generated.ResponseContext.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseContext</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/middleware.ts#L25">src/generated/middleware.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Modifies the returned response before it is deserialized.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>context: <a href="../classes/generated.ResponseContext.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseContext</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>ResponseContext of a sent request</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../classes/generated_rxjsStub.Observable.html" class="tsd-signature-type" data-tsd-kind="Class">Observable</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/generated.ResponseContext.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseContext</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>an observable of the modified response context</p>
-</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="pre" class="tsd-anchor"></a><h3 class="tsd-anchor-link">pre<a href="#pre" 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-interface"><li class="tsd-signature tsd-kind-icon">pre<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../classes/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="../classes/generated_rxjsStub.Observable.html" class="tsd-signature-type" data-tsd-kind="Class">Observable</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/generated.RequestContext.html" class="tsd-signature-type" data-tsd-kind="Class">RequestContext</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/middleware.ts#L18">src/generated/middleware.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Modifies the request before the request is sent.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>context: <a href="../classes/generated.RequestContext.html" class="tsd-signature-type" data-tsd-kind="Class">RequestContext</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>RequestContext of a request which is about to be sent to the server</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../classes/generated_rxjsStub.Observable.html" class="tsd-signature-type" data-tsd-kind="Class">Observable</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/generated.RequestContext.html" class="tsd-signature-type" data-tsd-kind="Class">RequestContext</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>an observable of the updated request context</p>
-</div></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=" 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="current 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-interface tsd-parent-kind-module"><a href="generated_middleware.Middleware.html" class="tsd-kind-icon">Middleware</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated_middleware.Middleware.html#post" class="tsd-kind-icon">post</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="generated_middleware.Middleware.html#pre" class="tsd-kind-icon">pre</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-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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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></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>