emissions-api-sdk 1.0.4 → 1.0.6

package/dist/api/Mobile.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.calculate = calculate;
-exports.getTypes = getTypes;
-exports.getArea = getArea;
-exports.getUnits = getUnits;
 const request_1 = require("../request");
 const Constants_1 = require("../Constants");
 const Client_1 = require("../Client");
@@ -42,64 +39,3 @@ async function calculate(payload) {
         data: payload,
     });
 }
-/**
- * Retrieves available mobile emission calculation types by making a GET request to the API endpoint.
- *
- * @export
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available mobile emission types
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * // Get all available mobile emission types
- * const types = await getTypes();
- */
-async function getTypes() {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.MOBILE_API_TYPES;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves information about geographical areas supported by the mobile emissions API.
- *
- * @export
- * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * const areas = await getArea();
- */
-async function getArea() {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.MOBILE_API_AREA;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves available units for a specific mobile emission type.
- *
- * @export
- * @param {string} type - The mobile emission type to get units for (e.g., "Diesel Fuel")
- * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * Get units for the "Cars:B20:(NE)" emission mobile type with subtype
- * const units = await getUnits("Cars:B20:(NE)");
-
- * Get units for the "Cars by Size - Large Car - Hybrid" emission mobile type without subtype
- * const units = await getUnits("Cars by Size - Large Car - Hybrid");
- */
-async function getUnits(type) {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.MOBILE_API_UNITS;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url,
-        params: { type }
-    });
-}

package/dist/api/RealEstate.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 3 Real estate emission calculations by making a POST request to the real estate API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the API
+ * @return {Promise<EmissionResponse | EmissionResponseWithDetails>} A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+    "time": {
+      "date": "2025-01-04"
+    },
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "type": "Commercial Real Estate:Industrial distribution warehouse",
+      "value": 17000.123,
+      "unit": "m2"
+    },
+    "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+async function calculate(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.REAL_ESTATE_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}

package/dist/api/Stationary.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.calculate = calculate;
-exports.getTypes = getTypes;
-exports.getArea = getArea;
-exports.getUnits = getUnits;
 const Client_1 = require("../Client");
 const Constants_1 = require("../Constants");
 const request_1 = require("../request");
@@ -42,63 +39,3 @@ async function calculate(payload) {
         data: payload,
     });
 }
-/**
- * Retrieves available stationary emission calculation types by making a GET request to the API endpoint.
- *
- * @export
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available stationary emission types
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * const types = await getTypes();
- */
-async function getTypes() {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.STATIONARY_API_TYPES;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves information about geographical areas supported by the stationary emissions API.
- *
- * @export
- * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * const areas = await getArea();
- */
-async function getArea() {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.STATIONARY_API_AREA;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves available units for a specific stationary emission type.
- *
- * @export
- * @param {string} type - The stationary emission type to get units for (e.g., "Coal - Lignite")
- * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * Get units for the "Petroleum Based Greases - NC:A" emission stationary type with subtype
- * const units = await getUnits("Petroleum Based Greases - NC:A");
-
- * Get units for the "Jet Kerosene" emission stationary type without subtype
- * const units = await getUnits("Jet Kerosene");
- */
-async function getUnits(type) {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.STATIONARY_API_UNITS;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url,
-        params: { type }
-    });
-}

package/dist/api/TransportationAndDistribution.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.calculate = calculate;
-exports.getTypes = getTypes;
-exports.getArea = getArea;
-exports.getUnits = getUnits;
 const Client_1 = require("../Client");
 const Constants_1 = require("../Constants");
 const request_1 = require("../request");
@@ -41,63 +38,3 @@ async function calculate(payload) {
         data: payload,
     });
 }
-/**
- * Retrieves available transportation and distribution calculation types by making a GET request to the API endpoint.
- *
- * @export
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available transportation and distribution calculation types
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * const types = await getTypes();
- */
-async function getTypes() {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.TRANSPORTATION_AND_DISTRIBUTION_API_TYPES;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves information about geographical areas supported by the transportation and distribution API.
- *
- * @export
- * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * const areas = await getArea();
- */
-async function getArea() {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.TRANSPORTATION_AND_DISTRIBUTION_API_AREA;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves available units for a specific transportation and distribution calculation type.
- *
- * @export
- * @param {string} type - The transportation and distribution calculation type to get units for (e.g., "Freight - Cargo Ship")
- * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
- * @throws {Error} May throw an error if the API request fails
- *
- * @example
- * // Get units for the "Business Travel - Cars:Diesel - Small" transportation and distribution type without subtype
- * const units = await getUnits("Business Travel - Cars:Diesel - Small");
- *
- * // Get units for the "Business Travel - Cars" transportation and distribution type with subtype
- * const units = await getUnits("Business Travel - Cars");
- */
-async function getUnits(type) {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.TRANSPORTATION_AND_DISTRIBUTION_API_UNITS;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url,
-        params: { type }
-    });
-}