emissions-api-sdk 1.0.1 → 1.0.3

package/src/api/Factor.ts

@@ -1,6 +1,11 @@
 import { Client } from "../Client";
 import { FACTOR_API_AREA, FACTOR_API_PATH, FACTOR_API_TYPES, FACTOR_API_UNITS, GET, POST, SEARCH_API_AREA, SEARCH_API_PATH } from "../Constants";
 import { FactorRequest, SearchRequest } from "../interfaces/Api";
+import { AreaResponse } from "../interfaces/response/AreaResponse";
+import { FactorResponse } from "../interfaces/response/FactorResponse";
+import { SearchResponse } from "../interfaces/response/SearchResponse";
+import { TypeResponse } from "../interfaces/response/TypeResponse";
+import { UnitResponse } from "../interfaces/response/UnitResponse";
 import { makeApiRequest } from "../request";
 
 /**
@@ -8,7 +13,7 @@ import { makeApiRequest } from "../request";
  * 
  * @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
+ * @return {Promise<FactorResponse>} A promise that resolves to the FactorResponse returned by the API
  * @throws {Error} May throw an error if the API request fails
  * 
  * @example
@@ -38,11 +43,11 @@ import { makeApiRequest } from "../request";
 
 export async function retrieveFactor(
   payload: FactorRequest
-): Promise<string> {
+): Promise<FactorResponse> {
   const client = Client.getInstance();
   const url =  client.getDomain() + FACTOR_API_PATH;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<FactorResponse>({
     method: POST,
     url,
     data: payload,
@@ -52,14 +57,14 @@ export async function retrieveFactor(
 
 /**
  * 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
+ * @return {Promise<SearchResponse>} A promise that resolves to the search results returned by the API
  * @throws {Error} May throw an error if the API request fails
- * 
+ *
  * @example
- * const searchRequest = { 
+ * const searchRequest = {
     "time":{
       "date": "2020-06-10"
     },
@@ -73,11 +78,11 @@ export async function retrieveFactor(
  */
 export async function search(
   payload: SearchRequest
-): Promise<string> {
+): Promise<SearchResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + SEARCH_API_PATH;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<SearchResponse>({
     method: POST,
     url,
     data: payload,
@@ -88,18 +93,18 @@ export async function search(
  * Retrieves available emission factor types by making a GET request to the API endpoint.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the available emission factor types
+ * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available emission factor types
  * @throws {Error} May throw an error if the API request fails
  *
  * @example
  * const types = await getTypes();
  */
 export async function getTypes(
-): Promise<string> {
+): Promise<TypeResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + FACTOR_API_TYPES;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<TypeResponse>({
     method: GET,
     url
   });
@@ -109,18 +114,18 @@ export async function getTypes(
  * Retrieves information about geographical areas supported by the factor search API.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the supported geographical areas
+ * @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();
+ * const areas = await getSearchArea();
  */
 export async function getSearchArea(
-): Promise<string> {
+): Promise<AreaResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + SEARCH_API_AREA;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<AreaResponse>({
     method: GET,
     url
   });
@@ -130,17 +135,17 @@ export async function getSearchArea(
  * Retrieves information about geographical areas supported by the factor API.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the supported geographical areas
+ * @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<string> {
+export async function getArea(): Promise<AreaResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + FACTOR_API_AREA;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<AreaResponse>({
     method: GET,
     url
   });
@@ -151,7 +156,7 @@ export async function getArea(): Promise<string> {
  *
  * @export
  * @param {string} type - The emission factor type to get units for (e.g., "Natural Gas - Scope 3:AAA")
- * @return {Promise<string>} A promise that resolves to a string containing the available units
+ * @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
@@ -163,11 +168,11 @@ export async function getArea(): Promise<string> {
  */
 export async function getUnits(
   type : string
-): Promise<string> {
+): Promise<UnitResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + FACTOR_API_UNITS;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<UnitResponse>({
     method: GET,
     url,
     params : { type }

package/src/api/FactorSets.ts

@@ -1,23 +1,24 @@
 import { Client } from "../Client";
 import { FACTOR_SET_API_PATH, GET } from "../Constants";
+import { FactorSetResponse } from "../interfaces/response/FactorSetResponse";
 import { makeApiRequest } from "../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
+ * @return {Promise<FactorSetResponse>} A promise that resolves to the  FactorSetResponse returned by the API
  * @throws {Error} May throw an error if the API request fails
  * 
  * @example
  * const factorSets = await get();
  */
 export async function get(
-): Promise<string> {
+): Promise<FactorSetResponse> {
 const client = Client.getInstance();
   const url = client.getDomain() + FACTOR_SET_API_PATH;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<FactorSetResponse>({
     method: GET,
     url
   });

package/src/api/Fugitive.ts

@@ -1,16 +1,21 @@
 import { Client } from "../Client";
 import { FUGITIVE_API_AREA, FUGITIVE_API_PATH, FUGITIVE_API_TYPES, FUGITIVE_API_UNITS, GET, 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 { makeApiRequest } from "../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
+ * @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": {
@@ -31,11 +36,11 @@ import { makeApiRequest } from "../request";
 
 export async function calculate(
   payload: CommonRequest
-): Promise<string> {
+): Promise<EmissionResponse | EmissionResponseWithDetails> {
   const client = Client.getInstance();
   const url =  client.getDomain() + FUGITIVE_API_PATH;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
     method: POST,
     url,
     data: payload,
@@ -46,18 +51,18 @@ export async function calculate(
  * Retrieves available fugitive emission calculation types by making a GET request to the API endpoint.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the available fugitive emission types
+ * @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();
  */
 export async function getTypes(
-): Promise<string> {
+): Promise<TypeResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + FUGITIVE_API_TYPES;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<TypeResponse>({
     method: GET,
     url
   });
@@ -67,18 +72,18 @@ export async function getTypes(
  * Retrieves information about geographical areas supported by the fugitive emissions API.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the supported geographical areas
+ * @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<string> {
+): Promise<AreaResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + FUGITIVE_API_AREA;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<AreaResponse>({
     method: GET,
     url
   });
@@ -89,7 +94,7 @@ export async function getArea(
  *
  * @export
  * @param {string} type - The fugitive emission type to get units for (e.g., "R134A")
- * @return {Promise<string>} A promise that resolves to a string containing the available units
+ * @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
@@ -101,11 +106,11 @@ export async function getArea(
  */
 export async function getUnits(
   type : string
-): Promise<string> {
+): Promise<UnitResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + FUGITIVE_API_UNITS;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<UnitResponse>({
     method: GET,
     url,
     params : { type }

package/src/api/Location.ts

@@ -1,16 +1,21 @@
 import { Client } from "../Client";
 import { GET, LOCATION_API_AREA, LOCATION_API_PATH, LOCATION_API_UNITS, LOCATION_TYPES, POST } from "../Constants";
 import { LocationRequest } 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";
 
 /**
  * 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
+ * @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 calculationRequest = {
     "time" : {
@@ -31,11 +36,11 @@ import { makeApiRequest } from "../request";
  */
 export async function calculate(
   payload: LocationRequest
-): Promise<string> {
+): Promise<EmissionResponse | EmissionResponseWithDetails> {
   const client = Client.getInstance();
   const url = client.getDomain() + LOCATION_API_PATH;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
     method: POST,
     url,
     data: payload,
@@ -47,19 +52,19 @@ export async function calculate(
  * Retrieves available location-based calculation types by making a GET request to the location types API endpoint.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the available location-based calculation types
+ * @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();
  */
 export async function getTypes(
-): Promise<string> {
+): Promise<TypeResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + LOCATION_TYPES;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<TypeResponse>({
     method: GET,
     url
   });
@@ -69,18 +74,18 @@ export async function getTypes(
  * Retrieves information about geographical areas supported by the location-based calculation API.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the supported geographical areas
+ * @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<string> {
+): Promise<AreaResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + LOCATION_API_AREA;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<AreaResponse>({
     method: GET,
     url
   });
@@ -91,7 +96,7 @@ export async function getArea(
  *
  * @export
  * @param {string} type - The location-based calculation type to get units for (e.g., "electricity")
- * @return {Promise<string>} A promise that resolves to a string containing the available units
+ * @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
@@ -100,11 +105,11 @@ export async function getArea(
  */
 export async function getUnits(
   type : string
-): Promise<string> {
+): Promise<UnitResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + LOCATION_API_UNITS;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<UnitResponse>({
     method: GET,
     url,
     params : { type }

package/src/api/Mobile.ts

@@ -1,17 +1,22 @@
 import { makeApiRequest } from "../request";
 import { GET, MOBILE_API_AREA, MOBILE_API_PATH, MOBILE_API_TYPES, MOBILE_API_UNITS, 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";
 
 
 /**
  * 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
+ * @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": {
@@ -33,11 +38,11 @@ import { Client } from "../Client";
 
 export async function calculate(
   payload: CommonRequest
-): Promise<string> {
+): Promise<EmissionResponse | EmissionResponseWithDetails> {
   const client = Client.getInstance();
   const url = client.getDomain() + MOBILE_API_PATH;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
     method: POST,
     url,
     data: payload,
@@ -49,21 +54,19 @@ export async function calculate(
  * Retrieves available mobile emission calculation types by making a GET request to the API endpoint.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the available mobile emission types
+ * @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();
- * const typesData = JSON.parse(types);
- * console.log("Available mobile emission types:", typesData);
  */
 export async function getTypes(
-): Promise<string> {
+): Promise<TypeResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + MOBILE_API_TYPES;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<TypeResponse>({
     method: GET,
     url
   });
@@ -73,18 +76,18 @@ export async function getTypes(
  * Retrieves information about geographical areas supported by the mobile emissions API.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the supported geographical areas
+ * @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<string> {
+): Promise<AreaResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + MOBILE_API_AREA;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<AreaResponse>({
     method: GET,
     url
   });
@@ -95,7 +98,7 @@ export async function getArea(
  *
  * @export
  * @param {string} type - The mobile emission type to get units for (e.g., "Diesel Fuel")
- * @return {Promise<string>} A promise that resolves to a string containing the available units
+ * @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
@@ -107,11 +110,11 @@ export async function getArea(
  */
 export async function getUnits(
   type : string
-): Promise<string> {
+): Promise<UnitResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + MOBILE_API_UNITS;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<UnitResponse>({
     method: GET,
     url,
     params : { type }

package/src/api/Stationary.ts

@@ -1,17 +1,22 @@
 import { Client } from "../Client";
 import { GET, POST, STATIONARY_API_AREA, STATIONARY_API_PATH, STATIONARY_API_TYPES, STATIONARY_API_UNITS } 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";
 
 
 /**
  * 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
+ * @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" : {
@@ -33,11 +38,11 @@ import { makeApiRequest } from "../request";
 
 export async function calculate(
   payload: CommonRequest
-): Promise<string> {
+): Promise<EmissionResponse | EmissionResponseWithDetails> {
   const client = Client.getInstance();
   const url =  client.getDomain() + STATIONARY_API_PATH;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
     method: POST,
     url,
     data: payload,
@@ -48,18 +53,18 @@ export async function calculate(
  * Retrieves available stationary emission calculation types by making a GET request to the API endpoint.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the available stationary emission types
+ * @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<string> {
+): Promise<TypeResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + STATIONARY_API_TYPES;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<TypeResponse>({
     method: GET,
     url
   });
@@ -69,18 +74,18 @@ export async function getTypes(
  * Retrieves information about geographical areas supported by the stationary emissions API.
  *
  * @export
- * @return {Promise<string>} A promise that resolves to a string containing the supported geographical areas
+ * @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<string> {
+): Promise<AreaResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + STATIONARY_API_AREA;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<AreaResponse>({
     method: GET,
     url
   });
@@ -91,7 +96,7 @@ export async function getArea(
  *
  * @export
  * @param {string} type - The stationary emission type to get units for (e.g., "Coal - Lignite")
- * @return {Promise<string>} A promise that resolves to a string containing the available units
+ * @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
@@ -103,11 +108,11 @@ export async function getArea(
  */
 export async function getUnits(
   type : string
-): Promise<string> {
+): Promise<UnitResponse> {
   const client = Client.getInstance();
   const url = client.getDomain() + STATIONARY_API_UNITS;
 
-  return makeApiRequest<string>({
+  return makeApiRequest<UnitResponse>({
     method: GET,
     url,
     params : { type }