@etainabl/nodejs-sdk 1.3.175 → 1.3.178

package/dist/index.d.cts

@@ -474,59 +474,27 @@ interface Action {
     icon?: string;
 }
 
-interface CustomAlertTemplateAction extends Action {
-    api?: {
-        endpoint: string;
-        method: string;
-        payload?: Record<string, any>;
-    };
-}
-interface CustomAlertTemplateConfigOption {
-    label: string;
-    value: string;
-}
-interface CustomAlertTemplateConfig {
-    type: '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';
-    label: string;
-    options?: CustomAlertTemplateConfigOption[];
-    default?: string | null;
-    required?: boolean;
-    placeholder?: string;
-}
-interface CustomAlertTemplate<ID = string, DateType = Date | string> {
-    _id: ID;
-    name: string;
-    description?: string;
-    key: string;
-    titleTemplate: string;
-    messageTemplate: string;
-    configSchema?: Record<string, CustomAlertTemplateConfig>;
-    active: boolean;
-    isSystemTemplate: boolean;
-    createdAt?: DateType;
-    updatedAt?: DateType;
-    deleted?: boolean;
-    deletedAt?: DateType;
-    deletedBy?: string;
-    companyId?: ID;
-}
-
 interface CustomAlertTrigger<ID = string, DateType = Date | string, metadataType = {
     [key: string]: any;
 }> {
     _id: ID;
-    templateId?: ID;
+    notificationTemplateId: ID;
     state: 'pending' | 'processing' | 'processed' | 'failed' | 'cancelled';
     metadata?: metadataType;
+    description: string;
     channels: {
         inApp: boolean;
         email: boolean;
         sms: boolean;
     };
+    severity: 'error' | 'warning' | 'info' | 'success' | 'tip';
+    audience?: 'me' | 'allCompanyUsers' | 'userGroup';
+    userGroupId?: ID;
     processedAt?: DateType;
     lastTriggeredEvent?: DateType;
     companyId: ID;
     userSub: string;
+    active: boolean;
     createdAt?: DateType;
     updatedAt?: DateType;
     deleted?: boolean;
@@ -534,6 +502,14 @@ interface CustomAlertTrigger<ID = string, DateType = Date | string, metadataType
     deletedBy?: string;
 }
 
+interface CustomAlertTriggerQueueMessage {
+    triggerId: string;
+    jobId: string;
+    windowStart?: string;
+    windowEnd?: string;
+    notificationTemplateId?: string;
+}
+
 interface Address {
     streetAddress: string;
     locality?: string;
@@ -1324,6 +1300,29 @@ interface ETNEvent {
     companyId: string;
 }
 
+type JobStatus = 'queued' | 'running' | 'completed' | 'failed' | 'cancelled';
+interface Job<ID = string, DateType = Date | string> {
+    _id: ID;
+    type: string;
+    key: string;
+    status: JobStatus;
+    windowStart?: DateType;
+    windowEnd?: DateType;
+    startedAt?: DateType;
+    completedAt?: DateType;
+    heartbeatAt?: DateType;
+    expiresAt?: DateType;
+    error?: string;
+    metadata?: Record<string, any>;
+    companyId?: ID;
+    userSub?: string;
+    createdAt?: DateType;
+    updatedAt?: DateType;
+    deleted?: boolean;
+    deletedAt?: DateType;
+    deletedBy?: string;
+}
+
 /**
  * Context type mapping for different notification events
  * Each event type has its own structured context data
@@ -1370,6 +1369,7 @@ interface Notification<ID = string, DateType = Date | string> {
     userSub: string;
     toastHasShown?: boolean;
     message?: string;
+    status: string;
     isAcknowledged?: boolean;
     acknowledgedAt?: DateType;
     customAlertTriggerId?: ID;
@@ -1401,52 +1401,107 @@ interface Notification<ID = string, DateType = Date | string> {
     deleted?: boolean;
     deletedAt?: DateType;
     deletedBy?: string;
-    companyId: ID;
+    companyId?: ID;
 }
 
-type NotificationTemplateCategory = 'automation' | 'report' | 'team' | 'dataQuality' | 'discussion' | 'scraper';
+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 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"];
+};
+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 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 {
+    label: string;
+    value: string;
+}
+interface NotificationTemplateConfig {
+    type: NotificationTemplateConfigType;
+    label: string;
+    options?: NotificationTemplateConfigOption[];
+    default?: string | null;
+    required?: boolean;
+    placeholder?: string;
+}
+interface NotificationTemplateRoute {
+    name?: string;
+    params?: Record<string, any>;
+}
 interface NotificationTemplate<ID = string, DateType = Date | string> {
     _id: ID;
     name: string;
     description?: string;
     category: NotificationTemplateCategory;
-    eventName: string;
+    eventName: NotificationEventName;
     severity: NotificationTemplateSeverity;
     isSystem?: boolean;
     default: NotificationTemplateDefaultChannel;
-    message: string;
-    route: {
-        name: {
-            type: String;
-            default: '';
-        };
-        params?: {
-            type: Object;
-            default: () => {};
-        };
-        query?: {
-            type: Object;
-            default: () => {};
-        };
-    };
-    icon: string;
+    message?: string;
+    route?: NotificationTemplateRoute;
+    icon?: string;
+    config?: Map<string, NotificationTemplateConfig> | Record<string, NotificationTemplateConfig>;
     createdAt?: DateType;
     updatedAt?: DateType;
-    deleted?: boolean;
-    deletedAt?: DateType;
-    deletedBy?: string;
 }
 
 type NotificationContextMap = {
-    generalReportGenerated: {
+    reportSuccess: {
+        report: {
+            fileName: string;
+            _id: string;
+        };
+    };
+    reportFailed: {
         report: {
             fileName: string;
-            type: string;
             _id: string;
         };
     };
+    automationFailed: {
+        context: {
+            message: string;
+            metadata: {
+                items: {
+                    message: string;
+                    route: {
+                        name: string;
+                        query: {
+                            id: string;
+                        };
+                    };
+                }[];
+            };
+        };
+    };
+    readingOverdue: {
+        context: {
+            message: string;
+            metadata: {
+                items: {
+                    message: string;
+                    route: {
+                        name: string;
+                        params: {
+                            id: string;
+                        };
+                    };
+                }[];
+            };
+        };
+    };
 };
 type NotificationEventType = keyof NotificationContextMap;
 interface NotificationSQSMessage<E extends NotificationEventType = NotificationEventType> {
@@ -1461,6 +1516,7 @@ interface SendNotificationMessageInput<E extends NotificationEventType> {
     companyId: string;
     userSub: string;
     alertTriggerId?: string;
+    timestamp?: string;
 }
 
 interface Log<IDType = ObjectId | string> {
@@ -1725,11 +1781,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>;
-    getAlertTemplate: (id: string, options?: AxiosRequestConfig) => Promise<CustomAlertTemplate<string, string | Date>>;
-    listAlertTemplates: <P = CustomAlertTemplate<string, string | Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
-    updateAlertTemplate: (id: string, data: any, options?: AxiosRequestConfig) => Promise<CustomAlertTemplate<string, string | Date>>;
-    createAlertTemplate: (data: any, options?: AxiosRequestConfig) => Promise<CustomAlertTemplate<string, string | Date>>;
-    removeAlertTemplate: (id: string, options?: AxiosRequestConfig) => Promise<CustomAlertTemplate<string, string | Date>>;
     getAlertTrigger: (id: string, options?: AxiosRequestConfig) => Promise<CustomAlertTrigger<string, string, {
         [key: string]: any;
     }>>;
@@ -1748,6 +1799,16 @@ declare const _default$5: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     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;
+    }>>;
+    listCustomAlertTriggers: <P = CustomAlertTrigger<string, string, {
+        [key: string]: any;
+    }>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
+    updateCustomAlertTrigger: (id: string, data: any, options?: AxiosRequestConfig) => Promise<CustomAlertTrigger<string, string | Date, {
+        [key: string]: any;
+    }>>;
+    bulkUpdateCustomAlertTriggers: (data: BulkUpdateCustomAlertTriggersRequest, options?: AxiosRequestConfig) => Promise<ETNBulkUpdateResult>;
     getAsset: (id: string, options?: AxiosRequestConfig) => Promise<Asset<string>>;
     listAssets: <P = Asset<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateAsset: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Asset<string>>;
@@ -1803,6 +1864,12 @@ declare const _default$5: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     createLog: (data: any, options?: AxiosRequestConfig) => Promise<Log<string>>;
     createLogBulk: (data: any, options?: AxiosRequestConfig) => Promise<Log<string>[]>;
     removeLog: (id: string, options?: AxiosRequestConfig) => Promise<Log<string>>;
+    getJob: (id: string, options?: AxiosRequestConfig) => Promise<Job<string, string | Date>>;
+    listJobs: <P = Job<string, string | Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
+    updateJob: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Job<string, string | Date>>;
+    createJob: (data: any, options?: AxiosRequestConfig) => Promise<Job<string, string | Date>>;
+    createJobBulk: (data: any, options?: AxiosRequestConfig) => Promise<Job<string, string | Date>[]>;
+    removeJob: (id: string, options?: AxiosRequestConfig) => Promise<Job<string, string | Date>>;
     getNotification: (id: string, options?: AxiosRequestConfig) => Promise<Notification<string, string | Date>>;
     listNotifications: <P = Notification<string, string | Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateNotification: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Notification<string, string | Date>>;
@@ -1810,6 +1877,11 @@ declare const _default$5: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     bulkCreateNotifications: (data: any, options?: AxiosRequestConfig) => Promise<Notification<string, string | Date>[]>;
     bulkUpdateNotificationDeliveryStatus: (data: any, options?: AxiosRequestConfig) => Promise<ETNBulkUpdateResult>;
     removeNotification: (id: string, options?: AxiosRequestConfig) => Promise<Notification<string, string | Date>>;
+    getNotificationTemplate: (id: string, options?: AxiosRequestConfig) => Promise<NotificationTemplate<string, string | Date>>;
+    listNotificationTemplates: <P = NotificationTemplate<string, string | Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
+    updateNotificationTemplate: (id: string, data: any, options?: AxiosRequestConfig) => Promise<NotificationTemplate<string, string | Date>>;
+    createNotificationTemplate: (data: any, options?: AxiosRequestConfig) => Promise<NotificationTemplate<string, string | Date>>;
+    removeNotificationTemplate: (id: string, options?: AxiosRequestConfig) => Promise<NotificationTemplate<string, string | Date>>;
     getReading: (id: string, options?: AxiosRequestConfig) => Promise<Reading<string, Date>>;
     listReadings: <P = Reading<string, Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateReading: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Reading<string, Date>>;
@@ -1942,6 +2014,7 @@ interface SendNotificationMessageOptions {
     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> = {
     eventName: T;
     context: NotificationContextMap[T];
@@ -1952,9 +2025,10 @@ declare function sendNotificationMessage<T extends NotificationType>({ eventName
     messageId: string;
 }>;
 
+declare const notificationQueue_createNotificationMessage: typeof createNotificationMessage;
 declare const notificationQueue_sendNotificationMessage: typeof sendNotificationMessage;
 declare namespace notificationQueue {
-  export { notificationQueue_sendNotificationMessage as sendNotificationMessage };
+  export { notificationQueue_createNotificationMessage as createNotificationMessage, notificationQueue_sendNotificationMessage as sendNotificationMessage };
 }
 
 interface ConsumptionData {
@@ -2173,4 +2247,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 AutomationRun, type AutomationRunLog, type AutomationRunSummary, type AutomationService, type AutomationServiceCategory, type AutomationSource, type Company, type CompanyInvoiceValidationRule, type CompanyInvoiceValidationSettings, type Consumption, type CreateScraperRunParams, type CustomAlertTemplate, type CustomAlertTemplateAction, type CustomAlertTemplateConfig, type CustomAlertTemplateConfigOption, type CustomAlertTrigger, type DataIngest, type DefaultField, type DeliveryStatus, type ETNEvent, type ETNPagedResponse$1 as ETNPagedResponse, type Email, type Entity, 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 Log, type Notification, type NotificationAction, type NotificationCategory, type NotificationCategoryKey, NotificationCategoryList, type NotificationCategoryPreferences, type NotificationChannels, type NotificationContextMap, NotificationDefaultChannels, type NotificationEventType, type NotificationPreferences, type NotificationSQSMessage, type NotificationTemplate, type NotificationTemplateCategory, type NotificationTemplateDefaultChannel, 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 };
+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 };