emissions-api-sdk 1.0.5 → 1.0.7
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/.secrets.baseline +314 -0
- package/README.md +20 -27
- package/dist/Constants.js +5 -29
- package/dist/api/Calculation.js +0 -63
- package/dist/api/EconomicActivity.js +0 -60
- package/dist/api/Factor.js +0 -82
- package/dist/api/Fugitive.js +0 -63
- package/dist/api/Location.js +0 -61
- package/dist/api/Metadata.js +155 -0
- package/dist/api/Mobile.js +0 -64
- package/dist/api/RealEstate.js +0 -61
- package/dist/api/Stationary.js +0 -63
- package/dist/api/TransportationAndDistribution.js +0 -63
- package/dist/api/TypeRecommender.js +62 -0
- package/dist/coverage/clover.xml +142 -238
- package/dist/coverage/coverage-final.json +15 -13
- package/dist/coverage/lcov-report/index.html +20 -20
- package/dist/coverage/lcov-report/src/Client.ts.html +28 -28
- package/dist/coverage/lcov-report/src/Constants.ts.html +31 -106
- package/dist/coverage/lcov-report/src/api/Calculation.ts.html +7 -217
- package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +7 -214
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +6 -285
- package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +7 -223
- package/dist/coverage/lcov-report/src/api/Location.ts.html +6 -222
- package/dist/coverage/lcov-report/src/api/Metadata.ts.html +604 -0
- package/dist/coverage/lcov-report/src/api/Mobile.ts.html +6 -231
- package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +6 -219
- package/dist/coverage/lcov-report/src/api/Stationary.ts.html +6 -225
- package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +7 -223
- package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +277 -0
- package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/index.html +63 -33
- package/dist/coverage/lcov-report/src/index.html +7 -7
- package/dist/coverage/lcov-report/src/request.ts.html +5 -5
- package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
- package/dist/coverage/lcov-report/test/index.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
- package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
- package/dist/coverage/lcov.info +239 -353
- package/dist/index.js +3 -1
- package/dist/interfaces/response/TypeRecommenderResponse.js +2 -0
- package/dist/types/Constants.d.ts +4 -28
- package/dist/types/api/Calculation.d.ts +0 -41
- package/dist/types/api/EconomicActivity.d.ts +0 -38
- package/dist/types/api/Factor.d.ts +0 -52
- package/dist/types/api/Fugitive.d.ts +0 -41
- package/dist/types/api/Location.d.ts +0 -39
- package/dist/types/api/Metadata.d.ts +99 -0
- package/dist/types/api/Mobile.d.ts +0 -42
- package/dist/types/api/RealEstate.d.ts +0 -39
- package/dist/types/api/Stationary.d.ts +0 -41
- package/dist/types/api/TransportationAndDistribution.d.ts +0 -41
- package/dist/types/api/TypeRecommender.d.ts +50 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +14 -0
- package/docs/_sources/reference.rst.txt +14 -50
- package/docs/_static/basic.css +8 -0
- package/docs/_static/pygments.css +146 -164
- package/docs/_static/searchtools.js +5 -8
- package/docs/_static/styles/furo.css +1 -1
- package/docs/_static/styles/furo.css.map +1 -1
- package/docs/authentication.html +28 -19
- package/docs/client.html +28 -19
- package/docs/genindex.html +41 -84
- package/docs/getting_started.html +28 -19
- package/docs/index.html +29 -20
- package/docs/objects.inv +0 -0
- package/docs/reference.html +102 -502
- package/docs/sdk.html +28 -19
- package/docs/search.html +28 -19
- package/docs/searchindex.js +1 -1
- package/docs/troubleshooting.html +28 -19
- package/package.json +10 -7
- package/sphinx-build/requirements.txt +1 -0
- package/sphinx-build/source/reference.rst +14 -50
- package/src/Constants.ts +5 -30
- package/src/api/Calculation.ts +1 -72
- package/src/api/EconomicActivity.ts +1 -71
- package/src/api/Factor.ts +1 -94
- package/src/api/Fugitive.ts +1 -74
- package/src/api/Location.ts +1 -73
- package/src/api/Metadata.ts +174 -0
- package/src/api/Mobile.ts +1 -76
- package/src/api/RealEstate.ts +1 -72
- package/src/api/Stationary.ts +1 -74
- package/src/api/TransportationAndDistribution.ts +1 -74
- package/src/api/TypeRecommender.ts +65 -0
- package/src/index.ts +4 -1
- package/src/interfaces/response/TypeRecommenderResponse.ts +18 -0
- package/test/apiTest.test.ts +9 -205
- package/test/metadata.test.ts +224 -0
- package/test/request.test.ts +0 -1
- package/sphinx-build/.secrets.baseline +0 -150
package/docs/reference.html
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
<!doctype html>
|
|
2
2
|
<html class="no-js" lang="en" data-content_root="./">
|
|
3
|
-
<head><meta charset="utf-8"
|
|
4
|
-
<meta name="viewport" content="width=device-width,initial-scale=1"
|
|
3
|
+
<head><meta charset="utf-8"/>
|
|
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"
|
|
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
|
-
<!-- Generated with Sphinx 8.
|
|
8
|
+
<!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 -->
|
|
9
9
|
<title>Reference - IBM Envizi - Emissions API Node.js SDK documentation</title>
|
|
10
10
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
|
|
11
|
-
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=
|
|
11
|
+
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=25af2a20" />
|
|
12
12
|
<link rel="stylesheet" type="text/css" href="_static/sphinx_js.css" />
|
|
13
13
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
|
|
14
14
|
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=8d04aa46" />
|
|
@@ -24,14 +24,14 @@
|
|
|
24
24
|
}
|
|
25
25
|
@media not print {
|
|
26
26
|
body[data-theme="dark"] {
|
|
27
|
-
--color-code-background: #
|
|
28
|
-
--color-code-foreground: #
|
|
27
|
+
--color-code-background: #2b2b2b;
|
|
28
|
+
--color-code-foreground: #f8f8f2;
|
|
29
29
|
|
|
30
30
|
}
|
|
31
31
|
@media (prefers-color-scheme: dark) {
|
|
32
32
|
body:not([data-theme="light"]) {
|
|
33
|
-
--color-code-background: #
|
|
34
|
-
--color-code-foreground: #
|
|
33
|
+
--color-code-background: #2b2b2b;
|
|
34
|
+
--color-code-foreground: #f8f8f2;
|
|
35
35
|
|
|
36
36
|
}
|
|
37
37
|
}
|
|
@@ -146,10 +146,14 @@
|
|
|
146
146
|
</symbol>
|
|
147
147
|
</svg>
|
|
148
148
|
|
|
149
|
-
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"
|
|
150
|
-
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"
|
|
151
|
-
<label class="overlay sidebar-overlay" for="__navigation"
|
|
152
|
-
<
|
|
149
|
+
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
150
|
+
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
151
|
+
<label class="overlay sidebar-overlay" for="__navigation">
|
|
152
|
+
<div class="visually-hidden">Hide navigation sidebar</div>
|
|
153
|
+
</label>
|
|
154
|
+
<label class="overlay toc-overlay" for="__toc">
|
|
155
|
+
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
156
|
+
</label>
|
|
153
157
|
|
|
154
158
|
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
|
155
159
|
|
|
@@ -159,7 +163,8 @@
|
|
|
159
163
|
<header class="mobile-header">
|
|
160
164
|
<div class="header-left">
|
|
161
165
|
<label class="nav-overlay-icon" for="__navigation">
|
|
162
|
-
<
|
|
166
|
+
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
167
|
+
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
163
168
|
</label>
|
|
164
169
|
</div>
|
|
165
170
|
<div class="header-center">
|
|
@@ -167,7 +172,8 @@
|
|
|
167
172
|
</div>
|
|
168
173
|
<div class="header-right">
|
|
169
174
|
<div class="theme-toggle-container theme-toggle-header">
|
|
170
|
-
<button class="theme-toggle"
|
|
175
|
+
<button class="theme-toggle">
|
|
176
|
+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
171
177
|
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
172
178
|
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
173
179
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
@@ -175,7 +181,8 @@
|
|
|
175
181
|
</button>
|
|
176
182
|
</div>
|
|
177
183
|
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
178
|
-
<
|
|
184
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
185
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
179
186
|
</label>
|
|
180
187
|
</div>
|
|
181
188
|
</header>
|
|
@@ -195,7 +202,7 @@
|
|
|
195
202
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
196
203
|
<ul class="current">
|
|
197
204
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
|
198
|
-
<li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input
|
|
205
|
+
<li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of SDK</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
|
199
206
|
<li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
|
|
200
207
|
<li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
|
|
201
208
|
</ul>
|
|
@@ -228,7 +235,8 @@
|
|
|
228
235
|
</a>
|
|
229
236
|
</div>
|
|
230
237
|
<div class="theme-toggle-container theme-toggle-content">
|
|
231
|
-
<button class="theme-toggle"
|
|
238
|
+
<button class="theme-toggle">
|
|
239
|
+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
232
240
|
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
233
241
|
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
234
242
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
@@ -236,7 +244,8 @@
|
|
|
236
244
|
</button>
|
|
237
245
|
</div>
|
|
238
246
|
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
239
|
-
<
|
|
247
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
248
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
240
249
|
</label>
|
|
241
250
|
</div>
|
|
242
251
|
<article role="main" id="furo-main-content">
|
|
@@ -821,501 +830,134 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
821
830
|
</dd></dl>
|
|
822
831
|
|
|
823
832
|
</section>
|
|
824
|
-
<section id="metadata-
|
|
825
|
-
<h2>Metadata
|
|
826
|
-
<
|
|
827
|
-
<
|
|
828
|
-
<
|
|
829
|
-
<
|
|
830
|
-
<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">Factor</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="#Factor.getTypes" title="Link to this definition">¶</a></dt>
|
|
831
|
-
<dd><p>Retrieves available emission factor types by making a GET request to the API endpoint.</p>
|
|
832
|
-
<dl class="field-list simple">
|
|
833
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
834
|
-
<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>
|
|
835
|
-
</dd>
|
|
836
|
-
</dl>
|
|
837
|
-
<div class="admonition-example admonition">
|
|
838
|
-
<p class="admonition-title">Example</p>
|
|
839
|
-
<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>
|
|
840
|
-
</pre></div>
|
|
841
|
-
</div>
|
|
842
|
-
</div>
|
|
843
|
-
</dd></dl>
|
|
844
|
-
|
|
845
|
-
<dl class="js function">
|
|
846
|
-
<dt class="sig sig-object js" id="Calculation.getTypes">
|
|
847
|
-
<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">Calculation</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="#Calculation.getTypes" title="Link to this definition">¶</a></dt>
|
|
848
|
-
<dd><p>Retrieves available calculation types by making a GET request to the calculation types API endpoint.</p>
|
|
849
|
-
<dl class="field-list simple">
|
|
850
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
851
|
-
<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>
|
|
852
|
-
</dd>
|
|
853
|
-
</dl>
|
|
854
|
-
<div class="admonition-example admonition">
|
|
855
|
-
<p class="admonition-title">Example</p>
|
|
856
|
-
<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>
|
|
857
|
-
</pre></div>
|
|
858
|
-
</div>
|
|
859
|
-
</div>
|
|
860
|
-
</dd></dl>
|
|
861
|
-
|
|
862
|
-
<dl class="js function">
|
|
863
|
-
<dt class="sig sig-object js" id="Location.getTypes">
|
|
864
|
-
<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">Location</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="#Location.getTypes" title="Link to this definition">¶</a></dt>
|
|
865
|
-
<dd><p>Retrieves available location-based calculation types by making a GET request to the location types API endpoint.</p>
|
|
866
|
-
<dl class="field-list simple">
|
|
867
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
868
|
-
<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>
|
|
869
|
-
</dd>
|
|
870
|
-
</dl>
|
|
871
|
-
<div class="admonition-example admonition">
|
|
872
|
-
<p class="admonition-title">Example</p>
|
|
873
|
-
<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>
|
|
874
|
-
</pre></div>
|
|
875
|
-
</div>
|
|
876
|
-
</div>
|
|
877
|
-
</dd></dl>
|
|
878
|
-
|
|
879
|
-
<dl class="js function">
|
|
880
|
-
<dt class="sig sig-object js" id="Mobile.getTypes">
|
|
881
|
-
<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">Mobile</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="#Mobile.getTypes" title="Link to this definition">¶</a></dt>
|
|
882
|
-
<dd><p>Retrieves available mobile emission calculation types by making a GET request to the API endpoint.</p>
|
|
883
|
-
<dl class="field-list simple">
|
|
884
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
885
|
-
<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>
|
|
886
|
-
</dd>
|
|
887
|
-
</dl>
|
|
888
|
-
<div class="admonition-example admonition">
|
|
889
|
-
<p class="admonition-title">Example</p>
|
|
890
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get all available mobile emission types</span>
|
|
891
|
-
<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>
|
|
892
|
-
</pre></div>
|
|
893
|
-
</div>
|
|
894
|
-
</div>
|
|
895
|
-
</dd></dl>
|
|
896
|
-
|
|
897
|
-
<dl class="js function">
|
|
898
|
-
<dt class="sig sig-object js" id="Stationary.getTypes">
|
|
899
|
-
<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">Stationary</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="#Stationary.getTypes" title="Link to this definition">¶</a></dt>
|
|
900
|
-
<dd><p>Retrieves available stationary emission calculation types by making a GET request to the API endpoint.</p>
|
|
901
|
-
<dl class="field-list simple">
|
|
902
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
903
|
-
<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>
|
|
904
|
-
</dd>
|
|
905
|
-
</dl>
|
|
906
|
-
<div class="admonition-example admonition">
|
|
907
|
-
<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">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>
|
|
909
|
-
</pre></div>
|
|
910
|
-
</div>
|
|
911
|
-
</div>
|
|
912
|
-
</dd></dl>
|
|
913
|
-
|
|
914
|
-
<dl class="js function">
|
|
915
|
-
<dt class="sig sig-object js" id="TransportationAndDistribution.getTypes">
|
|
916
|
-
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#TransportationAndDistribution.getTypes" title="Link to this definition">¶</a></dt>
|
|
917
|
-
<dd><p>Retrieves available transportation and distribution calculation types by making a GET request to the API endpoint.</p>
|
|
918
|
-
<dl class="field-list simple">
|
|
919
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
920
|
-
<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>
|
|
921
|
-
</dd>
|
|
922
|
-
</dl>
|
|
923
|
-
<div class="admonition-example admonition">
|
|
924
|
-
<p class="admonition-title">Example</p>
|
|
925
|
-
<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>
|
|
926
|
-
</pre></div>
|
|
927
|
-
</div>
|
|
928
|
-
</div>
|
|
929
|
-
</dd></dl>
|
|
930
|
-
|
|
931
|
-
<dl class="js function">
|
|
932
|
-
<dt class="sig sig-object js" id="Fugitive.getTypes">
|
|
933
|
-
<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">Fugitive</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="#Fugitive.getTypes" title="Link to this definition">¶</a></dt>
|
|
934
|
-
<dd><p>Retrieves available fugitive emission calculation types by making a GET request to the API endpoint.</p>
|
|
935
|
-
<dl class="field-list simple">
|
|
936
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
937
|
-
<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>
|
|
938
|
-
</dd>
|
|
939
|
-
</dl>
|
|
940
|
-
<div class="admonition-example admonition">
|
|
941
|
-
<p class="admonition-title">Example</p>
|
|
942
|
-
<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>
|
|
943
|
-
</pre></div>
|
|
944
|
-
</div>
|
|
945
|
-
</div>
|
|
946
|
-
</dd></dl>
|
|
947
|
-
|
|
948
|
-
<dl class="js function">
|
|
949
|
-
<dt class="sig sig-object js" id="RealEstate.getTypes">
|
|
950
|
-
<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>
|
|
951
|
-
<dd><p>Retrieves available Real estate emission calculation types by making a GET request to the API endpoint.</p>
|
|
952
|
-
<dl class="field-list simple">
|
|
953
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
954
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available Real estate emission types</p>
|
|
955
|
-
</dd>
|
|
956
|
-
</dl>
|
|
957
|
-
<div class="admonition-example admonition">
|
|
958
|
-
<p class="admonition-title">Example</p>
|
|
959
|
-
<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>
|
|
960
|
-
</pre></div>
|
|
961
|
-
</div>
|
|
962
|
-
</div>
|
|
963
|
-
</dd></dl>
|
|
964
|
-
|
|
965
|
-
<dl class="js function">
|
|
966
|
-
<dt class="sig sig-object js" id="EconomicActivity.getTypes">
|
|
967
|
-
<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>
|
|
968
|
-
<dd><p>Retrieves available economic activity emission calculation types by making a GET request to the API endpoint.</p>
|
|
969
|
-
<dl class="field-list simple">
|
|
970
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
971
|
-
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available economic activity emission types</p>
|
|
972
|
-
</dd>
|
|
973
|
-
</dl>
|
|
974
|
-
<div class="admonition-example admonition">
|
|
975
|
-
<p class="admonition-title">Example</p>
|
|
976
|
-
<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>
|
|
977
|
-
</pre></div>
|
|
978
|
-
</div>
|
|
979
|
-
</div>
|
|
980
|
-
</dd></dl>
|
|
981
|
-
|
|
982
|
-
</section>
|
|
983
|
-
<section id="getarea">
|
|
984
|
-
<h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
|
|
985
|
-
<dl class="js function">
|
|
986
|
-
<dt class="sig sig-object js" id="Factor.getArea">
|
|
987
|
-
<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">Factor</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="#Factor.getArea" title="Link to this definition">¶</a></dt>
|
|
988
|
-
<dd><p>Retrieves information about geographical areas supported by the factor API.</p>
|
|
989
|
-
<dl class="field-list simple">
|
|
990
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
991
|
-
<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>
|
|
992
|
-
</dd>
|
|
993
|
-
</dl>
|
|
994
|
-
<div class="admonition-example admonition">
|
|
995
|
-
<p class="admonition-title">Example</p>
|
|
996
|
-
<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>
|
|
997
|
-
</pre></div>
|
|
998
|
-
</div>
|
|
999
|
-
</div>
|
|
1000
|
-
</dd></dl>
|
|
1001
|
-
|
|
1002
|
-
<dl class="js function">
|
|
1003
|
-
<dt class="sig sig-object js" id="Factor.getSearchArea">
|
|
1004
|
-
<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">Factor</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getSearchArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Factor.getSearchArea" title="Link to this definition">¶</a></dt>
|
|
1005
|
-
<dd><p>Retrieves information about geographical areas supported by the factor search API.</p>
|
|
1006
|
-
<dl class="field-list simple">
|
|
1007
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1008
|
-
<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>
|
|
1009
|
-
</dd>
|
|
1010
|
-
</dl>
|
|
1011
|
-
<div class="admonition-example admonition">
|
|
1012
|
-
<p class="admonition-title">Example</p>
|
|
1013
|
-
<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>
|
|
1014
|
-
</pre></div>
|
|
1015
|
-
</div>
|
|
1016
|
-
</div>
|
|
1017
|
-
</dd></dl>
|
|
1018
|
-
|
|
1019
|
-
<dl class="js function">
|
|
1020
|
-
<dt class="sig sig-object js" id="Calculation.getArea">
|
|
1021
|
-
<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">Calculation</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="#Calculation.getArea" title="Link to this definition">¶</a></dt>
|
|
1022
|
-
<dd><p>Retrieves information about geographical areas supported by the calculation API.</p>
|
|
1023
|
-
<dl class="field-list simple">
|
|
1024
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1025
|
-
<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>
|
|
1026
|
-
</dd>
|
|
1027
|
-
</dl>
|
|
1028
|
-
<div class="admonition-example admonition">
|
|
1029
|
-
<p class="admonition-title">Example</p>
|
|
1030
|
-
<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>
|
|
1031
|
-
</pre></div>
|
|
1032
|
-
</div>
|
|
1033
|
-
</div>
|
|
1034
|
-
</dd></dl>
|
|
1035
|
-
|
|
1036
|
-
<dl class="js function">
|
|
1037
|
-
<dt class="sig sig-object js" id="Location.getArea">
|
|
1038
|
-
<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">Location</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="#Location.getArea" title="Link to this definition">¶</a></dt>
|
|
1039
|
-
<dd><p>Retrieves information about geographical areas supported by the location-based calculation API.</p>
|
|
1040
|
-
<dl class="field-list simple">
|
|
1041
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1042
|
-
<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>
|
|
1043
|
-
</dd>
|
|
1044
|
-
</dl>
|
|
1045
|
-
<div class="admonition-example admonition">
|
|
1046
|
-
<p class="admonition-title">Example</p>
|
|
1047
|
-
<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>
|
|
1048
|
-
</pre></div>
|
|
1049
|
-
</div>
|
|
1050
|
-
</div>
|
|
1051
|
-
</dd></dl>
|
|
1052
|
-
|
|
1053
|
-
<dl class="js function">
|
|
1054
|
-
<dt class="sig sig-object js" id="Mobile.getArea">
|
|
1055
|
-
<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">Mobile</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="#Mobile.getArea" title="Link to this definition">¶</a></dt>
|
|
1056
|
-
<dd><p>Retrieves information about geographical areas supported by the mobile emissions API.</p>
|
|
1057
|
-
<dl class="field-list simple">
|
|
1058
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1059
|
-
<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>
|
|
1060
|
-
</dd>
|
|
1061
|
-
</dl>
|
|
1062
|
-
<div class="admonition-example admonition">
|
|
1063
|
-
<p class="admonition-title">Example</p>
|
|
1064
|
-
<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>
|
|
1065
|
-
</pre></div>
|
|
1066
|
-
</div>
|
|
1067
|
-
</div>
|
|
1068
|
-
</dd></dl>
|
|
1069
|
-
|
|
1070
|
-
<dl class="js function">
|
|
1071
|
-
<dt class="sig sig-object js" id="Stationary.getArea">
|
|
1072
|
-
<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">Stationary</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="#Stationary.getArea" title="Link to this definition">¶</a></dt>
|
|
1073
|
-
<dd><p>Retrieves information about geographical areas supported by the stationary emissions API.</p>
|
|
1074
|
-
<dl class="field-list simple">
|
|
1075
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1076
|
-
<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>
|
|
1077
|
-
</dd>
|
|
1078
|
-
</dl>
|
|
1079
|
-
<div class="admonition-example admonition">
|
|
1080
|
-
<p class="admonition-title">Example</p>
|
|
1081
|
-
<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>
|
|
1082
|
-
</pre></div>
|
|
1083
|
-
</div>
|
|
1084
|
-
</div>
|
|
1085
|
-
</dd></dl>
|
|
1086
|
-
|
|
1087
|
-
<dl class="js function">
|
|
1088
|
-
<dt class="sig sig-object js" id="TransportationAndDistribution.getArea">
|
|
1089
|
-
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#TransportationAndDistribution.getArea" title="Link to this definition">¶</a></dt>
|
|
1090
|
-
<dd><p>Retrieves information about geographical areas supported by the transportation and distribution API.</p>
|
|
1091
|
-
<dl class="field-list simple">
|
|
1092
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1093
|
-
<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>
|
|
1094
|
-
</dd>
|
|
1095
|
-
</dl>
|
|
1096
|
-
<div class="admonition-example admonition">
|
|
1097
|
-
<p class="admonition-title">Example</p>
|
|
1098
|
-
<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>
|
|
1099
|
-
</pre></div>
|
|
1100
|
-
</div>
|
|
1101
|
-
</div>
|
|
1102
|
-
</dd></dl>
|
|
1103
|
-
|
|
1104
|
-
<dl class="js function">
|
|
1105
|
-
<dt class="sig sig-object js" id="Fugitive.getArea">
|
|
1106
|
-
<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">Fugitive</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="#Fugitive.getArea" title="Link to this definition">¶</a></dt>
|
|
1107
|
-
<dd><p>Retrieves information about geographical areas supported by the fugitive emissions API.</p>
|
|
1108
|
-
<dl class="field-list simple">
|
|
1109
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1110
|
-
<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>
|
|
1111
|
-
</dd>
|
|
1112
|
-
</dl>
|
|
1113
|
-
<div class="admonition-example admonition">
|
|
1114
|
-
<p class="admonition-title">Example</p>
|
|
1115
|
-
<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>
|
|
1116
|
-
</pre></div>
|
|
1117
|
-
</div>
|
|
1118
|
-
</div>
|
|
1119
|
-
</dd></dl>
|
|
1120
|
-
|
|
1121
|
-
<dl class="js function">
|
|
1122
|
-
<dt class="sig sig-object js" id="RealEstate.getArea">
|
|
1123
|
-
<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>
|
|
1124
|
-
<dd><p>Retrieves information about geographical areas supported by the real estate emissions API.</p>
|
|
1125
|
-
<dl class="field-list simple">
|
|
1126
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1127
|
-
<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>
|
|
1128
|
-
</dd>
|
|
1129
|
-
</dl>
|
|
1130
|
-
<div class="admonition-example admonition">
|
|
1131
|
-
<p class="admonition-title">Example</p>
|
|
1132
|
-
<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>
|
|
1133
|
-
</pre></div>
|
|
1134
|
-
</div>
|
|
1135
|
-
</div>
|
|
1136
|
-
</dd></dl>
|
|
1137
|
-
|
|
1138
|
-
<dl class="js function">
|
|
1139
|
-
<dt class="sig sig-object js" id="EconomicActivity.getArea">
|
|
1140
|
-
<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>
|
|
1141
|
-
<dd><p>Retrieves information about geographical areas supported by the economic activity emissions API.</p>
|
|
1142
|
-
<dl class="field-list simple">
|
|
1143
|
-
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1144
|
-
<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>
|
|
1145
|
-
</dd>
|
|
1146
|
-
</dl>
|
|
1147
|
-
<div class="admonition-example admonition">
|
|
1148
|
-
<p class="admonition-title">Example</p>
|
|
1149
|
-
<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>
|
|
1150
|
-
</pre></div>
|
|
1151
|
-
</div>
|
|
1152
|
-
</div>
|
|
1153
|
-
</dd></dl>
|
|
1154
|
-
|
|
1155
|
-
</section>
|
|
1156
|
-
<section id="getunits">
|
|
1157
|
-
<h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
|
|
1158
|
-
<dl class="js function">
|
|
1159
|
-
<dt class="sig sig-object js" id="Factor.getUnits">
|
|
1160
|
-
<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">Factor</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="#Factor.getUnits" title="Link to this definition">¶</a></dt>
|
|
1161
|
-
<dd><p>Retrieves available units for a specific emission factor type.</p>
|
|
1162
|
-
<dl class="field-list simple">
|
|
1163
|
-
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1164
|
-
<dd class="field-odd"><ul class="simple">
|
|
1165
|
-
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The emission factor type to get units for (e.g., “Natural Gas - Scope 3:AAA”)</p></li>
|
|
833
|
+
<section id="global-metadata-api">
|
|
834
|
+
<h2>Global Metadata API<a class="headerlink" href="#global-metadata-api" title="Link to this heading">¶</a></h2>
|
|
835
|
+
<p>The global Metadata API provides a unified way to query metadata across different endpoints without calling endpoint-specific methods.</p>
|
|
836
|
+
<ul class="simple">
|
|
837
|
+
<li><p><strong>getTypes/postTypes</strong> and <strong>getArea/postArea</strong>: Accept an optional <code class="docutils literal notranslate"><span class="pre">endpoint</span></code> parameter to query metadata for specific endpoints</p></li>
|
|
838
|
+
<li><p><strong>getUnits/postUnits</strong>: Accept an optional <code class="docutils literal notranslate"><span class="pre">type</span></code> parameter to query units for specific emission types</p></li>
|
|
1166
839
|
</ul>
|
|
1167
|
-
</
|
|
1168
|
-
<
|
|
1169
|
-
<
|
|
1170
|
-
</dd>
|
|
1171
|
-
</dl>
|
|
1172
|
-
<div class="admonition-example admonition">
|
|
1173
|
-
<p class="admonition-title">Example</p>
|
|
1174
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "Natural Gas - Scope 3:AAA" emission factor type with subtype</span>
|
|
1175
|
-
<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">"Natural Gas - Scope 3:AAA"</span><span class="p">);</span>
|
|
1176
|
-
|
|
1177
|
-
<span class="c1">// Get units for the "HFC-263fb" emission factor type without subtype</span>
|
|
1178
|
-
<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">"HFC-263fb"</span><span class="p">);</span>
|
|
1179
|
-
</pre></div>
|
|
1180
|
-
</div>
|
|
1181
|
-
</div>
|
|
1182
|
-
</dd></dl>
|
|
1183
|
-
|
|
840
|
+
<p><strong>Supported endpoints</strong> (for getTypes/postTypes and getArea/postArea): <code class="docutils literal notranslate"><span class="pre">calculation</span></code>, <code class="docutils literal notranslate"><span class="pre">location</span></code>, <code class="docutils literal notranslate"><span class="pre">stationary</span></code>, <code class="docutils literal notranslate"><span class="pre">mobile</span></code>, <code class="docutils literal notranslate"><span class="pre">fugitive</span></code>, <code class="docutils literal notranslate"><span class="pre">factor</span></code>, <code class="docutils literal notranslate"><span class="pre">search</span></code>, <code class="docutils literal notranslate"><span class="pre">transportation-and-distribution</span></code>, <code class="docutils literal notranslate"><span class="pre">economic-activity</span></code>, <code class="docutils literal notranslate"><span class="pre">real-estate</span></code></p>
|
|
841
|
+
<section id="id1">
|
|
842
|
+
<h3>getTypes<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3>
|
|
1184
843
|
<dl class="js function">
|
|
1185
|
-
<dt class="sig sig-object js" id="
|
|
1186
|
-
<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">
|
|
1187
|
-
<dd><p>Retrieves available
|
|
844
|
+
<dt class="sig sig-object js" id="Metadata.getTypes">
|
|
845
|
+
<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">Metadata</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><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.getTypes" title="Link to this definition">¶</a></dt>
|
|
846
|
+
<dd><p>Retrieves available emission source types for a specific endpoint using GET request.</p>
|
|
1188
847
|
<dl class="field-list simple">
|
|
1189
848
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1190
849
|
<dd class="field-odd"><ul class="simple">
|
|
1191
|
-
<li><p><strong>
|
|
850
|
+
<li><p><strong>endpoint</strong> (<span class="sphinx_js-type">string</span>) – The endpoint name to retrieve types for. Defaults to ‘calculation’ if not provided.</p></li>
|
|
1192
851
|
</ul>
|
|
1193
852
|
</dd>
|
|
1194
853
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1195
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
854
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available types</p>
|
|
1196
855
|
</dd>
|
|
1197
856
|
</dl>
|
|
1198
857
|
<div class="admonition-example admonition">
|
|
1199
858
|
<p class="admonition-title">Example</p>
|
|
1200
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get
|
|
1201
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
1202
|
-
|
|
1203
|
-
<span class="c1">// Get units for the "HFC-263fb" emission calculation type without subtype</span>
|
|
1204
|
-
<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">"HFC-263fb"</span><span class="p">);</span>
|
|
1205
|
-
</pre></div>
|
|
1206
|
-
</div>
|
|
1207
|
-
</div>
|
|
1208
|
-
</dd></dl>
|
|
859
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get types for calculation endpoint (default)</span>
|
|
860
|
+
<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>
|
|
1209
861
|
|
|
1210
|
-
<
|
|
1211
|
-
<
|
|
1212
|
-
<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">Location</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="#Location.getUnits" title="Link to this definition">¶</a></dt>
|
|
1213
|
-
<dd><p>Retrieves available units for a specific location-based calculation type.</p>
|
|
1214
|
-
<dl class="field-list simple">
|
|
1215
|
-
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1216
|
-
<dd class="field-odd"><ul class="simple">
|
|
1217
|
-
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The location-based calculation type to get units for (e.g., “electricity”)</p></li>
|
|
1218
|
-
</ul>
|
|
1219
|
-
</dd>
|
|
1220
|
-
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1221
|
-
<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>
|
|
1222
|
-
</dd>
|
|
1223
|
-
</dl>
|
|
1224
|
-
<div class="admonition-example admonition">
|
|
1225
|
-
<p class="admonition-title">Example</p>
|
|
1226
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "electricity" location type</span>
|
|
1227
|
-
<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">"electricity"</span><span class="p">);</span>
|
|
862
|
+
<span class="c1">// Get types for a specific endpoint</span>
|
|
863
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">locationTypes</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><span class="s1">'location'</span><span class="p">);</span>
|
|
1228
864
|
</pre></div>
|
|
1229
865
|
</div>
|
|
1230
866
|
</div>
|
|
1231
867
|
</dd></dl>
|
|
1232
868
|
|
|
1233
869
|
<dl class="js function">
|
|
1234
|
-
<dt class="sig sig-object js" id="
|
|
1235
|
-
<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">
|
|
1236
|
-
<dd><p>Retrieves available
|
|
870
|
+
<dt class="sig sig-object js" id="Metadata.postTypes">
|
|
871
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">postTypes</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.postTypes" title="Link to this definition">¶</a></dt>
|
|
872
|
+
<dd><p>Retrieves available emission source types for a specific endpoint using POST request.</p>
|
|
1237
873
|
<dl class="field-list simple">
|
|
1238
874
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1239
875
|
<dd class="field-odd"><ul class="simple">
|
|
1240
|
-
<li><p><strong>
|
|
876
|
+
<li><p><strong>endpoint</strong> (<span class="sphinx_js-type">string</span>) – The endpoint name to retrieve types for. Defaults to ‘calculation’ if not provided.</p></li>
|
|
1241
877
|
</ul>
|
|
1242
878
|
</dd>
|
|
1243
879
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1244
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
880
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available types</p>
|
|
1245
881
|
</dd>
|
|
1246
882
|
</dl>
|
|
1247
883
|
<div class="admonition-example admonition">
|
|
1248
884
|
<p class="admonition-title">Example</p>
|
|
1249
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="
|
|
1250
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
885
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get types for calculation endpoint (default)</span>
|
|
886
|
+
<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">postTypes</span><span class="p">();</span>
|
|
1251
887
|
|
|
1252
|
-
<span class="
|
|
1253
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
888
|
+
<span class="c1">// Get types for a specific endpoint</span>
|
|
889
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">stationaryTypes</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">postTypes</span><span class="p">(</span><span class="s1">'stationary'</span><span class="p">);</span>
|
|
1254
890
|
</pre></div>
|
|
1255
891
|
</div>
|
|
1256
892
|
</div>
|
|
1257
893
|
</dd></dl>
|
|
1258
894
|
|
|
895
|
+
</section>
|
|
896
|
+
<section id="getarea">
|
|
897
|
+
<h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
|
|
1259
898
|
<dl class="js function">
|
|
1260
|
-
<dt class="sig sig-object js" id="
|
|
1261
|
-
<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">
|
|
1262
|
-
<dd><p>Retrieves available
|
|
899
|
+
<dt class="sig sig-object js" id="Metadata.getArea">
|
|
900
|
+
<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">Metadata</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><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.getArea" title="Link to this definition">¶</a></dt>
|
|
901
|
+
<dd><p>Retrieves available geographic locations for a specific endpoint using GET request.</p>
|
|
1263
902
|
<dl class="field-list simple">
|
|
1264
903
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1265
904
|
<dd class="field-odd"><ul class="simple">
|
|
1266
|
-
<li><p><strong>
|
|
905
|
+
<li><p><strong>endpoint</strong> (<span class="sphinx_js-type">string</span>) – The endpoint name to retrieve locations for. Defaults to ‘calculation’ if not provided.</p></li>
|
|
1267
906
|
</ul>
|
|
1268
907
|
</dd>
|
|
1269
908
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1270
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
909
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the available locations</p>
|
|
1271
910
|
</dd>
|
|
1272
911
|
</dl>
|
|
1273
912
|
<div class="admonition-example admonition">
|
|
1274
913
|
<p class="admonition-title">Example</p>
|
|
1275
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="
|
|
1276
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
914
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get areas for calculation endpoint (default)</span>
|
|
915
|
+
<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>
|
|
1277
916
|
|
|
1278
|
-
<span class="
|
|
1279
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
917
|
+
<span class="c1">// Get areas for a specific endpoint</span>
|
|
918
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">mobileAreas</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><span class="s1">'mobile'</span><span class="p">);</span>
|
|
1280
919
|
</pre></div>
|
|
1281
920
|
</div>
|
|
1282
921
|
</div>
|
|
1283
922
|
</dd></dl>
|
|
1284
923
|
|
|
1285
924
|
<dl class="js function">
|
|
1286
|
-
<dt class="sig sig-object js" id="
|
|
1287
|
-
<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">
|
|
1288
|
-
<dd><p>Retrieves available
|
|
925
|
+
<dt class="sig sig-object js" id="Metadata.postArea">
|
|
926
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">postArea</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.postArea" title="Link to this definition">¶</a></dt>
|
|
927
|
+
<dd><p>Retrieves available geographic locations for a specific endpoint using POST request.</p>
|
|
1289
928
|
<dl class="field-list simple">
|
|
1290
929
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1291
930
|
<dd class="field-odd"><ul class="simple">
|
|
1292
|
-
<li><p><strong>
|
|
931
|
+
<li><p><strong>endpoint</strong> (<span class="sphinx_js-type">string</span>) – The endpoint name to retrieve locations for. Defaults to ‘calculation’ if not provided.</p></li>
|
|
1293
932
|
</ul>
|
|
1294
933
|
</dd>
|
|
1295
934
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1296
|
-
<dd class="field-even"><p><span class="sphinx_js-type">Promise<
|
|
935
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the available locations</p>
|
|
1297
936
|
</dd>
|
|
1298
937
|
</dl>
|
|
1299
938
|
<div class="admonition-example admonition">
|
|
1300
939
|
<p class="admonition-title">Example</p>
|
|
1301
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get
|
|
1302
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
940
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get areas for calculation endpoint (default)</span>
|
|
941
|
+
<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">postArea</span><span class="p">();</span>
|
|
1303
942
|
|
|
1304
|
-
<span class="c1">// Get
|
|
1305
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
943
|
+
<span class="c1">// Get areas for a specific endpoint</span>
|
|
944
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">fugitiveAreas</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">postArea</span><span class="p">(</span><span class="s1">'fugitive'</span><span class="p">);</span>
|
|
1306
945
|
</pre></div>
|
|
1307
946
|
</div>
|
|
1308
947
|
</div>
|
|
1309
948
|
</dd></dl>
|
|
1310
949
|
|
|
950
|
+
</section>
|
|
951
|
+
<section id="getunits">
|
|
952
|
+
<h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
|
|
1311
953
|
<dl class="js function">
|
|
1312
|
-
<dt class="sig sig-object js" id="
|
|
1313
|
-
<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">
|
|
1314
|
-
<dd><p>Retrieves available units for a specific
|
|
954
|
+
<dt class="sig sig-object js" id="Metadata.getUnits">
|
|
955
|
+
<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">Metadata</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="#Metadata.getUnits" title="Link to this definition">¶</a></dt>
|
|
956
|
+
<dd><p>Retrieves available measurement units for a specific type using GET request.</p>
|
|
1315
957
|
<dl class="field-list simple">
|
|
1316
958
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1317
959
|
<dd class="field-odd"><ul class="simple">
|
|
1318
|
-
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The
|
|
960
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The emission source type to retrieve units for. If not provided, returns the full UOM table.</p></li>
|
|
1319
961
|
</ul>
|
|
1320
962
|
</dd>
|
|
1321
963
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
@@ -1324,24 +966,24 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1324
966
|
</dl>
|
|
1325
967
|
<div class="admonition-example admonition">
|
|
1326
968
|
<p class="admonition-title">Example</p>
|
|
1327
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units
|
|
1328
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
969
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get all units</span>
|
|
970
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">allUnits</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>
|
|
1329
971
|
|
|
1330
|
-
<span class="c1">// Get units for
|
|
1331
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
972
|
+
<span class="c1">// Get units for a specific type</span>
|
|
973
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">naturalGasUnits</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="s1">'Natural Gas'</span><span class="p">);</span>
|
|
1332
974
|
</pre></div>
|
|
1333
975
|
</div>
|
|
1334
976
|
</div>
|
|
1335
977
|
</dd></dl>
|
|
1336
978
|
|
|
1337
979
|
<dl class="js function">
|
|
1338
|
-
<dt class="sig sig-object js" id="
|
|
1339
|
-
<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">
|
|
1340
|
-
<dd><p>Retrieves available units for a specific
|
|
980
|
+
<dt class="sig sig-object js" id="Metadata.postUnits">
|
|
981
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">postUnits</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="#Metadata.postUnits" title="Link to this definition">¶</a></dt>
|
|
982
|
+
<dd><p>Retrieves available measurement units for a specific type using POST request.</p>
|
|
1341
983
|
<dl class="field-list simple">
|
|
1342
984
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1343
985
|
<dd class="field-odd"><ul class="simple">
|
|
1344
|
-
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The
|
|
986
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The emission source type to retrieve units for. If not provided, returns the full UOM table.</p></li>
|
|
1345
987
|
</ul>
|
|
1346
988
|
</dd>
|
|
1347
989
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
@@ -1350,31 +992,11 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1350
992
|
</dl>
|
|
1351
993
|
<div class="admonition-example admonition">
|
|
1352
994
|
<p class="admonition-title">Example</p>
|
|
1353
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units
|
|
1354
|
-
<span class="kd">const</span><span class="w"> </span><span class="nx">
|
|
1355
|
-
</pre></div>
|
|
1356
|
-
</div>
|
|
1357
|
-
</div>
|
|
1358
|
-
</dd></dl>
|
|
995
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get all units</span>
|
|
996
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">allUnits</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">postUnits</span><span class="p">();</span>
|
|
1359
997
|
|
|
1360
|
-
<
|
|
1361
|
-
<
|
|
1362
|
-
<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>
|
|
1363
|
-
<dd><p>Retrieves available units for a specific economic activity emission type.</p>
|
|
1364
|
-
<dl class="field-list simple">
|
|
1365
|
-
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1366
|
-
<dd class="field-odd"><ul class="simple">
|
|
1367
|
-
<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>
|
|
1368
|
-
</ul>
|
|
1369
|
-
</dd>
|
|
1370
|
-
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1371
|
-
<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>
|
|
1372
|
-
</dd>
|
|
1373
|
-
</dl>
|
|
1374
|
-
<div class="admonition-example admonition">
|
|
1375
|
-
<p class="admonition-title">Example</p>
|
|
1376
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "accomodation" emission economic activity type without subtype</span>
|
|
1377
|
-
<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">"accomodation"</span><span class="p">);</span>
|
|
998
|
+
<span class="c1">// Get units for a specific type</span>
|
|
999
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">jetKeroseneUnits</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">postUnits</span><span class="p">(</span><span class="s1">'Jet Kerosene'</span><span class="p">);</span>
|
|
1378
1000
|
</pre></div>
|
|
1379
1001
|
</div>
|
|
1380
1002
|
</div>
|
|
@@ -1711,42 +1333,20 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1711
1333
|
<li><a class="reference internal" href="#EconomicActivity.calculate"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></a></li>
|
|
1712
1334
|
</ul>
|
|
1713
1335
|
</li>
|
|
1714
|
-
<li><a class="reference internal" href="#metadata-
|
|
1336
|
+
<li><a class="reference internal" href="#global-metadata-api">Global Metadata API</a><ul>
|
|
1715
1337
|
<li><a class="reference internal" href="#gettypes">getTypes</a><ul>
|
|
1716
|
-
<li><a class="reference internal" href="#
|
|
1717
|
-
<li><a class="reference internal" href="#
|
|
1718
|
-
<li><a class="reference internal" href="#Location.getTypes"><code class="docutils literal notranslate"><span class="pre">Location.getTypes()</span></code></a></li>
|
|
1719
|
-
<li><a class="reference internal" href="#Mobile.getTypes"><code class="docutils literal notranslate"><span class="pre">Mobile.getTypes()</span></code></a></li>
|
|
1720
|
-
<li><a class="reference internal" href="#Stationary.getTypes"><code class="docutils literal notranslate"><span class="pre">Stationary.getTypes()</span></code></a></li>
|
|
1721
|
-
<li><a class="reference internal" href="#TransportationAndDistribution.getTypes"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getTypes()</span></code></a></li>
|
|
1722
|
-
<li><a class="reference internal" href="#Fugitive.getTypes"><code class="docutils literal notranslate"><span class="pre">Fugitive.getTypes()</span></code></a></li>
|
|
1723
|
-
<li><a class="reference internal" href="#RealEstate.getTypes"><code class="docutils literal notranslate"><span class="pre">RealEstate.getTypes()</span></code></a></li>
|
|
1724
|
-
<li><a class="reference internal" href="#EconomicActivity.getTypes"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.getTypes()</span></code></a></li>
|
|
1338
|
+
<li><a class="reference internal" href="#Metadata.getTypes"><code class="docutils literal notranslate"><span class="pre">Metadata.getTypes()</span></code></a></li>
|
|
1339
|
+
<li><a class="reference internal" href="#Metadata.postTypes"><code class="docutils literal notranslate"><span class="pre">Metadata.postTypes()</span></code></a></li>
|
|
1725
1340
|
</ul>
|
|
1726
1341
|
</li>
|
|
1727
1342
|
<li><a class="reference internal" href="#getarea">getArea</a><ul>
|
|
1728
|
-
<li><a class="reference internal" href="#
|
|
1729
|
-
<li><a class="reference internal" href="#
|
|
1730
|
-
<li><a class="reference internal" href="#Calculation.getArea"><code class="docutils literal notranslate"><span class="pre">Calculation.getArea()</span></code></a></li>
|
|
1731
|
-
<li><a class="reference internal" href="#Location.getArea"><code class="docutils literal notranslate"><span class="pre">Location.getArea()</span></code></a></li>
|
|
1732
|
-
<li><a class="reference internal" href="#Mobile.getArea"><code class="docutils literal notranslate"><span class="pre">Mobile.getArea()</span></code></a></li>
|
|
1733
|
-
<li><a class="reference internal" href="#Stationary.getArea"><code class="docutils literal notranslate"><span class="pre">Stationary.getArea()</span></code></a></li>
|
|
1734
|
-
<li><a class="reference internal" href="#TransportationAndDistribution.getArea"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getArea()</span></code></a></li>
|
|
1735
|
-
<li><a class="reference internal" href="#Fugitive.getArea"><code class="docutils literal notranslate"><span class="pre">Fugitive.getArea()</span></code></a></li>
|
|
1736
|
-
<li><a class="reference internal" href="#RealEstate.getArea"><code class="docutils literal notranslate"><span class="pre">RealEstate.getArea()</span></code></a></li>
|
|
1737
|
-
<li><a class="reference internal" href="#EconomicActivity.getArea"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.getArea()</span></code></a></li>
|
|
1343
|
+
<li><a class="reference internal" href="#Metadata.getArea"><code class="docutils literal notranslate"><span class="pre">Metadata.getArea()</span></code></a></li>
|
|
1344
|
+
<li><a class="reference internal" href="#Metadata.postArea"><code class="docutils literal notranslate"><span class="pre">Metadata.postArea()</span></code></a></li>
|
|
1738
1345
|
</ul>
|
|
1739
1346
|
</li>
|
|
1740
1347
|
<li><a class="reference internal" href="#getunits">getUnits</a><ul>
|
|
1741
|
-
<li><a class="reference internal" href="#
|
|
1742
|
-
<li><a class="reference internal" href="#
|
|
1743
|
-
<li><a class="reference internal" href="#Location.getUnits"><code class="docutils literal notranslate"><span class="pre">Location.getUnits()</span></code></a></li>
|
|
1744
|
-
<li><a class="reference internal" href="#Mobile.getUnits"><code class="docutils literal notranslate"><span class="pre">Mobile.getUnits()</span></code></a></li>
|
|
1745
|
-
<li><a class="reference internal" href="#Stationary.getUnits"><code class="docutils literal notranslate"><span class="pre">Stationary.getUnits()</span></code></a></li>
|
|
1746
|
-
<li><a class="reference internal" href="#TransportationAndDistribution.getUnits"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getUnits()</span></code></a></li>
|
|
1747
|
-
<li><a class="reference internal" href="#Fugitive.getUnits"><code class="docutils literal notranslate"><span class="pre">Fugitive.getUnits()</span></code></a></li>
|
|
1748
|
-
<li><a class="reference internal" href="#RealEstate.getUnits"><code class="docutils literal notranslate"><span class="pre">RealEstate.getUnits()</span></code></a></li>
|
|
1749
|
-
<li><a class="reference internal" href="#EconomicActivity.getUnits"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.getUnits()</span></code></a></li>
|
|
1348
|
+
<li><a class="reference internal" href="#Metadata.getUnits"><code class="docutils literal notranslate"><span class="pre">Metadata.getUnits()</span></code></a></li>
|
|
1349
|
+
<li><a class="reference internal" href="#Metadata.postUnits"><code class="docutils literal notranslate"><span class="pre">Metadata.postUnits()</span></code></a></li>
|
|
1750
1350
|
</ul>
|
|
1751
1351
|
</li>
|
|
1752
1352
|
</ul>
|