npm - emissions-api-sdk - Versions diffs - 1.0.1 → 1.0.2 - Mend

emissions-api-sdk 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (106) hide show

package/dist/api/Calculation.js +4 -4
package/dist/api/Factor.js +7 -7
package/dist/api/FactorSets.js +1 -1
package/dist/api/Fugitive.js +4 -4
package/dist/api/Location.js +4 -4
package/dist/api/Mobile.js +4 -6
package/dist/api/Stationary.js +4 -4
package/dist/api/TransportationAndDistribution.js +5 -5
package/dist/coverage/clover.xml +335 -0
package/dist/coverage/coverage-final.json +19 -0
package/dist/coverage/lcov-report/base.css +224 -0
package/dist/coverage/lcov-report/block-navigation.js +87 -0
package/dist/coverage/lcov-report/favicon.png +0 -0
package/dist/coverage/lcov-report/index.html +161 -0
package/dist/coverage/lcov-report/prettify.css +1 -0
package/dist/coverage/lcov-report/prettify.js +2 -0
package/dist/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/dist/coverage/lcov-report/sorter.js +210 -0
package/dist/coverage/lcov-report/src/Client.ts.html +838 -0
package/dist/coverage/lcov-report/src/Constants.ts.html +208 -0
package/dist/coverage/lcov-report/src/api/Calculation.ts.html +436 -0
package/dist/coverage/lcov-report/src/api/Factor.ts.html +622 -0
package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +157 -0
package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +436 -0
package/dist/coverage/lcov-report/src/api/Location.ts.html +433 -0
package/dist/coverage/lcov-report/src/api/Mobile.ts.html +448 -0
package/dist/coverage/lcov-report/src/api/Stationary.ts.html +442 -0
package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +436 -0
package/dist/coverage/lcov-report/src/api/index.html +221 -0
package/dist/coverage/lcov-report/src/index.html +161 -0
package/dist/coverage/lcov-report/src/request.ts.html +235 -0
package/dist/coverage/lcov-report/src/utils.ts.html +139 -0
package/dist/coverage/lcov-report/test/index.html +116 -0
package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +142 -0
package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +133 -0
package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +142 -0
package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +139 -0
package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +142 -0
package/dist/coverage/lcov-report/test/mocks/index.html +176 -0
package/dist/coverage/lcov-report/test/testUtils.ts.html +97 -0
package/dist/coverage/lcov.info +558 -0
package/dist/interfaces/response/AreaResponse.js +2 -0
package/dist/interfaces/response/EmissionResponse.js +2 -0
package/dist/interfaces/response/EmissionResponseWithDetails.js +2 -0
package/dist/interfaces/response/FactorResponse.js +2 -0
package/dist/interfaces/response/FactorSetResponse.js +2 -0
package/dist/interfaces/response/SearchResponse.js +2 -0
package/dist/interfaces/response/TypeResponse.js +2 -0
package/dist/interfaces/response/UnitResponse.js +2 -0
package/dist/types/api/Calculation.d.ts +13 -8
package/dist/types/api/Factor.d.ts +18 -13
package/dist/types/api/FactorSets.d.ts +3 -2
package/dist/types/api/Fugitive.d.ts +13 -8
package/dist/types/api/Location.d.ts +13 -8
package/dist/types/api/Mobile.d.ts +13 -10
package/dist/types/api/Stationary.d.ts +13 -8
package/dist/types/api/TransportationAndDistribution.d.ts +14 -9
package/dist/types/index.d.ts +8 -0
package/dist/types/interfaces/response/AreaResponse.d.ts +20 -0
package/dist/types/interfaces/response/EmissionResponse.d.ts +31 -0
package/dist/types/interfaces/response/EmissionResponseWithDetails.d.ts +144 -0
package/dist/types/interfaces/response/FactorResponse.d.ts +53 -0
package/dist/types/interfaces/response/FactorSetResponse.d.ts +38 -0
package/dist/types/interfaces/response/SearchResponse.d.ts +41 -0
package/dist/types/interfaces/response/TypeResponse.d.ts +7 -0
package/dist/types/interfaces/response/UnitResponse.d.ts +7 -0
package/docs/_sources/index.rst.txt +1 -0
package/docs/_sources/troubleshooting.rst.txt +486 -0
package/docs/_static/basic.css +8 -0
package/docs/_static/pygments.css +146 -164
package/docs/_static/searchtools.js +5 -8
package/docs/_static/styles/furo.css +1 -1
package/docs/_static/styles/furo.css.map +1 -1
package/docs/authentication.html +29 -19
package/docs/client.html +29 -19
package/docs/genindex.html +29 -19
package/docs/getting_started.html +29 -19
package/docs/index.html +42 -19
package/docs/objects.inv +0 -0
package/docs/reference.html +69 -53
package/docs/sdk.html +29 -19
package/docs/search.html +29 -19
package/docs/searchindex.js +1 -1
package/docs/troubleshooting.html +786 -0
package/package.json +1 -1
package/sphinx-build/requirements.txt +5 -0
package/sphinx-build/source/index.rst +1 -0
package/sphinx-build/source/troubleshooting.rst +486 -0
package/src/api/Calculation.ts +19 -14
package/src/api/Factor.ts +27 -22
package/src/api/FactorSets.ts +4 -3
package/src/api/Fugitive.ts +19 -14
package/src/api/Location.ts +20 -15
package/src/api/Mobile.ts +19 -16
package/src/api/Stationary.ts +19 -14
package/src/api/TransportationAndDistribution.ts +21 -16
package/src/index.ts +33 -1
package/src/interfaces/response/AreaResponse.ts +25 -0
package/src/interfaces/response/EmissionResponse.ts +44 -0
package/src/interfaces/response/EmissionResponseWithDetails.ts +183 -0
package/src/interfaces/response/FactorResponse.ts +78 -0
package/src/interfaces/response/FactorSetResponse.ts +52 -0
package/src/interfaces/response/SearchResponse.ts +52 -0
package/src/interfaces/response/TypeResponse.ts +7 -0
package/src/interfaces/response/UnitResponse.ts +7 -0
package/test/apiTest.test.ts +1 -1

package/docs/troubleshooting.html ADDED Viewed

@@ -0,0 +1,786 @@
+<!doctype html>
+<html class="no-js" lang="en" data-content_root="./">
+  <head><meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
+    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
+<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Reference" href="reference.html" />
+    <!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 -->
+        <title>Troubleshooting Guide - IBM Envizi - Emissions API Node.js SDK documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
+    <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=25af2a20" />
+    <link rel="stylesheet" type="text/css" href="_static/sphinx_js.css" />
+    <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
+    <link rel="stylesheet" type="text/css" href="_static/custom.css?v=8d04aa46" />
+<style>
+  body {
+    --color-code-background: #f2f2f2;
+  --color-code-foreground: #1e1e1e;
+  }
+  @media not print {
+    body[data-theme="dark"] {
+      --color-code-background: #2b2b2b;
+  --color-code-foreground: #f8f8f2;
+    }
+    @media (prefers-color-scheme: dark) {
+      body:not([data-theme="light"]) {
+        --color-code-background: #2b2b2b;
+  --color-code-foreground: #f8f8f2;
+      }
+    }
+  }
+</style></head>
+  <body>
+    <script>
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
+    </script>
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
+  <symbol id="svg-toc" viewBox="0 0 24 24">
+    <title>Contents</title>
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
+      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
+    </svg>
+  </symbol>
+  <symbol id="svg-menu" viewBox="0 0 24 24">
+    <title>Menu</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
+      <line x1="3" y1="12" x2="21" y2="12"></line>
+      <line x1="3" y1="6" x2="21" y2="6"></line>
+      <line x1="3" y1="18" x2="21" y2="18"></line>
+    </svg>
+  </symbol>
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
+    <title>Expand</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
+      <polyline points="9 18 15 12 9 6"></polyline>
+    </svg>
+  </symbol>
+  <symbol id="svg-sun" viewBox="0 0 24 24">
+    <title>Light mode</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
+      <circle cx="12" cy="12" r="5"></circle>
+      <line x1="12" y1="1" x2="12" y2="3"></line>
+      <line x1="12" y1="21" x2="12" y2="23"></line>
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
+      <line x1="1" y1="12" x2="3" y2="12"></line>
+      <line x1="21" y1="12" x2="23" y2="12"></line>
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
+    </svg>
+  </symbol>
+  <symbol id="svg-moon" viewBox="0 0 24 24">
+    <title>Dark mode</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
+      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
+    </svg>
+  </symbol>
+  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
+    <title>Auto light/dark, in light mode</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
+      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
+      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
+      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
+      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
+      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
+      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
+      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
+      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
+      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
+      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
+      <circle cx="14.5" cy="9.55" r="3.6"/>
+    </svg>
+  </symbol>
+  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
+    <title>Auto light/dark, in dark mode</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
+      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
+      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
+      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
+      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
+      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
+      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
+      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
+      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
+      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
+      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
+      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
+    </svg>
+  </symbol>
+  <symbol id="svg-pencil" viewBox="0 0 24 24">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
+      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
+      <path d="M13.5 6.5l4 4" />
+      <path d="M20 21l2 -2l-2 -2" />
+      <path d="M17 17l-2 2l2 2" />
+    </svg>
+  </symbol>
+  <symbol id="svg-eye" viewBox="0 0 24 24">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
+      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
+      <path
+        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
+      <path d="M20 21l2 -2l-2 -2" />
+      <path d="M17 17l-2 2l2 2" />
+    </svg>
+  </symbol>
+</svg>
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
+<label class="overlay sidebar-overlay" for="__navigation">
+  <div class="visually-hidden">Hide navigation sidebar</div>
+</label>
+<label class="overlay toc-overlay" for="__toc">
+  <div class="visually-hidden">Hide table of contents sidebar</div>
+</label>
+<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
+<div class="page">
+  <header class="mobile-header">
+    <div class="header-left">
+      <label class="nav-overlay-icon" for="__navigation">
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
+      </label>
+    </div>
+    <div class="header-center">
+      <a href="index.html"><div class="brand">IBM Envizi - Emissions API Node.js SDK  documentation</div></a>
+    </div>
+    <div class="header-right">
+      <div class="theme-toggle-container theme-toggle-header">
+        <button class="theme-toggle">
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
+          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
+          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
+        </button>
+      </div>
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
+      </label>
+    </div>
+  </header>
+  <aside class="sidebar-drawer">
+    <div class="sidebar-container">
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
+  <span class="sidebar-brand-text">IBM Envizi - Emissions API Node.js SDK  documentation</span>
+</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
+  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
+  <input type="hidden" name="check_keywords" value="yes">
+  <input type="hidden" name="area" value="default">
+</form>
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
+  <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of SDK</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
+<li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Troubleshooting Guide</a></li>
+</ul>
+</div>
+</div>
+      </div>
+    </div>
+  </aside>
+  <div class="main">
+    <div class="content">
+      <div class="article-container">
+        <a href="#" class="back-to-top muted-link">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
+          </svg>
+          <span>Back to top</span>
+        </a>
+        <div class="content-icon-container">
+          <div class="view-this-page">
+  <a class="muted-link" href="_sources/troubleshooting.rst.txt" title="View this page">
+    <svg><use href="#svg-eye"></use></svg>
+    <span class="visually-hidden">View this page</span>
+  </a>
+</div>
+<div class="theme-toggle-container theme-toggle-content">
+            <button class="theme-toggle">
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
+              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
+              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
+            </button>
+          </div>
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
+          </label>
+        </div>
+        <article role="main" id="furo-main-content">
+          <section id="troubleshooting-guide">
+<h1>Troubleshooting Guide<a class="headerlink" href="#troubleshooting-guide" title="Link to this heading">¶</a></h1>
+<section id="overview">
+<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2>
+<p>This document lists all SDK-specific errors that can occur when using the Emissions API Node.js SDK. These errors are related to SDK initialization and client management.</p>
+</section>
+<hr class="docutils" />
+<section id="sdk-initialization-errors">
+<h2>SDK Initialization Errors<a class="headerlink" href="#sdk-initialization-errors" title="Link to this heading">¶</a></h2>
+<section id="configuration-errors">
+<h3>Configuration Errors<a class="headerlink" href="#configuration-errors" title="Link to this heading">¶</a></h3>
+<p>These errors occur when <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code> is called with invalid or missing configuration parameters.</p>
+<section id="missing-auth-url-with-custom-host">
+<h4>1. Missing Auth URL with Custom Host<a class="headerlink" href="#missing-auth-url-with-custom-host" title="Link to this heading">¶</a></h4>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: If custom &quot;host&quot; is provided, &quot;authUrl&quot; must also be provided.
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Custom host URL provided without corresponding authentication URL</p>
+<p><strong>Solution:</strong> Provide both <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">authUrl</span></code> parameters together</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">host</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;org456&#39;</span>
+<span class="w">  </span><span class="c1">// Missing authUrl parameter</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
+<hr class="docutils" />
+<section id="missing-client-id-with-token">
+<h4>2. Missing Client ID with Token<a class="headerlink" href="#missing-client-id-with-token" title="Link to this heading">¶</a></h4>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: If token is provided directly, &quot;clientId&quot; must also be provided.
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Pre-existing token provided without client ID</p>
+<p><strong>Solution:</strong> Provide <code class="docutils literal notranslate"><span class="pre">clientId</span></code> parameter when using a token</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">token</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-jwt-token&#39;</span>
+<span class="w">  </span><span class="c1">// Missing clientId parameter</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
+<hr class="docutils" />
+<section id="missing-parameters-with-api-key">
+<h4>3. Missing Parameters with API Key<a class="headerlink" href="#missing-parameters-with-api-key" title="Link to this heading">¶</a></h4>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: If apiKey is provided , &quot;clientId&quot; and &quot;OrgId&quot; must also be provided.
+</pre></div>
+</div>
+<p><strong>Cause:</strong> API key authentication requires both client ID and organization ID</p>
+<p><strong>Solution:</strong> Provide <code class="docutils literal notranslate"><span class="pre">apiKey</span></code>, <code class="docutils literal notranslate"><span class="pre">clientId</span></code>, and <code class="docutils literal notranslate"><span class="pre">orgId</span></code> parameters together</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="c1">// Missing orgId</span>
+<span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-api-key&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span>
+<span class="w">  </span><span class="c1">// Missing orgId parameter</span>
+<span class="p">});</span>
+<span class="c1">// Or missing clientId</span>
+<span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-api-key&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;org456&#39;</span>
+<span class="w">  </span><span class="c1">// Missing clientId parameter</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
+</section>
+<hr class="docutils" />
+<section id="authentication-errors-http-401">
+<h3>Authentication Errors (HTTP 401)<a class="headerlink" href="#authentication-errors-http-401" title="Link to this heading">¶</a></h3>
+<p>These errors occur when authentication credentials are invalid or expired.</p>
+<section id="invalid-api-key">
+<h4>4. Invalid API Key<a class="headerlink" href="#invalid-api-key" title="Link to this heading">¶</a></h4>
+<p><strong>Error Response:</strong></p>
+<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+<span class="w">  </span><span class="nt">&quot;httpCode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;401&quot;</span><span class="p">,</span>
+<span class="w">  </span><span class="nt">&quot;httpMessage&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Unauthorized&quot;</span><span class="p">,</span>
+<span class="w">  </span><span class="nt">&quot;moreInformation&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Cannot pass the security checks that are required by the target API or operation, Enable debug headers for more details.&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Cause:</strong> API key is invalid, expired, or revoked</p>
+<p><strong>Solution:</strong> Verify API key from IBM Cloud console and ensure it has proper permissions</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;invalid_api_key_12345&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;org456&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">host</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">authUrl</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com/auth-url&#39;</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
+<hr class="docutils" />
+<section id="invalid-organization-id">
+<h4>5. Invalid Organization ID<a class="headerlink" href="#invalid-organization-id" title="Link to this heading">¶</a></h4>
+<p><strong>Error Response:</strong></p>
+<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+<span class="w">  </span><span class="nt">&quot;httpCode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;401&quot;</span><span class="p">,</span>
+<span class="w">  </span><span class="nt">&quot;httpMessage&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Unauthorized&quot;</span><span class="p">,</span>
+<span class="w">  </span><span class="nt">&quot;moreInformation&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Cannot pass the security checks that are required by the target API or operation, Enable debug headers for more details.&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Organization ID doesn’t match account or user lacks access</p>
+<p><strong>Solution:</strong> Verify organization ID from IBM Cloud account settings</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-valid-api-key&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;invalid-org-id-12345&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">host</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">authUrl</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com/auth-url&#39;</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
+<hr class="docutils" />
+<section id="invalid-client-id">
+<h4>6. Invalid Client ID<a class="headerlink" href="#invalid-client-id" title="Link to this heading">¶</a></h4>
+<p><strong>Error Response:</strong></p>
+<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+<span class="w">  </span><span class="nt">&quot;httpCode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;401&quot;</span><span class="p">,</span>
+<span class="w">  </span><span class="nt">&quot;httpMessage&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Unauthorized&quot;</span><span class="p">,</span>
+<span class="w">  </span><span class="nt">&quot;moreInformation&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Invalid client id or secret.&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Client ID is invalid or doesn’t match credentials</p>
+<p><strong>Solution:</strong> Verify client ID from IBM Cloud credentials</p>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-valid-api-key&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;invalid-client-id-12345&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;org456&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">host</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">authUrl</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com/auth-url&#39;</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+</section>
+<hr class="docutils" />
+<section id="empty-token-response">
+<h4>7. Empty Token Response<a class="headerlink" href="#empty-token-response" title="Link to this heading">¶</a></h4>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: Token response is empty
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Authentication server returned an empty or null token in the response body</p>
+<p><strong>Solution:</strong></p>
+<ul class="simple">
+<li><p>Verify the <code class="docutils literal notranslate"><span class="pre">authUrl</span></code> is correct and points to a valid authentication endpoint</p></li>
+<li><p>Ensure the authentication service is responding correctly</p></li>
+<li><p>Check that the API key, client ID, and org ID combination is valid</p></li>
+<li><p>Verify the authentication endpoint is returning a token in the response</p></li>
+<li><p>Contact support if the authentication service is not responding properly</p></li>
+</ul>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;your-api-key&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;org456&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">host</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://api.ibm.com/&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">authUrl</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://valid-url-but-returns-empty-token.example.com/token&#39;</span>
+<span class="w">  </span><span class="c1">// Valid URL but returns empty token in response</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+<p><strong>Note:</strong> If the authUrl is completely invalid or unreachable (e.g., wrong domain), you’ll get a network error (ENOTFOUND) instead of this error. This error specifically occurs when the authentication endpoint responds but returns an empty token.</p>
+</section>
+<hr class="docutils" />
+<section id="missing-expiry-field-in-token">
+<h4>8. Missing Expiry Field in Token<a class="headerlink" href="#missing-expiry-field-in-token" title="Link to this heading">¶</a></h4>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: exp field is missing in the token
+</pre></div>
+</div>
+<p><strong>Cause:</strong> The provided JWT token does not contain the required <code class="docutils literal notranslate"><span class="pre">exp</span></code> (expiry) field</p>
+<p><strong>Solution:</strong></p>
+<ul class="simple">
+<li><p>Ensure the token is a valid JWT with an expiry field</p></li>
+<li><p>Regenerate the token if it’s malformed</p></li>
+<li><p>Verify the token was generated correctly by the authentication service</p></li>
+</ul>
+<p><strong>Sample Function Call That Causes This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">token</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;malformed-jwt-token-without-exp-field&#39;</span><span class="p">,</span>
+<span class="w">  </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;client123&#39;</span>
+<span class="p">});</span>
+</pre></div>
+</div>
+<p><strong>Note:</strong> This error occurs when using token-based authentication with a JWT that doesn’t include the standard <code class="docutils literal notranslate"><span class="pre">exp</span></code> (expiration time) claim.</p>
+</section>
+</section>
+</section>
+<hr class="docutils" />
+<section id="client-instance-errors">
+<h2>Client Instance Errors<a class="headerlink" href="#client-instance-errors" title="Link to this heading">¶</a></h2>
+<section id="client-not-initialized">
+<h3>Client Not Initialized<a class="headerlink" href="#client-not-initialized" title="Link to this heading">¶</a></h3>
+<p><strong>Error Message:</strong></p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Error: Client is not initialized. Call Client.getClient() first.
+</pre></div>
+</div>
+<p><strong>Cause:</strong> Attempting to use <code class="docutils literal notranslate"><span class="pre">Client.getInstance()</span></code> or API methods before calling <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code></p>
+<p><strong>Solution:</strong> Always call <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code> before using any SDK methods</p>
+<p><strong>When This Occurs:</strong></p>
+<ul class="simple">
+<li><p>Calling <code class="docutils literal notranslate"><span class="pre">Client.getInstance()</span></code> before initialization</p></li>
+<li><p>Calling any API method (Stationary.calculate(), Mobile.calculate(), etc.) before initialization</p></li>
+<li><p>Application restart without re-initializing the client</p></li>
+</ul>
+<p><strong>Sample Function Calls That Cause This Error:</strong></p>
+<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="c1">// Error 1: Calling getInstance() before initialization</span>
+<span class="kd">const</span><span class="w"> </span><span class="nx">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getInstance</span><span class="p">();</span><span class="w"> </span><span class="c1">// Throws error</span>
+<span class="c1">// Error 2: Calling API methods before initialization</span>
+<span class="k">await</span><span class="w"> </span><span class="nx">Stationary</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
+<span class="w">  </span><span class="nx">time</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">date</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span><span class="w"> </span><span class="p">},</span>
+<span class="w">  </span><span class="nx">location</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">country</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="w"> </span><span class="p">},</span>
+<span class="w">  </span><span class="nx">activity</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Coal - Lignite&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">unit</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;KJ&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">value</span><span class="o">:</span><span class="w"> </span><span class="kt">3</span><span class="w"> </span><span class="p">}</span>
+<span class="p">});</span><span class="w"> </span><span class="c1">// Throws error</span>
+<span class="c1">// Error 3: Calling any other API method</span>
+<span class="k">await</span><span class="w"> </span><span class="nx">Mobile</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({...});</span><span class="w"> </span><span class="c1">// Throws error</span>
+<span class="k">await</span><span class="w"> </span><span class="nx">Fugitive</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({...});</span><span class="w"> </span><span class="c1">// Throws error</span>
+<span class="k">await</span><span class="w"> </span><span class="nx">Location</span><span class="p">.</span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;steam&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// Throws error</span>
+</pre></div>
+</div>
+</section>
+</section>
+<hr class="docutils" />
+<section id="token-management">
+<h2>Token Management<a class="headerlink" href="#token-management" title="Link to this heading">¶</a></h2>
+<section id="automatic-token-refresh">
+<h3>Automatic Token Refresh<a class="headerlink" href="#automatic-token-refresh" title="Link to this heading">¶</a></h3>
+<p>The SDK automatically refreshes authentication tokens when they are about to expire (within 60 seconds). Token refresh failures will cause subsequent API calls to fail with 401 errors.</p>
+<p><strong>Note:</strong> Token refresh only occurs for tokens generated by the SDK, not for user-provided tokens.</p>
+</section>
+</section>
+<hr class="docutils" />
+<section id="error-summary-table">
+<h2>Error Summary Table<a class="headerlink" href="#error-summary-table" title="Link to this heading">¶</a></h2>
+<div class="table-wrapper colwidths-given docutils container">
+<table class="docutils align-default">
+<colgroup>
+<col style="width: 20.0%" />
+<col style="width: 40.0%" />
+<col style="width: 10.0%" />
+<col style="width: 30.0%" />
+</colgroup>
+<thead>
+<tr class="row-odd"><th class="head"><p>Error Type</p></th>
+<th class="head"><p>Error Message</p></th>
+<th class="head"><p>HTTP Code</p></th>
+<th class="head"><p>Solution</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>Configuration</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">If</span> <span class="pre">custom</span> <span class="pre">&quot;host&quot;</span> <span class="pre">is</span> <span class="pre">provided,</span> <span class="pre">&quot;authUrl&quot;</span> <span class="pre">must</span> <span class="pre">also</span> <span class="pre">be</span> <span class="pre">provided.</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Provide both host and authUrl</p></td>
+</tr>
+<tr class="row-odd"><td><p>Configuration</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">If</span> <span class="pre">token</span> <span class="pre">is</span> <span class="pre">provided</span> <span class="pre">directly,</span> <span class="pre">&quot;clientId&quot;</span> <span class="pre">must</span> <span class="pre">also</span> <span class="pre">be</span> <span class="pre">provided.</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Provide clientId with token</p></td>
+</tr>
+<tr class="row-even"><td><p>Configuration</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">If</span> <span class="pre">apiKey</span> <span class="pre">is</span> <span class="pre">provided</span> <span class="pre">,</span> <span class="pre">&quot;clientId&quot;</span> <span class="pre">and</span> <span class="pre">&quot;OrgId&quot;</span> <span class="pre">must</span> <span class="pre">also</span> <span class="pre">be</span> <span class="pre">provided.</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Provide all three parameters</p></td>
+</tr>
+<tr class="row-odd"><td><p>Authentication</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">Cannot</span> <span class="pre">pass</span> <span class="pre">the</span> <span class="pre">security</span> <span class="pre">checks...</span></code></p></td>
+<td><p>401</p></td>
+<td><p>Verify API key and org ID</p></td>
+</tr>
+<tr class="row-even"><td><p>Authentication</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">Invalid</span> <span class="pre">client</span> <span class="pre">id</span> <span class="pre">or</span> <span class="pre">secret</span></code></p></td>
+<td><p>401</p></td>
+<td><p>Verify client ID</p></td>
+</tr>
+<tr class="row-odd"><td><p>Authentication</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">Token</span> <span class="pre">response</span> <span class="pre">is</span> <span class="pre">empty</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Check network and authUrl</p></td>
+</tr>
+<tr class="row-even"><td><p>Token</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">exp</span> <span class="pre">field</span> <span class="pre">is</span> <span class="pre">missing</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">token</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Use valid JWT with exp field</p></td>
+</tr>
+<tr class="row-odd"><td><p>Instance</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">Client</span> <span class="pre">is</span> <span class="pre">not</span> <span class="pre">initialized.</span> <span class="pre">Call</span> <span class="pre">Client.getClient()</span> <span class="pre">first.</span></code></p></td>
+<td><p>N/A</p></td>
+<td><p>Call getClient() first</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</section>
+<hr class="docutils" />
+<section id="required-configuration-parameters">
+<h2>Required Configuration Parameters<a class="headerlink" href="#required-configuration-parameters" title="Link to this heading">¶</a></h2>
+<p>When calling <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code>, the following parameters are required based on authentication method:</p>
+<section id="api-key-authentication-recommended">
+<h3>API Key Authentication (Recommended)<a class="headerlink" href="#api-key-authentication-recommended" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">apiKey</span></code> - Your IBM Cloud API key</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">clientId</span></code> - Your client ID</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">orgId</span></code> - Your organization ID</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">host</span></code> - API host URL</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">authUrl</span></code> - Authentication URL</p></li>
+</ul>
+</section>
+<section id="token-authentication">
+<h3>Token Authentication<a class="headerlink" href="#token-authentication" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">token</span></code> - Pre-existing JWT token</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">clientId</span></code> - Your client ID</p></li>
+</ul>
+</section>
+</section>
+<hr class="docutils" />
+<section id="initialization-checklist">
+<h2>Initialization Checklist<a class="headerlink" href="#initialization-checklist" title="Link to this heading">¶</a></h2>
+<p>Before using the SDK, ensure:</p>
+<ul class="simple">
+<li><p>[ ] All required configuration parameters are provided</p></li>
+<li><p>[ ] Credentials are valid and not expired</p></li>
+<li><p>[ ] Correct environment URLs are used</p></li>
+<li><p>[ ] <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code> is called before any API methods</p></li>
+<li><p>[ ] Error handling is implemented for initialization failures</p></li>
+<li><p>[ ] Credentials are stored securely (environment variables recommended)</p></li>
+</ul>
+</section>
+<hr class="docutils" />
+<section id="common-scenarios">
+<h2>Common Scenarios<a class="headerlink" href="#common-scenarios" title="Link to this heading">¶</a></h2>
+<section id="scenario-1-application-startup">
+<h3>Scenario 1: Application Startup<a class="headerlink" href="#scenario-1-application-startup" title="Link to this heading">¶</a></h3>
+<p><strong>Issue:</strong> SDK must be initialized when application starts</p>
+<p><strong>Solution:</strong> Call <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code> in application initialization code before using any API methods</p>
+</section>
+<section id="scenario-2-invalid-credentials">
+<h3>Scenario 2: Invalid Credentials<a class="headerlink" href="#scenario-2-invalid-credentials" title="Link to this heading">¶</a></h3>
+<p><strong>Issue:</strong> 401 Unauthorized errors during initialization</p>
+<p><strong>Solution:</strong> Verify all credentials (API key, client ID, org ID) from IBM Cloud console</p>
+</section>
+<section id="scenario-3-missing-configuration">
+<h3>Scenario 3: Missing Configuration<a class="headerlink" href="#scenario-3-missing-configuration" title="Link to this heading">¶</a></h3>
+<p><strong>Issue:</strong> Configuration error thrown before API call</p>
+<p><strong>Solution:</strong> Ensure all required parameters are provided based on authentication method</p>
+</section>
+<section id="scenario-4-client-not-initialized">
+<h3>Scenario 4: Client Not Initialized<a class="headerlink" href="#scenario-4-client-not-initialized" title="Link to this heading">¶</a></h3>
+<p><strong>Issue:</strong> Error when calling API methods</p>
+<p><strong>Solution:</strong> Verify <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code> was called successfully before using API methods</p>
+</section>
+</section>
+<hr class="docutils" />
+<section id="troubleshooting-steps">
+<h2>Troubleshooting Steps<a class="headerlink" href="#troubleshooting-steps" title="Link to this heading">¶</a></h2>
+<ol class="arabic simple">
+<li><p><strong>Verify Configuration</strong></p>
+<ul class="simple">
+<li><p>Check all required parameters are provided</p></li>
+<li><p>Ensure no parameters are empty or null</p></li>
+<li><p>Verify host and authUrl match your environment</p></li>
+</ul>
+</li>
+<li><p><strong>Verify Credentials</strong></p>
+<ul class="simple">
+<li><p>Confirm API key is valid and not expired</p></li>
+<li><p>Check organization ID matches your IBM Cloud account</p></li>
+<li><p>Verify client ID is correct</p></li>
+</ul>
+</li>
+<li><p><strong>Check Initialization</strong></p>
+<ul class="simple">
+<li><p>Ensure <code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code> is called before API methods</p></li>
+<li><p>Verify initialization completed without errors</p></li>
+<li><p>Check for any error messages during initialization</p></li>
+</ul>
+</li>
+<li><p><strong>Network and Service</strong></p>
+<ul class="simple">
+<li><p>Verify network connectivity</p></li>
+<li><p>Check authentication service availability</p></li>
+<li><p>Ensure firewall allows connections to IBM Cloud</p></li>
+</ul>
+</li>
+</ol>
+</section>
+<hr class="docutils" />
+<section id="support">
+<h2>Support<a class="headerlink" href="#support" title="Link to this heading">¶</a></h2>
+<p>For issues not covered in this guide:</p>
+<ol class="arabic simple">
+<li><p>Verify SDK version is up to date</p></li>
+<li><p>Check IBM Cloud service status</p></li>
+<li><p>Review error messages and HTTP status codes</p></li>
+<li><p>Contact IBM Support with:</p>
+<ul class="simple">
+<li><p>Error message and stack trace</p></li>
+<li><p>SDK version</p></li>
+<li><p>Environment details</p></li>
+<li><p>Steps to reproduce (excluding sensitive credentials)</p></li>
+</ul>
+</li>
+</ol>
+<hr class="docutils" />
+<p><strong>Last Updated:</strong> 2025-11-24</p>
+<p><strong>SDK Version:</strong> 1.0.1</p>
+<p><strong>Coverage:</strong> SDK initialization, client instance, and authentication errors</p>
+</section>
+</section>
+        </article>
+      </div>
+      <footer>
+        <div class="related-pages">
+          <a class="prev-page" href="reference.html">
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
+              <div class="page-info">
+                <div class="context">
+                  <span>Previous</span>
+                </div>
+                <div class="title">Reference</div>
+              </div>
+            </a>
+        </div>
+        <div class="bottom-of-page">
+          <div class="left-details">
+            <div class="copyright">
+                Copyright &#169; 2025, IBM Corporation
+            </div>
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
+          </div>
+          <div class="right-details">
+          </div>
+        </div>
+      </footer>
+    </div>
+    <aside class="toc-drawer">
+      <div class="toc-sticky toc-scroll">
+        <div class="toc-title-container">
+          <span class="toc-title">
+            On this page
+          </span>
+        </div>
+        <div class="toc-tree-container">
+          <div class="toc-tree">
+            <ul>
+<li><a class="reference internal" href="#">Troubleshooting Guide</a><ul>
+<li><a class="reference internal" href="#overview">Overview</a></li>
+<li><a class="reference internal" href="#sdk-initialization-errors">SDK Initialization Errors</a><ul>
+<li><a class="reference internal" href="#configuration-errors">Configuration Errors</a><ul>
+<li><a class="reference internal" href="#missing-auth-url-with-custom-host">1. Missing Auth URL with Custom Host</a></li>
+<li><a class="reference internal" href="#missing-client-id-with-token">2. Missing Client ID with Token</a></li>
+<li><a class="reference internal" href="#missing-parameters-with-api-key">3. Missing Parameters with API Key</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#authentication-errors-http-401">Authentication Errors (HTTP 401)</a><ul>
+<li><a class="reference internal" href="#invalid-api-key">4. Invalid API Key</a></li>
+<li><a class="reference internal" href="#invalid-organization-id">5. Invalid Organization ID</a></li>
+<li><a class="reference internal" href="#invalid-client-id">6. Invalid Client ID</a></li>
+<li><a class="reference internal" href="#empty-token-response">7. Empty Token Response</a></li>
+<li><a class="reference internal" href="#missing-expiry-field-in-token">8. Missing Expiry Field in Token</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a class="reference internal" href="#client-instance-errors">Client Instance Errors</a><ul>
+<li><a class="reference internal" href="#client-not-initialized">Client Not Initialized</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#token-management">Token Management</a><ul>
+<li><a class="reference internal" href="#automatic-token-refresh">Automatic Token Refresh</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#error-summary-table">Error Summary Table</a></li>
+<li><a class="reference internal" href="#required-configuration-parameters">Required Configuration Parameters</a><ul>
+<li><a class="reference internal" href="#api-key-authentication-recommended">API Key Authentication (Recommended)</a></li>
+<li><a class="reference internal" href="#token-authentication">Token Authentication</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#initialization-checklist">Initialization Checklist</a></li>
+<li><a class="reference internal" href="#common-scenarios">Common Scenarios</a><ul>
+<li><a class="reference internal" href="#scenario-1-application-startup">Scenario 1: Application Startup</a></li>
+<li><a class="reference internal" href="#scenario-2-invalid-credentials">Scenario 2: Invalid Credentials</a></li>
+<li><a class="reference internal" href="#scenario-3-missing-configuration">Scenario 3: Missing Configuration</a></li>
+<li><a class="reference internal" href="#scenario-4-client-not-initialized">Scenario 4: Client Not Initialized</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#troubleshooting-steps">Troubleshooting Steps</a></li>
+<li><a class="reference internal" href="#support">Support</a></li>
+</ul>
+</li>
+</ul>
+          </div>
+        </div>
+      </div>
+    </aside>
+  </div>
+</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="_static/doctools.js?v=9bcbadda"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/scripts/furo.js?v=46bd48cc"></script>
+    </body>
+</html>