import {z} from 'zod' export type GetApiApiNotificationRulesArgs = {pageSize: number, page: number, textSearch?: string | undefined, sortProperty?: string | undefined, sortOrder?: string | undefined}; export type GetApiApiNotificationRulesOptions = {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 notificationRuleInfo = 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(), templateName: z.string().optional(), deliveryMethods: z.array(z.enum(["WEB", "EMAIL", "SMS", "SLACK", "MICROSOFT_TEAMS", "MOBILE_APP"])).optional()}); export const pageDataNotificationRuleInfo = z.object({data: z.array(notificationRuleInfo).optional(), totalPages: z.number().int().optional(), totalElements: z.number().int().optional(), hasNext: z.boolean().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 }; /** * Get notification rules (getNotificationRules) * * GET /api/notification/rules */ export const getApiApiNotificationRules = async (args: GetApiApiNotificationRulesArgs, options?: GetApiApiNotificationRulesOptions) => { const {baseUrl = "https://demo.thingsboard.io", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.page != null) query.append("page", String(args.page)) if (args.textSearch != null) query.append("textSearch", String(args.textSearch)) if (args.sortProperty != null) query.append("sortProperty", String(args.sortProperty)) if (args.sortOrder != null) query.append("sortOrder", String(args.sortOrder)) const url = `${baseUrl.replace(/\/+$/, '')}/api/notification/rules${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(pageDataNotificationRuleInfo, await res.json()) };