@etainabl/nodejs-sdk 1.2.32 → 1.2.33

package/dist/cjs/api.d.ts

@@ -1,5 +1,5 @@
 import type { AxiosRequestConfig, AxiosInstance, CreateAxiosDefaults } from 'axios';
-import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Report } from './types/index.js';
+import type { Account, Asset, Automation, Entity, Company, DataIngest, Invoice, Log, Reading, Report } from './types/index.js';
 export interface ETNPagedResponse<T = any> {
     data: T[];
     total: number;
@@ -61,6 +61,12 @@ declare const _default: (auth: AuthOptions, instanceOptions?: CreateAxiosDefault
     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>;
+    listEntities: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Entity>>;
+    updateEntity: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
+    createEntity: (data: any, options?: AxiosRequestConfig) => Promise<any>;
+    removeEntity: (id: string, options?: AxiosRequestConfig) => Promise<any>;
+    getEntitiesSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getLog: (id: string, options?: AxiosRequestConfig) => Promise<Log>;
     listLogs: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Log>>;
     updateLog: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;

package/dist/cjs/api.js

@@ -253,6 +253,13 @@ exports.default = (auth, instanceOptions = {}) => {
             updateEmissionFactor: factory.update(etainablApi, 'emission-factors'),
             createEmissionFactor: factory.create(etainablApi, 'emission-factors'),
             removeEmissionFactor: factory.remove(etainablApi, 'emission-factors'),
+            // entity
+            getEntity: factory.getWithId(etainablApi, 'entities'),
+            listEntities: factory.list(etainablApi, 'entities'),
+            updateEntity: factory.update(etainablApi, 'entities'),
+            createEntity: factory.create(etainablApi, 'entities'),
+            removeEntity: factory.remove(etainablApi, 'entities'),
+            getEntitiesSchema: factory.get(etainablApi, 'entities', 'schema'),
             // logs
             getLog: factory.getWithId(etainablApi, 'logs'),
             listLogs: factory.list(etainablApi, 'logs'),

package/dist/cjs/types/index.d.ts

@@ -4,13 +4,14 @@ import type { Automation } from './automation.js';
 import type { Company } from './company.js';
 import type { CreateScraperRunParams, ScraperRun } from './scraperRun.js';
 import type { DataIngest } from './dataIngest.js';
+import type { Entity } from './entity.js';
 import type { Email } from './email.js';
 import type { Invoice } from './invoice.js';
 import type { Log } from './log.js';
 import type { Reading } from './reading.js';
 import type { Report } from './report.js';
 import type { Supplier } from './supplier.js';
-export type { Account, Asset, Automation, Company, CreateScraperRunParams, DataIngest, Email, Invoice, Log, Reading, Report, ScraperRun, Supplier };
+export type { Account, Asset, Automation, Company, CreateScraperRunParams, DataIngest, Email, Entity, Invoice, Log, Reading, Report, ScraperRun, Supplier };
 export interface ETNPagedResponse<T = any> {
     data: T[];
     total: number;

package/dist/mjs/api.d.ts

@@ -1,5 +1,5 @@
 import type { AxiosRequestConfig, AxiosInstance, CreateAxiosDefaults } from 'axios';
-import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Report } from './types/index.js';
+import type { Account, Asset, Automation, Entity, Company, DataIngest, Invoice, Log, Reading, Report } from './types/index.js';
 export interface ETNPagedResponse<T = any> {
     data: T[];
     total: number;
@@ -61,6 +61,12 @@ declare const _default: (auth: AuthOptions, instanceOptions?: CreateAxiosDefault
     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>;
+    listEntities: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Entity>>;
+    updateEntity: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
+    createEntity: (data: any, options?: AxiosRequestConfig) => Promise<any>;
+    removeEntity: (id: string, options?: AxiosRequestConfig) => Promise<any>;
+    getEntitiesSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getLog: (id: string, options?: AxiosRequestConfig) => Promise<Log>;
     listLogs: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Log>>;
     updateLog: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;

package/dist/mjs/api.js

@@ -243,6 +243,13 @@ export default (auth, instanceOptions = {}) => {
             updateEmissionFactor: factory.update(etainablApi, 'emission-factors'),
             createEmissionFactor: factory.create(etainablApi, 'emission-factors'),
             removeEmissionFactor: factory.remove(etainablApi, 'emission-factors'),
+            // entity
+            getEntity: factory.getWithId(etainablApi, 'entities'),
+            listEntities: factory.list(etainablApi, 'entities'),
+            updateEntity: factory.update(etainablApi, 'entities'),
+            createEntity: factory.create(etainablApi, 'entities'),
+            removeEntity: factory.remove(etainablApi, 'entities'),
+            getEntitiesSchema: factory.get(etainablApi, 'entities', 'schema'),
             // logs
             getLog: factory.getWithId(etainablApi, 'logs'),
             listLogs: factory.list(etainablApi, 'logs'),

package/dist/mjs/types/index.d.ts

@@ -4,13 +4,14 @@ import type { Automation } from './automation.js';
 import type { Company } from './company.js';
 import type { CreateScraperRunParams, ScraperRun } from './scraperRun.js';
 import type { DataIngest } from './dataIngest.js';
+import type { Entity } from './entity.js';
 import type { Email } from './email.js';
 import type { Invoice } from './invoice.js';
 import type { Log } from './log.js';
 import type { Reading } from './reading.js';
 import type { Report } from './report.js';
 import type { Supplier } from './supplier.js';
-export type { Account, Asset, Automation, Company, CreateScraperRunParams, DataIngest, Email, Invoice, Log, Reading, Report, ScraperRun, Supplier };
+export type { Account, Asset, Automation, Company, CreateScraperRunParams, DataIngest, Email, Entity, Invoice, Log, Reading, Report, ScraperRun, Supplier };
 export interface ETNPagedResponse<T = any> {
     data: T[];
     total: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etainabl/nodejs-sdk",
-  "version": "1.2.32",
+  "version": "1.2.33",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
   "types": "dist/mjs/index.d.ts",

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, Report, Supplier } from './types/index.js'
+import type { Account, Asset, Automation, Entity, Company, DataIngest, Invoice, Log, Reading, Report, Supplier } from './types/index.js'
 
 const log = logger('etainablApi');
 
@@ -306,6 +306,15 @@ export default (auth: AuthOptions, instanceOptions: CreateAxiosDefaults = {}) =>
       updateEmissionFactor: factory.update(etainablApi, 'emission-factors'),
       createEmissionFactor: factory.create(etainablApi, 'emission-factors'),
       removeEmissionFactor: factory.remove(etainablApi, 'emission-factors'),
+
+      // entity
+      getEntity: factory.getWithId<Entity>(etainablApi, 'entities'),
+      listEntities: factory.list<Entity>(etainablApi, 'entities'),
+      updateEntity: factory.update(etainablApi, 'entities'),
+      createEntity: factory.create(etainablApi, 'entities'),
+      removeEntity: factory.remove(etainablApi, 'entities'),
+      getEntitiesSchema: factory.get(etainablApi, 'entities', 'schema'),
+        
   
       // logs
       getLog: factory.getWithId<Log>(etainablApi, 'logs'),

package/src/types/entity.d.ts

@@ -0,0 +1,18 @@
+import { Types } from 'mongoose';
+import { Address} from './address.ts';
+
+type EntityType = 'fund' | 'company' | 'charity' | 'school/university' | 'council' | 'other';
+
+export interface Entity {
+  _id?: Types.ObjectId;
+  legalName: string;
+  type: EntityType;
+  companyNumber?: string;
+  companyLogo?: string;
+  billingAddress: Address;
+  parentEntityId?: Types.ObjectId;
+  ultimateParentEntityId?: Types.ObjectId;
+  companyId: Types.ObjectId;
+  batchId?: string;
+  userSub: string;
+}

package/src/types/index.ts

@@ -4,6 +4,7 @@ import type { Automation } from './automation.js'
 import type { Company } from './company.js'
 import type { CreateScraperRunParams, ScraperRun } from './scraperRun.js';
 import type { DataIngest } from './dataIngest.js'
+import type { Entity } from './entity.js'
 import type { Email } from './email.js';
 import type { Invoice } from './invoice.js';
 import type { Log } from './log.js';
@@ -19,6 +20,7 @@ export type {
   CreateScraperRunParams,
   DataIngest,
   Email,
+  Entity,
   Invoice,
   Log,
   Reading,