emissions-api-sdk 1.0.2 → 1.0.3

package/dist/coverage/lcov-report/test/testUtils.ts.html

@@ -82,7 +82,7 @@
             <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
+                at 2025-12-23T04:53:24.226Z
             </div>
         <script src="../prettify.js"></script>
         <script>

package/dist/coverage/lcov.info

@@ -11,10 +11,10 @@ FN:214,(anonymous_8)
 FN:236,(anonymous_9)
 FNF:9
 FNH:7
-FNDA:35,(anonymous_1)
-FNDA:38,(anonymous_2)
-FNDA:62,(anonymous_3)
-FNDA:67,(anonymous_4)
+FNDA:38,(anonymous_1)
+FNDA:41,(anonymous_2)
+FNDA:68,(anonymous_3)
+FNDA:73,(anonymous_4)
 FNDA:3,(anonymous_5)
 FNDA:2,(anonymous_6)
 FNDA:0,(anonymous_7)
@@ -25,36 +25,36 @@ DA:3,4
 DA:4,4
 DA:6,4
 DA:7,4
-DA:24,35
-DA:25,35
-DA:26,35
-DA:27,35
+DA:24,38
+DA:25,38
+DA:26,38
+DA:27,38
 DA:28,1
 DA:29,1
-DA:31,34
-DA:32,34
-DA:35,35
-DA:36,35
-DA:37,35
-DA:38,35
-DA:39,35
-DA:40,35
-DA:78,38
+DA:31,37
+DA:32,37
+DA:35,38
+DA:36,38
+DA:37,38
+DA:38,38
+DA:39,38
+DA:40,38
+DA:78,41
 DA:79,1
-DA:83,37
+DA:83,40
 DA:84,1
-DA:88,36
+DA:88,39
 DA:89,1
-DA:94,35
-DA:96,35
+DA:94,38
+DA:96,38
 DA:97,1
 DA:98,1
-DA:99,34
-DA:100,35
-DA:114,62
-DA:136,67
+DA:99,37
+DA:100,38
+DA:114,68
+DA:136,73
 DA:137,1
-DA:141,66
+DA:141,72
 DA:157,3
 DA:158,2
 DA:159,2
@@ -74,38 +74,38 @@ LH:47
 BRDA:22,0,0,0
 BRDA:24,1,0,1
 BRDA:24,2,0,1
-BRDA:24,3,0,35
+BRDA:24,3,0,38
 BRDA:27,4,0,1
-BRDA:27,4,1,34
+BRDA:27,4,1,37
 BRDA:37,5,0,0
-BRDA:37,5,1,35
-BRDA:37,6,0,35
-BRDA:37,6,1,35
+BRDA:37,5,1,38
+BRDA:37,6,0,38
+BRDA:37,6,1,38
 BRDA:38,7,0,0
-BRDA:38,7,1,35
-BRDA:38,8,0,35
-BRDA:38,8,1,35
+BRDA:38,7,1,38
+BRDA:38,8,0,38
+BRDA:38,8,1,38
 BRDA:40,9,0,0
-BRDA:40,9,1,35
+BRDA:40,9,1,38
 BRDA:78,10,0,1
-BRDA:78,10,1,37
-BRDA:78,11,0,38
+BRDA:78,10,1,40
+BRDA:78,11,0,41
 BRDA:78,11,1,1
 BRDA:83,12,0,1
-BRDA:83,12,1,36
-BRDA:83,13,0,37
+BRDA:83,12,1,39
+BRDA:83,13,0,40
 BRDA:83,13,1,2
 BRDA:88,14,0,1
-BRDA:88,14,1,35
-BRDA:88,15,0,36
-BRDA:88,15,1,35
-BRDA:88,15,2,34
+BRDA:88,14,1,38
+BRDA:88,15,0,39
+BRDA:88,15,1,38
+BRDA:88,15,2,37
 BRDA:96,16,0,1
-BRDA:96,16,1,34
-BRDA:96,17,0,35
+BRDA:96,16,1,37
+BRDA:96,17,0,38
 BRDA:96,17,1,1
 BRDA:136,18,0,1
-BRDA:136,18,1,66
+BRDA:136,18,1,72
 BRDA:157,19,0,2
 BRDA:157,19,1,1
 BRDA:159,20,0,1
@@ -157,12 +157,13 @@ DA:34,4
 DA:35,4
 DA:36,4
 DA:38,4
-DA:39,4
 DA:40,4
 DA:41,4
 DA:42,4
-LF:38
-LH:38
+DA:43,4
+DA:44,4
+LF:39
+LH:39
 BRF:0
 BRH:0
 end_of_record
@@ -191,16 +192,16 @@ SF:src/utils.ts
 FN:14,findExpiryTime
 FNF:1
 FNH:1
-FNDA:33,findExpiryTime
+FNDA:36,findExpiryTime
 DA:14,4
-DA:15,33
-DA:16,33
-DA:17,33
-DA:18,33
+DA:15,36
+DA:16,36
+DA:17,36
+DA:18,36
 LF:5
 LH:5
 BRDA:17,0,0,0
-BRDA:17,0,1,33
+BRDA:17,0,1,36
 BRF:2
 BRH:1
 end_of_record
@@ -487,6 +488,25 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:src/api/Usage.ts
+FN:17,getUsage
+FNF:1
+FNH:1
+FNDA:3,getUsage
+DA:1,1
+DA:2,1
+DA:4,1
+DA:17,1
+DA:18,3
+DA:19,3
+DA:21,3
+LF:7
+LH:7
+BRDA:17,0,0,0
+BRF:1
+BRH:0
+end_of_record
+TN:
 SF:test/testUtils.ts
 FN:1,generateMockjwt
 FNF:1

package/dist/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FactorSets = exports.Factor = exports.TransportationAndDistribution = exports.Calculation = exports.Stationary = exports.Mobile = exports.Fugitive = exports.Location = exports.Client = void 0;
+exports.FactorSets = exports.Factor = exports.Usage = exports.TransportationAndDistribution = exports.Calculation = exports.Stationary = exports.Mobile = exports.Fugitive = exports.Location = exports.Client = void 0;
 var Client_1 = require("./Client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return Client_1.Client; } });
 exports.Location = __importStar(require("./api/Location"));
@@ -42,5 +42,6 @@ exports.Mobile = __importStar(require("./api/Mobile"));
 exports.Stationary = __importStar(require("./api/Stationary"));
 exports.Calculation = __importStar(require("./api/Calculation"));
 exports.TransportationAndDistribution = __importStar(require("./api/TransportationAndDistribution"));
+exports.Usage = __importStar(require("./api/Usage"));
 exports.Factor = __importStar(require("./api/Factor"));
 exports.FactorSets = __importStar(require("./api/FactorSets"));

package/dist/interfaces/response/UsageResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Interface representing the GHG Metrics Usage Response
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Constants.d.ts

@@ -31,6 +31,7 @@ export declare const STATIONARY_API_UNITS = "/v3/carbon/stationary/units";
 export declare const GENERAL_API_UNITS = "/v3/carbon/calculation/units";
 export declare const FACTOR_API_UNITS = "/v3/carbon/factor/units";
 export declare const TRANSPORTATION_AND_DISTRIBUTION_API_UNITS = "/v3/carbon/transportation-and-distribution/units";
+export declare const USAGE_API = "/v3/carbon/usage";
 export declare const GET = "GET";
 export declare const POST = "POST";
 export declare const CLIENT_SOURCE_HEADER = "X-Client-Source";

package/dist/types/api/Usage.d.ts

@@ -0,0 +1,13 @@
+import { UsageResponse } from "../interfaces/response/UsageResponse";
+/**
+ * Retrieves current billing period or historical usage data for the user by making a GET request to the API endpoint.
+ *
+ * @export
+ * @param {boolean} history - Flag to retrieve current billing or historical usage data.
+ * @return {Promise<UsageResponse>} A promise that resolves to a UsageResponse containing the organization's usage data
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const usage = await getUsage();
+ */
+export declare function getUsage(history?: boolean): Promise<UsageResponse>;

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export * as Mobile from './api/Mobile';
 export * as Stationary from './api/Stationary';
 export * as Calculation from './api/Calculation';
 export * as TransportationAndDistribution from './api/TransportationAndDistribution';
+export * as Usage from './api/Usage';
 export * as Factor from './api/Factor';
 export * as FactorSets from './api/FactorSets';
 export { ClientConfig } from './interfaces/Config';
@@ -16,3 +17,4 @@ export { FactorSetResponse, FactorSet } from './interfaces/response/FactorSetRes
 export { SearchResponse, Pagination, PaginationBody, SearchLink } from './interfaces/response/SearchResponse';
 export { TypeResponse } from './interfaces/response/TypeResponse';
 export { UnitResponse } from './interfaces/response/UnitResponse';
+export { UsageResponse } from './interfaces/response/UsageResponse';

package/dist/types/interfaces/response/UnitResponse.d.ts

@@ -1,7 +1,16 @@
+/**
+ * Interface for unit object
+ */
+export interface Unit {
+    /** Unit symbol */
+    unit: string;
+    /** Unit name */
+    unitName: string;
+}
 /**
  * Interface for /units metadata API
  */
 export interface UnitResponse {
-    /** Array of string*/
-    units: string[];
+    /** Array of Unit objects */
+    units: Unit[];
 }

package/dist/types/interfaces/response/UsageResponse.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Interface representing the GHG Metrics Usage Response
+ */
+export interface UsageResponse {
+    /** Organization ID for the API request */
+    orgId?: string;
+    /** Array of entitlement belonging to the Org */
+    entitlement?: Entitlement[];
+}
+export interface Entitlement {
+    /** Organization's billing start date*/
+    startDate?: string;
+    /** Organization's billing end date */
+    endDate?: string;
+    /** Total api calls made by the Organization in the billing cycle */
+    totalApiCalls?: number;
+}

package/docs/_sources/reference.rst.txt

@@ -83,6 +83,12 @@ getUnits
 
 .. js:autofunction:: Fugitive.getUnits
 
+
+Usage API
+===========
+
+.. js:autofunction:: Usage.getUsage
+
 Interfaces
 ==========
 

package/docs/_static/basic.css

@@ -741,14 +741,6 @@ abbr, acronym {
     cursor: help;
 }
 
-.translated {
-    background-color: rgba(207, 255, 207, 0.2)
-}
-
-.untranslated {
-    background-color: rgba(255, 207, 207, 0.2)
-}
-
 /* -- code displays --------------------------------------------------------- */
 
 pre {