emissions-api-sdk 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/README.md +19 -26
  2. package/dist/Constants.js +6 -23
  3. package/dist/api/Calculation.js +0 -63
  4. package/dist/api/EconomicActivity.js +40 -0
  5. package/dist/api/Factor.js +0 -82
  6. package/dist/api/Fugitive.js +0 -63
  7. package/dist/api/Location.js +0 -61
  8. package/dist/api/Metadata.js +155 -0
  9. package/dist/api/Mobile.js +0 -64
  10. package/dist/api/RealEstate.js +40 -0
  11. package/dist/api/Stationary.js +0 -63
  12. package/dist/api/TransportationAndDistribution.js +0 -63
  13. package/dist/coverage/clover.xml +144 -199
  14. package/dist/coverage/coverage-final.json +14 -11
  15. package/dist/coverage/lcov-report/index.html +20 -20
  16. package/dist/coverage/lcov-report/src/Client.ts.html +28 -28
  17. package/dist/coverage/lcov-report/src/Constants.ts.html +31 -88
  18. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +7 -217
  19. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +220 -0
  20. package/dist/coverage/lcov-report/src/api/Factor.ts.html +6 -285
  21. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  22. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +7 -223
  23. package/dist/coverage/lcov-report/src/api/Location.ts.html +6 -222
  24. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +604 -0
  25. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +6 -231
  26. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +217 -0
  27. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +6 -225
  28. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +7 -223
  29. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  30. package/dist/coverage/lcov-report/src/api/index.html +72 -27
  31. package/dist/coverage/lcov-report/src/index.html +7 -7
  32. package/dist/coverage/lcov-report/src/request.ts.html +5 -5
  33. package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
  34. package/dist/coverage/lcov-report/test/index.html +1 -1
  35. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  36. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  37. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  38. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  39. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
  40. package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
  41. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  42. package/dist/coverage/lcov.info +241 -294
  43. package/dist/index.js +4 -1
  44. package/dist/types/Constants.d.ts +5 -22
  45. package/dist/types/api/Calculation.d.ts +0 -41
  46. package/dist/types/api/EconomicActivity.d.ts +29 -0
  47. package/dist/types/api/Factor.d.ts +0 -52
  48. package/dist/types/api/Fugitive.d.ts +0 -41
  49. package/dist/types/api/Location.d.ts +0 -39
  50. package/dist/types/api/Metadata.d.ts +99 -0
  51. package/dist/types/api/Mobile.d.ts +0 -42
  52. package/dist/types/api/RealEstate.d.ts +29 -0
  53. package/dist/types/api/Stationary.d.ts +0 -41
  54. package/dist/types/api/TransportationAndDistribution.d.ts +0 -41
  55. package/dist/types/index.d.ts +3 -0
  56. package/dist/types/interfaces/response/FactorResponse.d.ts +0 -4
  57. package/docs/_sources/index.rst.txt +8 -6
  58. package/docs/_sources/reference.rst.txt +17 -37
  59. package/docs/_static/basic.css +8 -0
  60. package/docs/_static/pygments.css +146 -164
  61. package/docs/_static/searchtools.js +5 -8
  62. package/docs/_static/styles/furo.css +1 -1
  63. package/docs/_static/styles/furo.css.map +1 -1
  64. package/docs/authentication.html +28 -19
  65. package/docs/client.html +28 -19
  66. package/docs/genindex.html +56 -71
  67. package/docs/getting_started.html +28 -19
  68. package/docs/index.html +31 -20
  69. package/docs/objects.inv +0 -0
  70. package/docs/reference.html +151 -357
  71. package/docs/sdk.html +28 -19
  72. package/docs/search.html +28 -19
  73. package/docs/searchindex.js +1 -1
  74. package/docs/troubleshooting.html +28 -19
  75. package/package.json +7 -2
  76. package/sphinx-build/source/index.rst +8 -6
  77. package/sphinx-build/source/reference.rst +17 -37
  78. package/src/Constants.ts +6 -25
  79. package/src/api/Calculation.ts +1 -72
  80. package/src/api/EconomicActivity.ts +45 -0
  81. package/src/api/Factor.ts +1 -94
  82. package/src/api/Fugitive.ts +1 -74
  83. package/src/api/Location.ts +1 -73
  84. package/src/api/Metadata.ts +174 -0
  85. package/src/api/Mobile.ts +1 -76
  86. package/src/api/RealEstate.ts +45 -0
  87. package/src/api/Stationary.ts +1 -74
  88. package/src/api/TransportationAndDistribution.ts +1 -74
  89. package/src/index.ts +3 -0
  90. package/src/interfaces/response/FactorResponse.ts +0 -7
  91. package/test/apiTest.test.ts +19 -162
  92. package/test/metadata.test.ts +224 -0
  93. package/test/request.test.ts +0 -1
@@ -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"><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">
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.2.3 and Furo 2025.09.25 -->
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=580074bf" />
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: #202020;
28
- --color-code-foreground: #d0d0d0;
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: #202020;
34
- --color-code-foreground: #d0d0d0;
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" aria-label="Toggle site navigation sidebar">
150
- <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
151
- <label class="overlay sidebar-overlay" for="__navigation"></label>
152
- <label class="overlay toc-overlay" for="__toc"></label>
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
- <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
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" aria-label="Toggle Light / Dark / Auto color theme">
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
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
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 aria-label="Toggle navigation of SDK" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
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" aria-label="Toggle Light / Dark / Auto color theme">
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
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
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">
@@ -748,408 +757,207 @@ Only refreshes if the token was not provided by the user and is expiring within
748
757
  </div>
749
758
  </dd></dl>
750
759
 
751
- </section>
752
- <section id="metadata-apis">
753
- <h2>Metadata APIs<a class="headerlink" href="#metadata-apis" title="Link to this heading">¶</a></h2>
754
- <section id="gettypes">
755
- <h3>getTypes<a class="headerlink" href="#gettypes" title="Link to this heading">¶</a></h3>
756
- <dl class="js function">
757
- <dt class="sig sig-object js" id="Factor.getTypes">
758
- <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>
759
- <dd><p>Retrieves available emission factor types by making a GET request to the API endpoint.</p>
760
- <dl class="field-list simple">
761
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
762
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available emission factor types</p>
763
- </dd>
764
- </dl>
765
- <div class="admonition-example admonition">
766
- <p class="admonition-title">Example</p>
767
- <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>
768
- </pre></div>
769
- </div>
770
- </div>
771
- </dd></dl>
772
-
773
- <dl class="js function">
774
- <dt class="sig sig-object js" id="Calculation.getTypes">
775
- <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>
776
- <dd><p>Retrieves available calculation types by making a GET request to the calculation types API endpoint.</p>
777
- <dl class="field-list simple">
778
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
779
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available calculation types</p>
780
- </dd>
781
- </dl>
782
- <div class="admonition-example admonition">
783
- <p class="admonition-title">Example</p>
784
- <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>
785
- </pre></div>
786
- </div>
787
- </div>
788
- </dd></dl>
789
-
790
- <dl class="js function">
791
- <dt class="sig sig-object js" id="Location.getTypes">
792
- <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>
793
- <dd><p>Retrieves available location-based calculation types by making a GET request to the location types API endpoint.</p>
794
- <dl class="field-list simple">
795
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
796
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available location-based calculation types</p>
797
- </dd>
798
- </dl>
799
- <div class="admonition-example admonition">
800
- <p class="admonition-title">Example</p>
801
- <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>
802
- </pre></div>
803
- </div>
804
- </div>
805
- </dd></dl>
806
-
807
- <dl class="js function">
808
- <dt class="sig sig-object js" id="Mobile.getTypes">
809
- <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>
810
- <dd><p>Retrieves available mobile emission calculation types by making a GET request to the API endpoint.</p>
811
- <dl class="field-list simple">
812
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
813
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available mobile emission types</p>
814
- </dd>
815
- </dl>
816
- <div class="admonition-example admonition">
817
- <p class="admonition-title">Example</p>
818
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get all available mobile emission types</span>
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>
820
- </pre></div>
821
- </div>
822
- </div>
823
- </dd></dl>
824
-
825
- <dl class="js function">
826
- <dt class="sig sig-object js" id="Stationary.getTypes">
827
- <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>
828
- <dd><p>Retrieves available stationary emission calculation types by making a GET request to the API endpoint.</p>
829
- <dl class="field-list simple">
830
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
831
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available stationary emission types</p>
832
- </dd>
833
- </dl>
834
- <div class="admonition-example admonition">
835
- <p class="admonition-title">Example</p>
836
- <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>
837
- </pre></div>
838
- </div>
839
- </div>
840
- </dd></dl>
841
-
842
- <dl class="js function">
843
- <dt class="sig sig-object js" id="TransportationAndDistribution.getTypes">
844
- <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>
845
- <dd><p>Retrieves available transportation and distribution calculation types by making a GET request to the API endpoint.</p>
846
- <dl class="field-list simple">
847
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
848
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available transportation and distribution calculation types</p>
849
- </dd>
850
- </dl>
851
- <div class="admonition-example admonition">
852
- <p class="admonition-title">Example</p>
853
- <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>
854
- </pre></div>
855
- </div>
856
- </div>
857
- </dd></dl>
858
-
859
- <dl class="js function">
860
- <dt class="sig sig-object js" id="Fugitive.getTypes">
861
- <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>
862
- <dd><p>Retrieves available fugitive emission calculation types by making a GET request to the API endpoint.</p>
863
- <dl class="field-list simple">
864
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
865
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available fugitive emission types</p>
866
- </dd>
867
- </dl>
868
- <div class="admonition-example admonition">
869
- <p class="admonition-title">Example</p>
870
- <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>
871
- </pre></div>
872
- </div>
873
- </div>
874
- </dd></dl>
875
-
876
- </section>
877
- <section id="getarea">
878
- <h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
879
- <dl class="js function">
880
- <dt class="sig sig-object js" id="Factor.getArea">
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">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>
882
- <dd><p>Retrieves information about geographical areas supported by the factor API.</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&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</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="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>
891
- </pre></div>
892
- </div>
893
- </div>
894
- </dd></dl>
895
-
896
- <dl class="js function">
897
- <dt class="sig sig-object js" id="Factor.getSearchArea">
898
- <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>
899
- <dd><p>Retrieves information about geographical areas supported by the factor search API.</p>
900
- <dl class="field-list simple">
901
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
902
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
903
- </dd>
904
- </dl>
905
- <div class="admonition-example admonition">
906
- <p class="admonition-title">Example</p>
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>
908
- </pre></div>
909
- </div>
910
- </div>
911
- </dd></dl>
912
-
913
- <dl class="js function">
914
- <dt class="sig sig-object js" id="Calculation.getArea">
915
- <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>
916
- <dd><p>Retrieves information about geographical areas supported by the calculation API.</p>
917
- <dl class="field-list simple">
918
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
919
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
920
- </dd>
921
- </dl>
922
- <div class="admonition-example admonition">
923
- <p class="admonition-title">Example</p>
924
- <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>
925
- </pre></div>
926
- </div>
927
- </div>
928
- </dd></dl>
929
-
930
- <dl class="js function">
931
- <dt class="sig sig-object js" id="Location.getArea">
932
- <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>
933
- <dd><p>Retrieves information about geographical areas supported by the location-based calculation API.</p>
934
- <dl class="field-list simple">
935
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
936
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
937
- </dd>
938
- </dl>
939
- <div class="admonition-example admonition">
940
- <p class="admonition-title">Example</p>
941
- <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>
942
- </pre></div>
943
- </div>
944
- </div>
945
- </dd></dl>
946
-
947
- <dl class="js function">
948
- <dt class="sig sig-object js" id="Mobile.getArea">
949
- <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>
950
- <dd><p>Retrieves information about geographical areas supported by the mobile emissions API.</p>
951
- <dl class="field-list simple">
952
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
953
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
954
- </dd>
955
- </dl>
956
- <div class="admonition-example admonition">
957
- <p class="admonition-title">Example</p>
958
- <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>
959
- </pre></div>
960
- </div>
961
- </div>
962
- </dd></dl>
963
-
964
- <dl class="js function">
965
- <dt class="sig sig-object js" id="Stationary.getArea">
966
- <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>
967
- <dd><p>Retrieves information about geographical areas supported by the stationary emissions API.</p>
968
- <dl class="field-list simple">
969
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
970
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
971
- </dd>
972
- </dl>
973
- <div class="admonition-example admonition">
974
- <p class="admonition-title">Example</p>
975
- <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>
976
- </pre></div>
977
- </div>
978
- </div>
979
- </dd></dl>
980
-
981
760
  <dl class="js function">
982
- <dt class="sig sig-object js" id="TransportationAndDistribution.getArea">
983
- <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>
984
- <dd><p>Retrieves information about geographical areas supported by the transportation and distribution API.</p>
761
+ <dt class="sig sig-object js" id="RealEstate.calculate">
762
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">RealEstate</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RealEstate.calculate" title="Link to this definition">¶</a></dt>
763
+ <dd><p>Performs scope 3 Real estate emission calculations by making a POST request to the real estate API endpoint.</p>
985
764
  <dl class="field-list simple">
986
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
987
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
765
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
766
+ <dd class="field-odd"><ul class="simple">
767
+ <li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the API</p></li>
768
+ </ul>
988
769
  </dd>
989
- </dl>
990
- <div class="admonition-example admonition">
991
- <p class="admonition-title">Example</p>
992
- <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>
993
- </pre></div>
994
- </div>
995
- </div>
996
- </dd></dl>
997
-
998
- <dl class="js function">
999
- <dt class="sig sig-object js" id="Fugitive.getArea">
1000
- <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>
1001
- <dd><p>Retrieves information about geographical areas supported by the fugitive emissions API.</p>
1002
- <dl class="field-list simple">
1003
- <dt class="field-odd">Returns<span class="colon">:</span></dt>
1004
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
770
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
771
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;EmissionResponse | EmissionResponseWithDetails&gt;</span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
1005
772
  </dd>
1006
773
  </dl>
1007
774
  <div class="admonition-example admonition">
1008
775
  <p class="admonition-title">Example</p>
1009
- <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>
776
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
777
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
778
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span>
779
+ <span class="w"> </span><span class="p">},</span>
780
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
781
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
782
+ <span class="w"> </span><span class="p">},</span>
783
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
784
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Commercial Real Estate:Industrial distribution warehouse&quot;</span><span class="p">,</span>
785
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">17000.123</span><span class="p">,</span>
786
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;m2&quot;</span>
787
+ <span class="w"> </span><span class="p">},</span>
788
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
789
+ <span class="w"> </span><span class="p">};</span>
790
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
1010
791
  </pre></div>
1011
792
  </div>
1012
793
  </div>
1013
794
  </dd></dl>
1014
795
 
1015
- </section>
1016
- <section id="getunits">
1017
- <h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
1018
796
  <dl class="js function">
1019
- <dt class="sig sig-object js" id="Factor.getUnits">
1020
- <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>
1021
- <dd><p>Retrieves available units for a specific emission factor type.</p>
797
+ <dt class="sig sig-object js" id="EconomicActivity.calculate">
798
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">EconomicActivity</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EconomicActivity.calculate" title="Link to this definition">¶</a></dt>
799
+ <dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.</p>
1022
800
  <dl class="field-list simple">
1023
801
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1024
802
  <dd class="field-odd"><ul class="simple">
1025
- <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>
803
+ <li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the API</p></li>
1026
804
  </ul>
1027
805
  </dd>
1028
806
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1029
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;UnitResponse&gt;</span> – A promise that resolves to a UnitResponse containing the available units</p>
807
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;EmissionResponse | EmissionResponseWithDetails&gt;</span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
1030
808
  </dd>
1031
809
  </dl>
1032
810
  <div class="admonition-example admonition">
1033
811
  <p class="admonition-title">Example</p>
1034
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the &quot;Natural Gas - Scope 3:AAA&quot; emission factor type with subtype</span>
1035
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Natural Gas - Scope 3:AAA&quot;</span><span class="p">);</span>
1036
-
1037
- <span class="c1">// Get units for the &quot;HFC-263fb&quot; emission factor type without subtype</span>
1038
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;HFC-263fb&quot;</span><span class="p">);</span>
812
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
813
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
814
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span>
815
+ <span class="w"> </span><span class="p">},</span>
816
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
817
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
818
+ <span class="w"> </span><span class="p">},</span>
819
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
820
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
821
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
822
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
823
+ <span class="w"> </span><span class="p">},</span>
824
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
825
+ <span class="w"> </span><span class="p">};</span>
826
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
1039
827
  </pre></div>
1040
828
  </div>
1041
829
  </div>
1042
830
  </dd></dl>
1043
831
 
832
+ </section>
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>
839
+ </ul>
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>
1044
843
  <dl class="js function">
1045
- <dt class="sig sig-object js" id="Calculation.getUnits">
1046
- <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">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="#Calculation.getUnits" title="Link to this definition">¶</a></dt>
1047
- <dd><p>Retrieves available units for a specific calculation type.</p>
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>
1048
847
  <dl class="field-list simple">
1049
848
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1050
849
  <dd class="field-odd"><ul class="simple">
1051
- <li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The calculation type to get units for</p></li>
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>
1052
851
  </ul>
1053
852
  </dd>
1054
853
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1055
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;UnitResponse&gt;</span> – A promise that resolves to a UnitResponse containing the available units</p>
854
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available types</p>
1056
855
  </dd>
1057
856
  </dl>
1058
857
  <div class="admonition-example admonition">
1059
858
  <p class="admonition-title">Example</p>
1060
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the &quot;Natural Gas - Scope 3:AAA&quot; emission calculation type with subtype</span>
1061
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Natural Gas - Scope 3:AAA&quot;</span><span class="p">);</span>
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>
1062
861
 
1063
- <span class="c1">// Get units for the &quot;HFC-263fb&quot; emission calculation type without subtype</span>
1064
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;HFC-263fb&quot;</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">&#39;location&#39;</span><span class="p">);</span>
1065
864
  </pre></div>
1066
865
  </div>
1067
866
  </div>
1068
867
  </dd></dl>
1069
868
 
1070
869
  <dl class="js function">
1071
- <dt class="sig sig-object js" id="Location.getUnits">
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">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>
1073
- <dd><p>Retrieves available units for a specific location-based calculation type.</p>
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>
1074
873
  <dl class="field-list simple">
1075
874
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1076
875
  <dd class="field-odd"><ul class="simple">
1077
- <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>
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>
1078
877
  </ul>
1079
878
  </dd>
1080
879
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1081
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;UnitResponse&gt;</span> – A promise that resolves to a UnitResponse containing the available units</p>
880
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;TypeResponse&gt;</span> – A promise that resolves to a TypeResponse containing the available types</p>
1082
881
  </dd>
1083
882
  </dl>
1084
883
  <div class="admonition-example admonition">
1085
884
  <p class="admonition-title">Example</p>
1086
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the &quot;electricity&quot; location type</span>
1087
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;electricity&quot;</span><span class="p">);</span>
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>
887
+
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">&#39;stationary&#39;</span><span class="p">);</span>
1088
890
  </pre></div>
1089
891
  </div>
1090
892
  </div>
1091
893
  </dd></dl>
1092
894
 
895
+ </section>
896
+ <section id="getarea">
897
+ <h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
1093
898
  <dl class="js function">
1094
- <dt class="sig sig-object js" id="Mobile.getUnits">
1095
- <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">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="#Mobile.getUnits" title="Link to this definition">¶</a></dt>
1096
- <dd><p>Retrieves available units for a specific mobile emission type.</p>
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>
1097
902
  <dl class="field-list simple">
1098
903
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1099
904
  <dd class="field-odd"><ul class="simple">
1100
- <li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The mobile emission type to get units for (e.g., “Diesel Fuel”)</p></li>
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>
1101
906
  </ul>
1102
907
  </dd>
1103
908
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1104
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;UnitResponse&gt;</span> – A promise that resolves to a UnitResponse containing the available units</p>
909
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the available locations</p>
1105
910
  </dd>
1106
911
  </dl>
1107
912
  <div class="admonition-example admonition">
1108
913
  <p class="admonition-title">Example</p>
1109
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">&quot;Cars:B20:(NE)&quot;</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">mobile</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="kd">with</span><span class="w"> </span><span class="nx">subtype</span>
1110
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Cars:B20:(NE)&quot;</span><span class="p">);</span>
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>
1111
916
 
1112
- <span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">&quot;Cars by Size - Large Car - Hybrid&quot;</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">mobile</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="nx">without</span><span class="w"> </span><span class="nx">subtype</span>
1113
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Cars by Size - Large Car - Hybrid&quot;</span><span class="p">);</span>
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">&#39;mobile&#39;</span><span class="p">);</span>
1114
919
  </pre></div>
1115
920
  </div>
1116
921
  </div>
1117
922
  </dd></dl>
1118
923
 
1119
924
  <dl class="js function">
1120
- <dt class="sig sig-object js" id="Stationary.getUnits">
1121
- <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">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="#Stationary.getUnits" title="Link to this definition">¶</a></dt>
1122
- <dd><p>Retrieves available units for a specific stationary emission type.</p>
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>
1123
928
  <dl class="field-list simple">
1124
929
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1125
930
  <dd class="field-odd"><ul class="simple">
1126
- <li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The stationary emission type to get units for (e.g., “Coal - Lignite”)</p></li>
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>
1127
932
  </ul>
1128
933
  </dd>
1129
934
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1130
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;UnitResponse&gt;</span> – A promise that resolves to a UnitResponse containing the available units</p>
935
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;AreaResponse&gt;</span> – A promise that resolves to an AreaResponse containing the available locations</p>
1131
936
  </dd>
1132
937
  </dl>
1133
938
  <div class="admonition-example admonition">
1134
939
  <p class="admonition-title">Example</p>
1135
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">&quot;Petroleum Based Greases - NC:A&quot;</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">stationary</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="kd">with</span><span class="w"> </span><span class="nx">subtype</span>
1136
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Petroleum Based Greases - NC:A&quot;</span><span class="p">);</span>
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>
1137
942
 
1138
- <span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">&quot;Jet Kerosene&quot;</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">stationary</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="nx">without</span><span class="w"> </span><span class="nx">subtype</span>
1139
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Jet Kerosene&quot;</span><span class="p">);</span>
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">&#39;fugitive&#39;</span><span class="p">);</span>
1140
945
  </pre></div>
1141
946
  </div>
1142
947
  </div>
1143
948
  </dd></dl>
1144
949
 
950
+ </section>
951
+ <section id="getunits">
952
+ <h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
1145
953
  <dl class="js function">
1146
- <dt class="sig sig-object js" id="TransportationAndDistribution.getUnits">
1147
- <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">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="#TransportationAndDistribution.getUnits" title="Link to this definition">¶</a></dt>
1148
- <dd><p>Retrieves available units for a specific transportation and distribution calculation type.</p>
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>
1149
957
  <dl class="field-list simple">
1150
958
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1151
959
  <dd class="field-odd"><ul class="simple">
1152
- <li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The transportation and distribution calculation type to get units for (e.g., “Freight - Cargo Ship”)</p></li>
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>
1153
961
  </ul>
1154
962
  </dd>
1155
963
  <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -1158,24 +966,24 @@ Only refreshes if the token was not provided by the user and is expiring within
1158
966
  </dl>
1159
967
  <div class="admonition-example admonition">
1160
968
  <p class="admonition-title">Example</p>
1161
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the &quot;Business Travel - Cars:Diesel - Small&quot; transportation and distribution type without subtype</span>
1162
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Business Travel - Cars:Diesel - Small&quot;</span><span class="p">);</span>
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>
1163
971
 
1164
- <span class="c1">// Get units for the &quot;Business Travel - Cars&quot; transportation and distribution type with subtype</span>
1165
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Business Travel - Cars&quot;</span><span class="p">);</span>
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">&#39;Natural Gas&#39;</span><span class="p">);</span>
1166
974
  </pre></div>
1167
975
  </div>
1168
976
  </div>
1169
977
  </dd></dl>
1170
978
 
1171
979
  <dl class="js function">
1172
- <dt class="sig sig-object js" id="Fugitive.getUnits">
1173
- <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">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="#Fugitive.getUnits" title="Link to this definition">¶</a></dt>
1174
- <dd><p>Retrieves available units for a specific fugitive emission type.</p>
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>
1175
983
  <dl class="field-list simple">
1176
984
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1177
985
  <dd class="field-odd"><ul class="simple">
1178
- <li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The fugitive emission type to get units for (e.g., “R134A”)</p></li>
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>
1179
987
  </ul>
1180
988
  </dd>
1181
989
  <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -1184,11 +992,11 @@ Only refreshes if the token was not provided by the user and is expiring within
1184
992
  </dl>
1185
993
  <div class="admonition-example admonition">
1186
994
  <p class="admonition-title">Example</p>
1187
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the &quot;Natural Gas - Scope 3:AAA&quot; emission fugitive type with subtype</span>
1188
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;Natural Gas - Scope 3:AAA&quot;</span><span class="p">);</span>
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>
1189
997
 
1190
- <span class="c1">// Get units for the &quot;R-426A&quot; emission fugitive type without subtype</span>
1191
- <span class="kd">const</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getUnits</span><span class="p">(</span><span class="s2">&quot;R-426A&quot;</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">&#39;Jet Kerosene&#39;</span><span class="p">);</span>
1192
1000
  </pre></div>
1193
1001
  </div>
1194
1002
  </div>
@@ -1521,38 +1329,24 @@ Used to find relevant factors or activities based on location, time, and search
1521
1329
  <li><a class="reference internal" href="#Mobile.calculate"><code class="docutils literal notranslate"><span class="pre">Mobile.calculate()</span></code></a></li>
1522
1330
  <li><a class="reference internal" href="#Stationary.calculate"><code class="docutils literal notranslate"><span class="pre">Stationary.calculate()</span></code></a></li>
1523
1331
  <li><a class="reference internal" href="#TransportationAndDistribution.calculate"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.calculate()</span></code></a></li>
1332
+ <li><a class="reference internal" href="#RealEstate.calculate"><code class="docutils literal notranslate"><span class="pre">RealEstate.calculate()</span></code></a></li>
1333
+ <li><a class="reference internal" href="#EconomicActivity.calculate"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></a></li>
1524
1334
  </ul>
1525
1335
  </li>
1526
- <li><a class="reference internal" href="#metadata-apis">Metadata APIs</a><ul>
1336
+ <li><a class="reference internal" href="#global-metadata-api">Global Metadata API</a><ul>
1527
1337
  <li><a class="reference internal" href="#gettypes">getTypes</a><ul>
1528
- <li><a class="reference internal" href="#Factor.getTypes"><code class="docutils literal notranslate"><span class="pre">Factor.getTypes()</span></code></a></li>
1529
- <li><a class="reference internal" href="#Calculation.getTypes"><code class="docutils literal notranslate"><span class="pre">Calculation.getTypes()</span></code></a></li>
1530
- <li><a class="reference internal" href="#Location.getTypes"><code class="docutils literal notranslate"><span class="pre">Location.getTypes()</span></code></a></li>
1531
- <li><a class="reference internal" href="#Mobile.getTypes"><code class="docutils literal notranslate"><span class="pre">Mobile.getTypes()</span></code></a></li>
1532
- <li><a class="reference internal" href="#Stationary.getTypes"><code class="docutils literal notranslate"><span class="pre">Stationary.getTypes()</span></code></a></li>
1533
- <li><a class="reference internal" href="#TransportationAndDistribution.getTypes"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getTypes()</span></code></a></li>
1534
- <li><a class="reference internal" href="#Fugitive.getTypes"><code class="docutils literal notranslate"><span class="pre">Fugitive.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>
1535
1340
  </ul>
1536
1341
  </li>
1537
1342
  <li><a class="reference internal" href="#getarea">getArea</a><ul>
1538
- <li><a class="reference internal" href="#Factor.getArea"><code class="docutils literal notranslate"><span class="pre">Factor.getArea()</span></code></a></li>
1539
- <li><a class="reference internal" href="#Factor.getSearchArea"><code class="docutils literal notranslate"><span class="pre">Factor.getSearchArea()</span></code></a></li>
1540
- <li><a class="reference internal" href="#Calculation.getArea"><code class="docutils literal notranslate"><span class="pre">Calculation.getArea()</span></code></a></li>
1541
- <li><a class="reference internal" href="#Location.getArea"><code class="docutils literal notranslate"><span class="pre">Location.getArea()</span></code></a></li>
1542
- <li><a class="reference internal" href="#Mobile.getArea"><code class="docutils literal notranslate"><span class="pre">Mobile.getArea()</span></code></a></li>
1543
- <li><a class="reference internal" href="#Stationary.getArea"><code class="docutils literal notranslate"><span class="pre">Stationary.getArea()</span></code></a></li>
1544
- <li><a class="reference internal" href="#TransportationAndDistribution.getArea"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getArea()</span></code></a></li>
1545
- <li><a class="reference internal" href="#Fugitive.getArea"><code class="docutils literal notranslate"><span class="pre">Fugitive.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>
1546
1345
  </ul>
1547
1346
  </li>
1548
1347
  <li><a class="reference internal" href="#getunits">getUnits</a><ul>
1549
- <li><a class="reference internal" href="#Factor.getUnits"><code class="docutils literal notranslate"><span class="pre">Factor.getUnits()</span></code></a></li>
1550
- <li><a class="reference internal" href="#Calculation.getUnits"><code class="docutils literal notranslate"><span class="pre">Calculation.getUnits()</span></code></a></li>
1551
- <li><a class="reference internal" href="#Location.getUnits"><code class="docutils literal notranslate"><span class="pre">Location.getUnits()</span></code></a></li>
1552
- <li><a class="reference internal" href="#Mobile.getUnits"><code class="docutils literal notranslate"><span class="pre">Mobile.getUnits()</span></code></a></li>
1553
- <li><a class="reference internal" href="#Stationary.getUnits"><code class="docutils literal notranslate"><span class="pre">Stationary.getUnits()</span></code></a></li>
1554
- <li><a class="reference internal" href="#TransportationAndDistribution.getUnits"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getUnits()</span></code></a></li>
1555
- <li><a class="reference internal" href="#Fugitive.getUnits"><code class="docutils literal notranslate"><span class="pre">Fugitive.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>
1556
1350
  </ul>
1557
1351
  </li>
1558
1352
  </ul>