@widergy/web-utils/lib/constants/consumptionInterfaces.d.ts

Utility GO! Web utils

export interface DataItem {
    value: number;
    color: string;
    isCurrentYear: boolean;
    key: string;
    highlighted: boolean;
    mainLabel: string;
    secondaryLabel: string;
    selectable: boolean;
    highlightColor: string;
    tooltipContent: string;
    isSmart: boolean;
    overHiredPower: boolean;
    clickable: boolean;
}
export interface IndicatorsConfig {
    data: DataItem[][];
    currentPage: number;
    pagination: number;
}
export interface CarbonFootprintValues {
    key: number;
    value: number;
    lastValue?: number;
    lastYearTooltipContent?: string;
    lastYearIsSmart?: boolean;
    mainLabel: string;
    stacked: boolean;
    selectable: boolean;
    tooltipContent: string;
    isSmart: boolean;
    data?: number;
    values?: any[];
}
export interface Periods {
    year: number;
    period: number;
    smart: boolean;
    start_date: Date | string;
    end_date: Date | string;
    bill_external_id?: string;
    projected_consumption: any[];
    current_consumption: Consumption[];
    last_consumption: Consumption[];
    days: Day[];
}
export interface Consumption {
    metric: Metric;
    values: LastConsumptionValue[];
}
export declare enum Metric {
    BillAmount = "bill_amount",
    CosinPhi = "cosin_phi",
    Energy = "energy",
    Power = "power",
    TangentPhi = "tangent_phi",
    TargetConsumption = "target_consumption",
    Temperature = "temperature"
}
export declare enum Magnitude {
    ArgentinePeso = "argentine peso",
    Celsius = "celsius",
    CosenoFi = "coseno fi",
    EnergiaActiva = "energia activa",
    Potencia = "potencia",
    PotenciaActiva = "potencia activa",
    TangenteFi = "tangente fi"
}
export declare enum Unit {
    Ars = "ars",
    C = "C",
    Day = "day",
    KW = "kW",
    KWh = "kWh"
}
export interface Hours {
    year: number;
    period: number;
    day: string;
    hour: number;
    frequency: string;
    projected_consumption: any[];
    current_consumption: Consumption[];
}
export interface Day {
    year: number;
    period: number;
    day: string;
    workday: boolean;
    frequency: string;
    projected_consumption: any[];
    current_consumption: Consumption[];
    hour?: number;
    hours?: Hours[];
}
export interface LastConsumptionValue {
    type: Type | string;
    unit?: Unit;
    magnitude?: Magnitude;
    value: number | Date;
}
export declare enum Type {
    DailyAvg = "daily_avg",
    HourlyAvg = "hourly_avg",
    PurchasedPower = "purchased_power",
    Total = "total"
}
export interface Year {
    year: string;
    projected_consumption: any[];
    periods: Periods[];
}
export type ChartData = {
    [key: string]: Year;
};
export interface Days {
    year: number;
    period: number;
    day: Date | string;
    workday: boolean;
    frequency: string;
    projected_consumption: any[];
    current_consumption?: Consumption[];
}
export interface PeriodConcepts {
    reference: string;
    label: string;
    color: string;
}
export interface ConsumptionHistory {
    yearsToDisplay: number[];
    bills: Bill[];
}
export interface Bill {
    period: string;
    amount: number;
    electric_concepts_amount: number;
    taxes_amount: number;
    other_concepts_amount: number;
    rate_stage: RateStage | null;
    period_started_on: string;
    period_ended_on: string;
    consumption_unit: ConsumptionUnit;
    consumption: number;
    consumption_on_peak: number;
    consumption_remainder: number;
    consumption_valley: number;
    power_unit: PowerUnit;
    billed_power: number;
    purchased_power: number;
    power_billed_on_peak: number;
    purchased_power_on_peak: number;
    agreed_power_on_peak: number;
    exceeded_power_on_peak: number;
    power_billed_off_peak: number;
    purchased_power_off_peak: number;
    agreed_power_off_peak: number;
    exceeded_power_off_peak: number;
    reactive_energy_unit: ReactiveEnergyUnit;
    reactive_energy: number;
    phi_tangent: number;
    consumptions_before: ConsumptionsBefore;
    month: string;
    year: number;
    renderIcon: string;
    id: number;
    carbonFootprint: number;
    kmPerKilowattHour: number;
    treesPerKilowattHour: number;
    sheetsPerKilowattHour: number;
    power_billed_remainder?: number;
    power_billed_valley?: number;
}
export declare enum ConsumptionUnit {
    KWh = "kWh"
}
export interface ConsumptionsBefore {
    period: string;
    amount: number;
    period_started_on: Date;
    period_ended_on: Date;
    consumption: number;
    consumption_on_peak: number;
    consumption_remainder: number;
    consumption_valley: number;
    billed_power: number;
    purchased_power: number;
    power_billed_on_peak: number;
    purchased_power_on_peak: number;
    agreed_power_on_peak: number;
    exceeded_power_on_peak: number;
    power_billed_off_peak: number;
    purchased_power_off_peak: number;
    agreed_power_off_peak: number;
    exceeded_power_off_peak: number;
    reactive_energy: number;
    phi_tangent: number;
}
export declare enum PowerUnit {
    Kw = "KW"
}
export declare enum RateStage {
    T1G2 = "T1-G2"
}
export declare enum ReactiveEnergyUnit {
    Kvar = "KVAR"
}
export interface Bars {
    bars: Bar[];
    unit: string;
}
export interface Bar {
    id: string;
    key: string;
    name: string;
}
export interface CarbonFootprintKpis {
    period: string;
    amount: number;
    electric_concepts_amount: number;
    taxes_amount: number;
    other_concepts_amount: number;
    rate_stage: RateStage | null;
    period_started_on: string;
    period_ended_on: string;
    consumption_unit: ConsumptionUnit;
    consumption: number;
    consumption_on_peak: number;
    consumption_remainder: number;
    consumption_valley: number;
    power_unit: PowerUnit;
    billed_power: number;
    purchased_power: number;
    power_billed_on_peak: number;
    purchased_power_on_peak: number;
    agreed_power_on_peak: number;
    exceeded_power_on_peak: number;
    power_billed_off_peak: number;
    purchased_power_off_peak: number;
    agreed_power_off_peak: number;
    exceeded_power_off_peak: number;
    reactive_energy_unit: ReactiveEnergyUnit;
    reactive_energy: number;
    phi_tangent: number;
    consumptions_before: ConsumptionsBefore;
    month: string;
    year: number;
    renderIcon: string;
    id: number;
    carbonFootprint: number;
    kmPerKilowattHour: number;
    treesPerKilowattHour: number;
    sheetsPerKilowattHour: number;
}
export interface ConsumptionsBefore {
    period: string;
    amount: number;
    period_started_on: Date;
    period_ended_on: Date;
    consumption: number;
    consumption_on_peak: number;
    consumption_remainder: number;
    consumption_valley: number;
    billed_power: number;
    purchased_power: number;
    power_billed_on_peak: number;
    purchased_power_on_peak: number;
    agreed_power_on_peak: number;
    exceeded_power_on_peak: number;
    power_billed_off_peak: number;
    purchased_power_off_peak: number;
    agreed_power_off_peak: number;
    exceeded_power_off_peak: number;
    reactive_energy: number;
    phi_tangent: number;
}
export interface BarDataColors {
    LAST_YEAR: string;
    CURRENT_YEAR: string;
    SELECTED_LABEL: string;
    LAST_YEAR_SELECTED_LABEL: string;
}
export interface HighlightColors {
    LAST_YEAR: string;
    CURRENT_YEAR: string;
}
export interface ConsumptionData {
    client_number: string;
    period: string;
    period_started_on: string;
    period_ended_on: string;
    consumption: number;
    consumption_unit: ConsumptionUnitV0;
    amount: number;
    billed_power: number;
    purchased_power: number;
    month: string;
    year: number;
}
export declare enum ConsumptionUnitV0 {
    M3 = "m3"
}
export type Styles = {
    [key: string]: string;
};
export interface Account {
    id: number;
    client_number: string;
    address: string;
    holder_name: string;
    rate: string;
    status: string;
    status_label: string;
    adherence_to_automatic_debit: string;
    adherence_to_digital_bill: string;
    balance: number;
    chart_type: string;
    push_notifications_enabled: boolean;
    new_notifications: number;
    related_accounts: null;
    user_adherence_to_digital_bill: null;
    cancel_service_enabled: boolean;
    new_service_enabled: boolean;
    city: string;
    district: string;
    is_prepaid: null;
    depends_on_electricity: null;
    smart_bill_enabled: boolean;
    alias: string;
    relationship: string;
    profile: string;
    meter_type: null;
    meter_number: null;
    meter_prepaid_number: null;
    meter_numerators_quantity: null;
    suggest_digital_bill_adherence: boolean;
    contact_emails: string[];
    latitude: number;
    longitude: number;
    benefit_percentage_cap: null;
    benefit_value_cap: null;
    real_time_consumption_status: null;
    real_time_consumption_url: null;
    smart_meter: boolean;
    premium: boolean;
    client_type: null;
    client_document_type: null;
    client_document_number: null;
    groups_names: any[];
    payment_blocked: boolean;
    group_name: null;
    voltage_level: null;
    normalized_rate: null;
    is_social_rate: null;
    can_request_social_rate: null;
    subsidy_level: null;
    external_status: string;
    electrical_segmentation_adherence: null;
    can_view_bill_history: boolean;
    can_view_consumptions: boolean;
    can_delegate: null;
    can_manage_payments: boolean;
    can_view_payment_history: boolean;
    can_manage_digital_bill: boolean;
    can_download_bill: boolean;
    can_request_social_rate_status: null;
    can_manage_payment_plan: boolean;
    can_view_payment_plan: boolean;
    can_view_smart_bill: null;
    can_manage_account_association: null;
    ov_read_only: null;
    can_cancel_claims_user: null;
    can_reiterate_claims_user: null;
    can_manage_notifications: null;
    can_manage_group_accounts: null;
    can_view_projections: null;
    can_view_simulator: null;
    can_finalize_inquiries: null;
    can_create_inquiries: null;
    can_create_complaints: null;
    can_finalize_complaints: null;
    can_view_procedures: boolean;
    can_view_claims: null;
    can_create_procedures: null;
    can_create_claims: null;
    can_finalize_claims: null;
    can_finalize_procedures: null;
    can_finalize_payment: null;
}
export interface Coefficients {
    km_per_kilowatt_hour: number;
    trees_per_kilowatt_hour: number;
    sheets_per_kilowatt_hour: number;
    carbon_dioxide_per_kilowatt_hour: number;
}
export interface ConsumptionHistory {
    client_number: string;
    period: string;
    period_started_on: Date;
    period_ended_on: Date;
    consumption: number;
    consumption_unit: string;
    amount: number;
    billed_power: number;
    purchased_power: number;
    concepts?: {
        concept: string;
        amount: number;
    }[];
}
export interface PeriodConsumptionType {
    metric: string;
    values: PeriodConsumptionValue[];
}
export interface PeriodConsumptionValue {
    type: string;
    unit?: string;
    magnitude: string;
    value: number;
}
export interface Period {
    end_date: string;
    start_date: string;
}
export interface EnableSelection {
    year: boolean;
    period: boolean;
    day: boolean;
}