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/dist/coverage/lcov-report/src/Client.ts.html CHANGED
@@ -378,13 +378,13 @@
378
378
  <a name='L313'></a><a href='#L313'>313</a>
379
379
  <a name='L314'></a><a href='#L314'>314</a>
380
380
  <a name='L315'></a><a href='#L315'>315</a>
381
- <a name='L316'></a><a href='#L316'>316</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">5x</span>
381
+ <a name='L316'></a><a href='#L316'>316</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">6x</span>
382
382
  <span class="cline-any cline-neutral">&nbsp;</span>
383
- <span class="cline-any cline-yes">5x</span>
384
- <span class="cline-any cline-yes">5x</span>
383
+ <span class="cline-any cline-yes">6x</span>
384
+ <span class="cline-any cline-yes">6x</span>
385
385
  <span class="cline-any cline-neutral">&nbsp;</span>
386
- <span class="cline-any cline-yes">5x</span>
387
- <span class="cline-any cline-yes">5x</span>
386
+ <span class="cline-any cline-yes">6x</span>
387
+ <span class="cline-any cline-yes">6x</span>
388
388
  <span class="cline-any cline-neutral">&nbsp;</span>
389
389
  <span class="cline-any cline-neutral">&nbsp;</span>
390
390
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -402,25 +402,25 @@
402
402
  <span class="cline-any cline-neutral">&nbsp;</span>
403
403
  <span class="cline-any cline-neutral">&nbsp;</span>
404
404
  <span class="cline-any cline-neutral">&nbsp;</span>
405
- <span class="cline-any cline-yes">43x</span>
406
- <span class="cline-any cline-yes">43x</span>
407
- <span class="cline-any cline-yes">43x</span>
408
- <span class="cline-any cline-yes">43x</span>
405
+ <span class="cline-any cline-yes">50x</span>
406
+ <span class="cline-any cline-yes">50x</span>
407
+ <span class="cline-any cline-yes">50x</span>
408
+ <span class="cline-any cline-yes">50x</span>
409
409
  <span class="cline-any cline-yes">1x</span>
410
410
  <span class="cline-any cline-yes">1x</span>
411
411
  <span class="cline-any cline-yes">1x</span>
412
412
  <span class="cline-any cline-neutral">&nbsp;</span>
413
- <span class="cline-any cline-yes">42x</span>
414
- <span class="cline-any cline-yes">42x</span>
415
- <span class="cline-any cline-yes">42x</span>
413
+ <span class="cline-any cline-yes">49x</span>
414
+ <span class="cline-any cline-yes">49x</span>
415
+ <span class="cline-any cline-yes">49x</span>
416
416
  <span class="cline-any cline-neutral">&nbsp;</span>
417
417
  <span class="cline-any cline-neutral">&nbsp;</span>
418
- <span class="cline-any cline-yes">43x</span>
419
- <span class="cline-any cline-yes">43x</span>
420
- <span class="cline-any cline-yes">43x</span>
421
- <span class="cline-any cline-yes">43x</span>
422
- <span class="cline-any cline-yes">43x</span>
423
- <span class="cline-any cline-yes">43x</span>
418
+ <span class="cline-any cline-yes">50x</span>
419
+ <span class="cline-any cline-yes">50x</span>
420
+ <span class="cline-any cline-yes">50x</span>
421
+ <span class="cline-any cline-yes">50x</span>
422
+ <span class="cline-any cline-yes">50x</span>
423
+ <span class="cline-any cline-yes">50x</span>
424
424
  <span class="cline-any cline-neutral">&nbsp;</span>
425
425
  <span class="cline-any cline-neutral">&nbsp;</span>
426
426
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -465,44 +465,44 @@
465
465
  <span class="cline-any cline-neutral">&nbsp;</span>
466
466
  <span class="cline-any cline-neutral">&nbsp;</span>
467
467
  <span class="cline-any cline-neutral">&nbsp;</span>
468
- <span class="cline-any cline-yes">48x</span>
468
+ <span class="cline-any cline-yes">55x</span>
469
469
  <span class="cline-any cline-yes">1x</span>
470
470
  <span class="cline-any cline-neutral">&nbsp;</span>
471
471
  <span class="cline-any cline-neutral">&nbsp;</span>
472
472
  <span class="cline-any cline-neutral">&nbsp;</span>
473
- <span class="cline-any cline-yes">47x</span>
473
+ <span class="cline-any cline-yes">54x</span>
474
474
  <span class="cline-any cline-yes">1x</span>
475
475
  <span class="cline-any cline-neutral">&nbsp;</span>
476
476
  <span class="cline-any cline-neutral">&nbsp;</span>
477
477
  <span class="cline-any cline-neutral">&nbsp;</span>
478
- <span class="cline-any cline-yes">46x</span>
478
+ <span class="cline-any cline-yes">53x</span>
479
479
  <span class="cline-any cline-yes">1x</span>
480
480
  <span class="cline-any cline-neutral">&nbsp;</span>
481
481
  <span class="cline-any cline-neutral">&nbsp;</span>
482
482
  <span class="cline-any cline-neutral">&nbsp;</span>
483
- <span class="cline-any cline-yes">45x</span>
483
+ <span class="cline-any cline-yes">52x</span>
484
484
  <span class="cline-any cline-yes">1x</span>
485
485
  <span class="cline-any cline-neutral">&nbsp;</span>
486
486
  <span class="cline-any cline-neutral">&nbsp;</span>
487
487
  <span class="cline-any cline-neutral">&nbsp;</span>
488
- <span class="cline-any cline-yes">44x</span>
488
+ <span class="cline-any cline-yes">51x</span>
489
489
  <span class="cline-any cline-yes">1x</span>
490
490
  <span class="cline-any cline-neutral">&nbsp;</span>
491
491
  <span class="cline-any cline-neutral">&nbsp;</span>
492
492
  <span class="cline-any cline-neutral">&nbsp;</span>
493
493
  <span class="cline-any cline-neutral">&nbsp;</span>
494
- <span class="cline-any cline-yes">43x</span>
494
+ <span class="cline-any cline-yes">50x</span>
495
495
  <span class="cline-any cline-neutral">&nbsp;</span>
496
- <span class="cline-any cline-yes">43x</span>
496
+ <span class="cline-any cline-yes">50x</span>
497
497
  <span class="cline-any cline-yes">1x</span>
498
498
  <span class="cline-any cline-yes">1x</span>
499
- <span class="cline-any cline-yes">42x</span>
499
+ <span class="cline-any cline-yes">49x</span>
500
500
  <span class="cline-any cline-yes">6x</span>
501
501
  <span class="cline-any cline-neutral">&nbsp;</span>
502
- <span class="cline-any cline-yes">36x</span>
503
- <span class="cline-any cline-neutral">&nbsp;</span>
504
502
  <span class="cline-any cline-yes">43x</span>
505
503
  <span class="cline-any cline-neutral">&nbsp;</span>
504
+ <span class="cline-any cline-yes">50x</span>
505
+ <span class="cline-any cline-neutral">&nbsp;</span>
506
506
  <span class="cline-any cline-neutral">&nbsp;</span>
507
507
  <span class="cline-any cline-neutral">&nbsp;</span>
508
508
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -515,7 +515,7 @@
515
515
  <span class="cline-any cline-neutral">&nbsp;</span>
516
516
  <span class="cline-any cline-neutral">&nbsp;</span>
517
517
  <span class="cline-any cline-neutral">&nbsp;</span>
518
- <span class="cline-any cline-yes">66x</span>
518
+ <span class="cline-any cline-yes">80x</span>
519
519
  <span class="cline-any cline-neutral">&nbsp;</span>
520
520
  <span class="cline-any cline-neutral">&nbsp;</span>
521
521
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -537,12 +537,12 @@
537
537
  <span class="cline-any cline-neutral">&nbsp;</span>
538
538
  <span class="cline-any cline-neutral">&nbsp;</span>
539
539
  <span class="cline-any cline-neutral">&nbsp;</span>
540
- <span class="cline-any cline-yes">77x</span>
540
+ <span class="cline-any cline-yes">91x</span>
541
541
  <span class="cline-any cline-yes">1x</span>
542
542
  <span class="cline-any cline-neutral">&nbsp;</span>
543
543
  <span class="cline-any cline-neutral">&nbsp;</span>
544
544
  <span class="cline-any cline-neutral">&nbsp;</span>
545
- <span class="cline-any cline-yes">76x</span>
545
+ <span class="cline-any cline-yes">90x</span>
546
546
  <span class="cline-any cline-neutral">&nbsp;</span>
547
547
  <span class="cline-any cline-neutral">&nbsp;</span>
548
548
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -1015,7 +1015,7 @@ export class Client {
1015
1015
  <div class='footer quiet pad2 space-top1 center small'>
1016
1016
  Code coverage generated by
1017
1017
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
1018
- at 2026-04-28T14:06:05.256Z
1018
+ at 2026-06-30T08:27:03.967Z
1019
1019
  </div>
1020
1020
  <script src="../prettify.js"></script>
1021
1021
  <script>
package/dist/coverage/lcov-report/src/Constants.ts.html CHANGED
@@ -25,7 +25,7 @@
25
25
  <div class='fl pad1y space-right2'>
26
26
  <span class="strong">100% </span>
27
27
  <span class="quiet">Statements</span>
28
- <span class='fraction'>24/24</span>
28
+ <span class='fraction'>27/27</span>
29
29
  </div>
30
30
 
31
31
 
@@ -46,7 +46,7 @@
46
46
  <div class='fl pad1y space-right2'>
47
47
  <span class="strong">100% </span>
48
48
  <span class="quiet">Lines</span>
49
- <span class='fraction'>24/24</span>
49
+ <span class='fraction'>27/27</span>
50
50
  </div>
51
51
 
52
52
 
@@ -90,34 +90,40 @@
90
90
  <a name='L25'></a><a href='#L25'>25</a>
91
91
  <a name='L26'></a><a href='#L26'>26</a>
92
92
  <a name='L27'></a><a href='#L27'>27</a>
93
- <a name='L28'></a><a href='#L28'>28</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">5x</span>
94
- <span class="cline-any cline-yes">5x</span>
95
- <span class="cline-any cline-yes">5x</span>
96
- <span class="cline-any cline-yes">5x</span>
97
- <span class="cline-any cline-yes">5x</span>
98
- <span class="cline-any cline-yes">5x</span>
99
- <span class="cline-any cline-yes">5x</span>
100
- <span class="cline-any cline-yes">5x</span>
101
- <span class="cline-any cline-yes">5x</span>
102
- <span class="cline-any cline-yes">5x</span>
103
- <span class="cline-any cline-yes">5x</span>
104
- <span class="cline-any cline-yes">5x</span>
105
- <span class="cline-any cline-yes">5x</span>
106
- <span class="cline-any cline-yes">5x</span>
93
+ <a name='L28'></a><a href='#L28'>28</a>
94
+ <a name='L29'></a><a href='#L29'>29</a>
95
+ <a name='L30'></a><a href='#L30'>30</a>
96
+ <a name='L31'></a><a href='#L31'>31</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">8x</span>
97
+ <span class="cline-any cline-yes">8x</span>
98
+ <span class="cline-any cline-yes">8x</span>
99
+ <span class="cline-any cline-yes">8x</span>
100
+ <span class="cline-any cline-yes">8x</span>
101
+ <span class="cline-any cline-yes">8x</span>
102
+ <span class="cline-any cline-yes">8x</span>
103
+ <span class="cline-any cline-yes">8x</span>
104
+ <span class="cline-any cline-yes">8x</span>
105
+ <span class="cline-any cline-yes">8x</span>
106
+ <span class="cline-any cline-yes">8x</span>
107
+ <span class="cline-any cline-yes">8x</span>
108
+ <span class="cline-any cline-yes">8x</span>
109
+ <span class="cline-any cline-yes">8x</span>
110
+ <span class="cline-any cline-yes">8x</span>
111
+ <span class="cline-any cline-yes">8x</span>
107
112
  <span class="cline-any cline-neutral">&nbsp;</span>
108
- <span class="cline-any cline-yes">5x</span>
113
+ <span class="cline-any cline-yes">8x</span>
109
114
  <span class="cline-any cline-neutral">&nbsp;</span>
110
- <span class="cline-any cline-yes">5x</span>
115
+ <span class="cline-any cline-yes">8x</span>
111
116
  <span class="cline-any cline-neutral">&nbsp;</span>
112
- <span class="cline-any cline-yes">5x</span>
113
- <span class="cline-any cline-yes">5x</span>
114
- <span class="cline-any cline-yes">5x</span>
117
+ <span class="cline-any cline-yes">8x</span>
118
+ <span class="cline-any cline-yes">8x</span>
119
+ <span class="cline-any cline-yes">8x</span>
115
120
  <span class="cline-any cline-neutral">&nbsp;</span>
116
- <span class="cline-any cline-yes">5x</span>
117
- <span class="cline-any cline-yes">5x</span>
118
- <span class="cline-any cline-yes">5x</span>
119
- <span class="cline-any cline-yes">5x</span>
120
- <span class="cline-any cline-yes">5x</span></td><td class="text"><pre class="prettyprint lang-js">export const API_DOMAIN = "https://api.envizi.ibm.com/ghgemissions/run";
121
+ <span class="cline-any cline-yes">8x</span>
122
+ <span class="cline-any cline-yes">8x</span>
123
+ <span class="cline-any cline-yes">8x</span>
124
+ <span class="cline-any cline-yes">8x</span>
125
+ <span class="cline-any cline-yes">8x</span>
126
+ <span class="cline-any cline-yes">8x</span></td><td class="text"><pre class="prettyprint lang-js">export const API_DOMAIN = "https://api.envizi.ibm.com/ghgemissions/run";
121
127
  export const TOKEN_GENERATION_API = "https://api.ibm.com/saascore/run/authentication-retrieve/api-key";
122
128
  export const PAT_TOKEN_EXCHANGE_API = "https://api.ibm.com/saascore/run/envizi-auth/exchange";
123
129
  export const MOBILE_API_PATH = "/v3/carbon/mobile";
@@ -131,6 +137,8 @@ export const FACTOR_SET_API_PATH = "/v3/carbon/factorset";
131
137
  export const SEARCH_API_PATH = "/v3/carbon/factor/search";
132
138
  export const ECONOMIC_ACTIVITY_API_PATH = "/v3/carbon/economic-activity";
133
139
  export const REAL_ESTATE_API_PATH = "/v3/carbon/real-estate";
140
+ export const PHYSICAL_ACTIVITY_API_PATH = "/v3/carbon/physical-activity";
141
+ export const AUDIT_LOG_API_PATH = "/v3/carbon/admin/audit-log";
134
142
  &nbsp;
135
143
  export const TYPE_RECOMMENDER_API_PATH = "/v3/carbon/recommender/type/search";
136
144
  &nbsp;
@@ -142,6 +150,7 @@ export const METADATA_UNITS_ENDPOINT = "/v3/carbon/metadata/units";
142
150
  &nbsp;
143
151
  export const GET = "GET";
144
152
  export const POST = "POST";
153
+ export const PUT = "PUT";
145
154
  export const CLIENT_SOURCE_HEADER = "X-Client-Source";
146
155
  export const CLIENT_SOURCE_EXCEL = "excel";
147
156
  export const CLIENT_SOURCE_SDK = "node-sdk";</pre></td></tr></table></pre>
@@ -151,7 +160,7 @@ export const CLIENT_SOURCE_SDK = "node-sdk";</pre></td></tr></table></pre>
151
160
  <div class='footer quiet pad2 space-top1 center small'>
152
161
  Code coverage generated by
153
162
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
154
- at 2026-04-28T14:06:05.256Z
163
+ at 2026-06-30T08:27:03.967Z
155
164
  </div>
156
165
  <script src="../prettify.js"></script>
157
166
  <script>