Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | 1x 1x 1x 1x 3x 3x 3x | import { Client } from "../Client";
import { PHYSICAL_ACTIVITY_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 Physical activity emission calculations by making a POST request to the physical activity API endpoint.
* Supports attribution for private companies using equity/debt based calculations or EVIC (Enterprise Value Including Cash).
*
* @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
* // Basic physical activity request
* const request = {
"time": {
"date": "2025-01-23"
},
"location": {
"country": "usa"
},
"activity": {
"type": "commercial real estate",
"value": 0.1,
"unit": "km2"
},
"includeDetails": true
};
* const result = await calculate(request);
*
* @example
* // Physical activity request with attribution (equity/debt based for private companies)
* const requestWithEquityDebt = {
"time": {
"date": "2025-01-23"
},
"location": {
"country": "usa"
},
"activity": {
"type": "commercial real estate",
"value": 0.1,
"unit": "km2"
},
"attribution": {
"outstandingAmount": 1000000,
"totalEquity": 3000000,
"totalDebt": 2000000
},
"includeDetails": true
};
* const resultWithEquityDebt = await calculate(requestWithEquityDebt);
*
* @example
* // Physical activity request with attribution (EVIC based)
* const requestWithEVIC = {
"time": {
"date": "2025-01-23"
},
"location": {
"country": "usa"
},
"activity": {
"type": "commercial real estate",
"value": 0.1,
"unit": "km2"
},
"attribution": {
"outstandingAmount": 1000000.0,
"evic": 10000000.0
},
"includeDetails": true
};
* const resultWithEVIC = await calculate(requestWithEVIC);
*/
export async function calculate(
payload: CommonRequest
): Promise<EmissionResponse | EmissionResponseWithDetails> {
const client = Client.getInstance();
const url = client.getDomain() + PHYSICAL_ACTIVITY_API_PATH;
return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
method: POST,
url,
data: payload,
});
}
|