publish latest API docs

OpenNMS · May 15, 2024 · 29c009c · 29c009c
1 parent 4048b11
commit 29c009c
Show file tree

Hide file tree

Showing 100 changed files with 912 additions and 912 deletions.
diff --git a/docs/classes/API.Clause.html b/docs/classes/API.Clause.html
diff --git a/docs/classes/API.Comparator.html b/docs/classes/API.Comparator.html
diff --git a/docs/classes/API.Filter.html b/docs/classes/API.Filter.html
diff --git a/docs/classes/API.Logger.html b/docs/classes/API.Logger.html
diff --git a/docs/classes/API.NestedRestriction.html b/docs/classes/API.NestedRestriction.html
diff --git a/docs/classes/API.OnmsAuthConfig.html b/docs/classes/API.OnmsAuthConfig.html
diff --git a/docs/classes/API.OnmsError.html b/docs/classes/API.OnmsError.html
diff --git a/docs/classes/API.OnmsHTTPOptions.html b/docs/classes/API.OnmsHTTPOptions.html
diff --git a/docs/classes/API.OnmsHTTPOptionsBuilder.html b/docs/classes/API.OnmsHTTPOptionsBuilder.html
diff --git a/docs/classes/API.OnmsResult.html b/docs/classes/API.OnmsResult.html
diff --git a/docs/classes/API.OnmsServer.html b/docs/classes/API.OnmsServer.html
diff --git a/docs/classes/API.OnmsServerBuilder.html b/docs/classes/API.OnmsServerBuilder.html
diff --git a/docs/classes/API.OnmsVersion.html b/docs/classes/API.OnmsVersion.html
diff --git a/docs/classes/API.Operator.html b/docs/classes/API.Operator.html
diff --git a/docs/classes/API.Order.html b/docs/classes/API.Order.html
diff --git a/docs/classes/API.OrderBy.html b/docs/classes/API.OrderBy.html
diff --git a/docs/classes/API.Restriction.html b/docs/classes/API.Restriction.html
diff --git a/docs/classes/API.SearchProperty.html b/docs/classes/API.SearchProperty.html
diff --git a/docs/classes/API.SearchPropertyType.html b/docs/classes/API.SearchPropertyType.html
diff --git a/docs/classes/API.ServerMetadata.html b/docs/classes/API.ServerMetadata.html
diff --git a/docs/classes/API.ServerType.html b/docs/classes/API.ServerType.html
diff --git a/docs/classes/API.TicketerConfig.html b/docs/classes/API.TicketerConfig.html
diff --git a/docs/classes/Client.html b/docs/classes/Client.html
diff --git a/docs/classes/DAO.AlarmDAO.html b/docs/classes/DAO.AlarmDAO.html
diff --git a/docs/classes/DAO.EventDAO.html b/docs/classes/DAO.EventDAO.html
diff --git a/docs/classes/DAO.FlowDAO.html b/docs/classes/DAO.FlowDAO.html
diff --git a/docs/classes/DAO.IpInterfaceDAO.html b/docs/classes/DAO.IpInterfaceDAO.html
diff --git a/docs/classes/DAO.MonitoredServiceDAO.html b/docs/classes/DAO.MonitoredServiceDAO.html
diff --git a/docs/classes/DAO.NodeDAO.html b/docs/classes/DAO.NodeDAO.html
diff --git a/docs/classes/DAO.OutageDAO.html b/docs/classes/DAO.OutageDAO.html
diff --git a/docs/classes/DAO.SituationFeedbackDAO.html b/docs/classes/DAO.SituationFeedbackDAO.html
diff --git a/docs/classes/DAO.SnmpInterfaceDAO.html b/docs/classes/DAO.SnmpInterfaceDAO.html
diff --git a/docs/classes/DAO.V1FilterProcessor.html b/docs/classes/DAO.V1FilterProcessor.html
diff --git a/docs/classes/DAO.V2FilterProcessor.html b/docs/classes/DAO.V2FilterProcessor.html
diff --git a/docs/classes/Model.OnmsAlarm.html b/docs/classes/Model.OnmsAlarm.html
diff --git a/docs/classes/Model.OnmsAlarmSummary.html b/docs/classes/Model.OnmsAlarmSummary.html
diff --git a/docs/classes/Model.OnmsAlarmType.html b/docs/classes/Model.OnmsAlarmType.html
diff --git a/docs/classes/Model.OnmsCategory.html b/docs/classes/Model.OnmsCategory.html
diff --git a/docs/classes/Model.OnmsCollectType.html b/docs/classes/Model.OnmsCollectType.html
diff --git a/docs/classes/Model.OnmsEvent.html b/docs/classes/Model.OnmsEvent.html
diff --git a/docs/classes/Model.OnmsFlowExporter.html b/docs/classes/Model.OnmsFlowExporter.html
diff --git a/docs/classes/Model.OnmsFlowExporterSummary.html b/docs/classes/Model.OnmsFlowExporterSummary.html
diff --git a/docs/classes/Model.OnmsFlowSeries.html b/docs/classes/Model.OnmsFlowSeries.html
diff --git a/docs/classes/Model.OnmsFlowSeriesColumn.html b/docs/classes/Model.OnmsFlowSeriesColumn.html
diff --git a/docs/classes/Model.OnmsFlowSnmpInterface.html b/docs/classes/Model.OnmsFlowSnmpInterface.html
diff --git a/docs/classes/Model.OnmsFlowTable.html b/docs/classes/Model.OnmsFlowTable.html
diff --git a/docs/classes/Model.OnmsIpInterface.html b/docs/classes/Model.OnmsIpInterface.html
diff --git a/docs/classes/Model.OnmsManagedType.html b/docs/classes/Model.OnmsManagedType.html
diff --git a/docs/classes/Model.OnmsMemo.html b/docs/classes/Model.OnmsMemo.html
diff --git a/docs/classes/Model.OnmsMonitoredService.html b/docs/classes/Model.OnmsMonitoredService.html
diff --git a/docs/classes/Model.OnmsNode.html b/docs/classes/Model.OnmsNode.html
diff --git a/docs/classes/Model.OnmsNodeLabelSource.html b/docs/classes/Model.OnmsNodeLabelSource.html
diff --git a/docs/classes/Model.OnmsNodeType.html b/docs/classes/Model.OnmsNodeType.html
diff --git a/docs/classes/Model.OnmsOutage.html b/docs/classes/Model.OnmsOutage.html
diff --git a/docs/classes/Model.OnmsParm.html b/docs/classes/Model.OnmsParm.html
diff --git a/docs/classes/Model.OnmsPrimaryType.html b/docs/classes/Model.OnmsPrimaryType.html
diff --git a/docs/classes/Model.OnmsServiceStatusType.html b/docs/classes/Model.OnmsServiceStatusType.html
diff --git a/docs/classes/Model.OnmsServiceType.html b/docs/classes/Model.OnmsServiceType.html
diff --git a/docs/classes/Model.OnmsSeverity.html b/docs/classes/Model.OnmsSeverity.html
diff --git a/docs/classes/Model.OnmsSituationFeedback.html b/docs/classes/Model.OnmsSituationFeedback.html
diff --git a/docs/classes/Model.OnmsSituationFeedbackType.html b/docs/classes/Model.OnmsSituationFeedbackType.html
diff --git a/docs/classes/Model.OnmsSnmpInterface.html b/docs/classes/Model.OnmsSnmpInterface.html
diff --git a/docs/classes/Model.OnmsSnmpStatusType.html b/docs/classes/Model.OnmsSnmpStatusType.html
diff --git a/docs/classes/Model.OnmsTroubleTicketState.html b/docs/classes/Model.OnmsTroubleTicketState.html
diff --git a/docs/classes/Model.PhysAddr.html b/docs/classes/Model.PhysAddr.html
diff --git a/docs/classes/Rest.AbstractHTTP.html b/docs/classes/Rest.AbstractHTTP.html
diff --git a/docs/classes/Rest.AxiosHTTP.html b/docs/classes/Rest.AxiosHTTP.html
diff --git a/docs/classes/Rest.GrafanaError.html b/docs/classes/Rest.GrafanaError.html
diff --git a/docs/classes/Rest.GrafanaHTTP.html b/docs/classes/Rest.GrafanaHTTP.html
diff --git a/docs/classes/Rest.JsonTransformer.html b/docs/classes/Rest.JsonTransformer.html
diff --git a/docs/classes/Rest.XmlTransformer.html b/docs/classes/Rest.XmlTransformer.html
diff --git a/docs/interfaces/API.IFilterProcessor.html b/docs/interfaces/API.IFilterProcessor.html
diff --git a/docs/interfaces/API.IFilterVisitor.html b/docs/interfaces/API.IFilterVisitor.html
diff --git a/docs/interfaces/API.IHasHTTP.html b/docs/interfaces/API.IHasHTTP.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IHasHTTP | OpenNMS.js - v2.5.10-SNAPSHOT</title><meta name="description" content="Documentation for OpenNMS.js"/><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></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" data-base=".."><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"><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"></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">OpenNMS.js - v2.5.10-SNAPSHOT</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"><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">OpenNMS.js</a></li><li><a href="../modules/API.html">API</a></li><li><a href="API.IHasHTTP.html">IHasHTTP</a></li></ul><h1>Interface IHasHTTP</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface for a class that has an HTTP object.</p>
 <p>This exists to avoid import loops between the DAOs (that need to easily access [[IOnmsHTTP]])
 and the [[Client]] which needs to contain an [[IOnmsHTTP]].</p>
-</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IHasHTTP</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="API.IHasHTTP.html#http">http</a><span class="tsd-signature-symbol">: </span><a href="API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/Client.html" class="tsd-signature-type tsd-kind-class">Client</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/8ae854885fcd5c6eca48befd7a0126384e2c7094/src/api/IHasHTTP.ts#L12">src/api/IHasHTTP.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="API.IHasHTTP.html#http" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IHasHTTP</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="API.IHasHTTP.html#http">http</a><span class="tsd-signature-symbol">: </span><a href="API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/Client.html" class="tsd-signature-type tsd-kind-class">Client</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/4048b116fdf958c8c1206abf84e33578c09f79fb/src/api/IHasHTTP.ts#L12">src/api/IHasHTTP.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="API.IHasHTTP.html#http" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http</span></a>
 </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="http" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http</span><a href="#http" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">http</span><span class="tsd-signature-symbol">:</span> <a href="API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a></div><div class="tsd-comment tsd-typography"><p>The HTTP implementation this object should contain.</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/8ae854885fcd5c6eca48befd7a0126384e2c7094/src/api/IHasHTTP.ts#L14">src/api/IHasHTTP.ts:14</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#http" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>OpenNMS.js - v2.5.10-SNAPSHOT</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/4048b116fdf958c8c1206abf84e33578c09f79fb/src/api/IHasHTTP.ts#L14">src/api/IHasHTTP.ts:14</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#http" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>http</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>OpenNMS.js - v2.5.10-SNAPSHOT</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>