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.
Files changed (155) hide show
  1. package/README.md +33 -2
  2. package/dist/Constants.js +23 -1
  3. package/dist/api/Calculation.js +78 -15
  4. package/dist/api/Factor.js +99 -18
  5. package/dist/api/FactorSets.js +1 -1
  6. package/dist/api/Fugitive.js +76 -13
  7. package/dist/api/Location.js +76 -15
  8. package/dist/api/Mobile.js +65 -1
  9. package/dist/api/Stationary.js +78 -15
  10. package/dist/api/TransportationAndDistribution.js +77 -14
  11. package/dist/coverage/clover.xml +191 -81
  12. package/dist/coverage/coverage-final.json +11 -11
  13. package/dist/coverage/lcov-report/index.html +16 -16
  14. package/dist/coverage/lcov-report/src/Client.ts.html +23 -23
  15. package/dist/coverage/lcov-report/src/Constants.ts.html +82 -4
  16. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +245 -26
  17. package/dist/coverage/lcov-report/src/api/Factor.ts.html +313 -34
  18. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +8 -5
  19. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +246 -24
  20. package/dist/coverage/lcov-report/src/api/Location.ts.html +245 -26
  21. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +240 -12
  22. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +248 -26
  23. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +250 -25
  24. package/dist/coverage/lcov-report/src/api/index.html +25 -25
  25. package/dist/coverage/lcov-report/src/index.html +7 -7
  26. package/dist/coverage/lcov-report/src/request.ts.html +1 -1
  27. package/dist/coverage/lcov-report/src/utils.ts.html +5 -5
  28. package/dist/coverage/lcov-report/test/index.html +1 -1
  29. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  30. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  31. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  32. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  33. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
  34. package/dist/coverage/lcov-report/test/mocks/index.html +1 -1
  35. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  36. package/dist/coverage/lcov.info +287 -133
  37. package/dist/interfaces/response/AreaResponse.js +2 -0
  38. package/dist/interfaces/response/EmissionResponse.js +2 -0
  39. package/dist/interfaces/response/EmissionResponseWithDetails.js +2 -0
  40. package/dist/interfaces/response/FactorResponse.js +2 -0
  41. package/dist/interfaces/response/FactorSetResponse.js +2 -0
  42. package/dist/interfaces/response/SearchResponse.js +2 -0
  43. package/dist/interfaces/response/TypeResponse.js +2 -0
  44. package/dist/interfaces/response/UnitResponse.js +2 -0
  45. package/dist/types/Constants.d.ts +22 -0
  46. package/dist/types/api/Calculation.d.ts +59 -16
  47. package/dist/types/api/Factor.d.ts +73 -20
  48. package/dist/types/api/FactorSets.d.ts +3 -2
  49. package/dist/types/api/Fugitive.d.ts +57 -14
  50. package/dist/types/api/Location.d.ts +57 -16
  51. package/dist/types/api/Mobile.d.ts +46 -2
  52. package/dist/types/api/Stationary.d.ts +59 -16
  53. package/dist/types/api/TransportationAndDistribution.d.ts +58 -15
  54. package/dist/types/index.d.ts +8 -0
  55. package/dist/types/interfaces/response/AreaResponse.d.ts +20 -0
  56. package/dist/types/interfaces/response/EmissionResponse.d.ts +31 -0
  57. package/dist/types/interfaces/response/EmissionResponseWithDetails.d.ts +144 -0
  58. package/dist/types/interfaces/response/FactorResponse.d.ts +53 -0
  59. package/dist/types/interfaces/response/FactorSetResponse.d.ts +38 -0
  60. package/dist/types/interfaces/response/SearchResponse.d.ts +41 -0
  61. package/dist/types/interfaces/response/TypeResponse.d.ts +7 -0
  62. package/dist/types/interfaces/response/UnitResponse.d.ts +7 -0
  63. package/docs/.nojekyll +0 -0
  64. package/docs/_sources/authentication.rst.txt +164 -0
  65. package/docs/_sources/client.rst.txt +137 -0
  66. package/docs/_sources/getting_started.rst.txt +164 -0
  67. package/docs/_sources/index.rst.txt +30 -0
  68. package/docs/_sources/reference.rst.txt +129 -0
  69. package/docs/_sources/sdk.rst.txt +13 -0
  70. package/docs/_sources/troubleshooting.rst.txt +486 -0
  71. package/docs/_static/basic.css +914 -0
  72. package/docs/_static/custom.css +16 -0
  73. package/docs/_static/debug.css +69 -0
  74. package/docs/_static/doctools.js +149 -0
  75. package/docs/_static/documentation_options.js +13 -0
  76. package/docs/_static/file.png +0 -0
  77. package/docs/_static/language_data.js +192 -0
  78. package/docs/_static/minus.png +0 -0
  79. package/docs/_static/plus.png +0 -0
  80. package/docs/_static/pygments.css +232 -0
  81. package/docs/_static/scripts/furo-extensions.js +0 -0
  82. package/docs/_static/scripts/furo.js +3 -0
  83. package/docs/_static/scripts/furo.js.LICENSE.txt +7 -0
  84. package/docs/_static/scripts/furo.js.map +1 -0
  85. package/docs/_static/searchtools.js +632 -0
  86. package/docs/_static/skeleton.css +296 -0
  87. package/docs/_static/sphinx_highlight.js +154 -0
  88. package/docs/_static/sphinx_js.css +0 -0
  89. package/docs/_static/styles/furo-extensions.css +2 -0
  90. package/docs/_static/styles/furo-extensions.css.map +1 -0
  91. package/docs/_static/styles/furo.css +2 -0
  92. package/docs/_static/styles/furo.css.map +1 -0
  93. package/docs/authentication.html +523 -0
  94. package/docs/client.html +477 -0
  95. package/docs/genindex.html +492 -0
  96. package/docs/getting_started.html +491 -0
  97. package/docs/index.html +357 -0
  98. package/docs/objects.inv +0 -0
  99. package/docs/reference.html +1584 -0
  100. package/docs/sdk.html +334 -0
  101. package/docs/search.html +297 -0
  102. package/docs/searchindex.js +1 -0
  103. package/docs/troubleshooting.html +786 -0
  104. package/package.json +1 -1
  105. package/sphinx-build/Makefile +49 -0
  106. package/sphinx-build/requirements.txt +5 -0
  107. package/sphinx-build/source/_static/custom.css +16 -0
  108. package/sphinx-build/source/authentication.rst +164 -0
  109. package/sphinx-build/source/client.rst +137 -0
  110. package/sphinx-build/source/conf.py +56 -0
  111. package/sphinx-build/source/getting_started.rst +164 -0
  112. package/sphinx-build/source/index.rst +30 -0
  113. package/sphinx-build/source/reference.rst +129 -0
  114. package/sphinx-build/source/sdk.rst +13 -0
  115. package/sphinx-build/source/troubleshooting.rst +486 -0
  116. package/src/Constants.ts +26 -0
  117. package/src/api/Calculation.ts +94 -20
  118. package/src/api/Factor.ts +122 -28
  119. package/src/api/FactorSets.ts +4 -3
  120. package/src/api/Fugitive.ts +93 -18
  121. package/src/api/Location.ts +94 -20
  122. package/src/api/Mobile.ts +83 -6
  123. package/src/api/Stationary.ts +95 -20
  124. package/src/api/TransportationAndDistribution.ts +95 -19
  125. package/src/index.ts +33 -1
  126. package/src/interfaces/response/AreaResponse.ts +25 -0
  127. package/src/interfaces/response/EmissionResponse.ts +44 -0
  128. package/src/interfaces/response/EmissionResponseWithDetails.ts +183 -0
  129. package/src/interfaces/response/FactorResponse.ts +78 -0
  130. package/src/interfaces/response/FactorSetResponse.ts +52 -0
  131. package/src/interfaces/response/SearchResponse.ts +52 -0
  132. package/src/interfaces/response/TypeResponse.ts +7 -0
  133. package/src/interfaces/response/UnitResponse.ts +7 -0
  134. package/test/apiTest.test.ts +173 -6
  135. package/dist/api/Factors.js +0 -98
  136. package/dist/api/FugitiveEmission.js +0 -40
  137. package/dist/api/GenericCalculation.js +0 -41
  138. package/dist/api/LocationEmission.js +0 -41
  139. package/dist/api/MobileEmission.js +0 -41
  140. package/dist/api/StationaryEmission.js +0 -41
  141. package/dist/api/TransportationDistributionEmission.js +0 -40
  142. package/dist/coverage/lcov-report/src/api/Factors.ts.html +0 -403
  143. package/dist/coverage/lcov-report/src/api/FugitiveEmission.ts.html +0 -214
  144. package/dist/coverage/lcov-report/src/api/GenericCalculation.ts.html +0 -217
  145. package/dist/coverage/lcov-report/src/api/LocationEmission.ts.html +0 -214
  146. package/dist/coverage/lcov-report/src/api/MobileEmission.ts.html +0 -220
  147. package/dist/coverage/lcov-report/src/api/StationaryEmission.ts.html +0 -220
  148. package/dist/coverage/lcov-report/src/api/TransportationDistributionEmission.ts.html +0 -211
  149. package/dist/types/api/Factors.d.ts +0 -68
  150. package/dist/types/api/FugitiveEmission.d.ts +0 -27
  151. package/dist/types/api/GenericCalculation.d.ts +0 -28
  152. package/dist/types/api/LocationEmission.d.ts +0 -28
  153. package/dist/types/api/MobileEmission.d.ts +0 -28
  154. package/dist/types/api/StationaryEmission.d.ts +0 -28
  155. package/dist/types/api/TransportationDistributionEmission.d.ts +0 -27
package/docs/genindex.html ADDED
@@ -0,0 +1,492 @@
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"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
6
+
7
+ <!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 --><title>Index - IBM Envizi - Emissions API Node.js SDK documentation</title>
8
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
9
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=25af2a20" />
10
+ <link rel="stylesheet" type="text/css" href="_static/sphinx_js.css" />
11
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
12
+ <link rel="stylesheet" type="text/css" href="_static/custom.css?v=8d04aa46" />
13
+
14
+
15
+
16
+
17
+ <style>
18
+ body {
19
+ --color-code-background: #f2f2f2;
20
+ --color-code-foreground: #1e1e1e;
21
+
22
+ }
23
+ @media not print {
24
+ body[data-theme="dark"] {
25
+ --color-code-background: #2b2b2b;
26
+ --color-code-foreground: #f8f8f2;
27
+
28
+ }
29
+ @media (prefers-color-scheme: dark) {
30
+ body:not([data-theme="light"]) {
31
+ --color-code-background: #2b2b2b;
32
+ --color-code-foreground: #f8f8f2;
33
+
34
+ }
35
+ }
36
+ }
37
+ </style></head>
38
+ <body>
39
+
40
+ <script>
41
+ document.body.dataset.theme = localStorage.getItem("theme") || "auto";
42
+ </script>
43
+
44
+
45
+ <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
46
+ <symbol id="svg-toc" viewBox="0 0 24 24">
47
+ <title>Contents</title>
48
+ <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
49
+ <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"/>
50
+ </svg>
51
+ </symbol>
52
+ <symbol id="svg-menu" viewBox="0 0 24 24">
53
+ <title>Menu</title>
54
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
55
+ stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
56
+ <line x1="3" y1="12" x2="21" y2="12"></line>
57
+ <line x1="3" y1="6" x2="21" y2="6"></line>
58
+ <line x1="3" y1="18" x2="21" y2="18"></line>
59
+ </svg>
60
+ </symbol>
61
+ <symbol id="svg-arrow-right" viewBox="0 0 24 24">
62
+ <title>Expand</title>
63
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
64
+ stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
65
+ <polyline points="9 18 15 12 9 6"></polyline>
66
+ </svg>
67
+ </symbol>
68
+ <symbol id="svg-sun" viewBox="0 0 24 24">
69
+ <title>Light mode</title>
70
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
71
+ stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
72
+ <circle cx="12" cy="12" r="5"></circle>
73
+ <line x1="12" y1="1" x2="12" y2="3"></line>
74
+ <line x1="12" y1="21" x2="12" y2="23"></line>
75
+ <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
76
+ <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
77
+ <line x1="1" y1="12" x2="3" y2="12"></line>
78
+ <line x1="21" y1="12" x2="23" y2="12"></line>
79
+ <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
80
+ <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
81
+ </svg>
82
+ </symbol>
83
+ <symbol id="svg-moon" viewBox="0 0 24 24">
84
+ <title>Dark mode</title>
85
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
86
+ stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
87
+ <path stroke="none" d="M0 0h24v24H0z" fill="none" />
88
+ <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" />
89
+ </svg>
90
+ </symbol>
91
+ <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
92
+ <title>Auto light/dark, in light mode</title>
93
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
94
+ stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
95
+ class="icon-custom-derived-from-feather-sun-and-tabler-moon">
96
+ <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"/>
97
+ <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
98
+ <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
99
+ <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
100
+ <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
101
+ <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
102
+ <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
103
+ <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
104
+ <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
105
+ <circle cx="14.5" cy="9.55" r="3.6"/>
106
+ </svg>
107
+ </symbol>
108
+ <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
109
+ <title>Auto light/dark, in dark mode</title>
110
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
111
+ stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
112
+ class="icon-custom-derived-from-feather-sun-and-tabler-moon">
113
+ <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"/>
114
+ <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
115
+ <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
116
+ <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
117
+ <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
118
+ <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
119
+ <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
120
+ <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
121
+ <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
122
+ <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
123
+ </svg>
124
+ </symbol>
125
+ <symbol id="svg-pencil" viewBox="0 0 24 24">
126
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
127
+ stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
128
+ <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
129
+ <path d="M13.5 6.5l4 4" />
130
+ <path d="M20 21l2 -2l-2 -2" />
131
+ <path d="M17 17l-2 2l2 2" />
132
+ </svg>
133
+ </symbol>
134
+ <symbol id="svg-eye" viewBox="0 0 24 24">
135
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
136
+ stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
137
+ <path stroke="none" d="M0 0h24v24H0z" fill="none" />
138
+ <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
139
+ <path
140
+ 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" />
141
+ <path d="M20 21l2 -2l-2 -2" />
142
+ <path d="M17 17l-2 2l2 2" />
143
+ </svg>
144
+ </symbol>
145
+ </svg>
146
+
147
+ <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
148
+ <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
149
+ <label class="overlay sidebar-overlay" for="__navigation">
150
+ <div class="visually-hidden">Hide navigation sidebar</div>
151
+ </label>
152
+ <label class="overlay toc-overlay" for="__toc">
153
+ <div class="visually-hidden">Hide table of contents sidebar</div>
154
+ </label>
155
+
156
+ <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
157
+
158
+
159
+
160
+ <div class="page">
161
+ <header class="mobile-header">
162
+ <div class="header-left">
163
+ <label class="nav-overlay-icon" for="__navigation">
164
+ <div class="visually-hidden">Toggle site navigation sidebar</div>
165
+ <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
166
+ </label>
167
+ </div>
168
+ <div class="header-center">
169
+ <a href="index.html"><div class="brand">IBM Envizi - Emissions API Node.js SDK documentation</div></a>
170
+ </div>
171
+ <div class="header-right">
172
+ <div class="theme-toggle-container theme-toggle-header">
173
+ <button class="theme-toggle">
174
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
175
+ <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
176
+ <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
177
+ <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
178
+ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
179
+ </button>
180
+ </div>
181
+ <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
182
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
183
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
184
+ </label>
185
+ </div>
186
+ </header>
187
+ <aside class="sidebar-drawer">
188
+ <div class="sidebar-container">
189
+
190
+ <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
191
+
192
+ <span class="sidebar-brand-text">IBM Envizi - Emissions API Node.js SDK documentation</span>
193
+
194
+ </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
195
+ <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
196
+ <input type="hidden" name="check_keywords" value="yes">
197
+ <input type="hidden" name="area" value="default">
198
+ </form>
199
+ <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
200
+ <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
201
+ <ul>
202
+ <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
203
+ <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>
204
+ <li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
205
+ <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
206
+ </ul>
207
+ </li>
208
+ <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
209
+ <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
210
+ </ul>
211
+
212
+ </div>
213
+ </div>
214
+
215
+ </div>
216
+
217
+ </div>
218
+ </aside>
219
+ <div class="main">
220
+ <div class="content">
221
+ <div class="article-container">
222
+ <a href="#" class="back-to-top muted-link">
223
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
224
+ <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
225
+ </svg>
226
+ <span>Back to top</span>
227
+ </a>
228
+ <div class="content-icon-container">
229
+ <div class="theme-toggle-container theme-toggle-content">
230
+ <button class="theme-toggle">
231
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
232
+ <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
233
+ <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
234
+ <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
235
+ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
236
+ </button>
237
+ </div>
238
+ <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
239
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
240
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
241
+ </label>
242
+ </div>
243
+ <article role="main" id="furo-main-content">
244
+
245
+ <section class="genindex-section">
246
+ <h1 id="index">Index</h1>
247
+ <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a></div>
248
+ </section>
249
+ <section id="A" class="genindex-section">
250
+ <h2>A</h2>
251
+ <table style="width: 100%" class="indextable genindextable"><tr>
252
+ <td style="width: 33%; vertical-align: top;"><ul>
253
+ <li><a href="reference.html#Api.CommonRequestWithFactorId">Api.CommonRequestWithFactorId() (interface)</a>
254
+ </li>
255
+ <li><a href="reference.html#Api.CommonRequestWithoutFactorId">Api.CommonRequestWithoutFactorId() (interface)</a>
256
+ </li>
257
+ <li><a href="reference.html#Api.FactorRequestWithFactorId">Api.FactorRequestWithFactorId() (interface)</a>
258
+ </li>
259
+ <li><a href="reference.html#Api.FactorRequestWithoutFactorId">Api.FactorRequestWithoutFactorId() (interface)</a>
260
+ </li>
261
+ </ul></td>
262
+ <td style="width: 33%; vertical-align: top;"><ul>
263
+ <li><a href="reference.html#Api.GenericCalculationRequestWithFactorId">Api.GenericCalculationRequestWithFactorId() (interface)</a>
264
+ </li>
265
+ <li><a href="reference.html#Api.GenericCalculationRequestWithoutFactorId">Api.GenericCalculationRequestWithoutFactorId() (interface)</a>
266
+ </li>
267
+ <li><a href="reference.html#Api.LocationRequestWithFactorId">Api.LocationRequestWithFactorId() (interface)</a>
268
+ </li>
269
+ <li><a href="reference.html#Api.LocationRequestWithoutFactorId">Api.LocationRequestWithoutFactorId() (interface)</a>
270
+ </li>
271
+ <li><a href="reference.html#Api.SearchRequest">Api.SearchRequest() (interface)</a>
272
+ </li>
273
+ </ul></td>
274
+ </tr></table>
275
+ </section>
276
+
277
+ <section id="C" class="genindex-section">
278
+ <h2>C</h2>
279
+ <table style="width: 100%" class="indextable genindextable"><tr>
280
+ <td style="width: 33%; vertical-align: top;"><ul>
281
+ <li><a href="reference.html#Calculation.calculate">Calculation.calculate() (Calculation method)</a>
282
+ </li>
283
+ <li><a href="reference.html#Calculation.getArea">Calculation.getArea() (Calculation method)</a>
284
+ </li>
285
+ <li><a href="reference.html#Calculation.getTypes">Calculation.getTypes() (Calculation method)</a>
286
+ </li>
287
+ <li><a href="reference.html#Calculation.getUnits">Calculation.getUnits() (Calculation method)</a>
288
+ </li>
289
+ <li><a href="reference.html#Client">Client() (class)</a>
290
+ </li>
291
+ <li><a href="reference.html#Client.getAuthHeader">Client.getAuthHeader() (Client method)</a>
292
+ </li>
293
+ <li><a href="reference.html#Client.getClient">Client.getClient() (Client method)</a>
294
+ </li>
295
+ <li><a href="reference.html#Client.getClientId">Client.getClientId() (Client method)</a>
296
+ </li>
297
+ <li><a href="reference.html#Client.getClientSource">Client.getClientSource() (Client method)</a>
298
+ </li>
299
+ <li><a href="reference.html#Client.getDomain">Client.getDomain() (Client method)</a>
300
+ </li>
301
+ <li><a href="reference.html#Client.getInstance">Client.getInstance() (Client method)</a>
302
+ </li>
303
+ <li><a href="reference.html#Client.refreshToken">Client.refreshToken() (Client method)</a>
304
+ </li>
305
+ </ul></td>
306
+ <td style="width: 33%; vertical-align: top;"><ul>
307
+ <li><a href="reference.html#common.Activity">common.Activity() (interface)</a>
308
+ </li>
309
+ <li><a href="reference.html#common.ActivityWithFactorId">common.ActivityWithFactorId() (interface)</a>
310
+ </li>
311
+ <li><a href="reference.html#common.CombinedUnitsActivity">common.CombinedUnitsActivity() (interface)</a>
312
+ </li>
313
+ <li><a href="reference.html#common.CombinedUnitsActivityWithFactorId">common.CombinedUnitsActivityWithFactorId() (interface)</a>
314
+ </li>
315
+ <li><a href="reference.html#common.FactorActivity">common.FactorActivity() (interface)</a>
316
+ </li>
317
+ <li><a href="reference.html#common.FactorActivityWithFactorId">common.FactorActivityWithFactorId() (interface)</a>
318
+ </li>
319
+ <li><a href="reference.html#common.Location">common.Location() (interface)</a>
320
+ </li>
321
+ <li><a href="reference.html#common.Pagination">common.Pagination() (interface)</a>
322
+ </li>
323
+ <li><a href="reference.html#common.SearchActivity">common.SearchActivity() (interface)</a>
324
+ </li>
325
+ <li><a href="reference.html#common.Time">common.Time() (interface)</a>
326
+ </li>
327
+ <li><a href="reference.html#Config.ClientConfig">Config.ClientConfig() (interface)</a>
328
+ </li>
329
+ <li><a href="reference.html#Config.RequestConfig">Config.RequestConfig() (interface)</a>
330
+ </li>
331
+ </ul></td>
332
+ </tr></table>
333
+ </section>
334
+
335
+ <section id="F" class="genindex-section">
336
+ <h2>F</h2>
337
+ <table style="width: 100%" class="indextable genindextable"><tr>
338
+ <td style="width: 33%; vertical-align: top;"><ul>
339
+ <li><a href="reference.html#Factor.getArea">Factor.getArea() (Factor method)</a>
340
+ </li>
341
+ <li><a href="reference.html#Factor.getSearchArea">Factor.getSearchArea() (Factor method)</a>
342
+ </li>
343
+ <li><a href="reference.html#Factor.getTypes">Factor.getTypes() (Factor method)</a>
344
+ </li>
345
+ <li><a href="reference.html#Factor.getUnits">Factor.getUnits() (Factor method)</a>
346
+ </li>
347
+ </ul></td>
348
+ <td style="width: 33%; vertical-align: top;"><ul>
349
+ <li><a href="reference.html#Factor.retrieveFactor">Factor.retrieveFactor() (Factor method)</a>
350
+ </li>
351
+ <li><a href="reference.html#Fugitive.calculate">Fugitive.calculate() (Fugitive method)</a>
352
+ </li>
353
+ <li><a href="reference.html#Fugitive.getArea">Fugitive.getArea() (Fugitive method)</a>
354
+ </li>
355
+ <li><a href="reference.html#Fugitive.getTypes">Fugitive.getTypes() (Fugitive method)</a>
356
+ </li>
357
+ <li><a href="reference.html#Fugitive.getUnits">Fugitive.getUnits() (Fugitive method)</a>
358
+ </li>
359
+ </ul></td>
360
+ </tr></table>
361
+ </section>
362
+
363
+ <section id="L" class="genindex-section">
364
+ <h2>L</h2>
365
+ <table style="width: 100%" class="indextable genindextable"><tr>
366
+ <td style="width: 33%; vertical-align: top;"><ul>
367
+ <li><a href="reference.html#Location.calculate">Location.calculate() (Location method)</a>
368
+ </li>
369
+ <li><a href="reference.html#Location.getArea">Location.getArea() (Location method)</a>
370
+ </li>
371
+ </ul></td>
372
+ <td style="width: 33%; vertical-align: top;"><ul>
373
+ <li><a href="reference.html#Location.getTypes">Location.getTypes() (Location method)</a>
374
+ </li>
375
+ <li><a href="reference.html#Location.getUnits">Location.getUnits() (Location method)</a>
376
+ </li>
377
+ </ul></td>
378
+ </tr></table>
379
+ </section>
380
+
381
+ <section id="M" class="genindex-section">
382
+ <h2>M</h2>
383
+ <table style="width: 100%" class="indextable genindextable"><tr>
384
+ <td style="width: 33%; vertical-align: top;"><ul>
385
+ <li><a href="reference.html#Mobile.calculate">Mobile.calculate() (Mobile method)</a>
386
+ </li>
387
+ <li><a href="reference.html#Mobile.getArea">Mobile.getArea() (Mobile method)</a>
388
+ </li>
389
+ </ul></td>
390
+ <td style="width: 33%; vertical-align: top;"><ul>
391
+ <li><a href="reference.html#Mobile.getTypes">Mobile.getTypes() (Mobile method)</a>
392
+ </li>
393
+ <li><a href="reference.html#Mobile.getUnits">Mobile.getUnits() (Mobile method)</a>
394
+ </li>
395
+ </ul></td>
396
+ </tr></table>
397
+ </section>
398
+
399
+ <section id="R" class="genindex-section">
400
+ <h2>R</h2>
401
+ <table style="width: 100%" class="indextable genindextable"><tr>
402
+ <td style="width: 33%; vertical-align: top;"><ul>
403
+ <li><a href="reference.html#request.makeApiRequest">request.makeApiRequest() (request method)</a>
404
+ </li>
405
+ </ul></td>
406
+ </tr></table>
407
+ </section>
408
+
409
+ <section id="S" class="genindex-section">
410
+ <h2>S</h2>
411
+ <table style="width: 100%" class="indextable genindextable"><tr>
412
+ <td style="width: 33%; vertical-align: top;"><ul>
413
+ <li><a href="reference.html#Stationary.calculate">Stationary.calculate() (Stationary method)</a>
414
+ </li>
415
+ <li><a href="reference.html#Stationary.getArea">Stationary.getArea() (Stationary method)</a>
416
+ </li>
417
+ </ul></td>
418
+ <td style="width: 33%; vertical-align: top;"><ul>
419
+ <li><a href="reference.html#Stationary.getTypes">Stationary.getTypes() (Stationary method)</a>
420
+ </li>
421
+ <li><a href="reference.html#Stationary.getUnits">Stationary.getUnits() (Stationary method)</a>
422
+ </li>
423
+ </ul></td>
424
+ </tr></table>
425
+ </section>
426
+
427
+ <section id="T" class="genindex-section">
428
+ <h2>T</h2>
429
+ <table style="width: 100%" class="indextable genindextable"><tr>
430
+ <td style="width: 33%; vertical-align: top;"><ul>
431
+ <li><a href="reference.html#TransportationAndDistribution.calculate">TransportationAndDistribution.calculate() (TransportationAndDistribution method)</a>
432
+ </li>
433
+ <li><a href="reference.html#TransportationAndDistribution.getArea">TransportationAndDistribution.getArea() (TransportationAndDistribution method)</a>
434
+ </li>
435
+ </ul></td>
436
+ <td style="width: 33%; vertical-align: top;"><ul>
437
+ <li><a href="reference.html#TransportationAndDistribution.getTypes">TransportationAndDistribution.getTypes() (TransportationAndDistribution method)</a>
438
+ </li>
439
+ <li><a href="reference.html#TransportationAndDistribution.getUnits">TransportationAndDistribution.getUnits() (TransportationAndDistribution method)</a>
440
+ </li>
441
+ </ul></td>
442
+ </tr></table>
443
+ </section>
444
+
445
+ <section id="U" class="genindex-section">
446
+ <h2>U</h2>
447
+ <table style="width: 100%" class="indextable genindextable"><tr>
448
+ <td style="width: 33%; vertical-align: top;"><ul>
449
+ <li><a href="reference.html#utils.findExpiryTime">utils.findExpiryTime() (utils method)</a>
450
+ </li>
451
+ </ul></td>
452
+ </tr></table>
453
+ </section>
454
+
455
+
456
+ </article>
457
+ </div>
458
+ <footer>
459
+
460
+ <div class="related-pages">
461
+
462
+
463
+ </div>
464
+ <div class="bottom-of-page">
465
+ <div class="left-details">
466
+ <div class="copyright">
467
+ Copyright &#169; 2025, IBM Corporation
468
+ </div>
469
+ Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
470
+
471
+ <a href="https://github.com/pradyunsg/furo">Furo</a>
472
+
473
+ </div>
474
+ <div class="right-details">
475
+
476
+ </div>
477
+ </div>
478
+
479
+ </footer>
480
+ </div>
481
+ <aside class="toc-drawer no-toc">
482
+
483
+
484
+
485
+ </aside>
486
+ </div>
487
+ </div><script src="_static/documentation_options.js?v=5929fcd5"></script>
488
+ <script src="_static/doctools.js?v=9bcbadda"></script>
489
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
490
+ <script src="_static/scripts/furo.js?v=46bd48cc"></script>
491
+ </body>
492
+ </html>