PostalPortal/PostalPoint_Plugins
PostalPortal/PostalPoint_Plugins
2
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update API docss
All checks were successful
Build and Deploy MkDocs / build-next (push) Successful in 2m11s
Details

Browse Source
This commit is contained in:
Skylar Ittner 2026-03-27 16:34:01 -06:00
parent 4c2e60a775
commit a703139760
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Plugin API/shipping.md
View File

@ -260,7 +260,9 @@ Add a shipping insurance provider.
**Example** **Example**
```js ```js
async function getQuote(value, parcel, carrier, service) { async function getQuote(value, parcel, carrier, service, rateObject) {
// See shipping rate provider documentation for rateObject structure.
// Do math, etc // Do math, etc
var cost = value / 100; var cost = value / 100;

2
docs/Plugin API/ui.md
View File

@ -244,7 +244,7 @@ the customerSignatureCollected event is emitted with the data
| Param | Type | Default | Description | | Param | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| title | <code>string</code> | <code>null</code> | Display a title/header on the customer screen. Currently ignored, but may be used in the future. | | title | <code>string</code> | <code>null</code> | Display some title/header text on the customer screen near the signature box. Not shown if terms are set. |
| terms | <code>string</code> \| <code>boolean</code> | <code>false</code> | Set to a string to display terms and conditions or other text content next to the signature pad. | | terms | <code>string</code> \| <code>boolean</code> | <code>false</code> | Set to a string to display terms and conditions or other text content next to the signature pad. |
| termstype | <code>string</code> | <code>&quot;body&quot;</code> | "html", "pdf", "raw", or "body". See setCustomerScreen() | | termstype | <code>string</code> | <code>&quot;body&quot;</code> | "html", "pdf", "raw", or "body". See setCustomerScreen() |