@burdenoff/sdk-libs 2026.627.3 → 2026.627.4

package/dist/modules/ecoimpacthub/index.d.cts

@@ -0,0 +1,478 @@
+import { S as SdkModule } from '../../module-JDbvil5h.cjs';
+import 'graphql-request';
+
+type EcoSiteType = 'AIRSHED' | 'COASTAL' | 'FACILITY' | 'FARM' | 'FOREST' | 'OTHER' | 'PROTECTED_AREA' | 'WATERSHED' | 'WETLAND';
+type EcoSiteStatus = 'ACTIVE' | 'ARCHIVED' | 'MONITORING_PAUSED';
+type EcoSensorKind = 'ACOUSTIC' | 'AIR_QUALITY' | 'CAMERA_TRAP' | 'ENERGY_METER' | 'FLOW' | 'MANUAL' | 'SOIL' | 'WATER_QUALITY' | 'WEATHER';
+type EcoSensorStatus = 'DEGRADED' | 'MAINTENANCE' | 'OFFLINE' | 'ONLINE' | 'RETIRED';
+type EcoThresholdDirection = 'ABOVE' | 'BELOW' | 'OUTSIDE_RANGE';
+type EcoThresholdSeverity = 'CRITICAL' | 'INFO' | 'WARNING';
+type EcoMeasurementSource = 'CALCULATED' | 'IMPORT' | 'MANUAL' | 'SATELLITE' | 'SENSOR';
+type EcoConservationStatus = 'CRITICALLY_ENDANGERED' | 'DATA_DEFICIENT' | 'ENDANGERED' | 'EXTINCT_IN_WILD' | 'LEAST_CONCERN' | 'NEAR_THREATENED' | 'NOT_EVALUATED' | 'VULNERABLE';
+type EcoTaxonGroup = 'AMPHIBIAN' | 'BIRD' | 'FISH' | 'FUNGI' | 'INSECT' | 'MAMMAL' | 'OTHER' | 'PLANT' | 'REPTILE';
+type EcoObservationMethod = 'ACOUSTIC' | 'CAMERA_TRAP' | 'COMMUNITY_REPORT' | 'DIRECT_SIGHTING' | 'EDNA' | 'TELEMETRY' | 'TRACKS_SIGNS';
+type EcoHabitatProjectStatus = 'CANCELLED' | 'COMPLETED' | 'IN_PROGRESS' | 'MONITORING' | 'ON_HOLD' | 'PLANNED';
+type EcoRestorationActivityType = 'COMMUNITY_ENGAGEMENT' | 'INVASIVE_REMOVAL' | 'PLANTING' | 'REWILDING' | 'SOIL_REMEDIATION' | 'SURVEY' | 'WATER_MANAGEMENT';
+type EcoEmissionScope = 'SCOPE_1' | 'SCOPE_2' | 'SCOPE_3';
+type EcoCarbonEntryStatus = 'ADJUSTED' | 'DRAFT' | 'RECORDED' | 'VERIFIED';
+type EcoReductionTargetStatus = 'ACHIEVED' | 'ACTIVE' | 'MISSED' | 'PROPOSED' | 'RETIRED';
+type EcoReportFramework = 'CDP' | 'CUSTOM' | 'GHG_PROTOCOL' | 'GRI' | 'SASB' | 'TCFD';
+type EcoReportStatus = 'ARCHIVED' | 'DRAFT' | 'IN_REVIEW' | 'PUBLISHED';
+interface EcoPageInfo {
+    cursor?: string | null;
+    hasMore: boolean;
+}
+interface EcoFileRef {
+    id: string;
+}
+interface EcoSite {
+    id: string;
+    name: string;
+    code?: string | null;
+    description?: string | null;
+    type: EcoSiteType;
+    status: EcoSiteStatus;
+    region?: string | null;
+    country?: string | null;
+    latitude?: number | null;
+    longitude?: number | null;
+    areaHectares?: number | null;
+    sensors: EcoSensor[];
+    thresholds: EcoAlertThreshold[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoSensor {
+    id: string;
+    name: string;
+    siteId: string;
+    kind: EcoSensorKind;
+    status: EcoSensorStatus;
+    unit?: string | null;
+    hardwareId?: string | null;
+    installedAt?: string | null;
+    lastReadingAt?: string | null;
+    site?: EcoSite | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoAlertThreshold {
+    id: string;
+    siteId: string;
+    parameter: string;
+    direction: EcoThresholdDirection;
+    severity: EcoThresholdSeverity;
+    unit: string;
+    minValue?: number | null;
+    maxValue?: number | null;
+    limitValue?: number | null;
+    isActive: boolean;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoMeasurement {
+    id: string;
+    siteId: string;
+    sensorId?: string | null;
+    parameter: string;
+    value: number;
+    unit: string;
+    source: EcoMeasurementSource;
+    isBreach: boolean;
+    notes?: string | null;
+    recordedAt: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoSpecies {
+    id: string;
+    commonName: string;
+    scientificName?: string | null;
+    description?: string | null;
+    taxonGroup: EcoTaxonGroup;
+    conservationStatus: EcoConservationStatus;
+    isPriority: boolean;
+    observations: EcoObservation[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoObservation {
+    id: string;
+    speciesId: string;
+    siteId?: string | null;
+    observerId?: string | null;
+    count: number;
+    method: EcoObservationMethod;
+    latitude?: number | null;
+    longitude?: number | null;
+    notes?: string | null;
+    observedAt: string;
+    evidence?: EcoFileRef | null;
+    species?: EcoSpecies | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoHabitatProject {
+    id: string;
+    name: string;
+    description?: string | null;
+    status: EcoHabitatProjectStatus;
+    siteId?: string | null;
+    managerId?: string | null;
+    budgetAmount: number;
+    currency: string;
+    targetHectares?: number | null;
+    startDate?: string | null;
+    endDate?: string | null;
+    completedAt?: string | null;
+    activities: EcoRestorationActivity[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoRestorationActivity {
+    id: string;
+    projectId: string;
+    type: EcoRestorationActivityType;
+    summary: string;
+    details?: string | null;
+    quantity?: number | null;
+    unit?: string | null;
+    performedAt: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoEmissionFactor {
+    id: string;
+    name: string;
+    scope: EcoEmissionScope;
+    activityUnit: string;
+    factorKgco2e: number;
+    source?: string | null;
+    validYear?: number | null;
+    isActive: boolean;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoCarbonEntry {
+    id: string;
+    scope: EcoEmissionScope;
+    category: string;
+    activityValue: number;
+    activityUnit: string;
+    co2eKg: number;
+    status: EcoCarbonEntryStatus;
+    factorId?: string | null;
+    factor?: EcoEmissionFactor | null;
+    siteId?: string | null;
+    notes?: string | null;
+    periodStart: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoReductionTarget {
+    id: string;
+    name: string;
+    description?: string | null;
+    metric: string;
+    unit: string;
+    baselineValue: number;
+    baselineYear: number;
+    targetValue: number;
+    targetYear: number;
+    status: EcoReductionTargetStatus;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoReportLineItem {
+    id: string;
+    reportId: string;
+    carbonEntryId?: string | null;
+    category?: string | null;
+    label: string;
+    value: number;
+    unit: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoReport {
+    id: string;
+    title: string;
+    summary?: string | null;
+    framework: EcoReportFramework;
+    status: EcoReportStatus;
+    periodStart: string;
+    periodEnd: string;
+    publishedAt?: string | null;
+    file?: EcoFileRef | null;
+    lineItems: EcoReportLineItem[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface EcoSiteConnection {
+    items: EcoSite[];
+    pageInfo: EcoPageInfo;
+}
+interface EcoMeasurementConnection {
+    items: EcoMeasurement[];
+    pageInfo: EcoPageInfo;
+}
+interface EcoSpeciesConnection {
+    items: EcoSpecies[];
+    pageInfo: EcoPageInfo;
+}
+interface EcoObservationConnection {
+    items: EcoObservation[];
+    pageInfo: EcoPageInfo;
+}
+interface EcoCarbonEntryConnection {
+    items: EcoCarbonEntry[];
+    pageInfo: EcoPageInfo;
+}
+interface EcoReportConnection {
+    items: EcoReport[];
+    pageInfo: EcoPageInfo;
+}
+interface EcoPaginationInput {
+    cursor?: string;
+    limit?: number;
+    offset?: number;
+}
+interface EcoCreateSiteInput {
+    name: string;
+    code?: string;
+    description?: string;
+    type?: EcoSiteType;
+    status?: EcoSiteStatus;
+    region?: string;
+    country?: string;
+    latitude?: number;
+    longitude?: number;
+    areaHectares?: number;
+}
+interface EcoUpdateSiteInput {
+    name?: string;
+    code?: string;
+    description?: string;
+    type?: EcoSiteType;
+    status?: EcoSiteStatus;
+    region?: string;
+    country?: string;
+    latitude?: number;
+    longitude?: number;
+    areaHectares?: number;
+}
+interface EcoCreateSensorInput {
+    name: string;
+    siteId: string;
+    kind?: EcoSensorKind;
+    status?: EcoSensorStatus;
+    unit?: string;
+    hardwareId?: string;
+    installedAt?: string;
+}
+interface EcoCreateThresholdInput {
+    siteId: string;
+    parameter: string;
+    unit: string;
+    direction?: EcoThresholdDirection;
+    severity?: EcoThresholdSeverity;
+    minValue?: number;
+    maxValue?: number;
+    limitValue?: number;
+}
+interface EcoRecordMeasurementInput {
+    siteId: string;
+    parameter: string;
+    value: number;
+    unit: string;
+    recordedAt: string;
+    sensorId?: string;
+    source?: EcoMeasurementSource;
+    notes?: string;
+}
+interface EcoCreateSpeciesInput {
+    commonName: string;
+    scientificName?: string;
+    description?: string;
+    taxonGroup?: EcoTaxonGroup;
+    conservationStatus?: EcoConservationStatus;
+    isPriority?: boolean;
+}
+interface EcoUpdateSpeciesInput {
+    commonName?: string;
+    scientificName?: string;
+    description?: string;
+    taxonGroup?: EcoTaxonGroup;
+    conservationStatus?: EcoConservationStatus;
+    isPriority?: boolean;
+}
+interface EcoRecordObservationInput {
+    speciesId: string;
+    observedAt: string;
+    count?: number;
+    method?: EcoObservationMethod;
+    siteId?: string;
+    latitude?: number;
+    longitude?: number;
+    notes?: string;
+    evidenceFileId?: string;
+}
+interface EcoCreateHabitatProjectInput {
+    name: string;
+    description?: string;
+    siteId?: string;
+    managerId?: string;
+    budgetAmount?: number;
+    currency?: string;
+    targetHectares?: number;
+    startDate?: string;
+    endDate?: string;
+}
+interface EcoLogRestorationActivityInput {
+    projectId: string;
+    summary: string;
+    performedAt: string;
+    type?: EcoRestorationActivityType;
+    details?: string;
+    quantity?: number;
+    unit?: string;
+}
+interface EcoRecordCarbonEntryInput {
+    category: string;
+    activityValue: number;
+    activityUnit: string;
+    periodStart: string;
+    scope?: EcoEmissionScope;
+    factorId?: string;
+    siteId?: string;
+    notes?: string;
+}
+interface EcoCreateEmissionFactorInput {
+    name: string;
+    activityUnit: string;
+    factorKgco2e: number;
+    scope?: EcoEmissionScope;
+    source?: string;
+    validYear?: number;
+}
+interface EcoCreateReductionTargetInput {
+    name: string;
+    metric: string;
+    unit: string;
+    baselineValue: number;
+    baselineYear: number;
+    targetValue: number;
+    targetYear: number;
+    description?: string;
+}
+interface EcoCreateReportInput {
+    title: string;
+    periodStart: string;
+    periodEnd: string;
+    framework?: EcoReportFramework;
+    summary?: string;
+}
+interface EcoAddReportLineItemInput {
+    reportId: string;
+    label: string;
+    value: number;
+    unit: string;
+    carbonEntryId?: string;
+    category?: string;
+}
+
+interface EcoimpacthubSitesApi {
+    get(id: string): Promise<EcoSite | null>;
+    list(pagination?: EcoPaginationInput, status?: EcoSiteStatus, type?: EcoSiteType): Promise<EcoSiteConnection>;
+    create(input: EcoCreateSiteInput): Promise<EcoSite>;
+    update(id: string, input: EcoUpdateSiteInput): Promise<EcoSite>;
+    archive(id: string): Promise<boolean>;
+}
+interface EcoimpacthubSensorsApi {
+    list(kind?: EcoSensorKind, siteId?: string, status?: EcoSensorStatus): Promise<EcoSensor[]>;
+    create(input: EcoCreateSensorInput): Promise<EcoSensor>;
+    setStatus(id: string, status: EcoSensorStatus): Promise<EcoSensor>;
+}
+interface EcoimpacthubThresholdsApi {
+    list(siteId?: string): Promise<EcoAlertThreshold[]>;
+    create(input: EcoCreateThresholdInput): Promise<EcoAlertThreshold>;
+    setActive(id: string, isActive: boolean): Promise<EcoAlertThreshold>;
+}
+interface EcoimpacthubMeasurementsApi {
+    list(siteId?: string, sensorId?: string, parameter?: string, breachesOnly?: boolean, pagination?: EcoPaginationInput): Promise<EcoMeasurementConnection>;
+    record(input: EcoRecordMeasurementInput): Promise<EcoMeasurementConnection['items'][number]>;
+}
+interface EcoimpacthubSpeciesApi {
+    get(id: string): Promise<EcoSpecies | null>;
+    list(conservationStatus?: EcoConservationStatus, taxonGroup?: EcoTaxonGroup, priorityOnly?: boolean, pagination?: EcoPaginationInput): Promise<EcoSpeciesConnection>;
+    create(input: EcoCreateSpeciesInput): Promise<EcoSpecies>;
+    update(id: string, input: EcoUpdateSpeciesInput): Promise<EcoSpecies>;
+    archive(id: string): Promise<boolean>;
+}
+interface EcoimpacthubObservationsApi {
+    list(speciesId?: string, siteId?: string, pagination?: EcoPaginationInput): Promise<EcoObservationConnection>;
+    record(input: EcoRecordObservationInput): Promise<EcoObservationConnection['items'][number]>;
+}
+interface EcoimpacthubHabitatProjectsApi {
+    get(id: string): Promise<EcoHabitatProject | null>;
+    list(status?: EcoHabitatProjectStatus): Promise<EcoHabitatProject[]>;
+    create(input: EcoCreateHabitatProjectInput): Promise<EcoHabitatProject>;
+    transition(id: string, status: EcoHabitatProjectStatus): Promise<EcoHabitatProject>;
+    logActivity(input: EcoLogRestorationActivityInput): Promise<EcoRestorationActivity>;
+}
+interface EcoimpacthubCarbonApi {
+    listEntries(scope?: EcoEmissionScope, siteId?: string, status?: EcoCarbonEntryStatus, pagination?: EcoPaginationInput): Promise<EcoCarbonEntryConnection>;
+    recordEntry(input: EcoRecordCarbonEntryInput): Promise<EcoCarbonEntry>;
+    verifyEntry(id: string): Promise<EcoCarbonEntry>;
+    totalKg(scope?: EcoEmissionScope, siteId?: string): Promise<number>;
+}
+interface EcoimpacthubEmissionFactorsApi {
+    list(activeOnly?: boolean, scope?: EcoEmissionScope): Promise<EcoEmissionFactor[]>;
+    create(input: EcoCreateEmissionFactorInput): Promise<EcoEmissionFactor>;
+}
+interface EcoimpacthubReductionTargetsApi {
+    list(status?: EcoReductionTargetStatus): Promise<EcoReductionTarget[]>;
+    create(input: EcoCreateReductionTargetInput): Promise<EcoReductionTarget>;
+    setStatus(id: string, status: EcoReductionTargetStatus): Promise<EcoReductionTarget>;
+}
+interface EcoimpacthubReportsApi {
+    get(id: string): Promise<EcoReport | null>;
+    list(pagination?: EcoPaginationInput, status?: EcoReportStatus): Promise<EcoReportConnection>;
+    create(input: EcoCreateReportInput): Promise<EcoReport>;
+    addLineItem(input: EcoAddReportLineItemInput): Promise<EcoReportLineItem>;
+    publish(id: string, fileId?: string): Promise<EcoReport>;
+}
+interface EcoimpacthubSystemApi {
+    health(): Promise<string>;
+}
+interface EcoimpacthubApi {
+    sites: EcoimpacthubSitesApi;
+    sensors: EcoimpacthubSensorsApi;
+    thresholds: EcoimpacthubThresholdsApi;
+    measurements: EcoimpacthubMeasurementsApi;
+    species: EcoimpacthubSpeciesApi;
+    observations: EcoimpacthubObservationsApi;
+    habitatProjects: EcoimpacthubHabitatProjectsApi;
+    carbon: EcoimpacthubCarbonApi;
+    emissionFactors: EcoimpacthubEmissionFactorsApi;
+    reductionTargets: EcoimpacthubReductionTargetsApi;
+    reports: EcoimpacthubReportsApi;
+    system: EcoimpacthubSystemApi;
+}
+
+declare const ecoimpacthubModule: SdkModule<EcoimpacthubApi>;
+
+export { type EcoAddReportLineItemInput, type EcoAlertThreshold, type EcoCarbonEntry, type EcoCarbonEntryConnection, type EcoCarbonEntryStatus, type EcoConservationStatus, type EcoCreateEmissionFactorInput, type EcoCreateHabitatProjectInput, type EcoCreateReductionTargetInput, type EcoCreateReportInput, type EcoCreateSensorInput, type EcoCreateSiteInput, type EcoCreateSpeciesInput, type EcoCreateThresholdInput, type EcoEmissionFactor, type EcoEmissionScope, type EcoFileRef, type EcoHabitatProject, type EcoHabitatProjectStatus, type EcoLogRestorationActivityInput, type EcoMeasurement, type EcoMeasurementConnection, type EcoMeasurementSource, type EcoObservation, type EcoObservationConnection, type EcoObservationMethod, type EcoPageInfo, type EcoPaginationInput, type EcoRecordCarbonEntryInput, type EcoRecordMeasurementInput, type EcoRecordObservationInput, type EcoReductionTarget, type EcoReductionTargetStatus, type EcoReport, type EcoReportConnection, type EcoReportFramework, type EcoReportLineItem, type EcoReportStatus, type EcoRestorationActivity, type EcoRestorationActivityType, type EcoSensor, type EcoSensorKind, type EcoSensorStatus, type EcoSite, type EcoSiteConnection, type EcoSiteStatus, type EcoSiteType, type EcoSpecies, type EcoSpeciesConnection, type EcoTaxonGroup, type EcoThresholdDirection, type EcoThresholdSeverity, type EcoUpdateSiteInput, type EcoUpdateSpeciesInput, type EcoimpacthubApi, type EcoimpacthubCarbonApi, type EcoimpacthubEmissionFactorsApi, type EcoimpacthubHabitatProjectsApi, type EcoimpacthubMeasurementsApi, type EcoimpacthubObservationsApi, type EcoimpacthubReductionTargetsApi, type EcoimpacthubReportsApi, type EcoimpacthubSensorsApi, type EcoimpacthubSitesApi, type EcoimpacthubSpeciesApi, type EcoimpacthubSystemApi, type EcoimpacthubThresholdsApi, ecoimpacthubModule as default };