@etainabl/nodejs-sdk 1.3.181 → 1.3.186

package/dist/index.d.cts

@@ -487,13 +487,14 @@ interface CustomAlertTrigger<ID = string, DateType = Date | string, metadataType
         email: boolean;
         sms: boolean;
     };
-    severity: 'error' | 'warning' | 'info' | 'success' | 'tip';
+    severity: 'error' | 'warning' | 'info' | 'success';
     audience?: 'me' | 'allCompanyUsers' | 'userGroup';
     userGroupId?: ID;
     processedAt?: DateType;
     lastTriggeredEvent?: DateType;
     companyId: ID;
     userSub: string;
+    recipientUserSubs?: string[];
     active: boolean;
     createdAt?: DateType;
     updatedAt?: DateType;
@@ -795,10 +796,11 @@ interface AutomationRunSummary {
 interface AutomationRun<IDType = ObjectId | string, DateType = Date | string> {
     _id: IDType;
     automationId: IDType;
+    jobId?: IDType;
     companyId: IDType;
     active: boolean;
     category: 'account' | 'company';
-    status: 'running' | 'success' | 'failed' | 'warning';
+    status: 'running' | 'success' | 'error' | 'warning';
     collectionType?: CollectionType;
     source?: SourceMetadata;
     summary?: AutomationRunSummary;
@@ -1374,7 +1376,7 @@ interface Notification<ID = string, DateType = Date | string> {
     isAcknowledged?: boolean;
     acknowledgedAt?: DateType;
     customAlertTriggerId?: ID;
-    metadata?: Record<string, any>;
+    details?: Record<string, any>;
     route?: {
         name: string;
         params?: Record<string, any>;
@@ -1397,6 +1399,7 @@ interface Notification<ID = string, DateType = Date | string> {
             messageId?: string;
         };
     };
+    idempotencyKey?: string;
     createdAt?: DateType;
     updatedAt?: DateType;
     deleted?: boolean;
@@ -1405,24 +1408,16 @@ interface Notification<ID = string, DateType = Date | string> {
     companyId?: ID;
 }
 
-declare const NotificationTemplateCategories: readonly ["automation", "report", "team", "dataQuality", "discussion", "scraper"];
-type NotificationTemplateCategory = typeof NotificationTemplateCategories[number];
 declare const EventNamesByCategory: {
-    readonly automation: readonly ["automationFailed", "runCompleted", "hasnotRun", "fileNotExpected"];
+    readonly automation: readonly ["automationFailed", "automationCompleted", "automationOverdue", "automationExtractorOverdue"];
     readonly report: readonly ["reportSuccess", "reportFailed"];
     readonly team: readonly ["newUserSignIn"];
-    readonly dataQuality: readonly ["thresholdBreached", "approachingThreshold", "readingOverdue", "readingDueSoon", "contractRenewalUpcoming", "contractRenewalOverdue"];
-    readonly discussion: readonly ["commentAdded", "mentionInComment"];
-    readonly scraper: readonly ["scraperLoginError", "scraperHasnotRun", "scraperRunCompleted"];
+    readonly dataQuality: readonly ["invoiceOverdue", "contractOverdue", "contractDueSoon", "readingOverdue", "readingDueSoon"];
+    readonly discussion: readonly ["newDiscussionReply", "userAssignedToDiscussion", "discussionMessageDue"];
+    readonly scraper: readonly ["scraperLoginError", "scraperHasNotRun", "scraperRunCompleted"];
 };
-type AutomationEventName = typeof EventNamesByCategory.automation[number];
-type ReportEventName = typeof EventNamesByCategory.report[number];
-type TeamEventName = typeof EventNamesByCategory.team[number];
-type DataQualityEventName = typeof EventNamesByCategory.dataQuality[number];
-type DiscussionEventName = typeof EventNamesByCategory.discussion[number];
-type ScraperEventName = typeof EventNamesByCategory.scraper[number];
-type NotificationEventName = AutomationEventName | ReportEventName | TeamEventName | DataQualityEventName | DiscussionEventName | ScraperEventName;
-type NotificationTemplateSeverity = 'error' | 'warning' | 'info' | 'success' | 'tip';
+type NotificationEventName = (typeof EventNamesByCategory)[keyof typeof EventNamesByCategory][number] | 'alertTrigger';
+type NotificationTemplateSeverity = 'error' | 'warning' | 'info' | 'success';
 type NotificationTemplateDefaultChannel = 'off' | 'inApp' | 'email' | 'sms';
 type NotificationTemplateConfigType = 'text' | 'number' | 'password' | 'textarea' | 'radio' | 'select' | 'select2' | 'select-old' | 'select-multiple' | 'select-array' | 'select-array-list' | 'select-array-search' | 'multi-check-options' | 'tag-manager' | 'datePicker' | 'dateTimePicker' | 'dateRangePicker' | 'file' | 'slider';
 interface NotificationTemplateConfigOption {
@@ -1445,16 +1440,18 @@ interface NotificationTemplate<ID = string, DateType = Date | string> {
     _id: ID;
     name: string;
     description?: string;
-    category: NotificationTemplateCategory;
+    triggerDescription?: string;
+    category: NotificationCategory;
     eventName: NotificationEventName;
     severity: NotificationTemplateSeverity;
     isSystem?: boolean;
     default: NotificationTemplateDefaultChannel;
-    message?: string;
-    route?: NotificationTemplateRoute;
+    messageTemplate?: string;
+    routeTemplate?: NotificationTemplateRoute;
     icon?: string;
     config?: Map<string, NotificationTemplateConfig> | Record<string, NotificationTemplateConfig>;
     active: boolean;
+    enabledByDefault?: boolean;
     createdAt?: DateType;
     updatedAt?: DateType;
 }
@@ -1472,53 +1469,86 @@ type NotificationContextMap = {
             _id: string;
         };
     };
-    automationFailed: {
-        context: {
-            message: string;
-            metadata: {
-                items: {
-                    message: string;
-                    route: {
-                        name: string;
-                        query: {
-                            id: string;
-                        };
+    alertTrigger: {
+        summary: string;
+        metadata: {
+            items: {
+                message: string;
+                route: {
+                    name: string;
+                    query?: {
+                        [key: string]: any;
                     };
-                }[];
-            };
+                    params?: {
+                        [key: string]: any;
+                    };
+                };
+            }[];
         };
     };
-    readingOverdue: {
-        context: {
-            message: string;
-            metadata: {
-                items: {
-                    message: string;
-                    route: {
-                        name: string;
-                        params: {
-                            id: string;
-                        };
-                    };
-                }[];
-            };
+    newDiscussionReply: {
+        message: {
+            _id: string;
+            title: string;
+            parentType: string;
+            parentId: string;
+        };
+        reply: {
+            content: string;
+            userSub: string;
+        };
+        actionUserSub: string;
+    };
+    userAssignedToDiscussion: {
+        message: {
+            _id: string;
+            title: string;
+            parentType: string;
+            parentId: string;
         };
+        assignedBy: string;
+    };
+    discussionMessageDue: {
+        message: {
+            _id: string;
+            title: string;
+            parentType: string;
+            parentId: string;
+            dueDate: string;
+        };
+        scheduledBy: string;
+    };
+    newUserSignIn: {
+        user: {
+            _id: string;
+            name: string;
+            email: string;
+            userSub: string;
+        };
+        company: {
+            _id: string;
+            name: string;
+        };
+        loginTime: string;
     };
 };
-type NotificationEventType = keyof NotificationContextMap;
-interface NotificationSQSMessage<E extends NotificationEventType = NotificationEventType> {
+type NotificationContext = NotificationContextMap[keyof NotificationContextMap];
+type NotificationContextEventName = keyof NotificationContextMap;
+interface NotificationSQSMessage<E extends NotificationContextEventName = NotificationContextEventName> {
     eventName: E;
     timestamp: string;
     companyId: string;
     userSub: string;
     alertTriggerId?: string;
+    notificationTemplateId?: string;
     context: NotificationContextMap[E];
 }
-interface SendNotificationMessageInput<E extends NotificationEventType> {
+interface SendNotificationMessageInput {
     companyId: string;
     userSub: string;
     alertTriggerId?: string;
     timestamp?: string;
+    notificationTemplateId?: string;
 }
 
 interface Log<IDType = ObjectId | string> {
@@ -1703,14 +1733,13 @@ type NotificationChannels = {
     sms: boolean;
 };
 type NotificationTemplatesMap = Record<string, boolean>;
-type NotificationCategoryKey = (typeof NotificationCategoryList)[number];
 type NotificationCategoryPreferences<IDType = ObjectId | string> = {
     channels: NotificationChannels;
     templates: NotificationTemplatesMap;
 };
 type NotificationPreferences<IDType = ObjectId | string> = {
     channels: NotificationChannels;
-    categories: Record<NotificationCategoryKey, NotificationCategoryPreferences<IDType>>;
+    categories: Record<NotificationCategory, NotificationCategoryPreferences<IDType>>;
 };
 interface User<IDType = ObjectId | string> {
     _id: IDType;
@@ -1783,24 +1812,6 @@ declare const _default$5: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     removeAccount: (id: string, options?: AxiosRequestConfig) => Promise<Account<string>>;
     getAccountSchema: (options?: AxiosRequestConfig) => Promise<any>;
     invalidateAccountCache: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    getAlertTrigger: (id: string, options?: AxiosRequestConfig) => Promise<CustomAlertTrigger<string, string, {
-        [key: string]: any;
-    }>>;
-    listAlertTriggers: <P = CustomAlertTrigger<string, string, {
-        [key: string]: any;
-    }>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
-    updateAlertTrigger: (id: string, data: any, options?: AxiosRequestConfig) => Promise<CustomAlertTrigger<string, string | Date, {
-        [key: string]: any;
-    }>>;
-    createAlertTrigger: (data: any, options?: AxiosRequestConfig) => Promise<CustomAlertTrigger<string, string | Date, {
-        [key: string]: any;
-    }>>;
-    removeAlertTrigger: (id: string, options?: AxiosRequestConfig) => Promise<CustomAlertTrigger<string, string | Date, {
-        [key: string]: any;
-    }>>;
-    bulkUpdateAlertTriggers: (data: BulkUpdateCustomAlertTriggersRequest, options?: AxiosRequestConfig) => Promise<ETNBulkUpdateResult>;
-    retryAlertTrigger: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    cancelAlertTrigger: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
     getCustomAlertTrigger: (id: string, options?: AxiosRequestConfig) => Promise<CustomAlertTrigger<string, string, {
         [key: string]: any;
     }>>;
@@ -1982,6 +1993,9 @@ interface NotificationEmailOptions {
         url?: string;
     }>;
     metadata?: Record<string, any>;
+    items?: Array<{
+        message: string;
+    }>;
 }
 declare function generateNotificationEmail(options: NotificationEmailOptions): string;
 declare const _default$3: {
@@ -2014,26 +2028,25 @@ interface SendNotificationMessageOptions {
     queueUrl?: string;
     sqsClient?: SQSClient;
 }
-type NotificationType = keyof NotificationContextMap;
-declare function createNotificationMessage<T extends NotificationType>(eventName: T, context: NotificationContextMap[T], input: SendNotificationMessageInput<T>): NotificationSQSMessage<T>;
-type SendNotificationParams<T extends NotificationType> = {
+type SendNotificationParams<T extends NotificationContextEventName> = {
     eventName: T;
     context: NotificationContextMap[T];
-    input: SendNotificationMessageInput<T>;
+    input: SendNotificationMessageInput;
     options?: SendNotificationMessageOptions;
 };
-declare function sendNotificationMessage<T extends NotificationType>({ eventName, context, input, options }: SendNotificationParams<T>): Promise<{
-    messageId: string;
-}>;
-type SendNotificationBatchParams<T extends NotificationType> = {
+type SendNotificationBatchParams<T extends NotificationContextEventName> = {
     messages: Array<{
         eventName: T;
         context: NotificationContextMap[T];
-        input: SendNotificationMessageInput<T>;
+        input: SendNotificationMessageInput;
     }>;
     options?: SendNotificationMessageOptions;
 };
-declare function sendNotificationMessageBatch<T extends NotificationType>({ messages, options }: SendNotificationBatchParams<T>): Promise<{
+declare function createNotificationMessage<T extends NotificationContextEventName>(eventName: T, context: NotificationContextMap[T], input: SendNotificationMessageInput): NotificationSQSMessage<T>;
+declare function sendNotificationMessage<T extends NotificationContextEventName>({ eventName, context, input, options }: SendNotificationParams<T>): Promise<{
+    messageId: string;
+}>;
+declare function sendNotificationMessageBatch<T extends NotificationContextEventName>({ messages, options }: SendNotificationBatchParams<T>): Promise<{
     messageIds: string[];
 }>;
 
@@ -2086,6 +2099,14 @@ declare const automationServices: {
     category: AutomationServiceCategory;
 }[];
 
+declare function updateBatchJobStatus({ etnApi, automationRun, accountKey, status, errorMessage }: {
+    etnApi: ReturnType<typeof _default$5>;
+    automationRun: AutomationRun<string>;
+    accountKey?: string;
+    status: 'completed' | 'failed';
+    errorMessage?: string;
+}): Promise<void>;
+
 interface StepFunctionEvent {
     params: any;
     input: {
@@ -2124,16 +2145,75 @@ declare class IngestHandler {
  */
 declare function isTransientError(error: any): boolean;
 
+type PaginatedResponse<T> = {
+    data: T[];
+};
+type FetchPage<T> = (params: {
+    $limit: number;
+    $skip: number;
+}) => Promise<PaginatedResponse<T>>;
+type PaginatedFetchOptions = {
+    pageSize?: number;
+};
+declare const paginatedFetch: <T>(fetchPage: FetchPage<T>, options?: PaginatedFetchOptions) => Promise<T[]>;
+
+type SqsMessageAttribute = {
+    DataType: 'String' | 'Number' | 'Binary';
+    StringValue?: string;
+    BinaryValue?: Uint8Array;
+};
+type SqsBatchMessage<T> = {
+    body: T;
+    id?: string;
+    attributes?: Record<string, SqsMessageAttribute>;
+};
+type SendToSqsBatchedOptions = {
+    queueUrl: string;
+    sqsClient?: SQSClient;
+    concurrency?: number;
+    batchSize?: number;
+};
+type SendToSqsBatchedResult = {
+    successful: number;
+    failed: number;
+};
+declare const sendToSqsBatched: <T>(messages: SqsBatchMessage<T>[], options: SendToSqsBatchedOptions) => Promise<SendToSqsBatchedResult>;
+
+interface ResolvedNotificationPreferences {
+    channels: NotificationChannels;
+    categories: Record<string, {
+        channels: NotificationChannels;
+        templates: Array<{
+            _id: string;
+            name: string;
+            enabled: boolean;
+        }>;
+    }>;
+}
+declare function resolveNotificationPreferences(userPreferences: NotificationPreferences, systemTemplates: (NotificationTemplate<ObjectId, Date> | NotificationTemplate<string, string>)[]): ResolvedNotificationPreferences;
+
+type index$1_FetchPage<T> = FetchPage<T>;
 type index$1_IngestHandler = IngestHandler;
 declare const index$1_IngestHandler: typeof IngestHandler;
+type index$1_PaginatedFetchOptions = PaginatedFetchOptions;
+type index$1_PaginatedResponse<T> = PaginatedResponse<T>;
+type index$1_ResolvedNotificationPreferences = ResolvedNotificationPreferences;
+type index$1_SendToSqsBatchedOptions = SendToSqsBatchedOptions;
+type index$1_SendToSqsBatchedResult = SendToSqsBatchedResult;
+type index$1_SqsBatchMessage<T> = SqsBatchMessage<T>;
+type index$1_SqsMessageAttribute = SqsMessageAttribute;
 declare const index$1_automationServices: typeof automationServices;
 declare const index$1_automationSources: typeof automationSources;
 declare const index$1_getMeterPointNumberBottomLine: typeof getMeterPointNumberBottomLine;
 declare const index$1_isTransientError: typeof isTransientError;
+declare const index$1_paginatedFetch: typeof paginatedFetch;
+declare const index$1_resolveNotificationPreferences: typeof resolveNotificationPreferences;
+declare const index$1_sendToSqsBatched: typeof sendToSqsBatched;
+declare const index$1_updateBatchJobStatus: typeof updateBatchJobStatus;
 declare const index$1_utilityTypes: typeof utilityTypes;
 declare const index$1_wasteCategories: typeof wasteCategories;
 declare namespace index$1 {
-  export { index$1_IngestHandler as IngestHandler, index$1_automationServices as automationServices, index$1_automationSources as automationSources, index$1_getMeterPointNumberBottomLine as getMeterPointNumberBottomLine, index$1_isTransientError as isTransientError, units$1 as units, index$1_utilityTypes as utilityTypes, index$1_wasteCategories as wasteCategories };
+  export { type index$1_FetchPage as FetchPage, index$1_IngestHandler as IngestHandler, type index$1_PaginatedFetchOptions as PaginatedFetchOptions, type index$1_PaginatedResponse as PaginatedResponse, type index$1_ResolvedNotificationPreferences as ResolvedNotificationPreferences, type index$1_SendToSqsBatchedOptions as SendToSqsBatchedOptions, type index$1_SendToSqsBatchedResult as SendToSqsBatchedResult, type index$1_SqsBatchMessage as SqsBatchMessage, type index$1_SqsMessageAttribute as SqsMessageAttribute, index$1_automationServices as automationServices, index$1_automationSources as automationSources, index$1_getMeterPointNumberBottomLine as getMeterPointNumberBottomLine, index$1_isTransientError as isTransientError, index$1_paginatedFetch as paginatedFetch, index$1_resolveNotificationPreferences as resolveNotificationPreferences, index$1_sendToSqsBatched as sendToSqsBatched, units$1 as units, index$1_updateBatchJobStatus as updateBatchJobStatus, index$1_utilityTypes as utilityTypes, index$1_wasteCategories as wasteCategories };
 }
 
 interface ETNModel {
@@ -2260,4 +2340,4 @@ declare namespace scrapers {
   export type { scrapers_ETNAccount as ETNAccount };
 }
 
-export { type AccessLevel, type Account, type AccountResult, type Action, type ActionType, type Asset, type Automation, type AutomationEventName, type AutomationRun, type AutomationRunLog, type AutomationRunSummary, type AutomationService, type AutomationServiceCategory, type AutomationSource, type Company, type CompanyInvoiceValidationRule, type CompanyInvoiceValidationSettings, type Consumption, type CreateScraperRunParams, type CustomAlertTrigger, type CustomAlertTriggerQueueMessage, type DataIngest, type DataQualityEventName, type DefaultField, type DeliveryStatus, type DiscussionEventName, type ETNEvent, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, EventNamesByCategory, 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 Job, type JobStatus, type Log, type Notification, type NotificationAction, type NotificationCategory, type NotificationCategoryKey, NotificationCategoryList, type NotificationCategoryPreferences, type NotificationChannels, type NotificationContextMap, NotificationDefaultChannels, type NotificationEventName, type NotificationEventType, type NotificationPreferences, type NotificationSQSMessage, type NotificationTemplate, NotificationTemplateCategories, type NotificationTemplateCategory, type NotificationTemplateConfig, type NotificationTemplateConfigOption, type NotificationTemplateConfigType, type NotificationTemplateDefaultChannel, type NotificationTemplateRoute, type NotificationTemplateSeverity, type NotificationTemplatesMap, type Portal, type PortalSupplierSchema, type Problem, type ProblemCodes, type ProblemDetails, type Reading, type Report, type ReportEventName, type ReportMetadata, type ReportSource, type ReportSourceIdItem, type ReportTemplate, type ReportType, type ScraperEventName, type ScraperRun, type SendNotificationMessageInput, type Setting, type SourceType, type Supplier, type TeamEventName, type User, type UtilityType, type WasteCategories, type WasteTypes, _default$5 as api, consumption, _default$1 as db, _default$4 as emailTemplate, integrations, _default$2 as logger, monitoring, notification, _default$3 as notificationEmailTemplate, notificationQueue, index as openai, reporting, scrapers, _default as slack, units, index$1 as utils };
+export { type AccessLevel, type Account, type AccountResult, type Action, type ActionType, 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 CustomAlertTrigger, type CustomAlertTriggerQueueMessage, type DataIngest, type DefaultField, type DeliveryStatus, type ETNEvent, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, EventNamesByCategory, 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 Job, type JobStatus, type Log, type Notification, type NotificationAction, type NotificationCategory, NotificationCategoryList, type NotificationCategoryPreferences, type NotificationChannels, type NotificationContext, type NotificationContextEventName, type NotificationContextMap, NotificationDefaultChannels, type NotificationEventName, type NotificationPreferences, type NotificationSQSMessage, type NotificationTemplate, type NotificationTemplateConfig, type NotificationTemplateConfigOption, type NotificationTemplateConfigType, type NotificationTemplateDefaultChannel, type NotificationTemplateRoute, type NotificationTemplateSeverity, type NotificationTemplatesMap, 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 SendNotificationMessageInput, type Setting, type SourceType, type Supplier, type User, type UtilityType, type WasteCategories, type WasteTypes, _default$5 as api, consumption, _default$1 as db, _default$4 as emailTemplate, integrations, _default$2 as logger, monitoring, notification, _default$3 as notificationEmailTemplate, notificationQueue, index as openai, reporting, scrapers, _default as slack, units, index$1 as utils };