npm - emissions-api-sdk - Versions diffs - 1.0.1 → 1.0.2 - Mend

emissions-api-sdk 1.0.1 → 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 (106) hide show

package/dist/api/Calculation.js +4 -4
package/dist/api/Factor.js +7 -7
package/dist/api/FactorSets.js +1 -1
package/dist/api/Fugitive.js +4 -4
package/dist/api/Location.js +4 -4
package/dist/api/Mobile.js +4 -6
package/dist/api/Stationary.js +4 -4
package/dist/api/TransportationAndDistribution.js +5 -5
package/dist/coverage/clover.xml +335 -0
package/dist/coverage/coverage-final.json +19 -0
package/dist/coverage/lcov-report/base.css +224 -0
package/dist/coverage/lcov-report/block-navigation.js +87 -0
package/dist/coverage/lcov-report/favicon.png +0 -0
package/dist/coverage/lcov-report/index.html +161 -0
package/dist/coverage/lcov-report/prettify.css +1 -0
package/dist/coverage/lcov-report/prettify.js +2 -0
package/dist/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/dist/coverage/lcov-report/sorter.js +210 -0
package/dist/coverage/lcov-report/src/Client.ts.html +838 -0
package/dist/coverage/lcov-report/src/Constants.ts.html +208 -0
package/dist/coverage/lcov-report/src/api/Calculation.ts.html +436 -0
package/dist/coverage/lcov-report/src/api/Factor.ts.html +622 -0
package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +157 -0
package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +436 -0
package/dist/coverage/lcov-report/src/api/Location.ts.html +433 -0
package/dist/coverage/lcov-report/src/api/Mobile.ts.html +448 -0
package/dist/coverage/lcov-report/src/api/Stationary.ts.html +442 -0
package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +436 -0
package/dist/coverage/lcov-report/src/api/index.html +221 -0
package/dist/coverage/lcov-report/src/index.html +161 -0
package/dist/coverage/lcov-report/src/request.ts.html +235 -0
package/dist/coverage/lcov-report/src/utils.ts.html +139 -0
package/dist/coverage/lcov-report/test/index.html +116 -0
package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +142 -0
package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +133 -0
package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +142 -0
package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +139 -0
package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +142 -0
package/dist/coverage/lcov-report/test/mocks/index.html +176 -0
package/dist/coverage/lcov-report/test/testUtils.ts.html +97 -0
package/dist/coverage/lcov.info +558 -0
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/api/Calculation.d.ts +13 -8
package/dist/types/api/Factor.d.ts +18 -13
package/dist/types/api/FactorSets.d.ts +3 -2
package/dist/types/api/Fugitive.d.ts +13 -8
package/dist/types/api/Location.d.ts +13 -8
package/dist/types/api/Mobile.d.ts +13 -10
package/dist/types/api/Stationary.d.ts +13 -8
package/dist/types/api/TransportationAndDistribution.d.ts +14 -9
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/_sources/index.rst.txt +1 -0
package/docs/_sources/troubleshooting.rst.txt +486 -0
package/docs/_static/basic.css +8 -0
package/docs/_static/pygments.css +146 -164
package/docs/_static/searchtools.js +5 -8
package/docs/_static/styles/furo.css +1 -1
package/docs/_static/styles/furo.css.map +1 -1
package/docs/authentication.html +29 -19
package/docs/client.html +29 -19
package/docs/genindex.html +29 -19
package/docs/getting_started.html +29 -19
package/docs/index.html +42 -19
package/docs/objects.inv +0 -0
package/docs/reference.html +69 -53
package/docs/sdk.html +29 -19
package/docs/search.html +29 -19
package/docs/searchindex.js +1 -1
package/docs/troubleshooting.html +786 -0
package/package.json +1 -1
package/sphinx-build/requirements.txt +5 -0
package/sphinx-build/source/index.rst +1 -0
package/sphinx-build/source/troubleshooting.rst +486 -0
package/src/api/Calculation.ts +19 -14
package/src/api/Factor.ts +27 -22
package/src/api/FactorSets.ts +4 -3
package/src/api/Fugitive.ts +19 -14
package/src/api/Location.ts +20 -15
package/src/api/Mobile.ts +19 -16
package/src/api/Stationary.ts +19 -14
package/src/api/TransportationAndDistribution.ts +21 -16
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 +1 -1

package/dist/coverage/lcov-report/src/api/Location.ts.html ADDED Viewed

@@ -0,0 +1,433 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <title>Code coverage report for src/api/Location.ts</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="../../prettify.css" />
+    <link rel="stylesheet" href="../../base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(../../sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1><a href="../../index.html">All files</a> / <a href="index.html">src/api</a> Location.ts</h1>
+        <div class='clearfix'>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>19/19</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>0/0</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>4/4</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>19/19</span>
+            </div>
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line high'></div>
+    <pre><table class="coverage">
+<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
+<a name='L2'></a><a href='#L2'>2</a>
+<a name='L3'></a><a href='#L3'>3</a>
+<a name='L4'></a><a href='#L4'>4</a>
+<a name='L5'></a><a href='#L5'>5</a>
+<a name='L6'></a><a href='#L6'>6</a>
+<a name='L7'></a><a href='#L7'>7</a>
+<a name='L8'></a><a href='#L8'>8</a>
+<a name='L9'></a><a href='#L9'>9</a>
+<a name='L10'></a><a href='#L10'>10</a>
+<a name='L11'></a><a href='#L11'>11</a>
+<a name='L12'></a><a href='#L12'>12</a>
+<a name='L13'></a><a href='#L13'>13</a>
+<a name='L14'></a><a href='#L14'>14</a>
+<a name='L15'></a><a href='#L15'>15</a>
+<a name='L16'></a><a href='#L16'>16</a>
+<a name='L17'></a><a href='#L17'>17</a>
+<a name='L18'></a><a href='#L18'>18</a>
+<a name='L19'></a><a href='#L19'>19</a>
+<a name='L20'></a><a href='#L20'>20</a>
+<a name='L21'></a><a href='#L21'>21</a>
+<a name='L22'></a><a href='#L22'>22</a>
+<a name='L23'></a><a href='#L23'>23</a>
+<a name='L24'></a><a href='#L24'>24</a>
+<a name='L25'></a><a href='#L25'>25</a>
+<a name='L26'></a><a href='#L26'>26</a>
+<a name='L27'></a><a href='#L27'>27</a>
+<a name='L28'></a><a href='#L28'>28</a>
+<a name='L29'></a><a href='#L29'>29</a>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a>
+<a name='L36'></a><a href='#L36'>36</a>
+<a name='L37'></a><a href='#L37'>37</a>
+<a name='L38'></a><a href='#L38'>38</a>
+<a name='L39'></a><a href='#L39'>39</a>
+<a name='L40'></a><a href='#L40'>40</a>
+<a name='L41'></a><a href='#L41'>41</a>
+<a name='L42'></a><a href='#L42'>42</a>
+<a name='L43'></a><a href='#L43'>43</a>
+<a name='L44'></a><a href='#L44'>44</a>
+<a name='L45'></a><a href='#L45'>45</a>
+<a name='L46'></a><a href='#L46'>46</a>
+<a name='L47'></a><a href='#L47'>47</a>
+<a name='L48'></a><a href='#L48'>48</a>
+<a name='L49'></a><a href='#L49'>49</a>
+<a name='L50'></a><a href='#L50'>50</a>
+<a name='L51'></a><a href='#L51'>51</a>
+<a name='L52'></a><a href='#L52'>52</a>
+<a name='L53'></a><a href='#L53'>53</a>
+<a name='L54'></a><a href='#L54'>54</a>
+<a name='L55'></a><a href='#L55'>55</a>
+<a name='L56'></a><a href='#L56'>56</a>
+<a name='L57'></a><a href='#L57'>57</a>
+<a name='L58'></a><a href='#L58'>58</a>
+<a name='L59'></a><a href='#L59'>59</a>
+<a name='L60'></a><a href='#L60'>60</a>
+<a name='L61'></a><a href='#L61'>61</a>
+<a name='L62'></a><a href='#L62'>62</a>
+<a name='L63'></a><a href='#L63'>63</a>
+<a name='L64'></a><a href='#L64'>64</a>
+<a name='L65'></a><a href='#L65'>65</a>
+<a name='L66'></a><a href='#L66'>66</a>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a>
+<a name='L69'></a><a href='#L69'>69</a>
+<a name='L70'></a><a href='#L70'>70</a>
+<a name='L71'></a><a href='#L71'>71</a>
+<a name='L72'></a><a href='#L72'>72</a>
+<a name='L73'></a><a href='#L73'>73</a>
+<a name='L74'></a><a href='#L74'>74</a>
+<a name='L75'></a><a href='#L75'>75</a>
+<a name='L76'></a><a href='#L76'>76</a>
+<a name='L77'></a><a href='#L77'>77</a>
+<a name='L78'></a><a href='#L78'>78</a>
+<a name='L79'></a><a href='#L79'>79</a>
+<a name='L80'></a><a href='#L80'>80</a>
+<a name='L81'></a><a href='#L81'>81</a>
+<a name='L82'></a><a href='#L82'>82</a>
+<a name='L83'></a><a href='#L83'>83</a>
+<a name='L84'></a><a href='#L84'>84</a>
+<a name='L85'></a><a href='#L85'>85</a>
+<a name='L86'></a><a href='#L86'>86</a>
+<a name='L87'></a><a href='#L87'>87</a>
+<a name='L88'></a><a href='#L88'>88</a>
+<a name='L89'></a><a href='#L89'>89</a>
+<a name='L90'></a><a href='#L90'>90</a>
+<a name='L91'></a><a href='#L91'>91</a>
+<a name='L92'></a><a href='#L92'>92</a>
+<a name='L93'></a><a href='#L93'>93</a>
+<a name='L94'></a><a href='#L94'>94</a>
+<a name='L95'></a><a href='#L95'>95</a>
+<a name='L96'></a><a href='#L96'>96</a>
+<a name='L97'></a><a href='#L97'>97</a>
+<a name='L98'></a><a href='#L98'>98</a>
+<a name='L99'></a><a href='#L99'>99</a>
+<a name='L100'></a><a href='#L100'>100</a>
+<a name='L101'></a><a href='#L101'>101</a>
+<a name='L102'></a><a href='#L102'>102</a>
+<a name='L103'></a><a href='#L103'>103</a>
+<a name='L104'></a><a href='#L104'>104</a>
+<a name='L105'></a><a href='#L105'>105</a>
+<a name='L106'></a><a href='#L106'>106</a>
+<a name='L107'></a><a href='#L107'>107</a>
+<a name='L108'></a><a href='#L108'>108</a>
+<a name='L109'></a><a href='#L109'>109</a>
+<a name='L110'></a><a href='#L110'>110</a>
+<a name='L111'></a><a href='#L111'>111</a>
+<a name='L112'></a><a href='#L112'>112</a>
+<a name='L113'></a><a href='#L113'>113</a>
+<a name='L114'></a><a href='#L114'>114</a>
+<a name='L115'></a><a href='#L115'>115</a>
+<a name='L116'></a><a href='#L116'>116</a>
+<a name='L117'></a><a href='#L117'>117</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Client } from "../Client";
+import { GET, LOCATION_API_AREA, LOCATION_API_PATH, LOCATION_API_UNITS, LOCATION_TYPES, POST } from "../Constants";
+import { LocationRequest } from "../interfaces/Api";
+import { AreaResponse } from "../interfaces/response/AreaResponse";
+import { EmissionResponse } from "../interfaces/response/EmissionResponse";
+import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
+import { TypeResponse } from "../interfaces/response/TypeResponse";
+import { UnitResponse } from "../interfaces/response/UnitResponse";
+import { makeApiRequest } from "../request";
+&nbsp;
+/**
+ * Performs scope 2 purchased energy Emission calculations by making a POST request to the location API endpoint.
+ *
+ * @export
+ * @param {LocationRequest} payload - The location request data to be sent to the API
+ * @return {Promise&lt;EmissionResponse | EmissionResponseWithDetails&gt;} A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const calculationRequest = {
+    "time" : {
+      "date": "2025-01-04"
+    },
+    "location": {
+      "country": "usa",
+      "stateProvince": "new york"
+    },
+    "activity": {
+      "type":"electricity",
+      "unit": "kwh",
+      "value": 14123143
+    },
+    "includeDetails": true
+  };
+ * const result = await calculate(calculationRequest);
+ */
+export async function calculate(
+  payload: LocationRequest
+): Promise&lt;EmissionResponse | EmissionResponseWithDetails&gt; {
+  const client = Client.getInstance();
+  const url = client.getDomain() + LOCATION_API_PATH;
+&nbsp;
+  return makeApiRequest&lt;EmissionResponse | EmissionResponseWithDetails&gt;({
+    method: POST,
+    url,
+    data: payload,
+  });
+}
+&nbsp;
+&nbsp;
+/**
+ * Retrieves available location-based calculation types by making a GET request to the location types API endpoint.
+ *
+ * @export
+ * @return {Promise&lt;TypeResponse&gt;} A promise that resolves to a TypeResponse containing the available location-based calculation types
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ *
+ * const types = await getTypes();
+ */
+export async function getTypes(
+): Promise&lt;TypeResponse&gt; {
+  const client = Client.getInstance();
+  const url = client.getDomain() + LOCATION_TYPES;
+&nbsp;
+  return makeApiRequest&lt;TypeResponse&gt;({
+    method: GET,
+    url
+  });
+}
+&nbsp;
+/**
+ * Retrieves information about geographical areas supported by the location-based calculation API.
+ *
+ * @export
+ * @return {Promise&lt;AreaResponse&gt;} A promise that resolves to an AreaResponse containing the supported geographical areas
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const areas = await getArea();
+ */
+export async function getArea(
+): Promise&lt;AreaResponse&gt; {
+  const client = Client.getInstance();
+  const url = client.getDomain() + LOCATION_API_AREA;
+&nbsp;
+  return makeApiRequest&lt;AreaResponse&gt;({
+    method: GET,
+    url
+  });
+}
+&nbsp;
+/**
+ * Retrieves available units for a specific location-based calculation type.
+ *
+ * @export
+ * @param {string} type - The location-based calculation type to get units for (e.g., "electricity")
+ * @return {Promise&lt;UnitResponse&gt;} A promise that resolves to a UnitResponse containing the available units
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get units for the "electricity" location type
+ * const units = await getUnits("electricity");
+ */
+export async function getUnits(
+  type : string
+): Promise&lt;UnitResponse&gt; {
+  const client = Client.getInstance();
+  const url = client.getDomain() + LOCATION_API_UNITS;
+&nbsp;
+  return makeApiRequest&lt;UnitResponse&gt;({
+    method: GET,
+    url,
+    params : { type }
+  });
+}</pre></td></tr></table></pre>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <div class='footer quiet pad2 space-top1 center small'>
+                Code coverage generated by
+                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
+                at 2025-12-11T17:06:20.018Z
+            </div>
+        <script src="../../prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="../../sorter.js"></script>
+        <script src="../../block-navigation.js"></script>
+    </body>
+</html>