emissions-api-sdk 1.0.13 → 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 (81) hide show
  1. package/README.md +23 -0
  2. package/dist/Constants.js +4 -1
  3. package/dist/api/AuditExport.js +73 -0
  4. package/dist/api/EconomicActivity.js +45 -0
  5. package/dist/api/Factor.js +1 -4
  6. package/dist/api/RealEstate.js +2 -1
  7. package/dist/coverage/clover.xml +75 -54
  8. package/dist/coverage/coverage-final.json +8 -7
  9. package/dist/coverage/lcov-report/index.html +15 -15
  10. package/dist/coverage/lcov-report/src/Client.ts.html +6 -6
  11. package/dist/coverage/lcov-report/src/Constants.ts.html +39 -30
  12. package/dist/coverage/lcov-report/src/api/AuditExport.ts.html +355 -0
  13. package/dist/coverage/lcov-report/src/api/AuditLog.ts.html +1 -1
  14. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
  15. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +137 -2
  16. package/dist/coverage/lcov-report/src/api/Factor.ts.html +6 -12
  17. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  18. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
  19. package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
  20. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
  21. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
  22. package/dist/coverage/lcov-report/src/api/PhysicalActivity.ts.html +1 -1
  23. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +6 -3
  24. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
  25. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
  26. package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +1 -1
  27. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  28. package/dist/coverage/lcov-report/src/api/index.html +19 -4
  29. package/dist/coverage/lcov-report/src/index.html +7 -7
  30. package/dist/coverage/lcov-report/src/request.ts.html +8 -5
  31. package/dist/coverage/lcov-report/src/utils.ts.html +2 -2
  32. package/dist/coverage/lcov-report/test/index.html +1 -1
  33. package/dist/coverage/lcov-report/test/mocks/AttributionRequest.ts.html +1 -1
  34. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  35. package/dist/coverage/lcov-report/test/mocks/EconomicActivityAttributionRequest.ts.html +1 -1
  36. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  37. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  38. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  39. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityEVICRequest.ts.html +1 -1
  40. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityRequest.ts.html +1 -1
  41. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
  42. package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
  43. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  44. package/dist/coverage/lcov.info +86 -53
  45. package/dist/index.js +2 -1
  46. package/dist/interfaces/response/AuditExportResponse.js +2 -0
  47. package/dist/request.js +1 -0
  48. package/dist/types/Constants.d.ts +3 -0
  49. package/dist/types/api/AuditExport.d.ts +42 -0
  50. package/dist/types/api/EconomicActivity.d.ts +45 -0
  51. package/dist/types/api/Factor.d.ts +1 -4
  52. package/dist/types/api/RealEstate.d.ts +2 -1
  53. package/dist/types/index.d.ts +2 -0
  54. package/dist/types/interfaces/Config.d.ts +5 -1
  55. package/dist/types/interfaces/response/AuditExportResponse.d.ts +66 -0
  56. package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +1 -0
  57. package/docs/_sources/getting_started.rst.txt +226 -2
  58. package/docs/_sources/index.rst.txt +2 -0
  59. package/docs/_sources/reference.rst.txt +22 -0
  60. package/docs/genindex.html +27 -3
  61. package/docs/getting_started.html +226 -2
  62. package/docs/index.html +4 -0
  63. package/docs/reference.html +267 -4
  64. package/docs/searchindex.js +1 -1
  65. package/package.json +6 -5
  66. package/sphinx-build/source/getting_started.rst +226 -2
  67. package/sphinx-build/source/index.rst +2 -0
  68. package/sphinx-build/source/reference.rst +22 -0
  69. package/src/Constants.ts +3 -0
  70. package/src/api/AuditExport.ts +90 -0
  71. package/src/api/EconomicActivity.ts +45 -0
  72. package/src/api/Factor.ts +2 -5
  73. package/src/api/RealEstate.ts +2 -1
  74. package/src/index.ts +9 -1
  75. package/src/interfaces/Config.ts +6 -1
  76. package/src/interfaces/response/AuditExportResponse.ts +88 -0
  77. package/src/interfaces/response/TypeRecommenderResponse.ts +1 -0
  78. package/src/request.ts +1 -0
  79. package/test/auditExport.test.ts +68 -0
  80. package/docs/_static/base-stemmer.js +0 -476
  81. package/docs/_static/english-stemmer.js +0 -1066
package/docs/reference.html CHANGED
@@ -581,11 +581,8 @@ Only refreshes if the token was not provided by the user and is expiring within
581
581
  <p class="admonition-title">Example</p>
582
582
  <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search without cross-encoder reranking</span>
583
583
  <span class="kd">const</span><span class="w"> </span><span class="nx">searchWithoutReranker</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
584
- <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="p">{</span>
585
- <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2020-06-10&quot;</span>
586
- <span class="w"> </span><span class="p">},</span>
587
584
  <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
588
- <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;travel&quot;</span>
585
+ <span class="w"> </span><span class="s2">&quot;search&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;travel&quot;</span>
589
586
  <span class="w"> </span><span class="p">},</span>
590
587
  <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
591
588
  <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span>
@@ -934,6 +931,7 @@ Only refreshes if the token was not provided by the user and is expiring within
934
931
  <span class="w"> </span><span class="p">},</span>
935
932
  <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
936
933
  <span class="w"> </span><span class="p">};</span>
934
+ <span class="kd">const</span><span class="w"> </span><span class="nx">resultWithAttribution</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">requestWithAttribution</span><span class="p">);</span>
937
935
  </pre></div>
938
936
  </div>
939
937
  </div>
@@ -1000,6 +998,146 @@ Supports optional attribution with revenue for proportional allocation.</p>
1000
998
  </pre></div>
1001
999
  </div>
1002
1000
  </div>
1001
+ <div class="admonition-example admonition">
1002
+ <p class="admonition-title">Example</p>
1003
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Economic activity request with attribution (equity/debt based for private companies)</span>
1004
+ <span class="kd">const</span><span class="w"> </span><span class="nx">requestWithEquityDebt</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
1005
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1006
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span>
1007
+ <span class="w"> </span><span class="p">},</span>
1008
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1009
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1010
+ <span class="w"> </span><span class="p">},</span>
1011
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1012
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
1013
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
1014
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
1015
+ <span class="w"> </span><span class="p">},</span>
1016
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1017
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
1018
+ <span class="w"> </span><span class="s2">&quot;totalEquity&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">3000000.0</span><span class="p">,</span>
1019
+ <span class="w"> </span><span class="s2">&quot;totalDebt&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
1020
+ <span class="w"> </span><span class="p">},</span>
1021
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1022
+ <span class="w"> </span><span class="p">};</span>
1023
+ <span class="kd">const</span><span class="w"> </span><span class="nx">resultWithEquityDebt</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">requestWithEquityDebt</span><span class="p">);</span>
1024
+ </pre></div>
1025
+ </div>
1026
+ </div>
1027
+ <div class="admonition-example admonition">
1028
+ <p class="admonition-title">Example</p>
1029
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Economic activity request with attribution (EVIC based for listed companies)</span>
1030
+ <span class="kd">const</span><span class="w"> </span><span class="nx">requestWithEvic</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
1031
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1032
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span>
1033
+ <span class="w"> </span><span class="p">},</span>
1034
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1035
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1036
+ <span class="w"> </span><span class="p">},</span>
1037
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1038
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
1039
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
1040
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
1041
+ <span class="w"> </span><span class="p">},</span>
1042
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1043
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
1044
+ <span class="w"> </span><span class="s2">&quot;evic&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">10000000.0</span>
1045
+ <span class="w"> </span><span class="p">},</span>
1046
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1047
+ <span class="w"> </span><span class="p">};</span>
1048
+ <span class="kd">const</span><span class="w"> </span><span class="nx">resultWithEvic</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">requestWithEvic</span><span class="p">);</span>
1049
+ </pre></div>
1050
+ </div>
1051
+ </div>
1052
+ </dd></dl>
1053
+
1054
+ <dl class="js function">
1055
+ <dt class="sig sig-object js" id="PhysicalActivity.calculate">
1056
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">PhysicalActivity</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">calculate</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PhysicalActivity.calculate" title="Link to this definition">¶</a></dt>
1057
+ <dd><p>Performs scope 3 Physical activity emission calculations by making a POST request to the physical activity API endpoint.
1058
+ Supports attribution for private companies using equity/debt based calculations or EVIC (Enterprise Value Including Cash).</p>
1059
+ <dl class="field-list simple">
1060
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1061
+ <dd class="field-odd"><ul class="simple">
1062
+ <li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the API</p></li>
1063
+ </ul>
1064
+ </dd>
1065
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
1066
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;EmissionResponse | EmissionResponseWithDetails&gt;</span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
1067
+ </dd>
1068
+ </dl>
1069
+ <div class="admonition-example admonition">
1070
+ <p class="admonition-title">Example</p>
1071
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic physical activity request</span>
1072
+ <span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
1073
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1074
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-23&quot;</span>
1075
+ <span class="w"> </span><span class="p">},</span>
1076
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1077
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1078
+ <span class="w"> </span><span class="p">},</span>
1079
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1080
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;commercial real estate&quot;</span><span class="p">,</span>
1081
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">0.1</span><span class="p">,</span>
1082
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;km2&quot;</span>
1083
+ <span class="w"> </span><span class="p">},</span>
1084
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1085
+ <span class="w"> </span><span class="p">};</span>
1086
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
1087
+ </pre></div>
1088
+ </div>
1089
+ </div>
1090
+ <div class="admonition-example admonition">
1091
+ <p class="admonition-title">Example</p>
1092
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Physical activity request with attribution (equity/debt based for private companies)</span>
1093
+ <span class="kd">const</span><span class="w"> </span><span class="nx">requestWithEquityDebt</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
1094
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1095
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-23&quot;</span>
1096
+ <span class="w"> </span><span class="p">},</span>
1097
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1098
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1099
+ <span class="w"> </span><span class="p">},</span>
1100
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1101
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;commercial real estate&quot;</span><span class="p">,</span>
1102
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">0.1</span><span class="p">,</span>
1103
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;km2&quot;</span>
1104
+ <span class="w"> </span><span class="p">},</span>
1105
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1106
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000</span><span class="p">,</span>
1107
+ <span class="w"> </span><span class="s2">&quot;totalEquity&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">3000000</span><span class="p">,</span>
1108
+ <span class="w"> </span><span class="s2">&quot;totalDebt&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000</span>
1109
+ <span class="w"> </span><span class="p">},</span>
1110
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1111
+ <span class="w"> </span><span class="p">};</span>
1112
+ <span class="kd">const</span><span class="w"> </span><span class="nx">resultWithEquityDebt</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">requestWithEquityDebt</span><span class="p">);</span>
1113
+ </pre></div>
1114
+ </div>
1115
+ </div>
1116
+ <div class="admonition-example admonition">
1117
+ <p class="admonition-title">Example</p>
1118
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Physical activity request with attribution (EVIC based)</span>
1119
+ <span class="kd">const</span><span class="w"> </span><span class="nx">requestWithEVIC</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
1120
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1121
+ <span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-23&quot;</span>
1122
+ <span class="w"> </span><span class="p">},</span>
1123
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1124
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span>
1125
+ <span class="w"> </span><span class="p">},</span>
1126
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1127
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;commercial real estate&quot;</span><span class="p">,</span>
1128
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">0.1</span><span class="p">,</span>
1129
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;km2&quot;</span>
1130
+ <span class="w"> </span><span class="p">},</span>
1131
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1132
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
1133
+ <span class="w"> </span><span class="s2">&quot;evic&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">10000000.0</span>
1134
+ <span class="w"> </span><span class="p">},</span>
1135
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1136
+ <span class="w"> </span><span class="p">};</span>
1137
+ <span class="kd">const</span><span class="w"> </span><span class="nx">resultWithEVIC</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">requestWithEVIC</span><span class="p">);</span>
1138
+ </pre></div>
1139
+ </div>
1140
+ </div>
1003
1141
  </dd></dl>
1004
1142
 
1005
1143
  </section>
@@ -1195,6 +1333,80 @@ gracefully and the current configuration is returned.</p>
1195
1333
  </div>
1196
1334
  </dd></dl>
1197
1335
 
1336
+ </section>
1337
+ <section id="audit-export-api">
1338
+ <h2>Audit Export API<a class="headerlink" href="#audit-export-api" title="Link to this heading">¶</a></h2>
1339
+ <p>The Audit Export API asynchronously generates an audit-data ZIP archive for an admin user. Call <code class="docutils literal notranslate"><span class="pre">trigger</span></code> to create an export, <code class="docutils literal notranslate"><span class="pre">getStatus</span></code> until it is complete, and <code class="docutils literal notranslate"><span class="pre">download</span></code> to retrieve the archive.</p>
1340
+ <dl class="js function">
1341
+ <dt class="sig sig-object js" id="AuditExport.trigger">
1342
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditExport</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">trigger</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#AuditExport.trigger" title="Link to this definition">¶</a></dt>
1343
+ <dd><p>Triggers an asynchronous audit data export.</p>
1344
+ <dl class="field-list simple">
1345
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1346
+ <dd class="field-odd"><ul class="simple">
1347
+ <li><p><strong>payload</strong> (<span class="sphinx_js-type">AuditExportRequest</span>) – Date range and optional API-name filter for the export</p></li>
1348
+ </ul>
1349
+ </dd>
1350
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
1351
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;AuditExportResponse&gt;</span> – The accepted export request, including its request ID</p>
1352
+ </dd>
1353
+ </dl>
1354
+ <div class="admonition-example admonition">
1355
+ <p class="admonition-title">Example</p>
1356
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">auditExport</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">trigger</span><span class="p">({</span>
1357
+ <span class="w"> </span><span class="nx">fromDate</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-01&quot;</span><span class="p">,</span>
1358
+ <span class="w"> </span><span class="nx">toDate</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-03-31&quot;</span><span class="p">,</span>
1359
+ <span class="w"> </span><span class="nx">apiName</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;location&quot;</span>
1360
+ <span class="p">});</span>
1361
+ </pre></div>
1362
+ </div>
1363
+ </div>
1364
+ </dd></dl>
1365
+
1366
+ <dl class="js function">
1367
+ <dt class="sig sig-object js" id="AuditExport.getStatus">
1368
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditExport</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getStatus</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">requestId</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#AuditExport.getStatus" title="Link to this definition">¶</a></dt>
1369
+ <dd><p>Retrieves the processing status of an audit export.</p>
1370
+ <dl class="field-list simple">
1371
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1372
+ <dd class="field-odd"><ul class="simple">
1373
+ <li><p><strong>requestId</strong> (<span class="sphinx_js-type">string</span>) – Request ID returned by trigger</p></li>
1374
+ </ul>
1375
+ </dd>
1376
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
1377
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;AuditExportStatusResponse&gt;</span> – Current export status and, when complete, download details</p>
1378
+ </dd>
1379
+ </dl>
1380
+ <div class="admonition-example admonition">
1381
+ <p class="admonition-title">Example</p>
1382
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">getStatus</span><span class="p">(</span><span class="nx">auditExport</span><span class="p">.</span><span class="nx">requestId</span><span class="p">);</span>
1383
+ </pre></div>
1384
+ </div>
1385
+ </div>
1386
+ </dd></dl>
1387
+
1388
+ <dl class="js function">
1389
+ <dt class="sig sig-object js" id="AuditExport.download">
1390
+ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditExport</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">download</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">requestId</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#AuditExport.download" title="Link to this definition">¶</a></dt>
1391
+ <dd><p>Downloads a completed audit export as a ZIP archive.</p>
1392
+ <dl class="field-list simple">
1393
+ <dt class="field-odd">Arguments<span class="colon">:</span></dt>
1394
+ <dd class="field-odd"><ul class="simple">
1395
+ <li><p><strong>requestId</strong> (<span class="sphinx_js-type">string</span>) – Request ID returned by trigger</p></li>
1396
+ </ul>
1397
+ </dd>
1398
+ <dt class="field-even">Returns<span class="colon">:</span></dt>
1399
+ <dd class="field-even"><p><span class="sphinx_js-type">Promise&lt;Buffer&lt;ArrayBufferLike&gt;&gt;</span> – ZIP archive containing audit-export.csv</p>
1400
+ </dd>
1401
+ </dl>
1402
+ <div class="admonition-example admonition">
1403
+ <p class="admonition-title">Example</p>
1404
+ <div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">auditExportZip</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">download</span><span class="p">(</span><span class="nx">auditExport</span><span class="p">.</span><span class="nx">requestId</span><span class="p">);</span>
1405
+ </pre></div>
1406
+ </div>
1407
+ </div>
1408
+ </dd></dl>
1409
+
1198
1410
  </section>
1199
1411
  <section id="global-metadata-api">
1200
1412
  <h2>Global Metadata API<a class="headerlink" href="#global-metadata-api" title="Link to this heading">¶</a></h2>
@@ -1651,6 +1863,46 @@ Used to configure which parts of API interactions should be logged.</p>
1651
1863
  <dd><p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.TypeRecommenderResponse</span></code></p>
1652
1864
  </dd></dl>
1653
1865
 
1866
+ <dl class="js interface">
1867
+ <dt class="sig sig-object js" id="AuditExportResponse.AuditExportRequest">
1868
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditExportResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditExportRequest</span></span></span><a class="headerlink" href="#AuditExportResponse.AuditExportRequest" title="Link to this definition">¶</a></dt>
1869
+ <dd><p>Request body used to trigger an audit data export.</p>
1870
+ <blockquote>
1871
+ <div><p>AuditExportRequest</p>
1872
+ </div></blockquote>
1873
+ <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditExportResponse</span></code></p>
1874
+ </dd></dl>
1875
+
1876
+ <dl class="js interface">
1877
+ <dt class="sig sig-object js" id="AuditExportResponse.AuditExportResponse">
1878
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditExportResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditExportResponse</span></span></span><a class="headerlink" href="#AuditExportResponse.AuditExportResponse" title="Link to this definition">¶</a></dt>
1879
+ <dd><p>Response returned when an audit export is accepted.</p>
1880
+ <blockquote>
1881
+ <div><p>AuditExportResponse</p>
1882
+ </div></blockquote>
1883
+ <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditExportResponse</span></code></p>
1884
+ </dd></dl>
1885
+
1886
+ <dl class="js interface">
1887
+ <dt class="sig sig-object js" id="AuditExportResponse.AuditExportStatusResponse">
1888
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditExportResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditExportStatusResponse</span></span></span><a class="headerlink" href="#AuditExportResponse.AuditExportStatusResponse" title="Link to this definition">¶</a></dt>
1889
+ <dd><p>Response returned when checking an audit export’s status.</p>
1890
+ <blockquote>
1891
+ <div><p>AuditExportStatusResponse</p>
1892
+ </div></blockquote>
1893
+ <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditExportResponse</span></code></p>
1894
+ </dd></dl>
1895
+
1896
+ <dl class="js interface">
1897
+ <dt class="sig sig-object js" id="AuditExportResponse.AuditExportLinks">
1898
+ <em class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">AuditExportResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditExportLinks</span></span></span><a class="headerlink" href="#AuditExportResponse.AuditExportLinks" title="Link to this definition">¶</a></dt>
1899
+ <dd><p>Follow-up links returned by the audit export API.</p>
1900
+ <blockquote>
1901
+ <div><p>AuditExportLinks</p>
1902
+ </div></blockquote>
1903
+ <p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditExportResponse</span></code></p>
1904
+ </dd></dl>
1905
+
1654
1906
  </section>
1655
1907
  </section>
1656
1908
 
@@ -1733,6 +1985,7 @@ Used to configure which parts of API interactions should be logged.</p>
1733
1985
  <li><a class="reference internal" href="#TransportationAndDistribution.calculate"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.calculate()</span></code></a></li>
1734
1986
  <li><a class="reference internal" href="#RealEstate.calculate"><code class="docutils literal notranslate"><span class="pre">RealEstate.calculate()</span></code></a></li>
1735
1987
  <li><a class="reference internal" href="#EconomicActivity.calculate"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></a></li>
1988
+ <li><a class="reference internal" href="#PhysicalActivity.calculate"><code class="docutils literal notranslate"><span class="pre">PhysicalActivity.calculate()</span></code></a></li>
1736
1989
  </ul>
1737
1990
  </li>
1738
1991
  <li><a class="reference internal" href="#type-recommender-api">Type Recommender API</a><ul>
@@ -1744,6 +1997,12 @@ Used to configure which parts of API interactions should be logged.</p>
1744
1997
  <li><a class="reference internal" href="#AuditLog.updateAuditConfig"><code class="docutils literal notranslate"><span class="pre">AuditLog.updateAuditConfig()</span></code></a></li>
1745
1998
  </ul>
1746
1999
  </li>
2000
+ <li><a class="reference internal" href="#audit-export-api">Audit Export API</a><ul>
2001
+ <li><a class="reference internal" href="#AuditExport.trigger"><code class="docutils literal notranslate"><span class="pre">AuditExport.trigger()</span></code></a></li>
2002
+ <li><a class="reference internal" href="#AuditExport.getStatus"><code class="docutils literal notranslate"><span class="pre">AuditExport.getStatus()</span></code></a></li>
2003
+ <li><a class="reference internal" href="#AuditExport.download"><code class="docutils literal notranslate"><span class="pre">AuditExport.download()</span></code></a></li>
2004
+ </ul>
2005
+ </li>
1747
2006
  <li><a class="reference internal" href="#global-metadata-api">Global Metadata API</a><ul>
1748
2007
  <li><a class="reference internal" href="#gettypes">getTypes</a><ul>
1749
2008
  <li><a class="reference internal" href="#Metadata.getTypes"><code class="docutils literal notranslate"><span class="pre">Metadata.getTypes()</span></code></a></li>
@@ -1792,6 +2051,10 @@ Used to configure which parts of API interactions should be logged.</p>
1792
2051
  <li><a class="reference internal" href="#AuditLogResponse.AuditLogRequest"><code class="docutils literal notranslate"><span class="pre">AuditLogResponse.AuditLogRequest</span></code></a></li>
1793
2052
  <li><a class="reference internal" href="#TypeRecommenderResponse.TypeRecommenderResponse"><code class="docutils literal notranslate"><span class="pre">TypeRecommenderResponse.TypeRecommenderResponse</span></code></a></li>
1794
2053
  <li><a class="reference internal" href="#TypeRecommenderResponse.ActivityRequest"><code class="docutils literal notranslate"><span class="pre">TypeRecommenderResponse.ActivityRequest</span></code></a></li>
2054
+ <li><a class="reference internal" href="#AuditExportResponse.AuditExportRequest"><code class="docutils literal notranslate"><span class="pre">AuditExportResponse.AuditExportRequest</span></code></a></li>
2055
+ <li><a class="reference internal" href="#AuditExportResponse.AuditExportResponse"><code class="docutils literal notranslate"><span class="pre">AuditExportResponse.AuditExportResponse</span></code></a></li>
2056
+ <li><a class="reference internal" href="#AuditExportResponse.AuditExportStatusResponse"><code class="docutils literal notranslate"><span class="pre">AuditExportResponse.AuditExportStatusResponse</span></code></a></li>
2057
+ <li><a class="reference internal" href="#AuditExportResponse.AuditExportLinks"><code class="docutils literal notranslate"><span class="pre">AuditExportResponse.AuditExportLinks</span></code></a></li>
1795
2058
  </ul>
1796
2059
  </li>
1797
2060
  </ul>