@etainabl/nodejs-sdk 1.3.110 → 1.3.112

package/dist/index.d.ts

@@ -2,11 +2,12 @@ import * as axios from 'axios';
 import { CreateAxiosDefaults, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { ObjectId, Db } from 'mongodb';
 export { ObjectId } from 'mongodb';
+import { S3Client } from '@aws-sdk/client-s3';
+import { SQSClient } from '@aws-sdk/client-sqs';
 import winston from 'winston';
 import moment from 'moment';
 import { ZodObject } from 'zod';
 import OpenAI from 'openai';
-import { SQSClient } from '@aws-sdk/client-sqs';
 
 declare const wasteCategories: readonly [{
     readonly name: "General Waste";
@@ -261,6 +262,7 @@ declare const units$1: readonly [{
     readonly types: readonly ["occupancy"];
     readonly defaultTypes: readonly ["occupancy"];
 }];
+declare const getMeterPointNumberBottomLine: (meterPointNumber: string) => string;
 
 type UtilityType = (typeof utilityTypes)[number]['value'];
 
@@ -573,10 +575,10 @@ interface Asset<IDType = ObjectId | string> {
     gresbId?: string;
 }
 
-type AutomationSource = 'ftp' | 'email' | 's3';
+type AutomationSource = 'ftp' | 'email' | 's3' | 'manual';
 type AutomationService = 'accountStatus' | 'autometer' | 'bacnet' | 'beringar' | 'carlogavazzivmuc' | 'carlogavazziuwp' | 'cxgmulticolumn' | 'cxgmultitimecolumn' | 'cxgsinglecolumn' | 'etnsinglecolumn' | 'etnmulticolumn' | 'etnmultitimecolumn' | 'singlecolumn' | 'multicolumn' | 'multitimecolumn' | 'deepki' | '4dmonitoring' | 'crownamr' | 'elogbooks' | 'elveco' | 'elveco2108' | 'gridfetch' | 'imserv' | 'meteruk' | 'mjchurch' | 'msmsolutions' | 'niagaran4' | 'octanise' | 'orsis' | 'schneider' | 'schneideregx' | 'schneidercomx' | 'sentinel' | 'siemens' | 'siemenstem' | 'smartflow' | 'smartvatten' | 'sms' | 'soclean' | 'solarman' | 'solis' | 'sse' | 'stark' | 'synapsys' | 'trendlogs' | 'trio' | 'dataimport';
 type AutomationServiceCategory = 'system' | 'company' | 'account';
-interface Log$2<IDType = ObjectId | string> {
+interface Log$1<IDType = ObjectId | string> {
     _id: IDType;
     message: string;
     timestamp: Date;
@@ -600,7 +602,7 @@ interface Automation<IDType = ObjectId | string> {
     active: boolean;
     status?: 'running' | 'pending';
     lastCollection: LastCollection;
-    logs: Log$2[];
+    logs: Log$1[];
     data: Record<string, any>;
     sourceData: Record<string, any>;
     frequency?: FrequencyType;
@@ -610,34 +612,152 @@ interface Automation<IDType = ObjectId | string> {
     companyId: IDType;
 }
 
-interface Log$1 {
-    date: Date;
+type FormattedConsumption = Omit<Consumption<string, string>, '_id'>;
+type FormattedReading = Omit<Reading<string, string>, '_id'>;
+type FormattedInvoice = Omit<Invoice<string, string>, '_id' | 's3Key'>;
+declare const collectionTypes: readonly ["readings", "consumptions", "invoices"];
+declare const errorCodes: readonly ["ACCOUNT_NOT_FOUND", "INVALID_DATE_FORMAT", "INVALID_TIME_FORMAT", "COLUMN_LIMIT_EXCEEDED", "INVALID_TIMESTAMP", "MISSING_DEVICE_ID", "UNSUPPORTED_UTILITY_TYPE", "VALIDATION_ERROR", "METER_READS_ZERO"];
+interface DLQPayload {
+    originalMessage: string;
+    account?: Account<string>;
+    automation: Automation<string>;
+    automationRun: AutomationRun<string>;
+    error: {
+        message: string;
+        stack?: string;
+        timestamp: string;
+    };
+    context: {
+        messageId: string;
+        processingStage?: string;
+    };
+}
+type CollectionType = 'readings' | 'consumptions' | 'invoices';
+interface UploadCsv {
+    csvContent: string;
+    s3Client?: S3Client;
+    automationRun: AutomationRun<string>;
+    collectionType: CollectionType;
+    orgFilename?: string;
+}
+declare function sendToDLQ({ payload, sqsClient }: {
+    payload: Partial<DLQPayload>;
+    sqsClient?: SQSClient;
+}): Promise<void>;
+declare function createCsv(data: (FormattedConsumption | FormattedReading | FormattedInvoice)[]): string;
+declare function uploadCsv({ csvContent, automationRun, s3Client, orgFilename, collectionType }: UploadCsv): Promise<string>;
+
+type integrations_CollectionType = CollectionType;
+type integrations_DLQPayload = DLQPayload;
+type integrations_FormattedConsumption = FormattedConsumption;
+type integrations_FormattedInvoice = FormattedInvoice;
+type integrations_FormattedReading = FormattedReading;
+declare const integrations_collectionTypes: typeof collectionTypes;
+declare const integrations_createCsv: typeof createCsv;
+declare const integrations_errorCodes: typeof errorCodes;
+declare const integrations_sendToDLQ: typeof sendToDLQ;
+declare const integrations_uploadCsv: typeof uploadCsv;
+declare namespace integrations {
+  export { type integrations_CollectionType as CollectionType, type integrations_DLQPayload as DLQPayload, type integrations_FormattedConsumption as FormattedConsumption, type integrations_FormattedInvoice as FormattedInvoice, type integrations_FormattedReading as FormattedReading, integrations_collectionTypes as collectionTypes, integrations_createCsv as createCsv, integrations_errorCodes as errorCodes, integrations_sendToDLQ as sendToDLQ, integrations_uploadCsv as uploadCsv };
+}
+
+interface AutomationRunLog<DateType = Date | string> {
+    date: DateType;
     message: string;
-    status: string;
-    attachment?: {
-        s3Bucket: string;
-        s3Key: string;
-        filename: string;
+    status: 'error' | 'running' | 'success';
+    errorMessage?: string;
+    lambdaSource?: string;
+    lambdaRequestId?: string;
+    lambdaLogStreamName?: string;
+    lambdaMessageId?: string;
+}
+interface AccountResult<IDType = ObjectId | string, DateType = Date | string> {
+    accountId: IDType;
+    mpan: string;
+    deviceId?: string;
+    status: 'success' | 'warning' | 'error' | 'running';
+    processedRows?: number;
+    failedRows?: number;
+    dateRange?: {
+        from?: DateType;
+        to?: DateType;
     };
+    dataIngested?: number;
+    warnings?: {
+        code: ProblemCodes;
+        message: string;
+        row?: number;
+        field?: string;
+        value?: any;
+        expectedFormat?: string;
+    }[];
+    errors?: {
+        code: ProblemCodes;
+        message: string;
+        row?: number;
+        field?: string;
+        value?: any;
+        expectedFormat?: string;
+    }[];
+}
+type ProblemCodes = 'ACCOUNT_NOT_FOUND' | 'INVALID_DATE_FORMAT' | 'INVALID_TIME_FORMAT' | 'COLUMN_LIMIT_EXCEEDED' | 'INVALID_TIMESTAMP' | 'MISSING_DEVICE_ID' | 'UNSUPPORTED_UTILITY_TYPE' | 'VALIDATION_ERROR' | 'METER_READS_ZERO';
+type ProblemDetails = {
+    deviceId?: string;
+    row?: number;
+    column?: string;
+    field?: string;
+    value?: any;
+    expectedFormat?: string;
+};
+interface Problem {
+    code: ProblemCodes;
+    status?: 'warning' | 'error';
+    message: string;
+    details?: ProblemDetails;
 }
-interface AutomationRun<IDType = ObjectId | string> {
+interface SourceMetadata {
+    fileName: string;
+    fileSize: number;
+    fileType: string;
+    uploadMethod: 'manual' | 'email' | 'ftp' | 's3';
+    s3Bucket?: string;
+    s3Key?: string;
+}
+interface AutomationRunSummary {
+    totalRows?: number;
+    processedRows?: number;
+    failedRows?: number;
+    accountsNotFound?: number;
+    accountsFound?: number;
+    accountsWithWarnings?: number;
+    accountsWithErrors?: number;
+}
+interface AutomationRun<IDType = ObjectId | string, DateType = Date | string> {
     _id: IDType;
-    logs: Log$1[];
-    companyId: IDType;
     automationId: IDType;
-    accountIds: IDType[];
-    status: 'error' | 'completed' | 'running';
-    context: {
-        [key: string]: any;
+    companyId: IDType;
+    active: boolean;
+    category: 'dataFetcher' | 'dataExtractor';
+    status: 'running' | 'success' | 'failed' | 'completedWithWarnings';
+    collectionType?: CollectionType;
+    source?: SourceMetadata;
+    summary?: AutomationRunSummary;
+    accountResults?: AccountResult<IDType, DateType>[];
+    logs?: AutomationRunLog<DateType>[];
+    problems?: Problem[];
+    ingestFile?: {
+        s3Bucket: string;
+        s3Key: string;
+        fileName: string;
     };
 }
 
-interface Consumption<IDType = ObjectId | string> {
+interface Consumption<IDType = ObjectId | string, DateType = Date> {
     _id: IDType;
     value: number;
-    startTimestamp: Date;
-    endTimestamp: Date;
-    timestamp?: Date;
+    startTimestamp: DateType;
+    endTimestamp: DateType;
+    timestamp?: DateType;
     s3Key?: string;
     source?: string;
     category?: string;
@@ -658,6 +778,8 @@ interface Consumption<IDType = ObjectId | string> {
     companyId: IDType;
     metadata?: Record<string, any>;
     batchCorrectionId?: string;
+    createdAt?: DateType;
+    updatedAt?: DateType;
 }
 
 interface InvoiceValidationInvoice {
@@ -854,7 +976,7 @@ interface ImportTemplate<IDType = ObjectId | string, SpreadConfig = Record<strin
     companyId?: IDType;
 }
 
-interface InvoiceValues {
+interface InvoiceValues<DateType = Date | string> {
     friendlyInvoiceNumber?: string;
     friendlySupplierRef?: string;
     friendlyStartDate?: string;
@@ -886,9 +1008,9 @@ interface InvoiceValues {
     friendlyEndRead?: string;
     invoiceNumber?: string;
     supplierRef?: string;
-    startDate?: Date;
-    endDate?: Date;
-    invoiceDate?: Date;
+    startDate?: DateType;
+    endDate?: DateType;
+    invoiceDate?: DateType;
     meterPointNumber?: string;
     meterPointNumber2?: string;
     meterSerialNumber?: string;
@@ -935,11 +1057,11 @@ interface InvoiceRate {
 type InvoiceStatus = 'processing' | 'pending' | 'uploading' | 'queued' | 'captured' | 'error' | 'completed';
 type FinancialStatus = 'approved' | 'new' | 'not-approved' | 'paid' | 'sent-for-payment';
 type InvoiceRateType = 'unitRate' | 'daily' | 'levy' | 'tax' | 'kva' | 'waterRate' | 'wasteRate' | 'discount';
-interface Invoice<IDType = ObjectId | string> {
+interface Invoice<IDType = ObjectId | string, DateType = Date> {
     _id: IDType;
     jobId?: string | null;
-    startTime?: Date;
-    endTime?: Date | null;
+    startTime?: DateType;
+    endTime?: DateType | null;
     s3Key: string;
     s3TextractKey?: string | null;
     stampedS3Key?: string | null;
@@ -951,7 +1073,7 @@ interface Invoice<IDType = ObjectId | string> {
     type?: string | null;
     tags?: string[];
     manualResults?: Record<string, any>;
-    values?: InvoiceValues;
+    values?: InvoiceValues<DateType>;
     rates?: InvoiceRate[];
     detailedResults?: Record<string, any>;
     templateVersion?: string | null;
@@ -966,7 +1088,7 @@ interface Invoice<IDType = ObjectId | string> {
     assignedTo?: string;
     noScrape?: boolean;
     scraperInvoiceId?: string;
-    confirmedAt?: Date | null;
+    confirmedAt?: DateType | null;
     confirmedBy?: string | null;
     supplierId: IDType;
     sisterId?: IDType;
@@ -981,8 +1103,9 @@ interface Invoice<IDType = ObjectId | string> {
     validation?: any[];
     automationId?: IDType;
     ingestS3Key?: string;
-    updatedAt?: Date;
-    createdAt?: Date;
+    updatedAt?: DateType;
+    createdAt?: DateType;
+    automationRunId?: IDType;
 }
 
 interface InvoiceCaptureMetadataResult {
@@ -1051,9 +1174,9 @@ interface Log<IDType = ObjectId | string> {
     companyId?: IDType;
 }
 
-interface Reading<IDType = ObjectId | string> {
+interface Reading<IDType = ObjectId | string, DateType = Date> {
     _id: IDType;
-    submittedAt: Date;
+    submittedAt: DateType;
     value: number;
     units: ETNUnit;
     type?: string;
@@ -1078,6 +1201,8 @@ interface Reading<IDType = ObjectId | string> {
     batchCorrectionId?: string;
     metadata?: Record<string, any>;
     automationId?: IDType;
+    createdAt?: DateType;
+    updatedAt?: DateType;
 }
 
 type ReportSource = 'assetGroup' | 'asset' | 'account' | 'accountsByRegister';
@@ -1297,11 +1422,11 @@ declare const _default$4: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     updateLog: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Log<string>>;
     createLog: (data: any, options?: AxiosRequestConfig) => Promise<Log<string>>;
     removeLog: (id: string, options?: AxiosRequestConfig) => Promise<Log<string>>;
-    getReading: (id: string, options?: AxiosRequestConfig) => Promise<Reading<string>>;
-    listReadings: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Reading<string>>>;
-    updateReading: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Reading<string>>;
-    createReading: (data: any, options?: AxiosRequestConfig) => Promise<Reading<string>>;
-    removeReading: (id: string, options?: AxiosRequestConfig) => Promise<Reading<string>>;
+    getReading: (id: string, options?: AxiosRequestConfig) => Promise<Reading<string, Date>>;
+    listReadings: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Reading<string, Date>>>;
+    updateReading: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Reading<string, Date>>;
+    createReading: (data: any, options?: AxiosRequestConfig) => Promise<Reading<string, Date>>;
+    removeReading: (id: string, options?: AxiosRequestConfig) => Promise<Reading<string, Date>>;
     getReadingSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getReport: (id: string, options?: AxiosRequestConfig) => Promise<Report<string>>;
     listReports: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Report<string>>>;
@@ -1320,11 +1445,11 @@ declare const _default$4: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     createScheduledReport: (data: any, options?: AxiosRequestConfig) => Promise<any>;
     removeScheduledReport: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     sendScheduledReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    getInvoice: (id: string, options?: AxiosRequestConfig) => Promise<Invoice<string>>;
-    listInvoices: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Invoice<string>>>;
-    updateInvoice: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Invoice<string>>;
-    createInvoice: (data: any, options?: AxiosRequestConfig) => Promise<Invoice<string>>;
-    removeInvoice: (id: string, options?: AxiosRequestConfig) => Promise<Invoice<string>>;
+    getInvoice: (id: string, options?: AxiosRequestConfig) => Promise<Invoice<string, Date>>;
+    listInvoices: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Invoice<string, Date>>>;
+    updateInvoice: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Invoice<string, Date>>;
+    createInvoice: (data: any, options?: AxiosRequestConfig) => Promise<Invoice<string, Date>>;
+    removeInvoice: (id: string, options?: AxiosRequestConfig) => Promise<Invoice<string, Date>>;
     getInvoiceSchema: (options?: AxiosRequestConfig) => Promise<any>;
     downloadInvoice: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     getInvoiceCapture: (id: string, options?: AxiosRequestConfig) => Promise<InvoiceCapture<string>>;
@@ -1356,9 +1481,9 @@ declare const _default$4: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     socketDisconnect: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     listScraperRuns: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<ScraperRun<string>>>;
     updateScraperRun: (id: string, data: any, options?: AxiosRequestConfig) => Promise<ScraperRun<string>>;
-    createAutomationRun: (data: any, options?: AxiosRequestConfig) => Promise<AutomationRun<string>>;
-    listAutomationRun: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<AutomationRun<string>>>;
-    updateAutomationRun: (id: string, data: any, options?: AxiosRequestConfig) => Promise<AutomationRun<string>>;
+    createAutomationRun: (data: any, options?: AxiosRequestConfig) => Promise<AutomationRun<string, string | Date>>;
+    listAutomationRun: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<AutomationRun<string, string | Date>>>;
+    updateAutomationRun: (id: string, data: any, options?: AxiosRequestConfig) => Promise<AutomationRun<string, string | Date>>;
     createAutomationRunLog: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     globalSearch: (options?: AxiosRequestConfig) => Promise<any>;
 };
@@ -1432,10 +1557,11 @@ declare const automationServices: {
 
 declare const index$1_automationServices: typeof automationServices;
 declare const index$1_automationSources: typeof automationSources;
+declare const index$1_getMeterPointNumberBottomLine: typeof getMeterPointNumberBottomLine;
 declare const index$1_utilityTypes: typeof utilityTypes;
 declare const index$1_wasteCategories: typeof wasteCategories;
 declare namespace index$1 {
-  export { index$1_automationServices as automationServices, index$1_automationSources as automationSources, units$1 as units, index$1_utilityTypes as utilityTypes, index$1_wasteCategories as wasteCategories };
+  export { index$1_automationServices as automationServices, index$1_automationSources as automationSources, index$1_getMeterPointNumberBottomLine as getMeterPointNumberBottomLine, units$1 as units, index$1_utilityTypes as utilityTypes, index$1_wasteCategories as wasteCategories };
 }
 
 interface ETNModel {
@@ -1527,36 +1653,4 @@ declare namespace index {
   export { index_Prompt as Prompt, type index_PromptInput as PromptInput, type index_PromptOptions as PromptOptions, type index_PromptResponse as PromptResponse };
 }
 
-interface DLQPayload {
-    originalMessage: string;
-    account: Account<string>;
-    automation: Automation<string> | null;
-    automationRun: any | null;
-    error: {
-        message: string;
-        stack?: string;
-        timestamp: string;
-    };
-    context: {
-        messageId: string;
-        processingStage: string;
-    };
-    metadata: {
-        service: string;
-        accountName?: string;
-        meterPointNumber?: string;
-        companyId?: string;
-    };
-}
-declare function sendToDLQ({ QueueUrl, payload, dlqClient }: {
-    QueueUrl: string;
-    payload: Partial<DLQPayload>;
-    dlqClient: SQSClient;
-}): Promise<void>;
-
-declare const integrations_sendToDLQ: typeof sendToDLQ;
-declare namespace integrations {
-  export { integrations_sendToDLQ as sendToDLQ };
-}
-
-export { type AccessLevel, type Account, type Asset, type Automation, type AutomationRun, type AutomationService, type AutomationServiceCategory, type AutomationSource, type Company, type CompanyInvoiceValidationRule, type CompanyInvoiceValidationSettings, type Consumption, type CreateScraperRunParams, type DataIngest, type DefaultField, type ETNEvent, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, type FileFormat, type ImportTemplate, type Invoice, type InvoiceCapture, type InvoiceCaptureMetadata, type InvoiceCaptureMetadataResult, type InvoiceRate, type InvoiceRateType, type InvoiceValidation, type InvoiceValidationInvoice, type InvoiceValidationResults, type InvoiceValidationRule, type InvoiceValues, type Log, type Reading, type Report, type ReportMetadata, type ReportSource, type ReportSourceIdItem, type ReportTemplate, type ReportType, type ScraperRun, type SourceType, type Supplier, type User, type UtilityType, type WasteCategories, type WasteTypes, _default$4 as api, consumption, _default$1 as db, _default$3 as emailTemplate, integrations, _default$2 as logger, monitoring, index as openai, reporting, _default as slack, units, index$1 as utils };
+export { type AccessLevel, type Account, type AccountResult, type Asset, type Automation, type AutomationRun, type AutomationRunLog, type AutomationRunSummary, type AutomationService, type AutomationServiceCategory, type AutomationSource, type Company, type CompanyInvoiceValidationRule, type CompanyInvoiceValidationSettings, type Consumption, type CreateScraperRunParams, type DataIngest, type DefaultField, type ETNEvent, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, type FileFormat, type ImportTemplate, type Invoice, type InvoiceCapture, type InvoiceCaptureMetadata, type InvoiceCaptureMetadataResult, type InvoiceRate, type InvoiceRateType, type InvoiceValidation, type InvoiceValidationInvoice, type InvoiceValidationResults, type InvoiceValidationRule, type InvoiceValues, type Log, type Problem, type ProblemCodes, type ProblemDetails, type Reading, type Report, type ReportMetadata, type ReportSource, type ReportSourceIdItem, type ReportTemplate, type ReportType, type ScraperRun, type SourceType, type Supplier, type User, type UtilityType, type WasteCategories, type WasteTypes, _default$4 as api, consumption, _default$1 as db, _default$3 as emailTemplate, integrations, _default$2 as logger, monitoring, index as openai, reporting, _default as slack, units, index$1 as utils };