Deployed a36ece7 to next with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
CI 2026-03-19 23:25:57 +00:00
parent 2deb699794
commit a9e9d5836d
38 changed files with 2542 additions and 4 deletions

View File

@ -461,6 +461,34 @@
<li class="md-nav__item">
<a href="/Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/Docs/Parcel/" class="md-nav__link">

View File

@ -482,6 +482,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -541,6 +541,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -552,6 +552,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -591,6 +591,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -482,6 +482,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -12,7 +12,7 @@
<link rel="prev" href="../FormPS1583/">
<link rel="next" href="../Parcel/">
<link rel="next" href="../HiddenConfigs/">
@ -552,6 +552,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

File diff suppressed because it is too large Load Diff

View File

@ -9,7 +9,7 @@
<link rel="prev" href="../HTTP_API_Server/">
<link rel="prev" href="../HiddenConfigs/">
<link rel="next" href="../Receipt/">
@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>

View File

@ -472,6 +472,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -472,6 +472,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -472,6 +472,34 @@
<li class="md-nav__item">
<a href="../HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">
@ -959,6 +987,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#barcoderegisterdropoffcarrierscanhandlercarrier-fn" class="md-nav__link">
<span class="md-ellipsis">
barcode.registerDropOffCarrierScanHandler(carrier, fn)
</span>
</a>
</li>
</ul>
@ -1553,6 +1592,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#barcoderegisterdropoffcarrierscanhandlercarrier-fn" class="md-nav__link">
<span class="md-ellipsis">
barcode.registerDropOffCarrierScanHandler(carrier, fn)
</span>
</a>
</li>
</ul>
@ -1592,6 +1642,7 @@
<li><a href="#barcode.addPrepaidBarcode">.addPrepaidBarcode(trackingBarcodeData)</a></li>
<li><a href="#barcode.inject">.inject(barcodeData)</a></li>
<li><a href="#barcode.onPrepaidScan">.onPrepaidScan(f)</a></li>
<li><a href="#barcode.registerDropOffCarrierScanHandler">.registerDropOffCarrierScanHandler(carrier, fn)</a></li>
</ul>
</li>
</ul>
@ -1767,6 +1818,51 @@ If the barcode is handled by this function, it shall return a TrackingBarcode ob
</tr>
</tbody>
</table>
<p><a name="barcode.registerDropOffCarrierScanHandler"></a></p>
<h3 id="barcoderegisterdropoffcarrierscanhandlercarrier-fn">barcode.registerDropOffCarrierScanHandler(carrier, fn)</h3>
<p>Register to handle prepaid drop off scans for a particular shipping carrier.
Scans are kept in a local, disk-backed queue and the function registered here will be
called when a queued barcode is processed for the provided carrier.
This function is intended for carrier drop-off reimbursement programs such as ASO and FASC.</p>
<p><strong>Kind</strong>: static method of <a href="#barcode"><code>barcode</code></a><br />
<strong>Throws</strong>:</p>
<ul>
<li><code>Error</code> - Only one plugin may register a particular carrier with this function;
any subsequent attempts to register to handle that carrier will throw an Error.</li>
</ul>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>carrier</td>
<td><code>string</code></td>
<td>Carrier name to register for.</td>
</tr>
<tr>
<td>fn</td>
<td><code>function</code></td>
<td>Async function to pass scan details to. Returns true if processed, false if not processed (but the barcode should be removed from queue), or throws an Error if it should be retried later. See example for data and usage.</td>
</tr>
</tbody>
</table>
<p><strong>Example</strong><br />
<div class="language-js highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nb">global</span><span class="p">.</span><span class="nx">apis</span><span class="p">.</span><span class="nx">barcode</span><span class="p">.</span><span class="nx">registerDropOffCarrierScanHandler</span><span class="p">(</span><span class="s2">&quot;FedEx&quot;</span><span class="p">,</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="p">(</span><span class="nx">data</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nb">global</span><span class="p">.</span><span class="nx">apis</span><span class="p">.</span><span class="nx">alert</span><span class="p">(</span><span class="sb">`Carrier: </span><span class="si">${</span><span class="nx">data</span><span class="p">.</span><span class="nx">carrier</span><span class="si">}</span><span class="sb">, Tracking number: </span><span class="si">${</span><span class="nx">data</span><span class="p">.</span><span class="nx">tracking</span><span class="si">}</span><span class="sb">, `</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="sb">`Raw scanned barcode: </span><span class="si">${</span><span class="nx">data</span><span class="p">.</span><span class="nx">barcode</span><span class="si">}</span><span class="sb">, `</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="sb">`UNIX timestamp of scan: </span><span class="si">${</span><span class="nx">data</span><span class="p">.</span><span class="nx">timestamp</span><span class="si">}</span><span class="sb">, Scan UUID: </span><span class="si">${</span><span class="nx">data</span><span class="p">.</span><span class="nx">uuid</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="s2">&quot;Processing DropOffCarrierScan data&quot;</span><span class="p">);</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="kc">false</span><span class="p">;</span><span class="w"> </span><span class="c1">// Not processed but should be discarded</span>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Processed, discard from queue</span>
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s2">&quot;Failed to process, try again later&quot;</span><span class="p">);</span>
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">});</span>
</span></code></pre></div></p>

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">
@ -1607,7 +1635,7 @@ installations of PostalPoint on the LAN.</p>
<h3 id="httpserversendrequesttoremotedata-endpointid-serveraddress-serverport-promiseobject">httpserver.sendRequestToRemote(data, endpointID, serverAddress, serverPort) ⇒ <code>Promise.&lt;Object&gt;</code></h3>
<p>Send a HTTP request to another PostalPoint installation on the local network.</p>
<p><strong>Kind</strong>: static method of <a href="#httpserver"><code>httpserver</code></a><br />
<strong>Returns</strong>: <code>Promise.&lt;Object&gt;</code> - - The JSON reply.<br />
<strong>Returns</strong>: <code>Promise.&lt;Object&gt;</code> - The JSON reply.<br />
<strong>Throws</strong>:</p>
<ul>
<li><code>Error</code> When there's a network or other unrecoverable error while completing the request. Error message is a human-readable description of the problem.</li>

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -470,6 +470,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -468,6 +468,34 @@
<li class="md-nav__item">
<a href="../../Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../Docs/Parcel/" class="md-nav__link">

View File

@ -581,6 +581,34 @@
<li class="md-nav__item">
<a href="Docs/HiddenConfigs/" class="md-nav__link">
<span class="md-ellipsis">
Configuration Flags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="Docs/Parcel/" class="md-nav__link">

File diff suppressed because one or more lines are too long

Binary file not shown.