@etainabl/nodejs-sdk 1.3.141 → 1.3.143

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import * as _aws_sdk_client_ses from '@aws-sdk/client-ses';
 import { S3Client } from '@aws-sdk/client-s3';
 import { Context, SQSEvent, SNSEvent, APIGatewayEvent, S3Event } from 'aws-lambda';
 import { SQSClient } from '@aws-sdk/client-sqs';
+import { SoftDeleteDocument } from 'mongoose-delete';
 import winston from 'winston';
 import moment from 'moment';
 import { ZodObject } from 'zod';
@@ -305,12 +306,12 @@ declare namespace units {
   export { type units_AccountType as AccountType, type units_BaseUnit as BaseUnit, type units_ETNUnit as ETNUnit, units_accountTypeMap as accountTypeMap, units_accountTypeUnitMap as accountTypeUnitMap, units_checkAccountTypeVsUnits as checkAccountTypeVsUnits, units_convertItems as convertItems, units_simpleConvert as simpleConvert };
 }
 
-interface Portal<IDType = ObjectId | string> {
+interface Portal {
     username?: string;
     password?: string;
     scraperEnabled?: boolean;
     url?: string;
-    scraperId?: IDType;
+    scraperId?: string;
     scraperStartDate?: Date;
 }
 
@@ -1073,7 +1074,7 @@ 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' | 'misc' | 'feedInTariff' | 'latePaymentCharge';
-interface Invoice<IDType = ObjectId | string, DateType = Date> {
+interface Invoice<IDType = ObjectId | string, DateType = Date> extends SoftDeleteDocument {
     _id: IDType;
     jobId?: string | null;
     startTime?: DateType;
@@ -1414,27 +1415,27 @@ interface AuthOptions {
 declare const _default$4: (auth: AuthOptions, instanceOptions?: CreateAxiosDefaults) => {
     instance: AxiosInstance;
     getAccount: (id: string, options?: AxiosRequestConfig) => Promise<Account<string>>;
-    listAccounts: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Account<string>>>;
+    listAccounts: <P = Account<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateAccount: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Account<string>>;
     createAccount: (data: any, options?: AxiosRequestConfig) => Promise<Account<string>>;
     removeAccount: (id: string, options?: AxiosRequestConfig) => Promise<Account<string>>;
     getAccountSchema: (options?: AxiosRequestConfig) => Promise<any>;
     invalidateAccountCache: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     getAsset: (id: string, options?: AxiosRequestConfig) => Promise<Asset<string>>;
-    listAssets: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Asset<string>>>;
+    listAssets: <P = Asset<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateAsset: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Asset<string>>;
     createAsset: (data: any, options?: AxiosRequestConfig) => Promise<Asset<string>>;
     removeAsset: (id: string, options?: AxiosRequestConfig) => Promise<Asset<string>>;
     getAssetSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getAssetGroup: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listAssetGroups: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
+    listAssetGroups: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateAssetGroup: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     createAssetGroup: (data: any, options?: AxiosRequestConfig) => Promise<any>;
     removeAssetGroup: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     getAssetGroupAssets: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     getAssetGroupSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getAutomation: (id: string, options?: AxiosRequestConfig) => Promise<Automation<string>>;
-    listAutomations: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Automation<string>>>;
+    listAutomations: <P = Automation<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateAutomation: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Automation<string>>;
     createAutomation: (data: any, options?: AxiosRequestConfig) => Promise<Automation<string>>;
     removeAutomation: (id: string, options?: AxiosRequestConfig) => Promise<Automation<string>>;
@@ -1444,97 +1445,99 @@ declare const _default$4: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     updateAccountStatusForAutomation: (id: string, subId: string, data: any, options?: AxiosRequestConfig) => Promise<Automation<string>>;
     getCompany: (id: string, options?: AxiosRequestConfig) => Promise<Company<string>>;
     getCompanyInvoiceValidationRules: (id: string, options?: AxiosRequestConfig) => Promise<CompanyInvoiceValidationRule<string>[]>;
-    listCompanies: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Company<string>>>;
+    listCompanies: <P = Company<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateCompany: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Company<string>>;
     getConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listConsumptions: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
+    listConsumptions: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateConsumption: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     createConsumption: (data: any, options?: AxiosRequestConfig) => Promise<any>;
     removeConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     getConsumptionSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getEmail: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listEmails: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
+    listEmails: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateEmail: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     createEmail: (data: any, options?: AxiosRequestConfig) => Promise<any>;
     removeEmail: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     getEmissionFactor: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listEmissionFactors: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
+    listEmissionFactors: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateEmissionFactor: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     createEmissionFactor: (data: any, options?: AxiosRequestConfig) => Promise<any>;
     removeEmissionFactor: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     getEntity: (id: string, options?: AxiosRequestConfig) => Promise<Entity<string>>;
-    listEntities: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Entity<string>>>;
+    listEntities: <P = Entity<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateEntity: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Entity<string>>;
     createEntity: (data: any, options?: AxiosRequestConfig) => Promise<Entity<string>>;
     removeEntity: (id: string, options?: AxiosRequestConfig) => Promise<Entity<string>>;
     getEntitiesSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getEntityStructure: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     getLog: (id: string, options?: AxiosRequestConfig) => Promise<Log<string>>;
-    listLogs: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Log<string>>>;
+    listLogs: <P = Log<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     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, Date>>;
-    listReadings: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Reading<string, Date>>>;
+    listReadings: <P = Reading<string, Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     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>>>;
+    listReports: <P = Report<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Report<string>>;
     createReport: (data: any, options?: AxiosRequestConfig) => Promise<Report<string>>;
     removeReport: (id: string, options?: AxiosRequestConfig) => Promise<Report<string>>;
     sendReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     getReportTemplate: (id: string, options?: AxiosRequestConfig) => Promise<ReportTemplate<string>>;
-    listReportTemplates: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<ReportTemplate<string>>>;
+    listReportTemplates: <P = ReportTemplate<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateReportTemplate: (id: string, data: any, options?: AxiosRequestConfig) => Promise<ReportTemplate<string>>;
     createReportTemplate: (data: any, options?: AxiosRequestConfig) => Promise<ReportTemplate<string>>;
     removeReportTemplate: (id: string, options?: AxiosRequestConfig) => Promise<ReportTemplate<string>>;
     getScheduledReport: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listScheduledReports: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
+    listScheduledReports: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateScheduledReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     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, Date>>;
-    listInvoices: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Invoice<string, Date>>>;
+    listInvoices: <P = Invoice<string, string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     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>>;
-    listInvoicesCapture: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<InvoiceCapture<string>>>;
+    listInvoicesCapture: <P = InvoiceCapture<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateInvoiceCapture: (id: string, data: any, options?: AxiosRequestConfig) => Promise<InvoiceCapture<string>>;
     createInvoiceCapture: (data: any, options?: AxiosRequestConfig) => Promise<InvoiceCapture<string>>;
     removeInvoiceCapture: (id: string, options?: AxiosRequestConfig) => Promise<InvoiceCapture<string>>;
     getInvoiceCaptureSchema: (options?: AxiosRequestConfig) => Promise<any>;
     startInvoiceCaptureValidation: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     getInvoiceValidation: (id: string, options?: AxiosRequestConfig) => Promise<InvoiceValidation<string>>;
-    listInvoicesValidation: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<InvoiceValidation<string>>>;
+    listInvoicesValidation: <P = InvoiceValidation<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateInvoiceValidation: (id: string, data: any, options?: AxiosRequestConfig) => Promise<InvoiceValidation<string>>;
     createInvoiceValidation: (data: any, options?: AxiosRequestConfig) => Promise<InvoiceValidation<string>>;
     removeInvoiceValidation: (id: string, options?: AxiosRequestConfig) => Promise<InvoiceValidation<string>>;
     getInvoiceValidationSchema: (options?: AxiosRequestConfig) => Promise<any>;
     restartInvoiceValidation: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     getSupplier: (id: string, options?: AxiosRequestConfig) => Promise<Supplier<string>>;
-    listSuppliers: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Supplier<string>>>;
+    listSuppliers: <P = Supplier<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     getSupplierSchema: (options?: AxiosRequestConfig) => Promise<any>;
     updateSupplier: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Supplier<string>>;
     getImportTemplate: (id: string, options?: AxiosRequestConfig) => Promise<ImportTemplate<string, Record<string, any>, Record<string, any>, Record<string, any>>>;
-    listDataIngest: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<DataIngest<string>>>;
+    listDataIngest: <P = DataIngest<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateDataIngest: (id: string, data: any, options?: AxiosRequestConfig) => Promise<DataIngest<string>>;
     createDataIngest: (data: any, options?: AxiosRequestConfig) => Promise<DataIngest<string>>;
-    listUsers: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<User<string>>>;
+    listUsers: <P = User<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     getUser: (id: string, options?: AxiosRequestConfig) => Promise<User<string>>;
     getUserSelf: (options?: AxiosRequestConfig) => Promise<User<string>>;
     socketConnect: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     socketDisconnect: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    listScraperRuns: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<ScraperRun<string>>>;
+    listScraperRuns: <P = ScraperRun<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateScraperRun: (id: string, data: any, options?: AxiosRequestConfig) => Promise<ScraperRun<string>>;
+    createScraperRun: (data: any, options?: AxiosRequestConfig) => Promise<ScraperRun<string>>;
+    createScraperRunLog: (id: string, data: any, options?: AxiosRequestConfig) => Promise<ScraperRun<string>>;
     createAutomationRun: (data: Omit<AutomationRun<string, string>, "_id">, options?: AxiosRequestConfig) => Promise<AutomationRun<string, string | Date>>;
-    listAutomationRun: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<AutomationRun<string, string | Date>>>;
+    listAutomationRun: <P = AutomationRun<string, string | Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     getAutomationRun: (id: string, options?: AxiosRequestConfig) => Promise<AutomationRun<string, string | Date>>;
     updateAutomationRun: (id: string, data: any, options?: AxiosRequestConfig) => Promise<AutomationRun<string, string>>;
     createAutomationRunLog: (id: string, data: Omit<AutomationRunLog<string>, "date">, options?: AxiosRequestConfig) => Promise<AutomationRun<string, string | Date>>;
@@ -1762,4 +1765,16 @@ declare namespace index {
   export { index_Prompt as Prompt, type index_PromptInput as PromptInput, type index_PromptOptions as PromptOptions, type index_PromptResponse as PromptResponse };
 }
 
-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 };
+type ETNAccount = Account<string> & {
+    scraperSettings: PortalSupplierSchema & Portal & {
+        schedule?: string;
+    };
+    sharedSupplierRef?: boolean;
+};
+
+type scrapers_ETNAccount = ETNAccount;
+declare namespace scrapers {
+  export type { scrapers_ETNAccount as ETNAccount };
+}
+
+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 Portal, type PortalSupplierSchema, 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, scrapers, _default as slack, units, index$1 as utils };