emissions-api-sdk 1.0.10 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +135 -6
  2. package/dist/Constants.js +1 -1
  3. package/dist/api/Factor.js +53 -1
  4. package/dist/api/TypeRecommender.js +48 -0
  5. package/dist/coverage/clover.xml +17 -14
  6. package/dist/coverage/coverage-final.json +4 -4
  7. package/dist/coverage/lcov-report/index.html +7 -7
  8. package/dist/coverage/lcov-report/src/Client.ts.html +1 -1
  9. package/dist/coverage/lcov-report/src/Constants.ts.html +2 -2
  10. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
  11. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +1 -1
  12. package/dist/coverage/lcov-report/src/api/Factor.ts.html +159 -3
  13. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  14. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
  15. package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
  16. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
  17. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
  18. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +1 -1
  19. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
  20. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
  21. package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +146 -2
  22. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  23. package/dist/coverage/lcov-report/src/api/index.html +1 -1
  24. package/dist/coverage/lcov-report/src/index.html +1 -1
  25. package/dist/coverage/lcov-report/src/request.ts.html +1 -1
  26. package/dist/coverage/lcov-report/src/utils.ts.html +1 -1
  27. package/dist/coverage/lcov-report/test/index.html +1 -1
  28. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  29. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  30. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  31. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  32. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +148 -4
  33. package/dist/coverage/lcov-report/test/mocks/index.html +5 -5
  34. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  35. package/dist/coverage/lcov.info +16 -13
  36. package/dist/types/Constants.d.ts +1 -1
  37. package/dist/types/api/Factor.d.ts +53 -1
  38. package/dist/types/api/TypeRecommender.d.ts +48 -0
  39. package/dist/types/interfaces/common.d.ts +8 -0
  40. package/docs/_static/base-stemmer.js +476 -0
  41. package/docs/_static/basic.css +0 -8
  42. package/docs/_static/doctools.js +6 -5
  43. package/docs/_static/english-stemmer.js +1066 -0
  44. package/docs/_static/language_data.js +7 -186
  45. package/docs/_static/pygments.css +164 -146
  46. package/docs/_static/searchtools.js +121 -60
  47. package/docs/_static/sphinx_highlight.js +36 -31
  48. package/docs/_static/styles/furo.css +1 -1
  49. package/docs/_static/styles/furo.css.map +1 -1
  50. package/docs/authentication.html +21 -30
  51. package/docs/client.html +21 -30
  52. package/docs/genindex.html +21 -30
  53. package/docs/getting_started.html +21 -30
  54. package/docs/index.html +21 -30
  55. package/docs/reference.html +63 -72
  56. package/docs/sdk.html +21 -30
  57. package/docs/search.html +21 -30
  58. package/docs/searchindex.js +1 -1
  59. package/docs/troubleshooting.html +21 -30
  60. package/package.json +1 -1
  61. package/src/Constants.ts +1 -1
  62. package/src/api/Factor.ts +53 -1
  63. package/src/api/TypeRecommender.ts +48 -0
  64. package/src/interfaces/common.ts +12 -0
  65. package/test/mocks/SearchRequest.ts +48 -0
@@ -117,7 +117,7 @@
117
117
  <span class="cline-any cline-yes">5x</span>
118
118
  <span class="cline-any cline-yes">5x</span>
119
119
  <span class="cline-any cline-yes">5x</span>
120
- <span class="cline-any cline-yes">5x</span></td><td class="text"><pre class="prettyprint lang-js">export const API_DOMAIN = "https://api.ibm.com/ghgemissions/run";
120
+ <span class="cline-any cline-yes">5x</span></td><td class="text"><pre class="prettyprint lang-js">export const API_DOMAIN = "https://api.envizi.ibm.com/ghgemissions/run";
121
121
  export const TOKEN_GENERATION_API = "https://api.ibm.com/saascore/run/authentication-retrieve/api-key";
122
122
  export const PAT_TOKEN_EXCHANGE_API = "https://api.ibm.com/saascore/run/envizi-auth/exchange";
123
123
  export const MOBILE_API_PATH = "/v3/carbon/mobile";
@@ -151,7 +151,7 @@ export const CLIENT_SOURCE_SDK = "node-sdk";</pre></td></tr></table></pre>
151
151
  <div class='footer quiet pad2 space-top1 center small'>
152
152
  Code coverage generated by
153
153
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
154
- at 2026-04-28T12:54:24.682Z
154
+ at 2026-05-11T08:42:18.203Z
155
155
  </div>
156
156
  <script src="../prettify.js"></script>
157
157
  <script>
@@ -211,7 +211,7 @@ export async function calculate(
211
211
  <div class='footer quiet pad2 space-top1 center small'>
212
212
  Code coverage generated by
213
213
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
214
- at 2026-04-28T12:54:24.682Z
214
+ at 2026-05-11T08:42:18.203Z
215
215
  </div>
216
216
  <script src="../../prettify.js"></script>
217
217
  <script>
@@ -205,7 +205,7 @@ export async function calculate(
205
205
  <div class='footer quiet pad2 space-top1 center small'>
206
206
  Code coverage generated by
207
207
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
208
- at 2026-04-28T12:54:24.682Z
208
+ at 2026-05-11T08:42:18.203Z
209
209
  </div>
210
210
  <script src="../../prettify.js"></script>
211
211
  <script>
@@ -149,7 +149,59 @@
149
149
  <a name='L84'></a><a href='#L84'>84</a>
150
150
  <a name='L85'></a><a href='#L85'>85</a>
151
151
  <a name='L86'></a><a href='#L86'>86</a>
152
- <a name='L87'></a><a href='#L87'>87</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
152
+ <a name='L87'></a><a href='#L87'>87</a>
153
+ <a name='L88'></a><a href='#L88'>88</a>
154
+ <a name='L89'></a><a href='#L89'>89</a>
155
+ <a name='L90'></a><a href='#L90'>90</a>
156
+ <a name='L91'></a><a href='#L91'>91</a>
157
+ <a name='L92'></a><a href='#L92'>92</a>
158
+ <a name='L93'></a><a href='#L93'>93</a>
159
+ <a name='L94'></a><a href='#L94'>94</a>
160
+ <a name='L95'></a><a href='#L95'>95</a>
161
+ <a name='L96'></a><a href='#L96'>96</a>
162
+ <a name='L97'></a><a href='#L97'>97</a>
163
+ <a name='L98'></a><a href='#L98'>98</a>
164
+ <a name='L99'></a><a href='#L99'>99</a>
165
+ <a name='L100'></a><a href='#L100'>100</a>
166
+ <a name='L101'></a><a href='#L101'>101</a>
167
+ <a name='L102'></a><a href='#L102'>102</a>
168
+ <a name='L103'></a><a href='#L103'>103</a>
169
+ <a name='L104'></a><a href='#L104'>104</a>
170
+ <a name='L105'></a><a href='#L105'>105</a>
171
+ <a name='L106'></a><a href='#L106'>106</a>
172
+ <a name='L107'></a><a href='#L107'>107</a>
173
+ <a name='L108'></a><a href='#L108'>108</a>
174
+ <a name='L109'></a><a href='#L109'>109</a>
175
+ <a name='L110'></a><a href='#L110'>110</a>
176
+ <a name='L111'></a><a href='#L111'>111</a>
177
+ <a name='L112'></a><a href='#L112'>112</a>
178
+ <a name='L113'></a><a href='#L113'>113</a>
179
+ <a name='L114'></a><a href='#L114'>114</a>
180
+ <a name='L115'></a><a href='#L115'>115</a>
181
+ <a name='L116'></a><a href='#L116'>116</a>
182
+ <a name='L117'></a><a href='#L117'>117</a>
183
+ <a name='L118'></a><a href='#L118'>118</a>
184
+ <a name='L119'></a><a href='#L119'>119</a>
185
+ <a name='L120'></a><a href='#L120'>120</a>
186
+ <a name='L121'></a><a href='#L121'>121</a>
187
+ <a name='L122'></a><a href='#L122'>122</a>
188
+ <a name='L123'></a><a href='#L123'>123</a>
189
+ <a name='L124'></a><a href='#L124'>124</a>
190
+ <a name='L125'></a><a href='#L125'>125</a>
191
+ <a name='L126'></a><a href='#L126'>126</a>
192
+ <a name='L127'></a><a href='#L127'>127</a>
193
+ <a name='L128'></a><a href='#L128'>128</a>
194
+ <a name='L129'></a><a href='#L129'>129</a>
195
+ <a name='L130'></a><a href='#L130'>130</a>
196
+ <a name='L131'></a><a href='#L131'>131</a>
197
+ <a name='L132'></a><a href='#L132'>132</a>
198
+ <a name='L133'></a><a href='#L133'>133</a>
199
+ <a name='L134'></a><a href='#L134'>134</a>
200
+ <a name='L135'></a><a href='#L135'>135</a>
201
+ <a name='L136'></a><a href='#L136'>136</a>
202
+ <a name='L137'></a><a href='#L137'>137</a>
203
+ <a name='L138'></a><a href='#L138'>138</a>
204
+ <a name='L139'></a><a href='#L139'>139</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
153
205
  <span class="cline-any cline-yes">1x</span>
154
206
  <span class="cline-any cline-neutral">&nbsp;</span>
155
207
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -224,6 +276,58 @@
224
276
  <span class="cline-any cline-neutral">&nbsp;</span>
225
277
  <span class="cline-any cline-neutral">&nbsp;</span>
226
278
  <span class="cline-any cline-neutral">&nbsp;</span>
279
+ <span class="cline-any cline-neutral">&nbsp;</span>
280
+ <span class="cline-any cline-neutral">&nbsp;</span>
281
+ <span class="cline-any cline-neutral">&nbsp;</span>
282
+ <span class="cline-any cline-neutral">&nbsp;</span>
283
+ <span class="cline-any cline-neutral">&nbsp;</span>
284
+ <span class="cline-any cline-neutral">&nbsp;</span>
285
+ <span class="cline-any cline-neutral">&nbsp;</span>
286
+ <span class="cline-any cline-neutral">&nbsp;</span>
287
+ <span class="cline-any cline-neutral">&nbsp;</span>
288
+ <span class="cline-any cline-neutral">&nbsp;</span>
289
+ <span class="cline-any cline-neutral">&nbsp;</span>
290
+ <span class="cline-any cline-neutral">&nbsp;</span>
291
+ <span class="cline-any cline-neutral">&nbsp;</span>
292
+ <span class="cline-any cline-neutral">&nbsp;</span>
293
+ <span class="cline-any cline-neutral">&nbsp;</span>
294
+ <span class="cline-any cline-neutral">&nbsp;</span>
295
+ <span class="cline-any cline-neutral">&nbsp;</span>
296
+ <span class="cline-any cline-neutral">&nbsp;</span>
297
+ <span class="cline-any cline-neutral">&nbsp;</span>
298
+ <span class="cline-any cline-neutral">&nbsp;</span>
299
+ <span class="cline-any cline-neutral">&nbsp;</span>
300
+ <span class="cline-any cline-neutral">&nbsp;</span>
301
+ <span class="cline-any cline-neutral">&nbsp;</span>
302
+ <span class="cline-any cline-neutral">&nbsp;</span>
303
+ <span class="cline-any cline-neutral">&nbsp;</span>
304
+ <span class="cline-any cline-neutral">&nbsp;</span>
305
+ <span class="cline-any cline-neutral">&nbsp;</span>
306
+ <span class="cline-any cline-neutral">&nbsp;</span>
307
+ <span class="cline-any cline-neutral">&nbsp;</span>
308
+ <span class="cline-any cline-neutral">&nbsp;</span>
309
+ <span class="cline-any cline-neutral">&nbsp;</span>
310
+ <span class="cline-any cline-neutral">&nbsp;</span>
311
+ <span class="cline-any cline-neutral">&nbsp;</span>
312
+ <span class="cline-any cline-neutral">&nbsp;</span>
313
+ <span class="cline-any cline-neutral">&nbsp;</span>
314
+ <span class="cline-any cline-neutral">&nbsp;</span>
315
+ <span class="cline-any cline-neutral">&nbsp;</span>
316
+ <span class="cline-any cline-neutral">&nbsp;</span>
317
+ <span class="cline-any cline-neutral">&nbsp;</span>
318
+ <span class="cline-any cline-neutral">&nbsp;</span>
319
+ <span class="cline-any cline-neutral">&nbsp;</span>
320
+ <span class="cline-any cline-neutral">&nbsp;</span>
321
+ <span class="cline-any cline-neutral">&nbsp;</span>
322
+ <span class="cline-any cline-neutral">&nbsp;</span>
323
+ <span class="cline-any cline-neutral">&nbsp;</span>
324
+ <span class="cline-any cline-neutral">&nbsp;</span>
325
+ <span class="cline-any cline-neutral">&nbsp;</span>
326
+ <span class="cline-any cline-neutral">&nbsp;</span>
327
+ <span class="cline-any cline-neutral">&nbsp;</span>
328
+ <span class="cline-any cline-neutral">&nbsp;</span>
329
+ <span class="cline-any cline-neutral">&nbsp;</span>
330
+ <span class="cline-any cline-neutral">&nbsp;</span>
227
331
  <span class="cline-any cline-yes">1x</span>
228
332
  <span class="cline-any cline-neutral">&nbsp;</span>
229
333
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -298,17 +402,69 @@ export async function retrieveFactor(
298
402
  * @throws {Error} May throw an error if the API request fails
299
403
  *
300
404
  * @example
405
+ * // Basic search
301
406
  * const searchRequest = {
302
407
  "time":{
303
408
  "date": "2020-06-10"
304
409
  },
305
410
  "activity": {
306
- "search" : "travel"},
411
+ "search" : "travel"
412
+ },
307
413
  "location": {
308
414
  "country": "USA"
309
415
  }
310
416
  };
311
417
  * const results = await search(searchRequest);
418
+ *
419
+ * @example
420
+ * // Search with optional unit parameter
421
+ * const searchWithUnit = {
422
+ "time":{
423
+ "date": "2020-06-10"
424
+ },
425
+ "activity": {
426
+ "search": "electricity",
427
+ "unit": "kWh"
428
+ },
429
+ "location": {
430
+ "country": "USA"
431
+ }
432
+ };
433
+ * const results = await search(searchWithUnit);
434
+ *
435
+ * @example
436
+ * // Search with optional scope parameter
437
+ * const searchWithScope = {
438
+ "time":{
439
+ "date": "2020-06-10"
440
+ },
441
+ "activity": {
442
+ "search": "natural gas",
443
+ "scope": "1"
444
+ },
445
+ "location": {
446
+ "country": "USA"
447
+ }
448
+ };
449
+ * const results = await search(searchWithScope);
450
+ *
451
+ * @example
452
+ * // Search with both unit and scope parameters
453
+ * const searchWithBoth = {
454
+ "time":{
455
+ "date": "2020-06-10"
456
+ },
457
+ "activity": {
458
+ "search": "electricity",
459
+ "unit": "MWh",
460
+ "scope": "2"
461
+ },
462
+ "location": {
463
+ "country": "USA",
464
+ "stateProvince": "california"
465
+ }
466
+ };
467
+ * const results = await search(searchWithBoth);
312
468
  */
313
469
  export async function search(
314
470
  payload: SearchRequest
@@ -328,7 +484,7 @@ export async function search(
328
484
  <div class='footer quiet pad2 space-top1 center small'>
329
485
  Code coverage generated by
330
486
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
331
- at 2026-04-28T12:54:24.682Z
487
+ at 2026-05-11T08:42:18.203Z
332
488
  </div>
333
489
  <script src="../../prettify.js"></script>
334
490
  <script>
@@ -142,7 +142,7 @@ const client = Client.getInstance();
142
142
  <div class='footer quiet pad2 space-top1 center small'>
143
143
  Code coverage generated by
144
144
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
145
- at 2026-04-28T12:54:24.682Z
145
+ at 2026-05-11T08:42:18.203Z
146
146
  </div>
147
147
  <script src="../../prettify.js"></script>
148
148
  <script>
@@ -205,7 +205,7 @@ export async function calculate(
205
205
  <div class='footer quiet pad2 space-top1 center small'>
206
206
  Code coverage generated by
207
207
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
208
- at 2026-04-28T12:54:24.682Z
208
+ at 2026-05-11T08:42:18.203Z
209
209
  </div>
210
210
  <script src="../../prettify.js"></script>
211
211
  <script>
@@ -202,7 +202,7 @@ export async function calculate(
202
202
  <div class='footer quiet pad2 space-top1 center small'>
203
203
  Code coverage generated by
204
204
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
205
- at 2026-04-28T12:54:24.682Z
205
+ at 2026-05-11T08:42:18.203Z
206
206
  </div>
207
207
  <script src="../../prettify.js"></script>
208
208
  <script>
@@ -589,7 +589,7 @@ export async function postUnits(
589
589
  <div class='footer quiet pad2 space-top1 center small'>
590
590
  Code coverage generated by
591
591
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
592
- at 2026-04-28T12:54:24.682Z
592
+ at 2026-05-11T08:42:18.203Z
593
593
  </div>
594
594
  <script src="../../prettify.js"></script>
595
595
  <script>
@@ -208,7 +208,7 @@ export async function calculate(
208
208
  <div class='footer quiet pad2 space-top1 center small'>
209
209
  Code coverage generated by
210
210
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
211
- at 2026-04-28T12:54:24.682Z
211
+ at 2026-05-11T08:42:18.203Z
212
212
  </div>
213
213
  <script src="../../prettify.js"></script>
214
214
  <script>
@@ -202,7 +202,7 @@ export async function calculate(
202
202
  <div class='footer quiet pad2 space-top1 center small'>
203
203
  Code coverage generated by
204
204
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
205
- at 2026-04-28T12:54:24.682Z
205
+ at 2026-05-11T08:42:18.203Z
206
206
  </div>
207
207
  <script src="../../prettify.js"></script>
208
208
  <script>
@@ -208,7 +208,7 @@ export async function calculate(
208
208
  <div class='footer quiet pad2 space-top1 center small'>
209
209
  Code coverage generated by
210
210
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
211
- at 2026-04-28T12:54:24.682Z
211
+ at 2026-05-11T08:42:18.203Z
212
212
  </div>
213
213
  <script src="../../prettify.js"></script>
214
214
  <script>
@@ -205,7 +205,7 @@ export async function calculate(
205
205
  <div class='footer quiet pad2 space-top1 center small'>
206
206
  Code coverage generated by
207
207
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
208
- at 2026-04-28T12:54:24.682Z
208
+ at 2026-05-11T08:42:18.203Z
209
209
  </div>
210
210
  <script src="../../prettify.js"></script>
211
211
  <script>
@@ -127,7 +127,55 @@
127
127
  <a name='L62'></a><a href='#L62'>62</a>
128
128
  <a name='L63'></a><a href='#L63'>63</a>
129
129
  <a name='L64'></a><a href='#L64'>64</a>
130
- <a name='L65'></a><a href='#L65'>65</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
130
+ <a name='L65'></a><a href='#L65'>65</a>
131
+ <a name='L66'></a><a href='#L66'>66</a>
132
+ <a name='L67'></a><a href='#L67'>67</a>
133
+ <a name='L68'></a><a href='#L68'>68</a>
134
+ <a name='L69'></a><a href='#L69'>69</a>
135
+ <a name='L70'></a><a href='#L70'>70</a>
136
+ <a name='L71'></a><a href='#L71'>71</a>
137
+ <a name='L72'></a><a href='#L72'>72</a>
138
+ <a name='L73'></a><a href='#L73'>73</a>
139
+ <a name='L74'></a><a href='#L74'>74</a>
140
+ <a name='L75'></a><a href='#L75'>75</a>
141
+ <a name='L76'></a><a href='#L76'>76</a>
142
+ <a name='L77'></a><a href='#L77'>77</a>
143
+ <a name='L78'></a><a href='#L78'>78</a>
144
+ <a name='L79'></a><a href='#L79'>79</a>
145
+ <a name='L80'></a><a href='#L80'>80</a>
146
+ <a name='L81'></a><a href='#L81'>81</a>
147
+ <a name='L82'></a><a href='#L82'>82</a>
148
+ <a name='L83'></a><a href='#L83'>83</a>
149
+ <a name='L84'></a><a href='#L84'>84</a>
150
+ <a name='L85'></a><a href='#L85'>85</a>
151
+ <a name='L86'></a><a href='#L86'>86</a>
152
+ <a name='L87'></a><a href='#L87'>87</a>
153
+ <a name='L88'></a><a href='#L88'>88</a>
154
+ <a name='L89'></a><a href='#L89'>89</a>
155
+ <a name='L90'></a><a href='#L90'>90</a>
156
+ <a name='L91'></a><a href='#L91'>91</a>
157
+ <a name='L92'></a><a href='#L92'>92</a>
158
+ <a name='L93'></a><a href='#L93'>93</a>
159
+ <a name='L94'></a><a href='#L94'>94</a>
160
+ <a name='L95'></a><a href='#L95'>95</a>
161
+ <a name='L96'></a><a href='#L96'>96</a>
162
+ <a name='L97'></a><a href='#L97'>97</a>
163
+ <a name='L98'></a><a href='#L98'>98</a>
164
+ <a name='L99'></a><a href='#L99'>99</a>
165
+ <a name='L100'></a><a href='#L100'>100</a>
166
+ <a name='L101'></a><a href='#L101'>101</a>
167
+ <a name='L102'></a><a href='#L102'>102</a>
168
+ <a name='L103'></a><a href='#L103'>103</a>
169
+ <a name='L104'></a><a href='#L104'>104</a>
170
+ <a name='L105'></a><a href='#L105'>105</a>
171
+ <a name='L106'></a><a href='#L106'>106</a>
172
+ <a name='L107'></a><a href='#L107'>107</a>
173
+ <a name='L108'></a><a href='#L108'>108</a>
174
+ <a name='L109'></a><a href='#L109'>109</a>
175
+ <a name='L110'></a><a href='#L110'>110</a>
176
+ <a name='L111'></a><a href='#L111'>111</a>
177
+ <a name='L112'></a><a href='#L112'>112</a>
178
+ <a name='L113'></a><a href='#L113'>113</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
131
179
  <span class="cline-any cline-yes">1x</span>
132
180
  <span class="cline-any cline-neutral">&nbsp;</span>
133
181
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -180,6 +228,54 @@
180
228
  <span class="cline-any cline-neutral">&nbsp;</span>
181
229
  <span class="cline-any cline-neutral">&nbsp;</span>
182
230
  <span class="cline-any cline-neutral">&nbsp;</span>
231
+ <span class="cline-any cline-neutral">&nbsp;</span>
232
+ <span class="cline-any cline-neutral">&nbsp;</span>
233
+ <span class="cline-any cline-neutral">&nbsp;</span>
234
+ <span class="cline-any cline-neutral">&nbsp;</span>
235
+ <span class="cline-any cline-neutral">&nbsp;</span>
236
+ <span class="cline-any cline-neutral">&nbsp;</span>
237
+ <span class="cline-any cline-neutral">&nbsp;</span>
238
+ <span class="cline-any cline-neutral">&nbsp;</span>
239
+ <span class="cline-any cline-neutral">&nbsp;</span>
240
+ <span class="cline-any cline-neutral">&nbsp;</span>
241
+ <span class="cline-any cline-neutral">&nbsp;</span>
242
+ <span class="cline-any cline-neutral">&nbsp;</span>
243
+ <span class="cline-any cline-neutral">&nbsp;</span>
244
+ <span class="cline-any cline-neutral">&nbsp;</span>
245
+ <span class="cline-any cline-neutral">&nbsp;</span>
246
+ <span class="cline-any cline-neutral">&nbsp;</span>
247
+ <span class="cline-any cline-neutral">&nbsp;</span>
248
+ <span class="cline-any cline-neutral">&nbsp;</span>
249
+ <span class="cline-any cline-neutral">&nbsp;</span>
250
+ <span class="cline-any cline-neutral">&nbsp;</span>
251
+ <span class="cline-any cline-neutral">&nbsp;</span>
252
+ <span class="cline-any cline-neutral">&nbsp;</span>
253
+ <span class="cline-any cline-neutral">&nbsp;</span>
254
+ <span class="cline-any cline-neutral">&nbsp;</span>
255
+ <span class="cline-any cline-neutral">&nbsp;</span>
256
+ <span class="cline-any cline-neutral">&nbsp;</span>
257
+ <span class="cline-any cline-neutral">&nbsp;</span>
258
+ <span class="cline-any cline-neutral">&nbsp;</span>
259
+ <span class="cline-any cline-neutral">&nbsp;</span>
260
+ <span class="cline-any cline-neutral">&nbsp;</span>
261
+ <span class="cline-any cline-neutral">&nbsp;</span>
262
+ <span class="cline-any cline-neutral">&nbsp;</span>
263
+ <span class="cline-any cline-neutral">&nbsp;</span>
264
+ <span class="cline-any cline-neutral">&nbsp;</span>
265
+ <span class="cline-any cline-neutral">&nbsp;</span>
266
+ <span class="cline-any cline-neutral">&nbsp;</span>
267
+ <span class="cline-any cline-neutral">&nbsp;</span>
268
+ <span class="cline-any cline-neutral">&nbsp;</span>
269
+ <span class="cline-any cline-neutral">&nbsp;</span>
270
+ <span class="cline-any cline-neutral">&nbsp;</span>
271
+ <span class="cline-any cline-neutral">&nbsp;</span>
272
+ <span class="cline-any cline-neutral">&nbsp;</span>
273
+ <span class="cline-any cline-neutral">&nbsp;</span>
274
+ <span class="cline-any cline-neutral">&nbsp;</span>
275
+ <span class="cline-any cline-neutral">&nbsp;</span>
276
+ <span class="cline-any cline-neutral">&nbsp;</span>
277
+ <span class="cline-any cline-neutral">&nbsp;</span>
278
+ <span class="cline-any cline-neutral">&nbsp;</span>
183
279
  <span class="cline-any cline-yes">1x</span>
184
280
  <span class="cline-any cline-neutral">&nbsp;</span>
185
281
  <span class="cline-any cline-neutral">&nbsp;</span>
@@ -206,6 +302,7 @@ import { makeApiRequest } from "../request";
206
302
  * @throws {Error} May throw an error if the API request fails
207
303
  *
208
304
  * @example
305
+ * // Basic search
209
306
  * const result = await search({
210
307
  "location": {
211
308
  "country": "usa"
@@ -216,6 +313,7 @@ import { makeApiRequest } from "../request";
216
313
  });
217
314
  &nbsp;
218
315
  * @example
316
+ * // Search with time and pagination
219
317
  * const result = await search({
220
318
  "location": {
221
319
  "country": "usa",
@@ -234,6 +332,7 @@ import { makeApiRequest } from "../request";
234
332
  });
235
333
 
236
334
  * @example
335
+ * // Search with power grid
237
336
  * const result = await search({
238
337
  "location": {
239
338
  "country": "usa",
@@ -243,6 +342,51 @@ import { makeApiRequest } from "../request";
243
342
  "search": "renewable energy"
244
343
  }
245
344
  });
345
+ *
346
+ * @example
347
+ * // Search with optional unit parameter
348
+ * const result = await search({
349
+ "location": {
350
+ "country": "usa"
351
+ },
352
+ "activity": {
353
+ "search": "electricity",
354
+ "unit": "kWh"
355
+ }
356
+ });
357
+ *
358
+ * @example
359
+ * // Search with optional scope parameter
360
+ * const result = await search({
361
+ "location": {
362
+ "country": "usa"
363
+ },
364
+ "activity": {
365
+ "search": "natural gas",
366
+ "scope": "1"
367
+ }
368
+ });
369
+ *
370
+ * @example
371
+ * // Search with both unit and scope parameters
372
+ * const result = await search({
373
+ "location": {
374
+ "country": "usa",
375
+ "stateProvince": "california"
376
+ },
377
+ "time": {
378
+ "date": "2025-06-10"
379
+ },
380
+ "activity": {
381
+ "search": "electricity",
382
+ "unit": "MWh",
383
+ "scope": "2"
384
+ },
385
+ "pagination": {
386
+ "page": 1,
387
+ "size": 10
388
+ }
389
+ });
246
390
  */
247
391
  export async function search(
248
392
  payload: SearchRequest
@@ -262,7 +406,7 @@ export async function search(
262
406
  <div class='footer quiet pad2 space-top1 center small'>
263
407
  Code coverage generated by
264
408
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
265
- at 2026-04-28T12:54:24.682Z
409
+ at 2026-05-11T08:42:18.203Z
266
410
  </div>
267
411
  <script src="../../prettify.js"></script>
268
412
  <script>
@@ -145,7 +145,7 @@ export async function getUsage(history : boolean = <span class="branch-0 cbranch
145
145
  <div class='footer quiet pad2 space-top1 center small'>
146
146
  Code coverage generated by
147
147
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
148
- at 2026-04-28T12:54:24.682Z
148
+ at 2026-05-11T08:42:18.203Z
149
149
  </div>
150
150
  <script src="../../prettify.js"></script>
151
151
  <script>
@@ -281,7 +281,7 @@
281
281
  <div class='footer quiet pad2 space-top1 center small'>
282
282
  Code coverage generated by
283
283
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
284
- at 2026-04-28T12:54:24.682Z
284
+ at 2026-05-11T08:42:18.203Z
285
285
  </div>
286
286
  <script src="../../prettify.js"></script>
287
287
  <script>
@@ -146,7 +146,7 @@
146
146
  <div class='footer quiet pad2 space-top1 center small'>
147
147
  Code coverage generated by
148
148
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
149
- at 2026-04-28T12:54:24.682Z
149
+ at 2026-05-11T08:42:18.203Z
150
150
  </div>
151
151
  <script src="../prettify.js"></script>
152
152
  <script>
@@ -220,7 +220,7 @@ export async function makeApiRequest&lt;T&gt;(config: RequestConfig): Promise&lt
220
220
  <div class='footer quiet pad2 space-top1 center small'>
221
221
  Code coverage generated by
222
222
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
223
- at 2026-04-28T12:54:24.682Z
223
+ at 2026-05-11T08:42:18.203Z
224
224
  </div>
225
225
  <script src="../prettify.js"></script>
226
226
  <script>
@@ -124,7 +124,7 @@ export function findExpiryTime(token: string): any {
124
124
  <div class='footer quiet pad2 space-top1 center small'>
125
125
  Code coverage generated by
126
126
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
127
- at 2026-04-28T12:54:24.682Z
127
+ at 2026-05-11T08:42:18.203Z
128
128
  </div>
129
129
  <script src="../prettify.js"></script>
130
130
  <script>
@@ -101,7 +101,7 @@
101
101
  <div class='footer quiet pad2 space-top1 center small'>
102
102
  Code coverage generated by
103
103
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
104
- at 2026-04-28T12:54:24.682Z
104
+ at 2026-05-11T08:42:18.203Z
105
105
  </div>
106
106
  <script src="../prettify.js"></script>
107
107
  <script>
@@ -127,7 +127,7 @@ export default commonPayload;
127
127
  <div class='footer quiet pad2 space-top1 center small'>
128
128
  Code coverage generated by
129
129
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
130
- at 2026-04-28T12:54:24.682Z
130
+ at 2026-05-11T08:42:18.203Z
131
131
  </div>
132
132
  <script src="../../prettify.js"></script>
133
133
  <script>
@@ -118,7 +118,7 @@ export default FactorPayload;
118
118
  <div class='footer quiet pad2 space-top1 center small'>
119
119
  Code coverage generated by
120
120
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
121
- at 2026-04-28T12:54:24.682Z
121
+ at 2026-05-11T08:42:18.203Z
122
122
  </div>
123
123
  <script src="../../prettify.js"></script>
124
124
  <script>
@@ -127,7 +127,7 @@ export default GenericCalculationPayload;
127
127
  <div class='footer quiet pad2 space-top1 center small'>
128
128
  Code coverage generated by
129
129
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
130
- at 2026-04-28T12:54:24.682Z
130
+ at 2026-05-11T08:42:18.203Z
131
131
  </div>
132
132
  <script src="../../prettify.js"></script>
133
133
  <script>
@@ -124,7 +124,7 @@ export default locationPayload;</pre></td></tr></table></pre>
124
124
  <div class='footer quiet pad2 space-top1 center small'>
125
125
  Code coverage generated by
126
126
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
127
- at 2026-04-28T12:54:24.682Z
127
+ at 2026-05-11T08:42:18.203Z
128
128
  </div>
129
129
  <script src="../../prettify.js"></script>
130
130
  <script>