[DOCS] v16.0.0

Files changed:
M	docs/assets/search.js
M	docs/classes/OneBlinkAppsError.html
M	docs/classes/paymentService.westpacQuickStream.default.html
M	docs/interfaces/scheduledTasksService.TaskAvailability.html
M	docs/interfaces/scheduledTasksService.TaskResponse.html
M	docs/modules.html
M	docs/modules/approvalsService.html
M	docs/modules/attachmentsService.html
M	docs/modules/authService.html
M	docs/modules/autoSaveService.html
M	docs/modules/draftService.html
M	docs/modules/formService.html
M	docs/modules/formStoreService.html
M	docs/modules/formsAppService.html
M	docs/modules/jobService.html
M	docs/modules/localisationService.html
M	docs/modules/notificationService.html
M	docs/modules/offlineService.html
M	docs/modules/paymentService.html
M	docs/modules/paymentService.westpacQuickStream.html
M	docs/modules/prefillService.html
M	docs/modules/scheduledTasksService.html
M	docs/modules/schedulingService.html
M	docs/modules/submissionService.html

docs/modules/formsAppService.html

@@ -6,7 +6,7 @@ <h2>Forms App Service</h2>
 </div><div><p>Helper functions for forms apps</p>
 <pre><code class="language-js"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">formsAppService</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&#39;@oneblink/apps&#39;</span>
 </code></pre>
-</div></div></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>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="formsAppService.html#FormsAppConfigurationResponse" class="tsd-kind-icon">Forms<wbr/>App<wbr/>Configuration<wbr/>Response</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="formsAppService.html#getFormsAppConfiguration" class="tsd-kind-icon">get<wbr/>Forms<wbr/>App<wbr/>Configuration</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="FormsAppConfigurationResponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Forms<wbr/>App<wbr/>Configuration<wbr/>Response<a href="#FormsAppConfigurationResponse" 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">Forms<wbr/>App<wbr/>Configuration<wbr/>Response<span class="tsd-signature-symbol">:</span> <a href="FormsAppsTypes.html#FormsAppConfiguration" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppConfiguration</a><span class="tsd-signature-symbol">&lt;</span><a href="FormsAppsTypes.html#BaseFormsAppStyles" class="tsd-signature-type" data-tsd-kind="Type alias">BaseFormsAppStyles</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oneblink/apps/blob/17cf756/src/forms-app-service.ts#L8">src/forms-app-service.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getFormsAppConfiguration" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Forms<wbr/>App<wbr/>Configuration<a href="#getFormsAppConfiguration" 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-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Forms<wbr/>App<wbr/>Configuration<span class="tsd-signature-symbol">(</span>formsAppId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, abortSignal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</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="formsAppService.html#FormsAppConfigurationResponse" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppConfigurationResponse</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/oneblink/apps/blob/17cf756/src/forms-app-service.ts#L26">src/forms-app-service.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></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>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="formsAppService.html#FormsAppConfigurationResponse" class="tsd-kind-icon">Forms<wbr/>App<wbr/>Configuration<wbr/>Response</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="formsAppService.html#getFormsAppConfiguration" class="tsd-kind-icon">get<wbr/>Forms<wbr/>App<wbr/>Configuration</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="FormsAppConfigurationResponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Forms<wbr/>App<wbr/>Configuration<wbr/>Response<a href="#FormsAppConfigurationResponse" 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">Forms<wbr/>App<wbr/>Configuration<wbr/>Response<span class="tsd-signature-symbol">:</span> <a href="FormsAppsTypes.html#FormsAppConfiguration" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppConfiguration</a><span class="tsd-signature-symbol">&lt;</span><a href="FormsAppsTypes.html#BaseFormsAppStyles" class="tsd-signature-type" data-tsd-kind="Type alias">BaseFormsAppStyles</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oneblink/apps/blob/8ea94e8/src/forms-app-service.ts#L8">src/forms-app-service.ts:8</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getFormsAppConfiguration" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Forms<wbr/>App<wbr/>Configuration<a href="#getFormsAppConfiguration" 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-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Forms<wbr/>App<wbr/>Configuration<span class="tsd-signature-symbol">(</span>formsAppId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, abortSignal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</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="formsAppService.html#FormsAppConfigurationResponse" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppConfigurationResponse</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/oneblink/apps/blob/8ea94e8/src/forms-app-service.ts#L26">src/forms-app-service.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Get configuration for a OneBlink Forms App.</p>
 </div><div>
 <a href="#example" id="example" style="color: inherit; text-decoration: none;">

docs/modules/jobService.html

@@ -6,7 +6,7 @@ <h2>Job Service</h2>
 </div><div><p>Helper functions for job handling</p>
 <pre><code class="language-js"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">jobService</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&#39;@oneblink/apps&#39;</span>
 </code></pre>
-</div></div></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>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="jobService.html#ensurePrefillFormDataExists" class="tsd-kind-icon">ensure<wbr/>Prefill<wbr/>Form<wbr/>Data<wbr/>Exists</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="jobService.html#getJobs" class="tsd-kind-icon">get<wbr/>Jobs</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="ensurePrefillFormDataExists" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ensure<wbr/>Prefill<wbr/>Form<wbr/>Data<wbr/>Exists<a href="#ensurePrefillFormDataExists" 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-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">ensure<wbr/>Prefill<wbr/>Form<wbr/>Data<wbr/>Exists<span class="tsd-signature-symbol">(</span>jobs<span class="tsd-signature-symbol">: </span><a href="SubmissionTypes.html#FormsAppJob" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppJob</a><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/oneblink/apps/blob/17cf756/src/services/job-prefill.ts#L76">src/services/job-prefill.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></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>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="jobService.html#ensurePrefillFormDataExists" class="tsd-kind-icon">ensure<wbr/>Prefill<wbr/>Form<wbr/>Data<wbr/>Exists</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="jobService.html#getJobs" class="tsd-kind-icon">get<wbr/>Jobs</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="ensurePrefillFormDataExists" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ensure<wbr/>Prefill<wbr/>Form<wbr/>Data<wbr/>Exists<a href="#ensurePrefillFormDataExists" 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-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">ensure<wbr/>Prefill<wbr/>Form<wbr/>Data<wbr/>Exists<span class="tsd-signature-symbol">(</span>jobs<span class="tsd-signature-symbol">: </span><a href="SubmissionTypes.html#FormsAppJob" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppJob</a><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/oneblink/apps/blob/8ea94e8/src/services/job-prefill.ts#L76">src/services/job-prefill.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Helper to store Job prefill data locally if it is not currently in the local
 store. Pass in an array of Jobs.</p>
 </div><div>
@@ -15,7 +15,7 @@ <h4>Example</h4>
 </a>
 <pre><code class="language-js"><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-8">jobs</span><span class="hl-0"> = [...]</span><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">jobService</span><span class="hl-0">.</span><span class="hl-4">ensurePrefillFormDataExists</span><span class="hl-0">(</span><span class="hl-2">jobs</span><span class="hl-0">)</span>
 </code></pre>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jobs: <a href="SubmissionTypes.html#FormsAppJob" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppJob</a><span class="tsd-signature-symbol">[]</span></h5></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><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getJobs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Jobs<a href="#getJobs" 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-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Jobs<span class="tsd-signature-symbol">(</span>formsAppId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, jobsLabel<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="SubmissionTypes.html#FormsAppJob" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppJob</a><span class="tsd-signature-symbol">[]</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/oneblink/apps/blob/17cf756/src/job-service.ts#L54">src/job-service.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jobs: <a href="SubmissionTypes.html#FormsAppJob" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppJob</a><span class="tsd-signature-symbol">[]</span></h5></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><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getJobs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Jobs<a href="#getJobs" 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-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Jobs<span class="tsd-signature-symbol">(</span>formsAppId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, jobsLabel<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="SubmissionTypes.html#FormsAppJob" class="tsd-signature-type" data-tsd-kind="Type alias">FormsAppJob</a><span class="tsd-signature-symbol">[]</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/oneblink/apps/blob/8ea94e8/src/job-service.ts#L54">src/job-service.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Get Jobs for the current user. Jobs that are in the pending queue will be
 filtered out and Jobs with drafts will include the <code>draft</code> property.</p>
 </div><div>