emissions-api-sdk 1.0.12 → 1.0.14

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 (120) hide show
  1. package/README.md +65 -2
  2. package/dist/Constants.js +7 -1
  3. package/dist/api/AuditExport.js +73 -0
  4. package/dist/api/AuditLog.js +99 -0
  5. package/dist/api/EconomicActivity.js +69 -0
  6. package/dist/api/Factor.js +16 -0
  7. package/dist/api/PhysicalActivity.js +87 -0
  8. package/dist/api/RealEstate.js +25 -1
  9. package/dist/api/TypeRecommender.js +19 -2
  10. package/dist/coverage/clover.xml +172 -89
  11. package/dist/coverage/coverage-final.json +15 -8
  12. package/dist/coverage/lcov-report/index.html +21 -21
  13. package/dist/coverage/lcov-report/src/Client.ts.html +32 -32
  14. package/dist/coverage/lcov-report/src/Constants.ts.html +45 -27
  15. package/dist/coverage/lcov-report/src/api/AuditExport.ts.html +355 -0
  16. package/dist/coverage/lcov-report/src/api/AuditLog.ts.html +388 -0
  17. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
  18. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +212 -5
  19. package/dist/coverage/lcov-report/src/api/Factor.ts.html +54 -3
  20. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  21. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
  22. package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
  23. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
  24. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
  25. package/dist/coverage/lcov-report/src/api/PhysicalActivity.ts.html +361 -0
  26. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +78 -6
  27. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
  28. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
  29. package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +55 -4
  30. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  31. package/dist/coverage/lcov-report/src/api/index.html +51 -6
  32. package/dist/coverage/lcov-report/src/index.html +7 -7
  33. package/dist/coverage/lcov-report/src/request.ts.html +8 -5
  34. package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
  35. package/dist/coverage/lcov-report/test/index.html +1 -1
  36. package/dist/coverage/lcov-report/test/mocks/AttributionRequest.ts.html +151 -0
  37. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  38. package/dist/coverage/lcov-report/test/mocks/EconomicActivityAttributionRequest.ts.html +148 -0
  39. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  40. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  41. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  42. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityEVICRequest.ts.html +148 -0
  43. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityRequest.ts.html +151 -0
  44. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
  45. package/dist/coverage/lcov-report/test/mocks/index.html +63 -3
  46. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  47. package/dist/coverage/lcov.info +284 -124
  48. package/dist/index.js +4 -1
  49. package/dist/interfaces/response/AuditExportResponse.js +2 -0
  50. package/dist/interfaces/response/AuditLogResponse.js +2 -0
  51. package/dist/request.js +1 -0
  52. package/dist/types/Constants.d.ts +6 -0
  53. package/dist/types/api/AuditExport.d.ts +42 -0
  54. package/dist/types/api/AuditLog.d.ts +37 -0
  55. package/dist/types/api/EconomicActivity.d.ts +69 -0
  56. package/dist/types/api/Factor.d.ts +16 -0
  57. package/dist/types/api/PhysicalActivity.d.ts +76 -0
  58. package/dist/types/api/RealEstate.d.ts +25 -1
  59. package/dist/types/api/TypeRecommender.d.ts +19 -2
  60. package/dist/types/index.d.ts +6 -0
  61. package/dist/types/interfaces/Api.d.ts +17 -1
  62. package/dist/types/interfaces/Config.d.ts +5 -1
  63. package/dist/types/interfaces/common.d.ts +40 -0
  64. package/dist/types/interfaces/response/AuditExportResponse.d.ts +66 -0
  65. package/dist/types/interfaces/response/AuditLogResponse.d.ts +40 -0
  66. package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +2 -0
  67. package/docs/_sources/authentication.rst.txt +26 -4
  68. package/docs/_sources/getting_started.rst.txt +762 -74
  69. package/docs/_sources/index.rst.txt +13 -0
  70. package/docs/_sources/reference.rst.txt +48 -0
  71. package/docs/_sources/troubleshooting.rst.txt +77 -12
  72. package/docs/_static/basic.css +8 -0
  73. package/docs/_static/doctools.js +5 -6
  74. package/docs/_static/language_data.js +186 -7
  75. package/docs/_static/pygments.css +146 -164
  76. package/docs/_static/searchtools.js +60 -121
  77. package/docs/_static/sphinx_highlight.js +31 -36
  78. package/docs/_static/styles/furo.css +1 -1
  79. package/docs/_static/styles/furo.css.map +1 -1
  80. package/docs/authentication.html +61 -26
  81. package/docs/client.html +33 -22
  82. package/docs/genindex.html +77 -24
  83. package/docs/getting_started.html +969 -103
  84. package/docs/index.html +69 -21
  85. package/docs/reference.html +747 -66
  86. package/docs/sdk.html +32 -21
  87. package/docs/search.html +32 -21
  88. package/docs/searchindex.js +1 -1
  89. package/docs/troubleshooting.html +105 -38
  90. package/package.json +8 -3
  91. package/sphinx-build/source/authentication.rst +26 -4
  92. package/sphinx-build/source/getting_started.rst +762 -74
  93. package/sphinx-build/source/index.rst +13 -0
  94. package/sphinx-build/source/reference.rst +48 -0
  95. package/sphinx-build/source/troubleshooting.rst +77 -12
  96. package/src/Constants.ts +6 -0
  97. package/src/api/AuditExport.ts +90 -0
  98. package/src/api/AuditLog.ts +102 -0
  99. package/src/api/EconomicActivity.ts +69 -0
  100. package/src/api/Factor.ts +17 -1
  101. package/src/api/PhysicalActivity.ts +92 -0
  102. package/src/api/RealEstate.ts +25 -1
  103. package/src/api/TypeRecommender.ts +19 -2
  104. package/src/index.ts +15 -1
  105. package/src/interfaces/Api.ts +22 -6
  106. package/src/interfaces/Config.ts +6 -1
  107. package/src/interfaces/common.ts +46 -0
  108. package/src/interfaces/response/AuditExportResponse.ts +88 -0
  109. package/src/interfaces/response/AuditLogResponse.ts +47 -0
  110. package/src/interfaces/response/TypeRecommenderResponse.ts +3 -0
  111. package/src/request.ts +1 -0
  112. package/test/apiTest.test.ts +59 -3
  113. package/test/auditExport.test.ts +68 -0
  114. package/test/auditLog.test.ts +216 -0
  115. package/test/mocks/AttributionRequest.ts +23 -0
  116. package/test/mocks/EconomicActivityAttributionRequest.ts +22 -0
  117. package/test/mocks/PhysicalActivityEVICRequest.ts +22 -0
  118. package/test/mocks/PhysicalActivityRequest.ts +23 -0
  119. package/docs/_static/base-stemmer.js +0 -476
  120. package/docs/_static/english-stemmer.js +0 -1066
package/docs/authentication.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="Reference" href="reference.html"><link rel="prev" title="Client" href="client.html">
6
+ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Reference" href="reference.html" /><link rel="prev" title="Client" href="client.html" />
7
7
 
8
- <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
8
+ <!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 -->
9
9
  <title>Authentication - 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=7bdb33bb" />
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,11 +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"><a class="reference internal" href="sdk.html">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 class="current">
205
+ <li class="toctree-l1 current has-children"><a class="reference internal" href="sdk.html">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 class="current">
199
206
  <li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
200
- <li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Authentication</a></li>
207
+ <li class="toctree-l2 current"><a class="current reference internal" href="#">Authentication</a></li>
201
208
  </ul>
202
209
  </li>
210
+ <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Authentication</a></li>
211
+ <li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
203
212
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
204
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
205
214
  </ul>
@@ -228,7 +237,8 @@
228
237
  </a>
229
238
  </div>
230
239
  <div class="theme-toggle-container theme-toggle-content">
231
- <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
240
+ <button class="theme-toggle">
241
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
232
242
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
233
243
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
234
244
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -236,7 +246,8 @@
236
246
  </button>
237
247
  </div>
238
248
  <label class="toc-overlay-icon toc-content-icon" for="__toc">
239
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
249
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
250
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
240
251
  </label>
241
252
  </div>
242
253
  <article role="main" id="furo-main-content">
@@ -248,9 +259,32 @@
248
259
  </section>
249
260
  <section id="authentication-methods">
250
261
  <h2>Authentication Methods<a class="headerlink" href="#authentication-methods" title="Link to this heading">¶</a></h2>
251
- <p>The SDK provides two authentication methods:</p>
252
- <section id="api-key-authentication-recommended">
253
- <h3>API Key Authentication (Recommended)<a class="headerlink" href="#api-key-authentication-recommended" title="Link to this heading">¶</a></h3>
262
+ <p>The SDK provides three authentication methods:</p>
263
+ <section id="personal-access-token-pat-authentication-recommended">
264
+ <h3>Personal Access Token (PAT) Authentication (Recommended)<a class="headerlink" href="#personal-access-token-pat-authentication-recommended" title="Link to this heading">¶</a></h3>
265
+ <p>This method uses a personal access token directly:</p>
266
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Client</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">&#39;emissions-api-sdk&#39;</span><span class="p">;</span>
267
+
268
+ <span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
269
+ <span class="w"> </span><span class="nx">patToken</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_PAT_TOKEN</span><span class="p">,</span>
270
+ <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_CLIENT_ID</span>
271
+ <span class="p">});</span>
272
+ </pre></div>
273
+ </div>
274
+ <dl class="simple">
275
+ <dt><strong>Required parameters:</strong></dt><dd><ul class="simple">
276
+ <li><p><code class="docutils literal notranslate"><span class="pre">patToken</span></code>: Your personal access token</p></li>
277
+ <li><p><code class="docutils literal notranslate"><span class="pre">clientId</span></code>: Your client identifier</p></li>
278
+ </ul>
279
+ </dd>
280
+ </dl>
281
+ <div class="admonition note">
282
+ <p class="admonition-title">Note</p>
283
+ <p>When using a PAT token, do not provide <code class="docutils literal notranslate"><span class="pre">orgId</span></code>.</p>
284
+ </div>
285
+ </section>
286
+ <section id="api-key-authentication">
287
+ <h3>API Key Authentication<a class="headerlink" href="#api-key-authentication" title="Link to this heading">¶</a></h3>
254
288
  <p>This method automatically handles token generation and refreshing:</p>
255
289
  <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Client</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">&#39;emissions-api-sdk&#39;</span><span class="p">;</span>
256
290
 
@@ -481,7 +515,8 @@
481
515
  <li><a class="reference internal" href="#">Authentication</a><ul>
482
516
  <li><a class="reference internal" href="#overview">Overview</a></li>
483
517
  <li><a class="reference internal" href="#authentication-methods">Authentication Methods</a><ul>
484
- <li><a class="reference internal" href="#api-key-authentication-recommended">API Key Authentication (Recommended)</a><ul>
518
+ <li><a class="reference internal" href="#personal-access-token-pat-authentication-recommended">Personal Access Token (PAT) Authentication (Recommended)</a></li>
519
+ <li><a class="reference internal" href="#api-key-authentication">API Key Authentication</a><ul>
485
520
  <li><a class="reference internal" href="#token-retrieval">Token retrieval</a></li>
486
521
  </ul>
487
522
  </li>
@@ -507,8 +542,8 @@
507
542
  </aside>
508
543
  </div>
509
544
  </div><script src="_static/documentation_options.js?v=5929fcd5"></script>
510
- <script src="_static/doctools.js?v=fd6eb6e6"></script>
511
- <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
545
+ <script src="_static/doctools.js?v=9bcbadda"></script>
546
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
512
547
  <script src="_static/scripts/furo.js?v=46bd48cc"></script>
513
548
  </body>
514
549
  </html>
package/docs/client.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="Authentication" href="authentication.html"><link rel="prev" title="SDK" href="sdk.html">
6
+ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Authentication" href="authentication.html" /><link rel="prev" title="SDK" href="sdk.html" />
7
7
 
8
- <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
8
+ <!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 -->
9
9
  <title>Client - 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=7bdb33bb" />
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,11 +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"><a class="reference internal" href="sdk.html">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 class="current">
199
- <li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Client</a></li>
205
+ <li class="toctree-l1 current has-children"><a class="reference internal" href="sdk.html">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 class="current">
206
+ <li class="toctree-l2 current"><a class="current reference internal" href="#">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>
210
+ <li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
211
+ <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Client</a></li>
203
212
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
204
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
205
214
  </ul>
@@ -228,7 +237,8 @@
228
237
  </a>
229
238
  </div>
230
239
  <div class="theme-toggle-container theme-toggle-content">
231
- <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
240
+ <button class="theme-toggle">
241
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
232
242
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
233
243
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
234
244
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -236,7 +246,8 @@
236
246
  </button>
237
247
  </div>
238
248
  <label class="toc-overlay-icon toc-content-icon" for="__toc">
239
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
249
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
250
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
240
251
  </label>
241
252
  </div>
242
253
  <article role="main" id="furo-main-content">
@@ -461,8 +472,8 @@
461
472
  </aside>
462
473
  </div>
463
474
  </div><script src="_static/documentation_options.js?v=5929fcd5"></script>
464
- <script src="_static/doctools.js?v=fd6eb6e6"></script>
465
- <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
475
+ <script src="_static/doctools.js?v=9bcbadda"></script>
476
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
466
477
  <script src="_static/scripts/furo.js?v=46bd48cc"></script>
467
478
  </body>
468
479
  </html>
package/docs/genindex.html CHANGED
@@ -1,12 +1,12 @@
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">
5
- <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#"><link rel="search" title="Search" href="search.html">
3
+ <head><meta charset="utf-8"/>
4
+ <meta name="viewport" content="width=device-width,initial-scale=1"/>
5
+ <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
6
6
 
7
- <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 --><title>Index - IBM Envizi - Emissions API Node.js SDK documentation</title>
7
+ <!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 --><title>Index - IBM Envizi - Emissions API Node.js SDK documentation</title>
8
8
  <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
9
- <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
9
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=25af2a20" />
10
10
  <link rel="stylesheet" type="text/css" href="_static/sphinx_js.css" />
11
11
  <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
12
12
  <link rel="stylesheet" type="text/css" href="_static/custom.css?v=8d04aa46" />
@@ -22,14 +22,14 @@
22
22
  }
23
23
  @media not print {
24
24
  body[data-theme="dark"] {
25
- --color-code-background: #202020;
26
- --color-code-foreground: #d0d0d0;
25
+ --color-code-background: #2b2b2b;
26
+ --color-code-foreground: #f8f8f2;
27
27
 
28
28
  }
29
29
  @media (prefers-color-scheme: dark) {
30
30
  body:not([data-theme="light"]) {
31
- --color-code-background: #202020;
32
- --color-code-foreground: #d0d0d0;
31
+ --color-code-background: #2b2b2b;
32
+ --color-code-foreground: #f8f8f2;
33
33
 
34
34
  }
35
35
  }
@@ -144,10 +144,14 @@
144
144
  </symbol>
145
145
  </svg>
146
146
 
147
- <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
148
- <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
149
- <label class="overlay sidebar-overlay" for="__navigation"></label>
150
- <label class="overlay toc-overlay" for="__toc"></label>
147
+ <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
148
+ <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
149
+ <label class="overlay sidebar-overlay" for="__navigation">
150
+ <div class="visually-hidden">Hide navigation sidebar</div>
151
+ </label>
152
+ <label class="overlay toc-overlay" for="__toc">
153
+ <div class="visually-hidden">Hide table of contents sidebar</div>
154
+ </label>
151
155
 
152
156
  <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
153
157
 
@@ -157,7 +161,8 @@
157
161
  <header class="mobile-header">
158
162
  <div class="header-left">
159
163
  <label class="nav-overlay-icon" for="__navigation">
160
- <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
164
+ <div class="visually-hidden">Toggle site navigation sidebar</div>
165
+ <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
161
166
  </label>
162
167
  </div>
163
168
  <div class="header-center">
@@ -165,7 +170,8 @@
165
170
  </div>
166
171
  <div class="header-right">
167
172
  <div class="theme-toggle-container theme-toggle-header">
168
- <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
173
+ <button class="theme-toggle">
174
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
169
175
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
170
176
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
171
177
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -173,7 +179,8 @@
173
179
  </button>
174
180
  </div>
175
181
  <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
176
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
182
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
183
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
177
184
  </label>
178
185
  </div>
179
186
  </header>
@@ -193,11 +200,13 @@
193
200
  <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
194
201
  <ul>
195
202
  <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
196
- <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>
203
+ <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>
197
204
  <li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
198
205
  <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
199
206
  </ul>
200
207
  </li>
208
+ <li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
209
+ <li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
201
210
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
202
211
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
203
212
  </ul>
@@ -220,7 +229,8 @@
220
229
  </a>
221
230
  <div class="content-icon-container">
222
231
  <div class="theme-toggle-container theme-toggle-content">
223
- <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
232
+ <button class="theme-toggle">
233
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
224
234
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
225
235
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
226
236
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -228,14 +238,15 @@
228
238
  </button>
229
239
  </div>
230
240
  <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
231
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
241
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
242
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
232
243
  </label>
233
244
  </div>
234
245
  <article role="main" id="furo-main-content">
235
246
 
236
247
  <section class="genindex-section">
237
248
  <h1 id="index">Index</h1>
238
- <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a></div>
249
+ <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a></div>
239
250
  </section>
240
251
  <section id="A" class="genindex-section">
241
252
  <h2>A</h2>
@@ -249,8 +260,6 @@
249
260
  </li>
250
261
  <li><a href="reference.html#Api.FactorRequestWithoutFactorId">Api.FactorRequestWithoutFactorId() (interface)</a>
251
262
  </li>
252
- </ul></td>
253
- <td style="width: 33%; vertical-align: top;"><ul>
254
263
  <li><a href="reference.html#Api.GenericCalculationRequestWithFactorId">Api.GenericCalculationRequestWithFactorId() (interface)</a>
255
264
  </li>
256
265
  <li><a href="reference.html#Api.GenericCalculationRequestWithoutFactorId">Api.GenericCalculationRequestWithoutFactorId() (interface)</a>
@@ -260,6 +269,30 @@
260
269
  <li><a href="reference.html#Api.LocationRequestWithoutFactorId">Api.LocationRequestWithoutFactorId() (interface)</a>
261
270
  </li>
262
271
  <li><a href="reference.html#Api.SearchRequest">Api.SearchRequest() (interface)</a>
272
+ </li>
273
+ <li><a href="reference.html#AuditExport.download">AuditExport.download() (AuditExport method)</a>
274
+ </li>
275
+ </ul></td>
276
+ <td style="width: 33%; vertical-align: top;"><ul>
277
+ <li><a href="reference.html#AuditExport.getStatus">AuditExport.getStatus() (AuditExport method)</a>
278
+ </li>
279
+ <li><a href="reference.html#AuditExport.trigger">AuditExport.trigger() (AuditExport method)</a>
280
+ </li>
281
+ <li><a href="reference.html#AuditExportResponse.AuditExportLinks">AuditExportResponse.AuditExportLinks() (interface)</a>
282
+ </li>
283
+ <li><a href="reference.html#AuditExportResponse.AuditExportRequest">AuditExportResponse.AuditExportRequest() (interface)</a>
284
+ </li>
285
+ <li><a href="reference.html#AuditExportResponse.AuditExportResponse">AuditExportResponse.AuditExportResponse() (interface)</a>
286
+ </li>
287
+ <li><a href="reference.html#AuditExportResponse.AuditExportStatusResponse">AuditExportResponse.AuditExportStatusResponse() (interface)</a>
288
+ </li>
289
+ <li><a href="reference.html#AuditLog.getAuditConfig">AuditLog.getAuditConfig() (AuditLog method)</a>
290
+ </li>
291
+ <li><a href="reference.html#AuditLog.updateAuditConfig">AuditLog.updateAuditConfig() (AuditLog method)</a>
292
+ </li>
293
+ <li><a href="reference.html#AuditLogResponse.AuditLogRequest">AuditLogResponse.AuditLogRequest() (interface)</a>
294
+ </li>
295
+ <li><a href="reference.html#AuditLogResponse.AuditLogResponse">AuditLogResponse.AuditLogResponse() (interface)</a>
263
296
  </li>
264
297
  </ul></td>
265
298
  </tr></table>
@@ -335,6 +368,8 @@
335
368
  </li>
336
369
  </ul></td>
337
370
  <td style="width: 33%; vertical-align: top;"><ul>
371
+ <li><a href="reference.html#Factor.search">Factor.search() (Factor method)</a>
372
+ </li>
338
373
  <li><a href="reference.html#Fugitive.calculate">Fugitive.calculate() (Fugitive method)</a>
339
374
  </li>
340
375
  </ul></td>
@@ -375,6 +410,16 @@
375
410
  </tr></table>
376
411
  </section>
377
412
 
413
+ <section id="P" class="genindex-section">
414
+ <h2>P</h2>
415
+ <table style="width: 100%" class="indextable genindextable"><tr>
416
+ <td style="width: 33%; vertical-align: top;"><ul>
417
+ <li><a href="reference.html#PhysicalActivity.calculate">PhysicalActivity.calculate() (PhysicalActivity method)</a>
418
+ </li>
419
+ </ul></td>
420
+ </tr></table>
421
+ </section>
422
+
378
423
  <section id="R" class="genindex-section">
379
424
  <h2>R</h2>
380
425
  <table style="width: 100%" class="indextable genindextable"><tr>
@@ -404,6 +449,14 @@
404
449
  <table style="width: 100%" class="indextable genindextable"><tr>
405
450
  <td style="width: 33%; vertical-align: top;"><ul>
406
451
  <li><a href="reference.html#TransportationAndDistribution.calculate">TransportationAndDistribution.calculate() (TransportationAndDistribution method)</a>
452
+ </li>
453
+ <li><a href="reference.html#TypeRecommender.search">TypeRecommender.search() (TypeRecommender method)</a>
454
+ </li>
455
+ </ul></td>
456
+ <td style="width: 33%; vertical-align: top;"><ul>
457
+ <li><a href="reference.html#TypeRecommenderResponse.ActivityRequest">TypeRecommenderResponse.ActivityRequest() (interface)</a>
458
+ </li>
459
+ <li><a href="reference.html#TypeRecommenderResponse.TypeRecommenderResponse">TypeRecommenderResponse.TypeRecommenderResponse() (interface)</a>
407
460
  </li>
408
461
  </ul></td>
409
462
  </tr></table>
@@ -456,8 +509,8 @@
456
509
  </aside>
457
510
  </div>
458
511
  </div><script src="_static/documentation_options.js?v=5929fcd5"></script>
459
- <script src="_static/doctools.js?v=fd6eb6e6"></script>
460
- <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
512
+ <script src="_static/doctools.js?v=9bcbadda"></script>
513
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
461
514
  <script src="_static/scripts/furo.js?v=46bd48cc"></script>
462
515
  </body>
463
516
  </html>