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 | 1x 1x 1x 1x 2x 2x 2x | import { Client } from "../Client";
import { ECONOMIC_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 Spend based emission calculations by making a POST request to the economic activity API endpoint.
* Supports optional attribution with revenue for proportional allocation.
*
* @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 economic activity request
* const request = {
"time": {
"date": "2025-01-04"
},
"location": {
"country": "usa"
},
"activity": {
"type": "accomodation",
"value": 1500.12,
"unit": "usd"
},
"includeDetails": false
};
* const result = await calculate(request);
*
* @example
* // Economic activity request with revenue attribution
* const requestWithAttribution = {
"time": {
"date": "2025-01-04"
},
"location": {
"country": "usa"
},
"activity": {
"type": "accomodation",
"value": 1500.12,
"unit": "usd"
},
"attribution": {
"outstandingAmount": 500000.0,
"revenue": 2000000.0
},
"includeDetails": true
};
* const resultWithAttribution = await calculate(requestWithAttribution);
*/
export async function calculate(
payload: CommonRequest
): Promise<EmissionResponse | EmissionResponseWithDetails> {
const client = Client.getInstance();
const url = client.getDomain() + ECONOMIC_ACTIVITY_API_PATH;
return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
method: POST,
url,
data: payload,
});
}
|