emissions-api-sdk 1.0.12 → 1.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -2
- package/dist/Constants.js +7 -1
- package/dist/api/AuditExport.js +73 -0
- package/dist/api/AuditLog.js +99 -0
- package/dist/api/EconomicActivity.js +69 -0
- package/dist/api/Factor.js +16 -0
- package/dist/api/PhysicalActivity.js +87 -0
- package/dist/api/RealEstate.js +25 -1
- package/dist/api/TypeRecommender.js +19 -2
- package/dist/coverage/clover.xml +172 -89
- package/dist/coverage/coverage-final.json +15 -8
- package/dist/coverage/lcov-report/index.html +21 -21
- package/dist/coverage/lcov-report/src/Client.ts.html +32 -32
- package/dist/coverage/lcov-report/src/Constants.ts.html +45 -27
- package/dist/coverage/lcov-report/src/api/AuditExport.ts.html +355 -0
- package/dist/coverage/lcov-report/src/api/AuditLog.ts.html +388 -0
- package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +212 -5
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +54 -3
- package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/PhysicalActivity.ts.html +361 -0
- package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +78 -6
- package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +55 -4
- package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/index.html +51 -6
- package/dist/coverage/lcov-report/src/index.html +7 -7
- package/dist/coverage/lcov-report/src/request.ts.html +8 -5
- package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
- package/dist/coverage/lcov-report/test/index.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/AttributionRequest.ts.html +151 -0
- package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/EconomicActivityAttributionRequest.ts.html +148 -0
- package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/PhysicalActivityEVICRequest.ts.html +148 -0
- package/dist/coverage/lcov-report/test/mocks/PhysicalActivityRequest.ts.html +151 -0
- package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/index.html +63 -3
- package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
- package/dist/coverage/lcov.info +284 -124
- package/dist/index.js +4 -1
- package/dist/interfaces/response/AuditExportResponse.js +2 -0
- package/dist/interfaces/response/AuditLogResponse.js +2 -0
- package/dist/request.js +1 -0
- package/dist/types/Constants.d.ts +6 -0
- package/dist/types/api/AuditExport.d.ts +42 -0
- package/dist/types/api/AuditLog.d.ts +37 -0
- package/dist/types/api/EconomicActivity.d.ts +69 -0
- package/dist/types/api/Factor.d.ts +16 -0
- package/dist/types/api/PhysicalActivity.d.ts +76 -0
- package/dist/types/api/RealEstate.d.ts +25 -1
- package/dist/types/api/TypeRecommender.d.ts +19 -2
- package/dist/types/index.d.ts +6 -0
- package/dist/types/interfaces/Api.d.ts +17 -1
- package/dist/types/interfaces/Config.d.ts +5 -1
- package/dist/types/interfaces/common.d.ts +40 -0
- package/dist/types/interfaces/response/AuditExportResponse.d.ts +66 -0
- package/dist/types/interfaces/response/AuditLogResponse.d.ts +40 -0
- package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +2 -0
- package/docs/_sources/authentication.rst.txt +26 -4
- package/docs/_sources/getting_started.rst.txt +762 -74
- package/docs/_sources/index.rst.txt +13 -0
- package/docs/_sources/reference.rst.txt +48 -0
- package/docs/_sources/troubleshooting.rst.txt +77 -12
- package/docs/_static/basic.css +8 -0
- package/docs/_static/doctools.js +5 -6
- package/docs/_static/language_data.js +186 -7
- package/docs/_static/pygments.css +146 -164
- package/docs/_static/searchtools.js +60 -121
- package/docs/_static/sphinx_highlight.js +31 -36
- package/docs/_static/styles/furo.css +1 -1
- package/docs/_static/styles/furo.css.map +1 -1
- package/docs/authentication.html +61 -26
- package/docs/client.html +33 -22
- package/docs/genindex.html +77 -24
- package/docs/getting_started.html +969 -103
- package/docs/index.html +69 -21
- package/docs/reference.html +747 -66
- package/docs/sdk.html +32 -21
- package/docs/search.html +32 -21
- package/docs/searchindex.js +1 -1
- package/docs/troubleshooting.html +105 -38
- package/package.json +8 -3
- package/sphinx-build/source/authentication.rst +26 -4
- package/sphinx-build/source/getting_started.rst +762 -74
- package/sphinx-build/source/index.rst +13 -0
- package/sphinx-build/source/reference.rst +48 -0
- package/sphinx-build/source/troubleshooting.rst +77 -12
- package/src/Constants.ts +6 -0
- package/src/api/AuditExport.ts +90 -0
- package/src/api/AuditLog.ts +102 -0
- package/src/api/EconomicActivity.ts +69 -0
- package/src/api/Factor.ts +17 -1
- package/src/api/PhysicalActivity.ts +92 -0
- package/src/api/RealEstate.ts +25 -1
- package/src/api/TypeRecommender.ts +19 -2
- package/src/index.ts +15 -1
- package/src/interfaces/Api.ts +22 -6
- package/src/interfaces/Config.ts +6 -1
- package/src/interfaces/common.ts +46 -0
- package/src/interfaces/response/AuditExportResponse.ts +88 -0
- package/src/interfaces/response/AuditLogResponse.ts +47 -0
- package/src/interfaces/response/TypeRecommenderResponse.ts +3 -0
- package/src/request.ts +1 -0
- package/test/apiTest.test.ts +59 -3
- package/test/auditExport.test.ts +68 -0
- package/test/auditLog.test.ts +216 -0
- package/test/mocks/AttributionRequest.ts +23 -0
- package/test/mocks/EconomicActivityAttributionRequest.ts +22 -0
- package/test/mocks/PhysicalActivityEVICRequest.ts +22 -0
- package/test/mocks/PhysicalActivityRequest.ts +23 -0
- package/docs/_static/base-stemmer.js +0 -476
- package/docs/_static/english-stemmer.js +0 -1066
package/docs/reference.html
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
<!doctype html>
|
|
2
2
|
<html class="no-js" lang="en" data-content_root="./">
|
|
3
|
-
<head><meta charset="utf-8"
|
|
4
|
-
<meta name="viewport" content="width=device-width,initial-scale=1"
|
|
3
|
+
<head><meta charset="utf-8"/>
|
|
4
|
+
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
5
5
|
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
-
<link rel="index" title="Index" href="genindex.html"
|
|
6
|
+
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Troubleshooting Guide" href="troubleshooting.html" /><link rel="prev" title="Authentication" href="authentication.html" />
|
|
7
7
|
|
|
8
|
-
<!-- Generated with Sphinx
|
|
8
|
+
<!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 -->
|
|
9
9
|
<title>Reference - IBM Envizi - Emissions API Node.js SDK documentation</title>
|
|
10
10
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
|
|
11
|
-
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=
|
|
11
|
+
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=25af2a20" />
|
|
12
12
|
<link rel="stylesheet" type="text/css" href="_static/sphinx_js.css" />
|
|
13
13
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
|
|
14
14
|
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=8d04aa46" />
|
|
@@ -24,14 +24,14 @@
|
|
|
24
24
|
}
|
|
25
25
|
@media not print {
|
|
26
26
|
body[data-theme="dark"] {
|
|
27
|
-
--color-code-background: #
|
|
28
|
-
--color-code-foreground: #
|
|
27
|
+
--color-code-background: #2b2b2b;
|
|
28
|
+
--color-code-foreground: #f8f8f2;
|
|
29
29
|
|
|
30
30
|
}
|
|
31
31
|
@media (prefers-color-scheme: dark) {
|
|
32
32
|
body:not([data-theme="light"]) {
|
|
33
|
-
--color-code-background: #
|
|
34
|
-
--color-code-foreground: #
|
|
33
|
+
--color-code-background: #2b2b2b;
|
|
34
|
+
--color-code-foreground: #f8f8f2;
|
|
35
35
|
|
|
36
36
|
}
|
|
37
37
|
}
|
|
@@ -146,10 +146,14 @@
|
|
|
146
146
|
</symbol>
|
|
147
147
|
</svg>
|
|
148
148
|
|
|
149
|
-
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"
|
|
150
|
-
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"
|
|
151
|
-
<label class="overlay sidebar-overlay" for="__navigation"
|
|
152
|
-
<
|
|
149
|
+
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
150
|
+
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
151
|
+
<label class="overlay sidebar-overlay" for="__navigation">
|
|
152
|
+
<div class="visually-hidden">Hide navigation sidebar</div>
|
|
153
|
+
</label>
|
|
154
|
+
<label class="overlay toc-overlay" for="__toc">
|
|
155
|
+
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
156
|
+
</label>
|
|
153
157
|
|
|
154
158
|
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
|
155
159
|
|
|
@@ -159,7 +163,8 @@
|
|
|
159
163
|
<header class="mobile-header">
|
|
160
164
|
<div class="header-left">
|
|
161
165
|
<label class="nav-overlay-icon" for="__navigation">
|
|
162
|
-
<
|
|
166
|
+
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
167
|
+
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
163
168
|
</label>
|
|
164
169
|
</div>
|
|
165
170
|
<div class="header-center">
|
|
@@ -167,7 +172,8 @@
|
|
|
167
172
|
</div>
|
|
168
173
|
<div class="header-right">
|
|
169
174
|
<div class="theme-toggle-container theme-toggle-header">
|
|
170
|
-
<button class="theme-toggle"
|
|
175
|
+
<button class="theme-toggle">
|
|
176
|
+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
171
177
|
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
172
178
|
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
173
179
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
@@ -175,7 +181,8 @@
|
|
|
175
181
|
</button>
|
|
176
182
|
</div>
|
|
177
183
|
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
178
|
-
<
|
|
184
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
185
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
179
186
|
</label>
|
|
180
187
|
</div>
|
|
181
188
|
</header>
|
|
@@ -195,11 +202,13 @@
|
|
|
195
202
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
196
203
|
<ul class="current">
|
|
197
204
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
|
198
|
-
<li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input
|
|
205
|
+
<li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of SDK</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
|
199
206
|
<li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
|
|
200
207
|
<li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
|
|
201
208
|
</ul>
|
|
202
209
|
</li>
|
|
210
|
+
<li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
|
|
211
|
+
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
|
203
212
|
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reference</a></li>
|
|
204
213
|
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
|
|
205
214
|
</ul>
|
|
@@ -228,7 +237,8 @@
|
|
|
228
237
|
</a>
|
|
229
238
|
</div>
|
|
230
239
|
<div class="theme-toggle-container theme-toggle-content">
|
|
231
|
-
<button class="theme-toggle"
|
|
240
|
+
<button class="theme-toggle">
|
|
241
|
+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
232
242
|
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
233
243
|
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
234
244
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
@@ -236,7 +246,8 @@
|
|
|
236
246
|
</button>
|
|
237
247
|
</div>
|
|
238
248
|
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
239
|
-
<
|
|
249
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
250
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
240
251
|
</label>
|
|
241
252
|
</div>
|
|
242
253
|
<article role="main" id="furo-main-content">
|
|
@@ -244,7 +255,7 @@
|
|
|
244
255
|
<h1>Reference<a class="headerlink" href="#reference" title="Link to this heading">¶</a></h1>
|
|
245
256
|
<dl class="js class">
|
|
246
257
|
<dt class="sig sig-object js" id="Client">
|
|
247
|
-
<
|
|
258
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="n"><span class="pre">Client</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isUserProvidedToken=false</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Client" title="Link to this definition">¶</a></dt>
|
|
248
259
|
<dd><p><em>exported from</em> <a class="reference internal" href="#Client" title="Client"><code class="xref js js-mod docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
|
249
260
|
<dl class="field-list simple">
|
|
250
261
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -336,7 +347,7 @@
|
|
|
336
347
|
|
|
337
348
|
<dl class="js function">
|
|
338
349
|
<dt class="sig sig-object js" id="Client.refreshToken">
|
|
339
|
-
<
|
|
350
|
+
<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">Client</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">refreshToken</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Client.refreshToken" title="Link to this definition">¶</a></dt>
|
|
340
351
|
<dd><p>Refreshes the authentication token if it’s about to expire.
|
|
341
352
|
Only refreshes if the token was not provided by the user and is expiring within 60 seconds.</p>
|
|
342
353
|
<dl class="field-list simple">
|
|
@@ -357,7 +368,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
357
368
|
|
|
358
369
|
<dl class="js function">
|
|
359
370
|
<dt class="sig sig-object js" id="Client.getClient">
|
|
360
|
-
<
|
|
371
|
+
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span><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">Client</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getClient</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Client.getClient" title="Link to this definition">¶</a></dt>
|
|
361
372
|
<dd><p>Initializes and returns a Client instance with the provided configuration.</p>
|
|
362
373
|
<dl class="field-list simple">
|
|
363
374
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -404,7 +415,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
404
415
|
|
|
405
416
|
<dl class="js function">
|
|
406
417
|
<dt class="sig sig-object js" id="Client.getInstance">
|
|
407
|
-
<
|
|
418
|
+
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="n"><span class="pre">Client</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getInstance</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Client.getInstance" title="Link to this definition">¶</a></dt>
|
|
408
419
|
<dd><p>Returns the singleton instance of the Client.</p>
|
|
409
420
|
<dl class="field-list simple">
|
|
410
421
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
@@ -431,7 +442,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
431
442
|
|
|
432
443
|
<dl class="js function">
|
|
433
444
|
<dt class="sig sig-object js" id="request.makeApiRequest">
|
|
434
|
-
<
|
|
445
|
+
<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">request</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">makeApiRequest</span></span></span><span class="sig-paren"><</span><em class="sig-param"><span class="n"><span class="pre">T</span></span></em><span class="sig-paren">></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#request.makeApiRequest" title="Link to this definition">¶</a></dt>
|
|
435
446
|
<dd><p>Makes an API request with standardized headers and token refresh.</p>
|
|
436
447
|
<dl class="field-list simple">
|
|
437
448
|
<dt class="field-odd">Type parameters<span class="colon">:</span></dt>
|
|
@@ -493,7 +504,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
493
504
|
<h2>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h2>
|
|
494
505
|
<dl class="js function">
|
|
495
506
|
<dt class="sig sig-object js" id="Factor.retrieveFactor">
|
|
496
|
-
<
|
|
507
|
+
<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">Factor</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">retrieveFactor</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="#Factor.retrieveFactor" title="Link to this definition">¶</a></dt>
|
|
497
508
|
<dd><p>Retrieves a factor details by making a POST request to the factor API endpoint.</p>
|
|
498
509
|
<dl class="field-list simple">
|
|
499
510
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -534,9 +545,118 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
534
545
|
</div>
|
|
535
546
|
</dd></dl>
|
|
536
547
|
|
|
548
|
+
<dl class="js function">
|
|
549
|
+
<dt class="sig sig-object js" id="Factor.search">
|
|
550
|
+
<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">Factor</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">search</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="#Factor.search" title="Link to this definition">¶</a></dt>
|
|
551
|
+
<dd><p>Performs a search operation by making a POST request to the search API endpoint.</p>
|
|
552
|
+
<dl class="field-list simple">
|
|
553
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
554
|
+
<dd class="field-odd"><ul class="simple">
|
|
555
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">SearchRequest</span>) – The search request data to be sent to the API</p></li>
|
|
556
|
+
</ul>
|
|
557
|
+
</dd>
|
|
558
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
559
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<SearchResponse></span> – A promise that resolves to the search results returned by the API</p>
|
|
560
|
+
</dd>
|
|
561
|
+
</dl>
|
|
562
|
+
<div class="admonition-example admonition">
|
|
563
|
+
<p class="admonition-title">Example</p>
|
|
564
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic search</span>
|
|
565
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">searchRequest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
566
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
567
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
568
|
+
<span class="w"> </span><span class="p">},</span>
|
|
569
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
570
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s2">"travel"</span>
|
|
571
|
+
<span class="w"> </span><span class="p">},</span>
|
|
572
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
573
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span>
|
|
574
|
+
<span class="w"> </span><span class="p">}</span>
|
|
575
|
+
<span class="w"> </span><span class="p">};</span>
|
|
576
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">results</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">search</span><span class="p">(</span><span class="nx">searchRequest</span><span class="p">);</span>
|
|
577
|
+
</pre></div>
|
|
578
|
+
</div>
|
|
579
|
+
</div>
|
|
580
|
+
<div class="admonition-example admonition">
|
|
581
|
+
<p class="admonition-title">Example</p>
|
|
582
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search without cross-encoder reranking</span>
|
|
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">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
585
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"travel"</span>
|
|
586
|
+
<span class="w"> </span><span class="p">},</span>
|
|
587
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
588
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span>
|
|
589
|
+
<span class="w"> </span><span class="p">},</span>
|
|
590
|
+
<span class="w"> </span><span class="s2">"enableReranker"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
591
|
+
<span class="w"> </span><span class="p">};</span>
|
|
592
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">results</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">search</span><span class="p">(</span><span class="nx">searchWithoutReranker</span><span class="p">);</span>
|
|
593
|
+
</pre></div>
|
|
594
|
+
</div>
|
|
595
|
+
</div>
|
|
596
|
+
<div class="admonition-example admonition">
|
|
597
|
+
<p class="admonition-title">Example</p>
|
|
598
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional unit parameter</span>
|
|
599
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">searchWithUnit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
600
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
601
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
602
|
+
<span class="w"> </span><span class="p">},</span>
|
|
603
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
604
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span><span class="p">,</span>
|
|
605
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kWh"</span>
|
|
606
|
+
<span class="w"> </span><span class="p">},</span>
|
|
607
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
608
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span>
|
|
609
|
+
<span class="w"> </span><span class="p">}</span>
|
|
610
|
+
<span class="w"> </span><span class="p">};</span>
|
|
611
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">results</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">search</span><span class="p">(</span><span class="nx">searchWithUnit</span><span class="p">);</span>
|
|
612
|
+
</pre></div>
|
|
613
|
+
</div>
|
|
614
|
+
</div>
|
|
615
|
+
<div class="admonition-example admonition">
|
|
616
|
+
<p class="admonition-title">Example</p>
|
|
617
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional scope parameter</span>
|
|
618
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">searchWithScope</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
619
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
620
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
621
|
+
<span class="w"> </span><span class="p">},</span>
|
|
622
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
623
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"natural gas"</span><span class="p">,</span>
|
|
624
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"1"</span>
|
|
625
|
+
<span class="w"> </span><span class="p">},</span>
|
|
626
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
627
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span>
|
|
628
|
+
<span class="w"> </span><span class="p">}</span>
|
|
629
|
+
<span class="w"> </span><span class="p">};</span>
|
|
630
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">results</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">search</span><span class="p">(</span><span class="nx">searchWithScope</span><span class="p">);</span>
|
|
631
|
+
</pre></div>
|
|
632
|
+
</div>
|
|
633
|
+
</div>
|
|
634
|
+
<div class="admonition-example admonition">
|
|
635
|
+
<p class="admonition-title">Example</p>
|
|
636
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with both unit and scope parameters</span>
|
|
637
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">searchWithBoth</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
638
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
639
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
640
|
+
<span class="w"> </span><span class="p">},</span>
|
|
641
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
642
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span><span class="p">,</span>
|
|
643
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"MWh"</span><span class="p">,</span>
|
|
644
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2"</span>
|
|
645
|
+
<span class="w"> </span><span class="p">},</span>
|
|
646
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
647
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span><span class="p">,</span>
|
|
648
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"california"</span>
|
|
649
|
+
<span class="w"> </span><span class="p">}</span>
|
|
650
|
+
<span class="w"> </span><span class="p">};</span>
|
|
651
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">results</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">search</span><span class="p">(</span><span class="nx">searchWithBoth</span><span class="p">);</span>
|
|
652
|
+
</pre></div>
|
|
653
|
+
</div>
|
|
654
|
+
</div>
|
|
655
|
+
</dd></dl>
|
|
656
|
+
|
|
537
657
|
<dl class="js function">
|
|
538
658
|
<dt class="sig sig-object js" id="Fugitive.calculate">
|
|
539
|
-
<
|
|
659
|
+
<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">Fugitive</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="#Fugitive.calculate" title="Link to this definition">¶</a></dt>
|
|
540
660
|
<dd><p>Performs scope 1 fugitve emission calculations by making a POST request to the fugitive API endpoint.</p>
|
|
541
661
|
<dl class="field-list simple">
|
|
542
662
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -572,7 +692,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
572
692
|
|
|
573
693
|
<dl class="js function">
|
|
574
694
|
<dt class="sig sig-object js" id="Calculation.calculate">
|
|
575
|
-
<
|
|
695
|
+
<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">Calculation</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="#Calculation.calculate" title="Link to this definition">¶</a></dt>
|
|
576
696
|
<dd><p>Performs emission calculations by making a POST request to the generic calculation API endpoint.</p>
|
|
577
697
|
<dl class="field-list simple">
|
|
578
698
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -609,7 +729,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
609
729
|
|
|
610
730
|
<dl class="js function">
|
|
611
731
|
<dt class="sig sig-object js" id="Location.calculate">
|
|
612
|
-
<
|
|
732
|
+
<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">Location</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="#Location.calculate" title="Link to this definition">¶</a></dt>
|
|
613
733
|
<dd><p>Performs scope 2 purchased energy Emission calculations by making a POST request to the location API endpoint.</p>
|
|
614
734
|
<dl class="field-list simple">
|
|
615
735
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -646,7 +766,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
646
766
|
|
|
647
767
|
<dl class="js function">
|
|
648
768
|
<dt class="sig sig-object js" id="Mobile.calculate">
|
|
649
|
-
<
|
|
769
|
+
<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">Mobile</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="#Mobile.calculate" title="Link to this definition">¶</a></dt>
|
|
650
770
|
<dd><p>Performs Scope 1 mobile emissions related calculations by making a POST request to the mobile API endpoint.</p>
|
|
651
771
|
<dl class="field-list simple">
|
|
652
772
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -683,7 +803,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
683
803
|
|
|
684
804
|
<dl class="js function">
|
|
685
805
|
<dt class="sig sig-object js" id="Stationary.calculate">
|
|
686
|
-
<
|
|
806
|
+
<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">Stationary</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="#Stationary.calculate" title="Link to this definition">¶</a></dt>
|
|
687
807
|
<dd><p>Performs Scope 1 stationary calculations by making a POST request to the stationary API endpoint.</p>
|
|
688
808
|
<dl class="field-list simple">
|
|
689
809
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -720,7 +840,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
720
840
|
|
|
721
841
|
<dl class="js function">
|
|
722
842
|
<dt class="sig sig-object js" id="TransportationAndDistribution.calculate">
|
|
723
|
-
<
|
|
843
|
+
<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">TransportationAndDistribution</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="#TransportationAndDistribution.calculate" title="Link to this definition">¶</a></dt>
|
|
724
844
|
<dd><p>Performs Scope 3 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.</p>
|
|
725
845
|
<dl class="field-list simple">
|
|
726
846
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -756,7 +876,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
756
876
|
|
|
757
877
|
<dl class="js function">
|
|
758
878
|
<dt class="sig sig-object js" id="RealEstate.calculate">
|
|
759
|
-
<
|
|
879
|
+
<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">RealEstate</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="#RealEstate.calculate" title="Link to this definition">¶</a></dt>
|
|
760
880
|
<dd><p>Performs scope 3 Real estate emission calculations by making a POST request to the real estate API endpoint.</p>
|
|
761
881
|
<dl class="field-list simple">
|
|
762
882
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -770,7 +890,8 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
770
890
|
</dl>
|
|
771
891
|
<div class="admonition-example admonition">
|
|
772
892
|
<p class="admonition-title">Example</p>
|
|
773
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="
|
|
893
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic request without attribution</span>
|
|
894
|
+
<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>
|
|
774
895
|
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
775
896
|
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
776
897
|
<span class="w"> </span><span class="p">},</span>
|
|
@@ -788,12 +909,39 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
788
909
|
</pre></div>
|
|
789
910
|
</div>
|
|
790
911
|
</div>
|
|
912
|
+
<div class="admonition-example admonition">
|
|
913
|
+
<p class="admonition-title">Example</p>
|
|
914
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Request with attribution (property value based)</span>
|
|
915
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">requestWithAttribution</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
916
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
917
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span>
|
|
918
|
+
<span class="w"> </span><span class="p">},</span>
|
|
919
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
920
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span>
|
|
921
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span>
|
|
922
|
+
<span class="w"> </span><span class="p">},</span>
|
|
923
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
924
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Commercial Real Estate:Office"</span><span class="p">,</span>
|
|
925
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
|
|
926
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"m2"</span>
|
|
927
|
+
<span class="w"> </span><span class="p">},</span>
|
|
928
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
929
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
|
|
930
|
+
<span class="w"> </span><span class="s2">"propertyValue"</span><span class="o">:</span><span class="w"> </span><span class="mf">5000000.0</span>
|
|
931
|
+
<span class="w"> </span><span class="p">},</span>
|
|
932
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
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>
|
|
935
|
+
</pre></div>
|
|
936
|
+
</div>
|
|
937
|
+
</div>
|
|
791
938
|
</dd></dl>
|
|
792
939
|
|
|
793
940
|
<dl class="js function">
|
|
794
941
|
<dt class="sig sig-object js" id="EconomicActivity.calculate">
|
|
795
|
-
<
|
|
796
|
-
<dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint
|
|
942
|
+
<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">EconomicActivity</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="#EconomicActivity.calculate" title="Link to this definition">¶</a></dt>
|
|
943
|
+
<dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.
|
|
944
|
+
Supports optional attribution with revenue for proportional allocation.</p>
|
|
797
945
|
<dl class="field-list simple">
|
|
798
946
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
799
947
|
<dd class="field-odd"><ul class="simple">
|
|
@@ -806,7 +954,8 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
806
954
|
</dl>
|
|
807
955
|
<div class="admonition-example admonition">
|
|
808
956
|
<p class="admonition-title">Example</p>
|
|
809
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="
|
|
957
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic economic activity request</span>
|
|
958
|
+
<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>
|
|
810
959
|
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
811
960
|
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
812
961
|
<span class="w"> </span><span class="p">},</span>
|
|
@@ -824,6 +973,438 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
824
973
|
</pre></div>
|
|
825
974
|
</div>
|
|
826
975
|
</div>
|
|
976
|
+
<div class="admonition-example admonition">
|
|
977
|
+
<p class="admonition-title">Example</p>
|
|
978
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Economic activity request with revenue attribution</span>
|
|
979
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">requestWithAttribution</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
980
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
981
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
982
|
+
<span class="w"> </span><span class="p">},</span>
|
|
983
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
984
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
985
|
+
<span class="w"> </span><span class="p">},</span>
|
|
986
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
987
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"accomodation"</span><span class="p">,</span>
|
|
988
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
|
|
989
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
990
|
+
<span class="w"> </span><span class="p">},</span>
|
|
991
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
992
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
|
|
993
|
+
<span class="w"> </span><span class="s2">"revenue"</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
|
|
994
|
+
<span class="w"> </span><span class="p">},</span>
|
|
995
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
996
|
+
<span class="w"> </span><span class="p">};</span>
|
|
997
|
+
<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>
|
|
998
|
+
</pre></div>
|
|
999
|
+
</div>
|
|
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">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1006
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
1007
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1008
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1009
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1010
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1011
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1012
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"accomodation"</span><span class="p">,</span>
|
|
1013
|
+
<span class="w"> </span><span class="s2">"value"</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">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
1015
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1016
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1017
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</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">"totalEquity"</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">"totalDebt"</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">"includeDetails"</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">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1032
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
1033
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1034
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1035
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1036
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1037
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1038
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"accomodation"</span><span class="p">,</span>
|
|
1039
|
+
<span class="w"> </span><span class="s2">"value"</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">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
1041
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1042
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1043
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</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">"evic"</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">"includeDetails"</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<EmissionResponse | EmissionResponseWithDetails></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">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1074
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-23"</span>
|
|
1075
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1076
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1077
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1078
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1079
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1080
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"commercial real estate"</span><span class="p">,</span>
|
|
1081
|
+
<span class="w"> </span><span class="s2">"value"</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">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"km2"</span>
|
|
1083
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1084
|
+
<span class="w"> </span><span class="s2">"includeDetails"</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">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1095
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-23"</span>
|
|
1096
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1097
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1098
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1099
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1100
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1101
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"commercial real estate"</span><span class="p">,</span>
|
|
1102
|
+
<span class="w"> </span><span class="s2">"value"</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">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"km2"</span>
|
|
1104
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1105
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1106
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</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">"totalEquity"</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">"totalDebt"</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">"includeDetails"</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">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1121
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-23"</span>
|
|
1122
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1123
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1124
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1125
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1126
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1127
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"commercial real estate"</span><span class="p">,</span>
|
|
1128
|
+
<span class="w"> </span><span class="s2">"value"</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">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"km2"</span>
|
|
1130
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1131
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1132
|
+
<span class="w"> </span><span class="s2">"outstandingAmount"</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">"evic"</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">"includeDetails"</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>
|
|
1141
|
+
</dd></dl>
|
|
1142
|
+
|
|
1143
|
+
</section>
|
|
1144
|
+
<section id="type-recommender-api">
|
|
1145
|
+
<h2>Type Recommender API<a class="headerlink" href="#type-recommender-api" title="Link to this heading">¶</a></h2>
|
|
1146
|
+
<dl class="js function">
|
|
1147
|
+
<dt class="sig sig-object js" id="TypeRecommender.search">
|
|
1148
|
+
<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">TypeRecommender</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">search</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="#TypeRecommender.search" title="Link to this definition">¶</a></dt>
|
|
1149
|
+
<dd><p>Search for activity types using semantic search with location, time, and license context. Supports pagination and optional reranker control.</p>
|
|
1150
|
+
<dl class="field-list simple">
|
|
1151
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1152
|
+
<dd class="field-odd"><ul class="simple">
|
|
1153
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">SearchRequest</span>) – The search request data to be sent to the API</p></li>
|
|
1154
|
+
</ul>
|
|
1155
|
+
</dd>
|
|
1156
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1157
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<TypeRecommenderResponse></span> – A promise that resolves to the activity types returned by the API</p>
|
|
1158
|
+
</dd>
|
|
1159
|
+
</dl>
|
|
1160
|
+
<div class="admonition-example admonition">
|
|
1161
|
+
<p class="admonition-title">Example</p>
|
|
1162
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic search</span>
|
|
1163
|
+
<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">search</span><span class="p">({</span>
|
|
1164
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1165
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1166
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1167
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1168
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span>
|
|
1169
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1170
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1171
|
+
</pre></div>
|
|
1172
|
+
</div>
|
|
1173
|
+
</div>
|
|
1174
|
+
<div class="admonition-example admonition">
|
|
1175
|
+
<p class="admonition-title">Example</p>
|
|
1176
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with time and pagination</span>
|
|
1177
|
+
<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">search</span><span class="p">({</span>
|
|
1178
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1179
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span>
|
|
1180
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"california"</span>
|
|
1181
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1182
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1183
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-06-10"</span>
|
|
1184
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1185
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1186
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span>
|
|
1187
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1188
|
+
<span class="w"> </span><span class="s2">"pagination"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1189
|
+
<span class="w"> </span><span class="s2">"page"</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
|
|
1190
|
+
<span class="w"> </span><span class="s2">"size"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span>
|
|
1191
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1192
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1193
|
+
</pre></div>
|
|
1194
|
+
</div>
|
|
1195
|
+
</div>
|
|
1196
|
+
<div class="admonition-example admonition">
|
|
1197
|
+
<p class="admonition-title">Example</p>
|
|
1198
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with power grid</span>
|
|
1199
|
+
<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">search</span><span class="p">({</span>
|
|
1200
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1201
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span>
|
|
1202
|
+
<span class="w"> </span><span class="s2">"powerGrid"</span><span class="o">:</span><span class="w"> </span><span class="s2">"WECC"</span>
|
|
1203
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1204
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1205
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"renewable energy"</span>
|
|
1206
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1207
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1208
|
+
</pre></div>
|
|
1209
|
+
</div>
|
|
1210
|
+
</div>
|
|
1211
|
+
<div class="admonition-example admonition">
|
|
1212
|
+
<p class="admonition-title">Example</p>
|
|
1213
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search without cross-encoder reranking</span>
|
|
1214
|
+
<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">search</span><span class="p">({</span>
|
|
1215
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1216
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1217
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1218
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1219
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span>
|
|
1220
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1221
|
+
<span class="w"> </span><span class="s2">"enableReranker"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
1222
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1223
|
+
</pre></div>
|
|
1224
|
+
</div>
|
|
1225
|
+
</div>
|
|
1226
|
+
<div class="admonition-example admonition">
|
|
1227
|
+
<p class="admonition-title">Example</p>
|
|
1228
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional unit parameter</span>
|
|
1229
|
+
<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">search</span><span class="p">({</span>
|
|
1230
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1231
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1232
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1233
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1234
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span><span class="p">,</span>
|
|
1235
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kWh"</span>
|
|
1236
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1237
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1238
|
+
</pre></div>
|
|
1239
|
+
</div>
|
|
1240
|
+
</div>
|
|
1241
|
+
<div class="admonition-example admonition">
|
|
1242
|
+
<p class="admonition-title">Example</p>
|
|
1243
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional scope parameter</span>
|
|
1244
|
+
<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">search</span><span class="p">({</span>
|
|
1245
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1246
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1247
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1248
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1249
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"natural gas"</span><span class="p">,</span>
|
|
1250
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"1"</span>
|
|
1251
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1252
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1253
|
+
</pre></div>
|
|
1254
|
+
</div>
|
|
1255
|
+
</div>
|
|
1256
|
+
<div class="admonition-example admonition">
|
|
1257
|
+
<p class="admonition-title">Example</p>
|
|
1258
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with both unit and scope parameters</span>
|
|
1259
|
+
<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">search</span><span class="p">({</span>
|
|
1260
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1261
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span><span class="p">,</span>
|
|
1262
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"california"</span>
|
|
1263
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1264
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1265
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-06-10"</span>
|
|
1266
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1267
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1268
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span><span class="p">,</span>
|
|
1269
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"MWh"</span><span class="p">,</span>
|
|
1270
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2"</span>
|
|
1271
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1272
|
+
<span class="w"> </span><span class="s2">"pagination"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1273
|
+
<span class="w"> </span><span class="s2">"page"</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
|
|
1274
|
+
<span class="w"> </span><span class="s2">"size"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span>
|
|
1275
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1276
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1277
|
+
</pre></div>
|
|
1278
|
+
</div>
|
|
1279
|
+
</div>
|
|
1280
|
+
</dd></dl>
|
|
1281
|
+
|
|
1282
|
+
</section>
|
|
1283
|
+
<section id="audit-log-api">
|
|
1284
|
+
<h2>Audit Log API<a class="headerlink" href="#audit-log-api" title="Link to this heading">¶</a></h2>
|
|
1285
|
+
<p>Controls whether the organization’s API requests and responses are stored for auditing.
|
|
1286
|
+
Organizations can disable storage if they don’t need their API calls to be audited.</p>
|
|
1287
|
+
<dl class="js function">
|
|
1288
|
+
<dt class="sig sig-object js" id="AuditLog.getAuditConfig">
|
|
1289
|
+
<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">AuditLog</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getAuditConfig</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AuditLog.getAuditConfig" title="Link to this definition">¶</a></dt>
|
|
1290
|
+
<dd><p>Retrieves the audit log configuration for the organization.</p>
|
|
1291
|
+
<p>Controls whether the organization’s API requests and responses are stored for auditing.
|
|
1292
|
+
Organizations can disable this if they don’t need their API calls to be audited.</p>
|
|
1293
|
+
<dl class="field-list simple">
|
|
1294
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1295
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AuditLogResponse></span> – Current audit log configuration</p>
|
|
1296
|
+
</dd>
|
|
1297
|
+
</dl>
|
|
1298
|
+
<div class="admonition-example admonition">
|
|
1299
|
+
<p class="admonition-title">Example</p>
|
|
1300
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">config</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">getConfig</span><span class="p">();</span>
|
|
1301
|
+
<span class="c1">// Output: { logRequest: true, logResponse: false }</span>
|
|
1302
|
+
</pre></div>
|
|
1303
|
+
</div>
|
|
1304
|
+
</div>
|
|
1305
|
+
</dd></dl>
|
|
1306
|
+
|
|
1307
|
+
<dl class="js function">
|
|
1308
|
+
<dt class="sig sig-object js" id="AuditLog.updateAuditConfig">
|
|
1309
|
+
<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">AuditLog</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">updateAuditConfig</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="#AuditLog.updateAuditConfig" title="Link to this definition">¶</a></dt>
|
|
1310
|
+
<dd><p>Updates the audit log configuration for the organization.</p>
|
|
1311
|
+
<p>Controls whether the organization’s API requests and responses are stored for auditing.
|
|
1312
|
+
Organizations can disable this if they don’t need their API calls to be audited.</p>
|
|
1313
|
+
<p>Note: If the configuration is already set to the requested values, the API will return
|
|
1314
|
+
a 409 Conflict status with a message indicating no change was made. This is handled
|
|
1315
|
+
gracefully and the current configuration is returned.</p>
|
|
1316
|
+
<dl class="field-list simple">
|
|
1317
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1318
|
+
<dd class="field-odd"><ul class="simple">
|
|
1319
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">AuditLogRequest</span>) – Audit log configuration</p></li>
|
|
1320
|
+
</ul>
|
|
1321
|
+
</dd>
|
|
1322
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1323
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<AuditLogResponse></span> – Updated configuration or current configuration if no change</p>
|
|
1324
|
+
</dd>
|
|
1325
|
+
</dl>
|
|
1326
|
+
<div class="admonition-example admonition">
|
|
1327
|
+
<p class="admonition-title">Example</p>
|
|
1328
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><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">update</span><span class="p">({</span><span class="w"> </span><span class="nx">logRequest</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="p">,</span><span class="w"> </span><span class="nx">logResponse</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="w"> </span><span class="p">});</span>
|
|
1329
|
+
<span class="c1">// If already set to these values:</span>
|
|
1330
|
+
<span class="c1">// { logRequest: false, logResponse: false, message: "No change in audit log configuration" }</span>
|
|
1331
|
+
</pre></div>
|
|
1332
|
+
</div>
|
|
1333
|
+
</div>
|
|
1334
|
+
</dd></dl>
|
|
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<AuditExportResponse></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">"2025-01-01"</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">"2025-03-31"</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">"location"</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<AuditExportStatusResponse></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<Buffer<ArrayBufferLike>></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>
|
|
827
1408
|
</dd></dl>
|
|
828
1409
|
|
|
829
1410
|
</section>
|
|
@@ -839,7 +1420,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
839
1420
|
<h3>getTypes<a class="headerlink" href="#gettypes" title="Link to this heading">¶</a></h3>
|
|
840
1421
|
<dl class="js function">
|
|
841
1422
|
<dt class="sig sig-object js" id="Metadata.getTypes">
|
|
842
|
-
<
|
|
1423
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getTypes</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.getTypes" title="Link to this definition">¶</a></dt>
|
|
843
1424
|
<dd><p>Retrieves available emission source types for a specific endpoint using GET request.</p>
|
|
844
1425
|
<dl class="field-list simple">
|
|
845
1426
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -865,7 +1446,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
865
1446
|
|
|
866
1447
|
<dl class="js function">
|
|
867
1448
|
<dt class="sig sig-object js" id="Metadata.postTypes">
|
|
868
|
-
<
|
|
1449
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">postTypes</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.postTypes" title="Link to this definition">¶</a></dt>
|
|
869
1450
|
<dd><p>Retrieves available emission source types for a specific endpoint using POST request.</p>
|
|
870
1451
|
<dl class="field-list simple">
|
|
871
1452
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -894,7 +1475,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
894
1475
|
<h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
|
|
895
1476
|
<dl class="js function">
|
|
896
1477
|
<dt class="sig sig-object js" id="Metadata.getArea">
|
|
897
|
-
<
|
|
1478
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getArea</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.getArea" title="Link to this definition">¶</a></dt>
|
|
898
1479
|
<dd><p>Retrieves available geographic locations for a specific endpoint using GET request.</p>
|
|
899
1480
|
<dl class="field-list simple">
|
|
900
1481
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -920,7 +1501,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
920
1501
|
|
|
921
1502
|
<dl class="js function">
|
|
922
1503
|
<dt class="sig sig-object js" id="Metadata.postArea">
|
|
923
|
-
<
|
|
1504
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">postArea</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.postArea" title="Link to this definition">¶</a></dt>
|
|
924
1505
|
<dd><p>Retrieves available geographic locations for a specific endpoint using POST request.</p>
|
|
925
1506
|
<dl class="field-list simple">
|
|
926
1507
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -949,7 +1530,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
949
1530
|
<h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
|
|
950
1531
|
<dl class="js function">
|
|
951
1532
|
<dt class="sig sig-object js" id="Metadata.getUnits">
|
|
952
|
-
<
|
|
1533
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getUnits</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.getUnits" title="Link to this definition">¶</a></dt>
|
|
953
1534
|
<dd><p>Retrieves available measurement units for a specific type using GET request.</p>
|
|
954
1535
|
<dl class="field-list simple">
|
|
955
1536
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -975,7 +1556,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
975
1556
|
|
|
976
1557
|
<dl class="js function">
|
|
977
1558
|
<dt class="sig sig-object js" id="Metadata.postUnits">
|
|
978
|
-
<
|
|
1559
|
+
<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">Metadata</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">postUnits</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Metadata.postUnits" title="Link to this definition">¶</a></dt>
|
|
979
1560
|
<dd><p>Retrieves available measurement units for a specific type using POST request.</p>
|
|
980
1561
|
<dl class="field-list simple">
|
|
981
1562
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -1005,7 +1586,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1005
1586
|
<h2>Usage API<a class="headerlink" href="#usage-api" title="Link to this heading">¶</a></h2>
|
|
1006
1587
|
<dl class="js function">
|
|
1007
1588
|
<dt class="sig sig-object js" id="Usage.getUsage">
|
|
1008
|
-
<
|
|
1589
|
+
<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">Usage</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">getUsage</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">history=false</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Usage.getUsage" title="Link to this definition">¶</a></dt>
|
|
1009
1590
|
<dd><p>Retrieves current billing period or historical usage data for the user by making a GET request to the API endpoint.</p>
|
|
1010
1591
|
<dl class="field-list simple">
|
|
1011
1592
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -1030,7 +1611,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1030
1611
|
<h2>Interfaces<a class="headerlink" href="#interfaces" title="Link to this heading">¶</a></h2>
|
|
1031
1612
|
<dl class="js interface">
|
|
1032
1613
|
<dt class="sig sig-object js" id="Api.LocationRequestWithoutFactorId">
|
|
1033
|
-
<
|
|
1614
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">LocationRequestWithoutFactorId</span></span></span><a class="headerlink" href="#Api.LocationRequestWithoutFactorId" title="Link to this definition">¶</a></dt>
|
|
1034
1615
|
<dd><p>Request parameters for location-based calculations without specifying a factor ID.
|
|
1035
1616
|
Used for calculating emissions or other metrics based on location data.</p>
|
|
1036
1617
|
<blockquote>
|
|
@@ -1041,7 +1622,7 @@ Used for calculating emissions or other metrics based on location data.</p>
|
|
|
1041
1622
|
|
|
1042
1623
|
<dl class="js interface">
|
|
1043
1624
|
<dt class="sig sig-object js" id="Api.LocationRequestWithFactorId">
|
|
1044
|
-
<
|
|
1625
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">LocationRequestWithFactorId</span></span></span><a class="headerlink" href="#Api.LocationRequestWithFactorId" title="Link to this definition">¶</a></dt>
|
|
1045
1626
|
<dd><p>Request parameters for location-based calculations with a specific factor ID.
|
|
1046
1627
|
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1047
1628
|
<blockquote>
|
|
@@ -1052,7 +1633,7 @@ Used when the emission factor is already known and doesn’t need to be determin
|
|
|
1052
1633
|
|
|
1053
1634
|
<dl class="js interface">
|
|
1054
1635
|
<dt class="sig sig-object js" id="Api.CommonRequestWithoutFactorId">
|
|
1055
|
-
<
|
|
1636
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CommonRequestWithoutFactorId</span></span></span><a class="headerlink" href="#Api.CommonRequestWithoutFactorId" title="Link to this definition">¶</a></dt>
|
|
1056
1637
|
<dd><p>Common request parameters for calculations without specifying a factor ID.
|
|
1057
1638
|
Used for general-purpose calculations based on location, time, and activity data.</p>
|
|
1058
1639
|
<blockquote>
|
|
@@ -1063,7 +1644,7 @@ Used for general-purpose calculations based on location, time, and activity data
|
|
|
1063
1644
|
|
|
1064
1645
|
<dl class="js interface">
|
|
1065
1646
|
<dt class="sig sig-object js" id="Api.CommonRequestWithFactorId">
|
|
1066
|
-
<
|
|
1647
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CommonRequestWithFactorId</span></span></span><a class="headerlink" href="#Api.CommonRequestWithFactorId" title="Link to this definition">¶</a></dt>
|
|
1067
1648
|
<dd><p>Common request parameters for calculations with a specific factor ID.
|
|
1068
1649
|
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1069
1650
|
<blockquote>
|
|
@@ -1074,7 +1655,7 @@ Used when the emission factor is already known and doesn’t need to be determin
|
|
|
1074
1655
|
|
|
1075
1656
|
<dl class="js interface">
|
|
1076
1657
|
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithoutFactorId">
|
|
1077
|
-
<
|
|
1658
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">GenericCalculationRequestWithoutFactorId</span></span></span><a class="headerlink" href="#Api.GenericCalculationRequestWithoutFactorId" title="Link to this definition">¶</a></dt>
|
|
1078
1659
|
<dd><p>Request parameters for generic calculations without specifying a factor ID.
|
|
1079
1660
|
Used for calculations that may involve multiple units or complex activity data.</p>
|
|
1080
1661
|
<blockquote>
|
|
@@ -1085,7 +1666,7 @@ Used for calculations that may involve multiple units or complex activity data.<
|
|
|
1085
1666
|
|
|
1086
1667
|
<dl class="js interface">
|
|
1087
1668
|
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithFactorId">
|
|
1088
|
-
<
|
|
1669
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">GenericCalculationRequestWithFactorId</span></span></span><a class="headerlink" href="#Api.GenericCalculationRequestWithFactorId" title="Link to this definition">¶</a></dt>
|
|
1089
1670
|
<dd><p>Request parameters for generic calculations with a specific factor ID.
|
|
1090
1671
|
Used for complex calculations where the emission factor is already known.</p>
|
|
1091
1672
|
<blockquote>
|
|
@@ -1096,7 +1677,7 @@ Used for complex calculations where the emission factor is already known.</p>
|
|
|
1096
1677
|
|
|
1097
1678
|
<dl class="js interface">
|
|
1098
1679
|
<dt class="sig sig-object js" id="Api.FactorRequestWithoutFactorId">
|
|
1099
|
-
<
|
|
1680
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">FactorRequestWithoutFactorId</span></span></span><a class="headerlink" href="#Api.FactorRequestWithoutFactorId" title="Link to this definition">¶</a></dt>
|
|
1100
1681
|
<dd><p>Request parameters for retrieving factor information without specifying a factor ID.
|
|
1101
1682
|
Used to look up appropriate emission factors based on location, time, and activity type.</p>
|
|
1102
1683
|
<blockquote>
|
|
@@ -1107,7 +1688,7 @@ Used to look up appropriate emission factors based on location, time, and activi
|
|
|
1107
1688
|
|
|
1108
1689
|
<dl class="js interface">
|
|
1109
1690
|
<dt class="sig sig-object js" id="Api.FactorRequestWithFactorId">
|
|
1110
|
-
<
|
|
1691
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">FactorRequestWithFactorId</span></span></span><a class="headerlink" href="#Api.FactorRequestWithFactorId" title="Link to this definition">¶</a></dt>
|
|
1111
1692
|
<dd><p>Request parameters for retrieving specific factor information by ID.
|
|
1112
1693
|
Used when the exact factor to retrieve is already known.</p>
|
|
1113
1694
|
<blockquote>
|
|
@@ -1118,7 +1699,7 @@ Used when the exact factor to retrieve is already known.</p>
|
|
|
1118
1699
|
|
|
1119
1700
|
<dl class="js interface">
|
|
1120
1701
|
<dt class="sig sig-object js" id="Api.SearchRequest">
|
|
1121
|
-
<
|
|
1702
|
+
<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">Api</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">SearchRequest</span></span></span><a class="headerlink" href="#Api.SearchRequest" title="Link to this definition">¶</a></dt>
|
|
1122
1703
|
<dd><p>Request parameters for searching factors or activities.
|
|
1123
1704
|
Used to find relevant factors or activities based on location, time, and search criteria.</p>
|
|
1124
1705
|
<blockquote>
|
|
@@ -1129,7 +1710,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1129
1710
|
|
|
1130
1711
|
<dl class="js interface">
|
|
1131
1712
|
<dt class="sig sig-object js" id="common.Location">
|
|
1132
|
-
<
|
|
1713
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Location</span></span></span><a class="headerlink" href="#common.Location" title="Link to this definition">¶</a></dt>
|
|
1133
1714
|
<dd><dl class="simple">
|
|
1134
1715
|
<dt>Represents a geographical location.</dt><dd><p>Location</p>
|
|
1135
1716
|
</dd>
|
|
@@ -1139,7 +1720,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1139
1720
|
|
|
1140
1721
|
<dl class="js interface">
|
|
1141
1722
|
<dt class="sig sig-object js" id="common.Time">
|
|
1142
|
-
<
|
|
1723
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Time</span></span></span><a class="headerlink" href="#common.Time" title="Link to this definition">¶</a></dt>
|
|
1143
1724
|
<dd><dl class="simple">
|
|
1144
1725
|
<dt>Represents a point in time with date information.</dt><dd><p>Time</p>
|
|
1145
1726
|
</dd>
|
|
@@ -1149,7 +1730,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1149
1730
|
|
|
1150
1731
|
<dl class="js interface">
|
|
1151
1732
|
<dt class="sig sig-object js" id="common.Activity">
|
|
1152
|
-
<
|
|
1733
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Activity</span></span></span><a class="headerlink" href="#common.Activity" title="Link to this definition">¶</a></dt>
|
|
1153
1734
|
<dd><dl class="simple">
|
|
1154
1735
|
<dt>Represents an activity with type, value, and unit of measurement.</dt><dd><p>Activity</p>
|
|
1155
1736
|
</dd>
|
|
@@ -1159,7 +1740,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1159
1740
|
|
|
1160
1741
|
<dl class="js interface">
|
|
1161
1742
|
<dt class="sig sig-object js" id="common.ActivityWithFactorId">
|
|
1162
|
-
<
|
|
1743
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">ActivityWithFactorId</span></span></span><a class="headerlink" href="#common.ActivityWithFactorId" title="Link to this definition">¶</a></dt>
|
|
1163
1744
|
<dd><dl class="simple">
|
|
1164
1745
|
<dt>Represents an activity identified by a factor ID instead of a type.</dt><dd><p>ActivityWithFactorId</p>
|
|
1165
1746
|
</dd>
|
|
@@ -1169,7 +1750,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1169
1750
|
|
|
1170
1751
|
<dl class="js interface">
|
|
1171
1752
|
<dt class="sig sig-object js" id="common.CombinedUnitsActivity">
|
|
1172
|
-
<
|
|
1753
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CombinedUnitsActivity</span></span></span><a class="headerlink" href="#common.CombinedUnitsActivity" title="Link to this definition">¶</a></dt>
|
|
1173
1754
|
<dd><dl class="simple">
|
|
1174
1755
|
<dt>Represents an activity that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivity</p>
|
|
1175
1756
|
</dd>
|
|
@@ -1179,7 +1760,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1179
1760
|
|
|
1180
1761
|
<dl class="js interface">
|
|
1181
1762
|
<dt class="sig sig-object js" id="common.CombinedUnitsActivityWithFactorId">
|
|
1182
|
-
<
|
|
1763
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CombinedUnitsActivityWithFactorId</span></span></span><a class="headerlink" href="#common.CombinedUnitsActivityWithFactorId" title="Link to this definition">¶</a></dt>
|
|
1183
1764
|
<dd><dl class="simple">
|
|
1184
1765
|
<dt>Represents an activity with factor ID that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivityWithFactorId</p>
|
|
1185
1766
|
</dd>
|
|
@@ -1189,7 +1770,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1189
1770
|
|
|
1190
1771
|
<dl class="js interface">
|
|
1191
1772
|
<dt class="sig sig-object js" id="common.FactorActivity">
|
|
1192
|
-
<
|
|
1773
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">FactorActivity</span></span></span><a class="headerlink" href="#common.FactorActivity" title="Link to this definition">¶</a></dt>
|
|
1193
1774
|
<dd><dl class="simple">
|
|
1194
1775
|
<dt>Represents a factor activity with a type and optional unit.</dt><dd><p>FactorActivity</p>
|
|
1195
1776
|
</dd>
|
|
@@ -1199,7 +1780,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1199
1780
|
|
|
1200
1781
|
<dl class="js interface">
|
|
1201
1782
|
<dt class="sig sig-object js" id="common.FactorActivityWithFactorId">
|
|
1202
|
-
<
|
|
1783
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">FactorActivityWithFactorId</span></span></span><a class="headerlink" href="#common.FactorActivityWithFactorId" title="Link to this definition">¶</a></dt>
|
|
1203
1784
|
<dd><dl class="simple">
|
|
1204
1785
|
<dt>Represents a factor activity identified by a factor ID instead of a type.</dt><dd><p>FactorActivityWithFactorId</p>
|
|
1205
1786
|
</dd>
|
|
@@ -1209,7 +1790,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1209
1790
|
|
|
1210
1791
|
<dl class="js interface">
|
|
1211
1792
|
<dt class="sig sig-object js" id="common.SearchActivity">
|
|
1212
|
-
<
|
|
1793
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">SearchActivity</span></span></span><a class="headerlink" href="#common.SearchActivity" title="Link to this definition">¶</a></dt>
|
|
1213
1794
|
<dd><dl class="simple">
|
|
1214
1795
|
<dt>Represents a search query for activities.</dt><dd><p>SearchActivity</p>
|
|
1215
1796
|
</dd>
|
|
@@ -1219,7 +1800,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1219
1800
|
|
|
1220
1801
|
<dl class="js interface">
|
|
1221
1802
|
<dt class="sig sig-object js" id="common.Pagination">
|
|
1222
|
-
<
|
|
1803
|
+
<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">common</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">Pagination</span></span></span><a class="headerlink" href="#common.Pagination" title="Link to this definition">¶</a></dt>
|
|
1223
1804
|
<dd><dl class="simple">
|
|
1224
1805
|
<dt>Represents pagination parameters for paginated results.</dt><dd><p>Pagination</p>
|
|
1225
1806
|
</dd>
|
|
@@ -1229,7 +1810,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1229
1810
|
|
|
1230
1811
|
<dl class="js interface">
|
|
1231
1812
|
<dt class="sig sig-object js" id="Config.RequestConfig">
|
|
1232
|
-
<
|
|
1813
|
+
<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">Config</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">RequestConfig</span></span></span><a class="headerlink" href="#Config.RequestConfig" title="Link to this definition">¶</a></dt>
|
|
1233
1814
|
<dd><dl class="simple">
|
|
1234
1815
|
<dt>Configuration for making HTTP requests.</dt><dd><p>RequestConfig</p>
|
|
1235
1816
|
</dd>
|
|
@@ -1239,7 +1820,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1239
1820
|
|
|
1240
1821
|
<dl class="js interface">
|
|
1241
1822
|
<dt class="sig sig-object js" id="Config.ClientConfig">
|
|
1242
|
-
<
|
|
1823
|
+
<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">Config</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">ClientConfig</span></span></span><a class="headerlink" href="#Config.ClientConfig" title="Link to this definition">¶</a></dt>
|
|
1243
1824
|
<dd><dl class="simple">
|
|
1244
1825
|
<dt>Configuration for initializing a client instance.</dt><dd><p>ClientConfig</p>
|
|
1245
1826
|
</dd>
|
|
@@ -1247,6 +1828,81 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1247
1828
|
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Config</span></code></p>
|
|
1248
1829
|
</dd></dl>
|
|
1249
1830
|
|
|
1831
|
+
<dl class="js interface">
|
|
1832
|
+
<dt class="sig sig-object js" id="AuditLogResponse.AuditLogResponse">
|
|
1833
|
+
<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">AuditLogResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditLogResponse</span></span></span><a class="headerlink" href="#AuditLogResponse.AuditLogResponse" title="Link to this definition">¶</a></dt>
|
|
1834
|
+
<dd><p>Response interface for audit log configuration.
|
|
1835
|
+
Contains settings for logging requests and responses.</p>
|
|
1836
|
+
<blockquote>
|
|
1837
|
+
<div><p>AuditLogResponse</p>
|
|
1838
|
+
</div></blockquote>
|
|
1839
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditLogResponse</span></code></p>
|
|
1840
|
+
</dd></dl>
|
|
1841
|
+
|
|
1842
|
+
<dl class="js interface">
|
|
1843
|
+
<dt class="sig sig-object js" id="AuditLogResponse.AuditLogRequest">
|
|
1844
|
+
<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">AuditLogResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">AuditLogRequest</span></span></span><a class="headerlink" href="#AuditLogResponse.AuditLogRequest" title="Link to this definition">¶</a></dt>
|
|
1845
|
+
<dd><p>Request interface for updating audit log configuration.
|
|
1846
|
+
Used to configure which parts of API interactions should be logged.</p>
|
|
1847
|
+
<blockquote>
|
|
1848
|
+
<div><p>AuditLogRequest</p>
|
|
1849
|
+
</div></blockquote>
|
|
1850
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditLogResponse</span></code></p>
|
|
1851
|
+
</dd></dl>
|
|
1852
|
+
|
|
1853
|
+
<dl class="js interface">
|
|
1854
|
+
<dt class="sig sig-object js" id="TypeRecommenderResponse.TypeRecommenderResponse">
|
|
1855
|
+
<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">TypeRecommenderResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">TypeRecommenderResponse</span></span></span><a class="headerlink" href="#TypeRecommenderResponse.TypeRecommenderResponse" title="Link to this definition">¶</a></dt>
|
|
1856
|
+
<dd><p>Interface for type recommender API</p>
|
|
1857
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.TypeRecommenderResponse</span></code></p>
|
|
1858
|
+
</dd></dl>
|
|
1859
|
+
|
|
1860
|
+
<dl class="js interface">
|
|
1861
|
+
<dt class="sig sig-object js" id="TypeRecommenderResponse.ActivityRequest">
|
|
1862
|
+
<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">TypeRecommenderResponse</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">ActivityRequest</span></span></span><a class="headerlink" href="#TypeRecommenderResponse.ActivityRequest" title="Link to this definition">¶</a></dt>
|
|
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>
|
|
1864
|
+
</dd></dl>
|
|
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
|
+
|
|
1250
1906
|
</section>
|
|
1251
1907
|
</section>
|
|
1252
1908
|
|
|
@@ -1320,6 +1976,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1320
1976
|
<li><a class="reference internal" href="#utils.findExpiryTime"><code class="docutils literal notranslate"><span class="pre">utils.findExpiryTime()</span></code></a></li>
|
|
1321
1977
|
<li><a class="reference internal" href="#api">API</a><ul>
|
|
1322
1978
|
<li><a class="reference internal" href="#Factor.retrieveFactor"><code class="docutils literal notranslate"><span class="pre">Factor.retrieveFactor()</span></code></a></li>
|
|
1979
|
+
<li><a class="reference internal" href="#Factor.search"><code class="docutils literal notranslate"><span class="pre">Factor.search()</span></code></a></li>
|
|
1323
1980
|
<li><a class="reference internal" href="#Fugitive.calculate"><code class="docutils literal notranslate"><span class="pre">Fugitive.calculate()</span></code></a></li>
|
|
1324
1981
|
<li><a class="reference internal" href="#Calculation.calculate"><code class="docutils literal notranslate"><span class="pre">Calculation.calculate()</span></code></a></li>
|
|
1325
1982
|
<li><a class="reference internal" href="#Location.calculate"><code class="docutils literal notranslate"><span class="pre">Location.calculate()</span></code></a></li>
|
|
@@ -1328,6 +1985,22 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1328
1985
|
<li><a class="reference internal" href="#TransportationAndDistribution.calculate"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.calculate()</span></code></a></li>
|
|
1329
1986
|
<li><a class="reference internal" href="#RealEstate.calculate"><code class="docutils literal notranslate"><span class="pre">RealEstate.calculate()</span></code></a></li>
|
|
1330
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>
|
|
1989
|
+
</ul>
|
|
1990
|
+
</li>
|
|
1991
|
+
<li><a class="reference internal" href="#type-recommender-api">Type Recommender API</a><ul>
|
|
1992
|
+
<li><a class="reference internal" href="#TypeRecommender.search"><code class="docutils literal notranslate"><span class="pre">TypeRecommender.search()</span></code></a></li>
|
|
1993
|
+
</ul>
|
|
1994
|
+
</li>
|
|
1995
|
+
<li><a class="reference internal" href="#audit-log-api">Audit Log API</a><ul>
|
|
1996
|
+
<li><a class="reference internal" href="#AuditLog.getAuditConfig"><code class="docutils literal notranslate"><span class="pre">AuditLog.getAuditConfig()</span></code></a></li>
|
|
1997
|
+
<li><a class="reference internal" href="#AuditLog.updateAuditConfig"><code class="docutils literal notranslate"><span class="pre">AuditLog.updateAuditConfig()</span></code></a></li>
|
|
1998
|
+
</ul>
|
|
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>
|
|
1331
2004
|
</ul>
|
|
1332
2005
|
</li>
|
|
1333
2006
|
<li><a class="reference internal" href="#global-metadata-api">Global Metadata API</a><ul>
|
|
@@ -1374,6 +2047,14 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1374
2047
|
<li><a class="reference internal" href="#common.Pagination"><code class="docutils literal notranslate"><span class="pre">common.Pagination</span></code></a></li>
|
|
1375
2048
|
<li><a class="reference internal" href="#Config.RequestConfig"><code class="docutils literal notranslate"><span class="pre">Config.RequestConfig</span></code></a></li>
|
|
1376
2049
|
<li><a class="reference internal" href="#Config.ClientConfig"><code class="docutils literal notranslate"><span class="pre">Config.ClientConfig</span></code></a></li>
|
|
2050
|
+
<li><a class="reference internal" href="#AuditLogResponse.AuditLogResponse"><code class="docutils literal notranslate"><span class="pre">AuditLogResponse.AuditLogResponse</span></code></a></li>
|
|
2051
|
+
<li><a class="reference internal" href="#AuditLogResponse.AuditLogRequest"><code class="docutils literal notranslate"><span class="pre">AuditLogResponse.AuditLogRequest</span></code></a></li>
|
|
2052
|
+
<li><a class="reference internal" href="#TypeRecommenderResponse.TypeRecommenderResponse"><code class="docutils literal notranslate"><span class="pre">TypeRecommenderResponse.TypeRecommenderResponse</span></code></a></li>
|
|
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>
|
|
1377
2058
|
</ul>
|
|
1378
2059
|
</li>
|
|
1379
2060
|
</ul>
|
|
@@ -1388,8 +2069,8 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1388
2069
|
</aside>
|
|
1389
2070
|
</div>
|
|
1390
2071
|
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
1391
|
-
<script src="_static/doctools.js?v=
|
|
1392
|
-
<script src="_static/sphinx_highlight.js?v=
|
|
2072
|
+
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
2073
|
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
1393
2074
|
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
|
|
1394
2075
|
</body>
|
|
1395
2076
|
</html>
|