@etainabl/nodejs-sdk 1.2.16 → 1.2.18

package/dist/cjs/api.d.ts

@@ -1,6 +1,7 @@
 import type { AxiosRequestConfig, AxiosInstance, CreateAxiosDefaults } from 'axios';
-export interface ETNPagedResponse {
-    data: any[];
+import type { Account, Asset, Company, Invoice, Log, Reading, Supplier } from '../types/index.js';
+export interface ETNPagedResponse<T = any> {
+    data: T[];
     total: number;
     limit: number;
     skip: number;
@@ -15,84 +16,87 @@ interface AuthOptions {
 }
 declare const _default: (auth: AuthOptions, instanceOptions?: CreateAxiosDefaults) => {
     instance: AxiosInstance;
-    getAccount: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAccounts: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getAccount: (id: string, options?: AxiosRequestConfig<any>) => Promise<Account>;
+    listAccounts: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Account>>;
     updateAccount: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAccount: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAccount: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAccountSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
-    getAsset: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAssets: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getAsset: (id: string, options?: AxiosRequestConfig<any>) => Promise<Asset>;
+    listAssets: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Asset>>;
     updateAsset: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAsset: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAsset: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetGroup: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAssetGroups: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listAssetGroups: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateAssetGroup: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAssetGroup: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAssetGroup: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetGroupAssets: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetGroupSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
-    getAutomation: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAutomations: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getAutomation: (id: string, options?: AxiosRequestConfig<any>) => Promise<Automation>;
+    listAutomations: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Automation>>;
     updateAutomation: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAutomation: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAutomation: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAutomationLog: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     updateAutomationLog: (id: string, subId: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAutomationLog: (id: string, subId: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getCompany: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
+    getCompany: (id: string, options?: AxiosRequestConfig<any>) => Promise<Company>;
     getConsumption: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listConsumptions: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listConsumptions: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateConsumption: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createConsumption: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeConsumption: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getConsumptionSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
     getEmail: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listEmails: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listEmails: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateEmail: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createEmail: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeEmail: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getEmissionFactor: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listEmissionFactors: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listEmissionFactors: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateEmissionFactor: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createEmissionFactor: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeEmissionFactor: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getLog: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listLogs: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getLog: (id: string, options?: AxiosRequestConfig<any>) => Promise<Log>;
+    listLogs: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Log>>;
     updateLog: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createLog: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeLog: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getReading: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listReadings: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getReading: (id: string, options?: AxiosRequestConfig<any>) => Promise<Reading>;
+    listReadings: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Reading>>;
     updateReading: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createReading: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeReading: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getReadingSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
     getReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createReport: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     sendReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     getReportTemplate: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listReportTemplates: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listReportTemplates: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateReportTemplate: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createReportTemplate: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeReportTemplate: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getScheduledReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listScheduledReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listScheduledReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateScheduledReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createScheduledReport: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeScheduledReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     sendScheduledReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getInvoice: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listInvoices: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getInvoice: (id: string, options?: AxiosRequestConfig<any>) => Promise<Invoice>;
+    listInvoices: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Invoice>>;
     updateInvoice: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createInvoice: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeInvoice: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getInvoiceSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
-    getSupplierSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
+    getSupplierSchema: (options?: AxiosRequestConfig<any>) => Promise<Supplier>;
+    updateDataIngest: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
+    createDataIngest: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
+    listDataIngest: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<DataIngest>>;
 };
 export default _default;

package/dist/cjs/api.js

@@ -38,7 +38,7 @@ const factory = {
             method: 'GET',
             url: `${endpoint}/${id}${postEndpoint ? `/${postEndpoint}` : ''}`
         };
-        log.info(`API Request: ${req.method} ${process.env.ETAINABL_API_URL}/${req.url}`);
+        log.info(`API Request: ${req.method} ${process.env.ETAsINABL_API_URL}/${req.url}`);
         let res;
         try {
             res = yield etainablApi.get(req.url, options);
@@ -293,7 +293,11 @@ exports.default = (auth, instanceOptions = {}) => {
             removeInvoice: factory.remove(etainablApi, 'invoices'),
             getInvoiceSchema: factory.get(etainablApi, 'invoices', 'schema'),
             //suppliers
-            getSupplierSchema: factory.get(etainablApi, 'suppliers', 'schema')
+            getSupplierSchema: factory.get(etainablApi, 'suppliers', 'schema'),
+            //data imports
+            updateDataIngest: factory.update(etainablApi, 'data-ingests'),
+            createDataIngest: factory.create(etainablApi, 'data-ingests'),
+            listDataIngest: factory.list(etainablApi, 'data-ingests'),
         };
     }
     catch (e) {

package/dist/cjs/index.d.ts

@@ -6,4 +6,6 @@ import * as units from './units.js';
 import * as consumption from './consumption.js';
 import * as monitoring from './monitoring.js';
 import * as reporting from './reporting.js';
+import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier } from '../types/index.d.js';
 export { api, logger, consumption, monitoring, db, slack, units, reporting };
+export type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier };

package/dist/mjs/api.d.ts

@@ -1,6 +1,7 @@
 import type { AxiosRequestConfig, AxiosInstance, CreateAxiosDefaults } from 'axios';
-export interface ETNPagedResponse {
-    data: any[];
+import type { Account, Asset, Company, Invoice, Log, Reading, Supplier } from '../types/index.js';
+export interface ETNPagedResponse<T = any> {
+    data: T[];
     total: number;
     limit: number;
     skip: number;
@@ -15,84 +16,87 @@ interface AuthOptions {
 }
 declare const _default: (auth: AuthOptions, instanceOptions?: CreateAxiosDefaults) => {
     instance: AxiosInstance;
-    getAccount: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAccounts: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getAccount: (id: string, options?: AxiosRequestConfig<any>) => Promise<Account>;
+    listAccounts: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Account>>;
     updateAccount: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAccount: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAccount: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAccountSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
-    getAsset: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAssets: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getAsset: (id: string, options?: AxiosRequestConfig<any>) => Promise<Asset>;
+    listAssets: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Asset>>;
     updateAsset: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAsset: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAsset: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetGroup: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAssetGroups: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listAssetGroups: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateAssetGroup: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAssetGroup: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAssetGroup: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetGroupAssets: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getAssetGroupSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
-    getAutomation: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listAutomations: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getAutomation: (id: string, options?: AxiosRequestConfig<any>) => Promise<Automation>;
+    listAutomations: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Automation>>;
     updateAutomation: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAutomation: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAutomation: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     createAutomationLog: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     updateAutomationLog: (id: string, subId: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeAutomationLog: (id: string, subId: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getCompany: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
+    getCompany: (id: string, options?: AxiosRequestConfig<any>) => Promise<Company>;
     getConsumption: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listConsumptions: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listConsumptions: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateConsumption: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createConsumption: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeConsumption: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getConsumptionSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
     getEmail: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listEmails: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listEmails: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateEmail: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createEmail: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeEmail: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getEmissionFactor: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listEmissionFactors: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listEmissionFactors: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateEmissionFactor: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createEmissionFactor: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeEmissionFactor: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getLog: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listLogs: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getLog: (id: string, options?: AxiosRequestConfig<any>) => Promise<Log>;
+    listLogs: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Log>>;
     updateLog: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createLog: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeLog: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getReading: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listReadings: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getReading: (id: string, options?: AxiosRequestConfig<any>) => Promise<Reading>;
+    listReadings: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Reading>>;
     updateReading: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createReading: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeReading: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getReadingSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
     getReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createReport: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     sendReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     getReportTemplate: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listReportTemplates: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listReportTemplates: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateReportTemplate: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createReportTemplate: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeReportTemplate: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getScheduledReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listScheduledReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    listScheduledReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<any>>;
     updateScheduledReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createScheduledReport: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeScheduledReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     sendScheduledReport: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
-    getInvoice: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
-    listInvoices: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse>;
+    getInvoice: (id: string, options?: AxiosRequestConfig<any>) => Promise<Invoice>;
+    listInvoices: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Invoice>>;
     updateInvoice: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     createInvoice: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
     removeInvoice: (id: string, options?: AxiosRequestConfig<any>) => Promise<any>;
     getInvoiceSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
-    getSupplierSchema: (options?: AxiosRequestConfig<any>) => Promise<any>;
+    getSupplierSchema: (options?: AxiosRequestConfig<any>) => Promise<Supplier>;
+    updateDataIngest: (id: string, data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
+    createDataIngest: (data: any, options?: AxiosRequestConfig<any>) => Promise<any>;
+    listDataIngest: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<DataIngest>>;
 };
 export default _default;

package/dist/mjs/api.js

@@ -23,7 +23,7 @@ const factory = {
             method: 'GET',
             url: `${endpoint}/${id}${postEndpoint ? `/${postEndpoint}` : ''}`
         };
-        log.info(`API Request: ${req.method} ${process.env.ETAINABL_API_URL}/${req.url}`);
+        log.info(`API Request: ${req.method} ${process.env.ETAsINABL_API_URL}/${req.url}`);
         let res;
         try {
             res = await etainablApi.get(req.url, options);
@@ -283,7 +283,11 @@ export default (auth, instanceOptions = {}) => {
             removeInvoice: factory.remove(etainablApi, 'invoices'),
             getInvoiceSchema: factory.get(etainablApi, 'invoices', 'schema'),
             //suppliers
-            getSupplierSchema: factory.get(etainablApi, 'suppliers', 'schema')
+            getSupplierSchema: factory.get(etainablApi, 'suppliers', 'schema'),
+            //data imports
+            updateDataIngest: factory.update(etainablApi, 'data-ingests'),
+            createDataIngest: factory.create(etainablApi, 'data-ingests'),
+            listDataIngest: factory.list(etainablApi, 'data-ingests'),
         };
     }
     catch (e) {

package/dist/mjs/index.d.ts

@@ -6,4 +6,6 @@ import * as units from './units.js';
 import * as consumption from './consumption.js';
 import * as monitoring from './monitoring.js';
 import * as reporting from './reporting.js';
+import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier } from '../types/index.d.js';
 export { api, logger, consumption, monitoring, db, slack, units, reporting };
+export type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etainabl/nodejs-sdk",
-  "version": "1.2.16",
+  "version": "1.2.18",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
   "author": "Jonathan Lambert <jonathan@etainabl.com>",

package/src/api.ts

@@ -4,10 +4,12 @@ import https from 'https';
 
 import logger from './logger.js';
 
+import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier } from '../types/index.js'
+
 const log = logger('etainablApi');
 
-export interface ETNPagedResponse {
-  data: any[];
+export interface ETNPagedResponse<T = any>  {
+  data: T[];
   total: number;
   limit: number;
   skip: number;
@@ -39,13 +41,13 @@ function _handleResponse(req: ETNReq, res: AxiosResponse, isPaged = false) {
 }
 
 const factory = {
-  getWithId: (etainablApi: AxiosInstance, endpoint: string, postEndpoint?: string) => async (id: string, options: AxiosRequestConfig = {}) => {
+  getWithId: <T = any> (etainablApi: AxiosInstance, endpoint: string, postEndpoint?: string) => async (id: string, options: AxiosRequestConfig = {}): Promise<T> => {
     const req = {
       method: 'GET',
       url: `${endpoint}/${id}${postEndpoint ? `/${postEndpoint}` : ''}`
     };
 
-    log.info(`API Request: ${req.method} ${process.env.ETAINABL_API_URL}/${req.url}`);
+    log.info(`API Request: ${req.method} ${process.env.ETAsINABL_API_URL}/${req.url}`);
 
     let res: AxiosResponse;
 
@@ -62,7 +64,7 @@ const factory = {
 
     return res.data;
   },
-  get: (etainablApi: AxiosInstance, endpoint: string, postEndpoint?: string) => async (options: AxiosRequestConfig = {}) => {
+  get: <T = any> (etainablApi: AxiosInstance, endpoint: string, postEndpoint?: string) => async (options: AxiosRequestConfig = {}): Promise<T> => {
     const req = {
       method: 'GET',
       url: `${endpoint}${postEndpoint ? `/${postEndpoint}` : ''}`
@@ -84,7 +86,7 @@ const factory = {
 
     return res.data;
   },
-  list: (etainablApi: AxiosInstance, endpoint: string, postEndpoint?: string) => async (options: AxiosRequestConfig = {}): Promise<ETNPagedResponse> => {
+  list: <T = any> (etainablApi: AxiosInstance, endpoint: string, postEndpoint?: string) => async (options: AxiosRequestConfig = {}): Promise<ETNPagedResponse<T>> => {
     const req = {
       method: 'GET',
       url: `${endpoint}${postEndpoint ? `/${postEndpoint}` : ''}`
@@ -196,7 +198,6 @@ const factory = {
 
 // ETN Sub Endpoints
 // e.g. /assets/:id/documents/:documentId
-
 const subFactory = {
   // e.g. POST /assets/:id/documents
   create: (etainablApi: AxiosInstance, endpoint: string, subEndpoint: string) => async (id: string, data: any, options: AxiosRequestConfig = {}) => {    
@@ -246,20 +247,20 @@ export default (auth: AuthOptions, instanceOptions: CreateAxiosDefaults = {}) =>
       instance: etainablApi,
   
       // accounts
-      getAccount: factory.getWithId(etainablApi, 'accounts'),
-      listAccounts: factory.list(etainablApi, 'accounts'),
+      getAccount: factory.getWithId<Account>(etainablApi, 'accounts'),
+      listAccounts: factory.list<Account>(etainablApi, 'accounts'),
       updateAccount: factory.update(etainablApi, 'accounts'),
       createAccount: factory.create(etainablApi, 'accounts'),
       removeAccount: factory.remove(etainablApi, 'accounts'),
       getAccountSchema: factory.get(etainablApi, 'accounts', 'schema'),
-  
+
       // assets
-      getAsset: factory.getWithId(etainablApi, 'assets'),
-      listAssets: factory.list(etainablApi, 'assets'),
+      getAsset: factory.getWithId<Asset>(etainablApi, 'assets'),
+      listAssets: factory.list<Asset>(etainablApi, 'assets'),
       updateAsset: factory.update(etainablApi, 'assets'),
       createAsset: factory.create(etainablApi, 'assets'),
       removeAsset: factory.remove(etainablApi, 'assets'),
-      getAssetSchema:  factory.get(etainablApi, 'assets', 'schema'),
+      getAssetSchema: factory.get(etainablApi, 'assets', 'schema'),
   
       // assetGroups
       getAssetGroup: factory.getWithId(etainablApi, 'asset-groups'),
@@ -271,8 +272,8 @@ export default (auth: AuthOptions, instanceOptions: CreateAxiosDefaults = {}) =>
       getAssetGroupSchema:  factory.get(etainablApi, 'asset-groups', 'schema'),
   
       // automation
-      getAutomation: factory.getWithId(etainablApi, 'automation'),
-      listAutomations: factory.list(etainablApi, 'automation'),
+      getAutomation: factory.getWithId<Automation>(etainablApi, 'automation'),
+      listAutomations: factory.list<Automation>(etainablApi, 'automation'),
       updateAutomation: factory.update(etainablApi, 'automation'),
       createAutomation: factory.create(etainablApi, 'automation'),
       removeAutomation: factory.remove(etainablApi, 'automation'),
@@ -281,7 +282,7 @@ export default (auth: AuthOptions, instanceOptions: CreateAxiosDefaults = {}) =>
       removeAutomationLog: subFactory.remove(etainablApi, 'automation', 'logs'),
   
       // company
-      getCompany: factory.getWithId(etainablApi, 'companies'),
+      getCompany: factory.getWithId<Company>(etainablApi, 'companies'),
   
       // consumption
       getConsumption: factory.getWithId(etainablApi, 'consumptions'),
@@ -306,15 +307,15 @@ export default (auth: AuthOptions, instanceOptions: CreateAxiosDefaults = {}) =>
       removeEmissionFactor: factory.remove(etainablApi, 'emission-factors'),
   
       // logs
-      getLog: factory.getWithId(etainablApi, 'logs'),
-      listLogs: factory.list(etainablApi, 'logs'),
+      getLog: factory.getWithId<Log>(etainablApi, 'logs'),
+      listLogs: factory.list<Log>(etainablApi, 'logs'),
       updateLog: factory.update(etainablApi, 'logs'),
       createLog: factory.create(etainablApi, 'logs'),
       removeLog: factory.remove(etainablApi, 'logs'),
   
       // readings
-      getReading: factory.getWithId(etainablApi, 'readings'),
-      listReadings: factory.list(etainablApi, 'readings'),
+      getReading: factory.getWithId<Reading>(etainablApi, 'readings'),
+      listReadings: factory.list<Reading>(etainablApi, 'readings'),
       updateReading: factory.update(etainablApi, 'readings'),
       createReading: factory.create(etainablApi, 'readings'),
       removeReading: factory.remove(etainablApi, 'readings'),
@@ -344,15 +345,20 @@ export default (auth: AuthOptions, instanceOptions: CreateAxiosDefaults = {}) =>
       sendScheduledReport: factory.customWithId(etainablApi, 'post',  'scheduled-reports', 'send'),
   
       // invoices
-      getInvoice: factory.getWithId(etainablApi, 'invoices'),
-      listInvoices: factory.list(etainablApi, 'invoices'),
+      getInvoice: factory.getWithId<Invoice>(etainablApi, 'invoices'),
+      listInvoices: factory.list<Invoice>(etainablApi, 'invoices'),
       updateInvoice: factory.update(etainablApi, 'invoices'),
       createInvoice: factory.create(etainablApi, 'invoices'),
       removeInvoice: factory.remove(etainablApi, 'invoices'),
-      getInvoiceSchema:  factory.get(etainablApi, 'invoices', 'schema'),
+      getInvoiceSchema: factory.get(etainablApi, 'invoices', 'schema'),
 
       //suppliers
-      getSupplierSchema:  factory.get(etainablApi, 'suppliers', 'schema')
+      getSupplierSchema:  factory.get<Supplier>(etainablApi, 'suppliers', 'schema'),
+
+      //data imports
+      updateDataIngest: factory.update(etainablApi, 'data-ingests'),
+      createDataIngest: factory.create(etainablApi, 'data-ingests'),
+      listDataIngest: factory.list<DataIngest>(etainablApi, 'data-ingests'),
 
     }
   } catch (e) {

package/src/index.ts

@@ -6,6 +6,7 @@ import * as units from './units.js';
 import * as consumption from './consumption.js';
 import * as monitoring from './monitoring.js';
 import * as reporting from './reporting.js';
+import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier } from '../types/index.d.js';
 
 export {
   api,
@@ -16,4 +17,6 @@ export {
   slack,
   units,
   reporting
-}
+}
+
+export type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier };

package/types/account.d.ts

@@ -0,0 +1,116 @@
+import type { Portal } from './portal.ts';
+import type { StatusHistory } from './statusHistory.ts'
+
+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/types/address.d.ts

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

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/dataIngest.d.ts

@@ -0,0 +1,8 @@
+export interface DataImport {
+    messageId: string;
+    status: 'started' | 'processing' | 'importing' | 'completed' | 'failed' | 'dlq'
+    context: string
+    startTime: string;
+    remainingTime: number;
+    context: {}
+}

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,32 @@
+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 { DataIngest } from './dataIngest.js'
+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,
+  DataIngest,
+  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;
+};
+