emissions-api-sdk 1.0.12 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -2
- package/dist/Constants.js +4 -1
- package/dist/api/AuditLog.js +99 -0
- package/dist/api/EconomicActivity.js +24 -0
- package/dist/api/Factor.js +19 -0
- package/dist/api/PhysicalActivity.js +87 -0
- package/dist/api/RealEstate.js +23 -0
- package/dist/api/TypeRecommender.js +19 -2
- package/dist/coverage/clover.xml +149 -87
- package/dist/coverage/coverage-final.json +14 -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 +36 -27
- 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 +77 -5
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +59 -2
- 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 +74 -5
- 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 +36 -6
- package/dist/coverage/lcov-report/src/index.html +7 -7
- package/dist/coverage/lcov-report/src/request.ts.html +5 -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 +249 -122
- package/dist/index.js +3 -1
- package/dist/interfaces/response/AuditLogResponse.js +2 -0
- package/dist/types/Constants.d.ts +3 -0
- package/dist/types/api/AuditLog.d.ts +37 -0
- package/dist/types/api/EconomicActivity.d.ts +24 -0
- package/dist/types/api/Factor.d.ts +19 -0
- package/dist/types/api/PhysicalActivity.d.ts +76 -0
- package/dist/types/api/RealEstate.d.ts +23 -0
- package/dist/types/api/TypeRecommender.d.ts +19 -2
- package/dist/types/index.d.ts +4 -0
- package/dist/types/interfaces/Api.d.ts +17 -1
- package/dist/types/interfaces/common.d.ts +40 -0
- package/dist/types/interfaces/response/AuditLogResponse.d.ts +40 -0
- package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +1 -0
- package/docs/_sources/authentication.rst.txt +26 -4
- package/docs/_sources/getting_started.rst.txt +538 -74
- package/docs/_sources/index.rst.txt +11 -0
- package/docs/_sources/reference.rst.txt +26 -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 +52 -23
- package/docs/getting_started.html +745 -103
- package/docs/index.html +65 -21
- package/docs/reference.html +484 -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 +7 -3
- package/sphinx-build/source/authentication.rst +26 -4
- package/sphinx-build/source/getting_started.rst +538 -74
- package/sphinx-build/source/index.rst +11 -0
- package/sphinx-build/source/reference.rst +26 -0
- package/sphinx-build/source/troubleshooting.rst +77 -12
- package/src/Constants.ts +3 -0
- package/src/api/AuditLog.ts +102 -0
- package/src/api/EconomicActivity.ts +24 -0
- package/src/api/Factor.ts +19 -0
- package/src/api/PhysicalActivity.ts +92 -0
- package/src/api/RealEstate.ts +23 -0
- package/src/api/TypeRecommender.ts +19 -2
- package/src/index.ts +7 -1
- package/src/interfaces/Api.ts +22 -6
- package/src/interfaces/common.ts +46 -0
- package/src/interfaces/response/AuditLogResponse.ts +47 -0
- package/src/interfaces/response/TypeRecommenderResponse.ts +2 -0
- package/test/apiTest.test.ts +59 -3
- 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/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,121 @@ 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">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
585
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
586
|
+
<span class="w"> </span><span class="p">},</span>
|
|
587
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
588
|
+
<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>
|
|
589
|
+
<span class="w"> </span><span class="p">},</span>
|
|
590
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
591
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span>
|
|
592
|
+
<span class="w"> </span><span class="p">},</span>
|
|
593
|
+
<span class="w"> </span><span class="s2">"enableReranker"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
594
|
+
<span class="w"> </span><span class="p">};</span>
|
|
595
|
+
<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>
|
|
596
|
+
</pre></div>
|
|
597
|
+
</div>
|
|
598
|
+
</div>
|
|
599
|
+
<div class="admonition-example admonition">
|
|
600
|
+
<p class="admonition-title">Example</p>
|
|
601
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional unit parameter</span>
|
|
602
|
+
<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>
|
|
603
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
604
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
605
|
+
<span class="w"> </span><span class="p">},</span>
|
|
606
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
607
|
+
<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>
|
|
608
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kWh"</span>
|
|
609
|
+
<span class="w"> </span><span class="p">},</span>
|
|
610
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
611
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span>
|
|
612
|
+
<span class="w"> </span><span class="p">}</span>
|
|
613
|
+
<span class="w"> </span><span class="p">};</span>
|
|
614
|
+
<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>
|
|
615
|
+
</pre></div>
|
|
616
|
+
</div>
|
|
617
|
+
</div>
|
|
618
|
+
<div class="admonition-example admonition">
|
|
619
|
+
<p class="admonition-title">Example</p>
|
|
620
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional scope parameter</span>
|
|
621
|
+
<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>
|
|
622
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
623
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
624
|
+
<span class="w"> </span><span class="p">},</span>
|
|
625
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
626
|
+
<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>
|
|
627
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"1"</span>
|
|
628
|
+
<span class="w"> </span><span class="p">},</span>
|
|
629
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
630
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"USA"</span>
|
|
631
|
+
<span class="w"> </span><span class="p">}</span>
|
|
632
|
+
<span class="w"> </span><span class="p">};</span>
|
|
633
|
+
<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>
|
|
634
|
+
</pre></div>
|
|
635
|
+
</div>
|
|
636
|
+
</div>
|
|
637
|
+
<div class="admonition-example admonition">
|
|
638
|
+
<p class="admonition-title">Example</p>
|
|
639
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with both unit and scope parameters</span>
|
|
640
|
+
<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>
|
|
641
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="p">{</span>
|
|
642
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2020-06-10"</span>
|
|
643
|
+
<span class="w"> </span><span class="p">},</span>
|
|
644
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
645
|
+
<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>
|
|
646
|
+
<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>
|
|
647
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2"</span>
|
|
648
|
+
<span class="w"> </span><span class="p">},</span>
|
|
649
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
650
|
+
<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>
|
|
651
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"california"</span>
|
|
652
|
+
<span class="w"> </span><span class="p">}</span>
|
|
653
|
+
<span class="w"> </span><span class="p">};</span>
|
|
654
|
+
<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>
|
|
655
|
+
</pre></div>
|
|
656
|
+
</div>
|
|
657
|
+
</div>
|
|
658
|
+
</dd></dl>
|
|
659
|
+
|
|
537
660
|
<dl class="js function">
|
|
538
661
|
<dt class="sig sig-object js" id="Fugitive.calculate">
|
|
539
|
-
<
|
|
662
|
+
<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
663
|
<dd><p>Performs scope 1 fugitve emission calculations by making a POST request to the fugitive API endpoint.</p>
|
|
541
664
|
<dl class="field-list simple">
|
|
542
665
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -572,7 +695,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
572
695
|
|
|
573
696
|
<dl class="js function">
|
|
574
697
|
<dt class="sig sig-object js" id="Calculation.calculate">
|
|
575
|
-
<
|
|
698
|
+
<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
699
|
<dd><p>Performs emission calculations by making a POST request to the generic calculation API endpoint.</p>
|
|
577
700
|
<dl class="field-list simple">
|
|
578
701
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -609,7 +732,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
609
732
|
|
|
610
733
|
<dl class="js function">
|
|
611
734
|
<dt class="sig sig-object js" id="Location.calculate">
|
|
612
|
-
<
|
|
735
|
+
<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
736
|
<dd><p>Performs scope 2 purchased energy Emission calculations by making a POST request to the location API endpoint.</p>
|
|
614
737
|
<dl class="field-list simple">
|
|
615
738
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -646,7 +769,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
646
769
|
|
|
647
770
|
<dl class="js function">
|
|
648
771
|
<dt class="sig sig-object js" id="Mobile.calculate">
|
|
649
|
-
<
|
|
772
|
+
<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
773
|
<dd><p>Performs Scope 1 mobile emissions related calculations by making a POST request to the mobile API endpoint.</p>
|
|
651
774
|
<dl class="field-list simple">
|
|
652
775
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -683,7 +806,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
683
806
|
|
|
684
807
|
<dl class="js function">
|
|
685
808
|
<dt class="sig sig-object js" id="Stationary.calculate">
|
|
686
|
-
<
|
|
809
|
+
<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
810
|
<dd><p>Performs Scope 1 stationary calculations by making a POST request to the stationary API endpoint.</p>
|
|
688
811
|
<dl class="field-list simple">
|
|
689
812
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -720,7 +843,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
720
843
|
|
|
721
844
|
<dl class="js function">
|
|
722
845
|
<dt class="sig sig-object js" id="TransportationAndDistribution.calculate">
|
|
723
|
-
<
|
|
846
|
+
<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
847
|
<dd><p>Performs Scope 3 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.</p>
|
|
725
848
|
<dl class="field-list simple">
|
|
726
849
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -756,7 +879,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
756
879
|
|
|
757
880
|
<dl class="js function">
|
|
758
881
|
<dt class="sig sig-object js" id="RealEstate.calculate">
|
|
759
|
-
<
|
|
882
|
+
<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
883
|
<dd><p>Performs scope 3 Real estate emission calculations by making a POST request to the real estate API endpoint.</p>
|
|
761
884
|
<dl class="field-list simple">
|
|
762
885
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -770,7 +893,8 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
770
893
|
</dl>
|
|
771
894
|
<div class="admonition-example admonition">
|
|
772
895
|
<p class="admonition-title">Example</p>
|
|
773
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="
|
|
896
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic request without attribution</span>
|
|
897
|
+
<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
898
|
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
775
899
|
<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
900
|
<span class="w"> </span><span class="p">},</span>
|
|
@@ -788,12 +912,38 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
788
912
|
</pre></div>
|
|
789
913
|
</div>
|
|
790
914
|
</div>
|
|
915
|
+
<div class="admonition-example admonition">
|
|
916
|
+
<p class="admonition-title">Example</p>
|
|
917
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Request with attribution (property value based)</span>
|
|
918
|
+
<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>
|
|
919
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
920
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span>
|
|
921
|
+
<span class="w"> </span><span class="p">},</span>
|
|
922
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
923
|
+
<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>
|
|
924
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span>
|
|
925
|
+
<span class="w"> </span><span class="p">},</span>
|
|
926
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
927
|
+
<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>
|
|
928
|
+
<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>
|
|
929
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"m2"</span>
|
|
930
|
+
<span class="w"> </span><span class="p">},</span>
|
|
931
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
932
|
+
<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>
|
|
933
|
+
<span class="w"> </span><span class="s2">"propertyValue"</span><span class="o">:</span><span class="w"> </span><span class="mf">5000000.0</span>
|
|
934
|
+
<span class="w"> </span><span class="p">},</span>
|
|
935
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
936
|
+
<span class="w"> </span><span class="p">};</span>
|
|
937
|
+
</pre></div>
|
|
938
|
+
</div>
|
|
939
|
+
</div>
|
|
791
940
|
</dd></dl>
|
|
792
941
|
|
|
793
942
|
<dl class="js function">
|
|
794
943
|
<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
|
|
944
|
+
<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>
|
|
945
|
+
<dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.
|
|
946
|
+
Supports optional attribution with revenue for proportional allocation.</p>
|
|
797
947
|
<dl class="field-list simple">
|
|
798
948
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
799
949
|
<dd class="field-odd"><ul class="simple">
|
|
@@ -806,7 +956,8 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
806
956
|
</dl>
|
|
807
957
|
<div class="admonition-example admonition">
|
|
808
958
|
<p class="admonition-title">Example</p>
|
|
809
|
-
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="
|
|
959
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic economic activity request</span>
|
|
960
|
+
<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
961
|
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
811
962
|
<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
963
|
<span class="w"> </span><span class="p">},</span>
|
|
@@ -824,6 +975,224 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
824
975
|
</pre></div>
|
|
825
976
|
</div>
|
|
826
977
|
</div>
|
|
978
|
+
<div class="admonition-example admonition">
|
|
979
|
+
<p class="admonition-title">Example</p>
|
|
980
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Economic activity request with revenue attribution</span>
|
|
981
|
+
<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>
|
|
982
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
983
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
984
|
+
<span class="w"> </span><span class="p">},</span>
|
|
985
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
986
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
987
|
+
<span class="w"> </span><span class="p">},</span>
|
|
988
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
989
|
+
<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>
|
|
990
|
+
<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>
|
|
991
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usd"</span>
|
|
992
|
+
<span class="w"> </span><span class="p">},</span>
|
|
993
|
+
<span class="w"> </span><span class="s2">"attribution"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
994
|
+
<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>
|
|
995
|
+
<span class="w"> </span><span class="s2">"revenue"</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
|
|
996
|
+
<span class="w"> </span><span class="p">},</span>
|
|
997
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
998
|
+
<span class="w"> </span><span class="p">};</span>
|
|
999
|
+
<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>
|
|
1000
|
+
</pre></div>
|
|
1001
|
+
</div>
|
|
1002
|
+
</div>
|
|
1003
|
+
</dd></dl>
|
|
1004
|
+
|
|
1005
|
+
</section>
|
|
1006
|
+
<section id="type-recommender-api">
|
|
1007
|
+
<h2>Type Recommender API<a class="headerlink" href="#type-recommender-api" title="Link to this heading">¶</a></h2>
|
|
1008
|
+
<dl class="js function">
|
|
1009
|
+
<dt class="sig sig-object js" id="TypeRecommender.search">
|
|
1010
|
+
<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>
|
|
1011
|
+
<dd><p>Search for activity types using semantic search with location, time, and license context. Supports pagination and optional reranker control.</p>
|
|
1012
|
+
<dl class="field-list simple">
|
|
1013
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1014
|
+
<dd class="field-odd"><ul class="simple">
|
|
1015
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">SearchRequest</span>) – The search request data to be sent to the API</p></li>
|
|
1016
|
+
</ul>
|
|
1017
|
+
</dd>
|
|
1018
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1019
|
+
<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>
|
|
1020
|
+
</dd>
|
|
1021
|
+
</dl>
|
|
1022
|
+
<div class="admonition-example admonition">
|
|
1023
|
+
<p class="admonition-title">Example</p>
|
|
1024
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Basic search</span>
|
|
1025
|
+
<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>
|
|
1026
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1027
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1028
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1029
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1030
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span>
|
|
1031
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1032
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1033
|
+
</pre></div>
|
|
1034
|
+
</div>
|
|
1035
|
+
</div>
|
|
1036
|
+
<div class="admonition-example admonition">
|
|
1037
|
+
<p class="admonition-title">Example</p>
|
|
1038
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with time and pagination</span>
|
|
1039
|
+
<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>
|
|
1040
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1041
|
+
<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>
|
|
1042
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"california"</span>
|
|
1043
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1044
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1045
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-06-10"</span>
|
|
1046
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1047
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1048
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span>
|
|
1049
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1050
|
+
<span class="w"> </span><span class="s2">"pagination"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1051
|
+
<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>
|
|
1052
|
+
<span class="w"> </span><span class="s2">"size"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span>
|
|
1053
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1054
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1055
|
+
</pre></div>
|
|
1056
|
+
</div>
|
|
1057
|
+
</div>
|
|
1058
|
+
<div class="admonition-example admonition">
|
|
1059
|
+
<p class="admonition-title">Example</p>
|
|
1060
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with power grid</span>
|
|
1061
|
+
<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>
|
|
1062
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1063
|
+
<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>
|
|
1064
|
+
<span class="w"> </span><span class="s2">"powerGrid"</span><span class="o">:</span><span class="w"> </span><span class="s2">"WECC"</span>
|
|
1065
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1066
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1067
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"renewable energy"</span>
|
|
1068
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1069
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1070
|
+
</pre></div>
|
|
1071
|
+
</div>
|
|
1072
|
+
</div>
|
|
1073
|
+
<div class="admonition-example admonition">
|
|
1074
|
+
<p class="admonition-title">Example</p>
|
|
1075
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search without cross-encoder reranking</span>
|
|
1076
|
+
<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>
|
|
1077
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1078
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1079
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1080
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1081
|
+
<span class="w"> </span><span class="s2">"search"</span><span class="o">:</span><span class="w"> </span><span class="s2">"electricity"</span>
|
|
1082
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1083
|
+
<span class="w"> </span><span class="s2">"enableReranker"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
1084
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1085
|
+
</pre></div>
|
|
1086
|
+
</div>
|
|
1087
|
+
</div>
|
|
1088
|
+
<div class="admonition-example admonition">
|
|
1089
|
+
<p class="admonition-title">Example</p>
|
|
1090
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional unit parameter</span>
|
|
1091
|
+
<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>
|
|
1092
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1093
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1094
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1095
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1096
|
+
<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>
|
|
1097
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kWh"</span>
|
|
1098
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1099
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1100
|
+
</pre></div>
|
|
1101
|
+
</div>
|
|
1102
|
+
</div>
|
|
1103
|
+
<div class="admonition-example admonition">
|
|
1104
|
+
<p class="admonition-title">Example</p>
|
|
1105
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with optional scope parameter</span>
|
|
1106
|
+
<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>
|
|
1107
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1108
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
1109
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1110
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1111
|
+
<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>
|
|
1112
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"1"</span>
|
|
1113
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1114
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1115
|
+
</pre></div>
|
|
1116
|
+
</div>
|
|
1117
|
+
</div>
|
|
1118
|
+
<div class="admonition-example admonition">
|
|
1119
|
+
<p class="admonition-title">Example</p>
|
|
1120
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Search with both unit and scope parameters</span>
|
|
1121
|
+
<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>
|
|
1122
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1123
|
+
<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>
|
|
1124
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"california"</span>
|
|
1125
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1126
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1127
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-06-10"</span>
|
|
1128
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1129
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1130
|
+
<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>
|
|
1131
|
+
<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>
|
|
1132
|
+
<span class="w"> </span><span class="s2">"scope"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2"</span>
|
|
1133
|
+
<span class="w"> </span><span class="p">},</span>
|
|
1134
|
+
<span class="w"> </span><span class="s2">"pagination"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
1135
|
+
<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>
|
|
1136
|
+
<span class="w"> </span><span class="s2">"size"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span>
|
|
1137
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1138
|
+
<span class="w"> </span><span class="p">});</span>
|
|
1139
|
+
</pre></div>
|
|
1140
|
+
</div>
|
|
1141
|
+
</div>
|
|
1142
|
+
</dd></dl>
|
|
1143
|
+
|
|
1144
|
+
</section>
|
|
1145
|
+
<section id="audit-log-api">
|
|
1146
|
+
<h2>Audit Log API<a class="headerlink" href="#audit-log-api" title="Link to this heading">¶</a></h2>
|
|
1147
|
+
<p>Controls whether the organization’s API requests and responses are stored for auditing.
|
|
1148
|
+
Organizations can disable storage if they don’t need their API calls to be audited.</p>
|
|
1149
|
+
<dl class="js function">
|
|
1150
|
+
<dt class="sig sig-object js" id="AuditLog.getAuditConfig">
|
|
1151
|
+
<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>
|
|
1152
|
+
<dd><p>Retrieves the audit log configuration for the organization.</p>
|
|
1153
|
+
<p>Controls whether the organization’s API requests and responses are stored for auditing.
|
|
1154
|
+
Organizations can disable this if they don’t need their API calls to be audited.</p>
|
|
1155
|
+
<dl class="field-list simple">
|
|
1156
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1157
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AuditLogResponse></span> – Current audit log configuration</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="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>
|
|
1163
|
+
<span class="c1">// Output: { logRequest: true, logResponse: false }</span>
|
|
1164
|
+
</pre></div>
|
|
1165
|
+
</div>
|
|
1166
|
+
</div>
|
|
1167
|
+
</dd></dl>
|
|
1168
|
+
|
|
1169
|
+
<dl class="js function">
|
|
1170
|
+
<dt class="sig sig-object js" id="AuditLog.updateAuditConfig">
|
|
1171
|
+
<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>
|
|
1172
|
+
<dd><p>Updates the audit log configuration for the organization.</p>
|
|
1173
|
+
<p>Controls whether the organization’s API requests and responses are stored for auditing.
|
|
1174
|
+
Organizations can disable this if they don’t need their API calls to be audited.</p>
|
|
1175
|
+
<p>Note: If the configuration is already set to the requested values, the API will return
|
|
1176
|
+
a 409 Conflict status with a message indicating no change was made. This is handled
|
|
1177
|
+
gracefully and the current configuration is returned.</p>
|
|
1178
|
+
<dl class="field-list simple">
|
|
1179
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1180
|
+
<dd class="field-odd"><ul class="simple">
|
|
1181
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">AuditLogRequest</span>) – Audit log configuration</p></li>
|
|
1182
|
+
</ul>
|
|
1183
|
+
</dd>
|
|
1184
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1185
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<AuditLogResponse></span> – Updated configuration or current configuration if no change</p>
|
|
1186
|
+
</dd>
|
|
1187
|
+
</dl>
|
|
1188
|
+
<div class="admonition-example admonition">
|
|
1189
|
+
<p class="admonition-title">Example</p>
|
|
1190
|
+
<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>
|
|
1191
|
+
<span class="c1">// If already set to these values:</span>
|
|
1192
|
+
<span class="c1">// { logRequest: false, logResponse: false, message: "No change in audit log configuration" }</span>
|
|
1193
|
+
</pre></div>
|
|
1194
|
+
</div>
|
|
1195
|
+
</div>
|
|
827
1196
|
</dd></dl>
|
|
828
1197
|
|
|
829
1198
|
</section>
|
|
@@ -839,7 +1208,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
839
1208
|
<h3>getTypes<a class="headerlink" href="#gettypes" title="Link to this heading">¶</a></h3>
|
|
840
1209
|
<dl class="js function">
|
|
841
1210
|
<dt class="sig sig-object js" id="Metadata.getTypes">
|
|
842
|
-
<
|
|
1211
|
+
<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
1212
|
<dd><p>Retrieves available emission source types for a specific endpoint using GET request.</p>
|
|
844
1213
|
<dl class="field-list simple">
|
|
845
1214
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -865,7 +1234,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
865
1234
|
|
|
866
1235
|
<dl class="js function">
|
|
867
1236
|
<dt class="sig sig-object js" id="Metadata.postTypes">
|
|
868
|
-
<
|
|
1237
|
+
<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
1238
|
<dd><p>Retrieves available emission source types for a specific endpoint using POST request.</p>
|
|
870
1239
|
<dl class="field-list simple">
|
|
871
1240
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -894,7 +1263,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
894
1263
|
<h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
|
|
895
1264
|
<dl class="js function">
|
|
896
1265
|
<dt class="sig sig-object js" id="Metadata.getArea">
|
|
897
|
-
<
|
|
1266
|
+
<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
1267
|
<dd><p>Retrieves available geographic locations for a specific endpoint using GET request.</p>
|
|
899
1268
|
<dl class="field-list simple">
|
|
900
1269
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -920,7 +1289,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
920
1289
|
|
|
921
1290
|
<dl class="js function">
|
|
922
1291
|
<dt class="sig sig-object js" id="Metadata.postArea">
|
|
923
|
-
<
|
|
1292
|
+
<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
1293
|
<dd><p>Retrieves available geographic locations for a specific endpoint using POST request.</p>
|
|
925
1294
|
<dl class="field-list simple">
|
|
926
1295
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -949,7 +1318,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
949
1318
|
<h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
|
|
950
1319
|
<dl class="js function">
|
|
951
1320
|
<dt class="sig sig-object js" id="Metadata.getUnits">
|
|
952
|
-
<
|
|
1321
|
+
<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
1322
|
<dd><p>Retrieves available measurement units for a specific type using GET request.</p>
|
|
954
1323
|
<dl class="field-list simple">
|
|
955
1324
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -975,7 +1344,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
975
1344
|
|
|
976
1345
|
<dl class="js function">
|
|
977
1346
|
<dt class="sig sig-object js" id="Metadata.postUnits">
|
|
978
|
-
<
|
|
1347
|
+
<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
1348
|
<dd><p>Retrieves available measurement units for a specific type using POST request.</p>
|
|
980
1349
|
<dl class="field-list simple">
|
|
981
1350
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -1005,7 +1374,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1005
1374
|
<h2>Usage API<a class="headerlink" href="#usage-api" title="Link to this heading">¶</a></h2>
|
|
1006
1375
|
<dl class="js function">
|
|
1007
1376
|
<dt class="sig sig-object js" id="Usage.getUsage">
|
|
1008
|
-
<
|
|
1377
|
+
<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
1378
|
<dd><p>Retrieves current billing period or historical usage data for the user by making a GET request to the API endpoint.</p>
|
|
1010
1379
|
<dl class="field-list simple">
|
|
1011
1380
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -1030,7 +1399,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1030
1399
|
<h2>Interfaces<a class="headerlink" href="#interfaces" title="Link to this heading">¶</a></h2>
|
|
1031
1400
|
<dl class="js interface">
|
|
1032
1401
|
<dt class="sig sig-object js" id="Api.LocationRequestWithoutFactorId">
|
|
1033
|
-
<
|
|
1402
|
+
<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
1403
|
<dd><p>Request parameters for location-based calculations without specifying a factor ID.
|
|
1035
1404
|
Used for calculating emissions or other metrics based on location data.</p>
|
|
1036
1405
|
<blockquote>
|
|
@@ -1041,7 +1410,7 @@ Used for calculating emissions or other metrics based on location data.</p>
|
|
|
1041
1410
|
|
|
1042
1411
|
<dl class="js interface">
|
|
1043
1412
|
<dt class="sig sig-object js" id="Api.LocationRequestWithFactorId">
|
|
1044
|
-
<
|
|
1413
|
+
<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
1414
|
<dd><p>Request parameters for location-based calculations with a specific factor ID.
|
|
1046
1415
|
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1047
1416
|
<blockquote>
|
|
@@ -1052,7 +1421,7 @@ Used when the emission factor is already known and doesn’t need to be determin
|
|
|
1052
1421
|
|
|
1053
1422
|
<dl class="js interface">
|
|
1054
1423
|
<dt class="sig sig-object js" id="Api.CommonRequestWithoutFactorId">
|
|
1055
|
-
<
|
|
1424
|
+
<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
1425
|
<dd><p>Common request parameters for calculations without specifying a factor ID.
|
|
1057
1426
|
Used for general-purpose calculations based on location, time, and activity data.</p>
|
|
1058
1427
|
<blockquote>
|
|
@@ -1063,7 +1432,7 @@ Used for general-purpose calculations based on location, time, and activity data
|
|
|
1063
1432
|
|
|
1064
1433
|
<dl class="js interface">
|
|
1065
1434
|
<dt class="sig sig-object js" id="Api.CommonRequestWithFactorId">
|
|
1066
|
-
<
|
|
1435
|
+
<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
1436
|
<dd><p>Common request parameters for calculations with a specific factor ID.
|
|
1068
1437
|
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1069
1438
|
<blockquote>
|
|
@@ -1074,7 +1443,7 @@ Used when the emission factor is already known and doesn’t need to be determin
|
|
|
1074
1443
|
|
|
1075
1444
|
<dl class="js interface">
|
|
1076
1445
|
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithoutFactorId">
|
|
1077
|
-
<
|
|
1446
|
+
<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
1447
|
<dd><p>Request parameters for generic calculations without specifying a factor ID.
|
|
1079
1448
|
Used for calculations that may involve multiple units or complex activity data.</p>
|
|
1080
1449
|
<blockquote>
|
|
@@ -1085,7 +1454,7 @@ Used for calculations that may involve multiple units or complex activity data.<
|
|
|
1085
1454
|
|
|
1086
1455
|
<dl class="js interface">
|
|
1087
1456
|
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithFactorId">
|
|
1088
|
-
<
|
|
1457
|
+
<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
1458
|
<dd><p>Request parameters for generic calculations with a specific factor ID.
|
|
1090
1459
|
Used for complex calculations where the emission factor is already known.</p>
|
|
1091
1460
|
<blockquote>
|
|
@@ -1096,7 +1465,7 @@ Used for complex calculations where the emission factor is already known.</p>
|
|
|
1096
1465
|
|
|
1097
1466
|
<dl class="js interface">
|
|
1098
1467
|
<dt class="sig sig-object js" id="Api.FactorRequestWithoutFactorId">
|
|
1099
|
-
<
|
|
1468
|
+
<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
1469
|
<dd><p>Request parameters for retrieving factor information without specifying a factor ID.
|
|
1101
1470
|
Used to look up appropriate emission factors based on location, time, and activity type.</p>
|
|
1102
1471
|
<blockquote>
|
|
@@ -1107,7 +1476,7 @@ Used to look up appropriate emission factors based on location, time, and activi
|
|
|
1107
1476
|
|
|
1108
1477
|
<dl class="js interface">
|
|
1109
1478
|
<dt class="sig sig-object js" id="Api.FactorRequestWithFactorId">
|
|
1110
|
-
<
|
|
1479
|
+
<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
1480
|
<dd><p>Request parameters for retrieving specific factor information by ID.
|
|
1112
1481
|
Used when the exact factor to retrieve is already known.</p>
|
|
1113
1482
|
<blockquote>
|
|
@@ -1118,7 +1487,7 @@ Used when the exact factor to retrieve is already known.</p>
|
|
|
1118
1487
|
|
|
1119
1488
|
<dl class="js interface">
|
|
1120
1489
|
<dt class="sig sig-object js" id="Api.SearchRequest">
|
|
1121
|
-
<
|
|
1490
|
+
<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
1491
|
<dd><p>Request parameters for searching factors or activities.
|
|
1123
1492
|
Used to find relevant factors or activities based on location, time, and search criteria.</p>
|
|
1124
1493
|
<blockquote>
|
|
@@ -1129,7 +1498,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1129
1498
|
|
|
1130
1499
|
<dl class="js interface">
|
|
1131
1500
|
<dt class="sig sig-object js" id="common.Location">
|
|
1132
|
-
<
|
|
1501
|
+
<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
1502
|
<dd><dl class="simple">
|
|
1134
1503
|
<dt>Represents a geographical location.</dt><dd><p>Location</p>
|
|
1135
1504
|
</dd>
|
|
@@ -1139,7 +1508,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1139
1508
|
|
|
1140
1509
|
<dl class="js interface">
|
|
1141
1510
|
<dt class="sig sig-object js" id="common.Time">
|
|
1142
|
-
<
|
|
1511
|
+
<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
1512
|
<dd><dl class="simple">
|
|
1144
1513
|
<dt>Represents a point in time with date information.</dt><dd><p>Time</p>
|
|
1145
1514
|
</dd>
|
|
@@ -1149,7 +1518,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1149
1518
|
|
|
1150
1519
|
<dl class="js interface">
|
|
1151
1520
|
<dt class="sig sig-object js" id="common.Activity">
|
|
1152
|
-
<
|
|
1521
|
+
<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
1522
|
<dd><dl class="simple">
|
|
1154
1523
|
<dt>Represents an activity with type, value, and unit of measurement.</dt><dd><p>Activity</p>
|
|
1155
1524
|
</dd>
|
|
@@ -1159,7 +1528,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1159
1528
|
|
|
1160
1529
|
<dl class="js interface">
|
|
1161
1530
|
<dt class="sig sig-object js" id="common.ActivityWithFactorId">
|
|
1162
|
-
<
|
|
1531
|
+
<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
1532
|
<dd><dl class="simple">
|
|
1164
1533
|
<dt>Represents an activity identified by a factor ID instead of a type.</dt><dd><p>ActivityWithFactorId</p>
|
|
1165
1534
|
</dd>
|
|
@@ -1169,7 +1538,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1169
1538
|
|
|
1170
1539
|
<dl class="js interface">
|
|
1171
1540
|
<dt class="sig sig-object js" id="common.CombinedUnitsActivity">
|
|
1172
|
-
<
|
|
1541
|
+
<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
1542
|
<dd><dl class="simple">
|
|
1174
1543
|
<dt>Represents an activity that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivity</p>
|
|
1175
1544
|
</dd>
|
|
@@ -1179,7 +1548,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1179
1548
|
|
|
1180
1549
|
<dl class="js interface">
|
|
1181
1550
|
<dt class="sig sig-object js" id="common.CombinedUnitsActivityWithFactorId">
|
|
1182
|
-
<
|
|
1551
|
+
<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
1552
|
<dd><dl class="simple">
|
|
1184
1553
|
<dt>Represents an activity with factor ID that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivityWithFactorId</p>
|
|
1185
1554
|
</dd>
|
|
@@ -1189,7 +1558,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1189
1558
|
|
|
1190
1559
|
<dl class="js interface">
|
|
1191
1560
|
<dt class="sig sig-object js" id="common.FactorActivity">
|
|
1192
|
-
<
|
|
1561
|
+
<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
1562
|
<dd><dl class="simple">
|
|
1194
1563
|
<dt>Represents a factor activity with a type and optional unit.</dt><dd><p>FactorActivity</p>
|
|
1195
1564
|
</dd>
|
|
@@ -1199,7 +1568,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1199
1568
|
|
|
1200
1569
|
<dl class="js interface">
|
|
1201
1570
|
<dt class="sig sig-object js" id="common.FactorActivityWithFactorId">
|
|
1202
|
-
<
|
|
1571
|
+
<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
1572
|
<dd><dl class="simple">
|
|
1204
1573
|
<dt>Represents a factor activity identified by a factor ID instead of a type.</dt><dd><p>FactorActivityWithFactorId</p>
|
|
1205
1574
|
</dd>
|
|
@@ -1209,7 +1578,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1209
1578
|
|
|
1210
1579
|
<dl class="js interface">
|
|
1211
1580
|
<dt class="sig sig-object js" id="common.SearchActivity">
|
|
1212
|
-
<
|
|
1581
|
+
<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
1582
|
<dd><dl class="simple">
|
|
1214
1583
|
<dt>Represents a search query for activities.</dt><dd><p>SearchActivity</p>
|
|
1215
1584
|
</dd>
|
|
@@ -1219,7 +1588,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1219
1588
|
|
|
1220
1589
|
<dl class="js interface">
|
|
1221
1590
|
<dt class="sig sig-object js" id="common.Pagination">
|
|
1222
|
-
<
|
|
1591
|
+
<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
1592
|
<dd><dl class="simple">
|
|
1224
1593
|
<dt>Represents pagination parameters for paginated results.</dt><dd><p>Pagination</p>
|
|
1225
1594
|
</dd>
|
|
@@ -1229,7 +1598,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1229
1598
|
|
|
1230
1599
|
<dl class="js interface">
|
|
1231
1600
|
<dt class="sig sig-object js" id="Config.RequestConfig">
|
|
1232
|
-
<
|
|
1601
|
+
<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
1602
|
<dd><dl class="simple">
|
|
1234
1603
|
<dt>Configuration for making HTTP requests.</dt><dd><p>RequestConfig</p>
|
|
1235
1604
|
</dd>
|
|
@@ -1239,7 +1608,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1239
1608
|
|
|
1240
1609
|
<dl class="js interface">
|
|
1241
1610
|
<dt class="sig sig-object js" id="Config.ClientConfig">
|
|
1242
|
-
<
|
|
1611
|
+
<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
1612
|
<dd><dl class="simple">
|
|
1244
1613
|
<dt>Configuration for initializing a client instance.</dt><dd><p>ClientConfig</p>
|
|
1245
1614
|
</dd>
|
|
@@ -1247,6 +1616,41 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1247
1616
|
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Config</span></code></p>
|
|
1248
1617
|
</dd></dl>
|
|
1249
1618
|
|
|
1619
|
+
<dl class="js interface">
|
|
1620
|
+
<dt class="sig sig-object js" id="AuditLogResponse.AuditLogResponse">
|
|
1621
|
+
<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>
|
|
1622
|
+
<dd><p>Response interface for audit log configuration.
|
|
1623
|
+
Contains settings for logging requests and responses.</p>
|
|
1624
|
+
<blockquote>
|
|
1625
|
+
<div><p>AuditLogResponse</p>
|
|
1626
|
+
</div></blockquote>
|
|
1627
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditLogResponse</span></code></p>
|
|
1628
|
+
</dd></dl>
|
|
1629
|
+
|
|
1630
|
+
<dl class="js interface">
|
|
1631
|
+
<dt class="sig sig-object js" id="AuditLogResponse.AuditLogRequest">
|
|
1632
|
+
<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>
|
|
1633
|
+
<dd><p>Request interface for updating audit log configuration.
|
|
1634
|
+
Used to configure which parts of API interactions should be logged.</p>
|
|
1635
|
+
<blockquote>
|
|
1636
|
+
<div><p>AuditLogRequest</p>
|
|
1637
|
+
</div></blockquote>
|
|
1638
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.AuditLogResponse</span></code></p>
|
|
1639
|
+
</dd></dl>
|
|
1640
|
+
|
|
1641
|
+
<dl class="js interface">
|
|
1642
|
+
<dt class="sig sig-object js" id="TypeRecommenderResponse.TypeRecommenderResponse">
|
|
1643
|
+
<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>
|
|
1644
|
+
<dd><p>Interface for type recommender API</p>
|
|
1645
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.TypeRecommenderResponse</span></code></p>
|
|
1646
|
+
</dd></dl>
|
|
1647
|
+
|
|
1648
|
+
<dl class="js interface">
|
|
1649
|
+
<dt class="sig sig-object js" id="TypeRecommenderResponse.ActivityRequest">
|
|
1650
|
+
<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>
|
|
1651
|
+
<dd><p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.response.TypeRecommenderResponse</span></code></p>
|
|
1652
|
+
</dd></dl>
|
|
1653
|
+
|
|
1250
1654
|
</section>
|
|
1251
1655
|
</section>
|
|
1252
1656
|
|
|
@@ -1320,6 +1724,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1320
1724
|
<li><a class="reference internal" href="#utils.findExpiryTime"><code class="docutils literal notranslate"><span class="pre">utils.findExpiryTime()</span></code></a></li>
|
|
1321
1725
|
<li><a class="reference internal" href="#api">API</a><ul>
|
|
1322
1726
|
<li><a class="reference internal" href="#Factor.retrieveFactor"><code class="docutils literal notranslate"><span class="pre">Factor.retrieveFactor()</span></code></a></li>
|
|
1727
|
+
<li><a class="reference internal" href="#Factor.search"><code class="docutils literal notranslate"><span class="pre">Factor.search()</span></code></a></li>
|
|
1323
1728
|
<li><a class="reference internal" href="#Fugitive.calculate"><code class="docutils literal notranslate"><span class="pre">Fugitive.calculate()</span></code></a></li>
|
|
1324
1729
|
<li><a class="reference internal" href="#Calculation.calculate"><code class="docutils literal notranslate"><span class="pre">Calculation.calculate()</span></code></a></li>
|
|
1325
1730
|
<li><a class="reference internal" href="#Location.calculate"><code class="docutils literal notranslate"><span class="pre">Location.calculate()</span></code></a></li>
|
|
@@ -1330,6 +1735,15 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1330
1735
|
<li><a class="reference internal" href="#EconomicActivity.calculate"><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></a></li>
|
|
1331
1736
|
</ul>
|
|
1332
1737
|
</li>
|
|
1738
|
+
<li><a class="reference internal" href="#type-recommender-api">Type Recommender API</a><ul>
|
|
1739
|
+
<li><a class="reference internal" href="#TypeRecommender.search"><code class="docutils literal notranslate"><span class="pre">TypeRecommender.search()</span></code></a></li>
|
|
1740
|
+
</ul>
|
|
1741
|
+
</li>
|
|
1742
|
+
<li><a class="reference internal" href="#audit-log-api">Audit Log API</a><ul>
|
|
1743
|
+
<li><a class="reference internal" href="#AuditLog.getAuditConfig"><code class="docutils literal notranslate"><span class="pre">AuditLog.getAuditConfig()</span></code></a></li>
|
|
1744
|
+
<li><a class="reference internal" href="#AuditLog.updateAuditConfig"><code class="docutils literal notranslate"><span class="pre">AuditLog.updateAuditConfig()</span></code></a></li>
|
|
1745
|
+
</ul>
|
|
1746
|
+
</li>
|
|
1333
1747
|
<li><a class="reference internal" href="#global-metadata-api">Global Metadata API</a><ul>
|
|
1334
1748
|
<li><a class="reference internal" href="#gettypes">getTypes</a><ul>
|
|
1335
1749
|
<li><a class="reference internal" href="#Metadata.getTypes"><code class="docutils literal notranslate"><span class="pre">Metadata.getTypes()</span></code></a></li>
|
|
@@ -1374,6 +1788,10 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1374
1788
|
<li><a class="reference internal" href="#common.Pagination"><code class="docutils literal notranslate"><span class="pre">common.Pagination</span></code></a></li>
|
|
1375
1789
|
<li><a class="reference internal" href="#Config.RequestConfig"><code class="docutils literal notranslate"><span class="pre">Config.RequestConfig</span></code></a></li>
|
|
1376
1790
|
<li><a class="reference internal" href="#Config.ClientConfig"><code class="docutils literal notranslate"><span class="pre">Config.ClientConfig</span></code></a></li>
|
|
1791
|
+
<li><a class="reference internal" href="#AuditLogResponse.AuditLogResponse"><code class="docutils literal notranslate"><span class="pre">AuditLogResponse.AuditLogResponse</span></code></a></li>
|
|
1792
|
+
<li><a class="reference internal" href="#AuditLogResponse.AuditLogRequest"><code class="docutils literal notranslate"><span class="pre">AuditLogResponse.AuditLogRequest</span></code></a></li>
|
|
1793
|
+
<li><a class="reference internal" href="#TypeRecommenderResponse.TypeRecommenderResponse"><code class="docutils literal notranslate"><span class="pre">TypeRecommenderResponse.TypeRecommenderResponse</span></code></a></li>
|
|
1794
|
+
<li><a class="reference internal" href="#TypeRecommenderResponse.ActivityRequest"><code class="docutils literal notranslate"><span class="pre">TypeRecommenderResponse.ActivityRequest</span></code></a></li>
|
|
1377
1795
|
</ul>
|
|
1378
1796
|
</li>
|
|
1379
1797
|
</ul>
|
|
@@ -1388,8 +1806,8 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1388
1806
|
</aside>
|
|
1389
1807
|
</div>
|
|
1390
1808
|
</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=
|
|
1809
|
+
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
1810
|
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
1393
1811
|
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
|
|
1394
1812
|
</body>
|
|
1395
1813
|
</html>
|