@etainabl/nodejs-sdk 1.2.15 → 1.2.17

package/types/asset.d.ts

@@ -0,0 +1,142 @@
+import type { Address } from './address.js'
+import type { StatusHistory } from './statusHistory.ts'
+
+// 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/types/automation.d.ts

@@ -0,0 +1,36 @@
+import { Types } from 'mongoose';
+
+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 {
+  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?: Types.ObjectId[];
+  assetIds?: Types.ObjectId[];
+  userSub: string;
+  companyId: Types.ObjectId;
+}

package/types/company.d.ts

@@ -0,0 +1,47 @@
+
+import { Address } from './address.js'
+import { Portal } from './portal.ts'
+
+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/types/email.d.ts

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

package/types/index.d.ts

@@ -0,0 +1,30 @@
+import type { Account } from './account.d.ts'
+import type { Asset } from './asset.d.ts'
+import type { Company } from './company.d.ts'
+import type { CreateScraperRunParams, ScraperRun } from './scraperRun.d.ts';
+import type { Email } from './email.d.ts';
+import type { Invoice } from './invoice.d.ts';
+import type { Log } from './log.d.ts';
+import type { Reading } from './reading.d.ts'
+import type { Supplier } from './supplier.d.ts'
+
+export type {
+  Account,
+  Asset,
+  Automation,
+  Company,
+  CreateScraperRunParams,
+  Email,
+  Invoice,
+  Log,
+  Reading,
+  ScraperRun,
+  Supplier
+};
+
+export interface ETNPagedResponse<T = any> {
+  data: T[];
+  total: number;
+  limit: number;
+  skip: number;
+}

package/types/invoice.d.ts

@@ -0,0 +1,106 @@
+import { Types } from 'mongoose';
+
+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;
+}
+
+type InvoiceStatus = 'processing' | 'pending' | 'uploading' | 'queued' | 'captured' | 'error' | 'completed';
+type FinancialStatus = 'approved' | 'new' | 'not-approved' | 'paid' | 'sent-for-payment';
+
+export interface Invoice {
+  jobId?: string | null;
+  startTime?: Date;
+  endTime?: Date | null;
+  s3Key: string;
+  s3TextractKey?: string | null;
+  stampedS3Key: string;
+  fileName?: string | null;
+  status: InvoiceStatus;
+  financialStatus: FinancialStatus;
+  completed?: boolean;
+  type?: string | null;
+  tags?: string[];
+  manualResults?: Record<string, any>;
+  values?: Values;
+  rates?: any[];
+  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?: Types.ObjectId | null;
+  sisterId?: string | null;
+  batchId?: string | null;
+  accountId?: Types.ObjectId | null;
+  entityId?: Types.ObjectId;
+  companyId: Types.ObjectId;
+  userSub: string;
+  validation?: any[];
+}

package/types/log.d.ts

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

package/types/portal.d.ts

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

package/types/reading.d.ts

@@ -0,0 +1,16 @@
+export interface Reading {
+  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/types/scraperRun.d.ts

@@ -0,0 +1,15 @@
+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/types/statusHistory.d.ts

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

package/types/supplier.d.ts

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