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
@@ -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">7x</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">7x</span>
384
+ <span class="cline-any cline-yes">7x</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">7x</span>
387
+ <span class="cline-any cline-yes">7x</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-05-11T08:42:18.203Z
1018
+ at 2026-09-22T12:45:13.080Z
1019
1019
  </div>
1020
1020
  <script src="../prettify.js"></script>
1021
1021
  <script>
@@ -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'>30/30</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'>30/30</span>
50
50
  </div>
51
51
 
52
52
 
@@ -90,34 +90,46 @@
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>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">11x</span>
100
+ <span class="cline-any cline-yes">11x</span>
101
+ <span class="cline-any cline-yes">11x</span>
102
+ <span class="cline-any cline-yes">11x</span>
103
+ <span class="cline-any cline-yes">11x</span>
104
+ <span class="cline-any cline-yes">11x</span>
105
+ <span class="cline-any cline-yes">11x</span>
106
+ <span class="cline-any cline-yes">11x</span>
107
+ <span class="cline-any cline-yes">11x</span>
108
+ <span class="cline-any cline-yes">11x</span>
109
+ <span class="cline-any cline-yes">11x</span>
110
+ <span class="cline-any cline-yes">11x</span>
111
+ <span class="cline-any cline-yes">11x</span>
112
+ <span class="cline-any cline-yes">11x</span>
113
+ <span class="cline-any cline-yes">11x</span>
114
+ <span class="cline-any cline-yes">11x</span>
115
+ <span class="cline-any cline-yes">11x</span>
116
+ <span class="cline-any cline-yes">11x</span>
117
+ <span class="cline-any cline-yes">11x</span>
107
118
  <span class="cline-any cline-neutral">&nbsp;</span>
108
- <span class="cline-any cline-yes">5x</span>
119
+ <span class="cline-any cline-yes">11x</span>
109
120
  <span class="cline-any cline-neutral">&nbsp;</span>
110
- <span class="cline-any cline-yes">5x</span>
121
+ <span class="cline-any cline-yes">11x</span>
111
122
  <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>
123
+ <span class="cline-any cline-yes">11x</span>
124
+ <span class="cline-any cline-yes">11x</span>
125
+ <span class="cline-any cline-yes">11x</span>
115
126
  <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";
127
+ <span class="cline-any cline-yes">11x</span>
128
+ <span class="cline-any cline-yes">11x</span>
129
+ <span class="cline-any cline-yes">11x</span>
130
+ <span class="cline-any cline-yes">11x</span>
131
+ <span class="cline-any cline-yes">11x</span>
132
+ <span class="cline-any cline-yes">11x</span></td><td class="text"><pre class="prettyprint lang-js">export const API_DOMAIN = "https://api.envizi.ibm.com/ghgemissions/run";
121
133
  export const TOKEN_GENERATION_API = "https://api.ibm.com/saascore/run/authentication-retrieve/api-key";
122
134
  export const PAT_TOKEN_EXCHANGE_API = "https://api.ibm.com/saascore/run/envizi-auth/exchange";
123
135
  export const MOBILE_API_PATH = "/v3/carbon/mobile";
@@ -131,6 +143,11 @@ export const FACTOR_SET_API_PATH = "/v3/carbon/factorset";
131
143
  export const SEARCH_API_PATH = "/v3/carbon/factor/search";
132
144
  export const ECONOMIC_ACTIVITY_API_PATH = "/v3/carbon/economic-activity";
133
145
  export const REAL_ESTATE_API_PATH = "/v3/carbon/real-estate";
146
+ export const PHYSICAL_ACTIVITY_API_PATH = "/v3/carbon/physical-activity";
147
+ export const AUDIT_LOG_API_PATH = "/v3/carbon/admin/audit-log";
148
+ export const AUDIT_EXPORT_API_PATH = "/v3/carbon/audit";
149
+ export const AUDIT_EXPORT_STATUS_API_PATH = "/v3/carbon/audit/status";
150
+ export const AUDIT_EXPORT_DOWNLOAD_API_PATH = "/v3/carbon/audit/download";
134
151
  &nbsp;
135
152
  export const TYPE_RECOMMENDER_API_PATH = "/v3/carbon/recommender/type/search";
136
153
  &nbsp;
@@ -142,6 +159,7 @@ export const METADATA_UNITS_ENDPOINT = "/v3/carbon/metadata/units";
142
159
  &nbsp;
143
160
  export const GET = "GET";
144
161
  export const POST = "POST";
162
+ export const PUT = "PUT";
145
163
  export const CLIENT_SOURCE_HEADER = "X-Client-Source";
146
164
  export const CLIENT_SOURCE_EXCEL = "excel";
147
165
  export const CLIENT_SOURCE_SDK = "node-sdk";</pre></td></tr></table></pre>
@@ -151,7 +169,7 @@ export const CLIENT_SOURCE_SDK = "node-sdk";</pre></td></tr></table></pre>
151
169
  <div class='footer quiet pad2 space-top1 center small'>
152
170
  Code coverage generated by
153
171
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
154
- at 2026-05-11T08:42:18.203Z
172
+ at 2026-09-22T12:45:13.080Z
155
173
  </div>
156
174
  <script src="../prettify.js"></script>
157
175
  <script>
@@ -0,0 +1,355 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/api/AuditExport.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../prettify.css" />
9
+ <link rel="stylesheet" href="../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../index.html">All files</a> / <a href="index.html">src/api</a> AuditExport.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">100% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>15/15</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">100% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>0/0</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">100% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>3/3</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">100% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>15/15</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line high'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a>
90
+ <a name='L25'></a><a href='#L25'>25</a>
91
+ <a name='L26'></a><a href='#L26'>26</a>
92
+ <a name='L27'></a><a href='#L27'>27</a>
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>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a>
100
+ <a name='L35'></a><a href='#L35'>35</a>
101
+ <a name='L36'></a><a href='#L36'>36</a>
102
+ <a name='L37'></a><a href='#L37'>37</a>
103
+ <a name='L38'></a><a href='#L38'>38</a>
104
+ <a name='L39'></a><a href='#L39'>39</a>
105
+ <a name='L40'></a><a href='#L40'>40</a>
106
+ <a name='L41'></a><a href='#L41'>41</a>
107
+ <a name='L42'></a><a href='#L42'>42</a>
108
+ <a name='L43'></a><a href='#L43'>43</a>
109
+ <a name='L44'></a><a href='#L44'>44</a>
110
+ <a name='L45'></a><a href='#L45'>45</a>
111
+ <a name='L46'></a><a href='#L46'>46</a>
112
+ <a name='L47'></a><a href='#L47'>47</a>
113
+ <a name='L48'></a><a href='#L48'>48</a>
114
+ <a name='L49'></a><a href='#L49'>49</a>
115
+ <a name='L50'></a><a href='#L50'>50</a>
116
+ <a name='L51'></a><a href='#L51'>51</a>
117
+ <a name='L52'></a><a href='#L52'>52</a>
118
+ <a name='L53'></a><a href='#L53'>53</a>
119
+ <a name='L54'></a><a href='#L54'>54</a>
120
+ <a name='L55'></a><a href='#L55'>55</a>
121
+ <a name='L56'></a><a href='#L56'>56</a>
122
+ <a name='L57'></a><a href='#L57'>57</a>
123
+ <a name='L58'></a><a href='#L58'>58</a>
124
+ <a name='L59'></a><a href='#L59'>59</a>
125
+ <a name='L60'></a><a href='#L60'>60</a>
126
+ <a name='L61'></a><a href='#L61'>61</a>
127
+ <a name='L62'></a><a href='#L62'>62</a>
128
+ <a name='L63'></a><a href='#L63'>63</a>
129
+ <a name='L64'></a><a href='#L64'>64</a>
130
+ <a name='L65'></a><a href='#L65'>65</a>
131
+ <a name='L66'></a><a href='#L66'>66</a>
132
+ <a name='L67'></a><a href='#L67'>67</a>
133
+ <a name='L68'></a><a href='#L68'>68</a>
134
+ <a name='L69'></a><a href='#L69'>69</a>
135
+ <a name='L70'></a><a href='#L70'>70</a>
136
+ <a name='L71'></a><a href='#L71'>71</a>
137
+ <a name='L72'></a><a href='#L72'>72</a>
138
+ <a name='L73'></a><a href='#L73'>73</a>
139
+ <a name='L74'></a><a href='#L74'>74</a>
140
+ <a name='L75'></a><a href='#L75'>75</a>
141
+ <a name='L76'></a><a href='#L76'>76</a>
142
+ <a name='L77'></a><a href='#L77'>77</a>
143
+ <a name='L78'></a><a href='#L78'>78</a>
144
+ <a name='L79'></a><a href='#L79'>79</a>
145
+ <a name='L80'></a><a href='#L80'>80</a>
146
+ <a name='L81'></a><a href='#L81'>81</a>
147
+ <a name='L82'></a><a href='#L82'>82</a>
148
+ <a name='L83'></a><a href='#L83'>83</a>
149
+ <a name='L84'></a><a href='#L84'>84</a>
150
+ <a name='L85'></a><a href='#L85'>85</a>
151
+ <a name='L86'></a><a href='#L86'>86</a>
152
+ <a name='L87'></a><a href='#L87'>87</a>
153
+ <a name='L88'></a><a href='#L88'>88</a>
154
+ <a name='L89'></a><a href='#L89'>89</a>
155
+ <a name='L90'></a><a href='#L90'>90</a>
156
+ <a name='L91'></a><a href='#L91'>91</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
157
+ <span class="cline-any cline-yes">1x</span>
158
+ <span class="cline-any cline-yes">1x</span>
159
+ <span class="cline-any cline-neutral">&nbsp;</span>
160
+ <span class="cline-any cline-neutral">&nbsp;</span>
161
+ <span class="cline-any cline-neutral">&nbsp;</span>
162
+ <span class="cline-any cline-neutral">&nbsp;</span>
163
+ <span class="cline-any cline-neutral">&nbsp;</span>
164
+ <span class="cline-any cline-neutral">&nbsp;</span>
165
+ <span class="cline-any cline-neutral">&nbsp;</span>
166
+ <span class="cline-any cline-neutral">&nbsp;</span>
167
+ <span class="cline-any cline-neutral">&nbsp;</span>
168
+ <span class="cline-any cline-neutral">&nbsp;</span>
169
+ <span class="cline-any cline-neutral">&nbsp;</span>
170
+ <span class="cline-any cline-yes">1x</span>
171
+ <span class="cline-any cline-neutral">&nbsp;</span>
172
+ <span class="cline-any cline-neutral">&nbsp;</span>
173
+ <span class="cline-any cline-neutral">&nbsp;</span>
174
+ <span class="cline-any cline-neutral">&nbsp;</span>
175
+ <span class="cline-any cline-neutral">&nbsp;</span>
176
+ <span class="cline-any cline-neutral">&nbsp;</span>
177
+ <span class="cline-any cline-neutral">&nbsp;</span>
178
+ <span class="cline-any cline-neutral">&nbsp;</span>
179
+ <span class="cline-any cline-neutral">&nbsp;</span>
180
+ <span class="cline-any cline-neutral">&nbsp;</span>
181
+ <span class="cline-any cline-neutral">&nbsp;</span>
182
+ <span class="cline-any cline-neutral">&nbsp;</span>
183
+ <span class="cline-any cline-neutral">&nbsp;</span>
184
+ <span class="cline-any cline-neutral">&nbsp;</span>
185
+ <span class="cline-any cline-neutral">&nbsp;</span>
186
+ <span class="cline-any cline-neutral">&nbsp;</span>
187
+ <span class="cline-any cline-yes">1x</span>
188
+ <span class="cline-any cline-neutral">&nbsp;</span>
189
+ <span class="cline-any cline-neutral">&nbsp;</span>
190
+ <span class="cline-any cline-yes">1x</span>
191
+ <span class="cline-any cline-yes">1x</span>
192
+ <span class="cline-any cline-neutral">&nbsp;</span>
193
+ <span class="cline-any cline-yes">1x</span>
194
+ <span class="cline-any cline-neutral">&nbsp;</span>
195
+ <span class="cline-any cline-neutral">&nbsp;</span>
196
+ <span class="cline-any cline-neutral">&nbsp;</span>
197
+ <span class="cline-any cline-neutral">&nbsp;</span>
198
+ <span class="cline-any cline-neutral">&nbsp;</span>
199
+ <span class="cline-any cline-neutral">&nbsp;</span>
200
+ <span class="cline-any cline-neutral">&nbsp;</span>
201
+ <span class="cline-any cline-neutral">&nbsp;</span>
202
+ <span class="cline-any cline-neutral">&nbsp;</span>
203
+ <span class="cline-any cline-neutral">&nbsp;</span>
204
+ <span class="cline-any cline-neutral">&nbsp;</span>
205
+ <span class="cline-any cline-neutral">&nbsp;</span>
206
+ <span class="cline-any cline-neutral">&nbsp;</span>
207
+ <span class="cline-any cline-neutral">&nbsp;</span>
208
+ <span class="cline-any cline-neutral">&nbsp;</span>
209
+ <span class="cline-any cline-neutral">&nbsp;</span>
210
+ <span class="cline-any cline-neutral">&nbsp;</span>
211
+ <span class="cline-any cline-yes">1x</span>
212
+ <span class="cline-any cline-neutral">&nbsp;</span>
213
+ <span class="cline-any cline-neutral">&nbsp;</span>
214
+ <span class="cline-any cline-yes">1x</span>
215
+ <span class="cline-any cline-yes">1x</span>
216
+ <span class="cline-any cline-neutral">&nbsp;</span>
217
+ <span class="cline-any cline-yes">1x</span>
218
+ <span class="cline-any cline-neutral">&nbsp;</span>
219
+ <span class="cline-any cline-neutral">&nbsp;</span>
220
+ <span class="cline-any cline-neutral">&nbsp;</span>
221
+ <span class="cline-any cline-neutral">&nbsp;</span>
222
+ <span class="cline-any cline-neutral">&nbsp;</span>
223
+ <span class="cline-any cline-neutral">&nbsp;</span>
224
+ <span class="cline-any cline-neutral">&nbsp;</span>
225
+ <span class="cline-any cline-neutral">&nbsp;</span>
226
+ <span class="cline-any cline-neutral">&nbsp;</span>
227
+ <span class="cline-any cline-neutral">&nbsp;</span>
228
+ <span class="cline-any cline-neutral">&nbsp;</span>
229
+ <span class="cline-any cline-neutral">&nbsp;</span>
230
+ <span class="cline-any cline-neutral">&nbsp;</span>
231
+ <span class="cline-any cline-neutral">&nbsp;</span>
232
+ <span class="cline-any cline-neutral">&nbsp;</span>
233
+ <span class="cline-any cline-neutral">&nbsp;</span>
234
+ <span class="cline-any cline-neutral">&nbsp;</span>
235
+ <span class="cline-any cline-yes">1x</span>
236
+ <span class="cline-any cline-yes">1x</span>
237
+ <span class="cline-any cline-yes">1x</span>
238
+ <span class="cline-any cline-neutral">&nbsp;</span>
239
+ <span class="cline-any cline-yes">1x</span>
240
+ <span class="cline-any cline-neutral">&nbsp;</span>
241
+ <span class="cline-any cline-neutral">&nbsp;</span>
242
+ <span class="cline-any cline-neutral">&nbsp;</span>
243
+ <span class="cline-any cline-neutral">&nbsp;</span>
244
+ <span class="cline-any cline-neutral">&nbsp;</span>
245
+ <span class="cline-any cline-neutral">&nbsp;</span>
246
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Buffer } from "node:buffer";
247
+ import { Client } from "../Client";
248
+ import {
249
+ AUDIT_EXPORT_API_PATH,
250
+ AUDIT_EXPORT_DOWNLOAD_API_PATH,
251
+ AUDIT_EXPORT_STATUS_API_PATH,
252
+ GET,
253
+ POST,
254
+ } from "../Constants";
255
+ import {
256
+ AuditExportRequest,
257
+ AuditExportResponse,
258
+ AuditExportStatusResponse,
259
+ } from "../interfaces/response/AuditExportResponse";
260
+ import { makeApiRequest } from "../request";
261
+ &nbsp;
262
+ /**
263
+ * Triggers an asynchronous audit data export.
264
+ *
265
+ * @export
266
+ * @param {AuditExportRequest} payload - Date range and optional API-name filter for the export
267
+ * @return {Promise&lt;AuditExportResponse&gt;} The accepted export request, including its request ID
268
+ * @throws {Error} Throws if the request is invalid, the caller is not an admin, or a matching export already exists
269
+ *
270
+ * @example
271
+ * const auditExport = await trigger({
272
+ * fromDate: "2025-01-01",
273
+ * toDate: "2025-03-31",
274
+ * apiName: "location"
275
+ * });
276
+ */
277
+ export async function trigger(
278
+ payload: AuditExportRequest
279
+ ): Promise&lt;AuditExportResponse&gt; {
280
+ const client = Client.getInstance();
281
+ const url = client.getDomain() + AUDIT_EXPORT_API_PATH;
282
+ &nbsp;
283
+ return makeApiRequest&lt;AuditExportResponse&gt;({
284
+ method: POST,
285
+ url,
286
+ data: payload,
287
+ });
288
+ }
289
+ &nbsp;
290
+ /**
291
+ * Retrieves the processing status of an audit export.
292
+ *
293
+ * @export
294
+ * @param {string} requestId - Request ID returned by trigger
295
+ * @return {Promise&lt;AuditExportStatusResponse&gt;} Current export status and, when complete, download details
296
+ * @throws {Error} Throws if the request ID is invalid or the caller is not an admin
297
+ *
298
+ * @example
299
+ * const status = await getStatus(auditExport.requestId);
300
+ */
301
+ export async function getStatus(
302
+ requestId: string
303
+ ): Promise&lt;AuditExportStatusResponse&gt; {
304
+ const client = Client.getInstance();
305
+ const url = client.getDomain() + AUDIT_EXPORT_STATUS_API_PATH;
306
+ &nbsp;
307
+ return makeApiRequest&lt;AuditExportStatusResponse&gt;({
308
+ method: GET,
309
+ url,
310
+ params: { requestId },
311
+ });
312
+ }
313
+ &nbsp;
314
+ /**
315
+ * Downloads a completed audit export as a ZIP archive.
316
+ *
317
+ * @export
318
+ * @param {string} requestId - Request ID returned by trigger
319
+ * @return {Promise&lt;Buffer&gt;} ZIP archive containing audit-export.csv
320
+ * @throws {Error} Throws while processing, when the export failed or expired, or if the caller is not an admin
321
+ *
322
+ * @example
323
+ * const auditExportZip = await download(auditExport.requestId);
324
+ */
325
+ export async function download(requestId: string): Promise&lt;Buffer&gt; {
326
+ const client = Client.getInstance();
327
+ const url = client.getDomain() + AUDIT_EXPORT_DOWNLOAD_API_PATH;
328
+ &nbsp;
329
+ return makeApiRequest&lt;Buffer&gt;({
330
+ method: GET,
331
+ url,
332
+ params: { requestId },
333
+ responseType: "arraybuffer",
334
+ });
335
+ }
336
+ &nbsp;</pre></td></tr></table></pre>
337
+
338
+ <div class='push'></div><!-- for sticky footer -->
339
+ </div><!-- /wrapper -->
340
+ <div class='footer quiet pad2 space-top1 center small'>
341
+ Code coverage generated by
342
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
343
+ at 2026-09-22T12:45:13.080Z
344
+ </div>
345
+ <script src="../../prettify.js"></script>
346
+ <script>
347
+ window.onload = function () {
348
+ prettyPrint();
349
+ };
350
+ </script>
351
+ <script src="../../sorter.js"></script>
352
+ <script src="../../block-navigation.js"></script>
353
+ </body>
354
+ </html>
355
+