emissions-api-sdk 1.0.1 → 1.0.3

package/dist/types/interfaces/response/EmissionResponseWithDetails.d.ts

@@ -0,0 +1,144 @@
+import { EmissionResponse } from './EmissionResponse';
+/**
+ * Interface for unit information in emission details
+ */
+export interface UnitInfo {
+    /** Unit name */
+    name: string;
+    /** Unit description (optional) */
+    description?: string;
+}
+/**
+ * Interface for area information
+ */
+export interface AreaInfo {
+    /** Internal name of the area */
+    internalName: string;
+    /** Standard name of the area */
+    standardName: string;
+    alpha3?: string;
+}
+/**
+ * Interface for area type information
+ */
+export interface AreaType {
+    /** Type name (e.g., "Planet", "State") */
+    name: string;
+}
+/**
+ * Interface for factor data type categories
+ */
+export interface FactorDataTypeCategory {
+    /** Category name */
+    name: string;
+}
+/**
+ * Interface for factor set information
+ */
+export interface FactorSetInfo {
+    /** Factor set type */
+    type: string;
+    /** Description of the factor set */
+    description?: string;
+    /** Provider of the factor set */
+    provider?: string;
+    /** Source URL for the factor set */
+    sourceUrl?: string;
+    factorSource?: string;
+}
+export interface FactorSelectionDefault {
+    actorDataType?: string;
+    areaName?: string;
+    factorSetName?: string;
+}
+/**
+ * Interface for factor data type code
+ */
+export interface FactorDataTypeCode {
+    /** Unit of measure */
+    unitOfMeasure: string;
+    /** Activity type */
+    type: string;
+    /** Activity subtype */
+    subtype: string;
+    /** Unique factor identifier */
+    factorId: number;
+}
+/**
+ * Interface for factor set version information
+ */
+export interface FactorSetVersion {
+    /** Publication start date */
+    publishedFrom?: string;
+    /** Publication end date (optional) */
+    publishedTo?: string;
+    /** Source of the factor */
+    factorSource: string;
+}
+/**
+ * Interface for factor value
+ */
+export interface FactorValue {
+    /** Unit information */
+    unit: {
+        /** Unit name */
+        name: string;
+    };
+    /** Factor value */
+    value: number;
+}
+/**
+ * Interface for factor metadata
+ */
+export interface FactorMetaData {
+    /** Metadata key */
+    key: string;
+    /** Metadata value */
+    value: string;
+}
+/**
+ * Interface for unit conversion information
+ */
+export interface UnitConversion {
+    /** Input unit */
+    inputUnit: string;
+    /** Unit from database */
+    unitFromDb: string;
+    /** Conversion ratio */
+    conversionRatio: string;
+}
+/**
+ * Interface for detailed emission data
+ */
+export interface EmissionData {
+    /** Array of unit information */
+    unit: UnitInfo[];
+    /** Array of area information */
+    area: AreaInfo[];
+    /** Array of area types */
+    areaType: AreaType[];
+    /** Array of factor data type categories */
+    factorDataTypeCategories: FactorDataTypeCategory[];
+    factorSelectionDefault?: FactorSelectionDefault[];
+    /** Array of factor set information */
+    factorSet: FactorSetInfo[];
+    /** Array of factor data type codes */
+    factorDataTypeCode: FactorDataTypeCode[];
+    /** Array of factor set versions */
+    factorSetVersion: FactorSetVersion[];
+    /** Array of factor values */
+    factorValue: FactorValue[];
+    /** Array of factor metadata */
+    factorMetaData: FactorMetaData[];
+    /** Array of unit conversions */
+    unitConversion: UnitConversion[];
+}
+/**
+ * Interface representing the emission calculation response with detailed information
+ */
+export interface EmissionResponseWithDetails {
+    /** Emission calculation result */
+    result: EmissionResponse;
+    /** Detailed emission data */
+    data: EmissionData;
+}

package/dist/types/interfaces/response/FactorResponse.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Interface representing the response from the retrieve factor API
+ */
+export interface FactorResponse {
+    /** Unique transaction identifier */
+    transactionId: string;
+    /** Total CO2 equivalent emissions (optional - not present in all responses)*/
+    totalCO2e?: number;
+    /** CO2 emissions value (optional - not present in all responses) */
+    CO2?: number;
+    /** CH4 (Methane) emissions value (optional - not present in all responses) */
+    CH4?: number;
+    /** N2O (Nitrous Oxide) emissions value (optional - not present in all responses) */
+    N2O?: number;
+    /** Biogenic CO2 emissions value (optional - not present in all responses) */
+    bioCO2?: number;
+    /** Indirect CO2 equivalent emissions value (optional - not present in all responses) */
+    indirectCO2e?: number;
+    /** Hydrofluorocarbon emissions value (optional - not present in all responses) */
+    HFC?: number;
+    /** Perfluorocarbon emissions value (optional - not present in all responses) */
+    PFC?: number;
+    /** Sulfur hexafluoride emissions value (optional - not present in all responses) */
+    SF6?: number;
+    /** Nitrogen trifluoride emissions value (optional - not present in all responses) */
+    NF3?: number;
+    /** Unit of measurement for emissions */
+    unit?: string;
+    /** Description of the emission factors (optional)*/
+    description?: string;
+    /** Factor set identifier (e.g., "IPCC", "IGES") */
+    factorSet: string;
+    /** Source reference for the emission factors (optional)*/
+    source?: string;
+    /** Type of activity (e.g., "Gas/Diesel Oil", "Electricity") */
+    activityType: string;
+    /** Array of supported activity units */
+    activityUnit: string[];
+    /** Name of the emission factor */
+    name?: string;
+    /** Publication start date in ISO format (optional)*/
+    publishedFrom?: string;
+    /** Publication end date in ISO format (optional) */
+    publishedTo?: string;
+    /** Effective start date in ISO format (optional) */
+    effectiveFrom?: string;
+    /** Effective end date in ISO format (optional) */
+    effectiveTo?: string;
+    /** Geographic region (e.g., "Earth", "India") */
+    region: string;
+    /** Unique factor identifier */
+    factorId: number;
+}

package/dist/types/interfaces/response/FactorSetResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Interface for individual factor set within the response
+ */
+export interface FactorSet {
+    /** Unique identifier for the factor set (required) */
+    id: number;
+    /** Name of the factor set (required) */
+    name: string;
+    /** License type for the factor set (required, e.g., "Public") */
+    license: string;
+    /** Number of factors in this set (required) */
+    factorCount: number;
+    /** Source URL for the factor set data */
+    sourceUrl?: string;
+    /** Detailed description of the factor set */
+    description?: string;
+    /** Short description of the factor set */
+    descriptionShort?: string;
+    /** Array of emission factor types included in this set */
+    types?: string[];
+    /** Array of regions/countries covered by this factor set */
+    regions?: string[];
+    /** Array of version years available for this factor set */
+    versions?: string[];
+    /** Provider/publisher of the factor set */
+    provider?: string;
+    /** Optional citation information for the factor set */
+    citation?: string;
+}
+/**
+ * Interface for Factor Set API response
+ */
+export interface FactorSetResponse {
+    /** Transaction ID for the API request */
+    transactionId: string;
+    /** Array of factor sets returned in the response */
+    factorSets: FactorSet[];
+}

package/dist/types/interfaces/response/SearchResponse.d.ts

@@ -0,0 +1,41 @@
+import { FactorResponse } from './FactorResponse';
+/**
+ * Pagination parameters for search requests
+ */
+export interface Pagination {
+    /** Page number */
+    page: number;
+    /** Page size */
+    size: number;
+}
+/**
+ * Request body structure for pagination links
+ */
+export interface PaginationBody {
+    /** Pagination parameters */
+    pagination?: Pagination;
+}
+/**
+ * Link object for pagination in search results
+ */
+export interface SearchLink {
+    /** Relationship type (e.g., "next", "prev") */
+    rel: string;
+    /** URL for the link */
+    href: string;
+    /** Content type */
+    type: string;
+    /** HTTP method */
+    method: string;
+    /** Request body for pagination */
+    body?: PaginationBody;
+}
+/**
+ * Interface representing the response from the search factor API
+ */
+export interface SearchResponse {
+    /** Array of factor results */
+    factors: FactorResponse[];
+    /** Pagination links (optional) */
+    links?: SearchLink[];
+}

package/dist/types/interfaces/response/TypeResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Interface for type metadata API
+ */
+export interface TypeResponse {
+    /** Array of string*/
+    types: string[];
+}

package/dist/types/interfaces/response/UnitResponse.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Interface for unit object
+ */
+export interface Unit {
+    /** Unit symbol */
+    unit: string;
+    /** Unit name */
+    unitName: string;
+}
+/**
+ * Interface for /units metadata API
+ */
+export interface UnitResponse {
+    /** Array of Unit objects */
+    units: Unit[];
+}

package/dist/types/interfaces/response/UsageResponse.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Interface representing the GHG Metrics Usage Response
+ */
+export interface UsageResponse {
+    /** Organization ID for the API request */
+    orgId?: string;
+    /** Array of entitlement belonging to the Org */
+    entitlement?: Entitlement[];
+}
+export interface Entitlement {
+    /** Organization's billing start date*/
+    startDate?: string;
+    /** Organization's billing end date */
+    endDate?: string;
+    /** Total api calls made by the Organization in the billing cycle */
+    totalApiCalls?: number;
+}

package/docs/_sources/index.rst.txt

@@ -8,6 +8,7 @@ IBM Envizi - Emissions API Node.js SDK
    getting_started
    sdk
    reference
+   troubleshooting
 
 Introduction
 ============

package/docs/_sources/reference.rst.txt

@@ -83,6 +83,12 @@ getUnits
 
 .. js:autofunction:: Fugitive.getUnits
 
+
+Usage API
+===========
+
+.. js:autofunction:: Usage.getUsage
+
 Interfaces
 ==========