@etainabl/nodejs-sdk 1.2.44 → 1.2.46

package/dist/cjs/slack.d.ts

@@ -1,4 +0,0 @@
-declare const _default: {
-    postMessage: (message: string) => Promise<import("axios").AxiosResponse<any, any>>;
-};
-export default _default;

package/dist/cjs/slack.js

@@ -1,28 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-const postMessage = (message) => __awaiter(void 0, void 0, void 0, function* () {
-    const url = 'https://hooks.slack.com/services/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';
-    const data = {
-        text: `[${(process.env.ENV || '').toUpperCase()}][${process.env.AWS_LAMBDA_FUNCTION_NAME}] ${message}`
-    };
-    const headers = {
-        'Content-Type': 'application/json'
-    };
-    return axios_1.default.post(url, data, { headers });
-});
-exports.default = {
-    postMessage
-};

package/dist/cjs/types/account.d.ts

@@ -1,112 +0,0 @@
-import type { Portal } from './portal.js';
-import type { StatusHistory } from './statusHistory.js';
-interface PortalAccountSchema extends Portal {
-    invoiceFilenames: any[];
-}
-interface RateSchema {
-    type: string;
-    value: number;
-    description: string;
-}
-interface ContractSchema {
-    startDate: Date;
-    endDate: Date;
-    terminationDate?: Date;
-    paymentTerms?: string;
-    duration?: string;
-    tariffName?: string;
-    contractConsumption?: number;
-    volumeTolerance?: any[];
-    renewablePercentage?: number;
-    marketBasedEmissionFactor?: number;
-    chargeableCclPercentage?: number;
-    commissionRates?: number;
-    rates: any[];
-    s3Key?: string;
-    rateTypeMapping?: object;
-    batchId?: string;
-    supplierId?: string;
-    status: 'active' | 'inactive';
-    userSub?: string;
-    deletedOn?: Date;
-}
-interface CreditNoteSchema {
-    name: string;
-    type: string;
-    amount: number;
-    netAmount: number;
-    taxAmount: number;
-    date: Date;
-    isPaid: boolean;
-    s3Key: string;
-    stampedS3Key: string;
-    fileName: string;
-    invoiceData: object;
-    userSub: string;
-    readingIds: any[];
-    supplierId: string;
-    totalUnits: number;
-    endDate: Date;
-    startDate: Date;
-    stampDate: Date;
-    totalWaterVolume: number;
-    totalWasteVolume: number;
-    totalWaterCost: number;
-    totalWasteCost: number;
-}
-export interface Account {
-    _id: string;
-    name: string;
-    modifiedBy?: string;
-    siteCode?: string;
-    type: 'gas' | 'electricity' | 'water' | 'waste' | 'solar';
-    supplierRef?: string;
-    financialCode?: string;
-    propertyCode?: string;
-    meterPointNumber?: string;
-    meterSerialNumber?: string;
-    meterPointNumber2?: string;
-    meterUnits: 'kwh' | 'm3' | 'ft3';
-    automaticMeterRead?: boolean;
-    status?: 'active' | 'inactive';
-    statusHistory?: StatusHistory[];
-    rates?: RateSchema[];
-    capacity?: string;
-    meterOperator?: string;
-    meterLocation?: string;
-    meterOperatorType?: 'lease' | 'purchase';
-    meterOperatorExpiryDate?: Date;
-    dataCollector?: string;
-    parentAccountId?: string;
-    processingInvoices?: object[];
-    contracts?: ContractSchema[];
-    creditNotes?: CreditNoteSchema[];
-    meterUser?: string;
-    isTrc?: boolean;
-    floorArea?: string;
-    floorAreaUnit?: 'metric' | 'imperial';
-    reportingType?: string;
-    solarType?: 'generation' | 'export';
-    consumptionSource?: 'primary' | 'sub' | 'primary-sub';
-    esec?: 'a' | 'b' | 'c' | 'd' | 'e' | 'g' | 'h' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 's' | 't' | 'u';
-    portal?: PortalAccountSchema;
-    deviceId?: string;
-    gridfetchLoa?: {
-        s3Key?: string;
-        name?: string;
-        uploadedBy?: string;
-        uploadedAt?: Date;
-        expiryDate?: Date;
-        error?: string;
-        uploaded?: boolean;
-    };
-    automationIds?: string[];
-    customIntegrations?: object;
-    supplierId?: string;
-    batchId?: string;
-    assetId: string;
-    entityId: string;
-    companyId: string;
-    userSub: string;
-}
-export {};

package/dist/cjs/types/account.js

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

package/dist/cjs/types/address.d.ts

@@ -1,11 +0,0 @@
-export interface Address {
-    streetAddress: string;
-    locality?: string;
-    region?: string;
-    postCode: string;
-    province?: string;
-    countryCode?: string;
-    jurisdictionCode?: string;
-    latitude?: string;
-    longitude?: string;
-}

package/dist/cjs/types/address.js

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

package/dist/cjs/types/asset.d.ts

@@ -1,122 +0,0 @@
-import type { Address } from './address.js';
-import type { StatusHistory } from './statusHistory.js';
-interface Image {
-    url?: string;
-    label?: string;
-    type?: string;
-    isHidden?: boolean;
-    isPrimary?: boolean;
-}
-interface FloodRisk {
-    url?: string;
-    description?: string;
-    label?: string;
-    latitude?: number;
-    longitude?: number;
-    fetchedAt?: Date;
-}
-interface Crime {
-    category?: string;
-    month?: string;
-    crimeId?: string;
-    outcomeCategory?: string;
-    outcomeDate?: string;
-    location?: {
-        latitude: string;
-        longitude: string;
-        street: string;
-    };
-    fetchedAt?: Date;
-}
-interface AirQuality {
-    index?: number;
-    indexColour?: string;
-    indexRating?: string;
-    details?: object;
-    location?: object;
-    lastMeasured?: Date;
-    fetchedAt?: Date;
-}
-interface Benchmark {
-    benchmarkId: string;
-    fieldCode: string;
-    fieldValue: string;
-}
-interface Document {
-    s3Key?: string;
-    name: string;
-    extension?: string;
-    type: string;
-    status: string;
-    score?: string;
-    providerId?: string;
-    providerData?: object;
-    certificate?: object;
-    createdAt: Date;
-    accountIds?: string[];
-}
-interface TimelineEvent {
-    date: Date;
-    title: string;
-    status: string;
-    content?: string;
-    icon?: string;
-    accountIds?: string[];
-}
-interface AssetRecommendation {
-    recommendationId: string;
-    documentIds?: string[];
-}
-interface AssetSettings {
-    consumptionSources: {
-        electricity: string;
-        solar: string;
-        gas: string;
-        water: string;
-    };
-}
-export interface Asset {
-    _id: string;
-    siteName: string;
-    address: Address;
-    assetType: string;
-    floorArea: number;
-    floorAreaUnit: 'metric' | 'imperial';
-    noOfFloors?: number;
-    energyRating: string;
-    gav: string;
-    gavCurrency: string;
-    currency: string;
-    occupationStatus: 'occupied' | 'vacant' | 'other' | 'n/a';
-    type: 'new construction' | 'major renovation' | 'standing investment' | 'n/a';
-    vacancyRate?: number;
-    constructionYear?: number;
-    ownedSince?: Date;
-    disposalDate?: Date;
-    tenure: 'freehold' | 'leasehold';
-    tenantControlledPercent?: number;
-    landlordControlledPercent?: number;
-    occupancyLevel?: number;
-    images: Image[];
-    pricePaid?: number;
-    floodRisks: FloodRisk[];
-    recentCrimes: Crime[];
-    recentAirQuality: AirQuality;
-    documents?: Document[];
-    epbCertificates: any[];
-    status?: string;
-    settings: AssetSettings;
-    recommendations?: AssetRecommendation[];
-    statusHistory: StatusHistory[];
-    timelineEvents: TimelineEvent[];
-    benchmarks: Benchmark[];
-    lastPopulated?: Date;
-    deletedOn?: Date;
-    batchId?: string;
-    companyId: string;
-    entityId: string;
-    assetGroupIds: string[];
-    userSub: string;
-    gresbId?: string;
-}
-export {};

package/dist/cjs/types/asset.js

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

package/dist/cjs/types/automation.d.ts

@@ -1,33 +0,0 @@
-interface Log {
-    message: string;
-    timestamp: Date;
-    batchId?: string;
-    source?: string;
-}
-interface LastCollection {
-    collectedAt: Date | null;
-    data: Record<string, any> | null;
-    error: Record<string, any> | null;
-    status: 'success' | 'error' | 'pending';
-    source: Record<string, any> | null;
-}
-type FrequencyType = 'never' | 'trigger' | 'hourly' | 'daily' | 'weekly' | 'monthly';
-export interface Automation {
-    _id: string;
-    description?: string;
-    service: string;
-    source: string;
-    category: string;
-    active: boolean;
-    status?: 'running' | 'pending';
-    lastCollection: LastCollection;
-    logs: Log[];
-    data: Record<string, any>;
-    sourceData: Record<string, any>;
-    frequency?: FrequencyType;
-    accountIds?: string[];
-    assetIds?: string[];
-    userSub: string;
-    companyId: string;
-}
-export {};

package/dist/cjs/types/automation.js

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

package/dist/cjs/types/company.d.ts

@@ -1,42 +0,0 @@
-import { Address } from './address.js';
-import { Portal } from './portal.js';
-interface SupplierPortals {
-    supplierId: string;
-    portal: Portal;
-}
-interface CustomIntegrations {
-    account: any[];
-    asset: any[];
-    entity: any[];
-}
-interface DefaultSources {
-    electricity: 'invoice' | 'consumption' | 'reading';
-    solar: 'invoice' | 'consumption' | 'reading';
-    gas: 'invoice' | 'consumption' | 'reading';
-    water: 'invoice' | 'consumption' | 'reading';
-}
-interface CompanySettings {
-    showLogo?: boolean;
-    invoiceCategories?: any[];
-    miscInvoiceCategories?: any[];
-    messageCategories?: any[];
-    documentCategories?: any[];
-    assetDataSchemas?: any[];
-    hideCostData?: boolean;
-    calendarPeriod?: string;
-    customIntegrations?: CustomIntegrations;
-    supplierPortals?: SupplierPortals[];
-    defaultSources?: DefaultSources;
-    scraperCounter?: number;
-}
-export interface Company {
-    _id: string;
-    name: string;
-    address?: Address;
-    invoiceEmail?: string;
-    users?: string[];
-    settings: CompanySettings;
-    logoS3Key: string;
-    logoUrl?: string;
-}
-export {};

package/dist/cjs/types/company.js

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

package/dist/cjs/types/dataIngest.d.ts

@@ -1,8 +0,0 @@
-export interface DataIngest {
-    _id: string;
-    messageId: string;
-    status: 'started' | 'processing' | 'importing' | 'completed' | 'failed' | 'dlq';
-    context: any;
-    startTime: string;
-    remainingTime: number;
-}

package/dist/cjs/types/dataIngest.js

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

package/dist/cjs/types/email.d.ts

@@ -1,18 +0,0 @@
-interface Attachment {
-    filename: string;
-    s3Key: string;
-}
-export interface Email {
-    _id: string;
-    destinations: string[];
-    service: string;
-    subject: string;
-    body: string;
-    from: string;
-    attachments?: Attachment[];
-    sesMessageId: string;
-    s3Key: string;
-    userSub?: string;
-    companyId?: string;
-}
-export {};

package/dist/cjs/types/email.js

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

package/dist/cjs/types/entity.d.ts

@@ -1,16 +0,0 @@
-import { Address } from './address.js';
-type EntityType = 'fund' | 'company' | 'charity' | 'school/university' | 'council' | 'other';
-export interface Entity {
-    _id: string;
-    legalName: string;
-    type: EntityType;
-    companyNumber?: string;
-    companyLogo?: string;
-    billingAddress: Address;
-    parentEntityId?: string;
-    ultimateParentEntityId?: string;
-    companyId: string;
-    batchId?: string;
-    userSub: string;
-}
-export {};

package/dist/cjs/types/entity.js

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

package/dist/cjs/types/index.d.ts

@@ -1,19 +0,0 @@
-export type { Account } from './account.js';
-export type { Asset } from './asset.js';
-export type { Automation } from './automation.js';
-export type { Company } from './company.js';
-export type { CreateScraperRunParams, ScraperRun } from './scraperRun.js';
-export type { DataIngest } from './dataIngest.js';
-export type { Entity } from './entity.js';
-export type { Email } from './email.js';
-export type { Invoice } from './invoice.js';
-export type { Log } from './log.js';
-export type { Reading } from './reading.js';
-export type { Report } from './report.js';
-export type { Supplier } from './supplier.js';
-export interface ETNPagedResponse<T = any> {
-    data: T[];
-    total: number;
-    limit: number;
-    skip: number;
-}

package/dist/cjs/types/index.js

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

package/dist/cjs/types/invoice.d.ts

@@ -1,118 +0,0 @@
-interface Values {
-    friendlyInvoiceNumber?: string;
-    friendlySupplierRef?: string;
-    friendlyStartDate?: string;
-    friendlyEndDate?: string;
-    friendlyInvoiceDate?: string;
-    friendlyMeterPointNumber?: string;
-    friendlyMeterPointNumber2?: string;
-    friendlyMeterSerialNumber?: string;
-    friendlyPipeSize?: string;
-    friendlyTotalUnitCost?: number;
-    friendlyTotalWaterCost?: number;
-    friendlyTotalWasteCost?: number;
-    friendlyTotalDaily?: number;
-    friendlyTotalLevy?: number;
-    friendlyTotalKva?: number;
-    friendlyTotalUnits?: number;
-    friendlyTotalWaterVolume?: number;
-    friendlyTotalWasteVolume?: number;
-    friendlyNetTotalCost?: number;
-    friendlyTotalTax?: number;
-    friendlyTotalCost?: number;
-    friendlyMeteredConsumption?: string;
-    friendlyCorrectedConsumption?: string;
-    friendlyCorrectionFactor?: string;
-    friendlyCalorificValue?: string;
-    friendlyReadFactor?: string;
-    friendlyType?: string;
-    friendlyStartRead?: string;
-    friendlyEndRead?: string;
-    invoiceNumber?: string;
-    supplierRef?: string;
-    startDate?: Date;
-    endDate?: Date;
-    invoiceDate?: Date;
-    meterPointNumber?: string;
-    meterPointNumber2?: string;
-    meterSerialNumber?: string;
-    pipeSize?: string;
-    totalUnitCost?: number;
-    totalWaterCost?: number;
-    totalWasteCost?: number;
-    totalDaily?: number;
-    totalLevy?: number;
-    totalKva?: number;
-    totalUnits?: number;
-    totalWaterVolume?: number;
-    totalWasteVolume?: number;
-    netTotalCost?: number;
-    totalTax?: number;
-    totalCost?: number;
-    meteredConsumption?: string;
-    correctedConsumption?: string;
-    correctionFactor?: string;
-    calorificValue?: string;
-    readFactor?: string;
-    type?: string;
-    startRead?: string;
-    endRead?: string;
-}
-interface Rate {
-    consumption?: string;
-    cost?: string;
-    endDate?: Date | null;
-    endRead?: string | null;
-    endReadType?: string | null;
-    rateName?: string | null;
-    startDate?: Date | null;
-    startRead?: string | null;
-    startReadType?: string | null;
-    type: RateType | null;
-    unitRate?: string | null;
-}
-type InvoiceStatus = 'processing' | 'pending' | 'uploading' | 'queued' | 'captured' | 'error' | 'completed';
-type FinancialStatus = 'approved' | 'new' | 'not-approved' | 'paid' | 'sent-for-payment';
-type RateType = 'unitRate' | 'daily' | 'levy' | 'tax' | 'kva' | 'waterRate' | 'wasteRate' | 'discount';
-export interface Invoice {
-    _id: string;
-    jobId?: string | null;
-    startTime?: Date;
-    endTime?: Date | null;
-    s3Key: string;
-    s3TextractKey?: string | null;
-    stampedS3Key: string | null;
-    fileName?: string | null;
-    status: InvoiceStatus;
-    financialStatus: FinancialStatus;
-    completed?: boolean;
-    type?: string | null;
-    tags?: string[];
-    manualResults?: Record<string, any>;
-    values?: Values;
-    rates?: Rate[];
-    detailedResults?: Record<string, any>;
-    templateVersion?: string | null;
-    error?: Record<string, any>;
-    isPaid?: boolean;
-    isCreditNote?: boolean;
-    isConvertedCreditNote?: boolean;
-    isManual?: boolean;
-    uploaderStatus?: string;
-    simulated?: boolean;
-    notes?: string | null;
-    assignedTo?: string;
-    noScrape?: boolean;
-    scraperInvoiceId?: string;
-    confirmedAt?: Date | null;
-    confirmedBy?: string | null;
-    supplierId?: string | null;
-    sisterId?: string | null;
-    batchId?: string | null;
-    accountId?: string | null;
-    entityId?: string;
-    companyId: string;
-    userSub: string;
-    validation?: any[];
-}
-export {};

package/dist/cjs/types/invoice.js

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

package/dist/cjs/types/log.d.ts

@@ -1,10 +0,0 @@
-export interface Log {
-    _id: string;
-    message: string;
-    context?: {};
-    linkedId?: string;
-    linkedType?: string;
-    type: string;
-    userSub?: string;
-    companyId?: string;
-}

package/dist/cjs/types/log.js

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

package/dist/cjs/types/portal.d.ts

@@ -1,8 +0,0 @@
-export interface Portal {
-    username?: string;
-    password?: string;
-    scraperEnabled?: boolean;
-    url?: string;
-    scraperId?: string;
-    scraperStartDate?: Date;
-}

package/dist/cjs/types/portal.js

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

package/dist/cjs/types/reading.d.ts

@@ -1,17 +0,0 @@
-export interface Reading {
-    _id: string;
-    submittedAt: Date;
-    value: number;
-    type?: string;
-    invoiceStartRead?: number;
-    source: string;
-    invoiceId?: string;
-    rateId?: string;
-    contractRateType?: string;
-    invoiceBatchId?: string;
-    batchId?: string;
-    accountId: string;
-    entityId: string;
-    companyId: string;
-    userSub?: string;
-}

package/dist/cjs/types/reading.js

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

package/dist/cjs/types/report.d.ts

@@ -1,21 +0,0 @@
-export interface Report {
-    _id: string;
-    type: 'dynamic' | 'spreadsheet' | 'table' | 'pdf';
-    subType?: string;
-    fileFormat: 'pdf' | 'xlsx' | 'csv' | 'png' | 'jpg' | 'chart';
-    fileName?: string;
-    status: 'preparing' | 'ready';
-    scheduled?: boolean;
-    version?: number;
-    metadata?: Record<string, any>;
-    data?: Record<string, any>;
-    requestedAt: Date;
-    availableAt?: Date;
-    s3Key: string | null;
-    batchId?: string;
-    scheduledReportId?: string;
-    reportTemplateId?: string;
-    entityId: string;
-    companyId: string;
-    userSub?: string;
-}

package/dist/cjs/types/report.js

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

package/dist/cjs/types/scraperRun.d.ts

@@ -1,15 +0,0 @@
-export interface CreateScraperRunParams {
-    supplierId: string;
-    accountId: string;
-    companyId: string;
-}
-export interface ScraperRun {
-    _id: string;
-    logs?: {}[];
-    supplierId: string;
-    accountId: string;
-    companyId: string;
-    invoiceData?: [];
-    status: string[];
-    error?: string;
-}