emissions-api-sdk 1.0.0 → 1.0.1

package/dist/types/api/Factors.d.ts

@@ -1,68 +0,0 @@
-import { FactorRequest, SearchRequest } from "../interfaces/Api";
-/**
- * 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);
- */
-export declare function retrieveFactor(payload: FactorRequest): Promise<string>;
-/**
- * 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();
- */
-export declare function getFactorSets(): Promise<string>;
-/**
- * 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);
- */
-export declare function Search(payload: SearchRequest): Promise<string>;

package/dist/types/api/FugitiveEmission.d.ts

@@ -1,27 +0,0 @@
-import { CommonRequest } from "../interfaces/Api";
-/**
- * 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);
- */
-export declare function calculate(payload: CommonRequest): Promise<string>;

package/dist/types/api/GenericCalculation.d.ts

@@ -1,28 +0,0 @@
-import { GenericCalculationRequest } from "../interfaces/Api";
-/**
- * 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);
- */
-export declare function calculate(payload: GenericCalculationRequest): Promise<string>;

package/dist/types/api/LocationEmission.d.ts

@@ -1,28 +0,0 @@
-import { LocationRequest } from "../interfaces/Api";
-/**
- * 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);
- */
-export declare function calculate(payload: LocationRequest): Promise<string>;

package/dist/types/api/MobileEmission.d.ts

@@ -1,28 +0,0 @@
-import { CommonRequest } from "../interfaces/Api";
-/**
- * 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);
- */
-export declare function calculate(payload: CommonRequest): Promise<string>;

package/dist/types/api/StationaryEmission.d.ts

@@ -1,28 +0,0 @@
-import { CommonRequest } from "../interfaces/Api";
-/**
- * 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);
- */
-export declare function calculate(payload: CommonRequest): Promise<string>;

package/dist/types/api/TransportationDistributionEmission.d.ts

@@ -1,27 +0,0 @@
-import { GenericCalculationRequest } from "../interfaces/Api";
-/**
- * Performs Scope 2 transportation and distribution emission calculations by making a POST request to the transportation and distribution API endpoint.
- *
- * @export
- * @param {GenericCalculationRequest} 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);
- */
-export declare function calculate(payload: GenericCalculationRequest): Promise<string>;