@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
48 lines • 56.2 kB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Mapping | Frodo Library - v3.1.0</title><meta name="description" content="Documentation for Frodo Library"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div></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">Frodo Library - v3.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Frodo Library</a></li><li><a href="../modules/Reference.html">Reference</a></li><li><a href="Reference.Mapping.html">Mapping</a></li></ul><h1>Type Alias Mapping</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Mapping</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createMappingExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</span><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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">moType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importFirstMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">isLegacyMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</span><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">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</span><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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">moType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSyncMappings</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateSyncMappings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappings</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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><span class="tsd-kind-method">createMapping</span><a id="__typecreatemapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatemapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreatemapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create mapping</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mappingData</span>: <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a></span><div class="tsd-comment tsd-typography"><p>mapping object</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an mapping object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L52">ops/MappingOps.ts:52</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createMappingExportTemplate</span><a id="__typecreatemappingexporttemplate" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatemappingexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createMappingExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><a href="#__typecreatemappingexporttemplate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create an empty mapping export template</p>
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></h4><p>an empty mapping export template</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L24">ops/MappingOps.ts:24</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteMapping</span><a id="__typedeletemapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedeletemapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</span><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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeletemapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete mapping</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves an mapping object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L87">ops/MappingOps.ts:87</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteMappings</span><a id="__typedeletemappings" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedeletemappings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">moType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typedeletemappings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete all mappings</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">connectorId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to connector</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">moType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to managed object type</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of mapping objects</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L78">ops/MappingOps.ts:78</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportMapping</span><a id="__typeexportmapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexportmapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportmapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export mapping</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a MappingExportInterface object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L94">ops/MappingOps.ts:94</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportMappings</span><a id="__typeexportmappings" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexportmappings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportMappings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportmappings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export all mappings</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a MappingExportInterface object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L103">ops/MappingOps.ts:103</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importFirstMapping</span><a id="__typeimportfirstmapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeimportfirstmapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importFirstMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportfirstmapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import first mapping</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to a MappingSkeleton object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L124">ops/MappingOps.ts:124</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importMapping</span><a id="__typeimportmapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeimportmapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportmapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import mapping</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to a MappingSkeleton object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L113">ops/MappingOps.ts:113</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importMappings</span><a id="__typeimportmappings" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeimportmappings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportmappings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import all mappings</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an array of MappingSkeleton objects</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L134">ops/MappingOps.ts:134</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">isLegacyMapping</span><a id="__typeislegacymapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeislegacymapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isLegacyMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</span><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">boolean</span><a href="#__typeislegacymapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Helper that returns a boolean indicating whether the mapping is a legacy mapping or not given the id</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the mapping id</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the mapping is a legacy mapping, false otherwise</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>if the id is invalid</p>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L144">ops/MappingOps.ts:144</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readMapping</span><a id="__typereadmapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typereadmapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</span><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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereadmapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read mapping</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves an mapping object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L45">ops/MappingOps.ts:45</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readMappings</span><a id="__typereadmappings" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typereadmappings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readMappings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">moType</span><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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadmappings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read mappings</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">connectorId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to connector</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">moType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to managed object type</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of mapping objects</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L36">ops/MappingOps.ts:36</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readSyncMappings</span><a id="__typereadsyncmappings" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typereadsyncmappings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readSyncMappings</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadsyncmappings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read mappings from sync.json (legacy)</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of mapping objects</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/MappingOps.ts#L29">ops/MappingOps.ts:29</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">updateMapping</span><a id="__typeupdatemapping" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeupdatemapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeupdatemapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update or create mapping</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string