emissions-api-sdk 1.0.12 → 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 (106) hide show
  1. package/README.md +42 -2
  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 +19 -0
  6. package/dist/api/PhysicalActivity.js +87 -0
  7. package/dist/api/RealEstate.js +23 -0
  8. package/dist/api/TypeRecommender.js +19 -2
  9. package/dist/coverage/clover.xml +149 -87
  10. package/dist/coverage/coverage-final.json +14 -8
  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 +59 -2
  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 +55 -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 +1 -1
  43. package/dist/coverage/lcov-report/test/mocks/index.html +63 -3
  44. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  45. package/dist/coverage/lcov.info +249 -122
  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 +19 -0
  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 +19 -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 +40 -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/basic.css +8 -0
  66. package/docs/_static/doctools.js +5 -6
  67. package/docs/_static/language_data.js +186 -7
  68. package/docs/_static/pygments.css +146 -164
  69. package/docs/_static/searchtools.js +60 -121
  70. package/docs/_static/sphinx_highlight.js +31 -36
  71. package/docs/_static/styles/furo.css +1 -1
  72. package/docs/_static/styles/furo.css.map +1 -1
  73. package/docs/authentication.html +61 -26
  74. package/docs/client.html +33 -22
  75. package/docs/genindex.html +52 -23
  76. package/docs/getting_started.html +745 -103
  77. package/docs/index.html +65 -21
  78. package/docs/reference.html +484 -66
  79. package/docs/sdk.html +32 -21
  80. package/docs/search.html +32 -21
  81. package/docs/searchindex.js +1 -1
  82. package/docs/troubleshooting.html +105 -38
  83. package/package.json +7 -3
  84. package/sphinx-build/source/authentication.rst +26 -4
  85. package/sphinx-build/source/getting_started.rst +538 -74
  86. package/sphinx-build/source/index.rst +11 -0
  87. package/sphinx-build/source/reference.rst +26 -0
  88. package/sphinx-build/source/troubleshooting.rst +77 -12
  89. package/src/Constants.ts +3 -0
  90. package/src/api/AuditLog.ts +102 -0
  91. package/src/api/EconomicActivity.ts +24 -0
  92. package/src/api/Factor.ts +19 -0
  93. package/src/api/PhysicalActivity.ts +92 -0
  94. package/src/api/RealEstate.ts +23 -0
  95. package/src/api/TypeRecommender.ts +19 -2
  96. package/src/index.ts +7 -1
  97. package/src/interfaces/Api.ts +22 -6
  98. package/src/interfaces/common.ts +46 -0
  99. package/src/interfaces/response/AuditLogResponse.ts +47 -0
  100. package/src/interfaces/response/TypeRecommenderResponse.ts +2 -0
  101. package/test/apiTest.test.ts +59 -3
  102. package/test/auditLog.test.ts +216 -0
  103. package/test/mocks/AttributionRequest.ts +23 -0
  104. package/test/mocks/EconomicActivityAttributionRequest.ts +22 -0
  105. package/test/mocks/PhysicalActivityEVICRequest.ts +22 -0
  106. package/test/mocks/PhysicalActivityRequest.ts +23 -0
package/dist/coverage/lcov-report/src/api/AuditLog.ts.html ADDED
@@ -0,0 +1,388 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/api/AuditLog.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> AuditLog.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'>26/26</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">90.47% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>19/21</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'>26/26</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>
157
+ <a name='L92'></a><a href='#L92'>92</a>
158
+ <a name='L93'></a><a href='#L93'>93</a>
159
+ <a name='L94'></a><a href='#L94'>94</a>
160
+ <a name='L95'></a><a href='#L95'>95</a>
161
+ <a name='L96'></a><a href='#L96'>96</a>
162
+ <a name='L97'></a><a href='#L97'>97</a>
163
+ <a name='L98'></a><a href='#L98'>98</a>
164
+ <a name='L99'></a><a href='#L99'>99</a>
165
+ <a name='L100'></a><a href='#L100'>100</a>
166
+ <a name='L101'></a><a href='#L101'>101</a>
167
+ <a name='L102'></a><a href='#L102'>102</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">2x</span>
168
+ <span class="cline-any cline-yes">2x</span>
169
+ <span class="cline-any cline-yes">2x</span>
170
+ <span class="cline-any cline-neutral">&nbsp;</span>
171
+ <span class="cline-any cline-yes">2x</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-yes">8x</span>
182
+ <span class="cline-any cline-yes">6x</span>
183
+ <span class="cline-any cline-yes">6x</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-yes">6x</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-neutral">&nbsp;</span>
191
+ <span class="cline-any cline-yes">5x</span>
192
+ <span class="cline-any cline-yes">1x</span>
193
+ <span class="cline-any cline-neutral">&nbsp;</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-yes">4x</span>
197
+ <span class="cline-any cline-yes">2x</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-yes">4x</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-neutral">&nbsp;</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-neutral">&nbsp;</span>
215
+ <span class="cline-any cline-neutral">&nbsp;</span>
216
+ <span class="cline-any cline-neutral">&nbsp;</span>
217
+ <span class="cline-any cline-neutral">&nbsp;</span>
218
+ <span class="cline-any cline-neutral">&nbsp;</span>
219
+ <span class="cline-any cline-yes">2x</span>
220
+ <span class="cline-any cline-yes">5x</span>
221
+ <span class="cline-any cline-yes">5x</span>
222
+ <span class="cline-any cline-neutral">&nbsp;</span>
223
+ <span class="cline-any cline-yes">5x</span>
224
+ <span class="cline-any cline-yes">5x</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-yes">3x</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-neutral">&nbsp;</span>
236
+ <span class="cline-any cline-neutral">&nbsp;</span>
237
+ <span class="cline-any cline-neutral">&nbsp;</span>
238
+ <span class="cline-any cline-neutral">&nbsp;</span>
239
+ <span class="cline-any cline-neutral">&nbsp;</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>
247
+ <span class="cline-any cline-neutral">&nbsp;</span>
248
+ <span class="cline-any cline-neutral">&nbsp;</span>
249
+ <span class="cline-any cline-neutral">&nbsp;</span>
250
+ <span class="cline-any cline-neutral">&nbsp;</span>
251
+ <span class="cline-any cline-neutral">&nbsp;</span>
252
+ <span class="cline-any cline-neutral">&nbsp;</span>
253
+ <span class="cline-any cline-yes">2x</span>
254
+ <span class="cline-any cline-neutral">&nbsp;</span>
255
+ <span class="cline-any cline-neutral">&nbsp;</span>
256
+ <span class="cline-any cline-yes">7x</span>
257
+ <span class="cline-any cline-yes">7x</span>
258
+ <span class="cline-any cline-neutral">&nbsp;</span>
259
+ <span class="cline-any cline-yes">7x</span>
260
+ <span class="cline-any cline-yes">7x</span>
261
+ <span class="cline-any cline-neutral">&nbsp;</span>
262
+ <span class="cline-any cline-neutral">&nbsp;</span>
263
+ <span class="cline-any cline-neutral">&nbsp;</span>
264
+ <span class="cline-any cline-neutral">&nbsp;</span>
265
+ <span class="cline-any cline-neutral">&nbsp;</span>
266
+ <span class="cline-any cline-yes">5x</span>
267
+ <span class="cline-any cline-neutral">&nbsp;</span>
268
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import axios from "axios";
269
+ import { makeApiRequest } from "../request";
270
+ import { AUDIT_LOG_API_PATH, GET, PUT } from "../Constants";
271
+ import { AuditLogRequest, AuditLogResponse } from "../interfaces/response/AuditLogResponse";
272
+ import { Client } from "../Client";
273
+ &nbsp;
274
+ /**
275
+ * Handles common error responses for audit log API calls.
276
+ *
277
+ * @param {unknown} error - The error to handle
278
+ * @param {boolean} handle409 - Whether to handle 409 Conflict status (returns data instead of throwing)
279
+ * @return {AuditLogResponse | never} Returns response data for 409, otherwise throws error
280
+ */
281
+ function handleAuditLogError(error: unknown, handle409: boolean = false): AuditLogResponse | never {
282
+ if (axios.isAxiosError(error) &amp;&amp; error.response) {
283
+ const status = error.response.status;
284
+ const responseData = error.response.data;
285
+
286
+ // Handle 409 Conflict - configuration is already set to the requested values
287
+ if (status === 409 &amp;&amp; handle409) {
288
+ return responseData as AuditLogResponse;
289
+ }
290
+
291
+ // Handle 400 Bad Request - invalid payload
292
+ if (status === 400) {
293
+ throw new Error(responseData<span class="branch-0 cbranch-no" title="branch not covered" >?.m</span>essage);
294
+ }
295
+
296
+ // Handle 403 Forbidden - insufficient permissions
297
+ if (status === 403) {
298
+ throw new Error(responseData<span class="branch-0 cbranch-no" title="branch not covered" >?.m</span>essage);
299
+ }
300
+ }
301
+
302
+ // Re-throw any other errors
303
+ throw error;
304
+ }
305
+ &nbsp;
306
+ /**
307
+ * Retrieves the audit log configuration for the organization.
308
+ *
309
+ * Controls whether the organization's API requests and responses are stored for auditing.
310
+ * Organizations can disable this if they don't need their API calls to be audited.
311
+ *
312
+ * @export
313
+ * @return {Promise&lt;AuditLogResponse&gt;} Current audit log configuration
314
+ * @throws {Error} Throws error for 403 (Forbidden) or other failures
315
+ *
316
+ * @example
317
+ * const config = await getConfig();
318
+ * // Output: { logRequest: true, logResponse: false }
319
+ */
320
+ export async function getAuditConfig(): Promise&lt;AuditLogResponse&gt; {
321
+ const client = Client.getInstance();
322
+ const url = client.getDomain() + AUDIT_LOG_API_PATH;
323
+ &nbsp;
324
+ try {
325
+ return await makeApiRequest&lt;AuditLogResponse&gt;({
326
+ method: GET,
327
+ url,
328
+ });
329
+ } catch (error) {
330
+ return handleAuditLogError(error);
331
+ }
332
+ }
333
+ &nbsp;
334
+ /**
335
+ * Updates the audit log configuration for the organization.
336
+ *
337
+ * Controls whether the organization's API requests and responses are stored for auditing.
338
+ * Organizations can disable this if they don't need their API calls to be audited.
339
+ *
340
+ * Note: If the configuration is already set to the requested values, the API will return
341
+ * a 409 Conflict status with a message indicating no change was made. This is handled
342
+ * gracefully and the current configuration is returned.
343
+ *
344
+ * @export
345
+ * @param {AuditLogRequest} payload - Audit log configuration
346
+ * @return {Promise&lt;AuditLogResponse&gt;} Updated configuration or current configuration if no change
347
+ * @throws {Error} Throws error for 400 (Bad Request), 403 (Forbidden), or other failures
348
+ *
349
+ * @example
350
+ * const result = await update({ logRequest: false, logResponse: false });
351
+ * // If already set to these values:
352
+ * // { logRequest: false, logResponse: false, message: "No change in audit log configuration" }
353
+ */
354
+ export async function updateAuditConfig(
355
+ payload: AuditLogRequest
356
+ ): Promise&lt;AuditLogResponse&gt; {
357
+ const client = Client.getInstance();
358
+ const url = client.getDomain() + AUDIT_LOG_API_PATH;
359
+ &nbsp;
360
+ try {
361
+ return await makeApiRequest&lt;AuditLogResponse&gt;({
362
+ method: PUT,
363
+ url,
364
+ data: payload,
365
+ });
366
+ } catch (error) {
367
+ return handleAuditLogError(error, true);
368
+ }
369
+ }</pre></td></tr></table></pre>
370
+
371
+ <div class='push'></div><!-- for sticky footer -->
372
+ </div><!-- /wrapper -->
373
+ <div class='footer quiet pad2 space-top1 center small'>
374
+ Code coverage generated by
375
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
376
+ at 2026-06-30T08:27:03.967Z
377
+ </div>
378
+ <script src="../../prettify.js"></script>
379
+ <script>
380
+ window.onload = function () {
381
+ prettyPrint();
382
+ };
383
+ </script>
384
+ <script src="../../sorter.js"></script>
385
+ <script src="../../block-navigation.js"></script>
386
+ </body>
387
+ </html>
388
+
package/dist/coverage/lcov-report/src/api/Calculation.ts.html CHANGED
@@ -211,7 +211,7 @@ export async function calculate(
211
211
  <div class='footer quiet pad2 space-top1 center small'>
212
212
  Code coverage generated by
213
213
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
214
- at 2026-05-11T08:42:18.203Z
214
+ at 2026-06-30T08:27:03.967Z
215
215
  </div>
216
216
  <script src="../../prettify.js"></script>
217
217
  <script>
package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html CHANGED
@@ -108,7 +108,31 @@
108
108
  <a name='L43'></a><a href='#L43'>43</a>
109
109
  <a name='L44'></a><a href='#L44'>44</a>
110
110
  <a name='L45'></a><a href='#L45'>45</a>
111
- <a name='L46'></a><a href='#L46'>46</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
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></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
112
136
  <span class="cline-any cline-yes">1x</span>
113
137
  <span class="cline-any cline-neutral">&nbsp;</span>
114
138
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -141,15 +165,39 @@
141
165
  <span class="cline-any cline-neutral">&nbsp;</span>
142
166
  <span class="cline-any cline-neutral">&nbsp;</span>
143
167
  <span class="cline-any cline-neutral">&nbsp;</span>
144
- <span class="cline-any cline-yes">1x</span>
145
168
  <span class="cline-any cline-neutral">&nbsp;</span>
146
169
  <span class="cline-any cline-neutral">&nbsp;</span>
147
- <span class="cline-any cline-yes">1x</span>
148
- <span class="cline-any cline-yes">1x</span>
170
+ <span class="cline-any cline-neutral">&nbsp;</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-neutral">&nbsp;</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-neutral">&nbsp;</span>
149
191
  <span class="cline-any cline-neutral">&nbsp;</span>
150
192
  <span class="cline-any cline-yes">1x</span>
151
193
  <span class="cline-any cline-neutral">&nbsp;</span>
152
194
  <span class="cline-any cline-neutral">&nbsp;</span>
195
+ <span class="cline-any cline-yes">2x</span>
196
+ <span class="cline-any cline-yes">2x</span>
197
+ <span class="cline-any cline-neutral">&nbsp;</span>
198
+ <span class="cline-any cline-yes">2x</span>
199
+ <span class="cline-any cline-neutral">&nbsp;</span>
200
+ <span class="cline-any cline-neutral">&nbsp;</span>
153
201
  <span class="cline-any cline-neutral">&nbsp;</span>
154
202
  <span class="cline-any cline-neutral">&nbsp;</span>
155
203
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -162,6 +210,7 @@ import { makeApiRequest } from "../request";
162
210
  &nbsp;
163
211
  /**
164
212
  * Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.
213
+ * Supports optional attribution with revenue for proportional allocation.
165
214
  *
166
215
  * @export
167
216
  * @param {CommonRequest} payload - The request data to be sent to the API
@@ -169,6 +218,7 @@ import { makeApiRequest } from "../request";
169
218
  * @throws {Error} May throw an error if the API request fails
170
219
  *
171
220
  * @example
221
+ * // Basic economic activity request
172
222
  * const request = {
173
223
  "time": {
174
224
  "date": "2025-01-04"
@@ -184,6 +234,28 @@ import { makeApiRequest } from "../request";
184
234
  "includeDetails": false
185
235
  };
186
236
  * const result = await calculate(request);
237
+ *
238
+ * @example
239
+ * // Economic activity request with revenue attribution
240
+ * const requestWithAttribution = {
241
+ "time": {
242
+ "date": "2025-01-04"
243
+ },
244
+ "location": {
245
+ "country": "usa"
246
+ },
247
+ "activity": {
248
+ "type": "accomodation",
249
+ "value": 1500.12,
250
+ "unit": "usd"
251
+ },
252
+ "attribution": {
253
+ "outstandingAmount": 500000.0,
254
+ "revenue": 2000000.0
255
+ },
256
+ "includeDetails": true
257
+ };
258
+ * const resultWithAttribution = await calculate(requestWithAttribution);
187
259
  */
188
260
  &nbsp;
189
261
  export async function calculate(
@@ -205,7 +277,7 @@ export async function calculate(
205
277
  <div class='footer quiet pad2 space-top1 center small'>
206
278
  Code coverage generated by
207
279
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
208
- at 2026-05-11T08:42:18.203Z
280
+ at 2026-06-30T08:27:03.967Z
209
281
  </div>
210
282
  <script src="../../prettify.js"></script>
211
283
  <script>
package/dist/coverage/lcov-report/src/api/Factor.ts.html CHANGED
@@ -201,7 +201,26 @@
201
201
  <a name='L136'></a><a href='#L136'>136</a>
202
202
  <a name='L137'></a><a href='#L137'>137</a>
203
203
  <a name='L138'></a><a href='#L138'>138</a>
204
- <a name='L139'></a><a href='#L139'>139</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
204
+ <a name='L139'></a><a href='#L139'>139</a>
205
+ <a name='L140'></a><a href='#L140'>140</a>
206
+ <a name='L141'></a><a href='#L141'>141</a>
207
+ <a name='L142'></a><a href='#L142'>142</a>
208
+ <a name='L143'></a><a href='#L143'>143</a>
209
+ <a name='L144'></a><a href='#L144'>144</a>
210
+ <a name='L145'></a><a href='#L145'>145</a>
211
+ <a name='L146'></a><a href='#L146'>146</a>
212
+ <a name='L147'></a><a href='#L147'>147</a>
213
+ <a name='L148'></a><a href='#L148'>148</a>
214
+ <a name='L149'></a><a href='#L149'>149</a>
215
+ <a name='L150'></a><a href='#L150'>150</a>
216
+ <a name='L151'></a><a href='#L151'>151</a>
217
+ <a name='L152'></a><a href='#L152'>152</a>
218
+ <a name='L153'></a><a href='#L153'>153</a>
219
+ <a name='L154'></a><a href='#L154'>154</a>
220
+ <a name='L155'></a><a href='#L155'>155</a>
221
+ <a name='L156'></a><a href='#L156'>156</a>
222
+ <a name='L157'></a><a href='#L157'>157</a>
223
+ <a name='L158'></a><a href='#L158'>158</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
205
224
  <span class="cline-any cline-yes">1x</span>
206
225
  <span class="cline-any cline-neutral">&nbsp;</span>
207
226
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -328,6 +347,25 @@
328
347
  <span class="cline-any cline-neutral">&nbsp;</span>
329
348
  <span class="cline-any cline-neutral">&nbsp;</span>
330
349
  <span class="cline-any cline-neutral">&nbsp;</span>
350
+ <span class="cline-any cline-neutral">&nbsp;</span>
351
+ <span class="cline-any cline-neutral">&nbsp;</span>
352
+ <span class="cline-any cline-neutral">&nbsp;</span>
353
+ <span class="cline-any cline-neutral">&nbsp;</span>
354
+ <span class="cline-any cline-neutral">&nbsp;</span>
355
+ <span class="cline-any cline-neutral">&nbsp;</span>
356
+ <span class="cline-any cline-neutral">&nbsp;</span>
357
+ <span class="cline-any cline-neutral">&nbsp;</span>
358
+ <span class="cline-any cline-neutral">&nbsp;</span>
359
+ <span class="cline-any cline-neutral">&nbsp;</span>
360
+ <span class="cline-any cline-neutral">&nbsp;</span>
361
+ <span class="cline-any cline-neutral">&nbsp;</span>
362
+ <span class="cline-any cline-neutral">&nbsp;</span>
363
+ <span class="cline-any cline-neutral">&nbsp;</span>
364
+ <span class="cline-any cline-neutral">&nbsp;</span>
365
+ <span class="cline-any cline-neutral">&nbsp;</span>
366
+ <span class="cline-any cline-neutral">&nbsp;</span>
367
+ <span class="cline-any cline-neutral">&nbsp;</span>
368
+ <span class="cline-any cline-neutral">&nbsp;</span>
331
369
  <span class="cline-any cline-yes">1x</span>
332
370
  <span class="cline-any cline-neutral">&nbsp;</span>
333
371
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -401,6 +439,9 @@ export async function retrieveFactor(
401
439
  * @return {Promise&lt;SearchResponse&gt;} A promise that resolves to the search results returned by the API
402
440
  * @throws {Error} May throw an error if the API request fails
403
441
  *
442
+ * The API applies cross-encoder reranking by default. Set `enableReranker` to
443
+ * `false` to keep semantic similarity ordering without reranking.
444
+ *
404
445
  * @example
405
446
  * // Basic search
406
447
  * const searchRequest = {
@@ -417,6 +458,22 @@ export async function retrieveFactor(
417
458
  * const results = await search(searchRequest);
418
459
  *
419
460
  * @example
461
+ * // Search without cross-encoder reranking
462
+ * const searchWithoutReranker = {
463
+ "time":{
464
+ "date": "2020-06-10"
465
+ },
466
+ "activity": {
467
+ "search" : "travel"
468
+ },
469
+ "location": {
470
+ "country": "USA"
471
+ },
472
+ "enableReranker": false
473
+ };
474
+ * const results = await search(searchWithoutReranker);
475
+ *
476
+ * @example
420
477
  * // Search with optional unit parameter
421
478
  * const searchWithUnit = {
422
479
  "time":{
@@ -484,7 +541,7 @@ export async function search(
484
541
  <div class='footer quiet pad2 space-top1 center small'>
485
542
  Code coverage generated by
486
543
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
487
- at 2026-05-11T08:42:18.203Z
544
+ at 2026-06-30T08:27:03.967Z
488
545
  </div>
489
546
  <script src="../../prettify.js"></script>
490
547
  <script>
package/dist/coverage/lcov-report/src/api/FactorSets.ts.html CHANGED
@@ -142,7 +142,7 @@ const client = Client.getInstance();
142
142
  <div class='footer quiet pad2 space-top1 center small'>
143
143
  Code coverage generated by
144
144
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
145
- at 2026-05-11T08:42:18.203Z
145
+ at 2026-06-30T08:27:03.967Z
146
146
  </div>
147
147
  <script src="../../prettify.js"></script>
148
148
  <script>
package/dist/coverage/lcov-report/src/api/Fugitive.ts.html CHANGED
@@ -205,7 +205,7 @@ export async function calculate(
205
205
  <div class='footer quiet pad2 space-top1 center small'>
206
206
  Code coverage generated by
207
207
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
208
- at 2026-05-11T08:42:18.203Z
208
+ at 2026-06-30T08:27:03.967Z
209
209
  </div>
210
210
  <script src="../../prettify.js"></script>
211
211
  <script>