@etainabl/nodejs-sdk 1.2.20 → 1.2.22

package/dist/cjs/api.d.ts

@@ -1,4 +1,5 @@
 import type { AxiosRequestConfig, AxiosInstance, CreateAxiosDefaults } from 'axios';
+import type { Account, Asset, Company, Invoice, Log, Reading, Report } from '../types/index.js';
 export interface ETNPagedResponse<T = any> {
     data: T[];
     total: number;
@@ -71,8 +72,8 @@ declare const _default: (auth: AuthOptions, instanceOptions?: CreateAxiosDefault
     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<any>>;
+    getReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<Report>;
+    listReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Report>>;
     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>;

package/dist/cjs/units.d.ts

@@ -5,9 +5,9 @@ interface Item {
     value: number;
     [key: string]: any;
 }
-export declare type AccountType = 'electricity' | 'gas' | 'water' | 'waste' | 'solar' | 'heating' | 'flow' | 'cooling' | 'temperature' | 'other';
-export declare type ETNUnit = 'kwh' | 'kg' | 'm3' | 'lbs' | 'tonnes' | 'wh' | 'mwh' | 'ft3' | 'hcf' | 'm3/h' | 'qty' | 'l' | 'C' | 'mcuf' | 'hcuf' | 'tcuf' | 'ocuf' | 'hm3' | 'tm3' | 'nm3';
-export declare type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h';
+export type AccountType = 'electricity' | 'gas' | 'water' | 'waste' | 'solar' | 'heating' | 'flow' | 'cooling' | 'temperature' | 'other';
+export type ETNUnit = 'kwh' | 'kg' | 'm3' | 'lbs' | 'tonnes' | 'wh' | 'mwh' | 'ft3' | 'hcf' | 'm3/h' | 'qty' | 'l' | 'C' | 'mcuf' | 'hcuf' | 'tcuf' | 'ocuf' | 'hm3' | 'tm3' | 'nm3';
+export type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h';
 export declare const accountTypeMap: {
     [key: string]: BaseUnit;
 };

package/dist/mjs/api.d.ts

@@ -1,4 +1,5 @@
 import type { AxiosRequestConfig, AxiosInstance, CreateAxiosDefaults } from 'axios';
+import type { Account, Asset, Company, Invoice, Log, Reading, Report } from '../types/index.js';
 export interface ETNPagedResponse<T = any> {
     data: T[];
     total: number;
@@ -71,8 +72,8 @@ declare const _default: (auth: AuthOptions, instanceOptions?: CreateAxiosDefault
     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<any>>;
+    getReport: (id: string, options?: AxiosRequestConfig<any>) => Promise<Report>;
+    listReports: (options?: AxiosRequestConfig<any>) => Promise<ETNPagedResponse<Report>>;
     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>;

package/dist/mjs/units.d.ts

@@ -5,9 +5,9 @@ interface Item {
     value: number;
     [key: string]: any;
 }
-export declare type AccountType = 'electricity' | 'gas' | 'water' | 'waste' | 'solar' | 'heating' | 'flow' | 'cooling' | 'temperature' | 'other';
-export declare type ETNUnit = 'kwh' | 'kg' | 'm3' | 'lbs' | 'tonnes' | 'wh' | 'mwh' | 'ft3' | 'hcf' | 'm3/h' | 'qty' | 'l' | 'C' | 'mcuf' | 'hcuf' | 'tcuf' | 'ocuf' | 'hm3' | 'tm3' | 'nm3';
-export declare type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h';
+export type AccountType = 'electricity' | 'gas' | 'water' | 'waste' | 'solar' | 'heating' | 'flow' | 'cooling' | 'temperature' | 'other';
+export type ETNUnit = 'kwh' | 'kg' | 'm3' | 'lbs' | 'tonnes' | 'wh' | 'mwh' | 'ft3' | 'hcf' | 'm3/h' | 'qty' | 'l' | 'C' | 'mcuf' | 'hcuf' | 'tcuf' | 'ocuf' | 'hm3' | 'tm3' | 'nm3';
+export type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h';
 export declare const accountTypeMap: {
     [key: string]: BaseUnit;
 };

package/package.json

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

package/src/api.ts

@@ -4,7 +4,7 @@ import https from 'https';
 
 import logger from './logger.js';
 
-import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier } from '../types/index.js'
+import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Report, Supplier } from '../types/index.js'
 
 const log = logger('etainablApi');
 
@@ -323,8 +323,8 @@ export default (auth: AuthOptions, instanceOptions: CreateAxiosDefaults = {}) =>
       getReadingSchema: factory.get(etainablApi, 'readings', 'schema'),
   
       // reports
-      getReport: factory.getWithId(etainablApi, 'reports'),
-      listReports: factory.list(etainablApi, 'reports'),
+      getReport: factory.getWithId<Report>(etainablApi, 'reports'),
+      listReports: factory.list<Report>(etainablApi, 'reports'),
       updateReport: factory.update(etainablApi, 'reports'),
       createReport: factory.create(etainablApi, 'reports'),
       removeReport: factory.remove(etainablApi, 'reports'),

package/types/index.d.ts

@@ -7,6 +7,7 @@ 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 { Report } from './report.d.ts'
 import type { Supplier } from './supplier.d.ts'
 
 export type {
@@ -20,6 +21,7 @@ export type {
   Invoice,
   Log,
   Reading,
+  Report,
   ScraperRun,
   Supplier
 };

package/types/report.d.ts

@@ -0,0 +1,20 @@
+export interface Report {
+  type: 'dynamic' | 'spreadsheet' | 'table' | 'pdf';
+  subType?: string;
+  fileFormat: 'pdf' | 'xlsx' | 'csv' | 'png' | 'jpg' | 'chart';
+  fileName?: string;
+  status: 'preparing' | 'ready';
+  scheduled?: boolean;
+  version?: number;
+  metadata?: Record<string, any>;
+  data?: Record<string, any>;
+  requestedAt: Date;
+  availableAt?: Date;
+  s3Key: string | null;
+  batchId?: string;
+  scheduledReportId?: string;
+  reportTemplateId?: string;
+  entityId: string;
+  companyId: string;
+  userSub?: string;
+}