emissions-api-sdk 1.0.11 → 1.0.13

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 (101) hide show
  1. package/README.md +157 -0
  2. package/dist/Constants.js +4 -1
  3. package/dist/api/AuditLog.js +99 -0
  4. package/dist/api/EconomicActivity.js +24 -0
  5. package/dist/api/Factor.js +72 -1
  6. package/dist/api/PhysicalActivity.js +87 -0
  7. package/dist/api/RealEstate.js +23 -0
  8. package/dist/api/TypeRecommender.js +67 -2
  9. package/dist/coverage/clover.xml +154 -89
  10. package/dist/coverage/coverage-final.json +15 -9
  11. package/dist/coverage/lcov-report/index.html +21 -21
  12. package/dist/coverage/lcov-report/src/Client.ts.html +32 -32
  13. package/dist/coverage/lcov-report/src/Constants.ts.html +36 -27
  14. package/dist/coverage/lcov-report/src/api/AuditLog.ts.html +388 -0
  15. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
  16. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +77 -5
  17. package/dist/coverage/lcov-report/src/api/Factor.ts.html +216 -3
  18. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  19. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
  20. package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
  21. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
  22. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
  23. package/dist/coverage/lcov-report/src/api/PhysicalActivity.ts.html +361 -0
  24. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +74 -5
  25. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
  26. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
  27. package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +199 -4
  28. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  29. package/dist/coverage/lcov-report/src/api/index.html +36 -6
  30. package/dist/coverage/lcov-report/src/index.html +7 -7
  31. package/dist/coverage/lcov-report/src/request.ts.html +5 -5
  32. package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
  33. package/dist/coverage/lcov-report/test/index.html +1 -1
  34. package/dist/coverage/lcov-report/test/mocks/AttributionRequest.ts.html +151 -0
  35. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  36. package/dist/coverage/lcov-report/test/mocks/EconomicActivityAttributionRequest.ts.html +148 -0
  37. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  38. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  39. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  40. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityEVICRequest.ts.html +148 -0
  41. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityRequest.ts.html +151 -0
  42. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +148 -4
  43. package/dist/coverage/lcov-report/test/mocks/index.html +64 -4
  44. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  45. package/dist/coverage/lcov.info +254 -124
  46. package/dist/index.js +3 -1
  47. package/dist/interfaces/response/AuditLogResponse.js +2 -0
  48. package/dist/types/Constants.d.ts +3 -0
  49. package/dist/types/api/AuditLog.d.ts +37 -0
  50. package/dist/types/api/EconomicActivity.d.ts +24 -0
  51. package/dist/types/api/Factor.d.ts +72 -1
  52. package/dist/types/api/PhysicalActivity.d.ts +76 -0
  53. package/dist/types/api/RealEstate.d.ts +23 -0
  54. package/dist/types/api/TypeRecommender.d.ts +67 -2
  55. package/dist/types/index.d.ts +4 -0
  56. package/dist/types/interfaces/Api.d.ts +17 -1
  57. package/dist/types/interfaces/common.d.ts +48 -0
  58. package/dist/types/interfaces/response/AuditLogResponse.d.ts +40 -0
  59. package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +1 -0
  60. package/docs/_sources/authentication.rst.txt +26 -4
  61. package/docs/_sources/getting_started.rst.txt +538 -74
  62. package/docs/_sources/index.rst.txt +11 -0
  63. package/docs/_sources/reference.rst.txt +26 -0
  64. package/docs/_sources/troubleshooting.rst.txt +77 -12
  65. package/docs/_static/base-stemmer.js +476 -0
  66. package/docs/_static/english-stemmer.js +1066 -0
  67. package/docs/authentication.html +31 -5
  68. package/docs/client.html +3 -1
  69. package/docs/genindex.html +22 -2
  70. package/docs/getting_started.html +715 -82
  71. package/docs/index.html +35 -0
  72. package/docs/reference.html +412 -3
  73. package/docs/sdk.html +2 -0
  74. package/docs/search.html +2 -0
  75. package/docs/searchindex.js +1 -1
  76. package/docs/troubleshooting.html +75 -17
  77. package/package.json +7 -3
  78. package/sphinx-build/source/authentication.rst +26 -4
  79. package/sphinx-build/source/getting_started.rst +538 -74
  80. package/sphinx-build/source/index.rst +11 -0
  81. package/sphinx-build/source/reference.rst +26 -0
  82. package/sphinx-build/source/troubleshooting.rst +77 -12
  83. package/src/Constants.ts +3 -0
  84. package/src/api/AuditLog.ts +102 -0
  85. package/src/api/EconomicActivity.ts +24 -0
  86. package/src/api/Factor.ts +72 -1
  87. package/src/api/PhysicalActivity.ts +92 -0
  88. package/src/api/RealEstate.ts +23 -0
  89. package/src/api/TypeRecommender.ts +67 -2
  90. package/src/index.ts +7 -1
  91. package/src/interfaces/Api.ts +22 -6
  92. package/src/interfaces/common.ts +58 -0
  93. package/src/interfaces/response/AuditLogResponse.ts +47 -0
  94. package/src/interfaces/response/TypeRecommenderResponse.ts +2 -0
  95. package/test/apiTest.test.ts +59 -3
  96. package/test/auditLog.test.ts +216 -0
  97. package/test/mocks/AttributionRequest.ts +23 -0
  98. package/test/mocks/EconomicActivityAttributionRequest.ts +22 -0
  99. package/test/mocks/PhysicalActivityEVICRequest.ts +22 -0
  100. package/test/mocks/PhysicalActivityRequest.ts +23 -0
  101. package/test/mocks/SearchRequest.ts +48 -0
package/docs/authentication.html CHANGED
@@ -204,9 +204,11 @@
204
204
  <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
205
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
206
  <li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
207
- <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>
208
208
  </ul>
209
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>
210
212
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
211
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
212
214
  </ul>
@@ -257,9 +259,32 @@
257
259
  </section>
258
260
  <section id="authentication-methods">
259
261
  <h2>Authentication Methods<a class="headerlink" href="#authentication-methods" title="Link to this heading">¶</a></h2>
260
- <p>The SDK provides two authentication methods:</p>
261
- <section id="api-key-authentication-recommended">
262
- <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>
263
288
  <p>This method automatically handles token generation and refreshing:</p>
264
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>
265
290
 
@@ -490,7 +515,8 @@
490
515
  <li><a class="reference internal" href="#">Authentication</a><ul>
491
516
  <li><a class="reference internal" href="#overview">Overview</a></li>
492
517
  <li><a class="reference internal" href="#authentication-methods">Authentication Methods</a><ul>
493
- <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>
494
520
  <li><a class="reference internal" href="#token-retrieval">Token retrieval</a></li>
495
521
  </ul>
496
522
  </li>
package/docs/client.html CHANGED
@@ -203,10 +203,12 @@
203
203
  <ul class="current">
204
204
  <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
205
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 current-page"><a class="current reference internal" href="#">Client</a></li>
206
+ <li class="toctree-l2 current"><a class="current reference internal" href="#">Client</a></li>
207
207
  <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
208
208
  </ul>
209
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>
210
212
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
211
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
212
214
  </ul>
package/docs/genindex.html CHANGED
@@ -205,6 +205,8 @@
205
205
  <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
206
206
  </ul>
207
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>
208
210
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
209
211
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
210
212
  </ul>
@@ -258,17 +260,25 @@
258
260
  </li>
259
261
  <li><a href="reference.html#Api.FactorRequestWithoutFactorId">Api.FactorRequestWithoutFactorId() (interface)</a>
260
262
  </li>
261
- </ul></td>
262
- <td style="width: 33%; vertical-align: top;"><ul>
263
263
  <li><a href="reference.html#Api.GenericCalculationRequestWithFactorId">Api.GenericCalculationRequestWithFactorId() (interface)</a>
264
264
  </li>
265
265
  <li><a href="reference.html#Api.GenericCalculationRequestWithoutFactorId">Api.GenericCalculationRequestWithoutFactorId() (interface)</a>
266
266
  </li>
267
+ </ul></td>
268
+ <td style="width: 33%; vertical-align: top;"><ul>
267
269
  <li><a href="reference.html#Api.LocationRequestWithFactorId">Api.LocationRequestWithFactorId() (interface)</a>
268
270
  </li>
269
271
  <li><a href="reference.html#Api.LocationRequestWithoutFactorId">Api.LocationRequestWithoutFactorId() (interface)</a>
270
272
  </li>
271
273
  <li><a href="reference.html#Api.SearchRequest">Api.SearchRequest() (interface)</a>
274
+ </li>
275
+ <li><a href="reference.html#AuditLog.getAuditConfig">AuditLog.getAuditConfig() (AuditLog method)</a>
276
+ </li>
277
+ <li><a href="reference.html#AuditLog.updateAuditConfig">AuditLog.updateAuditConfig() (AuditLog method)</a>
278
+ </li>
279
+ <li><a href="reference.html#AuditLogResponse.AuditLogRequest">AuditLogResponse.AuditLogRequest() (interface)</a>
280
+ </li>
281
+ <li><a href="reference.html#AuditLogResponse.AuditLogResponse">AuditLogResponse.AuditLogResponse() (interface)</a>
272
282
  </li>
273
283
  </ul></td>
274
284
  </tr></table>
@@ -344,6 +354,8 @@
344
354
  </li>
345
355
  </ul></td>
346
356
  <td style="width: 33%; vertical-align: top;"><ul>
357
+ <li><a href="reference.html#Factor.search">Factor.search() (Factor method)</a>
358
+ </li>
347
359
  <li><a href="reference.html#Fugitive.calculate">Fugitive.calculate() (Fugitive method)</a>
348
360
  </li>
349
361
  </ul></td>
@@ -413,6 +425,14 @@
413
425
  <table style="width: 100%" class="indextable genindextable"><tr>
414
426
  <td style="width: 33%; vertical-align: top;"><ul>
415
427
  <li><a href="reference.html#TransportationAndDistribution.calculate">TransportationAndDistribution.calculate() (TransportationAndDistribution method)</a>
428
+ </li>
429
+ <li><a href="reference.html#TypeRecommender.search">TypeRecommender.search() (TypeRecommender method)</a>
430
+ </li>
431
+ </ul></td>
432
+ <td style="width: 33%; vertical-align: top;"><ul>
433
+ <li><a href="reference.html#TypeRecommenderResponse.ActivityRequest">TypeRecommenderResponse.ActivityRequest() (interface)</a>
434
+ </li>
435
+ <li><a href="reference.html#TypeRecommenderResponse.TypeRecommenderResponse">TypeRecommenderResponse.TypeRecommenderResponse() (interface)</a>
416
436
  </li>
417
437
  </ul></td>
418
438
  </tr></table>