emissions-api-sdk 1.0.11 → 1.0.12
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 +117 -0
- package/dist/api/Factor.js +53 -1
- package/dist/api/TypeRecommender.js +48 -0
- package/dist/coverage/clover.xml +17 -14
- package/dist/coverage/coverage-final.json +3 -3
- package/dist/coverage/lcov-report/index.html +7 -7
- package/dist/coverage/lcov-report/src/Client.ts.html +1 -1
- package/dist/coverage/lcov-report/src/Constants.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +159 -3
- package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +1 -1
- 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 +146 -2
- package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/index.html +1 -1
- package/dist/coverage/lcov-report/src/index.html +1 -1
- package/dist/coverage/lcov-report/src/request.ts.html +1 -1
- package/dist/coverage/lcov-report/src/utils.ts.html +1 -1
- package/dist/coverage/lcov-report/test/index.html +1 -1
- package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
- 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/SearchRequest.ts.html +148 -4
- package/dist/coverage/lcov-report/test/mocks/index.html +5 -5
- package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
- package/dist/coverage/lcov.info +16 -13
- package/dist/types/api/Factor.d.ts +53 -1
- package/dist/types/api/TypeRecommender.d.ts +48 -0
- package/dist/types/interfaces/common.d.ts +8 -0
- package/docs/_static/base-stemmer.js +476 -0
- package/docs/_static/basic.css +0 -8
- package/docs/_static/doctools.js +6 -5
- package/docs/_static/english-stemmer.js +1066 -0
- package/docs/_static/language_data.js +7 -186
- package/docs/_static/pygments.css +164 -146
- package/docs/_static/searchtools.js +121 -60
- package/docs/_static/sphinx_highlight.js +36 -31
- package/docs/_static/styles/furo.css +1 -1
- package/docs/_static/styles/furo.css.map +1 -1
- package/docs/authentication.html +21 -30
- package/docs/client.html +21 -30
- package/docs/genindex.html +21 -30
- package/docs/getting_started.html +21 -30
- package/docs/index.html +21 -30
- package/docs/reference.html +63 -72
- package/docs/sdk.html +21 -30
- package/docs/search.html +21 -30
- package/docs/searchindex.js +1 -1
- package/docs/troubleshooting.html +21 -30
- package/package.json +1 -1
- package/src/api/Factor.ts +53 -1
- package/src/api/TypeRecommender.ts +48 -0
- package/src/interfaces/common.ts +12 -0
- package/test/mocks/SearchRequest.ts +48 -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 9.1.0 and Furo 2025.12.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=7bdb33bb" />
|
|
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: #202020;
|
|
28
|
+
--color-code-foreground: #d0d0d0;
|
|
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: #202020;
|
|
34
|
+
--color-code-foreground: #d0d0d0;
|
|
35
35
|
|
|
36
36
|
}
|
|
37
37
|
}
|
|
@@ -146,14 +146,10 @@
|
|
|
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
|
-
|
|
153
|
-
</label>
|
|
154
|
-
<label class="overlay toc-overlay" for="__toc">
|
|
155
|
-
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
156
|
-
</label>
|
|
149
|
+
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
|
150
|
+
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
|
151
|
+
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
|
152
|
+
<label class="overlay toc-overlay" for="__toc"></label>
|
|
157
153
|
|
|
158
154
|
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
|
159
155
|
|
|
@@ -163,8 +159,7 @@
|
|
|
163
159
|
<header class="mobile-header">
|
|
164
160
|
<div class="header-left">
|
|
165
161
|
<label class="nav-overlay-icon" for="__navigation">
|
|
166
|
-
<
|
|
167
|
-
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
162
|
+
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
|
168
163
|
</label>
|
|
169
164
|
</div>
|
|
170
165
|
<div class="header-center">
|
|
@@ -172,8 +167,7 @@
|
|
|
172
167
|
</div>
|
|
173
168
|
<div class="header-right">
|
|
174
169
|
<div class="theme-toggle-container theme-toggle-header">
|
|
175
|
-
<button class="theme-toggle">
|
|
176
|
-
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
170
|
+
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
|
177
171
|
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
178
172
|
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
179
173
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
@@ -181,8 +175,7 @@
|
|
|
181
175
|
</button>
|
|
182
176
|
</div>
|
|
183
177
|
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
184
|
-
<
|
|
185
|
-
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
178
|
+
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
|
186
179
|
</label>
|
|
187
180
|
</div>
|
|
188
181
|
</header>
|
|
@@ -202,7 +195,7 @@
|
|
|
202
195
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
203
196
|
<ul class="current">
|
|
204
197
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
|
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"><
|
|
198
|
+
<li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input aria-label="Toggle navigation of SDK" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
|
206
199
|
<li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
|
|
207
200
|
<li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
|
|
208
201
|
</ul>
|
|
@@ -235,8 +228,7 @@
|
|
|
235
228
|
</a>
|
|
236
229
|
</div>
|
|
237
230
|
<div class="theme-toggle-container theme-toggle-content">
|
|
238
|
-
<button class="theme-toggle">
|
|
239
|
-
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
231
|
+
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
|
240
232
|
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
241
233
|
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
242
234
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
@@ -244,8 +236,7 @@
|
|
|
244
236
|
</button>
|
|
245
237
|
</div>
|
|
246
238
|
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
247
|
-
<
|
|
248
|
-
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
239
|
+
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
|
249
240
|
</label>
|
|
250
241
|
</div>
|
|
251
242
|
<article role="main" id="furo-main-content">
|
|
@@ -253,7 +244,7 @@
|
|
|
253
244
|
<h1>Reference<a class="headerlink" href="#reference" title="Link to this heading">¶</a></h1>
|
|
254
245
|
<dl class="js class">
|
|
255
246
|
<dt class="sig sig-object js" id="Client">
|
|
256
|
-
<
|
|
247
|
+
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><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</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">false</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Client" title="Link to this definition">¶</a></dt>
|
|
257
248
|
<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>
|
|
258
249
|
<dl class="field-list simple">
|
|
259
250
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -345,7 +336,7 @@
|
|
|
345
336
|
|
|
346
337
|
<dl class="js function">
|
|
347
338
|
<dt class="sig sig-object js" id="Client.refreshToken">
|
|
348
|
-
<
|
|
339
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
349
340
|
<dd><p>Refreshes the authentication token if it’s about to expire.
|
|
350
341
|
Only refreshes if the token was not provided by the user and is expiring within 60 seconds.</p>
|
|
351
342
|
<dl class="field-list simple">
|
|
@@ -366,7 +357,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
366
357
|
|
|
367
358
|
<dl class="js function">
|
|
368
359
|
<dt class="sig sig-object js" id="Client.getClient">
|
|
369
|
-
<
|
|
360
|
+
<span 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></span><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>
|
|
370
361
|
<dd><p>Initializes and returns a Client instance with the provided configuration.</p>
|
|
371
362
|
<dl class="field-list simple">
|
|
372
363
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -413,7 +404,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
413
404
|
|
|
414
405
|
<dl class="js function">
|
|
415
406
|
<dt class="sig sig-object js" id="Client.getInstance">
|
|
416
|
-
<
|
|
407
|
+
<span class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></span><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>
|
|
417
408
|
<dd><p>Returns the singleton instance of the Client.</p>
|
|
418
409
|
<dl class="field-list simple">
|
|
419
410
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
@@ -440,7 +431,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
440
431
|
|
|
441
432
|
<dl class="js function">
|
|
442
433
|
<dt class="sig sig-object js" id="request.makeApiRequest">
|
|
443
|
-
<
|
|
434
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
444
435
|
<dd><p>Makes an API request with standardized headers and token refresh.</p>
|
|
445
436
|
<dl class="field-list simple">
|
|
446
437
|
<dt class="field-odd">Type parameters<span class="colon">:</span></dt>
|
|
@@ -502,7 +493,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
502
493
|
<h2>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h2>
|
|
503
494
|
<dl class="js function">
|
|
504
495
|
<dt class="sig sig-object js" id="Factor.retrieveFactor">
|
|
505
|
-
<
|
|
496
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
506
497
|
<dd><p>Retrieves a factor details by making a POST request to the factor API endpoint.</p>
|
|
507
498
|
<dl class="field-list simple">
|
|
508
499
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -545,7 +536,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
545
536
|
|
|
546
537
|
<dl class="js function">
|
|
547
538
|
<dt class="sig sig-object js" id="Fugitive.calculate">
|
|
548
|
-
<
|
|
539
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
549
540
|
<dd><p>Performs scope 1 fugitve emission calculations by making a POST request to the fugitive API endpoint.</p>
|
|
550
541
|
<dl class="field-list simple">
|
|
551
542
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -581,7 +572,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
581
572
|
|
|
582
573
|
<dl class="js function">
|
|
583
574
|
<dt class="sig sig-object js" id="Calculation.calculate">
|
|
584
|
-
<
|
|
575
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
585
576
|
<dd><p>Performs emission calculations by making a POST request to the generic calculation API endpoint.</p>
|
|
586
577
|
<dl class="field-list simple">
|
|
587
578
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -618,7 +609,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
618
609
|
|
|
619
610
|
<dl class="js function">
|
|
620
611
|
<dt class="sig sig-object js" id="Location.calculate">
|
|
621
|
-
<
|
|
612
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
622
613
|
<dd><p>Performs scope 2 purchased energy Emission calculations by making a POST request to the location API endpoint.</p>
|
|
623
614
|
<dl class="field-list simple">
|
|
624
615
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -655,7 +646,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
655
646
|
|
|
656
647
|
<dl class="js function">
|
|
657
648
|
<dt class="sig sig-object js" id="Mobile.calculate">
|
|
658
|
-
<
|
|
649
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
659
650
|
<dd><p>Performs Scope 1 mobile emissions related calculations by making a POST request to the mobile API endpoint.</p>
|
|
660
651
|
<dl class="field-list simple">
|
|
661
652
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -692,7 +683,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
692
683
|
|
|
693
684
|
<dl class="js function">
|
|
694
685
|
<dt class="sig sig-object js" id="Stationary.calculate">
|
|
695
|
-
<
|
|
686
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
696
687
|
<dd><p>Performs Scope 1 stationary calculations by making a POST request to the stationary API endpoint.</p>
|
|
697
688
|
<dl class="field-list simple">
|
|
698
689
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -729,7 +720,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
729
720
|
|
|
730
721
|
<dl class="js function">
|
|
731
722
|
<dt class="sig sig-object js" id="TransportationAndDistribution.calculate">
|
|
732
|
-
<
|
|
723
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
733
724
|
<dd><p>Performs Scope 3 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.</p>
|
|
734
725
|
<dl class="field-list simple">
|
|
735
726
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -765,7 +756,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
765
756
|
|
|
766
757
|
<dl class="js function">
|
|
767
758
|
<dt class="sig sig-object js" id="RealEstate.calculate">
|
|
768
|
-
<
|
|
759
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
769
760
|
<dd><p>Performs scope 3 Real estate emission calculations by making a POST request to the real estate API endpoint.</p>
|
|
770
761
|
<dl class="field-list simple">
|
|
771
762
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -801,7 +792,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
801
792
|
|
|
802
793
|
<dl class="js function">
|
|
803
794
|
<dt class="sig sig-object js" id="EconomicActivity.calculate">
|
|
804
|
-
<
|
|
795
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
805
796
|
<dd><p>Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.</p>
|
|
806
797
|
<dl class="field-list simple">
|
|
807
798
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -848,7 +839,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
848
839
|
<h3>getTypes<a class="headerlink" href="#gettypes" title="Link to this heading">¶</a></h3>
|
|
849
840
|
<dl class="js function">
|
|
850
841
|
<dt class="sig sig-object js" id="Metadata.getTypes">
|
|
851
|
-
<
|
|
842
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
852
843
|
<dd><p>Retrieves available emission source types for a specific endpoint using GET request.</p>
|
|
853
844
|
<dl class="field-list simple">
|
|
854
845
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -874,7 +865,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
874
865
|
|
|
875
866
|
<dl class="js function">
|
|
876
867
|
<dt class="sig sig-object js" id="Metadata.postTypes">
|
|
877
|
-
<
|
|
868
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
878
869
|
<dd><p>Retrieves available emission source types for a specific endpoint using POST request.</p>
|
|
879
870
|
<dl class="field-list simple">
|
|
880
871
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -903,7 +894,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
903
894
|
<h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
|
|
904
895
|
<dl class="js function">
|
|
905
896
|
<dt class="sig sig-object js" id="Metadata.getArea">
|
|
906
|
-
<
|
|
897
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
907
898
|
<dd><p>Retrieves available geographic locations for a specific endpoint using GET request.</p>
|
|
908
899
|
<dl class="field-list simple">
|
|
909
900
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -929,7 +920,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
929
920
|
|
|
930
921
|
<dl class="js function">
|
|
931
922
|
<dt class="sig sig-object js" id="Metadata.postArea">
|
|
932
|
-
<
|
|
923
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
933
924
|
<dd><p>Retrieves available geographic locations for a specific endpoint using POST request.</p>
|
|
934
925
|
<dl class="field-list simple">
|
|
935
926
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -958,7 +949,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
958
949
|
<h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
|
|
959
950
|
<dl class="js function">
|
|
960
951
|
<dt class="sig sig-object js" id="Metadata.getUnits">
|
|
961
|
-
<
|
|
952
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
962
953
|
<dd><p>Retrieves available measurement units for a specific type using GET request.</p>
|
|
963
954
|
<dl class="field-list simple">
|
|
964
955
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -984,7 +975,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
984
975
|
|
|
985
976
|
<dl class="js function">
|
|
986
977
|
<dt class="sig sig-object js" id="Metadata.postUnits">
|
|
987
|
-
<
|
|
978
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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>
|
|
988
979
|
<dd><p>Retrieves available measurement units for a specific type using POST request.</p>
|
|
989
980
|
<dl class="field-list simple">
|
|
990
981
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -1014,7 +1005,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1014
1005
|
<h2>Usage API<a class="headerlink" href="#usage-api" title="Link to this heading">¶</a></h2>
|
|
1015
1006
|
<dl class="js function">
|
|
1016
1007
|
<dt class="sig sig-object js" id="Usage.getUsage">
|
|
1017
|
-
<
|
|
1008
|
+
<span class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></span><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</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">false</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Usage.getUsage" title="Link to this definition">¶</a></dt>
|
|
1018
1009
|
<dd><p>Retrieves current billing period or historical usage data for the user by making a GET request to the API endpoint.</p>
|
|
1019
1010
|
<dl class="field-list simple">
|
|
1020
1011
|
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
@@ -1039,7 +1030,7 @@ Only refreshes if the token was not provided by the user and is expiring within
|
|
|
1039
1030
|
<h2>Interfaces<a class="headerlink" href="#interfaces" title="Link to this heading">¶</a></h2>
|
|
1040
1031
|
<dl class="js interface">
|
|
1041
1032
|
<dt class="sig sig-object js" id="Api.LocationRequestWithoutFactorId">
|
|
1042
|
-
<
|
|
1033
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1043
1034
|
<dd><p>Request parameters for location-based calculations without specifying a factor ID.
|
|
1044
1035
|
Used for calculating emissions or other metrics based on location data.</p>
|
|
1045
1036
|
<blockquote>
|
|
@@ -1050,7 +1041,7 @@ Used for calculating emissions or other metrics based on location data.</p>
|
|
|
1050
1041
|
|
|
1051
1042
|
<dl class="js interface">
|
|
1052
1043
|
<dt class="sig sig-object js" id="Api.LocationRequestWithFactorId">
|
|
1053
|
-
<
|
|
1044
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1054
1045
|
<dd><p>Request parameters for location-based calculations with a specific factor ID.
|
|
1055
1046
|
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1056
1047
|
<blockquote>
|
|
@@ -1061,7 +1052,7 @@ Used when the emission factor is already known and doesn’t need to be determin
|
|
|
1061
1052
|
|
|
1062
1053
|
<dl class="js interface">
|
|
1063
1054
|
<dt class="sig sig-object js" id="Api.CommonRequestWithoutFactorId">
|
|
1064
|
-
<
|
|
1055
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1065
1056
|
<dd><p>Common request parameters for calculations without specifying a factor ID.
|
|
1066
1057
|
Used for general-purpose calculations based on location, time, and activity data.</p>
|
|
1067
1058
|
<blockquote>
|
|
@@ -1072,7 +1063,7 @@ Used for general-purpose calculations based on location, time, and activity data
|
|
|
1072
1063
|
|
|
1073
1064
|
<dl class="js interface">
|
|
1074
1065
|
<dt class="sig sig-object js" id="Api.CommonRequestWithFactorId">
|
|
1075
|
-
<
|
|
1066
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1076
1067
|
<dd><p>Common request parameters for calculations with a specific factor ID.
|
|
1077
1068
|
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1078
1069
|
<blockquote>
|
|
@@ -1083,7 +1074,7 @@ Used when the emission factor is already known and doesn’t need to be determin
|
|
|
1083
1074
|
|
|
1084
1075
|
<dl class="js interface">
|
|
1085
1076
|
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithoutFactorId">
|
|
1086
|
-
<
|
|
1077
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1087
1078
|
<dd><p>Request parameters for generic calculations without specifying a factor ID.
|
|
1088
1079
|
Used for calculations that may involve multiple units or complex activity data.</p>
|
|
1089
1080
|
<blockquote>
|
|
@@ -1094,7 +1085,7 @@ Used for calculations that may involve multiple units or complex activity data.<
|
|
|
1094
1085
|
|
|
1095
1086
|
<dl class="js interface">
|
|
1096
1087
|
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithFactorId">
|
|
1097
|
-
<
|
|
1088
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1098
1089
|
<dd><p>Request parameters for generic calculations with a specific factor ID.
|
|
1099
1090
|
Used for complex calculations where the emission factor is already known.</p>
|
|
1100
1091
|
<blockquote>
|
|
@@ -1105,7 +1096,7 @@ Used for complex calculations where the emission factor is already known.</p>
|
|
|
1105
1096
|
|
|
1106
1097
|
<dl class="js interface">
|
|
1107
1098
|
<dt class="sig sig-object js" id="Api.FactorRequestWithoutFactorId">
|
|
1108
|
-
<
|
|
1099
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1109
1100
|
<dd><p>Request parameters for retrieving factor information without specifying a factor ID.
|
|
1110
1101
|
Used to look up appropriate emission factors based on location, time, and activity type.</p>
|
|
1111
1102
|
<blockquote>
|
|
@@ -1116,7 +1107,7 @@ Used to look up appropriate emission factors based on location, time, and activi
|
|
|
1116
1107
|
|
|
1117
1108
|
<dl class="js interface">
|
|
1118
1109
|
<dt class="sig sig-object js" id="Api.FactorRequestWithFactorId">
|
|
1119
|
-
<
|
|
1110
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1120
1111
|
<dd><p>Request parameters for retrieving specific factor information by ID.
|
|
1121
1112
|
Used when the exact factor to retrieve is already known.</p>
|
|
1122
1113
|
<blockquote>
|
|
@@ -1127,7 +1118,7 @@ Used when the exact factor to retrieve is already known.</p>
|
|
|
1127
1118
|
|
|
1128
1119
|
<dl class="js interface">
|
|
1129
1120
|
<dt class="sig sig-object js" id="Api.SearchRequest">
|
|
1130
|
-
<
|
|
1121
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1131
1122
|
<dd><p>Request parameters for searching factors or activities.
|
|
1132
1123
|
Used to find relevant factors or activities based on location, time, and search criteria.</p>
|
|
1133
1124
|
<blockquote>
|
|
@@ -1138,7 +1129,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1138
1129
|
|
|
1139
1130
|
<dl class="js interface">
|
|
1140
1131
|
<dt class="sig sig-object js" id="common.Location">
|
|
1141
|
-
<
|
|
1132
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1142
1133
|
<dd><dl class="simple">
|
|
1143
1134
|
<dt>Represents a geographical location.</dt><dd><p>Location</p>
|
|
1144
1135
|
</dd>
|
|
@@ -1148,7 +1139,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1148
1139
|
|
|
1149
1140
|
<dl class="js interface">
|
|
1150
1141
|
<dt class="sig sig-object js" id="common.Time">
|
|
1151
|
-
<
|
|
1142
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1152
1143
|
<dd><dl class="simple">
|
|
1153
1144
|
<dt>Represents a point in time with date information.</dt><dd><p>Time</p>
|
|
1154
1145
|
</dd>
|
|
@@ -1158,7 +1149,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1158
1149
|
|
|
1159
1150
|
<dl class="js interface">
|
|
1160
1151
|
<dt class="sig sig-object js" id="common.Activity">
|
|
1161
|
-
<
|
|
1152
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1162
1153
|
<dd><dl class="simple">
|
|
1163
1154
|
<dt>Represents an activity with type, value, and unit of measurement.</dt><dd><p>Activity</p>
|
|
1164
1155
|
</dd>
|
|
@@ -1168,7 +1159,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1168
1159
|
|
|
1169
1160
|
<dl class="js interface">
|
|
1170
1161
|
<dt class="sig sig-object js" id="common.ActivityWithFactorId">
|
|
1171
|
-
<
|
|
1162
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1172
1163
|
<dd><dl class="simple">
|
|
1173
1164
|
<dt>Represents an activity identified by a factor ID instead of a type.</dt><dd><p>ActivityWithFactorId</p>
|
|
1174
1165
|
</dd>
|
|
@@ -1178,7 +1169,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1178
1169
|
|
|
1179
1170
|
<dl class="js interface">
|
|
1180
1171
|
<dt class="sig sig-object js" id="common.CombinedUnitsActivity">
|
|
1181
|
-
<
|
|
1172
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1182
1173
|
<dd><dl class="simple">
|
|
1183
1174
|
<dt>Represents an activity that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivity</p>
|
|
1184
1175
|
</dd>
|
|
@@ -1188,7 +1179,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1188
1179
|
|
|
1189
1180
|
<dl class="js interface">
|
|
1190
1181
|
<dt class="sig sig-object js" id="common.CombinedUnitsActivityWithFactorId">
|
|
1191
|
-
<
|
|
1182
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1192
1183
|
<dd><dl class="simple">
|
|
1193
1184
|
<dt>Represents an activity with factor ID that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivityWithFactorId</p>
|
|
1194
1185
|
</dd>
|
|
@@ -1198,7 +1189,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1198
1189
|
|
|
1199
1190
|
<dl class="js interface">
|
|
1200
1191
|
<dt class="sig sig-object js" id="common.FactorActivity">
|
|
1201
|
-
<
|
|
1192
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1202
1193
|
<dd><dl class="simple">
|
|
1203
1194
|
<dt>Represents a factor activity with a type and optional unit.</dt><dd><p>FactorActivity</p>
|
|
1204
1195
|
</dd>
|
|
@@ -1208,7 +1199,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1208
1199
|
|
|
1209
1200
|
<dl class="js interface">
|
|
1210
1201
|
<dt class="sig sig-object js" id="common.FactorActivityWithFactorId">
|
|
1211
|
-
<
|
|
1202
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1212
1203
|
<dd><dl class="simple">
|
|
1213
1204
|
<dt>Represents a factor activity identified by a factor ID instead of a type.</dt><dd><p>FactorActivityWithFactorId</p>
|
|
1214
1205
|
</dd>
|
|
@@ -1218,7 +1209,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1218
1209
|
|
|
1219
1210
|
<dl class="js interface">
|
|
1220
1211
|
<dt class="sig sig-object js" id="common.SearchActivity">
|
|
1221
|
-
<
|
|
1212
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1222
1213
|
<dd><dl class="simple">
|
|
1223
1214
|
<dt>Represents a search query for activities.</dt><dd><p>SearchActivity</p>
|
|
1224
1215
|
</dd>
|
|
@@ -1228,7 +1219,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1228
1219
|
|
|
1229
1220
|
<dl class="js interface">
|
|
1230
1221
|
<dt class="sig sig-object js" id="common.Pagination">
|
|
1231
|
-
<
|
|
1222
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1232
1223
|
<dd><dl class="simple">
|
|
1233
1224
|
<dt>Represents pagination parameters for paginated results.</dt><dd><p>Pagination</p>
|
|
1234
1225
|
</dd>
|
|
@@ -1238,7 +1229,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1238
1229
|
|
|
1239
1230
|
<dl class="js interface">
|
|
1240
1231
|
<dt class="sig sig-object js" id="Config.RequestConfig">
|
|
1241
|
-
<
|
|
1232
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1242
1233
|
<dd><dl class="simple">
|
|
1243
1234
|
<dt>Configuration for making HTTP requests.</dt><dd><p>RequestConfig</p>
|
|
1244
1235
|
</dd>
|
|
@@ -1248,7 +1239,7 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1248
1239
|
|
|
1249
1240
|
<dl class="js interface">
|
|
1250
1241
|
<dt class="sig sig-object js" id="Config.ClientConfig">
|
|
1251
|
-
<
|
|
1242
|
+
<span class="property"><span class="k"><span class="pre">interface</span></span><span class="w"> </span></span><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>
|
|
1252
1243
|
<dd><dl class="simple">
|
|
1253
1244
|
<dt>Configuration for initializing a client instance.</dt><dd><p>ClientConfig</p>
|
|
1254
1245
|
</dd>
|
|
@@ -1397,8 +1388,8 @@ Used to find relevant factors or activities based on location, time, and search
|
|
|
1397
1388
|
</aside>
|
|
1398
1389
|
</div>
|
|
1399
1390
|
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
1400
|
-
<script src="_static/doctools.js?v=
|
|
1401
|
-
<script src="_static/sphinx_highlight.js?v=
|
|
1391
|
+
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
|
1392
|
+
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
|
1402
1393
|
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
|
|
1403
1394
|
</body>
|
|
1404
1395
|
</html>
|