emissions-api-sdk 1.0.3 → 1.0.5

package/docs/genindex.html

@@ -235,7 +235,7 @@
           
 <section class="genindex-section">
   <h1 id="index">Index</h1>
-  <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a></div>
+  <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a></div>
 </section>
 <section id="A" class="genindex-section">
   <h2>A</h2>
@@ -323,6 +323,24 @@
   </tr></table>
 </section>
 
+<section id="E" class="genindex-section">
+  <h2>E</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="reference.html#EconomicActivity.calculate">EconomicActivity.calculate() (EconomicActivity method)</a>
+</li>
+        <li><a href="reference.html#EconomicActivity.getArea">EconomicActivity.getArea() (EconomicActivity method)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="reference.html#EconomicActivity.getTypes">EconomicActivity.getTypes() (EconomicActivity method)</a>
+</li>
+        <li><a href="reference.html#EconomicActivity.getUnits">EconomicActivity.getUnits() (EconomicActivity method)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
 <section id="F" class="genindex-section">
   <h2>F</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
@@ -391,6 +409,16 @@
   <h2>R</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="reference.html#RealEstate.calculate">RealEstate.calculate() (RealEstate method)</a>
+</li>
+        <li><a href="reference.html#RealEstate.getArea">RealEstate.getArea() (RealEstate method)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="reference.html#RealEstate.getTypes">RealEstate.getTypes() (RealEstate method)</a>
+</li>
+        <li><a href="reference.html#RealEstate.getUnits">RealEstate.getUnits() (RealEstate method)</a>
+</li>
         <li><a href="reference.html#request.makeApiRequest">request.makeApiRequest() (request method)</a>
 </li>
     </ul></td>

package/docs/index.html

@@ -296,6 +296,8 @@
 <li><p><strong>Mobile</strong> – emissions from vehicles and mobile equipment</p></li>
 <li><p><strong>Stationary</strong> – emissions from fixed fuel consumption</p></li>
 <li><p><strong>Transportation &amp; distribution</strong> – logistics and supply chain activities</p></li>
+<li><p><strong>Real Estate</strong> – emissions from commercial and residential properties</p></li>
+<li><p><strong>Economic Activity</strong> – spend-based emissions from business activities</p></li>
 <li><p><strong>Generic</strong> – custom emission calculations</p></li>
 </ul>
 <p>The SDK is designed for embedding emission calculations in applications, building sustainability dashboards, automating large-scale datasets, and tracking carbon footprints.</p>

package/docs/reference.html

@@ -748,6 +748,78 @@ Only refreshes if the token was not provided by the user and is expiring within
 </div>
 </dd></dl>
 
+<dl class="js function">
+<dt class="sig sig-object js" id="RealEstate.calculate">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">RealEstate</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RealEstate.calculate" title="Link to this definition">¶</a></dt>
+<dd><p>Performs scope 3 Real estate emission calculations by making a POST request to the real estate API endpoint.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the API</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;EmissionResponse | EmissionResponseWithDetails&gt;</span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
+<span class="w">   </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">     </span><span class="s2">&quot;date&quot;</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="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">     </span><span class="s2">&quot;country&quot;</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="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">     </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Commercial Real Estate:Industrial distribution warehouse&quot;</span><span class="p">,</span>
+<span class="w">     </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">17000.123</span><span class="p">,</span>
+<span class="w">     </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;m2&quot;</span>
+<span class="w">   </span><span class="p">},</span>
+<span class="w">   </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
+<span class="w"> </span><span class="p">};</span>
+<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
+<dl class="js function">
+<dt class="sig sig-object js" id="EconomicActivity.calculate">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">EconomicActivity</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EconomicActivity.calculate" title="Link to this definition">¶</a></dt>
+<dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the API</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;EmissionResponse | EmissionResponseWithDetails&gt;</span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
+<span class="w">   </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">     </span><span class="s2">&quot;date&quot;</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="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">     </span><span class="s2">&quot;country&quot;</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="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">     </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
+<span class="w">     </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
+<span class="w">     </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
+<span class="w">   </span><span class="p">},</span>
+<span class="w">   </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
+<span class="w"> </span><span class="p">};</span>
+<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
 </section>
 <section id="metadata-apis">
 <h2>Metadata APIs<a class="headerlink" href="#metadata-apis" title="Link to this heading">¶</a></h2>
@@ -873,6 +945,40 @@ Only refreshes if the token was not provided by the user and is expiring within
 </div>
 </dd></dl>
 
+<dl class="js function">
+<dt class="sig sig-object js" id="RealEstate.getTypes">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">RealEstate</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#RealEstate.getTypes" title="Link to this definition">¶</a></dt>
+<dd><p>Retrieves available Real estate emission calculation types by making a GET request to the API endpoint.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available Real estate emission types</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getTypes</span><span class="p">();</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
+<dl class="js function">
+<dt class="sig sig-object js" id="EconomicActivity.getTypes">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">EconomicActivity</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#EconomicActivity.getTypes" title="Link to this definition">¶</a></dt>
+<dd><p>Retrieves available economic activity emission calculation types by making a GET request to the API endpoint.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available economic activity emission types</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getTypes</span><span class="p">();</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
 </section>
 <section id="getarea">
 <h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
@@ -1012,6 +1118,40 @@ Only refreshes if the token was not provided by the user and is expiring within
 </div>
 </dd></dl>
 
+<dl class="js function">
+<dt class="sig sig-object js" id="RealEstate.getArea">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">RealEstate</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#RealEstate.getArea" title="Link to this definition">¶</a></dt>
+<dd><p>Retrieves information about geographical areas supported by the real estate emissions API.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getArea</span><span class="p">();</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
+<dl class="js function">
+<dt class="sig sig-object js" id="EconomicActivity.getArea">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">EconomicActivity</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#EconomicActivity.getArea" title="Link to this definition">¶</a></dt>
+<dd><p>Retrieves information about geographical areas supported by the economic activity emissions API.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getArea</span><span class="p">();</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
 </section>
 <section id="getunits">
 <h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
@@ -1194,6 +1334,52 @@ Only refreshes if the token was not provided by the user and is expiring within
 </div>
 </dd></dl>
 
+<dl class="js function">
+<dt class="sig sig-object js" id="RealEstate.getUnits">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">RealEstate</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getUnits</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RealEstate.getUnits" title="Link to this definition">¶</a></dt>
+<dd><p>Retrieves available units for a specific Real estate emission type.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The Real estate emission type to get units for (e.g., “R134A”)</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;UnitResponse&gt;</span> – A promise that resolves to a UnitResponse containing the available units</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the &quot;Commercial Real Estate:Industrial distribution warehouse&quot; emission real estate type with subtype</span>
+<span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Commercial Real Estate:Industrial distribution warehouse&quot;</span><span class="p">);</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
+<dl class="js function">
+<dt class="sig sig-object js" id="EconomicActivity.getUnits">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">EconomicActivity</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getUnits</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EconomicActivity.getUnits" title="Link to this definition">¶</a></dt>
+<dd><p>Retrieves available units for a specific economic activity emission type.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Arguments<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The economic activity emission type to get units for (e.g., “accomodation”)</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;UnitResponse&gt;</span> – A promise that resolves to a UnitResponse containing the available units</p>
+</dd>
+</dl>
+<div class="admonition-example admonition">
+<p class="admonition-title">Example</p>
+<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the &quot;accomodation&quot; emission economic activity type without subtype</span>
+<span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;accomodation&quot;</span><span class="p">);</span>
+</pre></div>
+</div>
+</div>
+</dd></dl>
+
 </section>
 </section>
 <section id="usage-api">
@@ -1521,6 +1707,8 @@ Used to find relevant factors or activities based on location, time, and search
 <li><a class="reference internal" href="#Mobile.calculate"><code class="docutils literal notranslate"><span class="pre">Mobile.calculate()</span></code></a></li>
 <li><a class="reference internal" href="#Stationary.calculate"><code class="docutils literal notranslate"><span class="pre">Stationary.calculate()</span></code></a></li>
 <li><a class="reference internal" href="#TransportationAndDistribution.calculate"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.calculate()</span></code></a></li>
+<li><a class="reference internal" href="#RealEstate.calculate"><code class="docutils literal notranslate"><span class="pre">RealEstate.calculate()</span></code></a></li>
+<li><a class="reference internal" href="#EconomicActivity.calculate"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#metadata-apis">Metadata APIs</a><ul>
@@ -1532,6 +1720,8 @@ Used to find relevant factors or activities based on location, time, and search
 <li><a class="reference internal" href="#Stationary.getTypes"><code class="docutils literal notranslate"><span class="pre">Stationary.getTypes()</span></code></a></li>
 <li><a class="reference internal" href="#TransportationAndDistribution.getTypes"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getTypes()</span></code></a></li>
 <li><a class="reference internal" href="#Fugitive.getTypes"><code class="docutils literal notranslate"><span class="pre">Fugitive.getTypes()</span></code></a></li>
+<li><a class="reference internal" href="#RealEstate.getTypes"><code class="docutils literal notranslate"><span class="pre">RealEstate.getTypes()</span></code></a></li>
+<li><a class="reference internal" href="#EconomicActivity.getTypes"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.getTypes()</span></code></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#getarea">getArea</a><ul>
@@ -1543,6 +1733,8 @@ Used to find relevant factors or activities based on location, time, and search
 <li><a class="reference internal" href="#Stationary.getArea"><code class="docutils literal notranslate"><span class="pre">Stationary.getArea()</span></code></a></li>
 <li><a class="reference internal" href="#TransportationAndDistribution.getArea"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getArea()</span></code></a></li>
 <li><a class="reference internal" href="#Fugitive.getArea"><code class="docutils literal notranslate"><span class="pre">Fugitive.getArea()</span></code></a></li>
+<li><a class="reference internal" href="#RealEstate.getArea"><code class="docutils literal notranslate"><span class="pre">RealEstate.getArea()</span></code></a></li>
+<li><a class="reference internal" href="#EconomicActivity.getArea"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.getArea()</span></code></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#getunits">getUnits</a><ul>
@@ -1553,6 +1745,8 @@ Used to find relevant factors or activities based on location, time, and search
 <li><a class="reference internal" href="#Stationary.getUnits"><code class="docutils literal notranslate"><span class="pre">Stationary.getUnits()</span></code></a></li>
 <li><a class="reference internal" href="#TransportationAndDistribution.getUnits"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getUnits()</span></code></a></li>
 <li><a class="reference internal" href="#Fugitive.getUnits"><code class="docutils literal notranslate"><span class="pre">Fugitive.getUnits()</span></code></a></li>
+<li><a class="reference internal" href="#RealEstate.getUnits"><code class="docutils literal notranslate"><span class="pre">RealEstate.getUnits()</span></code></a></li>
+<li><a class="reference internal" href="#EconomicActivity.getUnits"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.getUnits()</span></code></a></li>
 </ul>
 </li>
 </ul>

package/docs/searchindex.js

@@ -1 +1 @@
-Search.setIndex({"alltitles":{"1. Missing Auth URL with Custom Host":[[6,"missing-auth-url-with-custom-host"]],"2. Missing Client ID with Token":[[6,"missing-client-id-with-token"]],"3. Missing Parameters with API Key":[[6,"missing-parameters-with-api-key"]],"4. Invalid API Key":[[6,"invalid-api-key"]],"5. Invalid Organization ID":[[6,"invalid-organization-id"]],"6. Invalid Client ID":[[6,"invalid-client-id"]],"7. Empty Token Response":[[6,"empty-token-response"]],"8. Missing Expiry Field in Token":[[6,"missing-expiry-field-in-token"]],"API":[[4,"api"]],"API Key Authentication (Recommended)":[[0,"api-key-authentication-recommended"],[6,"api-key-authentication-recommended"]],"Architecture Diagram":[[0,"architecture-diagram"]],"Authentication":[[0,null],[2,"authentication"]],"Authentication Errors (HTTP 401)":[[6,"authentication-errors-http-401"]],"Authentication Flow":[[0,"authentication-flow"]],"Authentication Headers":[[0,"authentication-headers"]],"Authentication Integration":[[1,"authentication-integration"]],"Authentication Methods":[[0,"authentication-methods"]],"Automatic Token Refresh":[[6,"automatic-token-refresh"]],"Basic Import":[[2,"basic-import"]],"Best Practices":[[1,"best-practices"]],"Client":[[1,null]],"Client Initialization":[[1,"client-initialization"]],"Client Instance Errors":[[6,"client-instance-errors"]],"Client Not Initialized":[[6,"client-not-initialized"]],"Client Responsibilities":[[1,"client-responsibilities"]],"Common Scenarios":[[6,"common-scenarios"]],"Configuration Errors":[[6,"configuration-errors"]],"Configuration Options":[[1,"configuration-options"]],"Contents:":[[3,null]],"Error Handling":[[1,"error-handling"]],"Error Summary Table":[[6,"error-summary-table"]],"Example":[[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null]],"Example Response":[[2,"example-response"]],"First API Call":[[2,"first-api-call"]],"Getting Started":[[2,null]],"IBM Envizi - Emissions API Node.js SDK":[[3,null]],"Initialization Checklist":[[6,"initialization-checklist"]],"Installation":[[2,"installation"]],"Interfaces":[[4,"interfaces"]],"Introduction":[[3,"introduction"]],"Metadata APIs":[[4,"metadata-apis"]],"Overview":[[0,"overview"],[1,"overview"],[6,"overview"]],"Pre-generated Token Authentication":[[0,"pre-generated-token-authentication"]],"Prerequisites":[[2,"prerequisites"]],"Reference":[[4,null]],"Required Configuration Parameters":[[6,"required-configuration-parameters"]],"SDK":[[5,null]],"SDK Initialization Errors":[[6,"sdk-initialization-errors"]],"Scenario 1: Application Startup":[[6,"scenario-1-application-startup"]],"Scenario 2: Invalid Credentials":[[6,"scenario-2-invalid-credentials"]],"Scenario 3: Missing Configuration":[[6,"scenario-3-missing-configuration"]],"Scenario 4: Client Not Initialized":[[6,"scenario-4-client-not-initialized"]],"Security Best Practices":[[0,"security-best-practices"]],"Support":[[6,"support"]],"Supported Emission Types":[[3,"supported-emission-types"]],"Token Authentication":[[6,"token-authentication"]],"Token Management":[[6,"token-management"]],"Token lifetime & refresh":[[0,"token-lifetime-refresh"]],"Token retrieval":[[0,"token-retrieval"]],"Troubleshooting Guide":[[6,null]],"Troubleshooting Steps":[[6,"troubleshooting-steps"]],"Usage API":[[4,"usage-api"]],"Using API Key (Recommended)":[[2,"using-api-key-recommended"]],"Using Pre-generated Token":[[2,"using-pre-generated-token"]],"getArea":[[4,"getarea"]],"getTypes":[[4,"gettypes"]],"getUnits":[[4,"getunits"]]},"docnames":["authentication","client","getting_started","index","reference","sdk","troubleshooting"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1},"filenames":["authentication.rst","client.rst","getting_started.rst","index.rst","reference.rst","sdk.rst","troubleshooting.rst"],"indexentries":{"api.commonrequestwithfactorid() (interface)":[[4,"Api.CommonRequestWithFactorId",false]],"api.commonrequestwithoutfactorid() (interface)":[[4,"Api.CommonRequestWithoutFactorId",false]],"api.factorrequestwithfactorid() (interface)":[[4,"Api.FactorRequestWithFactorId",false]],"api.factorrequestwithoutfactorid() (interface)":[[4,"Api.FactorRequestWithoutFactorId",false]],"api.genericcalculationrequestwithfactorid() (interface)":[[4,"Api.GenericCalculationRequestWithFactorId",false]],"api.genericcalculationrequestwithoutfactorid() (interface)":[[4,"Api.GenericCalculationRequestWithoutFactorId",false]],"api.locationrequestwithfactorid() (interface)":[[4,"Api.LocationRequestWithFactorId",false]],"api.locationrequestwithoutfactorid() (interface)":[[4,"Api.LocationRequestWithoutFactorId",false]],"api.searchrequest() (interface)":[[4,"Api.SearchRequest",false]],"calculation.calculate() (calculation method)":[[4,"Calculation.calculate",false]],"calculation.getarea() (calculation method)":[[4,"Calculation.getArea",false]],"calculation.gettypes() (calculation method)":[[4,"Calculation.getTypes",false]],"calculation.getunits() (calculation method)":[[4,"Calculation.getUnits",false]],"client() (class)":[[4,"Client",false]],"client.getauthheader() (client method)":[[4,"Client.getAuthHeader",false]],"client.getclient() (client method)":[[4,"Client.getClient",false]],"client.getclientid() (client method)":[[4,"Client.getClientId",false]],"client.getclientsource() (client method)":[[4,"Client.getClientSource",false]],"client.getdomain() (client method)":[[4,"Client.getDomain",false]],"client.getinstance() (client method)":[[4,"Client.getInstance",false]],"client.refreshtoken() (client method)":[[4,"Client.refreshToken",false]],"common.activity() (interface)":[[4,"common.Activity",false]],"common.activitywithfactorid() (interface)":[[4,"common.ActivityWithFactorId",false]],"common.combinedunitsactivity() (interface)":[[4,"common.CombinedUnitsActivity",false]],"common.combinedunitsactivitywithfactorid() (interface)":[[4,"common.CombinedUnitsActivityWithFactorId",false]],"common.factoractivity() (interface)":[[4,"common.FactorActivity",false]],"common.factoractivitywithfactorid() (interface)":[[4,"common.FactorActivityWithFactorId",false]],"common.location() (interface)":[[4,"common.Location",false]],"common.pagination() (interface)":[[4,"common.Pagination",false]],"common.searchactivity() (interface)":[[4,"common.SearchActivity",false]],"common.time() (interface)":[[4,"common.Time",false]],"config.clientconfig() (interface)":[[4,"Config.ClientConfig",false]],"config.requestconfig() (interface)":[[4,"Config.RequestConfig",false]],"factor.getarea() (factor method)":[[4,"Factor.getArea",false]],"factor.getsearcharea() (factor method)":[[4,"Factor.getSearchArea",false]],"factor.gettypes() (factor method)":[[4,"Factor.getTypes",false]],"factor.getunits() (factor method)":[[4,"Factor.getUnits",false]],"factor.retrievefactor() (factor method)":[[4,"Factor.retrieveFactor",false]],"fugitive.calculate() (fugitive method)":[[4,"Fugitive.calculate",false]],"fugitive.getarea() (fugitive method)":[[4,"Fugitive.getArea",false]],"fugitive.gettypes() (fugitive method)":[[4,"Fugitive.getTypes",false]],"fugitive.getunits() (fugitive method)":[[4,"Fugitive.getUnits",false]],"location.calculate() (location method)":[[4,"Location.calculate",false]],"location.getarea() (location method)":[[4,"Location.getArea",false]],"location.gettypes() (location method)":[[4,"Location.getTypes",false]],"location.getunits() (location method)":[[4,"Location.getUnits",false]],"mobile.calculate() (mobile method)":[[4,"Mobile.calculate",false]],"mobile.getarea() (mobile method)":[[4,"Mobile.getArea",false]],"mobile.gettypes() (mobile method)":[[4,"Mobile.getTypes",false]],"mobile.getunits() (mobile method)":[[4,"Mobile.getUnits",false]],"request.makeapirequest() (request method)":[[4,"request.makeApiRequest",false]],"stationary.calculate() (stationary method)":[[4,"Stationary.calculate",false]],"stationary.getarea() (stationary method)":[[4,"Stationary.getArea",false]],"stationary.gettypes() (stationary method)":[[4,"Stationary.getTypes",false]],"stationary.getunits() (stationary method)":[[4,"Stationary.getUnits",false]],"transportationanddistribution.calculate() (transportationanddistribution method)":[[4,"TransportationAndDistribution.calculate",false]],"transportationanddistribution.getarea() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getArea",false]],"transportationanddistribution.gettypes() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getTypes",false]],"transportationanddistribution.getunits() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getUnits",false]],"usage.getusage() (usage method)":[[4,"Usage.getUsage",false]],"utils.findexpirytime() (utils method)":[[4,"utils.findExpiryTime",false]]},"objects":{"":[[4,2,1,"","Client"]],"Api":[[4,0,1,"","CommonRequestWithFactorId"],[4,0,1,"","CommonRequestWithoutFactorId"],[4,0,1,"","FactorRequestWithFactorId"],[4,0,1,"","FactorRequestWithoutFactorId"],[4,0,1,"","GenericCalculationRequestWithFactorId"],[4,0,1,"","GenericCalculationRequestWithoutFactorId"],[4,0,1,"","LocationRequestWithFactorId"],[4,0,1,"","LocationRequestWithoutFactorId"],[4,0,1,"","SearchRequest"]],"Calculation":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Client":[[4,1,1,"","getAuthHeader"],[4,1,1,"","getClient"],[4,1,1,"","getClientId"],[4,1,1,"","getClientSource"],[4,1,1,"","getDomain"],[4,1,1,"","getInstance"],[4,1,1,"","refreshToken"]],"Config":[[4,0,1,"","ClientConfig"],[4,0,1,"","RequestConfig"]],"Factor":[[4,1,1,"","getArea"],[4,1,1,"","getSearchArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"],[4,1,1,"","retrieveFactor"]],"Fugitive":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Location":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Mobile":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Stationary":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"TransportationAndDistribution":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Usage":[[4,1,1,"","getUsage"]],"common":[[4,0,1,"","Activity"],[4,0,1,"","ActivityWithFactorId"],[4,0,1,"","CombinedUnitsActivity"],[4,0,1,"","CombinedUnitsActivityWithFactorId"],[4,0,1,"","FactorActivity"],[4,0,1,"","FactorActivityWithFactorId"],[4,0,1,"","Location"],[4,0,1,"","Pagination"],[4,0,1,"","SearchActivity"],[4,0,1,"","Time"]],"request":[[4,1,1,"","makeApiRequest"]],"utils":[[4,1,1,"","findExpiryTime"]]},"objnames":{"0":["js","interface","JavaScript interface"],"1":["js","function","JavaScript function"],"2":["js","class","JavaScript class"]},"objtypes":{"0":"js:interface","1":"js:function","2":"js:class"},"terms":{"":[0,2,4,6],"0":[0,2,4,6],"00033022":2,"00036061":2,"01":[4,6],"01115131":2,"02ae":2,"04":[4,6],"1":[2,4],"1000":4,"11":6,"121":4,"1223123":4,"123":4,"12345":[4,6],"14123143":4,"150":4,"1500000":4,"2":[0,4],"2022":[2,4],"2025":[4,6],"20681091":2,"20750174":2,"24":6,"263fb":4,"3":4,"426a":4,"47a3":2,"60":[4,6],"831bfca7cecd":2,"95a7efe7":2,"9999":4,"A":[0,4,6],"For":[0,1,6],"If":[0,2,6],"In":0,"It":1,"No":1,"OR":[1,4],"Or":[2,6],"That":6,"The":[0,1,2,3,4,5,6],"Then":4,"These":6,"a7fd":2,"aaa":4,"about":[0,1,4,6],"accept":[0,1,2],"access":[0,1,4,6],"account":6,"across":1,"activ":[2,3,4,6],"activitywithfactorid":4,"add":[0,1],"after":2,"all":[1,4,6],"allow":6,"alreadi":[2,4],"also":6,"alwai":6,"an":[2,4,6],"ani":[4,6],"api":[1,5],"apidomain":4,"apikei":[0,1,2,4,6],"applic":[0,1,2,3,4],"approach":[0,5],"appropri":[1,4],"ar":[2,6],"architectur":5,"area":[2,4],"arearespons":4,"argument":4,"async":[2,4],"attempt":6,"auth":4,"authent":[3,4,5],"author":[0,4],"authurl":[0,1,4,6],"autom":3,"automat":[0,1],"avail":[2,4,6],"await":[0,1,2,4,6],"axio":0,"b20":4,"base":[2,4,6],"bearer":[0,4],"befor":[0,1,2,4,6],"best":5,"bill":4,"bodi":6,"boolean":4,"both":6,"build":3,"bulk":4,"busi":4,"cach":0,"calcul":[2,3,4,6],"calculateemiss":2,"calculationrequest":4,"california":2,"call":[0,3,6],"can":[2,4,6],"cannot":6,"car":4,"carbon":3,"cargo":4,"carrier":4,"catch":[1,2],"caus":6,"central":1,"ch4":2,"chain":3,"check":[0,6],"checklist":3,"claim":6,"class":4,"client":[0,2,3,4,5],"client123":[4,6],"clientconfig":4,"clientid":[0,1,2,4,6],"climat":2,"close":1,"cloud":6,"co2":2,"coal":[4,6],"code":[0,6],"com":[0,2,4,6],"combin":6,"combinedunitsact":4,"combinedunitsactivitywithfactorid":4,"combust":4,"common":[3,4],"commonrequest":4,"commonrequestwithfactorid":4,"commonrequestwithoutfactorid":4,"complet":[4,6],"complex":4,"compon":[1,5],"config":4,"configur":[3,4,5],"confirm":6,"connect":[1,2,6],"consist":1,"consol":[1,2,4,6],"const":[2,4,6],"consumpt":3,"contact":6,"contain":[4,6],"content":4,"control":0,"convert":4,"correct":6,"correctli":6,"correspond":6,"countri":[2,4,6],"cover":[5,6],"coverag":6,"credenti":[0,1,2],"criteria":4,"current":4,"custom":[1,3,4],"dashboard":3,"data":[1,4],"databas":3,"dataset":3,"date":[4,6],"debug":6,"decis":3,"decod":0,"default":[0,1,4],"deploy":0,"descript":[1,2],"design":[1,3],"detail":[0,1,4,6],"detect":0,"determin":4,"diagram":5,"diesel":4,"directli":[2,6],"distribut":[3,4],"document":6,"doe":6,"doesn":[4,6],"domain":[0,4,6],"dure":6,"dwt":4,"e":[2,4,6],"each":0,"egrid":2,"either":1,"electr":[2,4],"email":4,"embed":3,"emiss":[0,1,2,4,5,6],"emissionrespons":4,"emissionresponsewithdetail":4,"enabl":6,"endpoint":[0,1,2,4,6],"energi":4,"engin":3,"enotfound":6,"ensur":[1,2,4,6],"entir":2,"env":[0,1],"environ":[0,1,6],"envizi":[0,1,5],"envizi_api_kei":[0,1],"envizi_client_id":[0,1],"envizi_org_id":[0,1],"envizisdk":2,"equip":3,"error":[2,3,5],"etc":6,"exact":4,"exampl":[3,6],"excel":0,"exclud":6,"exist":[1,4,6],"exp":[0,6],"expect":4,"expir":[0,1,4,6],"expiri":[0,4],"expirytim":4,"explain":0,"export":4,"extern":0,"extract":4,"factor":[2,3,4],"factoract":4,"factoractivitywithfactorid":4,"factorid":4,"factorrequest":4,"factorrequestwithfactorid":4,"factorrequestwithoutfactorid":4,"factorrespons":4,"fail":[2,6],"failur":[1,6],"fals":4,"fetch":1,"find":4,"findexpirytim":[3,4],"firewal":6,"first":[3,4,6],"fix":3,"flag":4,"flow":5,"follow":[0,1,2,6],"footprint":3,"format":[0,2],"freight":4,"fresh":[0,4],"from":[0,1,2,3,4,6],"fuel":[3,4],"fugit":[3,4,6],"fugitv":4,"function":[2,6],"futur":0,"g":[4,6],"ga":[3,4],"gener":[1,3,4,6],"genericcalculationrequestwithfactorid":4,"genericcalculationrequestwithoutfactorid":4,"geograph":4,"get":[0,3,4,6],"getauthhead":4,"getclient":[0,1,2,4,6],"getclientid":4,"getclientsourc":4,"getdomain":4,"getinst":[4,6],"getsearcharea":4,"getunit":6,"getusag":4,"ghg":3,"ghgemiss":0,"give":4,"gracefulli":1,"greas":4,"greenhous":3,"guid":3,"ha":6,"handl":[0,5,6],"hardcod":0,"have":[2,4],"header":[1,2,4,5,6],"here":2,"hfc":4,"histor":4,"histori":4,"host":[0,1,4],"http":[0,1,2,4],"httpcode":6,"httpmessag":6,"hybrid":4,"i":[0,1,3,4,6],"ibm":[0,1,2,5,6],"ibmid":2,"id":[0,1,2,4],"identifi":[0,4],"implement":[0,1,6],"import":[0,1],"includ":[0,4,6],"includedetail":4,"indirectco2":2,"inform":[0,1,4],"init":0,"initi":[0,2,3,4,5],"instal":3,"instanc":[1,3,4],"instead":[4,6],"integr":5,"interact":5,"interfac":[1,3],"internet":2,"invalid_api_key_12345":6,"involv":4,"issu":6,"isuserprovidedtoken":4,"j":[0,1,2,5,6],"jet":4,"json":[0,2,4],"jwt":[0,4,6],"jwt_token":0,"jwttoken":4,"kei":[1,4,5],"kerosen":4,"kg":4,"kgco2e":2,"kj":[4,6],"km":4,"known":4,"kwh":[2,4],"l":4,"lack":6,"larg":[3,4],"last":6,"layer":0,"leader":2,"leak":3,"least":0,"let":1,"lignit":[4,6],"list":6,"ll":6,"locat":[2,3,4,6],"locationemiss":2,"locationrequest":4,"locationrequestwithfactorid":4,"locationrequestwithoutfactorid":4,"log":[2,4],"logist":3,"look":4,"mai":4,"maintain":1,"make":[2,3,4],"makeapirequest":[0,3,4],"malform":6,"manag":[0,1,2,3],"match":6,"measur":4,"messag":[1,6],"metadata":3,"method":[1,2,4,5,6],"metric":4,"mobil":[3,4,6],"mode":0,"modul":[1,2],"more":[0,6],"moreinform":6,"multipl":4,"must":6,"n":6,"n2o":2,"name":4,"natur":4,"nc":4,"ne":4,"necessari":0,"need":[0,4],"network":6,"never":0,"new":[0,4],"node":[0,1,2,5,6],"note":6,"npm":2,"null":6,"oauth":0,"object":4,"obtain":[1,2],"occur":[0,6],"old":0,"onc":[0,1],"one":[0,1],"onli":[0,1,4,6],"oper":[1,3,4,6],"optim":1,"option":[0,4,5],"org":[2,6],"org456":[4,6],"organ":[0,1,4],"orgid":[0,1,2,4,6],"other":[4,6],"otherwis":4,"overview":[2,3,5],"page":[0,1,2],"pagin":4,"param":[0,4],"paramet":[0,1,3,4],"pass":6,"pattern":5,"payload":4,"perform":4,"period":4,"permiss":6,"petroleum":4,"point":[4,6],"post":4,"practic":5,"pre":[1,6],"prerequisit":3,"preview":2,"principl":0,"privileg":0,"proce":4,"process":[0,1],"product":[0,1],"project":[2,3],"promis":4,"proper":[0,1,6],"properli":6,"provid":[0,1,2,4,5,6],"purchas":4,"purpos":4,"queri":[0,4],"r":4,"r134a":4,"re":[0,6],"record":4,"refer":3,"refresh":[1,4],"refreshtoken":4,"regener":6,"region":[2,3],"relat":[4,6],"relev":4,"replac":0,"repres":4,"reproduc":6,"request":[0,1,3,4],"requestconfig":4,"requir":[0,1,2,3],"resolv":4,"respond":6,"respons":[0,3,4,5],"restart":6,"result":[2,4],"retriev":[2,4],"retrievefactor":4,"return":[0,2,4,6],"reus":1,"review":6,"revok":6,"run":[0,2],"saascor":[0,2],"sampl":6,"scale":3,"scenario":[0,3],"scope":4,"sdk":[0,1,2,4],"search":4,"searchact":4,"searchrequest":4,"second":[4,6],"secret":6,"section":5,"secur":[1,5,6],"see":[0,1],"send":0,"sensit":6,"sent":4,"server":6,"servic":[0,1,6],"set":[2,6],"sever":1,"ship":4,"sign":2,"singl":4,"singleton":[0,1,4],"size":4,"small":4,"solut":6,"sourc":[0,3,4],"specif":[1,3,4,6],"specifi":4,"stack":6,"standard":[4,6],"start":[3,6],"startup":1,"state":2,"stateprovinc":[2,4],"static":4,"stationari":[3,4,6],"statu":[1,6],"steam":6,"steel":4,"step":[0,3],"store":[0,1,6],"string":[0,4],"structur":5,"subsequ":6,"subtyp":4,"successfulli":[2,6],"summari":3,"suppli":3,"support":[1,4],"sustain":3,"t":[4,6],"tabl":3,"target":6,"tenantid":2,"thei":6,"thi":[0,2,4,5,6],"three":6,"throw":6,"thrown":6,"time":[0,4,6],"timestamp":4,"togeth":6,"toisostr":4,"token":[1,3,4],"totalco2":2,"trace":6,"track":3,"transactionid":2,"transport":[3,4],"transportationanddistribut":4,"travel":4,"trim":0,"troubleshoot":3,"true":4,"try":[1,2],"two":[0,2],"type":[2,4,6],"typerespons":4,"u":2,"unauthor":6,"unifi":1,"unit":[2,4,6],"unitrespons":4,"unix":4,"unless":1,"unreach":6,"up":[2,4,6],"updat":6,"url":[0,4],"us":[0,1,3,4,6],"usa":[2,4,6],"usag":[1,3,5],"usagerespons":4,"user":[0,1,4,6],"userdata":4,"util":[3,4],"v":[0,1],"valid":[0,1,6],"valu":[2,4,6],"variabl":[0,1,6],"vehicl":3,"verifi":[1,6],"version":6,"void":4,"wa":[2,4,6],"waitlist":2,"wast":4,"web":4,"when":[0,4,6],"where":[0,4],"which":0,"within":[4,6],"without":[4,6],"work":1,"wrong":6,"x":[0,2,4],"yarn":2,"ye":1,"year":2,"york":4,"you":[0,2,6],"your":[0,1,2,3,4,6]},"titles":["Authentication","Client","Getting Started","IBM Envizi - Emissions API Node.js SDK","Reference","SDK","Troubleshooting Guide"],"titleterms":{"1":6,"2":6,"3":6,"4":6,"401":6,"5":6,"6":6,"7":6,"8":6,"Not":6,"api":[0,2,3,4,6],"applic":6,"architectur":0,"auth":6,"authent":[0,1,2,6],"automat":6,"basic":2,"best":[0,1],"call":2,"checklist":6,"client":[1,6],"common":6,"configur":[1,6],"content":3,"credenti":6,"custom":6,"diagram":0,"emiss":3,"empti":6,"envizi":3,"error":[1,6],"exampl":[2,4],"expiri":6,"field":6,"first":2,"flow":0,"gener":[0,2],"get":2,"getarea":4,"gettyp":4,"getunit":4,"guid":6,"handl":1,"header":0,"host":6,"http":6,"ibm":3,"id":6,"import":2,"initi":[1,6],"instal":2,"instanc":6,"integr":1,"interfac":4,"introduct":3,"invalid":6,"j":3,"kei":[0,2,6],"lifetim":0,"manag":6,"metadata":4,"method":0,"miss":6,"node":3,"option":1,"organ":6,"overview":[0,1,6],"paramet":6,"practic":[0,1],"pre":[0,2],"prerequisit":2,"recommend":[0,2,6],"refer":4,"refresh":[0,6],"requir":6,"respons":[1,2,6],"retriev":0,"scenario":6,"sdk":[3,5,6],"secur":0,"start":2,"startup":6,"step":6,"summari":6,"support":[3,6],"tabl":6,"token":[0,2,6],"troubleshoot":6,"type":3,"url":6,"us":2,"usag":4}})
+Search.setIndex({"alltitles":{"1. Missing Auth URL with Custom Host":[[6,"missing-auth-url-with-custom-host"]],"2. Missing Client ID with Token":[[6,"missing-client-id-with-token"]],"3. Missing Parameters with API Key":[[6,"missing-parameters-with-api-key"]],"4. Invalid API Key":[[6,"invalid-api-key"]],"5. Invalid Organization ID":[[6,"invalid-organization-id"]],"6. Invalid Client ID":[[6,"invalid-client-id"]],"7. Empty Token Response":[[6,"empty-token-response"]],"8. Missing Expiry Field in Token":[[6,"missing-expiry-field-in-token"]],"API":[[4,"api"]],"API Key Authentication (Recommended)":[[0,"api-key-authentication-recommended"],[6,"api-key-authentication-recommended"]],"Architecture Diagram":[[0,"architecture-diagram"]],"Authentication":[[0,null],[2,"authentication"]],"Authentication Errors (HTTP 401)":[[6,"authentication-errors-http-401"]],"Authentication Flow":[[0,"authentication-flow"]],"Authentication Headers":[[0,"authentication-headers"]],"Authentication Integration":[[1,"authentication-integration"]],"Authentication Methods":[[0,"authentication-methods"]],"Automatic Token Refresh":[[6,"automatic-token-refresh"]],"Basic Import":[[2,"basic-import"]],"Best Practices":[[1,"best-practices"]],"Client":[[1,null]],"Client Initialization":[[1,"client-initialization"]],"Client Instance Errors":[[6,"client-instance-errors"]],"Client Not Initialized":[[6,"client-not-initialized"]],"Client Responsibilities":[[1,"client-responsibilities"]],"Common Scenarios":[[6,"common-scenarios"]],"Configuration Errors":[[6,"configuration-errors"]],"Configuration Options":[[1,"configuration-options"]],"Contents:":[[3,null]],"Error Handling":[[1,"error-handling"]],"Error Summary Table":[[6,"error-summary-table"]],"Example":[[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null],[4,null]],"Example Response":[[2,"example-response"]],"First API Call":[[2,"first-api-call"]],"Getting Started":[[2,null]],"IBM Envizi - Emissions API Node.js SDK":[[3,null]],"Initialization Checklist":[[6,"initialization-checklist"]],"Installation":[[2,"installation"]],"Interfaces":[[4,"interfaces"]],"Introduction":[[3,"introduction"]],"Metadata APIs":[[4,"metadata-apis"]],"Overview":[[0,"overview"],[1,"overview"],[6,"overview"]],"Pre-generated Token Authentication":[[0,"pre-generated-token-authentication"]],"Prerequisites":[[2,"prerequisites"]],"Reference":[[4,null]],"Required Configuration Parameters":[[6,"required-configuration-parameters"]],"SDK":[[5,null]],"SDK Initialization Errors":[[6,"sdk-initialization-errors"]],"Scenario 1: Application Startup":[[6,"scenario-1-application-startup"]],"Scenario 2: Invalid Credentials":[[6,"scenario-2-invalid-credentials"]],"Scenario 3: Missing Configuration":[[6,"scenario-3-missing-configuration"]],"Scenario 4: Client Not Initialized":[[6,"scenario-4-client-not-initialized"]],"Security Best Practices":[[0,"security-best-practices"]],"Support":[[6,"support"]],"Supported Emission Types":[[3,"supported-emission-types"]],"Token Authentication":[[6,"token-authentication"]],"Token Management":[[6,"token-management"]],"Token lifetime & refresh":[[0,"token-lifetime-refresh"]],"Token retrieval":[[0,"token-retrieval"]],"Troubleshooting Guide":[[6,null]],"Troubleshooting Steps":[[6,"troubleshooting-steps"]],"Usage API":[[4,"usage-api"]],"Using API Key (Recommended)":[[2,"using-api-key-recommended"]],"Using Pre-generated Token":[[2,"using-pre-generated-token"]],"getArea":[[4,"getarea"]],"getTypes":[[4,"gettypes"]],"getUnits":[[4,"getunits"]]},"docnames":["authentication","client","getting_started","index","reference","sdk","troubleshooting"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1},"filenames":["authentication.rst","client.rst","getting_started.rst","index.rst","reference.rst","sdk.rst","troubleshooting.rst"],"indexentries":{"api.commonrequestwithfactorid() (interface)":[[4,"Api.CommonRequestWithFactorId",false]],"api.commonrequestwithoutfactorid() (interface)":[[4,"Api.CommonRequestWithoutFactorId",false]],"api.factorrequestwithfactorid() (interface)":[[4,"Api.FactorRequestWithFactorId",false]],"api.factorrequestwithoutfactorid() (interface)":[[4,"Api.FactorRequestWithoutFactorId",false]],"api.genericcalculationrequestwithfactorid() (interface)":[[4,"Api.GenericCalculationRequestWithFactorId",false]],"api.genericcalculationrequestwithoutfactorid() (interface)":[[4,"Api.GenericCalculationRequestWithoutFactorId",false]],"api.locationrequestwithfactorid() (interface)":[[4,"Api.LocationRequestWithFactorId",false]],"api.locationrequestwithoutfactorid() (interface)":[[4,"Api.LocationRequestWithoutFactorId",false]],"api.searchrequest() (interface)":[[4,"Api.SearchRequest",false]],"calculation.calculate() (calculation method)":[[4,"Calculation.calculate",false]],"calculation.getarea() (calculation method)":[[4,"Calculation.getArea",false]],"calculation.gettypes() (calculation method)":[[4,"Calculation.getTypes",false]],"calculation.getunits() (calculation method)":[[4,"Calculation.getUnits",false]],"client() (class)":[[4,"Client",false]],"client.getauthheader() (client method)":[[4,"Client.getAuthHeader",false]],"client.getclient() (client method)":[[4,"Client.getClient",false]],"client.getclientid() (client method)":[[4,"Client.getClientId",false]],"client.getclientsource() (client method)":[[4,"Client.getClientSource",false]],"client.getdomain() (client method)":[[4,"Client.getDomain",false]],"client.getinstance() (client method)":[[4,"Client.getInstance",false]],"client.refreshtoken() (client method)":[[4,"Client.refreshToken",false]],"common.activity() (interface)":[[4,"common.Activity",false]],"common.activitywithfactorid() (interface)":[[4,"common.ActivityWithFactorId",false]],"common.combinedunitsactivity() (interface)":[[4,"common.CombinedUnitsActivity",false]],"common.combinedunitsactivitywithfactorid() (interface)":[[4,"common.CombinedUnitsActivityWithFactorId",false]],"common.factoractivity() (interface)":[[4,"common.FactorActivity",false]],"common.factoractivitywithfactorid() (interface)":[[4,"common.FactorActivityWithFactorId",false]],"common.location() (interface)":[[4,"common.Location",false]],"common.pagination() (interface)":[[4,"common.Pagination",false]],"common.searchactivity() (interface)":[[4,"common.SearchActivity",false]],"common.time() (interface)":[[4,"common.Time",false]],"config.clientconfig() (interface)":[[4,"Config.ClientConfig",false]],"config.requestconfig() (interface)":[[4,"Config.RequestConfig",false]],"economicactivity.calculate() (economicactivity method)":[[4,"EconomicActivity.calculate",false]],"economicactivity.getarea() (economicactivity method)":[[4,"EconomicActivity.getArea",false]],"economicactivity.gettypes() (economicactivity method)":[[4,"EconomicActivity.getTypes",false]],"economicactivity.getunits() (economicactivity method)":[[4,"EconomicActivity.getUnits",false]],"factor.getarea() (factor method)":[[4,"Factor.getArea",false]],"factor.getsearcharea() (factor method)":[[4,"Factor.getSearchArea",false]],"factor.gettypes() (factor method)":[[4,"Factor.getTypes",false]],"factor.getunits() (factor method)":[[4,"Factor.getUnits",false]],"factor.retrievefactor() (factor method)":[[4,"Factor.retrieveFactor",false]],"fugitive.calculate() (fugitive method)":[[4,"Fugitive.calculate",false]],"fugitive.getarea() (fugitive method)":[[4,"Fugitive.getArea",false]],"fugitive.gettypes() (fugitive method)":[[4,"Fugitive.getTypes",false]],"fugitive.getunits() (fugitive method)":[[4,"Fugitive.getUnits",false]],"location.calculate() (location method)":[[4,"Location.calculate",false]],"location.getarea() (location method)":[[4,"Location.getArea",false]],"location.gettypes() (location method)":[[4,"Location.getTypes",false]],"location.getunits() (location method)":[[4,"Location.getUnits",false]],"mobile.calculate() (mobile method)":[[4,"Mobile.calculate",false]],"mobile.getarea() (mobile method)":[[4,"Mobile.getArea",false]],"mobile.gettypes() (mobile method)":[[4,"Mobile.getTypes",false]],"mobile.getunits() (mobile method)":[[4,"Mobile.getUnits",false]],"realestate.calculate() (realestate method)":[[4,"RealEstate.calculate",false]],"realestate.getarea() (realestate method)":[[4,"RealEstate.getArea",false]],"realestate.gettypes() (realestate method)":[[4,"RealEstate.getTypes",false]],"realestate.getunits() (realestate method)":[[4,"RealEstate.getUnits",false]],"request.makeapirequest() (request method)":[[4,"request.makeApiRequest",false]],"stationary.calculate() (stationary method)":[[4,"Stationary.calculate",false]],"stationary.getarea() (stationary method)":[[4,"Stationary.getArea",false]],"stationary.gettypes() (stationary method)":[[4,"Stationary.getTypes",false]],"stationary.getunits() (stationary method)":[[4,"Stationary.getUnits",false]],"transportationanddistribution.calculate() (transportationanddistribution method)":[[4,"TransportationAndDistribution.calculate",false]],"transportationanddistribution.getarea() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getArea",false]],"transportationanddistribution.gettypes() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getTypes",false]],"transportationanddistribution.getunits() (transportationanddistribution method)":[[4,"TransportationAndDistribution.getUnits",false]],"usage.getusage() (usage method)":[[4,"Usage.getUsage",false]],"utils.findexpirytime() (utils method)":[[4,"utils.findExpiryTime",false]]},"objects":{"":[[4,2,1,"","Client"]],"Api":[[4,0,1,"","CommonRequestWithFactorId"],[4,0,1,"","CommonRequestWithoutFactorId"],[4,0,1,"","FactorRequestWithFactorId"],[4,0,1,"","FactorRequestWithoutFactorId"],[4,0,1,"","GenericCalculationRequestWithFactorId"],[4,0,1,"","GenericCalculationRequestWithoutFactorId"],[4,0,1,"","LocationRequestWithFactorId"],[4,0,1,"","LocationRequestWithoutFactorId"],[4,0,1,"","SearchRequest"]],"Calculation":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Client":[[4,1,1,"","getAuthHeader"],[4,1,1,"","getClient"],[4,1,1,"","getClientId"],[4,1,1,"","getClientSource"],[4,1,1,"","getDomain"],[4,1,1,"","getInstance"],[4,1,1,"","refreshToken"]],"Config":[[4,0,1,"","ClientConfig"],[4,0,1,"","RequestConfig"]],"EconomicActivity":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Factor":[[4,1,1,"","getArea"],[4,1,1,"","getSearchArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"],[4,1,1,"","retrieveFactor"]],"Fugitive":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Location":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Mobile":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"RealEstate":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Stationary":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"TransportationAndDistribution":[[4,1,1,"","calculate"],[4,1,1,"","getArea"],[4,1,1,"","getTypes"],[4,1,1,"","getUnits"]],"Usage":[[4,1,1,"","getUsage"]],"common":[[4,0,1,"","Activity"],[4,0,1,"","ActivityWithFactorId"],[4,0,1,"","CombinedUnitsActivity"],[4,0,1,"","CombinedUnitsActivityWithFactorId"],[4,0,1,"","FactorActivity"],[4,0,1,"","FactorActivityWithFactorId"],[4,0,1,"","Location"],[4,0,1,"","Pagination"],[4,0,1,"","SearchActivity"],[4,0,1,"","Time"]],"request":[[4,1,1,"","makeApiRequest"]],"utils":[[4,1,1,"","findExpiryTime"]]},"objnames":{"0":["js","interface","JavaScript interface"],"1":["js","function","JavaScript function"],"2":["js","class","JavaScript class"]},"objtypes":{"0":"js:interface","1":"js:function","2":"js:class"},"terms":{"":[0,2,4,6],"0":[0,2,4,6],"00033022":2,"00036061":2,"01":[4,6],"01115131":2,"02ae":2,"04":[4,6],"1":[2,4],"1000":4,"11":6,"12":4,"121":4,"1223123":4,"123":4,"12345":[4,6],"14123143":4,"150":4,"1500":4,"1500000":4,"17000":4,"2":[0,4],"2022":[2,4],"2025":[4,6],"20681091":2,"20750174":2,"24":6,"263fb":4,"3":4,"426a":4,"47a3":2,"60":[4,6],"831bfca7cecd":2,"95a7efe7":2,"9999":4,"A":[0,4,6],"For":[0,1,6],"If":[0,2,6],"In":0,"It":1,"No":1,"OR":[1,4],"Or":[2,6],"That":6,"The":[0,1,2,3,4,5,6],"Then":4,"These":6,"a7fd":2,"aaa":4,"about":[0,1,4,6],"accept":[0,1,2],"access":[0,1,4,6],"accomod":4,"account":6,"across":1,"activ":[2,3,4,6],"activitywithfactorid":4,"add":[0,1],"after":2,"all":[1,4,6],"allow":6,"alreadi":[2,4],"also":6,"alwai":6,"an":[2,4,6],"ani":[4,6],"api":[1,5],"apidomain":4,"apikei":[0,1,2,4,6],"applic":[0,1,2,3,4],"approach":[0,5],"appropri":[1,4],"ar":[2,6],"architectur":5,"area":[2,4],"arearespons":4,"argument":4,"async":[2,4],"attempt":6,"auth":4,"authent":[3,4,5],"author":[0,4],"authurl":[0,1,4,6],"autom":3,"automat":[0,1],"avail":[2,4,6],"await":[0,1,2,4,6],"axio":0,"b20":4,"base":[2,3,4,6],"bearer":[0,4],"befor":[0,1,2,4,6],"best":5,"bill":4,"bodi":6,"boolean":4,"both":6,"build":3,"bulk":4,"busi":[3,4],"cach":0,"calcul":[2,3,4,6],"calculateemiss":2,"calculationrequest":4,"california":2,"call":[0,3,6],"can":[2,4,6],"cannot":6,"car":4,"carbon":3,"cargo":4,"carrier":4,"catch":[1,2],"caus":6,"central":1,"ch4":2,"chain":3,"check":[0,6],"checklist":3,"claim":6,"class":4,"client":[0,2,3,4,5],"client123":[4,6],"clientconfig":4,"clientid":[0,1,2,4,6],"climat":2,"close":1,"cloud":6,"co2":2,"coal":[4,6],"code":[0,6],"com":[0,2,4,6],"combin":6,"combinedunitsact":4,"combinedunitsactivitywithfactorid":4,"combust":4,"commerci":[3,4],"common":[3,4],"commonrequest":4,"commonrequestwithfactorid":4,"commonrequestwithoutfactorid":4,"complet":[4,6],"complex":4,"compon":[1,5],"config":4,"configur":[3,4,5],"confirm":6,"connect":[1,2,6],"consist":1,"consol":[1,2,4,6],"const":[2,4,6],"consumpt":3,"contact":6,"contain":[4,6],"content":4,"control":0,"convert":4,"correct":6,"correctli":6,"correspond":6,"countri":[2,4,6],"cover":[5,6],"coverag":6,"credenti":[0,1,2],"criteria":4,"current":4,"custom":[1,3,4],"dashboard":3,"data":[1,4],"databas":3,"dataset":3,"date":[4,6],"debug":6,"decis":3,"decod":0,"default":[0,1,4],"deploy":0,"descript":[1,2],"design":[1,3],"detail":[0,1,4,6],"detect":0,"determin":4,"diagram":5,"diesel":4,"directli":[2,6],"distribut":[3,4],"document":6,"doe":6,"doesn":[4,6],"domain":[0,4,6],"dure":6,"dwt":4,"e":[2,4,6],"each":0,"econom":[3,4],"economicact":4,"egrid":2,"either":1,"electr":[2,4],"email":4,"embed":3,"emiss":[0,1,2,4,5,6],"emissionrespons":4,"emissionresponsewithdetail":4,"enabl":6,"endpoint":[0,1,2,4,6],"energi":4,"engin":3,"enotfound":6,"ensur":[1,2,4,6],"entir":2,"env":[0,1],"environ":[0,1,6],"envizi":[0,1,5],"envizi_api_kei":[0,1],"envizi_client_id":[0,1],"envizi_org_id":[0,1],"envizisdk":2,"equip":3,"error":[2,3,5],"estat":[3,4],"etc":6,"exact":4,"exampl":[3,6],"excel":0,"exclud":6,"exist":[1,4,6],"exp":[0,6],"expect":4,"expir":[0,1,4,6],"expiri":[0,4],"expirytim":4,"explain":0,"export":4,"extern":0,"extract":4,"factor":[2,3,4],"factoract":4,"factoractivitywithfactorid":4,"factorid":4,"factorrequest":4,"factorrequestwithfactorid":4,"factorrequestwithoutfactorid":4,"factorrespons":4,"fail":[2,6],"failur":[1,6],"fals":4,"fetch":1,"find":4,"findexpirytim":[3,4],"firewal":6,"first":[3,4,6],"fix":3,"flag":4,"flow":5,"follow":[0,1,2,6],"footprint":3,"format":[0,2],"freight":4,"fresh":[0,4],"from":[0,1,2,3,4,6],"fuel":[3,4],"fugit":[3,4,6],"fugitv":4,"function":[2,6],"futur":0,"g":[4,6],"ga":[3,4],"gener":[1,3,4,6],"genericcalculationrequestwithfactorid":4,"genericcalculationrequestwithoutfactorid":4,"geograph":4,"get":[0,3,4,6],"getauthhead":4,"getclient":[0,1,2,4,6],"getclientid":4,"getclientsourc":4,"getdomain":4,"getinst":[4,6],"getsearcharea":4,"getunit":6,"getusag":4,"ghg":3,"ghgemiss":0,"give":4,"gracefulli":1,"greas":4,"greenhous":3,"guid":3,"ha":6,"handl":[0,5,6],"hardcod":0,"have":[2,4],"header":[1,2,4,5,6],"here":2,"hfc":4,"histor":4,"histori":4,"host":[0,1,4],"http":[0,1,2,4],"httpcode":6,"httpmessag":6,"hybrid":4,"i":[0,1,3,4,6],"ibm":[0,1,2,5,6],"ibmid":2,"id":[0,1,2,4],"identifi":[0,4],"implement":[0,1,6],"import":[0,1],"includ":[0,4,6],"includedetail":4,"indirectco2":2,"industri":4,"inform":[0,1,4],"init":0,"initi":[0,2,3,4,5],"instal":3,"instanc":[1,3,4],"instead":[4,6],"integr":5,"interact":5,"interfac":[1,3],"internet":2,"invalid_api_key_12345":6,"involv":4,"issu":6,"isuserprovidedtoken":4,"j":[0,1,2,5,6],"jet":4,"json":[0,2,4],"jwt":[0,4,6],"jwt_token":0,"jwttoken":4,"kei":[1,4,5],"kerosen":4,"kg":4,"kgco2e":2,"kj":[4,6],"km":4,"known":4,"kwh":[2,4],"l":4,"lack":6,"larg":[3,4],"last":6,"layer":0,"leader":2,"leak":3,"least":0,"let":1,"lignit":[4,6],"list":6,"ll":6,"locat":[2,3,4,6],"locationemiss":2,"locationrequest":4,"locationrequestwithfactorid":4,"locationrequestwithoutfactorid":4,"log":[2,4],"logist":3,"look":4,"m2":4,"mai":4,"maintain":1,"make":[2,3,4],"makeapirequest":[0,3,4],"malform":6,"manag":[0,1,2,3],"match":6,"measur":4,"messag":[1,6],"metadata":3,"method":[1,2,4,5,6],"metric":4,"mobil":[3,4,6],"mode":0,"modul":[1,2],"more":[0,6],"moreinform":6,"multipl":4,"must":6,"n":6,"n2o":2,"name":4,"natur":4,"nc":4,"ne":4,"necessari":0,"need":[0,4],"network":6,"never":0,"new":[0,4],"node":[0,1,2,5,6],"note":6,"npm":2,"null":6,"oauth":0,"object":4,"obtain":[1,2],"occur":[0,6],"old":0,"onc":[0,1],"one":[0,1],"onli":[0,1,4,6],"oper":[1,3,4,6],"optim":1,"option":[0,4,5],"org":[2,6],"org456":[4,6],"organ":[0,1,4],"orgid":[0,1,2,4,6],"other":[4,6],"otherwis":4,"overview":[2,3,5],"page":[0,1,2],"pagin":4,"param":[0,4],"paramet":[0,1,3,4],"pass":6,"pattern":5,"payload":4,"perform":4,"period":4,"permiss":6,"petroleum":4,"point":[4,6],"post":4,"practic":5,"pre":[1,6],"prerequisit":3,"preview":2,"principl":0,"privileg":0,"proce":4,"process":[0,1],"product":[0,1],"project":[2,3],"promis":4,"proper":[0,1,6],"properli":6,"properti":3,"provid":[0,1,2,4,5,6],"purchas":4,"purpos":4,"queri":[0,4],"r":4,"r134a":4,"re":[0,6],"real":[3,4],"realest":4,"record":4,"refer":3,"refresh":[1,4],"refreshtoken":4,"regener":6,"region":[2,3],"relat":[4,6],"relev":4,"replac":0,"repres":4,"reproduc":6,"request":[0,1,3,4],"requestconfig":4,"requir":[0,1,2,3],"residenti":3,"resolv":4,"respond":6,"respons":[0,3,4,5],"restart":6,"result":[2,4],"retriev":[2,4],"retrievefactor":4,"return":[0,2,4,6],"reus":1,"review":6,"revok":6,"run":[0,2],"saascor":[0,2],"sampl":6,"scale":3,"scenario":[0,3],"scope":4,"sdk":[0,1,2,4],"search":4,"searchact":4,"searchrequest":4,"second":[4,6],"secret":6,"section":5,"secur":[1,5,6],"see":[0,1],"send":0,"sensit":6,"sent":4,"server":6,"servic":[0,1,6],"set":[2,6],"sever":1,"ship":4,"sign":2,"singl":4,"singleton":[0,1,4],"size":4,"small":4,"solut":6,"sourc":[0,3,4],"specif":[1,3,4,6],"specifi":4,"spend":[3,4],"stack":6,"standard":[4,6],"start":[3,6],"startup":1,"state":2,"stateprovinc":[2,4],"static":4,"stationari":[3,4,6],"statu":[1,6],"steam":6,"steel":4,"step":[0,3],"store":[0,1,6],"string":[0,4],"structur":5,"subsequ":6,"subtyp":4,"successfulli":[2,6],"summari":3,"suppli":3,"support":[1,4],"sustain":3,"t":[4,6],"tabl":3,"target":6,"tenantid":2,"thei":6,"thi":[0,2,4,5,6],"three":6,"throw":6,"thrown":6,"time":[0,4,6],"timestamp":4,"togeth":6,"toisostr":4,"token":[1,3,4],"totalco2":2,"trace":6,"track":3,"transactionid":2,"transport":[3,4],"transportationanddistribut":4,"travel":4,"trim":0,"troubleshoot":3,"true":4,"try":[1,2],"two":[0,2],"type":[2,4,6],"typerespons":4,"u":2,"unauthor":6,"unifi":1,"unit":[2,4,6],"unitrespons":4,"unix":4,"unless":1,"unreach":6,"up":[2,4,6],"updat":6,"url":[0,4],"us":[0,1,3,4,6],"usa":[2,4,6],"usag":[1,3,5],"usagerespons":4,"usd":4,"user":[0,1,4,6],"userdata":4,"util":[3,4],"v":[0,1],"valid":[0,1,6],"valu":[2,4,6],"variabl":[0,1,6],"vehicl":3,"verifi":[1,6],"version":6,"void":4,"wa":[2,4,6],"waitlist":2,"warehous":4,"wast":4,"web":4,"when":[0,4,6],"where":[0,4],"which":0,"within":[4,6],"without":[4,6],"work":1,"wrong":6,"x":[0,2,4],"yarn":2,"ye":1,"year":2,"york":4,"you":[0,2,6],"your":[0,1,2,3,4,6]},"titles":["Authentication","Client","Getting Started","IBM Envizi - Emissions API Node.js SDK","Reference","SDK","Troubleshooting Guide"],"titleterms":{"1":6,"2":6,"3":6,"4":6,"401":6,"5":6,"6":6,"7":6,"8":6,"Not":6,"api":[0,2,3,4,6],"applic":6,"architectur":0,"auth":6,"authent":[0,1,2,6],"automat":6,"basic":2,"best":[0,1],"call":2,"checklist":6,"client":[1,6],"common":6,"configur":[1,6],"content":3,"credenti":6,"custom":6,"diagram":0,"emiss":3,"empti":6,"envizi":3,"error":[1,6],"exampl":[2,4],"expiri":6,"field":6,"first":2,"flow":0,"gener":[0,2],"get":2,"getarea":4,"gettyp":4,"getunit":4,"guid":6,"handl":1,"header":0,"host":6,"http":6,"ibm":3,"id":6,"import":2,"initi":[1,6],"instal":2,"instanc":6,"integr":1,"interfac":4,"introduct":3,"invalid":6,"j":3,"kei":[0,2,6],"lifetim":0,"manag":6,"metadata":4,"method":0,"miss":6,"node":3,"option":1,"organ":6,"overview":[0,1,6],"paramet":6,"practic":[0,1],"pre":[0,2],"prerequisit":2,"recommend":[0,2,6],"refer":4,"refresh":[0,6],"requir":6,"respons":[1,2,6],"retriev":0,"scenario":6,"sdk":[3,5,6],"secur":0,"start":2,"startup":6,"step":6,"summari":6,"support":[3,6],"tabl":6,"token":[0,2,6],"troubleshoot":6,"type":3,"url":6,"us":2,"usag":4}})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emissions-api-sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "sdk for IBM Emissions APIs",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
@@ -34,8 +34,11 @@
   ],
   "author": "santhosh0703,Prakhar-sahu,taylorsteffanj",
   "license": "Apache-2.0",
+  "overrides": {
+    "markdown-it": "^14.1.1"
+  },
   "dependencies": {
-    "axios": "^1.12.2"
+    "axios": "^1.13.5"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",