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

@openfort/openfort-node 0.6.26 → 0.6.28

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

Files changed (394) hide show

package/docs/classes/apis_policyRulesApiWrapper.PolicyRulesApiWrapper.html DELETED Viewed

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

package/docs/classes/apis_sessionsApiWrapper.SessionsApiWrapper.html DELETED Viewed

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

package/docs/classes/apis_settingsApiWrapper.SettingsApiWrapper.html DELETED Viewed

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

package/docs/classes/apis_transactionIntentsApiWrapper.TransactionIntentsApiWrapper.html DELETED Viewed

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