emissions-api-sdk 1.0.12 → 1.0.13

package/dist/coverage/lcov.info

@@ -12,59 +12,59 @@ FN:269,(anonymous_9)
 FN:303,(anonymous_10)
 FNF:10
 FNH:8
-FNDA:43,(anonymous_1)
-FNDA:48,(anonymous_2)
-FNDA:66,(anonymous_3)
-FNDA:77,(anonymous_4)
+FNDA:50,(anonymous_1)
+FNDA:55,(anonymous_2)
+FNDA:80,(anonymous_3)
+FNDA:91,(anonymous_4)
 FNDA:6,(anonymous_5)
 FNDA:4,(anonymous_6)
 FNDA:0,(anonymous_7)
 FNDA:0,(anonymous_8)
 FNDA:4,(anonymous_9)
 FNDA:8,(anonymous_10)
-DA:1,5
-DA:3,5
-DA:4,5
-DA:6,5
-DA:7,5
-DA:25,43
-DA:26,43
-DA:27,43
-DA:28,43
+DA:1,6
+DA:3,6
+DA:4,6
+DA:6,6
+DA:7,6
+DA:25,50
+DA:26,50
+DA:27,50
+DA:28,50
 DA:29,1
 DA:30,1
 DA:31,1
-DA:33,42
-DA:34,42
-DA:35,42
-DA:38,43
-DA:39,43
-DA:40,43
-DA:41,43
-DA:42,43
-DA:43,43
-DA:88,48
+DA:33,49
+DA:34,49
+DA:35,49
+DA:38,50
+DA:39,50
+DA:40,50
+DA:41,50
+DA:42,50
+DA:43,50
+DA:88,55
 DA:89,1
-DA:93,47
+DA:93,54
 DA:94,1
-DA:98,46
+DA:98,53
 DA:99,1
-DA:103,45
+DA:103,52
 DA:104,1
-DA:108,44
+DA:108,51
 DA:109,1
-DA:114,43
-DA:116,43
+DA:114,50
+DA:116,50
 DA:117,1
 DA:118,1
-DA:119,42
+DA:119,49
 DA:120,6
-DA:122,36
-DA:124,43
-DA:138,66
-DA:160,77
+DA:122,43
+DA:124,50
+DA:138,80
+DA:160,91
 DA:161,1
-DA:165,76
+DA:165,90
 DA:181,6
 DA:182,5
 DA:183,5
@@ -89,54 +89,54 @@ LF:63
 LH:61
 BRDA:23,0,0,0
 BRDA:25,1,0,7
-BRDA:25,2,0,37
+BRDA:25,2,0,44
 BRDA:25,3,0,7
-BRDA:25,4,0,43
+BRDA:25,4,0,50
 BRDA:28,5,0,1
-BRDA:28,5,1,42
+BRDA:28,5,1,49
 BRDA:40,6,0,0
-BRDA:40,6,1,43
-BRDA:40,7,0,43
-BRDA:40,7,1,43
+BRDA:40,6,1,50
+BRDA:40,7,0,50
+BRDA:40,7,1,50
 BRDA:41,8,0,2
-BRDA:41,8,1,41
-BRDA:41,9,0,43
-BRDA:41,9,1,43
+BRDA:41,8,1,48
+BRDA:41,9,0,50
+BRDA:41,9,1,50
 BRDA:41,10,0,4
-BRDA:41,10,1,37
+BRDA:41,10,1,44
 BRDA:43,11,0,0
-BRDA:43,11,1,43
+BRDA:43,11,1,50
 BRDA:88,12,0,1
-BRDA:88,12,1,47
-BRDA:88,13,0,48
+BRDA:88,12,1,54
+BRDA:88,13,0,55
 BRDA:88,13,1,1
 BRDA:93,14,0,1
-BRDA:93,14,1,46
-BRDA:93,15,0,47
+BRDA:93,14,1,53
+BRDA:93,15,0,54
 BRDA:93,15,1,2
 BRDA:98,16,0,1
-BRDA:98,16,1,45
-BRDA:98,17,0,46
-BRDA:98,17,1,37
-BRDA:98,17,2,36
+BRDA:98,16,1,52
+BRDA:98,17,0,53
+BRDA:98,17,1,44
+BRDA:98,17,2,43
 BRDA:103,18,0,1
-BRDA:103,18,1,44
-BRDA:103,19,0,45
+BRDA:103,18,1,51
+BRDA:103,19,0,52
 BRDA:103,19,1,8
 BRDA:108,20,0,1
-BRDA:108,20,1,43
-BRDA:108,21,0,44
+BRDA:108,20,1,50
+BRDA:108,21,0,51
 BRDA:108,21,1,7
 BRDA:116,22,0,1
-BRDA:116,22,1,42
-BRDA:116,23,0,43
+BRDA:116,22,1,49
+BRDA:116,23,0,50
 BRDA:116,23,1,1
 BRDA:119,24,0,6
-BRDA:119,24,1,36
-BRDA:119,25,0,42
+BRDA:119,24,1,43
+BRDA:119,25,0,49
 BRDA:119,25,1,6
 BRDA:160,26,0,1
-BRDA:160,26,1,76
+BRDA:160,26,1,90
 BRDA:181,27,0,5
 BRDA:181,27,1,1
 BRDA:183,28,0,3
@@ -162,32 +162,35 @@ TN:
 SF:src/Constants.ts
 FNF:0
 FNH:0
-DA:1,5
-DA:2,5
-DA:3,5
-DA:4,5
-DA:5,5
-DA:6,5
-DA:7,5
-DA:8,5
-DA:9,5
-DA:10,5
-DA:11,5
-DA:12,5
-DA:13,5
-DA:14,5
-DA:16,5
-DA:18,5
-DA:20,5
-DA:21,5
-DA:22,5
-DA:24,5
-DA:25,5
-DA:26,5
-DA:27,5
-DA:28,5
-LF:24
-LH:24
+DA:1,8
+DA:2,8
+DA:3,8
+DA:4,8
+DA:5,8
+DA:6,8
+DA:7,8
+DA:8,8
+DA:9,8
+DA:10,8
+DA:11,8
+DA:12,8
+DA:13,8
+DA:14,8
+DA:15,8
+DA:16,8
+DA:18,8
+DA:20,8
+DA:22,8
+DA:23,8
+DA:24,8
+DA:26,8
+DA:27,8
+DA:28,8
+DA:29,8
+DA:30,8
+DA:31,8
+LF:27
+LH:27
 BRF:0
 BRH:0
 end_of_record
@@ -197,10 +200,10 @@ FN:30,makeApiRequest
 FNF:1
 FNH:1
 FNDA:3,makeApiRequest
-DA:1,3
-DA:3,3
-DA:4,3
-DA:30,3
+DA:1,4
+DA:3,4
+DA:4,4
+DA:30,4
 DA:31,3
 DA:32,3
 DA:34,3
@@ -216,20 +219,82 @@ SF:src/utils.ts
 FN:14,findExpiryTime
 FNF:1
 FNH:1
-FNDA:38,findExpiryTime
-DA:14,5
-DA:15,38
-DA:16,38
-DA:17,38
-DA:18,38
+FNDA:45,findExpiryTime
+DA:14,6
+DA:15,45
+DA:16,45
+DA:17,45
+DA:18,45
 LF:5
 LH:5
 BRDA:17,0,0,0
-BRDA:17,0,1,38
+BRDA:17,0,1,45
 BRF:2
 BRH:1
 end_of_record
 TN:
+SF:src/api/AuditLog.ts
+FN:14,handleAuditLogError
+FN:53,getAuditConfig
+FN:87,updateAuditConfig
+FNF:3
+FNH:3
+FNDA:8,handleAuditLogError
+FNDA:5,getAuditConfig
+FNDA:7,updateAuditConfig
+DA:1,2
+DA:2,2
+DA:3,2
+DA:5,2
+DA:15,8
+DA:16,6
+DA:17,6
+DA:20,6
+DA:21,1
+DA:25,5
+DA:26,1
+DA:30,4
+DA:31,2
+DA:36,4
+DA:53,2
+DA:54,5
+DA:55,5
+DA:57,5
+DA:58,5
+DA:63,3
+DA:87,2
+DA:90,7
+DA:91,7
+DA:93,7
+DA:94,7
+DA:100,5
+LF:26
+LH:26
+BRDA:14,0,0,3
+BRDA:15,1,0,6
+BRDA:15,1,1,2
+BRDA:15,2,0,8
+BRDA:15,2,1,6
+BRDA:20,3,0,1
+BRDA:20,3,1,5
+BRDA:20,4,0,6
+BRDA:20,4,1,1
+BRDA:25,5,0,1
+BRDA:25,5,1,4
+BRDA:26,6,0,0
+BRDA:26,6,1,1
+BRDA:26,7,0,1
+BRDA:26,7,1,1
+BRDA:30,8,0,2
+BRDA:30,8,1,2
+BRDA:31,9,0,0
+BRDA:31,9,1,2
+BRDA:31,10,0,2
+BRDA:31,10,1,2
+BRF:21
+BRH:19
+end_of_record
+TN:
 SF:src/api/Calculation.ts
 FN:35,calculate
 FNF:1
@@ -249,17 +314,17 @@ BRH:0
 end_of_record
 TN:
 SF:src/api/EconomicActivity.ts
-FN:34,calculate
+FN:58,calculate
 FNF:1
 FNH:1
-FNDA:1,calculate
+FNDA:2,calculate
 DA:1,1
 DA:2,1
 DA:6,1
-DA:34,1
-DA:37,1
-DA:38,1
-DA:40,1
+DA:58,1
+DA:61,2
+DA:62,2
+DA:64,2
 LF:7
 LH:7
 BRF:0
@@ -268,7 +333,7 @@ end_of_record
 TN:
 SF:src/api/Factor.ts
 FN:41,retrieveFactor
-FN:128,search
+FN:147,search
 FNF:2
 FNH:2
 FNDA:1,retrieveFactor
@@ -280,10 +345,10 @@ DA:41,1
 DA:44,1
 DA:45,1
 DA:47,1
-DA:128,1
-DA:131,1
-DA:132,1
-DA:134,1
+DA:147,1
+DA:150,1
+DA:151,1
+DA:153,1
 LF:11
 LH:11
 BRF:0
@@ -422,18 +487,36 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:src/api/PhysicalActivity.ts
+FN:81,calculate
+FNF:1
+FNH:1
+FNDA:3,calculate
+DA:1,1
+DA:2,1
+DA:6,1
+DA:81,1
+DA:84,3
+DA:85,3
+DA:87,3
+LF:7
+LH:7
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:src/api/RealEstate.ts
-FN:34,calculate
+FN:57,calculate
 FNF:1
 FNH:1
-FNDA:1,calculate
+FNDA:2,calculate
 DA:1,1
 DA:2,1
 DA:6,1
-DA:34,1
-DA:37,1
-DA:38,1
-DA:40,1
+DA:57,1
+DA:60,2
+DA:61,2
+DA:63,2
 LF:7
 LH:7
 BRF:0
@@ -477,17 +560,17 @@ BRH:0
 end_of_record
 TN:
 SF:src/api/TypeRecommender.ts
-FN:102,search
+FN:119,search
 FNF:1
 FNH:1
 FNDA:1,search
 DA:1,1
 DA:2,1
 DA:5,1
-DA:102,1
-DA:105,1
-DA:106,1
-DA:108,1
+DA:119,1
+DA:122,1
+DA:123,1
+DA:125,1
 LF:7
 LH:7
 BRF:0
@@ -528,6 +611,17 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:test/mocks/AttributionRequest.ts
+FNF:0
+FNH:0
+DA:3,1
+DA:23,1
+LF:2
+LH:2
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:test/mocks/CommonRequest.ts
 FNF:0
 FNH:0
@@ -539,6 +633,17 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:test/mocks/EconomicActivityAttributionRequest.ts
+FNF:0
+FNH:0
+DA:3,1
+DA:22,1
+LF:2
+LH:2
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:test/mocks/FactorRequest.ts
 FNF:0
 FNH:0
@@ -572,6 +677,28 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:test/mocks/PhysicalActivityEVICRequest.ts
+FNF:0
+FNH:0
+DA:3,1
+DA:22,1
+LF:2
+LH:2
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:test/mocks/PhysicalActivityRequest.ts
+FNF:0
+FNH:0
+DA:3,1
+DA:23,1
+LF:2
+LH:2
+BRF:0
+BRH:0
+end_of_record
+TN:
 SF:test/mocks/SearchRequest.ts
 FNF:0
 FNH:0

package/dist/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeRecommender = exports.Metadata = exports.RealEstate = exports.EconomicActivity = exports.FactorSets = exports.Factor = exports.Usage = exports.TransportationAndDistribution = exports.Calculation = exports.Stationary = exports.Mobile = exports.Fugitive = exports.Location = exports.Client = void 0;
+exports.AuditLog = exports.TypeRecommender = exports.Metadata = exports.PhysicalActivity = exports.RealEstate = exports.EconomicActivity = exports.FactorSets = exports.Factor = exports.Usage = exports.TransportationAndDistribution = exports.Calculation = exports.Stationary = exports.Mobile = exports.Fugitive = exports.Location = exports.Client = void 0;
 var Client_1 = require("./Client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return Client_1.Client; } });
 exports.Location = __importStar(require("./api/Location"));
@@ -47,5 +47,7 @@ exports.Factor = __importStar(require("./api/Factor"));
 exports.FactorSets = __importStar(require("./api/FactorSets"));
 exports.EconomicActivity = __importStar(require("./api/EconomicActivity"));
 exports.RealEstate = __importStar(require("./api/RealEstate"));
+exports.PhysicalActivity = __importStar(require("./api/PhysicalActivity"));
 exports.Metadata = __importStar(require("./api/Metadata"));
 exports.TypeRecommender = __importStar(require("./api/TypeRecommender"));
+exports.AuditLog = __importStar(require("./api/AuditLog"));

package/dist/interfaces/response/AuditLogResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Constants.d.ts

@@ -12,6 +12,8 @@ export declare const FACTOR_SET_API_PATH = "/v3/carbon/factorset";
 export declare const SEARCH_API_PATH = "/v3/carbon/factor/search";
 export declare const ECONOMIC_ACTIVITY_API_PATH = "/v3/carbon/economic-activity";
 export declare const REAL_ESTATE_API_PATH = "/v3/carbon/real-estate";
+export declare const PHYSICAL_ACTIVITY_API_PATH = "/v3/carbon/physical-activity";
+export declare const AUDIT_LOG_API_PATH = "/v3/carbon/admin/audit-log";
 export declare const TYPE_RECOMMENDER_API_PATH = "/v3/carbon/recommender/type/search";
 export declare const USAGE_API = "/v3/carbon/usage";
 export declare const METADATA_TYPES_ENDPOINT = "/v3/carbon/metadata/types";
@@ -19,6 +21,7 @@ export declare const METADATA_AREA_ENDPOINT = "/v3/carbon/metadata/area";
 export declare const METADATA_UNITS_ENDPOINT = "/v3/carbon/metadata/units";
 export declare const GET = "GET";
 export declare const POST = "POST";
+export declare const PUT = "PUT";
 export declare const CLIENT_SOURCE_HEADER = "X-Client-Source";
 export declare const CLIENT_SOURCE_EXCEL = "excel";
 export declare const CLIENT_SOURCE_SDK = "node-sdk";

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

@@ -0,0 +1,37 @@
+import { AuditLogRequest, AuditLogResponse } from "../interfaces/response/AuditLogResponse";
+/**
+ * Retrieves the audit log configuration for the organization.
+ *
+ * Controls whether the organization's API requests and responses are stored for auditing.
+ * Organizations can disable this if they don't need their API calls to be audited.
+ *
+ * @export
+ * @return {Promise<AuditLogResponse>} Current audit log configuration
+ * @throws {Error} Throws error for 403 (Forbidden) or other failures
+ *
+ * @example
+ * const config = await getConfig();
+ * // Output: { logRequest: true, logResponse: false }
+ */
+export declare function getAuditConfig(): Promise<AuditLogResponse>;
+/**
+ * Updates the audit log configuration for the organization.
+ *
+ * Controls whether the organization's API requests and responses are stored for auditing.
+ * Organizations can disable this if they don't need their API calls to be audited.
+ *
+ * Note: If the configuration is already set to the requested values, the API will return
+ * a 409 Conflict status with a message indicating no change was made. This is handled
+ * gracefully and the current configuration is returned.
+ *
+ * @export
+ * @param {AuditLogRequest} payload - Audit log configuration
+ * @return {Promise<AuditLogResponse>} Updated configuration or current configuration if no change
+ * @throws {Error} Throws error for 400 (Bad Request), 403 (Forbidden), or other failures
+ *
+ * @example
+ * const result = await update({ logRequest: false, logResponse: false });
+ * // If already set to these values:
+ * // { logRequest: false, logResponse: false, message: "No change in audit log configuration" }
+ */
+export declare function updateAuditConfig(payload: AuditLogRequest): Promise<AuditLogResponse>;

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

@@ -3,6 +3,7 @@ import { EmissionResponse } from "../interfaces/response/EmissionResponse";
 import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
 /**
  * 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
@@ -10,6 +11,7 @@ import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResp
  * @throws {Error} May throw an error if the API request fails
  *
  * @example
+ * // Basic economic activity request
  * const request = {
     "time": {
       "date": "2025-01-04"
@@ -25,5 +27,27 @@ import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResp
     "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 declare function calculate(payload: CommonRequest): Promise<EmissionResponse | EmissionResponseWithDetails>;

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

@@ -42,6 +42,9 @@ export declare function retrieveFactor(payload: FactorRequest): Promise<FactorRe
  * @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
  *
+ * The API applies cross-encoder reranking by default. Set `enableReranker` to
+ * `false` to keep semantic similarity ordering without reranking.
+ *
  * @example
  * // Basic search
  * const searchRequest = {
@@ -58,6 +61,22 @@ export declare function retrieveFactor(payload: FactorRequest): Promise<FactorRe
  * const results = await search(searchRequest);
  *
  * @example
+ * // Search without cross-encoder reranking
+ * const searchWithoutReranker = {
+    "time":{
+      "date": "2020-06-10"
+    },
+    "activity": {
+      "search" : "travel"
+    },
+    "location": {
+      "country": "USA"
+    },
+    "enableReranker": false
+  };
+ * const results = await search(searchWithoutReranker);
+ *
+ * @example
  * // Search with optional unit parameter
  * const searchWithUnit = {
     "time":{