emissions-api-sdk 1.0.1 → 1.0.3
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.
- package/README.md +9 -0
- package/dist/Constants.js +2 -1
- 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/api/Usage.js +26 -0
- package/dist/coverage/clover.xml +346 -0
- package/dist/coverage/coverage-final.json +20 -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 +214 -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/Usage.ts.html +160 -0
- package/dist/coverage/lcov-report/src/api/index.html +236 -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 +578 -0
- package/dist/index.js +2 -1
- 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/interfaces/response/UsageResponse.js +5 -0
- package/dist/types/Constants.d.ts +1 -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/api/Usage.d.ts +13 -0
- package/dist/types/index.d.ts +10 -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 +16 -0
- package/dist/types/interfaces/response/UsageResponse.d.ts +17 -0
- package/docs/_sources/index.rst.txt +1 -0
- package/docs/_sources/reference.rst.txt +6 -0
- package/docs/_sources/troubleshooting.rst.txt +486 -0
- package/docs/authentication.html +1 -0
- package/docs/client.html +1 -0
- package/docs/genindex.html +5 -0
- package/docs/getting_started.html +1 -0
- package/docs/index.html +15 -0
- package/docs/objects.inv +0 -0
- package/docs/reference.html +71 -35
- package/docs/sdk.html +1 -0
- package/docs/search.html +1 -0
- package/docs/searchindex.js +1 -1
- package/docs/troubleshooting.html +777 -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/reference.rst +6 -0
- package/sphinx-build/source/troubleshooting.rst +486 -0
- package/src/Constants.ts +2 -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/api/Usage.ts +26 -0
- package/src/index.ts +35 -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 +17 -0
- package/src/interfaces/response/UsageResponse.ts +23 -0
- package/test/apiTest.test.ts +35 -4
package/docs/reference.html
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head><meta charset="utf-8">
|
|
4
4
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
5
5
|
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
-
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="prev" title="Authentication" href="authentication.html">
|
|
6
|
+
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Troubleshooting Guide" href="troubleshooting.html"><link rel="prev" title="Authentication" href="authentication.html">
|
|
7
7
|
|
|
8
8
|
<!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25 -->
|
|
9
9
|
<title>Reference - IBM Envizi - Emissions API Node.js SDK documentation</title>
|
|
@@ -201,6 +201,7 @@
|
|
|
201
201
|
</ul>
|
|
202
202
|
</li>
|
|
203
203
|
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reference</a></li>
|
|
204
|
+
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
|
|
204
205
|
</ul>
|
|
205
206
|
|
|
206
207
|
</div>
|
|
@@ -495,7 +496,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
495
496
|
</ul>
|
|
496
497
|
</dd>
|
|
497
498
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
498
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
499
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<FactorResponse></span> – A promise that resolves to the FactorResponse returned by the API</p>
|
|
499
500
|
</dd>
|
|
500
501
|
</dl>
|
|
501
502
|
<div class="admonition-example admonition">
|
|
@@ -538,7 +539,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
538
539
|
</ul>
|
|
539
540
|
</dd>
|
|
540
541
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
541
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
542
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
542
543
|
</dd>
|
|
543
544
|
</dl>
|
|
544
545
|
<div class="admonition-example admonition">
|
|
@@ -574,7 +575,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
574
575
|
</ul>
|
|
575
576
|
</dd>
|
|
576
577
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
577
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
578
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
578
579
|
</dd>
|
|
579
580
|
</dl>
|
|
580
581
|
<div class="admonition-example admonition">
|
|
@@ -611,7 +612,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
611
612
|
</ul>
|
|
612
613
|
</dd>
|
|
613
614
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
614
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
615
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
615
616
|
</dd>
|
|
616
617
|
</dl>
|
|
617
618
|
<div class="admonition-example admonition">
|
|
@@ -648,7 +649,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
648
649
|
</ul>
|
|
649
650
|
</dd>
|
|
650
651
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
651
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
652
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
652
653
|
</dd>
|
|
653
654
|
</dl>
|
|
654
655
|
<div class="admonition-example admonition">
|
|
@@ -685,7 +686,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
685
686
|
</ul>
|
|
686
687
|
</dd>
|
|
687
688
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
688
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
689
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
689
690
|
</dd>
|
|
690
691
|
</dl>
|
|
691
692
|
<div class="admonition-example admonition">
|
|
@@ -714,7 +715,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
714
715
|
<dl class="js function">
|
|
715
716
|
<dt class="sig sig-object js" id="TransportationAndDistribution.calculate">
|
|
716
717
|
<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">TransportationAndDistribution</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="#TransportationAndDistribution.calculate" title="Link to this definition">¶</a></dt>
|
|
717
|
-
<dd><p>Performs Scope
|
|
718
|
+
<dd><p>Performs Scope 3 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.</p>
|
|
718
719
|
<dl class="field-list simple">
|
|
719
720
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
720
721
|
<dd class="field-odd"><ul class="simple">
|
|
@@ -722,7 +723,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
722
723
|
</ul>
|
|
723
724
|
</dd>
|
|
724
725
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
725
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
726
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
726
727
|
</dd>
|
|
727
728
|
</dl>
|
|
728
729
|
<div class="admonition-example admonition">
|
|
@@ -758,7 +759,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
758
759
|
<dd><p>Retrieves available emission factor types by making a GET request to the API endpoint.</p>
|
|
759
760
|
<dl class="field-list simple">
|
|
760
761
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
761
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
762
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available emission factor types</p>
|
|
762
763
|
</dd>
|
|
763
764
|
</dl>
|
|
764
765
|
<div class="admonition-example admonition">
|
|
@@ -775,7 +776,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
775
776
|
<dd><p>Retrieves available calculation types by making a GET request to the calculation types API endpoint.</p>
|
|
776
777
|
<dl class="field-list simple">
|
|
777
778
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
778
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
779
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available calculation types</p>
|
|
779
780
|
</dd>
|
|
780
781
|
</dl>
|
|
781
782
|
<div class="admonition-example admonition">
|
|
@@ -792,7 +793,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
792
793
|
<dd><p>Retrieves available location-based calculation types by making a GET request to the location types API endpoint.</p>
|
|
793
794
|
<dl class="field-list simple">
|
|
794
795
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
795
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
796
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available location-based calculation types</p>
|
|
796
797
|
</dd>
|
|
797
798
|
</dl>
|
|
798
799
|
<div class="admonition-example admonition">
|
|
@@ -809,15 +810,13 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
809
810
|
<dd><p>Retrieves available mobile emission calculation types by making a GET request to the API endpoint.</p>
|
|
810
811
|
<dl class="field-list simple">
|
|
811
812
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
812
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
813
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available mobile emission types</p>
|
|
813
814
|
</dd>
|
|
814
815
|
</dl>
|
|
815
816
|
<div class="admonition-example admonition">
|
|
816
817
|
<p class="admonition-title">Example</p>
|
|
817
818
|
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get all available mobile emission types</span>
|
|
818
819
|
<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>
|
|
819
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">typesData</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">types</span><span class="p">);</span>
|
|
820
|
-
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">"Available mobile emission types:"</span><span class="p">,</span><span class="w"> </span><span class="nx">typesData</span><span class="p">);</span>
|
|
821
820
|
</pre></div>
|
|
822
821
|
</div>
|
|
823
822
|
</div>
|
|
@@ -829,7 +828,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
829
828
|
<dd><p>Retrieves available stationary emission calculation types by making a GET request to the API endpoint.</p>
|
|
830
829
|
<dl class="field-list simple">
|
|
831
830
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
832
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
831
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available stationary emission types</p>
|
|
833
832
|
</dd>
|
|
834
833
|
</dl>
|
|
835
834
|
<div class="admonition-example admonition">
|
|
@@ -846,7 +845,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
846
845
|
<dd><p>Retrieves available transportation and distribution calculation types by making a GET request to the API endpoint.</p>
|
|
847
846
|
<dl class="field-list simple">
|
|
848
847
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
849
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
848
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available transportation and distribution calculation types</p>
|
|
850
849
|
</dd>
|
|
851
850
|
</dl>
|
|
852
851
|
<div class="admonition-example admonition">
|
|
@@ -863,7 +862,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
863
862
|
<dd><p>Retrieves available fugitive emission calculation types by making a GET request to the API endpoint.</p>
|
|
864
863
|
<dl class="field-list simple">
|
|
865
864
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
866
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
865
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available fugitive emission types</p>
|
|
867
866
|
</dd>
|
|
868
867
|
</dl>
|
|
869
868
|
<div class="admonition-example admonition">
|
|
@@ -883,7 +882,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
883
882
|
<dd><p>Retrieves information about geographical areas supported by the factor API.</p>
|
|
884
883
|
<dl class="field-list simple">
|
|
885
884
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
886
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
885
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
887
886
|
</dd>
|
|
888
887
|
</dl>
|
|
889
888
|
<div class="admonition-example admonition">
|
|
@@ -900,12 +899,12 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
900
899
|
<dd><p>Retrieves information about geographical areas supported by the factor search API.</p>
|
|
901
900
|
<dl class="field-list simple">
|
|
902
901
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
903
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
902
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
904
903
|
</dd>
|
|
905
904
|
</dl>
|
|
906
905
|
<div class="admonition-example admonition">
|
|
907
906
|
<p class="admonition-title">Example</p>
|
|
908
|
-
<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">
|
|
907
|
+
<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">getSearchArea</span><span class="p">();</span>
|
|
909
908
|
</pre></div>
|
|
910
909
|
</div>
|
|
911
910
|
</div>
|
|
@@ -917,7 +916,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
917
916
|
<dd><p>Retrieves information about geographical areas supported by the calculation API.</p>
|
|
918
917
|
<dl class="field-list simple">
|
|
919
918
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
920
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
919
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
921
920
|
</dd>
|
|
922
921
|
</dl>
|
|
923
922
|
<div class="admonition-example admonition">
|
|
@@ -934,7 +933,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
934
933
|
<dd><p>Retrieves information about geographical areas supported by the location-based calculation API.</p>
|
|
935
934
|
<dl class="field-list simple">
|
|
936
935
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
937
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
936
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
938
937
|
</dd>
|
|
939
938
|
</dl>
|
|
940
939
|
<div class="admonition-example admonition">
|
|
@@ -951,7 +950,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
951
950
|
<dd><p>Retrieves information about geographical areas supported by the mobile emissions API.</p>
|
|
952
951
|
<dl class="field-list simple">
|
|
953
952
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
954
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
953
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
955
954
|
</dd>
|
|
956
955
|
</dl>
|
|
957
956
|
<div class="admonition-example admonition">
|
|
@@ -968,7 +967,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
968
967
|
<dd><p>Retrieves information about geographical areas supported by the stationary emissions API.</p>
|
|
969
968
|
<dl class="field-list simple">
|
|
970
969
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
971
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
970
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
972
971
|
</dd>
|
|
973
972
|
</dl>
|
|
974
973
|
<div class="admonition-example admonition">
|
|
@@ -985,7 +984,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
985
984
|
<dd><p>Retrieves information about geographical areas supported by the transportation and distribution API.</p>
|
|
986
985
|
<dl class="field-list simple">
|
|
987
986
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
988
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
987
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
989
988
|
</dd>
|
|
990
989
|
</dl>
|
|
991
990
|
<div class="admonition-example admonition">
|
|
@@ -1002,7 +1001,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1002
1001
|
<dd><p>Retrieves information about geographical areas supported by the fugitive emissions API.</p>
|
|
1003
1002
|
<dl class="field-list simple">
|
|
1004
1003
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1005
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<
|
|
1004
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
1006
1005
|
</dd>
|
|
1007
1006
|
</dl>
|
|
1008
1007
|
<div class="admonition-example admonition">
|
|
@@ -1027,7 +1026,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1027
1026
|
</ul>
|
|
1028
1027
|
</dd>
|
|
1029
1028
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1030
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
1029
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1031
1030
|
</dd>
|
|
1032
1031
|
</dl>
|
|
1033
1032
|
<div class="admonition-example admonition">
|
|
@@ -1053,7 +1052,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1053
1052
|
</ul>
|
|
1054
1053
|
</dd>
|
|
1055
1054
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1056
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
1055
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1057
1056
|
</dd>
|
|
1058
1057
|
</dl>
|
|
1059
1058
|
<div class="admonition-example admonition">
|
|
@@ -1079,7 +1078,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1079
1078
|
</ul>
|
|
1080
1079
|
</dd>
|
|
1081
1080
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1082
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
1081
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1083
1082
|
</dd>
|
|
1084
1083
|
</dl>
|
|
1085
1084
|
<div class="admonition-example admonition">
|
|
@@ -1102,7 +1101,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1102
1101
|
</ul>
|
|
1103
1102
|
</dd>
|
|
1104
1103
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1105
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
1104
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1106
1105
|
</dd>
|
|
1107
1106
|
</dl>
|
|
1108
1107
|
<div class="admonition-example admonition">
|
|
@@ -1128,7 +1127,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1128
1127
|
</ul>
|
|
1129
1128
|
</dd>
|
|
1130
1129
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1131
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
1130
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1132
1131
|
</dd>
|
|
1133
1132
|
</dl>
|
|
1134
1133
|
<div class="admonition-example admonition">
|
|
@@ -1154,7 +1153,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1154
1153
|
</ul>
|
|
1155
1154
|
</dd>
|
|
1156
1155
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1157
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
1156
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1158
1157
|
</dd>
|
|
1159
1158
|
</dl>
|
|
1160
1159
|
<div class="admonition-example admonition">
|
|
@@ -1180,7 +1179,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1180
1179
|
</ul>
|
|
1181
1180
|
</dd>
|
|
1182
1181
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1183
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
1182
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1184
1183
|
</dd>
|
|
1185
1184
|
</dl>
|
|
1186
1185
|
<div class="admonition-example admonition">
|
|
@@ -1196,6 +1195,31 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1196
1195
|
</dd></dl>
|
|
1197
1196
|
|
|
1198
1197
|
</section>
|
|
1198
|
+
</section>
|
|
1199
|
+
<section id="usage-api">
|
|
1200
|
+
<h2>Usage API<a class="headerlink" href="#usage-api" title="Link to this heading">¶</a></h2>
|
|
1201
|
+
<dl class="js function">
|
|
1202
|
+
<dt class="sig sig-object js" id="Usage.getUsage">
|
|
1203
|
+
<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">Usage</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getUsage</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">history=false</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Usage.getUsage" title="Link to this definition">¶</a></dt>
|
|
1204
|
+
<dd><p>Retrieves current billing period or historical usage data for the user by making a GET request to the API endpoint.</p>
|
|
1205
|
+
<dl class="field-list simple">
|
|
1206
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1207
|
+
<dd class="field-odd"><ul class="simple">
|
|
1208
|
+
<li><p><strong>history</strong> (<span class="sphinx_js-type">boolean</span>) – Flag to retrieve current billing or historical usage data.</p></li>
|
|
1209
|
+
</ul>
|
|
1210
|
+
</dd>
|
|
1211
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1212
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UsageResponse></span> – A promise that resolves to a UsageResponse containing the organization’s usage data</p>
|
|
1213
|
+
</dd>
|
|
1214
|
+
</dl>
|
|
1215
|
+
<div class="admonition-example admonition">
|
|
1216
|
+
<p class="admonition-title">Example</p>
|
|
1217
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">usage</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">getUsage</span><span class="p">();</span>
|
|
1218
|
+
</pre></div>
|
|
1219
|
+
</div>
|
|
1220
|
+
</div>
|
|
1221
|
+
</dd></dl>
|
|
1222
|
+
|
|
1199
1223
|
</section>
|
|
1200
1224
|
<section id="interfaces">
|
|
1201
1225
|
<h2>Interfaces<a class="headerlink" href="#interfaces" title="Link to this heading">¶</a></h2>
|
|
@@ -1426,7 +1450,15 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1426
1450
|
<footer>
|
|
1427
1451
|
|
|
1428
1452
|
<div class="related-pages">
|
|
1429
|
-
|
|
1453
|
+
<a class="next-page" href="troubleshooting.html">
|
|
1454
|
+
<div class="page-info">
|
|
1455
|
+
<div class="context">
|
|
1456
|
+
<span>Next</span>
|
|
1457
|
+
</div>
|
|
1458
|
+
<div class="title">Troubleshooting Guide</div>
|
|
1459
|
+
</div>
|
|
1460
|
+
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
|
1461
|
+
</a>
|
|
1430
1462
|
<a class="prev-page" href="authentication.html">
|
|
1431
1463
|
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
|
1432
1464
|
<div class="page-info">
|
|
@@ -1525,6 +1557,10 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1525
1557
|
</li>
|
|
1526
1558
|
</ul>
|
|
1527
1559
|
</li>
|
|
1560
|
+
<li><a class="reference internal" href="#usage-api">Usage API</a><ul>
|
|
1561
|
+
<li><a class="reference internal" href="#Usage.getUsage"><code class="docutils literal notranslate"><span class="pre">Usage.getUsage()</span></code></a></li>
|
|
1562
|
+
</ul>
|
|
1563
|
+
</li>
|
|
1528
1564
|
<li><a class="reference internal" href="#interfaces">Interfaces</a><ul>
|
|
1529
1565
|
<li><a class="reference internal" href="#Api.LocationRequestWithoutFactorId"><code class="docutils literal notranslate"><span class="pre">Api.LocationRequestWithoutFactorId</span></code></a></li>
|
|
1530
1566
|
<li><a class="reference internal" href="#Api.LocationRequestWithFactorId"><code class="docutils literal notranslate"><span class="pre">Api.LocationRequestWithFactorId</span></code></a></li>
|
package/docs/sdk.html
CHANGED
|
@@ -201,6 +201,7 @@
|
|
|
201
201
|
</ul>
|
|
202
202
|
</li>
|
|
203
203
|
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
|
|
204
|
+
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
|
|
204
205
|
</ul>
|
|
205
206
|
|
|
206
207
|
</div>
|
package/docs/search.html
CHANGED
|
@@ -201,6 +201,7 @@
|
|
|
201
201
|
</ul>
|
|
202
202
|
</li>
|
|
203
203
|
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
|
|
204
|
+
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
|
|
204
205
|
</ul>
|
|
205
206
|
|
|
206
207
|
</div>
|
package/docs/searchindex.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Search.setIndex({"alltitles":{"API":[[4,"api"]],"API Key Authentication (Recommended)":[[0,"api-key-authentication-recommended"]],"Architecture Diagram":[[0,"architecture-diagram"]],"Authentication":[[0,null],[2,"authentication"]],"Authentication Flow":[[0,"authentication-flow"]],"Authentication Headers":[[0,"authentication-headers"]],"Authentication Integration":[[1,"authentication-integration"]],"Authentication Methods":[[0,"authentication-methods"]],"Basic Import":[[2,"basic-import"]],"Best Practices":[[1,"best-practices"]],"Client":[[1,null]],"Client Initialization":[[1,"client-initialization"]],"Client Responsibilities":[[1,"client-responsibilities"]],"Configuration Options":[[1,"configuration-options"]],"Contents:":[[3,null]],"Error Handling":[[1,"error-handling"]],"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]],"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]],"Installation":[[2,"installation"]],"Interfaces":[[4,"interfaces"]],"Introduction":[[3,"introduction"]],"Metadata APIs":[[4,"metadata-apis"]],"Overview":[[0,"overview"],[1,"overview"]],"Pre-generated Token Authentication":[[0,"pre-generated-token-authentication"]],"Prerequisites":[[2,"prerequisites"]],"Reference":[[4,null]],"SDK":[[5,null]],"Security Best Practices":[[0,"security-best-practices"]],"Supported Emission Types":[[3,"supported-emission-types"]],"Token lifetime & refresh":[[0,"token-lifetime-refresh"]],"Token retrieval":[[0,"token-retrieval"]],"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"],"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"],"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]],"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"]],"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],"0":[0,2,4],"00033022":2,"00036061":2,"01":4,"01115131":2,"02ae":2,"04":4,"1":[2,4],"1000":4,"121":4,"1223123":4,"123":4,"12345":4,"14123143":4,"150":4,"1500000":4,"2":[0,4],"2022":[2,4],"2025":4,"20681091":2,"20750174":2,"263fb":4,"3":4,"426a":4,"47a3":2,"60":4,"831bfca7cecd":2,"95a7efe7":2,"9999":4,"A":[0,4],"For":[0,1],"If":[0,2],"In":0,"It":1,"No":1,"OR":[1,4],"Or":2,"The":[0,1,2,3,4,5],"Then":4,"a7fd":2,"aaa":4,"about":[0,1,4],"accept":[0,1,2],"access":[0,1,4],"across":1,"activ":[2,3,4],"activitywithfactorid":4,"add":[0,1],"after":2,"all":[1,4],"alreadi":[2,4],"an":[2,4],"ani":4,"api":[1,5],"apidomain":4,"apikei":[0,1,2,4],"applic":[0,1,2,3,4],"approach":[0,5],"appropri":[1,4],"ar":2,"architectur":5,"area":[2,4],"argument":4,"async":[2,4],"auth":4,"authent":[3,4,5],"author":[0,4],"authurl":[0,1,4],"autom":3,"automat":[0,1],"avail":[2,4],"await":[0,1,2,4],"axio":0,"b20":4,"base":[2,4],"bearer":[0,4],"befor":[0,1,2,4],"best":5,"boolean":4,"build":3,"bulk":4,"busi":4,"cach":0,"calcul":[2,3,4],"calculateemiss":2,"calculationrequest":4,"california":2,"call":[0,3],"can":[2,4],"car":4,"carbon":3,"cargo":4,"carrier":4,"catch":[1,2],"central":1,"ch4":2,"chain":3,"check":0,"class":4,"client":[0,2,3,4,5],"client123":4,"clientconfig":4,"clientid":[0,1,2,4],"climat":2,"close":1,"co2":2,"coal":4,"code":0,"com":[0,2,4],"combinedunitsact":4,"combinedunitsactivitywithfactorid":4,"combust":4,"common":4,"commonrequest":4,"commonrequestwithfactorid":4,"commonrequestwithoutfactorid":4,"complet":4,"complex":4,"compon":[1,5],"config":4,"configur":[4,5],"connect":[1,2],"consist":1,"consol":[1,2,4],"const":[2,4],"consumpt":3,"contain":4,"content":4,"control":0,"convert":4,"countri":[2,4],"cover":5,"credenti":[0,1,2],"criteria":4,"custom":[1,3,4],"dashboard":3,"data":[1,4],"databas":3,"dataset":3,"date":4,"decis":3,"decod":0,"default":[0,1,4],"deploy":0,"descript":[1,2],"design":[1,3],"detail":[0,1,4],"detect":0,"determin":4,"diagram":5,"diesel":4,"directli":2,"distribut":[3,4],"doesn":4,"domain":[0,4],"dwt":4,"e":[2,4],"each":0,"egrid":2,"either":1,"electr":[2,4],"email":4,"embed":3,"emiss":[0,1,2,4,5],"endpoint":[0,1,2,4],"energi":4,"engin":3,"ensur":[1,2,4],"entir":2,"env":[0,1],"environ":[0,1],"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,5],"exact":4,"exampl":3,"excel":0,"exist":[1,4],"exp":0,"expect":4,"expir":[0,1,4],"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,"fail":2,"failur":1,"fals":4,"fetch":1,"find":4,"findexpirytim":[3,4],"first":[3,4],"fix":3,"flow":5,"follow":[0,1,2],"footprint":3,"format":[0,2],"freight":4,"fresh":[0,4],"from":[0,1,2,3,4],"fuel":[3,4],"fugit":[3,4],"fugitv":4,"function":2,"futur":0,"g":4,"ga":[3,4],"gener":[1,3,4],"genericcalculationrequestwithfactorid":4,"genericcalculationrequestwithoutfactorid":4,"geograph":4,"get":[0,3,4],"getauthhead":4,"getclient":[0,1,2,4],"getclientid":4,"getclientsourc":4,"getdomain":4,"getinst":4,"getsearcharea":4,"ghg":3,"ghgemiss":0,"give":4,"gracefulli":1,"greas":4,"greenhous":3,"handl":[0,5],"hardcod":0,"have":[2,4],"header":[1,2,4,5],"here":2,"hfc":4,"host":[0,1,4],"http":[0,1,2,4],"hybrid":4,"i":[0,1,3,4],"ibm":[0,1,2,5],"ibmid":2,"id":[0,1,2,4],"identifi":[0,4],"implement":[0,1],"import":[0,1],"includ":[0,4],"includedetail":4,"indirectco2":2,"inform":[0,1,4],"init":0,"initi":[0,2,4,5],"instal":3,"instanc":[1,4],"instead":4,"integr":5,"interact":5,"interfac":[1,3],"internet":2,"involv":4,"isuserprovidedtoken":4,"j":[0,1,2,5],"jet":4,"json":[0,2,4],"jwt":[0,4],"jwt_token":0,"jwttoken":4,"kei":[1,4,5],"kerosen":4,"kg":4,"kgco2e":2,"kj":4,"km":4,"known":4,"kwh":[2,4],"l":4,"larg":[3,4],"layer":0,"leader":2,"leak":3,"least":0,"let":1,"lignit":4,"locat":[2,3,4],"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],"manag":[0,1,2,3],"measur":4,"messag":1,"metadata":3,"method":[1,2,4,5],"metric":4,"mobil":[3,4],"mode":0,"modul":[1,2],"more":0,"multipl":4,"n2o":2,"name":4,"natur":4,"nc":4,"ne":4,"necessari":0,"need":[0,4],"never":0,"new":[0,4],"node":[0,1,2,5],"npm":2,"oauth":0,"object":4,"obtain":[1,2],"occur":0,"old":0,"onc":[0,1],"one":[0,1],"onli":[0,1,4],"oper":[1,3,4],"optim":1,"option":[0,4,5],"org":2,"org456":4,"organ":[0,1],"orgid":[0,1,2,4],"other":4,"overview":[2,5],"page":[0,1,2],"pagin":4,"param":[0,4],"paramet":[0,1,4],"pars":4,"pattern":5,"payload":4,"perform":4,"petroleum":4,"point":4,"post":4,"practic":5,"pre":1,"prerequisit":3,"preview":2,"principl":0,"privileg":0,"proce":4,"process":[0,1],"product":[0,1],"project":[2,3],"promis":4,"proper":[0,1],"provid":[0,1,2,4,5],"purchas":4,"purpos":4,"queri":[0,4],"r":4,"r134a":4,"re":0,"record":4,"refer":3,"refresh":[1,4],"refreshtoken":4,"region":[2,3],"relat":4,"relev":4,"replac":0,"repres":4,"request":[0,1,3,4],"requestconfig":4,"requir":[0,1,2],"resolv":4,"respons":[0,3,4,5],"result":[2,4],"retriev":[2,4],"retrievefactor":4,"return":[0,2,4],"reus":1,"run":[0,2],"saascor":[0,2],"scale":3,"scenario":0,"scope":4,"sdk":[0,1,2,4],"search":4,"searchact":4,"searchrequest":4,"second":4,"section":5,"secur":[1,5],"see":[0,1],"send":0,"sent":4,"servic":[0,1],"set":2,"sever":1,"ship":4,"sign":2,"singl":4,"singleton":[0,1,4],"size":4,"small":4,"sourc":[0,3,4],"specif":[1,3,4],"specifi":4,"standard":4,"start":3,"startup":1,"state":2,"stateprovinc":[2,4],"static":4,"stationari":[3,4],"statu":1,"steel":4,"step":0,"store":[0,1],"string":[0,4],"structur":5,"subtyp":4,"successfulli":2,"suppli":3,"support":[1,4],"sustain":3,"t":4,"tenantid":2,"thi":[0,2,4,5],"time":[0,4],"timestamp":4,"toisostr":4,"token":[1,4],"totalco2":2,"track":3,"transactionid":2,"transport":[3,4],"transportationanddistribut":4,"travel":4,"trim":0,"true":4,"try":[1,2],"two":[0,2],"type":[2,4],"typesdata":4,"u":2,"unifi":1,"unit":[2,4],"unix":4,"unless":1,"up":[2,4],"url":[0,4],"us":[0,1,3,4],"usa":[2,4],"usag":[1,5],"user":[0,1,4],"userdata":4,"util":[3,4],"v":[0,1],"valid":[0,1],"valu":[2,4],"variabl":[0,1],"vehicl":3,"verifi":1,"void":4,"wa":[2,4],"waitlist":2,"wast":4,"web":4,"when":[0,4],"where":[0,4],"which":0,"within":4,"without":4,"work":1,"x":[0,2,4],"yarn":2,"ye":1,"year":2,"york":4,"you":[0,2],"your":[0,1,2,3,4]},"titles":["Authentication","Client","Getting Started","IBM Envizi - Emissions API Node.js SDK","Reference","SDK"],"titleterms":{"api":[0,2,3,4],"architectur":0,"authent":[0,1,2],"basic":2,"best":[0,1],"call":2,"client":1,"configur":1,"content":3,"diagram":0,"emiss":3,"envizi":3,"error":1,"exampl":[2,4],"first":2,"flow":0,"gener":[0,2],"get":2,"getarea":4,"gettyp":4,"getunit":4,"handl":1,"header":0,"ibm":3,"import":2,"initi":1,"instal":2,"integr":1,"interfac":4,"introduct":3,"j":3,"kei":[0,2],"lifetim":0,"metadata":4,"method":0,"node":3,"option":1,"overview":[0,1],"practic":[0,1],"pre":[0,2],"prerequisit":2,"recommend":[0,2],"refer":4,"refresh":0,"respons":[1,2],"retriev":0,"sdk":[3,5],"secur":0,"start":2,"support":3,"token":[0,2],"type":3,"us":2}})
|
|
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}})
|