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/dist/coverage/lcov-report/src/api/AuditExport.ts.html ADDED
@@ -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
+
package/dist/coverage/lcov-report/src/api/AuditLog.ts.html CHANGED
@@ -373,7 +373,7 @@ export async function updateAuditConfig(
373
373
  <div class='footer quiet pad2 space-top1 center small'>
374
374
  Code coverage generated by
375
375
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
376
- at 2026-06-30T08:27:03.967Z
376
+ at 2026-09-22T12:45:13.080Z
377
377
  </div>
378
378
  <script src="../../prettify.js"></script>
379
379
  <script>
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-06-30T08:27:03.967Z
214
+ at 2026-09-22T12:45:13.080Z
215
215
  </div>
216
216
  <script src="../../prettify.js"></script>
217
217
  <script>
package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html CHANGED
@@ -132,7 +132,52 @@
132
132
  <a name='L67'></a><a href='#L67'>67</a>
133
133
  <a name='L68'></a><a href='#L68'>68</a>
134
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>
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>
168
+ <a name='L103'></a><a href='#L103'>103</a>
169
+ <a name='L104'></a><a href='#L104'>104</a>
170
+ <a name='L105'></a><a href='#L105'>105</a>
171
+ <a name='L106'></a><a href='#L106'>106</a>
172
+ <a name='L107'></a><a href='#L107'>107</a>
173
+ <a name='L108'></a><a href='#L108'>108</a>
174
+ <a name='L109'></a><a href='#L109'>109</a>
175
+ <a name='L110'></a><a href='#L110'>110</a>
176
+ <a name='L111'></a><a href='#L111'>111</a>
177
+ <a name='L112'></a><a href='#L112'>112</a>
178
+ <a name='L113'></a><a href='#L113'>113</a>
179
+ <a name='L114'></a><a href='#L114'>114</a>
180
+ <a name='L115'></a><a href='#L115'>115</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
136
181
  <span class="cline-any cline-yes">1x</span>
137
182
  <span class="cline-any cline-neutral">&nbsp;</span>
138
183
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -189,6 +234,51 @@
189
234
  <span class="cline-any cline-neutral">&nbsp;</span>
190
235
  <span class="cline-any cline-neutral">&nbsp;</span>
191
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-neutral">&nbsp;</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-neutral">&nbsp;</span>
257
+ <span class="cline-any cline-neutral">&nbsp;</span>
258
+ <span class="cline-any cline-neutral">&nbsp;</span>
259
+ <span class="cline-any cline-neutral">&nbsp;</span>
260
+ <span class="cline-any cline-neutral">&nbsp;</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-neutral">&nbsp;</span>
267
+ <span class="cline-any cline-neutral">&nbsp;</span>
268
+ <span class="cline-any cline-neutral">&nbsp;</span>
269
+ <span class="cline-any cline-neutral">&nbsp;</span>
270
+ <span class="cline-any cline-neutral">&nbsp;</span>
271
+ <span class="cline-any cline-neutral">&nbsp;</span>
272
+ <span class="cline-any cline-neutral">&nbsp;</span>
273
+ <span class="cline-any cline-neutral">&nbsp;</span>
274
+ <span class="cline-any cline-neutral">&nbsp;</span>
275
+ <span class="cline-any cline-neutral">&nbsp;</span>
276
+ <span class="cline-any cline-neutral">&nbsp;</span>
277
+ <span class="cline-any cline-neutral">&nbsp;</span>
278
+ <span class="cline-any cline-neutral">&nbsp;</span>
279
+ <span class="cline-any cline-neutral">&nbsp;</span>
280
+ <span class="cline-any cline-neutral">&nbsp;</span>
281
+ <span class="cline-any cline-neutral">&nbsp;</span>
192
282
  <span class="cline-any cline-yes">1x</span>
193
283
  <span class="cline-any cline-neutral">&nbsp;</span>
194
284
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -256,6 +346,51 @@ import { makeApiRequest } from "../request";
256
346
  "includeDetails": true
257
347
  };
258
348
  * const resultWithAttribution = await calculate(requestWithAttribution);
349
+ *
350
+ * @example
351
+ * // Economic activity request with attribution (equity/debt based for private companies)
352
+ * const requestWithEquityDebt = {
353
+ "time": {
354
+ "date": "2025-01-04"
355
+ },
356
+ "location": {
357
+ "country": "usa"
358
+ },
359
+ "activity": {
360
+ "type": "accomodation",
361
+ "value": 1500.12,
362
+ "unit": "usd"
363
+ },
364
+ "attribution": {
365
+ "outstandingAmount": 500000.0,
366
+ "totalEquity": 3000000.0,
367
+ "totalDebt": 2000000.0
368
+ },
369
+ "includeDetails": true
370
+ };
371
+ * const resultWithEquityDebt = await calculate(requestWithEquityDebt);
372
+ *
373
+ * @example
374
+ * // Economic activity request with attribution (EVIC based for listed companies)
375
+ * const requestWithEvic = {
376
+ "time": {
377
+ "date": "2025-01-04"
378
+ },
379
+ "location": {
380
+ "country": "usa"
381
+ },
382
+ "activity": {
383
+ "type": "accomodation",
384
+ "value": 1500.12,
385
+ "unit": "usd"
386
+ },
387
+ "attribution": {
388
+ "outstandingAmount": 500000.0,
389
+ "evic": 10000000.0
390
+ },
391
+ "includeDetails": true
392
+ };
393
+ * const resultWithEvic = await calculate(requestWithEvic);
259
394
  */
260
395
  &nbsp;
261
396
  export async function calculate(
@@ -277,7 +412,7 @@ export async function calculate(
277
412
  <div class='footer quiet pad2 space-top1 center small'>
278
413
  Code coverage generated by
279
414
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
280
- at 2026-06-30T08:27:03.967Z
415
+ at 2026-09-22T12:45:13.080Z
281
416
  </div>
282
417
  <script src="../../prettify.js"></script>
283
418
  <script>
package/dist/coverage/lcov-report/src/api/Factor.ts.html CHANGED
@@ -218,9 +218,7 @@
218
218
  <a name='L153'></a><a href='#L153'>153</a>
219
219
  <a name='L154'></a><a href='#L154'>154</a>
220
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>
221
+ <a name='L156'></a><a href='#L156'>156</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
224
222
  <span class="cline-any cline-yes">1x</span>
225
223
  <span class="cline-any cline-neutral">&nbsp;</span>
226
224
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -363,9 +361,6 @@
363
361
  <span class="cline-any cline-neutral">&nbsp;</span>
364
362
  <span class="cline-any cline-neutral">&nbsp;</span>
365
363
  <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>
369
364
  <span class="cline-any cline-yes">1x</span>
370
365
  <span class="cline-any cline-neutral">&nbsp;</span>
371
366
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -377,6 +372,7 @@
377
372
  <span class="cline-any cline-neutral">&nbsp;</span>
378
373
  <span class="cline-any cline-neutral">&nbsp;</span>
379
374
  <span class="cline-any cline-neutral">&nbsp;</span>
375
+ <span class="cline-any cline-neutral">&nbsp;</span>
380
376
  <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Client } from "../Client";
381
377
  import { FACTOR_API_PATH, POST, SEARCH_API_PATH } from "../Constants";
382
378
  import { FactorRequest, SearchRequest } from "../interfaces/Api";
@@ -460,11 +456,8 @@ export async function retrieveFactor(
460
456
  * @example
461
457
  * // Search without cross-encoder reranking
462
458
  * const searchWithoutReranker = {
463
- "time":{
464
- "date": "2020-06-10"
465
- },
466
459
  "activity": {
467
- "search" : "travel"
460
+ "search": "travel"
468
461
  },
469
462
  "location": {
470
463
  "country": "USA"
@@ -534,14 +527,15 @@ export async function search(
534
527
  url,
535
528
  data: payload,
536
529
  });
537
- }</pre></td></tr></table></pre>
530
+ }
531
+ &nbsp;</pre></td></tr></table></pre>
538
532
 
539
533
  <div class='push'></div><!-- for sticky footer -->
540
534
  </div><!-- /wrapper -->
541
535
  <div class='footer quiet pad2 space-top1 center small'>
542
536
  Code coverage generated by
543
537
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
544
- at 2026-06-30T08:27:03.967Z
538
+ at 2026-09-22T12:45:13.080Z
545
539
  </div>
546
540
  <script src="../../prettify.js"></script>
547
541
  <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-06-30T08:27:03.967Z
145
+ at 2026-09-22T12:45:13.080Z
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-06-30T08:27:03.967Z
208
+ at 2026-09-22T12:45:13.080Z
209
209
  </div>
210
210
  <script src="../../prettify.js"></script>
211
211
  <script>
package/dist/coverage/lcov-report/src/api/Location.ts.html CHANGED
@@ -202,7 +202,7 @@ export async function calculate(
202
202
  <div class='footer quiet pad2 space-top1 center small'>
203
203
  Code coverage generated by
204
204
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
205
- at 2026-06-30T08:27:03.967Z
205
+ at 2026-09-22T12:45:13.080Z
206
206
  </div>
207
207
  <script src="../../prettify.js"></script>
208
208
  <script>
package/dist/coverage/lcov-report/src/api/Metadata.ts.html CHANGED
@@ -589,7 +589,7 @@ export async function postUnits(
589
589
  <div class='footer quiet pad2 space-top1 center small'>
590
590
  Code coverage generated by
591
591
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
592
- at 2026-06-30T08:27:03.967Z
592
+ at 2026-09-22T12:45:13.080Z
593
593
  </div>
594
594
  <script src="../../prettify.js"></script>
595
595
  <script>