emissions-api-sdk 1.0.0

package/dist/Constants.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLIENT_SOURCE_SDK = exports.CLIENT_SOURCE_EXCEL = exports.CLIENT_SOURCE_HEADER = exports.POST = exports.GET = exports.SEARCH_API_PATH = exports.FACTOR_SET_API_PATH = exports.FACTOR_API_PATH = exports.TRANSPORTATION_AND_DISTRIBUTION_API_PATH = exports.GENERIC_CALCULATION_API_PATH = exports.STATIONARY_API_PATH = exports.FUGITIVE_API_PATH = exports.LOCATION_API_PATH = exports.MOBILE_API_PATH = exports.TOKEN_GENERATION_API = exports.API_DOMAIN = void 0;
+exports.API_DOMAIN = "https://api.ibm.com/ghgemissions/run";
+exports.TOKEN_GENERATION_API = "https://api.ibm.com/saascore/run/authentication-retrieve/api-key";
+exports.MOBILE_API_PATH = "/v3/carbon/mobile";
+exports.LOCATION_API_PATH = "/v3/carbon/location";
+exports.FUGITIVE_API_PATH = "/v3/carbon/fugitive";
+exports.STATIONARY_API_PATH = "/v3/carbon/stationary";
+exports.GENERIC_CALCULATION_API_PATH = "/v3/carbon/calculation";
+exports.TRANSPORTATION_AND_DISTRIBUTION_API_PATH = "/v3/carbon/transportation-and-distribution";
+exports.FACTOR_API_PATH = "/v3/carbon/factor";
+exports.FACTOR_SET_API_PATH = "/v3/carbon/factorset";
+exports.SEARCH_API_PATH = "/v3/carbon/factor/search";
+exports.GET = "GET";
+exports.POST = "POST";
+exports.CLIENT_SOURCE_HEADER = "X-Client-Source";
+exports.CLIENT_SOURCE_EXCEL = "excel";
+exports.CLIENT_SOURCE_SDK = "node-sdk";

package/dist/api/Calculation.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Performs emission calculations by making a POST request to the generic calculation API endpoint.
+ *
+ * @export
+ * @param {CalculationRequest} payload - The calculation request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @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":"Waste Combusted - Steel Cans:Default factor",
+                            "unit": "kg",
+                            "value": 1223123.121
+            },
+            "includeDetails": true
+        };
+ * const result = await calculate(calculationRequest);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.GENERIC_CALCULATION_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/Factor.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retrieveFactor = retrieveFactor;
+exports.search = search;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Retrieves a factor details by making a POST request to the factor API endpoint.
+ *
+ * @export
+ * @param {FactorRequest} payload - The factor request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the factor string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const factorRequest = {
+    
+    "activity": {
+         "factorId": 12345
+    }
+  };
+  
+  or
+
+  const factorRequest = {
+             "time" : {
+                "date": "2025-01-04"
+            },
+            "location": {
+                "country": "usa",
+                                "stateProvince": "new york"
+            },
+            "activity": {
+                            "type":"natural gas"
+            },
+            "includeDetails": true
+        };
+ * const factor = await retrieveFactor(factorRequest);
+ */
+async function retrieveFactor(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.FACTOR_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}
+/**
+ * Performs a search operation by making a POST request to the search API endpoint.
+ *
+ * @export
+ * @param {SearchRequest} payload - The search request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the search results string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const searchRequest = {
+    "time":{
+      "date": "2020-06-10"
+    },
+    "activity": {
+      "search" : "travel"},
+  "location": {
+      "country": "USA"
+    }
+  };
+ * const results = await search(searchRequest);
+ */
+async function search(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.SEARCH_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/FactorSets.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = get;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Retrieves factor sets by making a GET request to the factor set API endpoint.
+ *
+ * @export
+ * @return {Promise<string>} A promise that resolves to the factor sets string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const factorSets = await get();
+ */
+async function get() {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.FACTOR_SET_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.GET,
+        url
+    });
+}

package/dist/api/Factors.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retrieveFactor = retrieveFactor;
+exports.getFactorSets = getFactorSets;
+exports.Search = Search;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Retrieves a factor details by making a POST request to the factor API endpoint.
+ *
+ * @export
+ * @param {FactorRequest} payload - The factor request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the factor string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const factorRequest = {
+    
+    "activity": {
+         "factorId": 12345
+    }
+  };
+  
+  or
+
+  const factorRequest = {
+             "time" : {
+                "date": "2025-01-04"
+            },
+            "location": {
+                "country": "usa",
+                                "stateProvince": "new york"
+            },
+            "activity": {
+                            "type":"natural gas"
+            },
+            "includeDetails": true
+        };
+ * const factor = await retrieveFactor(factorRequest);
+ */
+async function retrieveFactor(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.FACTOR_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}
+/**
+ * Retrieves factor sets by making a GET request to the factor set API endpoint.
+ *
+ * @export
+ * @return {Promise<string>} A promise that resolves to the factor sets string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const factorSets = await getFactorSets();
+ */
+async function getFactorSets() {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.FACTOR_SET_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.GET,
+        url
+    });
+}
+/**
+ * Performs a search operation by making a POST request to the search API endpoint.
+ *
+ * @export
+ * @param {SearchRequest} payload - The search request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the search results string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const searchRequest = {
+    "time":{
+      "date": "2020-06-10"
+    },
+    "activity": {
+      "search" : "travel"},
+  "location": {
+      "country": "USA"
+    }
+  };
+ * const results = await Search(searchRequest);
+ */
+async function Search(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.SEARCH_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/Fugitive.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Performs scope 1 fugitve emission calculations by making a POST request to the fugitive API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+      "time": {
+        "date": "2025-01-04"
+      },
+      "location": {
+        "country": "usa"
+      },
+      "activity": {
+        "type": "R134A",
+        "value": 150,
+        "unit": "kg"
+      },
+      "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.FUGITIVE_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/FugitiveEmission.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Performs scope 1 fugitve emission calculations by making a POST request to the fugitive API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+      "time": {
+        "date": "2025-01-04"
+      },
+      "location": {
+        "country": "usa"
+      },
+      "activity": {
+        "type": "R134A",
+        "value": 150,
+        "unit": "kg"
+      },
+      "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.FUGITIVE_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/GenericCalculation.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Performs emission calculations by making a POST request to the generic calculation API endpoint.
+ *
+ * @export
+ * @param {GenericCalculationRequest} payload - The calculation request data to be sent to the API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @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":"Waste Combusted - Steel Cans:Default factor",
+                            "unit": "kg",
+                            "value": 1223123.121
+            },
+            "includeDetails": true
+        };
+ * const result = await calculate(calculationRequest);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.GENERIC_CALCULATION_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/Location.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * 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<string>} A promise that resolves to the purchased energy emission result string returned by the API
+ * @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);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.LOCATION_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/LocationEmission.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * 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<string>} A promise that resolves to the purchased energy emission result string returned by the API
+ * @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);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.LOCATION_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/Mobile.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const request_1 = require("../request");
+const Constants_1 = require("../Constants");
+const Client_1 = require("../Client");
+/**
+ * Performs Scope 1 mobile emissions related calculations by making a POST request to the mobile API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the mobile API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+    "time": {
+      "date": "2022-01-01"
+    },
+    "location": {
+      "country": "USA",
+      "stateProvince": "new york"
+    },
+    "activity": {
+      "type": "Diesel Fuel",
+      "value": 1500000,
+      "unit": "l"
+    },
+    "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.MOBILE_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/MobileEmission.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const request_1 = require("../request");
+const Constants_1 = require("../Constants");
+const Client_1 = require("../Client");
+/**
+ * Performs Scope 1 mobile emissions related calculations by making a POST request to the mobile API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the mobile API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+    "time": {
+      "date": "2022-01-01"
+    },
+    "location": {
+      "country": "USA",
+      "stateProvince": "new york"
+    },
+    "activity": {
+      "type": "Diesel Fuel",
+      "value": 1500000,
+      "unit": "l"
+    },
+    "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.MOBILE_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/Stationary.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Performs Scope 1 stationary calculations by making a POST request to the stationary API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the stationary API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+             "time" : {
+                "date": "2025-01-04"
+            },
+            "location": {
+                "country": "usa",
+                                "stateProvince": "new york"
+            },
+            "activity": {
+                            "type":"Coal - Lignite",
+                            "unit": "KJ",
+                            "value": 3
+            },
+            "includeDetails": true
+      };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.STATIONARY_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/StationaryEmission.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Performs Scope 1 stationary calculations by making a POST request to the stationary API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the stationary API
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+             "time" : {
+                "date": "2025-01-04"
+            },
+            "location": {
+                "country": "usa",
+                                "stateProvince": "new york"
+            },
+            "activity": {
+                            "type":"Coal - Lignite",
+                            "unit": "KJ",
+                            "value": 3
+            },
+            "includeDetails": true
+      };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.STATIONARY_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/TransportationAndDistribution.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculate = calculate;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Performs Scope 2 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.
+ *
+ * @export
+ * @param {CalculationRequest} payload - The calculation request data for transportation and distribution operations
+ * @return {Promise<string>} A promise that resolves to the calculation result string returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+             "time" : {
+                "date": "2025-01-04"
+            },
+            "location": {
+                "country": "usa"
+            },
+            "activity": {
+                "type": "Freight - Cargo Ship - Bulk Carrier - 0-9999 dwt",
+                            "unit": ["t","km"],
+                            "value": [1.0,1.0]
+            },
+            "includeDetails": true
+  };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.TRANSPORTATION_AND_DISTRIBUTION_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}