update typedocs

This commit is contained in:
woodser 2023-07-28 11:16:01 -04:00
parent ac788ca45e
commit e11cf26e7e
15 changed files with 160 additions and 160 deletions

View file

@ -17,7 +17,7 @@
<li><a href="../modules/protobuf_grpc_pb.PostOfferRequest.html">PostOfferRequest</a></li>
<li><a href="protobuf_grpc_pb.PostOfferRequest.AsObject.html">AsObject</a></li></ul>
<h1>Type alias AsObject</h1></div>
<div class="tsd-signature">As<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>buyerSecurityDepositPct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>currencyCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>direction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>marketPriceMarginPct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>minAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>paymentAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>splitOutput<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>triggerPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>useMarketBasedPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
<div class="tsd-signature">As<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>buyerSecurityDepositPct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>currencyCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>direction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>marketPriceMarginPct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>minAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>paymentAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveExactAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>triggerPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>useMarketBasedPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
@ -38,7 +38,7 @@
<li class="tsd-parameter">
<h5>price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">
<h5>split<wbr/>Output<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li>
<h5>reserve<wbr/>Exact<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5>trigger<wbr/>Price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">

View file

@ -17,13 +17,15 @@
<li><a href="../modules/protobuf_pb_pb.OpenOffer.html">OpenOffer</a></li>
<li><a href="protobuf_pb_pb.OpenOffer.AsObject.html">AsObject</a></li></ul>
<h1>Type alias AsObject</h1></div>
<div class="tsd-signature">As<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>offer<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.Offer.html" class="tsd-signature-type" data-tsd-kind="Namespace">Offer</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.Offer.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveTxHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveTxHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveTxKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>scheduledAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>scheduledTxHashesList<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><br/><span>    </span>splitOutput<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>splitOutputTxHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>state<span class="tsd-signature-symbol">: </span><a href="../modules/protobuf_pb_pb.OpenOffer.html" class="tsd-signature-type" data-tsd-kind="Namespace">OpenOffer</a><span class="tsd-signature-symbol">.</span><a href="../enums/protobuf_pb_pb.OpenOffer.State.html" class="tsd-signature-type" data-tsd-kind="Enumeration">State</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>triggerPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
<div class="tsd-signature">As<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>offer<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.Offer.html" class="tsd-signature-type" data-tsd-kind="Namespace">Offer</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.Offer.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveExactAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveTxHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveTxHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>reserveTxKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>scheduledAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>scheduledTxHashesList<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><br/><span>    </span>splitOutputTxHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>state<span class="tsd-signature-symbol">: </span><a href="../modules/protobuf_pb_pb.OpenOffer.html" class="tsd-signature-type" data-tsd-kind="Namespace">OpenOffer</a><span class="tsd-signature-symbol">.</span><a href="../enums/protobuf_pb_pb.OpenOffer.State.html" class="tsd-signature-type" data-tsd-kind="Enumeration">State</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>triggerPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> offer<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.Offer.html" class="tsd-signature-type" data-tsd-kind="Namespace">Offer</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.Offer.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a></h5></li>
<li class="tsd-parameter">
<h5>reserve<wbr/>Exact<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5>reserve<wbr/>Tx<wbr/>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">
<h5>reserve<wbr/>Tx<wbr/>Hex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
@ -34,8 +36,6 @@
<li class="tsd-parameter">
<h5>scheduled<wbr/>Tx<wbr/>Hashes<wbr/>List<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
<li class="tsd-parameter">
<h5>split<wbr/>Output<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li>
<li class="tsd-parameter">
<h5>split<wbr/>Output<wbr/>Tx<wbr/>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
<li class="tsd-parameter">
<h5>state<span class="tsd-signature-symbol">: </span><a href="../modules/protobuf_pb_pb.OpenOffer.html" class="tsd-signature-type" data-tsd-kind="Namespace">OpenOffer</a><span class="tsd-signature-symbol">.</span><a href="../enums/protobuf_pb_pb.OpenOffer.State.html" class="tsd-signature-type" data-tsd-kind="Enumeration">State</a></h5></li>