emissions-api-sdk 1.0.0 → 1.0.2
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 +33 -2
- package/dist/Constants.js +23 -1
- package/dist/api/Calculation.js +78 -15
- package/dist/api/Factor.js +99 -18
- package/dist/api/FactorSets.js +1 -1
- package/dist/api/Fugitive.js +76 -13
- package/dist/api/Location.js +76 -15
- package/dist/api/Mobile.js +65 -1
- package/dist/api/Stationary.js +78 -15
- package/dist/api/TransportationAndDistribution.js +77 -14
- package/dist/coverage/clover.xml +191 -81
- package/dist/coverage/coverage-final.json +11 -11
- package/dist/coverage/lcov-report/index.html +16 -16
- package/dist/coverage/lcov-report/src/Client.ts.html +23 -23
- package/dist/coverage/lcov-report/src/Constants.ts.html +82 -4
- package/dist/coverage/lcov-report/src/api/Calculation.ts.html +245 -26
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +313 -34
- package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +8 -5
- package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +246 -24
- package/dist/coverage/lcov-report/src/api/Location.ts.html +245 -26
- package/dist/coverage/lcov-report/src/api/Mobile.ts.html +240 -12
- package/dist/coverage/lcov-report/src/api/Stationary.ts.html +248 -26
- package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +250 -25
- package/dist/coverage/lcov-report/src/api/index.html +25 -25
- package/dist/coverage/lcov-report/src/index.html +7 -7
- package/dist/coverage/lcov-report/src/request.ts.html +1 -1
- package/dist/coverage/lcov-report/src/utils.ts.html +5 -5
- 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 +1 -1
- package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
- package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
- package/dist/coverage/lcov.info +287 -133
- package/dist/interfaces/response/AreaResponse.js +2 -0
- package/dist/interfaces/response/EmissionResponse.js +2 -0
- package/dist/interfaces/response/EmissionResponseWithDetails.js +2 -0
- package/dist/interfaces/response/FactorResponse.js +2 -0
- package/dist/interfaces/response/FactorSetResponse.js +2 -0
- package/dist/interfaces/response/SearchResponse.js +2 -0
- package/dist/interfaces/response/TypeResponse.js +2 -0
- package/dist/interfaces/response/UnitResponse.js +2 -0
- package/dist/types/Constants.d.ts +22 -0
- package/dist/types/api/Calculation.d.ts +59 -16
- package/dist/types/api/Factor.d.ts +73 -20
- package/dist/types/api/FactorSets.d.ts +3 -2
- package/dist/types/api/Fugitive.d.ts +57 -14
- package/dist/types/api/Location.d.ts +57 -16
- package/dist/types/api/Mobile.d.ts +46 -2
- package/dist/types/api/Stationary.d.ts +59 -16
- package/dist/types/api/TransportationAndDistribution.d.ts +58 -15
- package/dist/types/index.d.ts +8 -0
- package/dist/types/interfaces/response/AreaResponse.d.ts +20 -0
- package/dist/types/interfaces/response/EmissionResponse.d.ts +31 -0
- package/dist/types/interfaces/response/EmissionResponseWithDetails.d.ts +144 -0
- package/dist/types/interfaces/response/FactorResponse.d.ts +53 -0
- package/dist/types/interfaces/response/FactorSetResponse.d.ts +38 -0
- package/dist/types/interfaces/response/SearchResponse.d.ts +41 -0
- package/dist/types/interfaces/response/TypeResponse.d.ts +7 -0
- package/dist/types/interfaces/response/UnitResponse.d.ts +7 -0
- package/docs/.nojekyll +0 -0
- package/docs/_sources/authentication.rst.txt +164 -0
- package/docs/_sources/client.rst.txt +137 -0
- package/docs/_sources/getting_started.rst.txt +164 -0
- package/docs/_sources/index.rst.txt +30 -0
- package/docs/_sources/reference.rst.txt +129 -0
- package/docs/_sources/sdk.rst.txt +13 -0
- package/docs/_sources/troubleshooting.rst.txt +486 -0
- package/docs/_static/basic.css +914 -0
- package/docs/_static/custom.css +16 -0
- package/docs/_static/debug.css +69 -0
- package/docs/_static/doctools.js +149 -0
- package/docs/_static/documentation_options.js +13 -0
- package/docs/_static/file.png +0 -0
- package/docs/_static/language_data.js +192 -0
- package/docs/_static/minus.png +0 -0
- package/docs/_static/plus.png +0 -0
- package/docs/_static/pygments.css +232 -0
- package/docs/_static/scripts/furo-extensions.js +0 -0
- package/docs/_static/scripts/furo.js +3 -0
- package/docs/_static/scripts/furo.js.LICENSE.txt +7 -0
- package/docs/_static/scripts/furo.js.map +1 -0
- package/docs/_static/searchtools.js +632 -0
- package/docs/_static/skeleton.css +296 -0
- package/docs/_static/sphinx_highlight.js +154 -0
- package/docs/_static/sphinx_js.css +0 -0
- package/docs/_static/styles/furo-extensions.css +2 -0
- package/docs/_static/styles/furo-extensions.css.map +1 -0
- package/docs/_static/styles/furo.css +2 -0
- package/docs/_static/styles/furo.css.map +1 -0
- package/docs/authentication.html +523 -0
- package/docs/client.html +477 -0
- package/docs/genindex.html +492 -0
- package/docs/getting_started.html +491 -0
- package/docs/index.html +357 -0
- package/docs/objects.inv +0 -0
- package/docs/reference.html +1584 -0
- package/docs/sdk.html +334 -0
- package/docs/search.html +297 -0
- package/docs/searchindex.js +1 -0
- package/docs/troubleshooting.html +786 -0
- package/package.json +1 -1
- package/sphinx-build/Makefile +49 -0
- package/sphinx-build/requirements.txt +5 -0
- package/sphinx-build/source/_static/custom.css +16 -0
- package/sphinx-build/source/authentication.rst +164 -0
- package/sphinx-build/source/client.rst +137 -0
- package/sphinx-build/source/conf.py +56 -0
- package/sphinx-build/source/getting_started.rst +164 -0
- package/sphinx-build/source/index.rst +30 -0
- package/sphinx-build/source/reference.rst +129 -0
- package/sphinx-build/source/sdk.rst +13 -0
- package/sphinx-build/source/troubleshooting.rst +486 -0
- package/src/Constants.ts +26 -0
- package/src/api/Calculation.ts +94 -20
- package/src/api/Factor.ts +122 -28
- package/src/api/FactorSets.ts +4 -3
- package/src/api/Fugitive.ts +93 -18
- package/src/api/Location.ts +94 -20
- package/src/api/Mobile.ts +83 -6
- package/src/api/Stationary.ts +95 -20
- package/src/api/TransportationAndDistribution.ts +95 -19
- package/src/index.ts +33 -1
- package/src/interfaces/response/AreaResponse.ts +25 -0
- package/src/interfaces/response/EmissionResponse.ts +44 -0
- package/src/interfaces/response/EmissionResponseWithDetails.ts +183 -0
- package/src/interfaces/response/FactorResponse.ts +78 -0
- package/src/interfaces/response/FactorSetResponse.ts +52 -0
- package/src/interfaces/response/SearchResponse.ts +52 -0
- package/src/interfaces/response/TypeResponse.ts +7 -0
- package/src/interfaces/response/UnitResponse.ts +7 -0
- package/test/apiTest.test.ts +173 -6
- package/dist/api/Factors.js +0 -98
- package/dist/api/FugitiveEmission.js +0 -40
- package/dist/api/GenericCalculation.js +0 -41
- package/dist/api/LocationEmission.js +0 -41
- package/dist/api/MobileEmission.js +0 -41
- package/dist/api/StationaryEmission.js +0 -41
- package/dist/api/TransportationDistributionEmission.js +0 -40
- package/dist/coverage/lcov-report/src/api/Factors.ts.html +0 -403
- package/dist/coverage/lcov-report/src/api/FugitiveEmission.ts.html +0 -214
- package/dist/coverage/lcov-report/src/api/GenericCalculation.ts.html +0 -217
- package/dist/coverage/lcov-report/src/api/LocationEmission.ts.html +0 -214
- package/dist/coverage/lcov-report/src/api/MobileEmission.ts.html +0 -220
- package/dist/coverage/lcov-report/src/api/StationaryEmission.ts.html +0 -220
- package/dist/coverage/lcov-report/src/api/TransportationDistributionEmission.ts.html +0 -211
- package/dist/types/api/Factors.d.ts +0 -68
- package/dist/types/api/FugitiveEmission.d.ts +0 -27
- package/dist/types/api/GenericCalculation.d.ts +0 -28
- package/dist/types/api/LocationEmission.d.ts +0 -28
- package/dist/types/api/MobileEmission.d.ts +0 -28
- package/dist/types/api/StationaryEmission.d.ts +0 -28
- package/dist/types/api/TransportationDistributionEmission.d.ts +0 -27
|
@@ -0,0 +1,1584 @@
|
|
|
1
|
+
<!doctype html>
|
|
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"/>
|
|
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" /><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
|
+
|
|
8
|
+
<!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 -->
|
|
9
|
+
<title>Reference - IBM Envizi - Emissions API Node.js SDK documentation</title>
|
|
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=25af2a20" />
|
|
12
|
+
<link rel="stylesheet" type="text/css" href="_static/sphinx_js.css" />
|
|
13
|
+
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
|
|
14
|
+
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=8d04aa46" />
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
<style>
|
|
20
|
+
body {
|
|
21
|
+
--color-code-background: #f2f2f2;
|
|
22
|
+
--color-code-foreground: #1e1e1e;
|
|
23
|
+
|
|
24
|
+
}
|
|
25
|
+
@media not print {
|
|
26
|
+
body[data-theme="dark"] {
|
|
27
|
+
--color-code-background: #2b2b2b;
|
|
28
|
+
--color-code-foreground: #f8f8f2;
|
|
29
|
+
|
|
30
|
+
}
|
|
31
|
+
@media (prefers-color-scheme: dark) {
|
|
32
|
+
body:not([data-theme="light"]) {
|
|
33
|
+
--color-code-background: #2b2b2b;
|
|
34
|
+
--color-code-foreground: #f8f8f2;
|
|
35
|
+
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
</style></head>
|
|
40
|
+
<body>
|
|
41
|
+
|
|
42
|
+
<script>
|
|
43
|
+
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
44
|
+
</script>
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
48
|
+
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
49
|
+
<title>Contents</title>
|
|
50
|
+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
|
51
|
+
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
|
52
|
+
</svg>
|
|
53
|
+
</symbol>
|
|
54
|
+
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
55
|
+
<title>Menu</title>
|
|
56
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
57
|
+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
|
58
|
+
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
59
|
+
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
60
|
+
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
61
|
+
</svg>
|
|
62
|
+
</symbol>
|
|
63
|
+
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
64
|
+
<title>Expand</title>
|
|
65
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
66
|
+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
|
67
|
+
<polyline points="9 18 15 12 9 6"></polyline>
|
|
68
|
+
</svg>
|
|
69
|
+
</symbol>
|
|
70
|
+
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
71
|
+
<title>Light mode</title>
|
|
72
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
73
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
|
74
|
+
<circle cx="12" cy="12" r="5"></circle>
|
|
75
|
+
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
76
|
+
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
77
|
+
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
78
|
+
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
79
|
+
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
80
|
+
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
81
|
+
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
82
|
+
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
83
|
+
</svg>
|
|
84
|
+
</symbol>
|
|
85
|
+
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
86
|
+
<title>Dark mode</title>
|
|
87
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
88
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
|
89
|
+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
90
|
+
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
|
91
|
+
</svg>
|
|
92
|
+
</symbol>
|
|
93
|
+
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
|
94
|
+
<title>Auto light/dark, in light mode</title>
|
|
95
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
96
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
|
97
|
+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
|
98
|
+
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
|
99
|
+
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
|
100
|
+
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
|
101
|
+
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
|
102
|
+
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
|
103
|
+
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
|
104
|
+
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
|
105
|
+
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
|
106
|
+
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
|
107
|
+
<circle cx="14.5" cy="9.55" r="3.6"/>
|
|
108
|
+
</svg>
|
|
109
|
+
</symbol>
|
|
110
|
+
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
|
111
|
+
<title>Auto light/dark, in dark mode</title>
|
|
112
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
113
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
|
114
|
+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
|
115
|
+
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
|
116
|
+
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
|
117
|
+
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
|
118
|
+
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
|
119
|
+
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
|
120
|
+
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
|
121
|
+
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
|
122
|
+
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
|
123
|
+
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
|
124
|
+
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
|
125
|
+
</svg>
|
|
126
|
+
</symbol>
|
|
127
|
+
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
|
128
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
129
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
|
130
|
+
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
|
131
|
+
<path d="M13.5 6.5l4 4" />
|
|
132
|
+
<path d="M20 21l2 -2l-2 -2" />
|
|
133
|
+
<path d="M17 17l-2 2l2 2" />
|
|
134
|
+
</svg>
|
|
135
|
+
</symbol>
|
|
136
|
+
<symbol id="svg-eye" viewBox="0 0 24 24">
|
|
137
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
138
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
|
139
|
+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
140
|
+
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
|
141
|
+
<path
|
|
142
|
+
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
|
143
|
+
<path d="M20 21l2 -2l-2 -2" />
|
|
144
|
+
<path d="M17 17l-2 2l2 2" />
|
|
145
|
+
</svg>
|
|
146
|
+
</symbol>
|
|
147
|
+
</svg>
|
|
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
|
+
<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>
|
|
157
|
+
|
|
158
|
+
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<div class="page">
|
|
163
|
+
<header class="mobile-header">
|
|
164
|
+
<div class="header-left">
|
|
165
|
+
<label class="nav-overlay-icon" for="__navigation">
|
|
166
|
+
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
167
|
+
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
168
|
+
</label>
|
|
169
|
+
</div>
|
|
170
|
+
<div class="header-center">
|
|
171
|
+
<a href="index.html"><div class="brand">IBM Envizi - Emissions API Node.js SDK documentation</div></a>
|
|
172
|
+
</div>
|
|
173
|
+
<div class="header-right">
|
|
174
|
+
<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>
|
|
177
|
+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
178
|
+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
179
|
+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
180
|
+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
181
|
+
</button>
|
|
182
|
+
</div>
|
|
183
|
+
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
184
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
185
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
186
|
+
</label>
|
|
187
|
+
</div>
|
|
188
|
+
</header>
|
|
189
|
+
<aside class="sidebar-drawer">
|
|
190
|
+
<div class="sidebar-container">
|
|
191
|
+
|
|
192
|
+
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
|
193
|
+
|
|
194
|
+
<span class="sidebar-brand-text">IBM Envizi - Emissions API Node.js SDK documentation</span>
|
|
195
|
+
|
|
196
|
+
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
|
197
|
+
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
|
198
|
+
<input type="hidden" name="check_keywords" value="yes">
|
|
199
|
+
<input type="hidden" name="area" value="default">
|
|
200
|
+
</form>
|
|
201
|
+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
202
|
+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
203
|
+
<ul class="current">
|
|
204
|
+
<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"><div class="visually-hidden">Toggle navigation of SDK</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
|
206
|
+
<li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
|
|
207
|
+
<li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
|
|
208
|
+
</ul>
|
|
209
|
+
</li>
|
|
210
|
+
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Reference</a></li>
|
|
211
|
+
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
|
|
212
|
+
</ul>
|
|
213
|
+
|
|
214
|
+
</div>
|
|
215
|
+
</div>
|
|
216
|
+
|
|
217
|
+
</div>
|
|
218
|
+
|
|
219
|
+
</div>
|
|
220
|
+
</aside>
|
|
221
|
+
<div class="main">
|
|
222
|
+
<div class="content">
|
|
223
|
+
<div class="article-container">
|
|
224
|
+
<a href="#" class="back-to-top muted-link">
|
|
225
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
226
|
+
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
227
|
+
</svg>
|
|
228
|
+
<span>Back to top</span>
|
|
229
|
+
</a>
|
|
230
|
+
<div class="content-icon-container">
|
|
231
|
+
<div class="view-this-page">
|
|
232
|
+
<a class="muted-link" href="_sources/reference.rst.txt" title="View this page">
|
|
233
|
+
<svg><use href="#svg-eye"></use></svg>
|
|
234
|
+
<span class="visually-hidden">View this page</span>
|
|
235
|
+
</a>
|
|
236
|
+
</div>
|
|
237
|
+
<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>
|
|
240
|
+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
241
|
+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
242
|
+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
243
|
+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
244
|
+
</button>
|
|
245
|
+
</div>
|
|
246
|
+
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
247
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
248
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
249
|
+
</label>
|
|
250
|
+
</div>
|
|
251
|
+
<article role="main" id="furo-main-content">
|
|
252
|
+
<section id="reference">
|
|
253
|
+
<h1>Reference<a class="headerlink" href="#reference" title="Link to this heading">¶</a></h1>
|
|
254
|
+
<dl class="js class">
|
|
255
|
+
<dt class="sig sig-object js" id="Client">
|
|
256
|
+
<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>
|
|
257
|
+
<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
|
+
<dl class="field-list simple">
|
|
259
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
260
|
+
<dd class="field-odd"><ul class="simple">
|
|
261
|
+
<li><p><strong>token</strong> (<span class="sphinx_js-type">string</span>)</p></li>
|
|
262
|
+
<li><p><strong>config</strong> (<span class="sphinx_js-type">ClientConfig</span>)</p></li>
|
|
263
|
+
<li><p><strong>isUserProvidedToken</strong> (<span class="sphinx_js-type">boolean</span>)</p></li>
|
|
264
|
+
</ul>
|
|
265
|
+
</dd>
|
|
266
|
+
</dl>
|
|
267
|
+
<dl class="js function">
|
|
268
|
+
<dt class="sig sig-object js" id="Client.getAuthHeader">
|
|
269
|
+
<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">getAuthHeader</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Client.getAuthHeader" title="Link to this definition">¶</a></dt>
|
|
270
|
+
<dd><p>Returns the authorization header object with the Bearer token.</p>
|
|
271
|
+
<dl class="field-list simple">
|
|
272
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
273
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Record<string, string></span> – An object containing the Authorization header with the Bearer token</p>
|
|
274
|
+
</dd>
|
|
275
|
+
</dl>
|
|
276
|
+
<div class="admonition-example admonition">
|
|
277
|
+
<p class="admonition-title">Example</p>
|
|
278
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getInstance</span><span class="p">();</span>
|
|
279
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">headers</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
280
|
+
<span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span><span class="p">,</span>
|
|
281
|
+
<span class="w"> </span><span class="p">...</span><span class="nx">client</span><span class="p">.</span><span class="nx">getAuthHeader</span><span class="p">()</span>
|
|
282
|
+
<span class="p">};</span>
|
|
283
|
+
<span class="c1">// headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer token...' }</span>
|
|
284
|
+
</pre></div>
|
|
285
|
+
</div>
|
|
286
|
+
</div>
|
|
287
|
+
</dd></dl>
|
|
288
|
+
|
|
289
|
+
<dl class="js function">
|
|
290
|
+
<dt class="sig sig-object js" id="Client.getClientId">
|
|
291
|
+
<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">getClientId</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Client.getClientId" title="Link to this definition">¶</a></dt>
|
|
292
|
+
<dd><p>Returns the client ID configured for this client instance.</p>
|
|
293
|
+
<dl class="field-list simple">
|
|
294
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
295
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">string</span> – The client ID string</p>
|
|
296
|
+
</dd>
|
|
297
|
+
</dl>
|
|
298
|
+
<div class="admonition-example admonition">
|
|
299
|
+
<p class="admonition-title">Example</p>
|
|
300
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getInstance</span><span class="p">();</span>
|
|
301
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">clientId</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">client</span><span class="p">.</span><span class="nx">getClientId</span><span class="p">();</span>
|
|
302
|
+
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">clientId</span><span class="p">);</span><span class="w"> </span><span class="c1">// e.g., 'client123'</span>
|
|
303
|
+
</pre></div>
|
|
304
|
+
</div>
|
|
305
|
+
</div>
|
|
306
|
+
</dd></dl>
|
|
307
|
+
|
|
308
|
+
<dl class="js function">
|
|
309
|
+
<dt class="sig sig-object js" id="Client.getClientSource">
|
|
310
|
+
<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">getClientSource</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Client.getClientSource" title="Link to this definition">¶</a></dt>
|
|
311
|
+
<dd><p>Returns the client source identifier for this client instance.</p>
|
|
312
|
+
<dl class="field-list simple">
|
|
313
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
314
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">string</span> – The client source string</p>
|
|
315
|
+
</dd>
|
|
316
|
+
</dl>
|
|
317
|
+
<div class="admonition-example admonition">
|
|
318
|
+
<p class="admonition-title">Example</p>
|
|
319
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getInstance</span><span class="p">();</span>
|
|
320
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">source</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">client</span><span class="p">.</span><span class="nx">getClientSource</span><span class="p">();</span>
|
|
321
|
+
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">source</span><span class="p">);</span><span class="w"> </span><span class="c1">// e.g., 'web', 'mobile', 'sdk'</span>
|
|
322
|
+
</pre></div>
|
|
323
|
+
</div>
|
|
324
|
+
</div>
|
|
325
|
+
</dd></dl>
|
|
326
|
+
|
|
327
|
+
<dl class="js function">
|
|
328
|
+
<dt class="sig sig-object js" id="Client.getDomain">
|
|
329
|
+
<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">getDomain</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Client.getDomain" title="Link to this definition">¶</a></dt>
|
|
330
|
+
<dd><p>Returns the domain URL configured for the client.</p>
|
|
331
|
+
<dl class="field-list simple">
|
|
332
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
333
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">string</span> – The domain URL string</p>
|
|
334
|
+
</dd>
|
|
335
|
+
</dl>
|
|
336
|
+
<div class="admonition-example admonition">
|
|
337
|
+
<p class="admonition-title">Example</p>
|
|
338
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getInstance</span><span class="p">();</span>
|
|
339
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">apiDomain</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">client</span><span class="p">.</span><span class="nx">getDomain</span><span class="p">();</span>
|
|
340
|
+
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">apiDomain</span><span class="p">);</span><span class="w"> </span><span class="c1">// e.g., 'https://api.example.com'</span>
|
|
341
|
+
</pre></div>
|
|
342
|
+
</div>
|
|
343
|
+
</div>
|
|
344
|
+
</dd></dl>
|
|
345
|
+
|
|
346
|
+
<dl class="js function">
|
|
347
|
+
<dt class="sig sig-object js" id="Client.refreshToken">
|
|
348
|
+
<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>
|
|
349
|
+
<dd><p>Refreshes the authentication token if it’s about to expire.
|
|
350
|
+
Only refreshes if the token was not provided by the user and is expiring within 60 seconds.</p>
|
|
351
|
+
<dl class="field-list simple">
|
|
352
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
353
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<void></span> – A promise that resolves when the token refresh is complete</p>
|
|
354
|
+
</dd>
|
|
355
|
+
</dl>
|
|
356
|
+
<div class="admonition-example admonition">
|
|
357
|
+
<p class="admonition-title">Example</p>
|
|
358
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getInstance</span><span class="p">();</span>
|
|
359
|
+
<span class="c1">// Ensure token is fresh before making API requests</span>
|
|
360
|
+
<span class="k">await</span><span class="w"> </span><span class="nx">client</span><span class="p">.</span><span class="nx">refreshToken</span><span class="p">();</span>
|
|
361
|
+
<span class="c1">// Proceed with API requests...</span>
|
|
362
|
+
</pre></div>
|
|
363
|
+
</div>
|
|
364
|
+
</div>
|
|
365
|
+
</dd></dl>
|
|
366
|
+
|
|
367
|
+
<dl class="js function">
|
|
368
|
+
<dt class="sig sig-object js" id="Client.getClient">
|
|
369
|
+
<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>
|
|
370
|
+
<dd><p>Initializes and returns a Client instance with the provided configuration.</p>
|
|
371
|
+
<dl class="field-list simple">
|
|
372
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
373
|
+
<dd class="field-odd"><ul class="simple">
|
|
374
|
+
<li><p><strong>config</strong> (<span class="sphinx_js-type">ClientConfig</span>) – The client configuration object</p></li>
|
|
375
|
+
</ul>
|
|
376
|
+
</dd>
|
|
377
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
378
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<void></span> – A promise that resolves when the client is initialized</p>
|
|
379
|
+
</dd>
|
|
380
|
+
</dl>
|
|
381
|
+
<div class="admonition-example admonition">
|
|
382
|
+
<p class="admonition-title">Example</p>
|
|
383
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Initialize with authentication URL</span>
|
|
384
|
+
<span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
|
|
385
|
+
<span class="w"> </span><span class="nx">host</span><span class="o">:</span><span class="w"> </span><span class="s1">'https://api.example.com'</span><span class="p">,</span>
|
|
386
|
+
<span class="w"> </span><span class="nx">authUrl</span><span class="o">:</span><span class="w"> </span><span class="s1">'https://auth.example.com'</span><span class="p">,</span>
|
|
387
|
+
<span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">'client123'</span><span class="p">,</span>
|
|
388
|
+
<span class="w"> </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">'org456'</span>
|
|
389
|
+
<span class="p">});</span>
|
|
390
|
+
|
|
391
|
+
<span class="c1">// Initialize with existing token</span>
|
|
392
|
+
<span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
|
|
393
|
+
<span class="w"> </span><span class="nx">token</span><span class="o">:</span><span class="w"> </span><span class="s1">'existing-jwt-token'</span><span class="p">,</span>
|
|
394
|
+
<span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">'client123'</span>
|
|
395
|
+
<span class="p">});</span>
|
|
396
|
+
|
|
397
|
+
<span class="c1">// Initialize with API key</span>
|
|
398
|
+
<span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
|
|
399
|
+
<span class="w"> </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s1">'your-api-key'</span><span class="p">,</span>
|
|
400
|
+
<span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">'client123'</span><span class="p">,</span>
|
|
401
|
+
<span class="w"> </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">'org456'</span>
|
|
402
|
+
<span class="p">});</span>
|
|
403
|
+
</pre></div>
|
|
404
|
+
</div>
|
|
405
|
+
</div>
|
|
406
|
+
</dd></dl>
|
|
407
|
+
|
|
408
|
+
<dl class="js function">
|
|
409
|
+
<dt class="sig sig-object js" id="Client.getInstance">
|
|
410
|
+
<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>
|
|
411
|
+
<dd><p>Returns the singleton instance of the Client.</p>
|
|
412
|
+
<dl class="field-list simple">
|
|
413
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
414
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Client</span> – The singleton Client instance</p>
|
|
415
|
+
</dd>
|
|
416
|
+
</dl>
|
|
417
|
+
<div class="admonition-example admonition">
|
|
418
|
+
<p class="admonition-title">Example</p>
|
|
419
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// First initialize the client</span>
|
|
420
|
+
<span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
|
|
421
|
+
<span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s1">'client123'</span><span class="p">,</span>
|
|
422
|
+
<span class="w"> </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s1">'org456'</span>
|
|
423
|
+
<span class="p">});</span>
|
|
424
|
+
|
|
425
|
+
<span class="c1">// Then get the instance</span>
|
|
426
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getInstance</span><span class="p">();</span>
|
|
427
|
+
<span class="c1">// Use the client...</span>
|
|
428
|
+
</pre></div>
|
|
429
|
+
</div>
|
|
430
|
+
</div>
|
|
431
|
+
</dd></dl>
|
|
432
|
+
|
|
433
|
+
</dd></dl>
|
|
434
|
+
|
|
435
|
+
<dl class="js function">
|
|
436
|
+
<dt class="sig sig-object js" id="request.makeApiRequest">
|
|
437
|
+
<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>
|
|
438
|
+
<dd><p>Makes an API request with standardized headers and token refresh.</p>
|
|
439
|
+
<dl class="field-list simple">
|
|
440
|
+
<dt class="field-odd">Type parameters<span class="colon">:</span></dt>
|
|
441
|
+
<dd class="field-odd"><p><strong>T</strong> – The expected response data type</p>
|
|
442
|
+
</dd>
|
|
443
|
+
<dt class="field-even">Arguments<span class="colon">:</span></dt>
|
|
444
|
+
<dd class="field-even"><ul class="simple">
|
|
445
|
+
<li><p><strong>config</strong> (<span class="sphinx_js-type">RequestConfig</span>) – The request configuration including method, URL, data, params, and optional headers</p></li>
|
|
446
|
+
</ul>
|
|
447
|
+
</dd>
|
|
448
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
449
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<T></span> – A promise that resolves to the response data of type T</p>
|
|
450
|
+
</dd>
|
|
451
|
+
</dl>
|
|
452
|
+
<div class="admonition-example admonition">
|
|
453
|
+
<p class="admonition-title">Example</p>
|
|
454
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">interface</span><span class="w"> </span><span class="nx">UserData</span><span class="w"> </span><span class="p">{</span>
|
|
455
|
+
<span class="w"> </span><span class="nx">id</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
456
|
+
<span class="w"> </span><span class="nx">name</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
457
|
+
<span class="w"> </span><span class="nx">email</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
458
|
+
<span class="p">}</span>
|
|
459
|
+
|
|
460
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">userData</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">makeApiRequest</span><span class="o"><</span><span class="nx">UserData</span><span class="o">></span><span class="p">({</span>
|
|
461
|
+
<span class="w"> </span><span class="nx">method</span><span class="o">:</span><span class="w"> </span><span class="s1">'GET'</span><span class="p">,</span>
|
|
462
|
+
<span class="w"> </span><span class="nx">url</span><span class="o">:</span><span class="w"> </span><span class="s1">'https://api.example.com/users/123'</span><span class="p">,</span>
|
|
463
|
+
<span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s1">'X-Custom-Header'</span><span class="o">:</span><span class="w"> </span><span class="s1">'value'</span><span class="w"> </span><span class="p">}</span>
|
|
464
|
+
<span class="p">});</span>
|
|
465
|
+
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">userData</span><span class="p">.</span><span class="nx">name</span><span class="p">);</span><span class="w"> </span><span class="c1">// Typed access to the response data</span>
|
|
466
|
+
</pre></div>
|
|
467
|
+
</div>
|
|
468
|
+
</div>
|
|
469
|
+
</dd></dl>
|
|
470
|
+
|
|
471
|
+
<dl class="js function">
|
|
472
|
+
<dt class="sig sig-object js" id="utils.findExpiryTime">
|
|
473
|
+
<span class="sig-prename descclassname"><span class="n"><span class="pre">utils</span></span><span class="p"><span class="pre">.</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">findExpiryTime</span></span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.findExpiryTime" title="Link to this definition">¶</a></dt>
|
|
474
|
+
<dd><p>Extracts the expiration time from a JWT token and give the token expiry time.</p>
|
|
475
|
+
<dl class="field-list simple">
|
|
476
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
477
|
+
<dd class="field-odd"><ul class="simple">
|
|
478
|
+
<li><p><strong>token</strong> (<span class="sphinx_js-type">string</span>) – The JWT token to extract the expiration time from</p></li>
|
|
479
|
+
</ul>
|
|
480
|
+
</dd>
|
|
481
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
482
|
+
<dd class="field-even"><p><span class="sphinx_js-type">any</span> – The expiration time value from the token’s payload</p>
|
|
483
|
+
</dd>
|
|
484
|
+
</dl>
|
|
485
|
+
<div class="admonition-example admonition">
|
|
486
|
+
<p class="admonition-title">Example</p>
|
|
487
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">jwtToken</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'your-token'</span><span class="p">;</span>
|
|
488
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">expiryTime</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">findExpiryTime</span><span class="p">(</span><span class="nx">jwtToken</span><span class="p">);</span>
|
|
489
|
+
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="ow">new</span><span class="w"> </span><span class="nb">Date</span><span class="p">(</span><span class="nx">expiryTime</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="mf">1000</span><span class="p">).</span><span class="nx">toISOString</span><span class="p">());</span><span class="w"> </span><span class="c1">// Convert to date if it's a Unix timestamp</span>
|
|
490
|
+
</pre></div>
|
|
491
|
+
</div>
|
|
492
|
+
</div>
|
|
493
|
+
</dd></dl>
|
|
494
|
+
|
|
495
|
+
<section id="api">
|
|
496
|
+
<h2>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h2>
|
|
497
|
+
<dl class="js function">
|
|
498
|
+
<dt class="sig sig-object js" id="Factor.retrieveFactor">
|
|
499
|
+
<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>
|
|
500
|
+
<dd><p>Retrieves a factor details by making a POST request to the factor API endpoint.</p>
|
|
501
|
+
<dl class="field-list simple">
|
|
502
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
503
|
+
<dd class="field-odd"><ul class="simple">
|
|
504
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">FactorRequest</span>) – The factor request data to be sent to the API</p></li>
|
|
505
|
+
</ul>
|
|
506
|
+
</dd>
|
|
507
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
508
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<FactorResponse></span> – A promise that resolves to the FactorResponse returned by the API</p>
|
|
509
|
+
</dd>
|
|
510
|
+
</dl>
|
|
511
|
+
<div class="admonition-example admonition">
|
|
512
|
+
<p class="admonition-title">Example</p>
|
|
513
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">factorRequest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
514
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
515
|
+
<span class="w"> </span><span class="s2">"factorId"</span><span class="o">:</span><span class="w"> </span><span class="mf">12345</span>
|
|
516
|
+
<span class="w"> </span><span class="p">}</span>
|
|
517
|
+
<span class="w"> </span><span class="p">};</span>
|
|
518
|
+
|
|
519
|
+
<span class="w"> </span><span class="nx">OR</span>
|
|
520
|
+
|
|
521
|
+
<span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">factorRequest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
522
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
523
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
524
|
+
<span class="w"> </span><span class="p">},</span>
|
|
525
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
526
|
+
<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>
|
|
527
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span>
|
|
528
|
+
<span class="w"> </span><span class="p">},</span>
|
|
529
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
530
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="s2">"natural gas"</span>
|
|
531
|
+
<span class="w"> </span><span class="p">},</span>
|
|
532
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
533
|
+
<span class="w"> </span><span class="p">};</span>
|
|
534
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">factor</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">retrieveFactor</span><span class="p">(</span><span class="nx">factorRequest</span><span class="p">);</span>
|
|
535
|
+
</pre></div>
|
|
536
|
+
</div>
|
|
537
|
+
</div>
|
|
538
|
+
</dd></dl>
|
|
539
|
+
|
|
540
|
+
<dl class="js function">
|
|
541
|
+
<dt class="sig sig-object js" id="Fugitive.calculate">
|
|
542
|
+
<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>
|
|
543
|
+
<dd><p>Performs scope 1 fugitve emission calculations by making a POST request to the fugitive API endpoint.</p>
|
|
544
|
+
<dl class="field-list simple">
|
|
545
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
546
|
+
<dd class="field-odd"><ul class="simple">
|
|
547
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the API</p></li>
|
|
548
|
+
</ul>
|
|
549
|
+
</dd>
|
|
550
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
551
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
552
|
+
</dd>
|
|
553
|
+
</dl>
|
|
554
|
+
<div class="admonition-example admonition">
|
|
555
|
+
<p class="admonition-title">Example</p>
|
|
556
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><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>
|
|
557
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
558
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
559
|
+
<span class="w"> </span><span class="p">},</span>
|
|
560
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
561
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
562
|
+
<span class="w"> </span><span class="p">},</span>
|
|
563
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
564
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"R134A"</span><span class="p">,</span>
|
|
565
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">150</span><span class="p">,</span>
|
|
566
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kg"</span>
|
|
567
|
+
<span class="w"> </span><span class="p">},</span>
|
|
568
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
569
|
+
<span class="w"> </span><span class="p">};</span>
|
|
570
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
|
|
571
|
+
</pre></div>
|
|
572
|
+
</div>
|
|
573
|
+
</div>
|
|
574
|
+
</dd></dl>
|
|
575
|
+
|
|
576
|
+
<dl class="js function">
|
|
577
|
+
<dt class="sig sig-object js" id="Calculation.calculate">
|
|
578
|
+
<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>
|
|
579
|
+
<dd><p>Performs emission calculations by making a POST request to the generic calculation API endpoint.</p>
|
|
580
|
+
<dl class="field-list simple">
|
|
581
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
582
|
+
<dd class="field-odd"><ul class="simple">
|
|
583
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">CalculationRequest</span>) – The calculation request data to be sent to the API</p></li>
|
|
584
|
+
</ul>
|
|
585
|
+
</dd>
|
|
586
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
587
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
588
|
+
</dd>
|
|
589
|
+
</dl>
|
|
590
|
+
<div class="admonition-example admonition">
|
|
591
|
+
<p class="admonition-title">Example</p>
|
|
592
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">calculationRequest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
593
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
594
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
595
|
+
<span class="w"> </span><span class="p">},</span>
|
|
596
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
597
|
+
<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>
|
|
598
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span>
|
|
599
|
+
<span class="w"> </span><span class="p">},</span>
|
|
600
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
601
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="s2">"Waste Combusted - Steel Cans:Default factor"</span><span class="p">,</span>
|
|
602
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kg"</span><span class="p">,</span>
|
|
603
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">1223123.121</span>
|
|
604
|
+
<span class="w"> </span><span class="p">},</span>
|
|
605
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
606
|
+
<span class="w"> </span><span class="p">};</span>
|
|
607
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">calculationRequest</span><span class="p">);</span>
|
|
608
|
+
</pre></div>
|
|
609
|
+
</div>
|
|
610
|
+
</div>
|
|
611
|
+
</dd></dl>
|
|
612
|
+
|
|
613
|
+
<dl class="js function">
|
|
614
|
+
<dt class="sig sig-object js" id="Location.calculate">
|
|
615
|
+
<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>
|
|
616
|
+
<dd><p>Performs scope 2 purchased energy Emission calculations by making a POST request to the location API endpoint.</p>
|
|
617
|
+
<dl class="field-list simple">
|
|
618
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
619
|
+
<dd class="field-odd"><ul class="simple">
|
|
620
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">LocationRequest</span>) – The location request data to be sent to the API</p></li>
|
|
621
|
+
</ul>
|
|
622
|
+
</dd>
|
|
623
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
624
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
625
|
+
</dd>
|
|
626
|
+
</dl>
|
|
627
|
+
<div class="admonition-example admonition">
|
|
628
|
+
<p class="admonition-title">Example</p>
|
|
629
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">calculationRequest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
630
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
631
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
632
|
+
<span class="w"> </span><span class="p">},</span>
|
|
633
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
634
|
+
<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>
|
|
635
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span>
|
|
636
|
+
<span class="w"> </span><span class="p">},</span>
|
|
637
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
638
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="s2">"electricity"</span><span class="p">,</span>
|
|
639
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"kwh"</span><span class="p">,</span>
|
|
640
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">14123143</span>
|
|
641
|
+
<span class="w"> </span><span class="p">},</span>
|
|
642
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
643
|
+
<span class="w"> </span><span class="p">};</span>
|
|
644
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">calculationRequest</span><span class="p">);</span>
|
|
645
|
+
</pre></div>
|
|
646
|
+
</div>
|
|
647
|
+
</div>
|
|
648
|
+
</dd></dl>
|
|
649
|
+
|
|
650
|
+
<dl class="js function">
|
|
651
|
+
<dt class="sig sig-object js" id="Mobile.calculate">
|
|
652
|
+
<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>
|
|
653
|
+
<dd><p>Performs Scope 1 mobile emissions related calculations by making a POST request to the mobile API endpoint.</p>
|
|
654
|
+
<dl class="field-list simple">
|
|
655
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
656
|
+
<dd class="field-odd"><ul class="simple">
|
|
657
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the mobile API</p></li>
|
|
658
|
+
</ul>
|
|
659
|
+
</dd>
|
|
660
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
661
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
662
|
+
</dd>
|
|
663
|
+
</dl>
|
|
664
|
+
<div class="admonition-example admonition">
|
|
665
|
+
<p class="admonition-title">Example</p>
|
|
666
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><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>
|
|
667
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
668
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-01-01"</span>
|
|
669
|
+
<span class="w"> </span><span class="p">},</span>
|
|
670
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
671
|
+
<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>
|
|
672
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span>
|
|
673
|
+
<span class="w"> </span><span class="p">},</span>
|
|
674
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
675
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Diesel Fuel"</span><span class="p">,</span>
|
|
676
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">1500000</span><span class="p">,</span>
|
|
677
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"l"</span>
|
|
678
|
+
<span class="w"> </span><span class="p">},</span>
|
|
679
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
|
|
680
|
+
<span class="w"> </span><span class="p">};</span>
|
|
681
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
|
|
682
|
+
</pre></div>
|
|
683
|
+
</div>
|
|
684
|
+
</div>
|
|
685
|
+
</dd></dl>
|
|
686
|
+
|
|
687
|
+
<dl class="js function">
|
|
688
|
+
<dt class="sig sig-object js" id="Stationary.calculate">
|
|
689
|
+
<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>
|
|
690
|
+
<dd><p>Performs Scope 1 stationary calculations by making a POST request to the stationary API endpoint.</p>
|
|
691
|
+
<dl class="field-list simple">
|
|
692
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
693
|
+
<dd class="field-odd"><ul class="simple">
|
|
694
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">CommonRequest</span>) – The request data to be sent to the stationary API</p></li>
|
|
695
|
+
</ul>
|
|
696
|
+
</dd>
|
|
697
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
698
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
699
|
+
</dd>
|
|
700
|
+
</dl>
|
|
701
|
+
<div class="admonition-example admonition">
|
|
702
|
+
<p class="admonition-title">Example</p>
|
|
703
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><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>
|
|
704
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
705
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
706
|
+
<span class="w"> </span><span class="p">},</span>
|
|
707
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
708
|
+
<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>
|
|
709
|
+
<span class="w"> </span><span class="s2">"stateProvince"</span><span class="o">:</span><span class="w"> </span><span class="s2">"new york"</span>
|
|
710
|
+
<span class="w"> </span><span class="p">},</span>
|
|
711
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
712
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="s2">"Coal - Lignite"</span><span class="p">,</span>
|
|
713
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="s2">"KJ"</span><span class="p">,</span>
|
|
714
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">3</span>
|
|
715
|
+
<span class="w"> </span><span class="p">},</span>
|
|
716
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
717
|
+
<span class="w"> </span><span class="p">};</span>
|
|
718
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
|
|
719
|
+
</pre></div>
|
|
720
|
+
</div>
|
|
721
|
+
</div>
|
|
722
|
+
</dd></dl>
|
|
723
|
+
|
|
724
|
+
<dl class="js function">
|
|
725
|
+
<dt class="sig sig-object js" id="TransportationAndDistribution.calculate">
|
|
726
|
+
<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>
|
|
727
|
+
<dd><p>Performs Scope 3 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.</p>
|
|
728
|
+
<dl class="field-list simple">
|
|
729
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
730
|
+
<dd class="field-odd"><ul class="simple">
|
|
731
|
+
<li><p><strong>payload</strong> (<span class="sphinx_js-type">CalculationRequest</span>) – The calculation request data for transportation and distribution operations</p></li>
|
|
732
|
+
</ul>
|
|
733
|
+
</dd>
|
|
734
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
735
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<EmissionResponse | EmissionResponseWithDetails></span> – A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse</p>
|
|
736
|
+
</dd>
|
|
737
|
+
</dl>
|
|
738
|
+
<div class="admonition-example admonition">
|
|
739
|
+
<p class="admonition-title">Example</p>
|
|
740
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><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>
|
|
741
|
+
<span class="w"> </span><span class="s2">"time"</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
742
|
+
<span class="w"> </span><span class="s2">"date"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2025-01-04"</span>
|
|
743
|
+
<span class="w"> </span><span class="p">},</span>
|
|
744
|
+
<span class="w"> </span><span class="s2">"location"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
745
|
+
<span class="w"> </span><span class="s2">"country"</span><span class="o">:</span><span class="w"> </span><span class="s2">"usa"</span>
|
|
746
|
+
<span class="w"> </span><span class="p">},</span>
|
|
747
|
+
<span class="w"> </span><span class="s2">"activity"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
748
|
+
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Freight - Cargo Ship - Bulk Carrier - 0-9999 dwt"</span><span class="p">,</span>
|
|
749
|
+
<span class="w"> </span><span class="s2">"unit"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"t"</span><span class="p">,</span><span class="s2">"km"</span><span class="p">],</span>
|
|
750
|
+
<span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="mf">1.0</span><span class="p">,</span><span class="mf">1.0</span><span class="p">]</span>
|
|
751
|
+
<span class="w"> </span><span class="p">},</span>
|
|
752
|
+
<span class="w"> </span><span class="s2">"includeDetails"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
|
|
753
|
+
<span class="w"> </span><span class="p">};</span>
|
|
754
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">calculate</span><span class="p">(</span><span class="nx">request</span><span class="p">);</span>
|
|
755
|
+
</pre></div>
|
|
756
|
+
</div>
|
|
757
|
+
</div>
|
|
758
|
+
</dd></dl>
|
|
759
|
+
|
|
760
|
+
</section>
|
|
761
|
+
<section id="metadata-apis">
|
|
762
|
+
<h2>Metadata APIs<a class="headerlink" href="#metadata-apis" title="Link to this heading">¶</a></h2>
|
|
763
|
+
<section id="gettypes">
|
|
764
|
+
<h3>getTypes<a class="headerlink" href="#gettypes" title="Link to this heading">¶</a></h3>
|
|
765
|
+
<dl class="js function">
|
|
766
|
+
<dt class="sig sig-object js" id="Factor.getTypes">
|
|
767
|
+
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Factor.getTypes" title="Link to this definition">¶</a></dt>
|
|
768
|
+
<dd><p>Retrieves available emission factor types by making a GET request to the API endpoint.</p>
|
|
769
|
+
<dl class="field-list simple">
|
|
770
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
771
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available emission factor types</p>
|
|
772
|
+
</dd>
|
|
773
|
+
</dl>
|
|
774
|
+
<div class="admonition-example admonition">
|
|
775
|
+
<p class="admonition-title">Example</p>
|
|
776
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</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">getTypes</span><span class="p">();</span>
|
|
777
|
+
</pre></div>
|
|
778
|
+
</div>
|
|
779
|
+
</div>
|
|
780
|
+
</dd></dl>
|
|
781
|
+
|
|
782
|
+
<dl class="js function">
|
|
783
|
+
<dt class="sig sig-object js" id="Calculation.getTypes">
|
|
784
|
+
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Calculation.getTypes" title="Link to this definition">¶</a></dt>
|
|
785
|
+
<dd><p>Retrieves available calculation types by making a GET request to the calculation types API endpoint.</p>
|
|
786
|
+
<dl class="field-list simple">
|
|
787
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
788
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available calculation types</p>
|
|
789
|
+
</dd>
|
|
790
|
+
</dl>
|
|
791
|
+
<div class="admonition-example admonition">
|
|
792
|
+
<p class="admonition-title">Example</p>
|
|
793
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</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">getTypes</span><span class="p">();</span>
|
|
794
|
+
</pre></div>
|
|
795
|
+
</div>
|
|
796
|
+
</div>
|
|
797
|
+
</dd></dl>
|
|
798
|
+
|
|
799
|
+
<dl class="js function">
|
|
800
|
+
<dt class="sig sig-object js" id="Location.getTypes">
|
|
801
|
+
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Location.getTypes" title="Link to this definition">¶</a></dt>
|
|
802
|
+
<dd><p>Retrieves available location-based calculation types by making a GET request to the location types API endpoint.</p>
|
|
803
|
+
<dl class="field-list simple">
|
|
804
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
805
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available location-based calculation types</p>
|
|
806
|
+
</dd>
|
|
807
|
+
</dl>
|
|
808
|
+
<div class="admonition-example admonition">
|
|
809
|
+
<p class="admonition-title">Example</p>
|
|
810
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</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">getTypes</span><span class="p">();</span>
|
|
811
|
+
</pre></div>
|
|
812
|
+
</div>
|
|
813
|
+
</div>
|
|
814
|
+
</dd></dl>
|
|
815
|
+
|
|
816
|
+
<dl class="js function">
|
|
817
|
+
<dt class="sig sig-object js" id="Mobile.getTypes">
|
|
818
|
+
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Mobile.getTypes" title="Link to this definition">¶</a></dt>
|
|
819
|
+
<dd><p>Retrieves available mobile emission calculation types by making a GET request to the API endpoint.</p>
|
|
820
|
+
<dl class="field-list simple">
|
|
821
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
822
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available mobile emission types</p>
|
|
823
|
+
</dd>
|
|
824
|
+
</dl>
|
|
825
|
+
<div class="admonition-example admonition">
|
|
826
|
+
<p class="admonition-title">Example</p>
|
|
827
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get all available mobile emission types</span>
|
|
828
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">types</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">getTypes</span><span class="p">();</span>
|
|
829
|
+
</pre></div>
|
|
830
|
+
</div>
|
|
831
|
+
</div>
|
|
832
|
+
</dd></dl>
|
|
833
|
+
|
|
834
|
+
<dl class="js function">
|
|
835
|
+
<dt class="sig sig-object js" id="Stationary.getTypes">
|
|
836
|
+
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Stationary.getTypes" title="Link to this definition">¶</a></dt>
|
|
837
|
+
<dd><p>Retrieves available stationary emission calculation types by making a GET request to the API endpoint.</p>
|
|
838
|
+
<dl class="field-list simple">
|
|
839
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
840
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available stationary emission types</p>
|
|
841
|
+
</dd>
|
|
842
|
+
</dl>
|
|
843
|
+
<div class="admonition-example admonition">
|
|
844
|
+
<p class="admonition-title">Example</p>
|
|
845
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</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">getTypes</span><span class="p">();</span>
|
|
846
|
+
</pre></div>
|
|
847
|
+
</div>
|
|
848
|
+
</div>
|
|
849
|
+
</dd></dl>
|
|
850
|
+
|
|
851
|
+
<dl class="js function">
|
|
852
|
+
<dt class="sig sig-object js" id="TransportationAndDistribution.getTypes">
|
|
853
|
+
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#TransportationAndDistribution.getTypes" title="Link to this definition">¶</a></dt>
|
|
854
|
+
<dd><p>Retrieves available transportation and distribution calculation types by making a GET request to the API endpoint.</p>
|
|
855
|
+
<dl class="field-list simple">
|
|
856
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
857
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available transportation and distribution calculation types</p>
|
|
858
|
+
</dd>
|
|
859
|
+
</dl>
|
|
860
|
+
<div class="admonition-example admonition">
|
|
861
|
+
<p class="admonition-title">Example</p>
|
|
862
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</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">getTypes</span><span class="p">();</span>
|
|
863
|
+
</pre></div>
|
|
864
|
+
</div>
|
|
865
|
+
</div>
|
|
866
|
+
</dd></dl>
|
|
867
|
+
|
|
868
|
+
<dl class="js function">
|
|
869
|
+
<dt class="sig sig-object js" id="Fugitive.getTypes">
|
|
870
|
+
<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">getTypes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Fugitive.getTypes" title="Link to this definition">¶</a></dt>
|
|
871
|
+
<dd><p>Retrieves available fugitive emission calculation types by making a GET request to the API endpoint.</p>
|
|
872
|
+
<dl class="field-list simple">
|
|
873
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
874
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<TypeResponse></span> – A promise that resolves to a TypeResponse containing the available fugitive emission types</p>
|
|
875
|
+
</dd>
|
|
876
|
+
</dl>
|
|
877
|
+
<div class="admonition-example admonition">
|
|
878
|
+
<p class="admonition-title">Example</p>
|
|
879
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">types</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">getTypes</span><span class="p">();</span>
|
|
880
|
+
</pre></div>
|
|
881
|
+
</div>
|
|
882
|
+
</div>
|
|
883
|
+
</dd></dl>
|
|
884
|
+
|
|
885
|
+
</section>
|
|
886
|
+
<section id="getarea">
|
|
887
|
+
<h3>getArea<a class="headerlink" href="#getarea" title="Link to this heading">¶</a></h3>
|
|
888
|
+
<dl class="js function">
|
|
889
|
+
<dt class="sig sig-object js" id="Factor.getArea">
|
|
890
|
+
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Factor.getArea" title="Link to this definition">¶</a></dt>
|
|
891
|
+
<dd><p>Retrieves information about geographical areas supported by the factor API.</p>
|
|
892
|
+
<dl class="field-list simple">
|
|
893
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
894
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
895
|
+
</dd>
|
|
896
|
+
</dl>
|
|
897
|
+
<div class="admonition-example admonition">
|
|
898
|
+
<p class="admonition-title">Example</p>
|
|
899
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getArea</span><span class="p">();</span>
|
|
900
|
+
</pre></div>
|
|
901
|
+
</div>
|
|
902
|
+
</div>
|
|
903
|
+
</dd></dl>
|
|
904
|
+
|
|
905
|
+
<dl class="js function">
|
|
906
|
+
<dt class="sig sig-object js" id="Factor.getSearchArea">
|
|
907
|
+
<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">getSearchArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Factor.getSearchArea" title="Link to this definition">¶</a></dt>
|
|
908
|
+
<dd><p>Retrieves information about geographical areas supported by the factor search API.</p>
|
|
909
|
+
<dl class="field-list simple">
|
|
910
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
911
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
912
|
+
</dd>
|
|
913
|
+
</dl>
|
|
914
|
+
<div class="admonition-example admonition">
|
|
915
|
+
<p class="admonition-title">Example</p>
|
|
916
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getSearchArea</span><span class="p">();</span>
|
|
917
|
+
</pre></div>
|
|
918
|
+
</div>
|
|
919
|
+
</div>
|
|
920
|
+
</dd></dl>
|
|
921
|
+
|
|
922
|
+
<dl class="js function">
|
|
923
|
+
<dt class="sig sig-object js" id="Calculation.getArea">
|
|
924
|
+
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Calculation.getArea" title="Link to this definition">¶</a></dt>
|
|
925
|
+
<dd><p>Retrieves information about geographical areas supported by the calculation API.</p>
|
|
926
|
+
<dl class="field-list simple">
|
|
927
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
928
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
929
|
+
</dd>
|
|
930
|
+
</dl>
|
|
931
|
+
<div class="admonition-example admonition">
|
|
932
|
+
<p class="admonition-title">Example</p>
|
|
933
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getArea</span><span class="p">();</span>
|
|
934
|
+
</pre></div>
|
|
935
|
+
</div>
|
|
936
|
+
</div>
|
|
937
|
+
</dd></dl>
|
|
938
|
+
|
|
939
|
+
<dl class="js function">
|
|
940
|
+
<dt class="sig sig-object js" id="Location.getArea">
|
|
941
|
+
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Location.getArea" title="Link to this definition">¶</a></dt>
|
|
942
|
+
<dd><p>Retrieves information about geographical areas supported by the location-based calculation API.</p>
|
|
943
|
+
<dl class="field-list simple">
|
|
944
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
945
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
946
|
+
</dd>
|
|
947
|
+
</dl>
|
|
948
|
+
<div class="admonition-example admonition">
|
|
949
|
+
<p class="admonition-title">Example</p>
|
|
950
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getArea</span><span class="p">();</span>
|
|
951
|
+
</pre></div>
|
|
952
|
+
</div>
|
|
953
|
+
</div>
|
|
954
|
+
</dd></dl>
|
|
955
|
+
|
|
956
|
+
<dl class="js function">
|
|
957
|
+
<dt class="sig sig-object js" id="Mobile.getArea">
|
|
958
|
+
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Mobile.getArea" title="Link to this definition">¶</a></dt>
|
|
959
|
+
<dd><p>Retrieves information about geographical areas supported by the mobile emissions API.</p>
|
|
960
|
+
<dl class="field-list simple">
|
|
961
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
962
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
963
|
+
</dd>
|
|
964
|
+
</dl>
|
|
965
|
+
<div class="admonition-example admonition">
|
|
966
|
+
<p class="admonition-title">Example</p>
|
|
967
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getArea</span><span class="p">();</span>
|
|
968
|
+
</pre></div>
|
|
969
|
+
</div>
|
|
970
|
+
</div>
|
|
971
|
+
</dd></dl>
|
|
972
|
+
|
|
973
|
+
<dl class="js function">
|
|
974
|
+
<dt class="sig sig-object js" id="Stationary.getArea">
|
|
975
|
+
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Stationary.getArea" title="Link to this definition">¶</a></dt>
|
|
976
|
+
<dd><p>Retrieves information about geographical areas supported by the stationary emissions API.</p>
|
|
977
|
+
<dl class="field-list simple">
|
|
978
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
979
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
980
|
+
</dd>
|
|
981
|
+
</dl>
|
|
982
|
+
<div class="admonition-example admonition">
|
|
983
|
+
<p class="admonition-title">Example</p>
|
|
984
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getArea</span><span class="p">();</span>
|
|
985
|
+
</pre></div>
|
|
986
|
+
</div>
|
|
987
|
+
</div>
|
|
988
|
+
</dd></dl>
|
|
989
|
+
|
|
990
|
+
<dl class="js function">
|
|
991
|
+
<dt class="sig sig-object js" id="TransportationAndDistribution.getArea">
|
|
992
|
+
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#TransportationAndDistribution.getArea" title="Link to this definition">¶</a></dt>
|
|
993
|
+
<dd><p>Retrieves information about geographical areas supported by the transportation and distribution API.</p>
|
|
994
|
+
<dl class="field-list simple">
|
|
995
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
996
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
997
|
+
</dd>
|
|
998
|
+
</dl>
|
|
999
|
+
<div class="admonition-example admonition">
|
|
1000
|
+
<p class="admonition-title">Example</p>
|
|
1001
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getArea</span><span class="p">();</span>
|
|
1002
|
+
</pre></div>
|
|
1003
|
+
</div>
|
|
1004
|
+
</div>
|
|
1005
|
+
</dd></dl>
|
|
1006
|
+
|
|
1007
|
+
<dl class="js function">
|
|
1008
|
+
<dt class="sig sig-object js" id="Fugitive.getArea">
|
|
1009
|
+
<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">getArea</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Fugitive.getArea" title="Link to this definition">¶</a></dt>
|
|
1010
|
+
<dd><p>Retrieves information about geographical areas supported by the fugitive emissions API.</p>
|
|
1011
|
+
<dl class="field-list simple">
|
|
1012
|
+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
1013
|
+
<dd class="field-odd"><p><span class="sphinx_js-type">Promise<AreaResponse></span> – A promise that resolves to an AreaResponse containing the supported geographical areas</p>
|
|
1014
|
+
</dd>
|
|
1015
|
+
</dl>
|
|
1016
|
+
<div class="admonition-example admonition">
|
|
1017
|
+
<p class="admonition-title">Example</p>
|
|
1018
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">areas</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">getArea</span><span class="p">();</span>
|
|
1019
|
+
</pre></div>
|
|
1020
|
+
</div>
|
|
1021
|
+
</div>
|
|
1022
|
+
</dd></dl>
|
|
1023
|
+
|
|
1024
|
+
</section>
|
|
1025
|
+
<section id="getunits">
|
|
1026
|
+
<h3>getUnits<a class="headerlink" href="#getunits" title="Link to this heading">¶</a></h3>
|
|
1027
|
+
<dl class="js function">
|
|
1028
|
+
<dt class="sig sig-object js" id="Factor.getUnits">
|
|
1029
|
+
<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">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="#Factor.getUnits" title="Link to this definition">¶</a></dt>
|
|
1030
|
+
<dd><p>Retrieves available units for a specific emission factor type.</p>
|
|
1031
|
+
<dl class="field-list simple">
|
|
1032
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1033
|
+
<dd class="field-odd"><ul class="simple">
|
|
1034
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The emission factor type to get units for (e.g., “Natural Gas - Scope 3:AAA”)</p></li>
|
|
1035
|
+
</ul>
|
|
1036
|
+
</dd>
|
|
1037
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1038
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1039
|
+
</dd>
|
|
1040
|
+
</dl>
|
|
1041
|
+
<div class="admonition-example admonition">
|
|
1042
|
+
<p class="admonition-title">Example</p>
|
|
1043
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "Natural Gas - Scope 3:AAA" emission factor type with subtype</span>
|
|
1044
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Natural Gas - Scope 3:AAA"</span><span class="p">);</span>
|
|
1045
|
+
|
|
1046
|
+
<span class="c1">// Get units for the "HFC-263fb" emission factor type without subtype</span>
|
|
1047
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"HFC-263fb"</span><span class="p">);</span>
|
|
1048
|
+
</pre></div>
|
|
1049
|
+
</div>
|
|
1050
|
+
</div>
|
|
1051
|
+
</dd></dl>
|
|
1052
|
+
|
|
1053
|
+
<dl class="js function">
|
|
1054
|
+
<dt class="sig sig-object js" id="Calculation.getUnits">
|
|
1055
|
+
<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">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="#Calculation.getUnits" title="Link to this definition">¶</a></dt>
|
|
1056
|
+
<dd><p>Retrieves available units for a specific calculation type.</p>
|
|
1057
|
+
<dl class="field-list simple">
|
|
1058
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1059
|
+
<dd class="field-odd"><ul class="simple">
|
|
1060
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The calculation type to get units for</p></li>
|
|
1061
|
+
</ul>
|
|
1062
|
+
</dd>
|
|
1063
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1064
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1065
|
+
</dd>
|
|
1066
|
+
</dl>
|
|
1067
|
+
<div class="admonition-example admonition">
|
|
1068
|
+
<p class="admonition-title">Example</p>
|
|
1069
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "Natural Gas - Scope 3:AAA" emission calculation type with subtype</span>
|
|
1070
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Natural Gas - Scope 3:AAA"</span><span class="p">);</span>
|
|
1071
|
+
|
|
1072
|
+
<span class="c1">// Get units for the "HFC-263fb" emission calculation type without subtype</span>
|
|
1073
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"HFC-263fb"</span><span class="p">);</span>
|
|
1074
|
+
</pre></div>
|
|
1075
|
+
</div>
|
|
1076
|
+
</div>
|
|
1077
|
+
</dd></dl>
|
|
1078
|
+
|
|
1079
|
+
<dl class="js function">
|
|
1080
|
+
<dt class="sig sig-object js" id="Location.getUnits">
|
|
1081
|
+
<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">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="#Location.getUnits" title="Link to this definition">¶</a></dt>
|
|
1082
|
+
<dd><p>Retrieves available units for a specific location-based calculation type.</p>
|
|
1083
|
+
<dl class="field-list simple">
|
|
1084
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1085
|
+
<dd class="field-odd"><ul class="simple">
|
|
1086
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The location-based calculation type to get units for (e.g., “electricity”)</p></li>
|
|
1087
|
+
</ul>
|
|
1088
|
+
</dd>
|
|
1089
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1090
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1091
|
+
</dd>
|
|
1092
|
+
</dl>
|
|
1093
|
+
<div class="admonition-example admonition">
|
|
1094
|
+
<p class="admonition-title">Example</p>
|
|
1095
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "electricity" location type</span>
|
|
1096
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"electricity"</span><span class="p">);</span>
|
|
1097
|
+
</pre></div>
|
|
1098
|
+
</div>
|
|
1099
|
+
</div>
|
|
1100
|
+
</dd></dl>
|
|
1101
|
+
|
|
1102
|
+
<dl class="js function">
|
|
1103
|
+
<dt class="sig sig-object js" id="Mobile.getUnits">
|
|
1104
|
+
<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">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="#Mobile.getUnits" title="Link to this definition">¶</a></dt>
|
|
1105
|
+
<dd><p>Retrieves available units for a specific mobile emission type.</p>
|
|
1106
|
+
<dl class="field-list simple">
|
|
1107
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1108
|
+
<dd class="field-odd"><ul class="simple">
|
|
1109
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The mobile emission type to get units for (e.g., “Diesel Fuel”)</p></li>
|
|
1110
|
+
</ul>
|
|
1111
|
+
</dd>
|
|
1112
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1113
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1114
|
+
</dd>
|
|
1115
|
+
</dl>
|
|
1116
|
+
<div class="admonition-example admonition">
|
|
1117
|
+
<p class="admonition-title">Example</p>
|
|
1118
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">"Cars:B20:(NE)"</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">mobile</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="kd">with</span><span class="w"> </span><span class="nx">subtype</span>
|
|
1119
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Cars:B20:(NE)"</span><span class="p">);</span>
|
|
1120
|
+
|
|
1121
|
+
<span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">"Cars by Size - Large Car - Hybrid"</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">mobile</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="nx">without</span><span class="w"> </span><span class="nx">subtype</span>
|
|
1122
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Cars by Size - Large Car - Hybrid"</span><span class="p">);</span>
|
|
1123
|
+
</pre></div>
|
|
1124
|
+
</div>
|
|
1125
|
+
</div>
|
|
1126
|
+
</dd></dl>
|
|
1127
|
+
|
|
1128
|
+
<dl class="js function">
|
|
1129
|
+
<dt class="sig sig-object js" id="Stationary.getUnits">
|
|
1130
|
+
<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">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="#Stationary.getUnits" title="Link to this definition">¶</a></dt>
|
|
1131
|
+
<dd><p>Retrieves available units for a specific stationary emission type.</p>
|
|
1132
|
+
<dl class="field-list simple">
|
|
1133
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1134
|
+
<dd class="field-odd"><ul class="simple">
|
|
1135
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The stationary emission type to get units for (e.g., “Coal - Lignite”)</p></li>
|
|
1136
|
+
</ul>
|
|
1137
|
+
</dd>
|
|
1138
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1139
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1140
|
+
</dd>
|
|
1141
|
+
</dl>
|
|
1142
|
+
<div class="admonition-example admonition">
|
|
1143
|
+
<p class="admonition-title">Example</p>
|
|
1144
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">"Petroleum Based Greases - NC:A"</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">stationary</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="kd">with</span><span class="w"> </span><span class="nx">subtype</span>
|
|
1145
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Petroleum Based Greases - NC:A"</span><span class="p">);</span>
|
|
1146
|
+
|
|
1147
|
+
<span class="nx">Get</span><span class="w"> </span><span class="nx">units</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="nx">the</span><span class="w"> </span><span class="s2">"Jet Kerosene"</span><span class="w"> </span><span class="nx">emission</span><span class="w"> </span><span class="nx">stationary</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="nx">without</span><span class="w"> </span><span class="nx">subtype</span>
|
|
1148
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Jet Kerosene"</span><span class="p">);</span>
|
|
1149
|
+
</pre></div>
|
|
1150
|
+
</div>
|
|
1151
|
+
</div>
|
|
1152
|
+
</dd></dl>
|
|
1153
|
+
|
|
1154
|
+
<dl class="js function">
|
|
1155
|
+
<dt class="sig sig-object js" id="TransportationAndDistribution.getUnits">
|
|
1156
|
+
<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">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="#TransportationAndDistribution.getUnits" title="Link to this definition">¶</a></dt>
|
|
1157
|
+
<dd><p>Retrieves available units for a specific transportation and distribution calculation type.</p>
|
|
1158
|
+
<dl class="field-list simple">
|
|
1159
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1160
|
+
<dd class="field-odd"><ul class="simple">
|
|
1161
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The transportation and distribution calculation type to get units for (e.g., “Freight - Cargo Ship”)</p></li>
|
|
1162
|
+
</ul>
|
|
1163
|
+
</dd>
|
|
1164
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1165
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1166
|
+
</dd>
|
|
1167
|
+
</dl>
|
|
1168
|
+
<div class="admonition-example admonition">
|
|
1169
|
+
<p class="admonition-title">Example</p>
|
|
1170
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "Business Travel - Cars:Diesel - Small" transportation and distribution type without subtype</span>
|
|
1171
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Business Travel - Cars:Diesel - Small"</span><span class="p">);</span>
|
|
1172
|
+
|
|
1173
|
+
<span class="c1">// Get units for the "Business Travel - Cars" transportation and distribution type with subtype</span>
|
|
1174
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Business Travel - Cars"</span><span class="p">);</span>
|
|
1175
|
+
</pre></div>
|
|
1176
|
+
</div>
|
|
1177
|
+
</div>
|
|
1178
|
+
</dd></dl>
|
|
1179
|
+
|
|
1180
|
+
<dl class="js function">
|
|
1181
|
+
<dt class="sig sig-object js" id="Fugitive.getUnits">
|
|
1182
|
+
<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">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="#Fugitive.getUnits" title="Link to this definition">¶</a></dt>
|
|
1183
|
+
<dd><p>Retrieves available units for a specific fugitive emission type.</p>
|
|
1184
|
+
<dl class="field-list simple">
|
|
1185
|
+
<dt class="field-odd">Arguments<span class="colon">:</span></dt>
|
|
1186
|
+
<dd class="field-odd"><ul class="simple">
|
|
1187
|
+
<li><p><strong>type</strong> (<span class="sphinx_js-type">string</span>) – The fugitive emission type to get units for (e.g., “R134A”)</p></li>
|
|
1188
|
+
</ul>
|
|
1189
|
+
</dd>
|
|
1190
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1191
|
+
<dd class="field-even"><p><span class="sphinx_js-type">Promise<UnitResponse></span> – A promise that resolves to a UnitResponse containing the available units</p>
|
|
1192
|
+
</dd>
|
|
1193
|
+
</dl>
|
|
1194
|
+
<div class="admonition-example admonition">
|
|
1195
|
+
<p class="admonition-title">Example</p>
|
|
1196
|
+
<div class="highlight-ts notranslate"><div class="highlight"><pre><span></span><span class="c1">// Get units for the "Natural Gas - Scope 3:AAA" emission fugitive type with subtype</span>
|
|
1197
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"Natural Gas - Scope 3:AAA"</span><span class="p">);</span>
|
|
1198
|
+
|
|
1199
|
+
<span class="c1">// Get units for the "R-426A" emission fugitive type without subtype</span>
|
|
1200
|
+
<span class="kd">const</span><span class="w"> </span><span class="nx">units</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">getUnits</span><span class="p">(</span><span class="s2">"R-426A"</span><span class="p">);</span>
|
|
1201
|
+
</pre></div>
|
|
1202
|
+
</div>
|
|
1203
|
+
</div>
|
|
1204
|
+
</dd></dl>
|
|
1205
|
+
|
|
1206
|
+
</section>
|
|
1207
|
+
</section>
|
|
1208
|
+
<section id="interfaces">
|
|
1209
|
+
<h2>Interfaces<a class="headerlink" href="#interfaces" title="Link to this heading">¶</a></h2>
|
|
1210
|
+
<dl class="js interface">
|
|
1211
|
+
<dt class="sig sig-object js" id="Api.LocationRequestWithoutFactorId">
|
|
1212
|
+
<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>
|
|
1213
|
+
<dd><p>Request parameters for location-based calculations without specifying a factor ID.
|
|
1214
|
+
Used for calculating emissions or other metrics based on location data.</p>
|
|
1215
|
+
<blockquote>
|
|
1216
|
+
<div><p>LocationRequestWithoutFactorId</p>
|
|
1217
|
+
</div></blockquote>
|
|
1218
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1219
|
+
</dd></dl>
|
|
1220
|
+
|
|
1221
|
+
<dl class="js interface">
|
|
1222
|
+
<dt class="sig sig-object js" id="Api.LocationRequestWithFactorId">
|
|
1223
|
+
<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>
|
|
1224
|
+
<dd><p>Request parameters for location-based calculations with a specific factor ID.
|
|
1225
|
+
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1226
|
+
<blockquote>
|
|
1227
|
+
<div><p>LocationRequestWithFactorId</p>
|
|
1228
|
+
</div></blockquote>
|
|
1229
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1230
|
+
</dd></dl>
|
|
1231
|
+
|
|
1232
|
+
<dl class="js interface">
|
|
1233
|
+
<dt class="sig sig-object js" id="Api.CommonRequestWithoutFactorId">
|
|
1234
|
+
<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>
|
|
1235
|
+
<dd><p>Common request parameters for calculations without specifying a factor ID.
|
|
1236
|
+
Used for general-purpose calculations based on location, time, and activity data.</p>
|
|
1237
|
+
<blockquote>
|
|
1238
|
+
<div><p>CommonRequestWithoutFactorId</p>
|
|
1239
|
+
</div></blockquote>
|
|
1240
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1241
|
+
</dd></dl>
|
|
1242
|
+
|
|
1243
|
+
<dl class="js interface">
|
|
1244
|
+
<dt class="sig sig-object js" id="Api.CommonRequestWithFactorId">
|
|
1245
|
+
<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>
|
|
1246
|
+
<dd><p>Common request parameters for calculations with a specific factor ID.
|
|
1247
|
+
Used when the emission factor is already known and doesn’t need to be determined by location.</p>
|
|
1248
|
+
<blockquote>
|
|
1249
|
+
<div><p>CommonRequestWithFactorId</p>
|
|
1250
|
+
</div></blockquote>
|
|
1251
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1252
|
+
</dd></dl>
|
|
1253
|
+
|
|
1254
|
+
<dl class="js interface">
|
|
1255
|
+
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithoutFactorId">
|
|
1256
|
+
<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>
|
|
1257
|
+
<dd><p>Request parameters for generic calculations without specifying a factor ID.
|
|
1258
|
+
Used for calculations that may involve multiple units or complex activity data.</p>
|
|
1259
|
+
<blockquote>
|
|
1260
|
+
<div><p>GenericCalculationRequestWithoutFactorId</p>
|
|
1261
|
+
</div></blockquote>
|
|
1262
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1263
|
+
</dd></dl>
|
|
1264
|
+
|
|
1265
|
+
<dl class="js interface">
|
|
1266
|
+
<dt class="sig sig-object js" id="Api.GenericCalculationRequestWithFactorId">
|
|
1267
|
+
<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>
|
|
1268
|
+
<dd><p>Request parameters for generic calculations with a specific factor ID.
|
|
1269
|
+
Used for complex calculations where the emission factor is already known.</p>
|
|
1270
|
+
<blockquote>
|
|
1271
|
+
<div><p>GenericCalculationRequestWithFactorId</p>
|
|
1272
|
+
</div></blockquote>
|
|
1273
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1274
|
+
</dd></dl>
|
|
1275
|
+
|
|
1276
|
+
<dl class="js interface">
|
|
1277
|
+
<dt class="sig sig-object js" id="Api.FactorRequestWithoutFactorId">
|
|
1278
|
+
<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>
|
|
1279
|
+
<dd><p>Request parameters for retrieving factor information without specifying a factor ID.
|
|
1280
|
+
Used to look up appropriate emission factors based on location, time, and activity type.</p>
|
|
1281
|
+
<blockquote>
|
|
1282
|
+
<div><p>FactorRequestWithoutFactorId</p>
|
|
1283
|
+
</div></blockquote>
|
|
1284
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1285
|
+
</dd></dl>
|
|
1286
|
+
|
|
1287
|
+
<dl class="js interface">
|
|
1288
|
+
<dt class="sig sig-object js" id="Api.FactorRequestWithFactorId">
|
|
1289
|
+
<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>
|
|
1290
|
+
<dd><p>Request parameters for retrieving specific factor information by ID.
|
|
1291
|
+
Used when the exact factor to retrieve is already known.</p>
|
|
1292
|
+
<blockquote>
|
|
1293
|
+
<div><p>FactorRequestWithFactorId</p>
|
|
1294
|
+
</div></blockquote>
|
|
1295
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1296
|
+
</dd></dl>
|
|
1297
|
+
|
|
1298
|
+
<dl class="js interface">
|
|
1299
|
+
<dt class="sig sig-object js" id="Api.SearchRequest">
|
|
1300
|
+
<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>
|
|
1301
|
+
<dd><p>Request parameters for searching factors or activities.
|
|
1302
|
+
Used to find relevant factors or activities based on location, time, and search criteria.</p>
|
|
1303
|
+
<blockquote>
|
|
1304
|
+
<div><p>SearchRequest</p>
|
|
1305
|
+
</div></blockquote>
|
|
1306
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Api</span></code></p>
|
|
1307
|
+
</dd></dl>
|
|
1308
|
+
|
|
1309
|
+
<dl class="js interface">
|
|
1310
|
+
<dt class="sig sig-object js" id="common.Location">
|
|
1311
|
+
<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>
|
|
1312
|
+
<dd><dl class="simple">
|
|
1313
|
+
<dt>Represents a geographical location.</dt><dd><p>Location</p>
|
|
1314
|
+
</dd>
|
|
1315
|
+
</dl>
|
|
1316
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1317
|
+
</dd></dl>
|
|
1318
|
+
|
|
1319
|
+
<dl class="js interface">
|
|
1320
|
+
<dt class="sig sig-object js" id="common.Time">
|
|
1321
|
+
<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>
|
|
1322
|
+
<dd><dl class="simple">
|
|
1323
|
+
<dt>Represents a point in time with date information.</dt><dd><p>Time</p>
|
|
1324
|
+
</dd>
|
|
1325
|
+
</dl>
|
|
1326
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1327
|
+
</dd></dl>
|
|
1328
|
+
|
|
1329
|
+
<dl class="js interface">
|
|
1330
|
+
<dt class="sig sig-object js" id="common.Activity">
|
|
1331
|
+
<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>
|
|
1332
|
+
<dd><dl class="simple">
|
|
1333
|
+
<dt>Represents an activity with type, value, and unit of measurement.</dt><dd><p>Activity</p>
|
|
1334
|
+
</dd>
|
|
1335
|
+
</dl>
|
|
1336
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1337
|
+
</dd></dl>
|
|
1338
|
+
|
|
1339
|
+
<dl class="js interface">
|
|
1340
|
+
<dt class="sig sig-object js" id="common.ActivityWithFactorId">
|
|
1341
|
+
<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>
|
|
1342
|
+
<dd><dl class="simple">
|
|
1343
|
+
<dt>Represents an activity identified by a factor ID instead of a type.</dt><dd><p>ActivityWithFactorId</p>
|
|
1344
|
+
</dd>
|
|
1345
|
+
</dl>
|
|
1346
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1347
|
+
</dd></dl>
|
|
1348
|
+
|
|
1349
|
+
<dl class="js interface">
|
|
1350
|
+
<dt class="sig sig-object js" id="common.CombinedUnitsActivity">
|
|
1351
|
+
<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>
|
|
1352
|
+
<dd><dl class="simple">
|
|
1353
|
+
<dt>Represents an activity that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivity</p>
|
|
1354
|
+
</dd>
|
|
1355
|
+
</dl>
|
|
1356
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1357
|
+
</dd></dl>
|
|
1358
|
+
|
|
1359
|
+
<dl class="js interface">
|
|
1360
|
+
<dt class="sig sig-object js" id="common.CombinedUnitsActivityWithFactorId">
|
|
1361
|
+
<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>
|
|
1362
|
+
<dd><dl class="simple">
|
|
1363
|
+
<dt>Represents an activity with factor ID that can have single or multiple values and units.</dt><dd><p>CombinedUnitsActivityWithFactorId</p>
|
|
1364
|
+
</dd>
|
|
1365
|
+
</dl>
|
|
1366
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1367
|
+
</dd></dl>
|
|
1368
|
+
|
|
1369
|
+
<dl class="js interface">
|
|
1370
|
+
<dt class="sig sig-object js" id="common.FactorActivity">
|
|
1371
|
+
<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>
|
|
1372
|
+
<dd><dl class="simple">
|
|
1373
|
+
<dt>Represents a factor activity with a type and optional unit.</dt><dd><p>FactorActivity</p>
|
|
1374
|
+
</dd>
|
|
1375
|
+
</dl>
|
|
1376
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1377
|
+
</dd></dl>
|
|
1378
|
+
|
|
1379
|
+
<dl class="js interface">
|
|
1380
|
+
<dt class="sig sig-object js" id="common.FactorActivityWithFactorId">
|
|
1381
|
+
<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>
|
|
1382
|
+
<dd><dl class="simple">
|
|
1383
|
+
<dt>Represents a factor activity identified by a factor ID instead of a type.</dt><dd><p>FactorActivityWithFactorId</p>
|
|
1384
|
+
</dd>
|
|
1385
|
+
</dl>
|
|
1386
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1387
|
+
</dd></dl>
|
|
1388
|
+
|
|
1389
|
+
<dl class="js interface">
|
|
1390
|
+
<dt class="sig sig-object js" id="common.SearchActivity">
|
|
1391
|
+
<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>
|
|
1392
|
+
<dd><dl class="simple">
|
|
1393
|
+
<dt>Represents a search query for activities.</dt><dd><p>SearchActivity</p>
|
|
1394
|
+
</dd>
|
|
1395
|
+
</dl>
|
|
1396
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1397
|
+
</dd></dl>
|
|
1398
|
+
|
|
1399
|
+
<dl class="js interface">
|
|
1400
|
+
<dt class="sig sig-object js" id="common.Pagination">
|
|
1401
|
+
<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>
|
|
1402
|
+
<dd><dl class="simple">
|
|
1403
|
+
<dt>Represents pagination parameters for paginated results.</dt><dd><p>Pagination</p>
|
|
1404
|
+
</dd>
|
|
1405
|
+
</dl>
|
|
1406
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.common</span></code></p>
|
|
1407
|
+
</dd></dl>
|
|
1408
|
+
|
|
1409
|
+
<dl class="js interface">
|
|
1410
|
+
<dt class="sig sig-object js" id="Config.RequestConfig">
|
|
1411
|
+
<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>
|
|
1412
|
+
<dd><dl class="simple">
|
|
1413
|
+
<dt>Configuration for making HTTP requests.</dt><dd><p>RequestConfig</p>
|
|
1414
|
+
</dd>
|
|
1415
|
+
</dl>
|
|
1416
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Config</span></code></p>
|
|
1417
|
+
</dd></dl>
|
|
1418
|
+
|
|
1419
|
+
<dl class="js interface">
|
|
1420
|
+
<dt class="sig sig-object js" id="Config.ClientConfig">
|
|
1421
|
+
<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>
|
|
1422
|
+
<dd><dl class="simple">
|
|
1423
|
+
<dt>Configuration for initializing a client instance.</dt><dd><p>ClientConfig</p>
|
|
1424
|
+
</dd>
|
|
1425
|
+
</dl>
|
|
1426
|
+
<p><em>exported from</em> <code class="xref js js-mod docutils literal notranslate"><span class="pre">interfaces.Config</span></code></p>
|
|
1427
|
+
</dd></dl>
|
|
1428
|
+
|
|
1429
|
+
</section>
|
|
1430
|
+
</section>
|
|
1431
|
+
|
|
1432
|
+
</article>
|
|
1433
|
+
</div>
|
|
1434
|
+
<footer>
|
|
1435
|
+
|
|
1436
|
+
<div class="related-pages">
|
|
1437
|
+
<a class="next-page" href="troubleshooting.html">
|
|
1438
|
+
<div class="page-info">
|
|
1439
|
+
<div class="context">
|
|
1440
|
+
<span>Next</span>
|
|
1441
|
+
</div>
|
|
1442
|
+
<div class="title">Troubleshooting Guide</div>
|
|
1443
|
+
</div>
|
|
1444
|
+
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
|
1445
|
+
</a>
|
|
1446
|
+
<a class="prev-page" href="authentication.html">
|
|
1447
|
+
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
|
1448
|
+
<div class="page-info">
|
|
1449
|
+
<div class="context">
|
|
1450
|
+
<span>Previous</span>
|
|
1451
|
+
</div>
|
|
1452
|
+
|
|
1453
|
+
<div class="title">Authentication</div>
|
|
1454
|
+
|
|
1455
|
+
</div>
|
|
1456
|
+
</a>
|
|
1457
|
+
</div>
|
|
1458
|
+
<div class="bottom-of-page">
|
|
1459
|
+
<div class="left-details">
|
|
1460
|
+
<div class="copyright">
|
|
1461
|
+
Copyright © 2025, IBM Corporation
|
|
1462
|
+
</div>
|
|
1463
|
+
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
1464
|
+
|
|
1465
|
+
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
1466
|
+
|
|
1467
|
+
</div>
|
|
1468
|
+
<div class="right-details">
|
|
1469
|
+
|
|
1470
|
+
</div>
|
|
1471
|
+
</div>
|
|
1472
|
+
|
|
1473
|
+
</footer>
|
|
1474
|
+
</div>
|
|
1475
|
+
<aside class="toc-drawer">
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
<div class="toc-sticky toc-scroll">
|
|
1479
|
+
<div class="toc-title-container">
|
|
1480
|
+
<span class="toc-title">
|
|
1481
|
+
On this page
|
|
1482
|
+
</span>
|
|
1483
|
+
</div>
|
|
1484
|
+
<div class="toc-tree-container">
|
|
1485
|
+
<div class="toc-tree">
|
|
1486
|
+
<ul>
|
|
1487
|
+
<li><a class="reference internal" href="#">Reference</a><ul>
|
|
1488
|
+
<li><a class="reference internal" href="#Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a><ul>
|
|
1489
|
+
<li><a class="reference internal" href="#Client.getAuthHeader"><code class="docutils literal notranslate"><span class="pre">Client.getAuthHeader()</span></code></a></li>
|
|
1490
|
+
<li><a class="reference internal" href="#Client.getClientId"><code class="docutils literal notranslate"><span class="pre">Client.getClientId()</span></code></a></li>
|
|
1491
|
+
<li><a class="reference internal" href="#Client.getClientSource"><code class="docutils literal notranslate"><span class="pre">Client.getClientSource()</span></code></a></li>
|
|
1492
|
+
<li><a class="reference internal" href="#Client.getDomain"><code class="docutils literal notranslate"><span class="pre">Client.getDomain()</span></code></a></li>
|
|
1493
|
+
<li><a class="reference internal" href="#Client.refreshToken"><code class="docutils literal notranslate"><span class="pre">Client.refreshToken()</span></code></a></li>
|
|
1494
|
+
<li><a class="reference internal" href="#Client.getClient"><code class="docutils literal notranslate"><span class="pre">Client.getClient()</span></code></a></li>
|
|
1495
|
+
<li><a class="reference internal" href="#Client.getInstance"><code class="docutils literal notranslate"><span class="pre">Client.getInstance()</span></code></a></li>
|
|
1496
|
+
</ul>
|
|
1497
|
+
</li>
|
|
1498
|
+
<li><a class="reference internal" href="#request.makeApiRequest"><code class="docutils literal notranslate"><span class="pre">request.makeApiRequest()</span></code></a></li>
|
|
1499
|
+
<li><a class="reference internal" href="#utils.findExpiryTime"><code class="docutils literal notranslate"><span class="pre">utils.findExpiryTime()</span></code></a></li>
|
|
1500
|
+
<li><a class="reference internal" href="#api">API</a><ul>
|
|
1501
|
+
<li><a class="reference internal" href="#Factor.retrieveFactor"><code class="docutils literal notranslate"><span class="pre">Factor.retrieveFactor()</span></code></a></li>
|
|
1502
|
+
<li><a class="reference internal" href="#Fugitive.calculate"><code class="docutils literal notranslate"><span class="pre">Fugitive.calculate()</span></code></a></li>
|
|
1503
|
+
<li><a class="reference internal" href="#Calculation.calculate"><code class="docutils literal notranslate"><span class="pre">Calculation.calculate()</span></code></a></li>
|
|
1504
|
+
<li><a class="reference internal" href="#Location.calculate"><code class="docutils literal notranslate"><span class="pre">Location.calculate()</span></code></a></li>
|
|
1505
|
+
<li><a class="reference internal" href="#Mobile.calculate"><code class="docutils literal notranslate"><span class="pre">Mobile.calculate()</span></code></a></li>
|
|
1506
|
+
<li><a class="reference internal" href="#Stationary.calculate"><code class="docutils literal notranslate"><span class="pre">Stationary.calculate()</span></code></a></li>
|
|
1507
|
+
<li><a class="reference internal" href="#TransportationAndDistribution.calculate"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.calculate()</span></code></a></li>
|
|
1508
|
+
</ul>
|
|
1509
|
+
</li>
|
|
1510
|
+
<li><a class="reference internal" href="#metadata-apis">Metadata APIs</a><ul>
|
|
1511
|
+
<li><a class="reference internal" href="#gettypes">getTypes</a><ul>
|
|
1512
|
+
<li><a class="reference internal" href="#Factor.getTypes"><code class="docutils literal notranslate"><span class="pre">Factor.getTypes()</span></code></a></li>
|
|
1513
|
+
<li><a class="reference internal" href="#Calculation.getTypes"><code class="docutils literal notranslate"><span class="pre">Calculation.getTypes()</span></code></a></li>
|
|
1514
|
+
<li><a class="reference internal" href="#Location.getTypes"><code class="docutils literal notranslate"><span class="pre">Location.getTypes()</span></code></a></li>
|
|
1515
|
+
<li><a class="reference internal" href="#Mobile.getTypes"><code class="docutils literal notranslate"><span class="pre">Mobile.getTypes()</span></code></a></li>
|
|
1516
|
+
<li><a class="reference internal" href="#Stationary.getTypes"><code class="docutils literal notranslate"><span class="pre">Stationary.getTypes()</span></code></a></li>
|
|
1517
|
+
<li><a class="reference internal" href="#TransportationAndDistribution.getTypes"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getTypes()</span></code></a></li>
|
|
1518
|
+
<li><a class="reference internal" href="#Fugitive.getTypes"><code class="docutils literal notranslate"><span class="pre">Fugitive.getTypes()</span></code></a></li>
|
|
1519
|
+
</ul>
|
|
1520
|
+
</li>
|
|
1521
|
+
<li><a class="reference internal" href="#getarea">getArea</a><ul>
|
|
1522
|
+
<li><a class="reference internal" href="#Factor.getArea"><code class="docutils literal notranslate"><span class="pre">Factor.getArea()</span></code></a></li>
|
|
1523
|
+
<li><a class="reference internal" href="#Factor.getSearchArea"><code class="docutils literal notranslate"><span class="pre">Factor.getSearchArea()</span></code></a></li>
|
|
1524
|
+
<li><a class="reference internal" href="#Calculation.getArea"><code class="docutils literal notranslate"><span class="pre">Calculation.getArea()</span></code></a></li>
|
|
1525
|
+
<li><a class="reference internal" href="#Location.getArea"><code class="docutils literal notranslate"><span class="pre">Location.getArea()</span></code></a></li>
|
|
1526
|
+
<li><a class="reference internal" href="#Mobile.getArea"><code class="docutils literal notranslate"><span class="pre">Mobile.getArea()</span></code></a></li>
|
|
1527
|
+
<li><a class="reference internal" href="#Stationary.getArea"><code class="docutils literal notranslate"><span class="pre">Stationary.getArea()</span></code></a></li>
|
|
1528
|
+
<li><a class="reference internal" href="#TransportationAndDistribution.getArea"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getArea()</span></code></a></li>
|
|
1529
|
+
<li><a class="reference internal" href="#Fugitive.getArea"><code class="docutils literal notranslate"><span class="pre">Fugitive.getArea()</span></code></a></li>
|
|
1530
|
+
</ul>
|
|
1531
|
+
</li>
|
|
1532
|
+
<li><a class="reference internal" href="#getunits">getUnits</a><ul>
|
|
1533
|
+
<li><a class="reference internal" href="#Factor.getUnits"><code class="docutils literal notranslate"><span class="pre">Factor.getUnits()</span></code></a></li>
|
|
1534
|
+
<li><a class="reference internal" href="#Calculation.getUnits"><code class="docutils literal notranslate"><span class="pre">Calculation.getUnits()</span></code></a></li>
|
|
1535
|
+
<li><a class="reference internal" href="#Location.getUnits"><code class="docutils literal notranslate"><span class="pre">Location.getUnits()</span></code></a></li>
|
|
1536
|
+
<li><a class="reference internal" href="#Mobile.getUnits"><code class="docutils literal notranslate"><span class="pre">Mobile.getUnits()</span></code></a></li>
|
|
1537
|
+
<li><a class="reference internal" href="#Stationary.getUnits"><code class="docutils literal notranslate"><span class="pre">Stationary.getUnits()</span></code></a></li>
|
|
1538
|
+
<li><a class="reference internal" href="#TransportationAndDistribution.getUnits"><code class="docutils literal notranslate"><span class="pre">TransportationAndDistribution.getUnits()</span></code></a></li>
|
|
1539
|
+
<li><a class="reference internal" href="#Fugitive.getUnits"><code class="docutils literal notranslate"><span class="pre">Fugitive.getUnits()</span></code></a></li>
|
|
1540
|
+
</ul>
|
|
1541
|
+
</li>
|
|
1542
|
+
</ul>
|
|
1543
|
+
</li>
|
|
1544
|
+
<li><a class="reference internal" href="#interfaces">Interfaces</a><ul>
|
|
1545
|
+
<li><a class="reference internal" href="#Api.LocationRequestWithoutFactorId"><code class="docutils literal notranslate"><span class="pre">Api.LocationRequestWithoutFactorId</span></code></a></li>
|
|
1546
|
+
<li><a class="reference internal" href="#Api.LocationRequestWithFactorId"><code class="docutils literal notranslate"><span class="pre">Api.LocationRequestWithFactorId</span></code></a></li>
|
|
1547
|
+
<li><a class="reference internal" href="#Api.CommonRequestWithoutFactorId"><code class="docutils literal notranslate"><span class="pre">Api.CommonRequestWithoutFactorId</span></code></a></li>
|
|
1548
|
+
<li><a class="reference internal" href="#Api.CommonRequestWithFactorId"><code class="docutils literal notranslate"><span class="pre">Api.CommonRequestWithFactorId</span></code></a></li>
|
|
1549
|
+
<li><a class="reference internal" href="#Api.GenericCalculationRequestWithoutFactorId"><code class="docutils literal notranslate"><span class="pre">Api.GenericCalculationRequestWithoutFactorId</span></code></a></li>
|
|
1550
|
+
<li><a class="reference internal" href="#Api.GenericCalculationRequestWithFactorId"><code class="docutils literal notranslate"><span class="pre">Api.GenericCalculationRequestWithFactorId</span></code></a></li>
|
|
1551
|
+
<li><a class="reference internal" href="#Api.FactorRequestWithoutFactorId"><code class="docutils literal notranslate"><span class="pre">Api.FactorRequestWithoutFactorId</span></code></a></li>
|
|
1552
|
+
<li><a class="reference internal" href="#Api.FactorRequestWithFactorId"><code class="docutils literal notranslate"><span class="pre">Api.FactorRequestWithFactorId</span></code></a></li>
|
|
1553
|
+
<li><a class="reference internal" href="#Api.SearchRequest"><code class="docutils literal notranslate"><span class="pre">Api.SearchRequest</span></code></a></li>
|
|
1554
|
+
<li><a class="reference internal" href="#common.Location"><code class="docutils literal notranslate"><span class="pre">common.Location</span></code></a></li>
|
|
1555
|
+
<li><a class="reference internal" href="#common.Time"><code class="docutils literal notranslate"><span class="pre">common.Time</span></code></a></li>
|
|
1556
|
+
<li><a class="reference internal" href="#common.Activity"><code class="docutils literal notranslate"><span class="pre">common.Activity</span></code></a></li>
|
|
1557
|
+
<li><a class="reference internal" href="#common.ActivityWithFactorId"><code class="docutils literal notranslate"><span class="pre">common.ActivityWithFactorId</span></code></a></li>
|
|
1558
|
+
<li><a class="reference internal" href="#common.CombinedUnitsActivity"><code class="docutils literal notranslate"><span class="pre">common.CombinedUnitsActivity</span></code></a></li>
|
|
1559
|
+
<li><a class="reference internal" href="#common.CombinedUnitsActivityWithFactorId"><code class="docutils literal notranslate"><span class="pre">common.CombinedUnitsActivityWithFactorId</span></code></a></li>
|
|
1560
|
+
<li><a class="reference internal" href="#common.FactorActivity"><code class="docutils literal notranslate"><span class="pre">common.FactorActivity</span></code></a></li>
|
|
1561
|
+
<li><a class="reference internal" href="#common.FactorActivityWithFactorId"><code class="docutils literal notranslate"><span class="pre">common.FactorActivityWithFactorId</span></code></a></li>
|
|
1562
|
+
<li><a class="reference internal" href="#common.SearchActivity"><code class="docutils literal notranslate"><span class="pre">common.SearchActivity</span></code></a></li>
|
|
1563
|
+
<li><a class="reference internal" href="#common.Pagination"><code class="docutils literal notranslate"><span class="pre">common.Pagination</span></code></a></li>
|
|
1564
|
+
<li><a class="reference internal" href="#Config.RequestConfig"><code class="docutils literal notranslate"><span class="pre">Config.RequestConfig</span></code></a></li>
|
|
1565
|
+
<li><a class="reference internal" href="#Config.ClientConfig"><code class="docutils literal notranslate"><span class="pre">Config.ClientConfig</span></code></a></li>
|
|
1566
|
+
</ul>
|
|
1567
|
+
</li>
|
|
1568
|
+
</ul>
|
|
1569
|
+
</li>
|
|
1570
|
+
</ul>
|
|
1571
|
+
|
|
1572
|
+
</div>
|
|
1573
|
+
</div>
|
|
1574
|
+
</div>
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
</aside>
|
|
1578
|
+
</div>
|
|
1579
|
+
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
1580
|
+
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
1581
|
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
1582
|
+
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
|
|
1583
|
+
</body>
|
|
1584
|
+
</html>
|