emissions-api-sdk 1.0.4 → 1.0.6

package/src/api/Metadata.ts

@@ -0,0 +1,174 @@
+import { Client } from "../Client";
+import { GET, METADATA_AREA_ENDPOINT, METADATA_TYPES_ENDPOINT, METADATA_UNITS_ENDPOINT, POST } from "../Constants";
+import { AreaResponse } from "../interfaces/response/AreaResponse";
+import { TypeResponse } from "../interfaces/response/TypeResponse";
+import { UnitResponse } from "../interfaces/response/UnitResponse";
+import { makeApiRequest } from "../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');
+ */
+export async function getTypes(
+  endpoint?: string
+): Promise<TypeResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + METADATA_TYPES_ENDPOINT;
+
+  return makeApiRequest<TypeResponse>({
+    method: 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');
+ */
+export async function postTypes(
+  endpoint?: string
+): Promise<TypeResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + METADATA_TYPES_ENDPOINT;
+
+  return makeApiRequest<TypeResponse>({
+    method: 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');
+ */
+export async function getArea(
+  endpoint?: string
+): Promise<AreaResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + METADATA_AREA_ENDPOINT;
+
+  return makeApiRequest<AreaResponse>({
+    method: 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');
+ */
+export async function postArea(
+  endpoint?: string
+): Promise<AreaResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + METADATA_AREA_ENDPOINT;
+
+  return makeApiRequest<AreaResponse>({
+    method: 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');
+ */
+export async function getUnits(
+  type?: string
+): Promise<UnitResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + METADATA_UNITS_ENDPOINT;
+
+  return makeApiRequest<UnitResponse>({
+    method: 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');
+ */
+export async function postUnits(
+  type?: string
+): Promise<UnitResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + METADATA_UNITS_ENDPOINT;
+
+  return makeApiRequest<UnitResponse>({
+    method: POST,
+    url,
+    data: type ? { type } : {},
+  });
+}

package/src/api/Mobile.ts

@@ -1,11 +1,8 @@
 import { makeApiRequest } from "../request";
-import { GET, MOBILE_API_AREA, MOBILE_API_PATH, MOBILE_API_TYPES, MOBILE_API_UNITS, POST } from "../Constants";
+import { MOBILE_API_PATH, POST } from "../Constants";
 import { CommonRequest } from "../interfaces/Api";
-import { AreaResponse } from "../interfaces/response/AreaResponse";
 import { EmissionResponse } from "../interfaces/response/EmissionResponse";
 import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
-import { TypeResponse } from "../interfaces/response/TypeResponse";
-import { UnitResponse } from "../interfaces/response/UnitResponse";
 import { Client } from "../Client";
 
 
@@ -47,76 +44,4 @@ export async function calculate(
     url,
     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();
- */
-export async function getTypes(
-): Promise<TypeResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + MOBILE_API_TYPES;
-
-  return makeApiRequest<TypeResponse>({
-    method: 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();
- */
-export async function getArea(
-): Promise<AreaResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + MOBILE_API_AREA;
-
-  return makeApiRequest<AreaResponse>({
-    method: 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");
- */
-export async function getUnits(
-  type : string
-): Promise<UnitResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + MOBILE_API_UNITS;
-
-  return makeApiRequest<UnitResponse>({
-    method: GET,
-    url,
-    params : { type }
-  });
 }

package/src/api/RealEstate.ts

@@ -0,0 +1,45 @@
+import { Client } from "../Client";
+import { REAL_ESTATE_API_PATH, POST } from "../Constants";
+import { CommonRequest } from "../interfaces/Api";
+import { EmissionResponse } from "../interfaces/response/EmissionResponse";
+import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
+import { makeApiRequest } from "../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);
+ */
+
+export async function calculate(
+  payload: CommonRequest
+): Promise<EmissionResponse | EmissionResponseWithDetails> {
+  const client = Client.getInstance();
+  const url =  client.getDomain() + REAL_ESTATE_API_PATH;
+
+  return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
+    method: POST,
+    url,
+    data: payload,
+  });
+}

package/src/api/Stationary.ts

@@ -1,11 +1,8 @@
 import { Client } from "../Client";
-import { GET, POST, STATIONARY_API_AREA, STATIONARY_API_PATH, STATIONARY_API_TYPES, STATIONARY_API_UNITS } from "../Constants";
+import { POST, STATIONARY_API_PATH } from "../Constants";
 import { CommonRequest } from "../interfaces/Api";
-import { AreaResponse } from "../interfaces/response/AreaResponse";
 import { EmissionResponse } from "../interfaces/response/EmissionResponse";
 import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
-import { TypeResponse } from "../interfaces/response/TypeResponse";
-import { UnitResponse } from "../interfaces/response/UnitResponse";
 import { makeApiRequest } from "../request";
 
 
@@ -47,74 +44,4 @@ export async function calculate(
     url,
     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();
- */
-export async function getTypes(
-): Promise<TypeResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + STATIONARY_API_TYPES;
-
-  return makeApiRequest<TypeResponse>({
-    method: 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();
- */
-export async function getArea(
-): Promise<AreaResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + STATIONARY_API_AREA;
-
-  return makeApiRequest<AreaResponse>({
-    method: 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");
- */
-export async function getUnits(
-  type : string
-): Promise<UnitResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + STATIONARY_API_UNITS;
-
-  return makeApiRequest<UnitResponse>({
-    method: GET,
-    url,
-    params : { type }
-  });
 }

package/src/api/TransportationAndDistribution.ts

@@ -1,11 +1,8 @@
 import { Client } from "../Client";
-import { TRANSPORTATION_AND_DISTRIBUTION_API_PATH, POST, TRANSPORTATION_AND_DISTRIBUTION_API_TYPES, GET, TRANSPORTATION_AND_DISTRIBUTION_API_AREA, TRANSPORTATION_AND_DISTRIBUTION_API_UNITS } from "../Constants";
+import { TRANSPORTATION_AND_DISTRIBUTION_API_PATH, POST } from "../Constants";
 import { CalculationRequest } from "../interfaces/Api";
-import { AreaResponse } from "../interfaces/response/AreaResponse";
 import { EmissionResponse } from "../interfaces/response/EmissionResponse";
 import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
-import { TypeResponse } from "../interfaces/response/TypeResponse";
-import { UnitResponse } from "../interfaces/response/UnitResponse";
 import { makeApiRequest } from "../request";
 
 /**
@@ -46,73 +43,3 @@ export async function calculate(
   });
 }
 
-
-/**
- * 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();
- */
-export async function getTypes(
-): Promise<TypeResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + TRANSPORTATION_AND_DISTRIBUTION_API_TYPES;
-
-  return makeApiRequest<TypeResponse>({
-    method: 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();
- */
-export async function getArea(
-): Promise<AreaResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + TRANSPORTATION_AND_DISTRIBUTION_API_AREA;
-
-  return makeApiRequest<AreaResponse>({
-    method: 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");
- */
-export async function getUnits(
-  type : string
-): Promise<UnitResponse> {
-  const client = Client.getInstance();
-  const url = client.getDomain() + TRANSPORTATION_AND_DISTRIBUTION_API_UNITS;
-
-  return makeApiRequest<UnitResponse>({
-    method: GET,
-    url,
-    params : { type }
-  });
-}

package/src/index.ts

@@ -8,6 +8,9 @@ export * as TransportationAndDistribution from './api/TransportationAndDistribut
 export * as Usage from './api/Usage'
 export * as Factor from './api/Factor';
 export * as FactorSets from './api/FactorSets'
+export * as EconomicActivity from './api/EconomicActivity';
+export * as RealEstate from './api/RealEstate';
+export * as Metadata from './api/Metadata';
 export { ClientConfig } from './interfaces/Config';
 
 // Response interfaces

package/src/interfaces/response/FactorResponse.ts

@@ -62,13 +62,6 @@ export interface FactorResponse {
   
   /** Publication end date in ISO format (optional) */
   publishedTo?: string;
-
-  /** Effective start date in ISO format (optional) */
-  effectiveFrom?: string;
-
-  /** Effective end date in ISO format (optional) */
-  effectiveTo?: string;
-
   
   /** Geographic region (e.g., "Earth", "India") */
   region: string;