emissions-api-sdk 1.0.5 → 1.0.7

package/dist/api/Fugitive.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 fugitive 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 fugitive 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.FUGITIVE_API_TYPES;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves information about geographical areas supported by the fugitive 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.FUGITIVE_API_AREA;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves available units for a specific fugitive emission type.
- *
- * @export
- * @param {string} type - The fugitive emission type to get units for (e.g., "R134A")
- * @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 "Natural Gas - Scope 3:AAA" emission fugitive type with subtype
- * const units = await getUnits("Natural Gas - Scope 3:AAA");
-
- * // Get units for the "R-426A" emission fugitive type without subtype
- * const units = await getUnits("R-426A");
- */
-async function getUnits(type) {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.FUGITIVE_API_UNITS;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url,
-        params: { type }
-    });
-}

package/dist/api/Location.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,61 +39,3 @@ async function calculate(payload) {
         data: payload,
     });
 }
-/**
- * Retrieves available location-based calculation types by making a GET request to the location types API endpoint.
- *
- * @export
- * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available location-based 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.LOCATION_TYPES;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves information about geographical areas supported by the location-based calculation 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.LOCATION_API_AREA;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves available units for a specific location-based calculation type.
- *
- * @export
- * @param {string} type - The location-based calculation type to get units for (e.g., "electricity")
- * @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 "electricity" location type
- * const units = await getUnits("electricity");
- */
-async function getUnits(type) {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.LOCATION_API_UNITS;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url,
-        params: { type }
-    });
-}

package/dist/api/Metadata.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTypes = getTypes;
+exports.postTypes = postTypes;
+exports.getArea = getArea;
+exports.postArea = postArea;
+exports.getUnits = getUnits;
+exports.postUnits = postUnits;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Retrieves available emission source types for a specific endpoint using GET request.
+ *
+ * @export
+ * @param {string} [endpoint] - The endpoint name to retrieve types for. Defaults to 'calculation' if not provided.
+ * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available types
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get types for calculation endpoint (default)
+ * const types = await getTypes();
+ *
+ * // Get types for a specific endpoint
+ * const locationTypes = await getTypes('location');
+ */
+async function getTypes(endpoint) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.METADATA_TYPES_ENDPOINT;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.GET,
+        url,
+        params: endpoint ? { endpoint } : undefined,
+    });
+}
+/**
+ * Retrieves available emission source types for a specific endpoint using POST request.
+ *
+ * @export
+ * @param {string} [endpoint] - The endpoint name to retrieve types for. Defaults to 'calculation' if not provided.
+ * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available types
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get types for calculation endpoint (default)
+ * const types = await postTypes();
+ *
+ * // Get types for a specific endpoint
+ * const stationaryTypes = await postTypes('stationary');
+ */
+async function postTypes(endpoint) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.METADATA_TYPES_ENDPOINT;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: endpoint ? { endpoint } : {},
+    });
+}
+/**
+ * Retrieves available geographic locations for a specific endpoint using GET request.
+ *
+ * @export
+ * @param {string} [endpoint] - The endpoint name to retrieve locations for. Defaults to 'calculation' if not provided.
+ * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the available locations
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get areas for calculation endpoint (default)
+ * const areas = await getArea();
+ *
+ * // Get areas for a specific endpoint
+ * const mobileAreas = await getArea('mobile');
+ */
+async function getArea(endpoint) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.METADATA_AREA_ENDPOINT;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.GET,
+        url,
+        params: endpoint ? { endpoint } : undefined,
+    });
+}
+/**
+ * Retrieves available geographic locations for a specific endpoint using POST request.
+ *
+ * @export
+ * @param {string} [endpoint] - The endpoint name to retrieve locations for. Defaults to 'calculation' if not provided.
+ * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the available locations
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get areas for calculation endpoint (default)
+ * const areas = await postArea();
+ *
+ * // Get areas for a specific endpoint
+ * const fugitiveAreas = await postArea('fugitive');
+ */
+async function postArea(endpoint) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.METADATA_AREA_ENDPOINT;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: endpoint ? { endpoint } : {},
+    });
+}
+/**
+ * Retrieves available measurement units for a specific type using GET request.
+ *
+ * @export
+ * @param {string} [type] - The emission source type to retrieve units for. If not provided, returns the full UOM table.
+ * @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 all units
+ * const allUnits = await getUnits();
+ *
+ * // Get units for a specific type
+ * const naturalGasUnits = await getUnits('Natural Gas');
+ */
+async function getUnits(type) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.METADATA_UNITS_ENDPOINT;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.GET,
+        url,
+        params: type ? { type } : undefined,
+    });
+}
+/**
+ * Retrieves available measurement units for a specific type using POST request.
+ *
+ * @export
+ * @param {string} [type] - The emission source type to retrieve units for. If not provided, returns the full UOM table.
+ * @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 all units
+ * const allUnits = await postUnits();
+ *
+ * // Get units for a specific type
+ * const jetKeroseneUnits = await postUnits('Jet Kerosene');
+ */
+async function postUnits(type) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.METADATA_UNITS_ENDPOINT;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: type ? { type } : {},
+    });
+}

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

@@ -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,61 +38,3 @@ async function calculate(payload) {
         data: payload,
     });
 }
-/**
- * Retrieves available Real estate 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 Real estate 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.REAL_ESTATE_API_TYPES;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves information about geographical areas supported by the real estate 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.REAL_ESTATE_API_AREA;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url
-    });
-}
-/**
- * Retrieves available units for a specific Real estate emission type.
- *
- * @export
- * @param {string} type - The Real estate emission type to get units for (e.g., "R134A")
- * @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 "Commercial Real Estate:Industrial distribution warehouse" emission real estate type with subtype
- * const units = await getUnits("Commercial Real Estate:Industrial distribution warehouse");
-
- */
-async function getUnits(type) {
-    const client = Client_1.Client.getInstance();
-    const url = client.getDomain() + Constants_1.REAL_ESTATE_API_UNITS;
-    return (0, request_1.makeApiRequest)({
-        method: Constants_1.GET,
-        url,
-        params: { type }
-    });
-}

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 }
-    });
-}

package/dist/api/TypeRecommender.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.search = search;
+const Client_1 = require("../Client");
+const Constants_1 = require("../Constants");
+const request_1 = require("../request");
+/**
+ * Search for activity types using semantic search with location, time, and license context. Supports pagination.
+ *
+ * @export
+ * @param {SearchRequest} payload - The search request data to be sent to the API
+ * @return {Promise<TypeResponse>} A promise that resolves to the activity types returned by the API
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "search": "electricity"
+    }
+  });
+
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa",
+      "stateProvince": "california"
+    },
+    "time": {
+      "date": "2025-06-10"
+    },
+    "activity": {
+      "search": "electricity"
+    },
+    "pagination": {
+      "page": 1,
+      "size": 10
+    }
+  });
+ 
+ * @example
+ * const result = await search({
+    "location": {
+      "country": "usa",
+      "powerGrid": "WECC"
+    },
+    "activity": {
+      "search": "renewable energy"
+    }
+  });
+ */
+async function search(payload) {
+    const client = Client_1.Client.getInstance();
+    const url = client.getDomain() + Constants_1.TYPE_RECOMMENDER_API_PATH;
+    return (0, request_1.makeApiRequest)({
+        method: Constants_1.POST,
+        url,
+        data: payload,
+    });
+}