emissions-api-sdk 1.0.2 → 1.0.4
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 +9 -0
- package/dist/Constants.js +2 -1
- package/dist/api/Usage.js +26 -0
- package/dist/coverage/clover.xml +44 -33
- package/dist/coverage/coverage-final.json +4 -3
- package/dist/coverage/lcov-report/index.html +19 -19
- package/dist/coverage/lcov-report/src/Client.ts.html +23 -23
- package/dist/coverage/lcov-report/src/Constants.ts.html +10 -4
- package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Factor.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
- package/dist/coverage/lcov-report/src/api/Usage.ts.html +160 -0
- package/dist/coverage/lcov-report/src/api/index.html +21 -6
- 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 +75 -55
- package/dist/index.js +2 -1
- package/dist/interfaces/response/UsageResponse.js +5 -0
- package/dist/types/Constants.d.ts +1 -0
- package/dist/types/api/Usage.d.ts +13 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/interfaces/response/EmissionResponseWithDetails.d.ts +4 -0
- package/dist/types/interfaces/response/FactorResponse.d.ts +4 -0
- package/dist/types/interfaces/response/UnitResponse.d.ts +11 -2
- package/dist/types/interfaces/response/UsageResponse.d.ts +17 -0
- package/docs/_sources/reference.rst.txt +6 -0
- package/docs/_static/basic.css +0 -8
- package/docs/_static/pygments.css +164 -146
- package/docs/_static/searchtools.js +8 -5
- package/docs/_static/styles/furo.css +1 -1
- package/docs/_static/styles/furo.css.map +1 -1
- package/docs/authentication.html +19 -28
- package/docs/client.html +19 -28
- package/docs/genindex.html +23 -28
- package/docs/getting_started.html +19 -28
- package/docs/index.html +20 -28
- package/docs/objects.inv +0 -0
- package/docs/reference.html +48 -28
- package/docs/sdk.html +19 -28
- package/docs/search.html +19 -28
- package/docs/searchindex.js +1 -1
- package/docs/troubleshooting.html +19 -28
- package/package.json +1 -1
- package/sphinx-build/requirements.txt +1 -2
- package/sphinx-build/source/reference.rst +6 -0
- package/src/Constants.ts +2 -0
- package/src/api/Usage.ts +26 -0
- package/src/index.ts +3 -1
- package/src/interfaces/response/EmissionResponseWithDetails.ts +6 -0
- package/src/interfaces/response/FactorResponse.ts +6 -0
- package/src/interfaces/response/UnitResponse.ts +12 -2
- package/src/interfaces/response/UsageResponse.ts +23 -0
- package/test/apiTest.test.ts +34 -3
|
@@ -337,23 +337,23 @@
|
|
|
337
337
|
<span class="cline-any cline-neutral"> </span>
|
|
338
338
|
<span class="cline-any cline-neutral"> </span>
|
|
339
339
|
<span class="cline-any cline-neutral"> </span>
|
|
340
|
-
<span class="cline-any cline-yes">
|
|
341
|
-
<span class="cline-any cline-yes">
|
|
342
|
-
<span class="cline-any cline-yes">
|
|
343
|
-
<span class="cline-any cline-yes">
|
|
340
|
+
<span class="cline-any cline-yes">38x</span>
|
|
341
|
+
<span class="cline-any cline-yes">38x</span>
|
|
342
|
+
<span class="cline-any cline-yes">38x</span>
|
|
343
|
+
<span class="cline-any cline-yes">38x</span>
|
|
344
344
|
<span class="cline-any cline-yes">1x</span>
|
|
345
345
|
<span class="cline-any cline-yes">1x</span>
|
|
346
346
|
<span class="cline-any cline-neutral"> </span>
|
|
347
|
-
<span class="cline-any cline-yes">
|
|
348
|
-
<span class="cline-any cline-yes">
|
|
347
|
+
<span class="cline-any cline-yes">37x</span>
|
|
348
|
+
<span class="cline-any cline-yes">37x</span>
|
|
349
349
|
<span class="cline-any cline-neutral"> </span>
|
|
350
350
|
<span class="cline-any cline-neutral"> </span>
|
|
351
|
-
<span class="cline-any cline-yes">
|
|
352
|
-
<span class="cline-any cline-yes">
|
|
353
|
-
<span class="cline-any cline-yes">
|
|
354
|
-
<span class="cline-any cline-yes">
|
|
355
|
-
<span class="cline-any cline-yes">
|
|
356
|
-
<span class="cline-any cline-yes">
|
|
351
|
+
<span class="cline-any cline-yes">38x</span>
|
|
352
|
+
<span class="cline-any cline-yes">38x</span>
|
|
353
|
+
<span class="cline-any cline-yes">38x</span>
|
|
354
|
+
<span class="cline-any cline-yes">38x</span>
|
|
355
|
+
<span class="cline-any cline-yes">38x</span>
|
|
356
|
+
<span class="cline-any cline-yes">38x</span>
|
|
357
357
|
<span class="cline-any cline-neutral"> </span>
|
|
358
358
|
<span class="cline-any cline-neutral"> </span>
|
|
359
359
|
<span class="cline-any cline-neutral"> </span>
|
|
@@ -391,29 +391,29 @@
|
|
|
391
391
|
<span class="cline-any cline-neutral"> </span>
|
|
392
392
|
<span class="cline-any cline-neutral"> </span>
|
|
393
393
|
<span class="cline-any cline-neutral"> </span>
|
|
394
|
-
<span class="cline-any cline-yes">
|
|
394
|
+
<span class="cline-any cline-yes">41x</span>
|
|
395
395
|
<span class="cline-any cline-yes">1x</span>
|
|
396
396
|
<span class="cline-any cline-neutral"> </span>
|
|
397
397
|
<span class="cline-any cline-neutral"> </span>
|
|
398
398
|
<span class="cline-any cline-neutral"> </span>
|
|
399
|
-
<span class="cline-any cline-yes">
|
|
399
|
+
<span class="cline-any cline-yes">40x</span>
|
|
400
400
|
<span class="cline-any cline-yes">1x</span>
|
|
401
401
|
<span class="cline-any cline-neutral"> </span>
|
|
402
402
|
<span class="cline-any cline-neutral"> </span>
|
|
403
403
|
<span class="cline-any cline-neutral"> </span>
|
|
404
|
-
<span class="cline-any cline-yes">
|
|
404
|
+
<span class="cline-any cline-yes">39x</span>
|
|
405
405
|
<span class="cline-any cline-yes">1x</span>
|
|
406
406
|
<span class="cline-any cline-neutral"> </span>
|
|
407
407
|
<span class="cline-any cline-neutral"> </span>
|
|
408
408
|
<span class="cline-any cline-neutral"> </span>
|
|
409
409
|
<span class="cline-any cline-neutral"> </span>
|
|
410
|
-
<span class="cline-any cline-yes">
|
|
410
|
+
<span class="cline-any cline-yes">38x</span>
|
|
411
411
|
<span class="cline-any cline-neutral"> </span>
|
|
412
|
-
<span class="cline-any cline-yes">
|
|
412
|
+
<span class="cline-any cline-yes">38x</span>
|
|
413
413
|
<span class="cline-any cline-yes">1x</span>
|
|
414
414
|
<span class="cline-any cline-yes">1x</span>
|
|
415
|
-
<span class="cline-any cline-yes">
|
|
416
|
-
<span class="cline-any cline-yes">
|
|
415
|
+
<span class="cline-any cline-yes">37x</span>
|
|
416
|
+
<span class="cline-any cline-yes">38x</span>
|
|
417
417
|
<span class="cline-any cline-neutral"> </span>
|
|
418
418
|
<span class="cline-any cline-neutral"> </span>
|
|
419
419
|
<span class="cline-any cline-neutral"> </span>
|
|
@@ -427,7 +427,7 @@
|
|
|
427
427
|
<span class="cline-any cline-neutral"> </span>
|
|
428
428
|
<span class="cline-any cline-neutral"> </span>
|
|
429
429
|
<span class="cline-any cline-neutral"> </span>
|
|
430
|
-
<span class="cline-any cline-yes">
|
|
430
|
+
<span class="cline-any cline-yes">68x</span>
|
|
431
431
|
<span class="cline-any cline-neutral"> </span>
|
|
432
432
|
<span class="cline-any cline-neutral"> </span>
|
|
433
433
|
<span class="cline-any cline-neutral"> </span>
|
|
@@ -449,12 +449,12 @@
|
|
|
449
449
|
<span class="cline-any cline-neutral"> </span>
|
|
450
450
|
<span class="cline-any cline-neutral"> </span>
|
|
451
451
|
<span class="cline-any cline-neutral"> </span>
|
|
452
|
-
<span class="cline-any cline-yes">
|
|
452
|
+
<span class="cline-any cline-yes">73x</span>
|
|
453
453
|
<span class="cline-any cline-yes">1x</span>
|
|
454
454
|
<span class="cline-any cline-neutral"> </span>
|
|
455
455
|
<span class="cline-any cline-neutral"> </span>
|
|
456
456
|
<span class="cline-any cline-neutral"> </span>
|
|
457
|
-
<span class="cline-any cline-yes">
|
|
457
|
+
<span class="cline-any cline-yes">72x</span>
|
|
458
458
|
<span class="cline-any cline-neutral"> </span>
|
|
459
459
|
<span class="cline-any cline-neutral"> </span>
|
|
460
460
|
<span class="cline-any cline-neutral"> </span>
|
|
@@ -823,7 +823,7 @@ export class Client {
|
|
|
823
823
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
824
824
|
Code coverage generated by
|
|
825
825
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
826
|
-
at
|
|
826
|
+
at 2026-01-23T09:26:49.327Z
|
|
827
827
|
</div>
|
|
828
828
|
<script src="../prettify.js"></script>
|
|
829
829
|
<script>
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
<div class='fl pad1y space-right2'>
|
|
26
26
|
<span class="strong">100% </span>
|
|
27
27
|
<span class="quiet">Statements</span>
|
|
28
|
-
<span class='fraction'>
|
|
28
|
+
<span class='fraction'>39/39</span>
|
|
29
29
|
</div>
|
|
30
30
|
|
|
31
31
|
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
<div class='fl pad1y space-right2'>
|
|
47
47
|
<span class="strong">100% </span>
|
|
48
48
|
<span class="quiet">Lines</span>
|
|
49
|
-
<span class='fraction'>
|
|
49
|
+
<span class='fraction'>39/39</span>
|
|
50
50
|
</div>
|
|
51
51
|
|
|
52
52
|
|
|
@@ -104,7 +104,9 @@
|
|
|
104
104
|
<a name='L39'></a><a href='#L39'>39</a>
|
|
105
105
|
<a name='L40'></a><a href='#L40'>40</a>
|
|
106
106
|
<a name='L41'></a><a href='#L41'>41</a>
|
|
107
|
-
<a name='L42'></a><a href='#L42'>42</a
|
|
107
|
+
<a name='L42'></a><a href='#L42'>42</a>
|
|
108
|
+
<a name='L43'></a><a href='#L43'>43</a>
|
|
109
|
+
<a name='L44'></a><a href='#L44'>44</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">4x</span>
|
|
108
110
|
<span class="cline-any cline-yes">4x</span>
|
|
109
111
|
<span class="cline-any cline-yes">4x</span>
|
|
110
112
|
<span class="cline-any cline-yes">4x</span>
|
|
@@ -142,6 +144,8 @@
|
|
|
142
144
|
<span class="cline-any cline-yes">4x</span>
|
|
143
145
|
<span class="cline-any cline-neutral"> </span>
|
|
144
146
|
<span class="cline-any cline-yes">4x</span>
|
|
147
|
+
<span class="cline-any cline-neutral"> </span>
|
|
148
|
+
<span class="cline-any cline-yes">4x</span>
|
|
145
149
|
<span class="cline-any cline-yes">4x</span>
|
|
146
150
|
<span class="cline-any cline-yes">4x</span>
|
|
147
151
|
<span class="cline-any cline-yes">4x</span>
|
|
@@ -182,6 +186,8 @@ export const GENERAL_API_UNITS = "/v3/carbon/calculation/units";
|
|
|
182
186
|
export const FACTOR_API_UNITS = "/v3/carbon/factor/units";
|
|
183
187
|
export const TRANSPORTATION_AND_DISTRIBUTION_API_UNITS = "/v3/carbon/transportation-and-distribution/units";
|
|
184
188
|
|
|
189
|
+
export const USAGE_API = "/v3/carbon/usage";
|
|
190
|
+
|
|
185
191
|
export const GET = "GET";
|
|
186
192
|
export const POST = "POST";
|
|
187
193
|
export const CLIENT_SOURCE_HEADER = "X-Client-Source";
|
|
@@ -193,7 +199,7 @@ export const CLIENT_SOURCE_SDK = "node-sdk";</pre></td></tr></table></pre>
|
|
|
193
199
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
194
200
|
Code coverage generated by
|
|
195
201
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
196
|
-
at
|
|
202
|
+
at 2026-01-23T09:26:49.327Z
|
|
197
203
|
</div>
|
|
198
204
|
<script src="../prettify.js"></script>
|
|
199
205
|
<script>
|
|
@@ -421,7 +421,7 @@ export async function getUnits(
|
|
|
421
421
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
422
422
|
Code coverage generated by
|
|
423
423
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
424
|
-
at
|
|
424
|
+
at 2026-01-23T09:26:49.327Z
|
|
425
425
|
</div>
|
|
426
426
|
<script src="../../prettify.js"></script>
|
|
427
427
|
<script>
|
|
@@ -607,7 +607,7 @@ export async function getUnits(
|
|
|
607
607
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
608
608
|
Code coverage generated by
|
|
609
609
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
610
|
-
at
|
|
610
|
+
at 2026-01-23T09:26:49.327Z
|
|
611
611
|
</div>
|
|
612
612
|
<script src="../../prettify.js"></script>
|
|
613
613
|
<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
|
|
145
|
+
at 2026-01-23T09:26:49.327Z
|
|
146
146
|
</div>
|
|
147
147
|
<script src="../../prettify.js"></script>
|
|
148
148
|
<script>
|
|
@@ -421,7 +421,7 @@ export async function getUnits(
|
|
|
421
421
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
422
422
|
Code coverage generated by
|
|
423
423
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
424
|
-
at
|
|
424
|
+
at 2026-01-23T09:26:49.327Z
|
|
425
425
|
</div>
|
|
426
426
|
<script src="../../prettify.js"></script>
|
|
427
427
|
<script>
|
|
@@ -418,7 +418,7 @@ export async function getUnits(
|
|
|
418
418
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
419
419
|
Code coverage generated by
|
|
420
420
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
421
|
-
at
|
|
421
|
+
at 2026-01-23T09:26:49.327Z
|
|
422
422
|
</div>
|
|
423
423
|
<script src="../../prettify.js"></script>
|
|
424
424
|
<script>
|
|
@@ -433,7 +433,7 @@ export async function getUnits(
|
|
|
433
433
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
434
434
|
Code coverage generated by
|
|
435
435
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
436
|
-
at
|
|
436
|
+
at 2026-01-23T09:26:49.327Z
|
|
437
437
|
</div>
|
|
438
438
|
<script src="../../prettify.js"></script>
|
|
439
439
|
<script>
|
|
@@ -427,7 +427,7 @@ export async function getUnits(
|
|
|
427
427
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
428
428
|
Code coverage generated by
|
|
429
429
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
430
|
-
at
|
|
430
|
+
at 2026-01-23T09:26:49.327Z
|
|
431
431
|
</div>
|
|
432
432
|
<script src="../../prettify.js"></script>
|
|
433
433
|
<script>
|
|
@@ -421,7 +421,7 @@ export async function getUnits(
|
|
|
421
421
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
422
422
|
Code coverage generated by
|
|
423
423
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
424
|
-
at
|
|
424
|
+
at 2026-01-23T09:26:49.327Z
|
|
425
425
|
</div>
|
|
426
426
|
<script src="../../prettify.js"></script>
|
|
427
427
|
<script>
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
|
|
2
|
+
<!doctype html>
|
|
3
|
+
<html lang="en">
|
|
4
|
+
|
|
5
|
+
<head>
|
|
6
|
+
<title>Code coverage report for src/api/Usage.ts</title>
|
|
7
|
+
<meta charset="utf-8" />
|
|
8
|
+
<link rel="stylesheet" href="../../prettify.css" />
|
|
9
|
+
<link rel="stylesheet" href="../../base.css" />
|
|
10
|
+
<link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
|
|
11
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
12
|
+
<style type='text/css'>
|
|
13
|
+
.coverage-summary .sorter {
|
|
14
|
+
background-image: url(../../sort-arrow-sprite.png);
|
|
15
|
+
}
|
|
16
|
+
</style>
|
|
17
|
+
</head>
|
|
18
|
+
|
|
19
|
+
<body>
|
|
20
|
+
<div class='wrapper'>
|
|
21
|
+
<div class='pad1'>
|
|
22
|
+
<h1><a href="../../index.html">All files</a> / <a href="index.html">src/api</a> Usage.ts</h1>
|
|
23
|
+
<div class='clearfix'>
|
|
24
|
+
|
|
25
|
+
<div class='fl pad1y space-right2'>
|
|
26
|
+
<span class="strong">100% </span>
|
|
27
|
+
<span class="quiet">Statements</span>
|
|
28
|
+
<span class='fraction'>7/7</span>
|
|
29
|
+
</div>
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<div class='fl pad1y space-right2'>
|
|
33
|
+
<span class="strong">0% </span>
|
|
34
|
+
<span class="quiet">Branches</span>
|
|
35
|
+
<span class='fraction'>0/1</span>
|
|
36
|
+
</div>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<div class='fl pad1y space-right2'>
|
|
40
|
+
<span class="strong">100% </span>
|
|
41
|
+
<span class="quiet">Functions</span>
|
|
42
|
+
<span class='fraction'>1/1</span>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div class='fl pad1y space-right2'>
|
|
47
|
+
<span class="strong">100% </span>
|
|
48
|
+
<span class="quiet">Lines</span>
|
|
49
|
+
<span class='fraction'>7/7</span>
|
|
50
|
+
</div>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
<p class="quiet">
|
|
55
|
+
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.
|
|
56
|
+
</p>
|
|
57
|
+
<template id="filterTemplate">
|
|
58
|
+
<div class="quiet">
|
|
59
|
+
Filter:
|
|
60
|
+
<input type="search" id="fileSearch">
|
|
61
|
+
</div>
|
|
62
|
+
</template>
|
|
63
|
+
</div>
|
|
64
|
+
<div class='status-line high'></div>
|
|
65
|
+
<pre><table class="coverage">
|
|
66
|
+
<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
|
|
67
|
+
<a name='L2'></a><a href='#L2'>2</a>
|
|
68
|
+
<a name='L3'></a><a href='#L3'>3</a>
|
|
69
|
+
<a name='L4'></a><a href='#L4'>4</a>
|
|
70
|
+
<a name='L5'></a><a href='#L5'>5</a>
|
|
71
|
+
<a name='L6'></a><a href='#L6'>6</a>
|
|
72
|
+
<a name='L7'></a><a href='#L7'>7</a>
|
|
73
|
+
<a name='L8'></a><a href='#L8'>8</a>
|
|
74
|
+
<a name='L9'></a><a href='#L9'>9</a>
|
|
75
|
+
<a name='L10'></a><a href='#L10'>10</a>
|
|
76
|
+
<a name='L11'></a><a href='#L11'>11</a>
|
|
77
|
+
<a name='L12'></a><a href='#L12'>12</a>
|
|
78
|
+
<a name='L13'></a><a href='#L13'>13</a>
|
|
79
|
+
<a name='L14'></a><a href='#L14'>14</a>
|
|
80
|
+
<a name='L15'></a><a href='#L15'>15</a>
|
|
81
|
+
<a name='L16'></a><a href='#L16'>16</a>
|
|
82
|
+
<a name='L17'></a><a href='#L17'>17</a>
|
|
83
|
+
<a name='L18'></a><a href='#L18'>18</a>
|
|
84
|
+
<a name='L19'></a><a href='#L19'>19</a>
|
|
85
|
+
<a name='L20'></a><a href='#L20'>20</a>
|
|
86
|
+
<a name='L21'></a><a href='#L21'>21</a>
|
|
87
|
+
<a name='L22'></a><a href='#L22'>22</a>
|
|
88
|
+
<a name='L23'></a><a href='#L23'>23</a>
|
|
89
|
+
<a name='L24'></a><a href='#L24'>24</a>
|
|
90
|
+
<a name='L25'></a><a href='#L25'>25</a>
|
|
91
|
+
<a name='L26'></a><a href='#L26'>26</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
|
|
92
|
+
<span class="cline-any cline-yes">1x</span>
|
|
93
|
+
<span class="cline-any cline-neutral"> </span>
|
|
94
|
+
<span class="cline-any cline-yes">1x</span>
|
|
95
|
+
<span class="cline-any cline-neutral"> </span>
|
|
96
|
+
<span class="cline-any cline-neutral"> </span>
|
|
97
|
+
<span class="cline-any cline-neutral"> </span>
|
|
98
|
+
<span class="cline-any cline-neutral"> </span>
|
|
99
|
+
<span class="cline-any cline-neutral"> </span>
|
|
100
|
+
<span class="cline-any cline-neutral"> </span>
|
|
101
|
+
<span class="cline-any cline-neutral"> </span>
|
|
102
|
+
<span class="cline-any cline-neutral"> </span>
|
|
103
|
+
<span class="cline-any cline-neutral"> </span>
|
|
104
|
+
<span class="cline-any cline-neutral"> </span>
|
|
105
|
+
<span class="cline-any cline-neutral"> </span>
|
|
106
|
+
<span class="cline-any cline-neutral"> </span>
|
|
107
|
+
<span class="cline-any cline-yes">1x</span>
|
|
108
|
+
<span class="cline-any cline-yes">3x</span>
|
|
109
|
+
<span class="cline-any cline-yes">3x</span>
|
|
110
|
+
<span class="cline-any cline-neutral"> </span>
|
|
111
|
+
<span class="cline-any cline-yes">3x</span>
|
|
112
|
+
<span class="cline-any cline-neutral"> </span>
|
|
113
|
+
<span class="cline-any cline-neutral"> </span>
|
|
114
|
+
<span class="cline-any cline-neutral"> </span>
|
|
115
|
+
<span class="cline-any cline-neutral"> </span>
|
|
116
|
+
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import { Client } from "../Client";
|
|
117
|
+
import { GET, USAGE_API } from "../Constants";
|
|
118
|
+
import { UsageResponse } from "../interfaces/response/UsageResponse";
|
|
119
|
+
import { makeApiRequest } from "../request";
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Retrieves current billing period or historical usage data for the user by making a GET request to the API endpoint.
|
|
123
|
+
*
|
|
124
|
+
* @export
|
|
125
|
+
* @param {boolean} history - Flag to retrieve current billing or historical usage data.
|
|
126
|
+
* @return {Promise<UsageResponse>} A promise that resolves to a UsageResponse containing the organization's usage data
|
|
127
|
+
* @throws {Error} May throw an error if the API request fails
|
|
128
|
+
*
|
|
129
|
+
* @example
|
|
130
|
+
* const usage = await getUsage();
|
|
131
|
+
*/
|
|
132
|
+
export async function getUsage(history : boolean = <span class="branch-0 cbranch-no" title="branch not covered" >false)</span>: Promise<UsageResponse> {
|
|
133
|
+
const client = Client.getInstance();
|
|
134
|
+
const url = client.getDomain() + USAGE_API;
|
|
135
|
+
|
|
136
|
+
return makeApiRequest<UsageResponse>({
|
|
137
|
+
method: GET,
|
|
138
|
+
url,
|
|
139
|
+
params : { history }
|
|
140
|
+
});
|
|
141
|
+
}</pre></td></tr></table></pre>
|
|
142
|
+
|
|
143
|
+
<div class='push'></div><!-- for sticky footer -->
|
|
144
|
+
</div><!-- /wrapper -->
|
|
145
|
+
<div class='footer quiet pad2 space-top1 center small'>
|
|
146
|
+
Code coverage generated by
|
|
147
|
+
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
148
|
+
at 2026-01-23T09:26:49.327Z
|
|
149
|
+
</div>
|
|
150
|
+
<script src="../../prettify.js"></script>
|
|
151
|
+
<script>
|
|
152
|
+
window.onload = function () {
|
|
153
|
+
prettyPrint();
|
|
154
|
+
};
|
|
155
|
+
</script>
|
|
156
|
+
<script src="../../sorter.js"></script>
|
|
157
|
+
<script src="../../block-navigation.js"></script>
|
|
158
|
+
</body>
|
|
159
|
+
</html>
|
|
160
|
+
|
|
@@ -25,28 +25,28 @@
|
|
|
25
25
|
<div class='fl pad1y space-right2'>
|
|
26
26
|
<span class="strong">100% </span>
|
|
27
27
|
<span class="quiet">Statements</span>
|
|
28
|
-
<span class='fraction'>
|
|
28
|
+
<span class='fraction'>155/155</span>
|
|
29
29
|
</div>
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
<div class='fl pad1y space-right2'>
|
|
33
|
-
<span class="strong">
|
|
33
|
+
<span class="strong">0% </span>
|
|
34
34
|
<span class="quiet">Branches</span>
|
|
35
|
-
<span class='fraction'>0/
|
|
35
|
+
<span class='fraction'>0/1</span>
|
|
36
36
|
</div>
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
<div class='fl pad1y space-right2'>
|
|
40
40
|
<span class="strong">100% </span>
|
|
41
41
|
<span class="quiet">Functions</span>
|
|
42
|
-
<span class='fraction'>
|
|
42
|
+
<span class='fraction'>32/32</span>
|
|
43
43
|
</div>
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
<div class='fl pad1y space-right2'>
|
|
47
47
|
<span class="strong">100% </span>
|
|
48
48
|
<span class="quiet">Lines</span>
|
|
49
|
-
<span class='fraction'>
|
|
49
|
+
<span class='fraction'>155/155</span>
|
|
50
50
|
</div>
|
|
51
51
|
|
|
52
52
|
|
|
@@ -198,6 +198,21 @@
|
|
|
198
198
|
<td data-value="19" class="abs high">19/19</td>
|
|
199
199
|
</tr>
|
|
200
200
|
|
|
201
|
+
<tr>
|
|
202
|
+
<td class="file high" data-value="Usage.ts"><a href="Usage.ts.html">Usage.ts</a></td>
|
|
203
|
+
<td data-value="100" class="pic high">
|
|
204
|
+
<div class="chart"><div class="cover-fill cover-full" style="width: 100%"></div><div class="cover-empty" style="width: 0%"></div></div>
|
|
205
|
+
</td>
|
|
206
|
+
<td data-value="100" class="pct high">100%</td>
|
|
207
|
+
<td data-value="7" class="abs high">7/7</td>
|
|
208
|
+
<td data-value="0" class="pct low">0%</td>
|
|
209
|
+
<td data-value="1" class="abs low">0/1</td>
|
|
210
|
+
<td data-value="100" class="pct high">100%</td>
|
|
211
|
+
<td data-value="1" class="abs high">1/1</td>
|
|
212
|
+
<td data-value="100" class="pct high">100%</td>
|
|
213
|
+
<td data-value="7" class="abs high">7/7</td>
|
|
214
|
+
</tr>
|
|
215
|
+
|
|
201
216
|
</tbody>
|
|
202
217
|
</table>
|
|
203
218
|
</div>
|
|
@@ -206,7 +221,7 @@
|
|
|
206
221
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
207
222
|
Code coverage generated by
|
|
208
223
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
209
|
-
at
|
|
224
|
+
at 2026-01-23T09:26:49.327Z
|
|
210
225
|
</div>
|
|
211
226
|
<script src="../../prettify.js"></script>
|
|
212
227
|
<script>
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
<div class='clearfix'>
|
|
24
24
|
|
|
25
25
|
<div class='fl pad1y space-right2'>
|
|
26
|
-
<span class="strong">96.
|
|
26
|
+
<span class="strong">96.15% </span>
|
|
27
27
|
<span class="quiet">Statements</span>
|
|
28
|
-
<span class='fraction'>
|
|
28
|
+
<span class='fraction'>100/104</span>
|
|
29
29
|
</div>
|
|
30
30
|
|
|
31
31
|
|
|
@@ -44,9 +44,9 @@
|
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
<div class='fl pad1y space-right2'>
|
|
47
|
-
<span class="strong">98.
|
|
47
|
+
<span class="strong">98.03% </span>
|
|
48
48
|
<span class="quiet">Lines</span>
|
|
49
|
-
<span class='fraction'>
|
|
49
|
+
<span class='fraction'>100/102</span>
|
|
50
50
|
</div>
|
|
51
51
|
|
|
52
52
|
|
|
@@ -99,13 +99,13 @@
|
|
|
99
99
|
<div class="chart"><div class="cover-fill cover-full" style="width: 100%"></div><div class="cover-empty" style="width: 0%"></div></div>
|
|
100
100
|
</td>
|
|
101
101
|
<td data-value="100" class="pct high">100%</td>
|
|
102
|
-
<td data-value="
|
|
102
|
+
<td data-value="39" class="abs high">39/39</td>
|
|
103
103
|
<td data-value="100" class="pct high">100%</td>
|
|
104
104
|
<td data-value="0" class="abs high">0/0</td>
|
|
105
105
|
<td data-value="100" class="pct high">100%</td>
|
|
106
106
|
<td data-value="0" class="abs high">0/0</td>
|
|
107
107
|
<td data-value="100" class="pct high">100%</td>
|
|
108
|
-
<td data-value="
|
|
108
|
+
<td data-value="39" class="abs high">39/39</td>
|
|
109
109
|
</tr>
|
|
110
110
|
|
|
111
111
|
<tr>
|
|
@@ -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
|
|
149
|
+
at 2026-01-23T09:26:49.327Z
|
|
150
150
|
</div>
|
|
151
151
|
<script src="../prettify.js"></script>
|
|
152
152
|
<script>
|
|
@@ -220,7 +220,7 @@ export async function makeApiRequest<T>(config: RequestConfig): Promise<
|
|
|
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
|
|
223
|
+
at 2026-01-23T09:26:49.327Z
|
|
224
224
|
</div>
|
|
225
225
|
<script src="../prettify.js"></script>
|
|
226
226
|
<script>
|
|
@@ -95,10 +95,10 @@
|
|
|
95
95
|
<span class="cline-any cline-neutral"> </span>
|
|
96
96
|
<span class="cline-any cline-neutral"> </span>
|
|
97
97
|
<span class="cline-any cline-yes">4x</span>
|
|
98
|
-
<span class="cline-any cline-yes">
|
|
99
|
-
<span class="cline-any cline-yes">
|
|
100
|
-
<span class="cline-any cline-yes">
|
|
101
|
-
<span class="cline-any cline-yes">
|
|
98
|
+
<span class="cline-any cline-yes">36x</span>
|
|
99
|
+
<span class="cline-any cline-yes">36x</span>
|
|
100
|
+
<span class="cline-any cline-yes">36x</span>
|
|
101
|
+
<span class="cline-any cline-yes">36x</span>
|
|
102
102
|
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">/**
|
|
103
103
|
* Extracts the expiration time from a JWT token and give the token expiry time.
|
|
104
104
|
*
|
|
@@ -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
|
|
127
|
+
at 2026-01-23T09:26:49.327Z
|
|
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
|
|
104
|
+
at 2026-01-23T09:26:49.327Z
|
|
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
|
|
130
|
+
at 2026-01-23T09:26:49.327Z
|
|
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
|
|
121
|
+
at 2026-01-23T09:26:49.327Z
|
|
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
|
|
130
|
+
at 2026-01-23T09:26:49.327Z
|
|
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
|
|
127
|
+
at 2026-01-23T09:26:49.327Z
|
|
128
128
|
</div>
|
|
129
129
|
<script src="../../prettify.js"></script>
|
|
130
130
|
<script>
|
|
@@ -127,7 +127,7 @@ export default SearchPayload;
|
|
|
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
|
|
130
|
+
at 2026-01-23T09:26:49.327Z
|
|
131
131
|
</div>
|
|
132
132
|
<script src="../../prettify.js"></script>
|
|
133
133
|
<script>
|