import {z} from 'zod' export type NotificationRuleId = {id: string, entityType: 'NOTIFICATION_RULE'}; export type TenantId = {id: string, entityType: 'TENANT'}; export type NotificationTemplateId = {id: string, entityType: 'NOTIFICATION_TEMPLATE'}; export type AlarmAssignmentNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, alarmTypes?: Array | undefined, alarmSeverities?: (Array<'CRITICAL' | 'MAJOR' | 'MINOR' | 'WARNING' | 'INDETERMINATE'>) | undefined, alarmStatuses?: (Array<'ANY' | 'ACTIVE' | 'CLEARED' | 'ACK' | 'UNACK'>) | undefined, notifyOn: Array<'ASSIGNED' | 'UNASSIGNED'>}; export type AlarmCommentNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, alarmTypes?: Array | undefined, alarmSeverities?: (Array<'CRITICAL' | 'MAJOR' | 'MINOR' | 'WARNING' | 'INDETERMINATE'>) | undefined, alarmStatuses?: (Array<'ANY' | 'ACTIVE' | 'CLEARED' | 'ACK' | 'UNACK'>) | undefined, onlyUserComments?: boolean | undefined, notifyOnCommentUpdate?: boolean | undefined}; export type ClearRule = {alarmStatuses?: (Array<'ANY' | 'ACTIVE' | 'CLEARED' | 'ACK' | 'UNACK'>) | undefined}; export type AlarmNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, alarmTypes?: Array | undefined, alarmSeverities?: (Array<'CRITICAL' | 'MAJOR' | 'MINOR' | 'WARNING' | 'INDETERMINATE'>) | undefined, notifyOn: Array<'CREATED' | 'SEVERITY_CHANGED' | 'ACKNOWLEDGED' | 'CLEARED'>, clearRule?: ClearRule | undefined}; export type ApiUsageLimitNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, apiFeatures?: (Array<'TRANSPORT' | 'DB' | 'RE' | 'JS' | 'TBEL' | 'EMAIL' | 'SMS' | 'ALARM'>) | undefined, notifyOn?: (Array<'ENABLED' | 'WARNING' | 'DISABLED'>) | undefined}; export type DeviceActivityNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, devices?: Array | undefined, deviceProfiles?: Array | undefined, notifyOn: Array<'ACTIVE' | 'INACTIVE'>}; export type EdgeCommunicationFailureNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, edges?: Array | undefined}; export type EdgeConnectionNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, edges?: Array | undefined, notifyOn?: (Array<'CONNECTED' | 'DISCONNECTED'>) | undefined}; export type EntitiesLimitNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, entityTypes?: (Array<'TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY'>) | undefined, threshold?: number | undefined}; export type EntityActionNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, entityTypes?: (Array<'TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY'>) | undefined, created?: boolean | undefined, updated?: boolean | undefined, deleted?: boolean | undefined}; export type NewPlatformVersionNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined}; export type RateLimitsNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, apis?: (Array<'ENTITY_EXPORT' | 'ENTITY_IMPORT' | 'NOTIFICATION_REQUESTS' | 'NOTIFICATION_REQUESTS_PER_RULE' | 'REST_REQUESTS_PER_TENANT' | 'REST_REQUESTS_PER_CUSTOMER' | 'WS_UPDATES_PER_SESSION' | 'CASSANDRA_WRITE_QUERIES_CORE' | 'CASSANDRA_READ_QUERIES_CORE' | 'CASSANDRA_WRITE_QUERIES_RULE_ENGINE' | 'CASSANDRA_READ_QUERIES_RULE_ENGINE' | 'CASSANDRA_READ_QUERIES_MONOLITH' | 'CASSANDRA_WRITE_QUERIES_MONOLITH' | 'CASSANDRA_QUERIES' | 'EDGE_EVENTS' | 'EDGE_EVENTS_PER_EDGE' | 'EDGE_UPLINK_MESSAGES' | 'EDGE_UPLINK_MESSAGES_PER_EDGE' | 'PASSWORD_RESET' | 'TWO_FA_VERIFICATION_CODE_SEND' | 'TWO_FA_VERIFICATION_CODE_CHECK' | 'TRANSPORT_MESSAGES_PER_TENANT' | 'TRANSPORT_MESSAGES_PER_DEVICE' | 'TRANSPORT_MESSAGES_PER_GATEWAY' | 'TRANSPORT_MESSAGES_PER_GATEWAY_DEVICE' | 'EMAILS' | 'WS_SUBSCRIPTIONS' | 'CALCULATED_FIELD_DEBUG_EVENTS'>) | undefined}; export type ResourcesShortageNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, cpuThreshold?: number | undefined, ramThreshold?: number | undefined, storageThreshold?: number | undefined}; export type RuleEngineComponentLifecycleEventNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined, ruleChains?: Array | undefined, ruleChainEvents?: (Array<'CREATED' | 'STARTED' | 'ACTIVATED' | 'SUSPENDED' | 'UPDATED' | 'STOPPED' | 'DELETED' | 'FAILED' | 'DEACTIVATED' | 'RELATION_UPDATED' | 'RELATION_DELETED'>) | undefined, onlyRuleChainLifecycleFailures?: boolean | undefined, trackRuleNodeEvents?: boolean | undefined, ruleNodeEvents?: (Array<'CREATED' | 'STARTED' | 'ACTIVATED' | 'SUSPENDED' | 'UPDATED' | 'STOPPED' | 'DELETED' | 'FAILED' | 'DEACTIVATED' | 'RELATION_UPDATED' | 'RELATION_DELETED'>) | undefined, onlyRuleNodeLifecycleFailures?: boolean | undefined}; export type TaskProcessingFailureNotificationRuleTriggerConfig = {triggerType?: ('ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE') | undefined}; export type EscalatedNotificationRuleRecipientsConfig = {triggerType: 'ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE', escalationTable: {[key: string]: Array}}; export type NotificationRuleConfig = {description?: string | undefined}; export type NotificationRule = {id?: NotificationRuleId | undefined, createdTime?: number | undefined, tenantId?: TenantId | undefined, name: string, enabled?: boolean | undefined, templateId: NotificationTemplateId, triggerType: 'ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE', triggerConfig: AlarmAssignmentNotificationRuleTriggerConfig | AlarmCommentNotificationRuleTriggerConfig | AlarmNotificationRuleTriggerConfig | ApiUsageLimitNotificationRuleTriggerConfig | DeviceActivityNotificationRuleTriggerConfig | EdgeCommunicationFailureNotificationRuleTriggerConfig | EdgeConnectionNotificationRuleTriggerConfig | EntitiesLimitNotificationRuleTriggerConfig | EntityActionNotificationRuleTriggerConfig | NewPlatformVersionNotificationRuleTriggerConfig | RateLimitsNotificationRuleTriggerConfig | ResourcesShortageNotificationRuleTriggerConfig | RuleEngineComponentLifecycleEventNotificationRuleTriggerConfig | TaskProcessingFailureNotificationRuleTriggerConfig, recipientsConfig: EscalatedNotificationRuleRecipientsConfig, additionalConfig?: NotificationRuleConfig | undefined}; export type CreateApiApiNotificationRuleArgs = {body: NotificationRule}; export type CreateApiApiNotificationRuleOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const notificationRuleId = z.object({id: z.string(), entityType: z.literal("NOTIFICATION_RULE")}); export const tenantId = z.object({id: z.string(), entityType: z.literal("TENANT")}); export const notificationTemplateId = z.object({id: z.string(), entityType: z.literal("NOTIFICATION_TEMPLATE")}); export const alarmAssignmentNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), alarmTypes: z.array(z.string()).optional(), alarmSeverities: z.array(z.enum(["CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE"])).optional(), alarmStatuses: z.array(z.enum(["ANY", "ACTIVE", "CLEARED", "ACK", "UNACK"])).optional(), notifyOn: z.array(z.enum(["ASSIGNED", "UNASSIGNED"]))}); export const alarmCommentNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), alarmTypes: z.array(z.string()).optional(), alarmSeverities: z.array(z.enum(["CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE"])).optional(), alarmStatuses: z.array(z.enum(["ANY", "ACTIVE", "CLEARED", "ACK", "UNACK"])).optional(), onlyUserComments: z.boolean().optional(), notifyOnCommentUpdate: z.boolean().optional()}); export const clearRule = z.object({alarmStatuses: z.array(z.enum(["ANY", "ACTIVE", "CLEARED", "ACK", "UNACK"])).optional()}); export const alarmNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), alarmTypes: z.array(z.string()).optional(), alarmSeverities: z.array(z.enum(["CRITICAL", "MAJOR", "MINOR", "WARNING", "INDETERMINATE"])).optional(), notifyOn: z.array(z.enum(["CREATED", "SEVERITY_CHANGED", "ACKNOWLEDGED", "CLEARED"])), clearRule: clearRule.optional()}); export const apiUsageLimitNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), apiFeatures: z.array(z.enum(["TRANSPORT", "DB", "RE", "JS", "TBEL", "EMAIL", "SMS", "ALARM"])).optional(), notifyOn: z.array(z.enum(["ENABLED", "WARNING", "DISABLED"])).optional()}); export const deviceActivityNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), devices: z.array(z.string()).optional(), deviceProfiles: z.array(z.string()).optional(), notifyOn: z.array(z.enum(["ACTIVE", "INACTIVE"]))}); export const edgeCommunicationFailureNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), edges: z.array(z.string()).optional()}); export const edgeConnectionNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), edges: z.array(z.string()).optional(), notifyOn: z.array(z.enum(["CONNECTED", "DISCONNECTED"])).optional()}); export const entitiesLimitNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), entityTypes: z.array(z.enum(["TENANT", "CUSTOMER", "USER", "DASHBOARD", "ASSET", "DEVICE", "ALARM", "RULE_CHAIN", "RULE_NODE", "ENTITY_VIEW", "WIDGETS_BUNDLE", "WIDGET_TYPE", "TENANT_PROFILE", "DEVICE_PROFILE", "ASSET_PROFILE", "API_USAGE_STATE", "TB_RESOURCE", "OTA_PACKAGE", "EDGE", "RPC", "QUEUE", "NOTIFICATION_TARGET", "NOTIFICATION_TEMPLATE", "NOTIFICATION_REQUEST", "NOTIFICATION", "NOTIFICATION_RULE", "QUEUE_STATS", "OAUTH2_CLIENT", "DOMAIN", "MOBILE_APP", "MOBILE_APP_BUNDLE", "CALCULATED_FIELD", "JOB", "ADMIN_SETTINGS", "AI_MODEL", "API_KEY"])).optional(), threshold: z.number().lte(1).optional()}); export const entityActionNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), entityTypes: z.array(z.enum(["TENANT", "CUSTOMER", "USER", "DASHBOARD", "ASSET", "DEVICE", "ALARM", "RULE_CHAIN", "RULE_NODE", "ENTITY_VIEW", "WIDGETS_BUNDLE", "WIDGET_TYPE", "TENANT_PROFILE", "DEVICE_PROFILE", "ASSET_PROFILE", "API_USAGE_STATE", "TB_RESOURCE", "OTA_PACKAGE", "EDGE", "RPC", "QUEUE", "NOTIFICATION_TARGET", "NOTIFICATION_TEMPLATE", "NOTIFICATION_REQUEST", "NOTIFICATION", "NOTIFICATION_RULE", "QUEUE_STATS", "OAUTH2_CLIENT", "DOMAIN", "MOBILE_APP", "MOBILE_APP_BUNDLE", "CALCULATED_FIELD", "JOB", "ADMIN_SETTINGS", "AI_MODEL", "API_KEY"])).optional(), created: z.boolean().optional(), updated: z.boolean().optional(), deleted: z.boolean().optional()}); export const newPlatformVersionNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional()}); export const rateLimitsNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), apis: z.array(z.enum(["ENTITY_EXPORT", "ENTITY_IMPORT", "NOTIFICATION_REQUESTS", "NOTIFICATION_REQUESTS_PER_RULE", "REST_REQUESTS_PER_TENANT", "REST_REQUESTS_PER_CUSTOMER", "WS_UPDATES_PER_SESSION", "CASSANDRA_WRITE_QUERIES_CORE", "CASSANDRA_READ_QUERIES_CORE", "CASSANDRA_WRITE_QUERIES_RULE_ENGINE", "CASSANDRA_READ_QUERIES_RULE_ENGINE", "CASSANDRA_READ_QUERIES_MONOLITH", "CASSANDRA_WRITE_QUERIES_MONOLITH", "CASSANDRA_QUERIES", "EDGE_EVENTS", "EDGE_EVENTS_PER_EDGE", "EDGE_UPLINK_MESSAGES", "EDGE_UPLINK_MESSAGES_PER_EDGE", "PASSWORD_RESET", "TWO_FA_VERIFICATION_CODE_SEND", "TWO_FA_VERIFICATION_CODE_CHECK", "TRANSPORT_MESSAGES_PER_TENANT", "TRANSPORT_MESSAGES_PER_DEVICE", "TRANSPORT_MESSAGES_PER_GATEWAY", "TRANSPORT_MESSAGES_PER_GATEWAY_DEVICE", "EMAILS", "WS_SUBSCRIPTIONS", "CALCULATED_FIELD_DEBUG_EVENTS"])).optional()}); export const resourcesShortageNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), cpuThreshold: z.number().lte(1).optional(), ramThreshold: z.number().lte(1).optional(), storageThreshold: z.number().lte(1).optional()}); export const ruleEngineComponentLifecycleEventNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional(), ruleChains: z.array(z.string()).optional(), ruleChainEvents: z.array(z.enum(["CREATED", "STARTED", "ACTIVATED", "SUSPENDED", "UPDATED", "STOPPED", "DELETED", "FAILED", "DEACTIVATED", "RELATION_UPDATED", "RELATION_DELETED"])).optional(), onlyRuleChainLifecycleFailures: z.boolean().optional(), trackRuleNodeEvents: z.boolean().optional(), ruleNodeEvents: z.array(z.enum(["CREATED", "STARTED", "ACTIVATED", "SUSPENDED", "UPDATED", "STOPPED", "DELETED", "FAILED", "DEACTIVATED", "RELATION_UPDATED", "RELATION_DELETED"])).optional(), onlyRuleNodeLifecycleFailures: z.boolean().optional()}); export const taskProcessingFailureNotificationRuleTriggerConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]).optional()}); export const escalatedNotificationRuleRecipientsConfig = z.object({triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]), escalationTable: z.record(z.string(), z.array(z.string()))}); export const notificationRuleConfig = z.object({description: z.string().optional()}); export const notificationRule = z.object({id: notificationRuleId.optional(), createdTime: z.number().int().optional(), tenantId: tenantId.optional(), name: z.string().min(1), enabled: z.boolean().optional(), templateId: notificationTemplateId, triggerType: z.enum(["ENTITY_ACTION", "ALARM", "ALARM_COMMENT", "ALARM_ASSIGNMENT", "DEVICE_ACTIVITY", "RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT", "EDGE_CONNECTION", "EDGE_COMMUNICATION_FAILURE", "NEW_PLATFORM_VERSION", "ENTITIES_LIMIT", "API_USAGE_LIMIT", "RATE_LIMITS", "TASK_PROCESSING_FAILURE", "RESOURCES_SHORTAGE"]), triggerConfig: z.union([alarmAssignmentNotificationRuleTriggerConfig, alarmCommentNotificationRuleTriggerConfig, alarmNotificationRuleTriggerConfig, apiUsageLimitNotificationRuleTriggerConfig, deviceActivityNotificationRuleTriggerConfig, edgeCommunicationFailureNotificationRuleTriggerConfig, edgeConnectionNotificationRuleTriggerConfig, entitiesLimitNotificationRuleTriggerConfig, entityActionNotificationRuleTriggerConfig, newPlatformVersionNotificationRuleTriggerConfig, rateLimitsNotificationRuleTriggerConfig, resourcesShortageNotificationRuleTriggerConfig, ruleEngineComponentLifecycleEventNotificationRuleTriggerConfig, taskProcessingFailureNotificationRuleTriggerConfig]), recipientsConfig: escalatedNotificationRuleRecipientsConfig, additionalConfig: notificationRuleConfig.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Save notification rule (saveNotificationRule) * * POST /api/notification/rule */ export const createApiApiNotificationRule = async (args: CreateApiApiNotificationRuleArgs, options?: CreateApiApiNotificationRuleOptions) => { const {baseUrl = "https://demo.thingsboard.io", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/api/notification/rule${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(notificationRule, await res.json()) };