@etainabl/nodejs-sdk 1.2.43 → 1.2.45

package/src/types/account.ts

@@ -1,116 +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[]; // Referenced from another file
-  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;
-}

package/src/types/address.ts

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

package/src/types/asset.ts

@@ -1,142 +0,0 @@
-import type { Address } from './address.js'
-import type { StatusHistory } from './statusHistory.js'
-
-// Define the Image Schema
-interface Image {
-  url?: string;
-  label?: string;
-  type?: string;
-  isHidden?: boolean;
-  isPrimary?: boolean;
-}
-
-// Define the Flood Risk Schema
-interface FloodRisk {
-  url?: string;
-  description?: string;
-  label?: string;
-  latitude?: number;
-  longitude?: number;
-  fetchedAt?: Date;
-}
-
-// Define the Crime Schema
-interface Crime {
-  category?: string;
-  month?: string;
-  crimeId?: string;
-  outcomeCategory?: string;
-  outcomeDate?: string;
-  location?: {
-    latitude: string;
-    longitude: string;
-    street: string;
-  };
-  fetchedAt?: Date;
-}
-
-// Define the Air Quality Schema
-interface AirQuality {
-  index?: number;
-  indexColour?: string;
-  indexRating?: string;
-  details?: object;
-  location?: object;
-  lastMeasured?: Date;
-  fetchedAt?: Date;
-}
-
-// Define the Benchmark Schema
-interface Benchmark {
-  benchmarkId: string
-  fieldCode: string;
-  fieldValue: string;
-}
-
-// Define the Document Schema
-interface Document {
-  s3Key?: string;
-  name: string;
-  extension?: string;
-  type: string;
-  status: string;
-  score?: string;
-  providerId?: string;
-  providerData?: object;
-  certificate?: object;
-  createdAt: Date;
-  accountIds?: string[];
-}
-
-// Define the Timeline Event Schema
-interface TimelineEvent {
-  date: Date;
-  title: string;
-  status: string;
-  content?: string;
-  icon?: string;
-  accountIds?: string[];
-}
-
-// Define the Asset Recommendation Schema
-interface AssetRecommendation {
-  recommendationId: string
-  documentIds?: string[];
-}
-
-// Define the Asset Settings Schema
-interface AssetSettings {
-  consumptionSources: {
-    electricity: string;
-    solar: string;
-    gas: string;
-    water: string;
-  };
-}
-
-// Main export, mirroring the main object in your code
-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;
-  };
-  

package/src/types/automation.ts

@@ -1,35 +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;
-}

package/src/types/company.ts

@@ -1,47 +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;
-}

package/src/types/dataIngest.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/src/types/email.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
-}

package/src/types/entity.ts

@@ -1,17 +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;
-}

package/src/types/index.ts

@@ -1,20 +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/src/types/invoice.ts

@@ -1,119 +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[];
-}

package/src/types/log.ts

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

package/src/types/portal.ts

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

package/src/types/reading.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/src/types/report.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/src/types/scraperRun.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;
-}

package/src/types/statusHistory.ts

@@ -1,5 +0,0 @@
-export interface StatusHistory {
-    date: Date;
-    value: 'active' | 'inactive';
-    notes?: string;
-  }

package/src/types/supplier.ts

@@ -1,31 +0,0 @@
-import { Portal } from './portal.js'
-
-interface PortalSupplierSchema extends Portal {
-  concurrent: boolean;
-  checkInvoiceFilenames: boolean;
-  supplierRefRequired: boolean;
-}
-
-interface InvoiceOptionsSchema {
-  stampPositionX?: number;
-  stampPositionY?: number;
-}
-
-export interface Supplier {
-  _id: string
-  name: string;
-  logoUrl?: string;
-  websiteUrl?: string;
-  portalUrl?: string;
-  identifier?: string;
-  type: 'supplier' | 'distributor';
-  region?: string;
-  countryCode: string;
-  defaultScraper?: string;
-  active: boolean;
-  transferSupplier: boolean;
-  transferSupplierId?: string;
-  portal: PortalSupplierSchema;
-  invoiceOptions?: InvoiceOptionsSchema;
-};
-