emissions-api-sdk 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/dist/api/Calculation.js +4 -4
  2. package/dist/api/Factor.js +7 -7
  3. package/dist/api/FactorSets.js +1 -1
  4. package/dist/api/Fugitive.js +4 -4
  5. package/dist/api/Location.js +4 -4
  6. package/dist/api/Mobile.js +4 -6
  7. package/dist/api/Stationary.js +4 -4
  8. package/dist/api/TransportationAndDistribution.js +5 -5
  9. package/dist/coverage/clover.xml +335 -0
  10. package/dist/coverage/coverage-final.json +19 -0
  11. package/dist/coverage/lcov-report/base.css +224 -0
  12. package/dist/coverage/lcov-report/block-navigation.js +87 -0
  13. package/dist/coverage/lcov-report/favicon.png +0 -0
  14. package/dist/coverage/lcov-report/index.html +161 -0
  15. package/dist/coverage/lcov-report/prettify.css +1 -0
  16. package/dist/coverage/lcov-report/prettify.js +2 -0
  17. package/dist/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  18. package/dist/coverage/lcov-report/sorter.js +210 -0
  19. package/dist/coverage/lcov-report/src/Client.ts.html +838 -0
  20. package/dist/coverage/lcov-report/src/Constants.ts.html +208 -0
  21. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +436 -0
  22. package/dist/coverage/lcov-report/src/api/Factor.ts.html +622 -0
  23. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +157 -0
  24. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +436 -0
  25. package/dist/coverage/lcov-report/src/api/Location.ts.html +433 -0
  26. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +448 -0
  27. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +442 -0
  28. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +436 -0
  29. package/dist/coverage/lcov-report/src/api/index.html +221 -0
  30. package/dist/coverage/lcov-report/src/index.html +161 -0
  31. package/dist/coverage/lcov-report/src/request.ts.html +235 -0
  32. package/dist/coverage/lcov-report/src/utils.ts.html +139 -0
  33. package/dist/coverage/lcov-report/test/index.html +116 -0
  34. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +142 -0
  35. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +133 -0
  36. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +142 -0
  37. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +139 -0
  38. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +142 -0
  39. package/dist/coverage/lcov-report/test/mocks/index.html +176 -0
  40. package/dist/coverage/lcov-report/test/testUtils.ts.html +97 -0
  41. package/dist/coverage/lcov.info +558 -0
  42. package/dist/interfaces/response/AreaResponse.js +2 -0
  43. package/dist/interfaces/response/EmissionResponse.js +2 -0
  44. package/dist/interfaces/response/EmissionResponseWithDetails.js +2 -0
  45. package/dist/interfaces/response/FactorResponse.js +2 -0
  46. package/dist/interfaces/response/FactorSetResponse.js +2 -0
  47. package/dist/interfaces/response/SearchResponse.js +2 -0
  48. package/dist/interfaces/response/TypeResponse.js +2 -0
  49. package/dist/interfaces/response/UnitResponse.js +2 -0
  50. package/dist/types/api/Calculation.d.ts +13 -8
  51. package/dist/types/api/Factor.d.ts +18 -13
  52. package/dist/types/api/FactorSets.d.ts +3 -2
  53. package/dist/types/api/Fugitive.d.ts +13 -8
  54. package/dist/types/api/Location.d.ts +13 -8
  55. package/dist/types/api/Mobile.d.ts +13 -10
  56. package/dist/types/api/Stationary.d.ts +13 -8
  57. package/dist/types/api/TransportationAndDistribution.d.ts +14 -9
  58. package/dist/types/index.d.ts +8 -0
  59. package/dist/types/interfaces/response/AreaResponse.d.ts +20 -0
  60. package/dist/types/interfaces/response/EmissionResponse.d.ts +31 -0
  61. package/dist/types/interfaces/response/EmissionResponseWithDetails.d.ts +144 -0
  62. package/dist/types/interfaces/response/FactorResponse.d.ts +53 -0
  63. package/dist/types/interfaces/response/FactorSetResponse.d.ts +38 -0
  64. package/dist/types/interfaces/response/SearchResponse.d.ts +41 -0
  65. package/dist/types/interfaces/response/TypeResponse.d.ts +7 -0
  66. package/dist/types/interfaces/response/UnitResponse.d.ts +7 -0
  67. package/docs/_sources/index.rst.txt +1 -0
  68. package/docs/_sources/troubleshooting.rst.txt +486 -0
  69. package/docs/_static/basic.css +8 -0
  70. package/docs/_static/pygments.css +146 -164
  71. package/docs/_static/searchtools.js +5 -8
  72. package/docs/_static/styles/furo.css +1 -1
  73. package/docs/_static/styles/furo.css.map +1 -1
  74. package/docs/authentication.html +29 -19
  75. package/docs/client.html +29 -19
  76. package/docs/genindex.html +29 -19
  77. package/docs/getting_started.html +29 -19
  78. package/docs/index.html +42 -19
  79. package/docs/objects.inv +0 -0
  80. package/docs/reference.html +69 -53
  81. package/docs/sdk.html +29 -19
  82. package/docs/search.html +29 -19
  83. package/docs/searchindex.js +1 -1
  84. package/docs/troubleshooting.html +786 -0
  85. package/package.json +1 -1
  86. package/sphinx-build/requirements.txt +5 -0
  87. package/sphinx-build/source/index.rst +1 -0
  88. package/sphinx-build/source/troubleshooting.rst +486 -0
  89. package/src/api/Calculation.ts +19 -14
  90. package/src/api/Factor.ts +27 -22
  91. package/src/api/FactorSets.ts +4 -3
  92. package/src/api/Fugitive.ts +19 -14
  93. package/src/api/Location.ts +20 -15
  94. package/src/api/Mobile.ts +19 -16
  95. package/src/api/Stationary.ts +19 -14
  96. package/src/api/TransportationAndDistribution.ts +21 -16
  97. package/src/index.ts +33 -1
  98. package/src/interfaces/response/AreaResponse.ts +25 -0
  99. package/src/interfaces/response/EmissionResponse.ts +44 -0
  100. package/src/interfaces/response/EmissionResponseWithDetails.ts +183 -0
  101. package/src/interfaces/response/FactorResponse.ts +78 -0
  102. package/src/interfaces/response/FactorSetResponse.ts +52 -0
  103. package/src/interfaces/response/SearchResponse.ts +52 -0
  104. package/src/interfaces/response/TypeResponse.ts +7 -0
  105. package/src/interfaces/response/UnitResponse.ts +7 -0
  106. package/test/apiTest.test.ts +1 -1
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"><link rel="search" title="Search" href="search.html"><link rel="prev" title="Authentication" href="authentication.html">
6
+ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Troubleshooting Guide" href="troubleshooting.html" /><link rel="prev" title="Authentication" href="authentication.html" />
7
7
 
8
- <!-- 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,12 +202,13 @@
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>
202
209
  </li>
203
210
  <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reference</a></li>
211
+ <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
204
212
  </ul>
205
213
 
206
214
  </div>
@@ -227,7 +235,8 @@
227
235
  </a>
228
236
  </div>
229
237
  <div class="theme-toggle-container theme-toggle-content">
230
- <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>
231
240
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
232
241
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
233
242
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -235,7 +244,8 @@
235
244
  </button>
236
245
  </div>
237
246
  <label class="toc-overlay-icon toc-content-icon" for="__toc">
238
- <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>
239
249
  </label>
240
250
  </div>
241
251
  <article role="main" id="furo-main-content">
@@ -495,7 +505,7 @@ Only refreshes if the token was not provided by the user and is expiring within
495
505
  </ul>
496
506
  </dd>
497
507
  <dt class="field-even">Returns<span class="colon">:</span></dt>
498
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to the factor string returned by the API</p>
508
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;FactorResponse&gt;</span> – A promise that resolves to the FactorResponse returned by the API</p>
499
509
  </dd>
500
510
  </dl>
501
511
  <div class="admonition-example admonition">
@@ -538,7 +548,7 @@ Only refreshes if the token was not provided by the user and is expiring within
538
548
  </ul>
539
549
  </dd>
540
550
  <dt class="field-even">Returns<span class="colon">:</span></dt>
541
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to the calculation result string returned by the API</p>
551
+ <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>
542
552
  </dd>
543
553
  </dl>
544
554
  <div class="admonition-example admonition">
@@ -574,7 +584,7 @@ Only refreshes if the token was not provided by the user and is expiring within
574
584
  </ul>
575
585
  </dd>
576
586
  <dt class="field-even">Returns<span class="colon">:</span></dt>
577
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to the calculation result string returned by the API</p>
587
+ <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>
578
588
  </dd>
579
589
  </dl>
580
590
  <div class="admonition-example admonition">
@@ -611,7 +621,7 @@ Only refreshes if the token was not provided by the user and is expiring within
611
621
  </ul>
612
622
  </dd>
613
623
  <dt class="field-even">Returns<span class="colon">:</span></dt>
614
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to the purchased energy emission result string returned by the API</p>
624
+ <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>
615
625
  </dd>
616
626
  </dl>
617
627
  <div class="admonition-example admonition">
@@ -648,7 +658,7 @@ Only refreshes if the token was not provided by the user and is expiring within
648
658
  </ul>
649
659
  </dd>
650
660
  <dt class="field-even">Returns<span class="colon">:</span></dt>
651
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to the calculation result string returned by the API</p>
661
+ <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>
652
662
  </dd>
653
663
  </dl>
654
664
  <div class="admonition-example admonition">
@@ -685,7 +695,7 @@ Only refreshes if the token was not provided by the user and is expiring within
685
695
  </ul>
686
696
  </dd>
687
697
  <dt class="field-even">Returns<span class="colon">:</span></dt>
688
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to the calculation result string returned by the API</p>
698
+ <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>
689
699
  </dd>
690
700
  </dl>
691
701
  <div class="admonition-example admonition">
@@ -714,7 +724,7 @@ Only refreshes if the token was not provided by the user and is expiring within
714
724
  <dl class="js function">
715
725
  <dt class="sig sig-object js" id="TransportationAndDistribution.calculate">
716
726
  <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">TransportationAndDistribution</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TransportationAndDistribution.calculate" title="Link to this definition">¶</a></dt>
717
- <dd><p>Performs Scope 2 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.</p>
727
+ <dd><p>Performs Scope 3 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.</p>
718
728
  <dl class="field-list simple">
719
729
  <dt class="field-odd">Arguments<span class="colon">:</span></dt>
720
730
  <dd class="field-odd"><ul class="simple">
@@ -722,7 +732,7 @@ Only refreshes if the token was not provided by the user and is expiring within
722
732
  </ul>
723
733
  </dd>
724
734
  <dt class="field-even">Returns<span class="colon">:</span></dt>
725
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to the calculation result string returned by the API</p>
735
+ <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>
726
736
  </dd>
727
737
  </dl>
728
738
  <div class="admonition-example admonition">
@@ -758,7 +768,7 @@ Only refreshes if the token was not provided by the user and is expiring within
758
768
  <dd><p>Retrieves available emission factor types by making a GET request to the API endpoint.</p>
759
769
  <dl class="field-list simple">
760
770
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
761
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available emission factor types</p>
771
+ <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>
762
772
  </dd>
763
773
  </dl>
764
774
  <div class="admonition-example admonition">
@@ -775,7 +785,7 @@ Only refreshes if the token was not provided by the user and is expiring within
775
785
  <dd><p>Retrieves available calculation types by making a GET request to the calculation types API endpoint.</p>
776
786
  <dl class="field-list simple">
777
787
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
778
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available calculation types</p>
788
+ <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>
779
789
  </dd>
780
790
  </dl>
781
791
  <div class="admonition-example admonition">
@@ -792,7 +802,7 @@ Only refreshes if the token was not provided by the user and is expiring within
792
802
  <dd><p>Retrieves available location-based calculation types by making a GET request to the location types API endpoint.</p>
793
803
  <dl class="field-list simple">
794
804
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
795
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available location-based calculation types</p>
805
+ <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>
796
806
  </dd>
797
807
  </dl>
798
808
  <div class="admonition-example admonition">
@@ -809,15 +819,13 @@ Only refreshes if the token was not provided by the user and is expiring within
809
819
  <dd><p>Retrieves available mobile emission calculation types by making a GET request to the API endpoint.</p>
810
820
  <dl class="field-list simple">
811
821
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
812
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available mobile emission types</p>
822
+ <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>
813
823
  </dd>
814
824
  </dl>
815
825
  <div class="admonition-example admonition">
816
826
  <p class="admonition-title">Example</p>
817
827
  <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get all available mobile emission types</span>
818
828
  <span class="kd">const</span><span class="w"> </span><span class="nx">types</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getTypes</span><span class="p">();</span>
819
- <span class="kd">const</span><span class="w"> </span><span class="nx">typesData</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">types</span><span class="p">);</span>
820
- <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;Available mobile emission types:&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">typesData</span><span class="p">);</span>
821
829
  </pre></div>
822
830
  </div>
823
831
  </div>
@@ -829,7 +837,7 @@ Only refreshes if the token was not provided by the user and is expiring within
829
837
  <dd><p>Retrieves available stationary emission calculation types by making a GET request to the API endpoint.</p>
830
838
  <dl class="field-list simple">
831
839
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
832
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available stationary emission types</p>
840
+ <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>
833
841
  </dd>
834
842
  </dl>
835
843
  <div class="admonition-example admonition">
@@ -846,7 +854,7 @@ Only refreshes if the token was not provided by the user and is expiring within
846
854
  <dd><p>Retrieves available transportation and distribution calculation types by making a GET request to the API endpoint.</p>
847
855
  <dl class="field-list simple">
848
856
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
849
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available transportation and distribution calculation types</p>
857
+ <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>
850
858
  </dd>
851
859
  </dl>
852
860
  <div class="admonition-example admonition">
@@ -863,7 +871,7 @@ Only refreshes if the token was not provided by the user and is expiring within
863
871
  <dd><p>Retrieves available fugitive emission calculation types by making a GET request to the API endpoint.</p>
864
872
  <dl class="field-list simple">
865
873
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
866
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available fugitive emission types</p>
874
+ <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>
867
875
  </dd>
868
876
  </dl>
869
877
  <div class="admonition-example admonition">
@@ -883,7 +891,7 @@ Only refreshes if the token was not provided by the user and is expiring within
883
891
  <dd><p>Retrieves information about geographical areas supported by the factor API.</p>
884
892
  <dl class="field-list simple">
885
893
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
886
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
894
+ <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>
887
895
  </dd>
888
896
  </dl>
889
897
  <div class="admonition-example admonition">
@@ -900,12 +908,12 @@ Only refreshes if the token was not provided by the user and is expiring within
900
908
  <dd><p>Retrieves information about geographical areas supported by the factor search API.</p>
901
909
  <dl class="field-list simple">
902
910
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
903
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
911
+ <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>
904
912
  </dd>
905
913
  </dl>
906
914
  <div class="admonition-example admonition">
907
915
  <p class="admonition-title">Example</p>
908
- <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getArea</span><span class="p">();</span>
916
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getSearchArea</span><span class="p">();</span>
909
917
  </pre></div>
910
918
  </div>
911
919
  </div>
@@ -917,7 +925,7 @@ Only refreshes if the token was not provided by the user and is expiring within
917
925
  <dd><p>Retrieves information about geographical areas supported by the calculation API.</p>
918
926
  <dl class="field-list simple">
919
927
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
920
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
928
+ <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>
921
929
  </dd>
922
930
  </dl>
923
931
  <div class="admonition-example admonition">
@@ -934,7 +942,7 @@ Only refreshes if the token was not provided by the user and is expiring within
934
942
  <dd><p>Retrieves information about geographical areas supported by the location-based calculation API.</p>
935
943
  <dl class="field-list simple">
936
944
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
937
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
945
+ <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>
938
946
  </dd>
939
947
  </dl>
940
948
  <div class="admonition-example admonition">
@@ -951,7 +959,7 @@ Only refreshes if the token was not provided by the user and is expiring within
951
959
  <dd><p>Retrieves information about geographical areas supported by the mobile emissions API.</p>
952
960
  <dl class="field-list simple">
953
961
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
954
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
962
+ <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>
955
963
  </dd>
956
964
  </dl>
957
965
  <div class="admonition-example admonition">
@@ -968,7 +976,7 @@ Only refreshes if the token was not provided by the user and is expiring within
968
976
  <dd><p>Retrieves information about geographical areas supported by the stationary emissions API.</p>
969
977
  <dl class="field-list simple">
970
978
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
971
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
979
+ <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>
972
980
  </dd>
973
981
  </dl>
974
982
  <div class="admonition-example admonition">
@@ -985,7 +993,7 @@ Only refreshes if the token was not provided by the user and is expiring within
985
993
  <dd><p>Retrieves information about geographical areas supported by the transportation and distribution API.</p>
986
994
  <dl class="field-list simple">
987
995
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
988
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
996
+ <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>
989
997
  </dd>
990
998
  </dl>
991
999
  <div class="admonition-example admonition">
@@ -1002,7 +1010,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1002
1010
  <dd><p>Retrieves information about geographical areas supported by the fugitive emissions API.</p>
1003
1011
  <dl class="field-list simple">
1004
1012
  <dt class="field-odd">Returns<span class="colon">:</span></dt>
1005
- <dd class="field-odd"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the supported geographical areas</p>
1013
+ <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>
1006
1014
  </dd>
1007
1015
  </dl>
1008
1016
  <div class="admonition-example admonition">
@@ -1027,7 +1035,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1027
1035
  </ul>
1028
1036
  </dd>
1029
1037
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1030
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available units</p>
1038
+ <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>
1031
1039
  </dd>
1032
1040
  </dl>
1033
1041
  <div class="admonition-example admonition">
@@ -1053,7 +1061,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1053
1061
  </ul>
1054
1062
  </dd>
1055
1063
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1056
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available units</p>
1064
+ <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>
1057
1065
  </dd>
1058
1066
  </dl>
1059
1067
  <div class="admonition-example admonition">
@@ -1079,7 +1087,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1079
1087
  </ul>
1080
1088
  </dd>
1081
1089
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1082
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available units</p>
1090
+ <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>
1083
1091
  </dd>
1084
1092
  </dl>
1085
1093
  <div class="admonition-example admonition">
@@ -1102,7 +1110,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1102
1110
  </ul>
1103
1111
  </dd>
1104
1112
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1105
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available units</p>
1113
+ <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>
1106
1114
  </dd>
1107
1115
  </dl>
1108
1116
  <div class="admonition-example admonition">
@@ -1128,7 +1136,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1128
1136
  </ul>
1129
1137
  </dd>
1130
1138
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1131
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available units</p>
1139
+ <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>
1132
1140
  </dd>
1133
1141
  </dl>
1134
1142
  <div class="admonition-example admonition">
@@ -1154,7 +1162,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1154
1162
  </ul>
1155
1163
  </dd>
1156
1164
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1157
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available units</p>
1165
+ <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>
1158
1166
  </dd>
1159
1167
  </dl>
1160
1168
  <div class="admonition-example admonition">
@@ -1180,7 +1188,7 @@ Only refreshes if the token was not provided by the user and is expiring within
1180
1188
  </ul>
1181
1189
  </dd>
1182
1190
  <dt class="field-even">Returns<span class="colon">:</span></dt>
1183
- <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;string&gt;</span> – A promise that resolves to a string containing the available units</p>
1191
+ <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>
1184
1192
  </dd>
1185
1193
  </dl>
1186
1194
  <div class="admonition-example admonition">
@@ -1426,7 +1434,15 @@ Used to find relevant factors or activities based on location, time, and search
1426
1434
  <footer>
1427
1435
 
1428
1436
  <div class="related-pages">
1429
-
1437
+ <a class="next-page" href="troubleshooting.html">
1438
+ <div class="page-info">
1439
+ <div class="context">
1440
+ <span>Next</span>
1441
+ </div>
1442
+ <div class="title">Troubleshooting Guide</div>
1443
+ </div>
1444
+ <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
1445
+ </a>
1430
1446
  <a class="prev-page" href="authentication.html">
1431
1447
  <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
1432
1448
  <div class="page-info">
package/docs/sdk.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"><link rel="search" title="Search" href="search.html"><link rel="next" title="Client" href="client.html"><link rel="prev" title="Getting Started" href="getting_started.html">
6
+ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Client" href="client.html" /><link rel="prev" title="Getting Started" href="getting_started.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>SDK - 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 no-toc" 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,12 +202,13 @@
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 current has-children current-page"><a class="current reference internal" href="#">SDK</a><input aria-label="Toggle navigation of SDK" checked="" 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 current has-children current-page"><a class="current reference internal" href="#">SDK</a><input checked="" 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>
202
209
  </li>
203
210
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
211
+ <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
204
212
  </ul>
205
213
 
206
214
  </div>
@@ -227,7 +235,8 @@
227
235
  </a>
228
236
  </div>
229
237
  <div class="theme-toggle-container theme-toggle-content">
230
- <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>
231
240
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
232
241
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
233
242
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -235,7 +244,8 @@
235
244
  </button>
236
245
  </div>
237
246
  <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
238
- <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>
239
249
  </label>
240
250
  </div>
241
251
  <article role="main" id="furo-main-content">