@etainabl/nodejs-sdk 1.2.50 → 1.2.52

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as axios from 'axios';
 import { CreateAxiosDefaults, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { ObjectId, Db } from 'mongodb';
 import winston from 'winston';
-import { Db } from 'mongodb';
 import moment from 'moment';
 
 interface Portal {
@@ -9,7 +9,7 @@ interface Portal {
     password?: string;
     scraperEnabled?: boolean;
     url?: string;
-    scraperId?: string;
+    scraperId?: ObjectId | string;
     scraperStartDate?: Date;
 }
 
@@ -19,6 +19,8 @@ interface StatusHistory {
     notes?: string;
 }
 
+type UtilityType = 'electricity' | 'gas' | 'water' | 'waste' | 'solar' | 'heating' | 'flow' | 'cooling' | 'temperature' | 'oil' | 'other';
+
 interface PortalAccountSchema extends Portal {
     invoiceFilenames: any[];
 }
@@ -28,6 +30,7 @@ interface RateSchema {
     description: string;
 }
 interface ContractSchema {
+    _id: ObjectId | string;
     startDate: Date;
     endDate: Date;
     terminationDate?: Date;
@@ -44,12 +47,13 @@ interface ContractSchema {
     s3Key?: string;
     rateTypeMapping?: object;
     batchId?: string;
-    supplierId?: string;
+    supplierId?: ObjectId | string;
     status: 'active' | 'inactive';
     userSub?: string;
     deletedOn?: Date;
 }
 interface CreditNoteSchema {
+    _id: ObjectId | string;
     name: string;
     type: string;
     amount: number;
@@ -62,8 +66,8 @@ interface CreditNoteSchema {
     fileName: string;
     invoiceData: object;
     userSub: string;
-    readingIds: any[];
-    supplierId: string;
+    readingIds: ObjectId[] | string[];
+    supplierId: ObjectId | string;
     totalUnits: number;
     endDate: Date;
     startDate: Date;
@@ -74,11 +78,11 @@ interface CreditNoteSchema {
     totalWasteCost: number;
 }
 interface Account {
-    _id: string;
+    _id: ObjectId | string;
     name: string;
     modifiedBy?: string;
     siteCode?: string;
-    type: 'gas' | 'electricity' | 'water' | 'waste' | 'solar';
+    type: UtilityType;
     supplierRef?: string;
     financialCode?: string;
     propertyCode?: string;
@@ -96,7 +100,7 @@ interface Account {
     meterOperatorType?: 'lease' | 'purchase';
     meterOperatorExpiryDate?: Date;
     dataCollector?: string;
-    parentAccountId?: string;
+    parentAccountId?: ObjectId | string;
     processingInvoices?: object[];
     contracts?: ContractSchema[];
     creditNotes?: CreditNoteSchema[];
@@ -119,13 +123,13 @@ interface Account {
         error?: string;
         uploaded?: boolean;
     };
-    automationIds?: string[];
+    automationIds?: ObjectId[] | string[];
     customIntegrations?: object;
-    supplierId?: string;
+    supplierId?: ObjectId | string;
     batchId?: string;
-    assetId: string;
-    entityId: string;
-    companyId: string;
+    assetId: ObjectId | string;
+    entityId: ObjectId | string;
+    companyId: ObjectId | string;
     userSub: string;
 }
 
@@ -194,7 +198,7 @@ interface Document {
     providerData?: object;
     certificate?: object;
     createdAt: Date;
-    accountIds?: string[];
+    accountIds?: ObjectId[] | string[];
 }
 interface TimelineEvent {
     date: Date;
@@ -202,11 +206,11 @@ interface TimelineEvent {
     status: string;
     content?: string;
     icon?: string;
-    accountIds?: string[];
+    accountIds?: ObjectId[] | string[];
 }
 interface AssetRecommendation {
-    recommendationId: string;
-    documentIds?: string[];
+    recommendationId: ObjectId | string;
+    documentIds?: ObjectId[] | string[];
 }
 interface AssetSettings {
     consumptionSources: {
@@ -217,7 +221,7 @@ interface AssetSettings {
     };
 }
 interface Asset {
-    _id: string;
+    _id: ObjectId | string;
     siteName: string;
     address: Address;
     assetType: string;
@@ -254,14 +258,15 @@ interface Asset {
     lastPopulated?: Date;
     deletedOn?: Date;
     batchId?: string;
-    companyId: string;
-    entityId: string;
-    assetGroupIds: string[];
+    companyId: ObjectId | string;
+    entityId: ObjectId | string;
+    assetGroupIds: ObjectId[] | string[];
     userSub: string;
     gresbId?: string;
 }
 
 interface Log$1 {
+    _id: ObjectId | string;
     message: string;
     timestamp: Date;
     batchId?: string;
@@ -276,7 +281,7 @@ interface LastCollection {
 }
 type FrequencyType = 'never' | 'trigger' | 'hourly' | 'daily' | 'weekly' | 'monthly';
 interface Automation {
-    _id: string;
+    _id: ObjectId | string;
     description?: string;
     service: string;
     source: string;
@@ -288,14 +293,14 @@ interface Automation {
     data: Record<string, any>;
     sourceData: Record<string, any>;
     frequency?: FrequencyType;
-    accountIds?: string[];
-    assetIds?: string[];
+    accountIds?: ObjectId[] | string[];
+    assetIds?: ObjectId[] | string[];
     userSub: string;
-    companyId: string;
+    companyId: ObjectId | string;
 }
 
 interface SupplierPortals {
-    supplierId: string;
+    supplierId: ObjectId | string;
     portal: Portal;
 }
 interface CustomIntegrations {
@@ -324,7 +329,7 @@ interface CompanySettings {
     scraperCounter?: number;
 }
 interface Company {
-    _id: string;
+    _id: ObjectId | string;
     name: string;
     address?: Address;
     invoiceEmail?: string;
@@ -335,23 +340,23 @@ interface Company {
 }
 
 interface CreateScraperRunParams {
-    supplierId: string;
-    accountId: string;
-    companyId: string;
+    supplierId: ObjectId | string;
+    accountId: ObjectId | string;
+    companyId: ObjectId | string;
 }
 interface ScraperRun {
-    _id: string;
+    _id: ObjectId | string;
     logs?: {}[];
-    supplierId: string;
-    accountId: string;
-    companyId: string;
+    supplierId: ObjectId | string;
+    accountId: ObjectId | string;
+    companyId: ObjectId | string;
     invoiceData?: [];
     status: string[];
     error?: string;
 }
 
 interface DataIngest {
-    _id: string;
+    _id: ObjectId | string;
     messageId: string;
     status: 'started' | 'processing' | 'importing' | 'completed' | 'failed' | 'dlq';
     context: any;
@@ -361,15 +366,15 @@ interface DataIngest {
 
 type EntityType = 'fund' | 'company' | 'charity' | 'school/university' | 'council' | 'other';
 interface Entity {
-    _id: string;
+    _id: ObjectId | string;
     legalName: string;
     type: EntityType;
     companyNumber?: string;
     companyLogo?: string;
     billingAddress: Address;
-    parentEntityId?: string;
-    ultimateParentEntityId?: string;
-    companyId: string;
+    parentEntityId?: ObjectId | string;
+    ultimateParentEntityId?: ObjectId | string;
+    companyId: ObjectId | string;
     batchId?: string;
     userSub: string;
 }
@@ -379,7 +384,7 @@ interface Attachment {
     s3Key: string;
 }
 interface Email {
-    _id: string;
+    _id: ObjectId | string;
     destinations: string[];
     service: string;
     subject: string;
@@ -389,10 +394,10 @@ interface Email {
     sesMessageId: string;
     s3Key: string;
     userSub?: string;
-    companyId?: string;
+    companyId?: ObjectId | string;
 }
 
-interface Values {
+interface InvoiceValues {
     friendlyInvoiceNumber?: string;
     friendlySupplierRef?: string;
     friendlyStartDate?: string;
@@ -452,7 +457,8 @@ interface Values {
     startRead?: string;
     endRead?: string;
 }
-interface Rate {
+interface InvoiceRate {
+    id: string;
     consumption?: string;
     cost?: string;
     endDate?: Date | null;
@@ -462,14 +468,14 @@ interface Rate {
     startDate?: Date | null;
     startRead?: string | null;
     startReadType?: string | null;
-    type: RateType | null;
+    type: InvoiceRateType;
     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';
+type InvoiceRateType = 'unitRate' | 'daily' | 'levy' | 'tax' | 'kva' | 'waterRate' | 'wasteRate' | 'discount';
 interface Invoice {
-    _id: string;
+    _id: ObjectId | string;
     jobId?: string | null;
     startTime?: Date;
     endTime?: Date | null;
@@ -483,8 +489,8 @@ interface Invoice {
     type?: string | null;
     tags?: string[];
     manualResults?: Record<string, any>;
-    values?: Values;
-    rates?: Rate[];
+    values?: InvoiceValues;
+    rates?: InvoiceRate[];
     detailedResults?: Record<string, any>;
     templateVersion?: string | null;
     error?: Record<string, any>;
@@ -501,24 +507,24 @@ interface Invoice {
     confirmedAt?: Date | null;
     confirmedBy?: string | null;
     supplierId?: string | null;
-    sisterId?: string | null;
-    batchId?: string | null;
-    accountId?: string | null;
-    entityId?: string;
+    sisterId?: ObjectId | string | null;
+    batchId?: ObjectId | string | null;
+    accountId?: ObjectId | string | null;
+    entityId?: ObjectId | string;
     companyId: string;
     userSub: string;
     validation?: any[];
 }
 
 interface Log {
-    _id: string;
+    _id: ObjectId | string;
     message: string;
     context?: {};
-    linkedId?: string;
+    linkedId?: ObjectId | string;
     linkedType?: string;
     type: string;
     userSub?: string;
-    companyId?: string;
+    companyId?: ObjectId | string;
 }
 
 interface Reading {
@@ -528,20 +534,20 @@ interface Reading {
     type?: string;
     invoiceStartRead?: number;
     source: string;
-    invoiceId?: string;
-    rateId?: string;
+    invoiceId?: ObjectId | string;
+    rateId?: ObjectId | string;
     contractRateType?: string;
     invoiceBatchId?: string;
     batchId?: string;
-    accountId: string;
-    entityId: string;
-    companyId: string;
+    accountId: ObjectId | string;
+    entityId: ObjectId | string;
+    companyId: ObjectId | string;
     userSub?: string;
 }
 
 type ReportSource = 'assetGroup' | 'asset' | 'account' | 'accountsByRegister';
 interface ReportSourceIdItem {
-    _id: string;
+    _id: ObjectId | string;
     type: ReportSource;
 }
 interface ReportMetadata {
@@ -559,9 +565,16 @@ interface ReportMetadata {
     consumptionSource?: 'reading' | 'invoice' | 'combined' | 'hh' | 'reading-hh';
     showSimulated?: boolean;
     chartOptions?: any;
+    filters: Record<string, any>;
+    readingSource: Reading['source'];
+    dateField: 'startDateEndDate' | 'startDate' | 'endDate' | 'confirmedAt';
+    includeSubMeters: boolean;
+    utilityType: UtilityType;
+    accountTag: string;
+    activityType: string;
 }
 interface Report {
-    _id: string;
+    _id: ObjectId | string;
     type: 'dynamic' | 'spreadsheet' | 'table' | 'pdf';
     subType?: string;
     fileFormat: 'pdf' | 'xlsx' | 'csv' | 'json' | 'png' | 'jpg' | 'chart';
@@ -575,10 +588,10 @@ interface Report {
     availableAt?: Date;
     s3Key: string | null;
     batchId?: string;
-    scheduledReportId?: string;
-    reportTemplateId?: string;
-    entityId: string;
-    companyId: string;
+    scheduledReportId?: ObjectId | string;
+    reportTemplateId?: ObjectId | string;
+    entityId: ObjectId | string;
+    companyId: ObjectId | string;
     userSub?: string;
 }
 
@@ -592,7 +605,7 @@ interface InvoiceOptionsSchema {
     stampPositionY?: number;
 }
 interface Supplier {
-    _id: string;
+    _id: ObjectId | string;
     name: string;
     logoUrl?: string;
     websiteUrl?: string;
@@ -615,6 +628,14 @@ interface ETNPagedResponse$1<T = any> {
     limit: number;
     skip: number;
 }
+type ToAPIType<T> = T extends (ObjectId | string) ? string : T extends Array<infer U> ? Array<ToAPIType<U>> : T extends object ? {
+    [K in keyof T]: ToAPIType<T[K]>;
+} : T;
+type ToMongoType<T> = T extends (ObjectId | string) ? ObjectId : T extends Array<infer U> ? Array<ToMongoType<U>> : T extends object ? {
+    [K in keyof T]: ToMongoType<T[K]>;
+} : T;
+type APIResponse<T> = ToAPIType<T>;
+type DBResponse<T> = ToMongoType<T>;
 
 interface ETNPagedResponse<T = any> {
     data: T[];
@@ -800,4 +821,4 @@ declare namespace reporting {
   export { reporting_getScheduledReportRunTimes as getScheduledReportRunTimes };
 }
 
-export { type Account, type Asset, type Automation, type Company, type CreateScraperRunParams, type DataIngest, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, type Invoice, type Log, type Reading, type Report, type ReportMetadata, type ReportSource, type ReportSourceIdItem, type ScraperRun, type Supplier, _default$3 as api, consumption, _default$1 as db, _default$2 as logger, monitoring, reporting, _default as slack, units };
+export { type APIResponse, type Account, type Asset, type Automation, type Company, type CreateScraperRunParams, type DBResponse, type DataIngest, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, type Invoice, type InvoiceRate, type InvoiceRateType, type InvoiceValues, type Log, type Reading, type Report, type ReportMetadata, type ReportSource, type ReportSourceIdItem, type ScraperRun, type Supplier, type ToAPIType, type ToMongoType, type UtilityType, _default$3 as api, consumption, _default$1 as db, _default$2 as logger, monitoring, reporting, _default as slack, units };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as axios from 'axios';
 import { CreateAxiosDefaults, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { ObjectId, Db } from 'mongodb';
 import winston from 'winston';
-import { Db } from 'mongodb';
 import moment from 'moment';
 
 interface Portal {
@@ -9,7 +9,7 @@ interface Portal {
     password?: string;
     scraperEnabled?: boolean;
     url?: string;
-    scraperId?: string;
+    scraperId?: ObjectId | string;
     scraperStartDate?: Date;
 }
 
@@ -19,6 +19,8 @@ interface StatusHistory {
     notes?: string;
 }
 
+type UtilityType = 'electricity' | 'gas' | 'water' | 'waste' | 'solar' | 'heating' | 'flow' | 'cooling' | 'temperature' | 'oil' | 'other';
+
 interface PortalAccountSchema extends Portal {
     invoiceFilenames: any[];
 }
@@ -28,6 +30,7 @@ interface RateSchema {
     description: string;
 }
 interface ContractSchema {
+    _id: ObjectId | string;
     startDate: Date;
     endDate: Date;
     terminationDate?: Date;
@@ -44,12 +47,13 @@ interface ContractSchema {
     s3Key?: string;
     rateTypeMapping?: object;
     batchId?: string;
-    supplierId?: string;
+    supplierId?: ObjectId | string;
     status: 'active' | 'inactive';
     userSub?: string;
     deletedOn?: Date;
 }
 interface CreditNoteSchema {
+    _id: ObjectId | string;
     name: string;
     type: string;
     amount: number;
@@ -62,8 +66,8 @@ interface CreditNoteSchema {
     fileName: string;
     invoiceData: object;
     userSub: string;
-    readingIds: any[];
-    supplierId: string;
+    readingIds: ObjectId[] | string[];
+    supplierId: ObjectId | string;
     totalUnits: number;
     endDate: Date;
     startDate: Date;
@@ -74,11 +78,11 @@ interface CreditNoteSchema {
     totalWasteCost: number;
 }
 interface Account {
-    _id: string;
+    _id: ObjectId | string;
     name: string;
     modifiedBy?: string;
     siteCode?: string;
-    type: 'gas' | 'electricity' | 'water' | 'waste' | 'solar';
+    type: UtilityType;
     supplierRef?: string;
     financialCode?: string;
     propertyCode?: string;
@@ -96,7 +100,7 @@ interface Account {
     meterOperatorType?: 'lease' | 'purchase';
     meterOperatorExpiryDate?: Date;
     dataCollector?: string;
-    parentAccountId?: string;
+    parentAccountId?: ObjectId | string;
     processingInvoices?: object[];
     contracts?: ContractSchema[];
     creditNotes?: CreditNoteSchema[];
@@ -119,13 +123,13 @@ interface Account {
         error?: string;
         uploaded?: boolean;
     };
-    automationIds?: string[];
+    automationIds?: ObjectId[] | string[];
     customIntegrations?: object;
-    supplierId?: string;
+    supplierId?: ObjectId | string;
     batchId?: string;
-    assetId: string;
-    entityId: string;
-    companyId: string;
+    assetId: ObjectId | string;
+    entityId: ObjectId | string;
+    companyId: ObjectId | string;
     userSub: string;
 }
 
@@ -194,7 +198,7 @@ interface Document {
     providerData?: object;
     certificate?: object;
     createdAt: Date;
-    accountIds?: string[];
+    accountIds?: ObjectId[] | string[];
 }
 interface TimelineEvent {
     date: Date;
@@ -202,11 +206,11 @@ interface TimelineEvent {
     status: string;
     content?: string;
     icon?: string;
-    accountIds?: string[];
+    accountIds?: ObjectId[] | string[];
 }
 interface AssetRecommendation {
-    recommendationId: string;
-    documentIds?: string[];
+    recommendationId: ObjectId | string;
+    documentIds?: ObjectId[] | string[];
 }
 interface AssetSettings {
     consumptionSources: {
@@ -217,7 +221,7 @@ interface AssetSettings {
     };
 }
 interface Asset {
-    _id: string;
+    _id: ObjectId | string;
     siteName: string;
     address: Address;
     assetType: string;
@@ -254,14 +258,15 @@ interface Asset {
     lastPopulated?: Date;
     deletedOn?: Date;
     batchId?: string;
-    companyId: string;
-    entityId: string;
-    assetGroupIds: string[];
+    companyId: ObjectId | string;
+    entityId: ObjectId | string;
+    assetGroupIds: ObjectId[] | string[];
     userSub: string;
     gresbId?: string;
 }
 
 interface Log$1 {
+    _id: ObjectId | string;
     message: string;
     timestamp: Date;
     batchId?: string;
@@ -276,7 +281,7 @@ interface LastCollection {
 }
 type FrequencyType = 'never' | 'trigger' | 'hourly' | 'daily' | 'weekly' | 'monthly';
 interface Automation {
-    _id: string;
+    _id: ObjectId | string;
     description?: string;
     service: string;
     source: string;
@@ -288,14 +293,14 @@ interface Automation {
     data: Record<string, any>;
     sourceData: Record<string, any>;
     frequency?: FrequencyType;
-    accountIds?: string[];
-    assetIds?: string[];
+    accountIds?: ObjectId[] | string[];
+    assetIds?: ObjectId[] | string[];
     userSub: string;
-    companyId: string;
+    companyId: ObjectId | string;
 }
 
 interface SupplierPortals {
-    supplierId: string;
+    supplierId: ObjectId | string;
     portal: Portal;
 }
 interface CustomIntegrations {
@@ -324,7 +329,7 @@ interface CompanySettings {
     scraperCounter?: number;
 }
 interface Company {
-    _id: string;
+    _id: ObjectId | string;
     name: string;
     address?: Address;
     invoiceEmail?: string;
@@ -335,23 +340,23 @@ interface Company {
 }
 
 interface CreateScraperRunParams {
-    supplierId: string;
-    accountId: string;
-    companyId: string;
+    supplierId: ObjectId | string;
+    accountId: ObjectId | string;
+    companyId: ObjectId | string;
 }
 interface ScraperRun {
-    _id: string;
+    _id: ObjectId | string;
     logs?: {}[];
-    supplierId: string;
-    accountId: string;
-    companyId: string;
+    supplierId: ObjectId | string;
+    accountId: ObjectId | string;
+    companyId: ObjectId | string;
     invoiceData?: [];
     status: string[];
     error?: string;
 }
 
 interface DataIngest {
-    _id: string;
+    _id: ObjectId | string;
     messageId: string;
     status: 'started' | 'processing' | 'importing' | 'completed' | 'failed' | 'dlq';
     context: any;
@@ -361,15 +366,15 @@ interface DataIngest {
 
 type EntityType = 'fund' | 'company' | 'charity' | 'school/university' | 'council' | 'other';
 interface Entity {
-    _id: string;
+    _id: ObjectId | string;
     legalName: string;
     type: EntityType;
     companyNumber?: string;
     companyLogo?: string;
     billingAddress: Address;
-    parentEntityId?: string;
-    ultimateParentEntityId?: string;
-    companyId: string;
+    parentEntityId?: ObjectId | string;
+    ultimateParentEntityId?: ObjectId | string;
+    companyId: ObjectId | string;
     batchId?: string;
     userSub: string;
 }
@@ -379,7 +384,7 @@ interface Attachment {
     s3Key: string;
 }
 interface Email {
-    _id: string;
+    _id: ObjectId | string;
     destinations: string[];
     service: string;
     subject: string;
@@ -389,10 +394,10 @@ interface Email {
     sesMessageId: string;
     s3Key: string;
     userSub?: string;
-    companyId?: string;
+    companyId?: ObjectId | string;
 }
 
-interface Values {
+interface InvoiceValues {
     friendlyInvoiceNumber?: string;
     friendlySupplierRef?: string;
     friendlyStartDate?: string;
@@ -452,7 +457,8 @@ interface Values {
     startRead?: string;
     endRead?: string;
 }
-interface Rate {
+interface InvoiceRate {
+    id: string;
     consumption?: string;
     cost?: string;
     endDate?: Date | null;
@@ -462,14 +468,14 @@ interface Rate {
     startDate?: Date | null;
     startRead?: string | null;
     startReadType?: string | null;
-    type: RateType | null;
+    type: InvoiceRateType;
     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';
+type InvoiceRateType = 'unitRate' | 'daily' | 'levy' | 'tax' | 'kva' | 'waterRate' | 'wasteRate' | 'discount';
 interface Invoice {
-    _id: string;
+    _id: ObjectId | string;
     jobId?: string | null;
     startTime?: Date;
     endTime?: Date | null;
@@ -483,8 +489,8 @@ interface Invoice {
     type?: string | null;
     tags?: string[];
     manualResults?: Record<string, any>;
-    values?: Values;
-    rates?: Rate[];
+    values?: InvoiceValues;
+    rates?: InvoiceRate[];
     detailedResults?: Record<string, any>;
     templateVersion?: string | null;
     error?: Record<string, any>;
@@ -501,24 +507,24 @@ interface Invoice {
     confirmedAt?: Date | null;
     confirmedBy?: string | null;
     supplierId?: string | null;
-    sisterId?: string | null;
-    batchId?: string | null;
-    accountId?: string | null;
-    entityId?: string;
+    sisterId?: ObjectId | string | null;
+    batchId?: ObjectId | string | null;
+    accountId?: ObjectId | string | null;
+    entityId?: ObjectId | string;
     companyId: string;
     userSub: string;
     validation?: any[];
 }
 
 interface Log {
-    _id: string;
+    _id: ObjectId | string;
     message: string;
     context?: {};
-    linkedId?: string;
+    linkedId?: ObjectId | string;
     linkedType?: string;
     type: string;
     userSub?: string;
-    companyId?: string;
+    companyId?: ObjectId | string;
 }
 
 interface Reading {
@@ -528,20 +534,20 @@ interface Reading {
     type?: string;
     invoiceStartRead?: number;
     source: string;
-    invoiceId?: string;
-    rateId?: string;
+    invoiceId?: ObjectId | string;
+    rateId?: ObjectId | string;
     contractRateType?: string;
     invoiceBatchId?: string;
     batchId?: string;
-    accountId: string;
-    entityId: string;
-    companyId: string;
+    accountId: ObjectId | string;
+    entityId: ObjectId | string;
+    companyId: ObjectId | string;
     userSub?: string;
 }
 
 type ReportSource = 'assetGroup' | 'asset' | 'account' | 'accountsByRegister';
 interface ReportSourceIdItem {
-    _id: string;
+    _id: ObjectId | string;
     type: ReportSource;
 }
 interface ReportMetadata {
@@ -559,9 +565,16 @@ interface ReportMetadata {
     consumptionSource?: 'reading' | 'invoice' | 'combined' | 'hh' | 'reading-hh';
     showSimulated?: boolean;
     chartOptions?: any;
+    filters: Record<string, any>;
+    readingSource: Reading['source'];
+    dateField: 'startDateEndDate' | 'startDate' | 'endDate' | 'confirmedAt';
+    includeSubMeters: boolean;
+    utilityType: UtilityType;
+    accountTag: string;
+    activityType: string;
 }
 interface Report {
-    _id: string;
+    _id: ObjectId | string;
     type: 'dynamic' | 'spreadsheet' | 'table' | 'pdf';
     subType?: string;
     fileFormat: 'pdf' | 'xlsx' | 'csv' | 'json' | 'png' | 'jpg' | 'chart';
@@ -575,10 +588,10 @@ interface Report {
     availableAt?: Date;
     s3Key: string | null;
     batchId?: string;
-    scheduledReportId?: string;
-    reportTemplateId?: string;
-    entityId: string;
-    companyId: string;
+    scheduledReportId?: ObjectId | string;
+    reportTemplateId?: ObjectId | string;
+    entityId: ObjectId | string;
+    companyId: ObjectId | string;
     userSub?: string;
 }
 
@@ -592,7 +605,7 @@ interface InvoiceOptionsSchema {
     stampPositionY?: number;
 }
 interface Supplier {
-    _id: string;
+    _id: ObjectId | string;
     name: string;
     logoUrl?: string;
     websiteUrl?: string;
@@ -615,6 +628,14 @@ interface ETNPagedResponse$1<T = any> {
     limit: number;
     skip: number;
 }
+type ToAPIType<T> = T extends (ObjectId | string) ? string : T extends Array<infer U> ? Array<ToAPIType<U>> : T extends object ? {
+    [K in keyof T]: ToAPIType<T[K]>;
+} : T;
+type ToMongoType<T> = T extends (ObjectId | string) ? ObjectId : T extends Array<infer U> ? Array<ToMongoType<U>> : T extends object ? {
+    [K in keyof T]: ToMongoType<T[K]>;
+} : T;
+type APIResponse<T> = ToAPIType<T>;
+type DBResponse<T> = ToMongoType<T>;
 
 interface ETNPagedResponse<T = any> {
     data: T[];
@@ -800,4 +821,4 @@ declare namespace reporting {
   export { reporting_getScheduledReportRunTimes as getScheduledReportRunTimes };
 }
 
-export { type Account, type Asset, type Automation, type Company, type CreateScraperRunParams, type DataIngest, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, type Invoice, type Log, type Reading, type Report, type ReportMetadata, type ReportSource, type ReportSourceIdItem, type ScraperRun, type Supplier, _default$3 as api, consumption, _default$1 as db, _default$2 as logger, monitoring, reporting, _default as slack, units };
+export { type APIResponse, type Account, type Asset, type Automation, type Company, type CreateScraperRunParams, type DBResponse, type DataIngest, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, type Invoice, type InvoiceRate, type InvoiceRateType, type InvoiceValues, type Log, type Reading, type Report, type ReportMetadata, type ReportSource, type ReportSourceIdItem, type ScraperRun, type Supplier, type ToAPIType, type ToMongoType, type UtilityType, _default$3 as api, consumption, _default$1 as db, _default$2 as logger, monitoring, reporting, _default as slack, units };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etainabl/nodejs-sdk",
-  "version": "1.2.50",
+  "version": "1.2.52",
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.mjs",