import {z} from 'zod' export type GetApiV2AlertsArgs = {sourceType?: string | undefined, df?: string | undefined, lang?: string | undefined, tz?: string | undefined}; export type GetApiV2AlertsOptions = {baseUrl: string, oauth2?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiV2AlertsResponse = z.array(z.object({uid: z.string().optional(), deviceId: z.number().int().optional(), message: z.string().optional(), createTime: z.number().optional(), updateTime: z.number().optional(), sourceType: z.enum(["AGENT_OFFLINE", "CONDITION_AGENT_CPU", "CONDITION_AGENT_MEMORY", "CONDITION_AGENT_NETWORK", "CONDITION_AGENT_DISK_IO", "CONDITION_AGENT_DISK_FREE_SPACE", "CONDITION_AGENT_DISK_USAGE", "CONDITION_AGENT_CVSS_SCORE", "CONDITION_AGENT_PATCH_LAST_INSTALLED", "CONDITION_NMS_CPU", "CONDITION_NMS_MEMORY", "CONDITION_NMS_NETWORK_TRAFFIC_BITS", "CONDITION_NMS_NETWORK_TRAFFIC_PERCENT", "CONDITION_NMS_NETWORK_STATUS", "CONDITION_NMS_NETWORK_STATUS_CHANGE", "CONDITION_NMS_SYSTEM_UPTIME", "CONDITION_PING", "CONDITION_PING_LATENCY", "CONDITION_PING_PACKET_LOSS", "CONDITION_PING_RESPONSE", "CONDITION_SYSTEM_UPTIME", "CONDITION_SMART_STATUS_DEGRATED", "CONDITION_RAID_HEALTH_STATUS", "CONDITION_SCRIPT_RESULT", "CONDITION_HTTP", "CONDITION_HTTP_RESPONSE", "CONDITION_PORT", "CONDITION_PORT_SCAN", "CONDITION_SYSLOG", "CONDITION_CONFIGURATION_FILE", "CONDITION_SNMPTRAP", "CONDITION_CRITICAL_EVENT", "CONDITION_DNS", "CONDITION_EMAIL", "CONDITION_CUSTOM_SNMP", "CONDITION_COMPOUND", "SHADOWPROTECT_BACKUPJOB_CREATE", "SHADOWPROTECT_BACKUPJOB_UPDATE", "SHADOWPROTECT_BACKUPJOB_DELETE", "SHADOWPROTECT_BACKUPJOB_EXECUTE", "IMAGEMANAGER_MANAGEDFOLDER_CREATE", "IMAGEMANAGER_MANAGEDFOLDER_UPDATE", "IMAGEMANAGER_MANAGEDFOLDER_DELETE", "IMAGEMANAGER_MANAGEDFOLDER_EXECUTE", "TEAMVIEWER_CONNECTION", "RETRIEVE_AGENT_LOGS", "SCHEDULED_TASK", "CONDITION_WINDOWS_EVENT_LOG_TRIGGERED", "CONDITION_WINDOWS_SERVICE_STATE_CHANGED", "UI_MESSAGE_ACTION_REBOOT", "UI_MESSAGE_BD_INSTALLATION_ISSUES", "GRAVITYZONE_UI_MESSAGE_INSTALLATION_ISSUES", "AV_QUARANTINE_THREAT", "AV_RESTORE_THREAT", "AV_DELETE_THREAT", "AV_REMOVE_THREAT", "BITDEFENDER_RESTORE_THREAT", "BITDEFENDER_DELETE_THREAT", "CONDITION_BITLOCKER_STATUS", "CONDITION_FILEVAULT_STATUS", "CONDITION_LINUX_PROCESS", "CONDITION_LINUX_Daemon", "CONDITION_LINUX_PROCESS_RESOURCE", "CONDITION_LINUX_PROCESS_RESOURCE_CPU", "CONDITION_LINUX_PROCESS_RESOURCE_MEMORY", "CONDITION_LINUX_DISK_FREE_SPACE", "CONDITION_LINUX_DISK_USAGE", "CONDITION_VM_AGGREGATE_CPU_USAGE", "CONDITION_VM_DISK_USAGE", "CONDITION_VM_HOST_DATASTORE", "CONDITION_VM_HOST_UPTIME", "CONDITION_VM_HOST_DEVICE_DOWN", "CONDITION_VM_HOST_BAD_SENSORS", "CONDITION_VM_HOST_SENSOR_HEALTH", "CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE", "CONDITION_VM_GUEST_SNAPSHOT_SIZE", "CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN", "CONDITION_VM_GUEST_TOOLS_NOT_RUNNING", "CONDITION_HV_GUEST_CHECKPOINT_SIZE", "CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN", "CONDITION_SOFTWARE", "CONDITION_WINDOWS_PROCESS_STATE", "CONDITION_WINDOWS_PROCESS_RESOURCE_CPU", "CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY", "CONDITION_MAC_PROCESS_STATE", "CONDITION_MAC_PROCESS_RESOURCE_CPU", "CONDITION_MAC_PROCESS_RESOURCE_MEMORY", "CONDITION_MAC_DEAMON", "CONDITION_CUSTOM_FIELD", "CONDITION_PENDING_REBOOT"]).optional(), sourceConfigUid: z.string().optional(), sourceName: z.string().optional(), subject: z.string().optional(), userId: z.number().int().optional(), psaTicketId: z.object({}).optional(), ticketTemplateId: z.number().int().optional(), data: z.record(z.string(), z.unknown()).optional(), device: z.object({id: z.number().int().optional(), uid: z.string().optional(), assignedOwnerUid: z.string().optional(), parentDeviceId: z.number().int().optional(), organizationId: z.number().int().optional(), locationId: z.number().int().optional(), nodeClass: z.enum(["WINDOWS_SERVER", "WINDOWS_WORKSTATION", "LINUX_WORKSTATION", "MAC", "ANDROID", "APPLE_IOS", "APPLE_IPADOS", "AOSP", "CHROMEOS", "VMWARE_VM_HOST", "VMWARE_VM_GUEST", "HYPERV_VMM_HOST", "HYPERV_VMM_GUEST", "LINUX_SERVER", "MAC_SERVER", "CLOUD_MONITOR_TARGET", "NMS_SWITCH", "NMS_ROUTER", "NMS_FIREWALL", "NMS_PRIVATE_NETWORK_GATEWAY", "NMS_PRINTER", "NMS_SCANNER", "NMS_DIAL_MANAGER", "NMS_WAP", "NMS_IPSLA", "NMS_COMPUTER", "NMS_VM_HOST", "NMS_APPLIANCE", "NMS_OTHER", "NMS_SERVER", "NMS_PHONE", "NMS_VIRTUAL_MACHINE", "NMS_NETWORK_MANAGEMENT_AGENT", "UNMANAGED_DEVICE", "MANAGED_DEVICE"]).optional(), nodeRoleId: z.number().int().optional(), rolePolicyId: z.number().int().optional(), policyId: z.number().int().optional(), approvalStatus: z.enum(["PENDING", "STAGED", "APPROVED", "DECOMMISSIONED"]).optional(), offline: z.boolean().optional(), displayName: z.string().optional(), systemName: z.string().optional(), dnsName: z.string().optional(), netbiosName: z.string().optional(), created: z.number().optional(), lastContact: z.number().optional(), lastUpdate: z.number().optional(), userData: z.record(z.string(), z.unknown()).optional(), tags: z.array(z.string()).optional(), maintenance: z.object({status: z.enum(["PENDING", "IN_MAINTENANCE", "FAILED"]).optional(), start: z.number().optional(), end: z.number().optional(), reasonMessage: z.string().optional()}).optional(), references: z.object({organization: z.object({name: z.string().optional(), description: z.string().optional(), userData: z.record(z.string(), z.unknown()).optional(), nodeApprovalMode: z.enum(["AUTOMATIC", "MANUAL", "REJECT"]).optional(), id: z.number().int().optional()}).optional(), location: z.object({name: z.string().optional(), address: z.string().optional(), description: z.string().optional(), userData: z.record(z.string(), z.unknown()).optional(), id: z.number().int().optional()}).optional(), rolePolicy: z.object({id: z.number().int().optional(), parentPolicyId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), nodeClass: z.enum(["WINDOWS_SERVER", "WINDOWS_WORKSTATION", "LINUX_WORKSTATION", "MAC", "ANDROID", "APPLE_IOS", "APPLE_IPADOS", "AOSP", "CHROMEOS", "VMWARE_VM_HOST", "VMWARE_VM_GUEST", "HYPERV_VMM_HOST", "HYPERV_VMM_GUEST", "LINUX_SERVER", "MAC_SERVER", "CLOUD_MONITOR_TARGET", "NMS_SWITCH", "NMS_ROUTER", "NMS_FIREWALL", "NMS_PRIVATE_NETWORK_GATEWAY", "NMS_PRINTER", "NMS_SCANNER", "NMS_DIAL_MANAGER", "NMS_WAP", "NMS_IPSLA", "NMS_COMPUTER", "NMS_VM_HOST", "NMS_APPLIANCE", "NMS_OTHER", "NMS_SERVER", "NMS_PHONE", "NMS_VIRTUAL_MACHINE", "NMS_NETWORK_MANAGEMENT_AGENT", "UNMANAGED_DEVICE", "MANAGED_DEVICE"]).optional(), updated: z.number().optional(), nodeClassDefault: z.boolean().optional()}).optional(), policy: z.object({id: z.number().int().optional(), parentPolicyId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), nodeClass: z.enum(["WINDOWS_SERVER", "WINDOWS_WORKSTATION", "LINUX_WORKSTATION", "MAC", "ANDROID", "APPLE_IOS", "APPLE_IPADOS", "AOSP", "CHROMEOS", "VMWARE_VM_HOST", "VMWARE_VM_GUEST", "HYPERV_VMM_HOST", "HYPERV_VMM_GUEST", "LINUX_SERVER", "MAC_SERVER", "CLOUD_MONITOR_TARGET", "NMS_SWITCH", "NMS_ROUTER", "NMS_FIREWALL", "NMS_PRIVATE_NETWORK_GATEWAY", "NMS_PRINTER", "NMS_SCANNER", "NMS_DIAL_MANAGER", "NMS_WAP", "NMS_IPSLA", "NMS_COMPUTER", "NMS_VM_HOST", "NMS_APPLIANCE", "NMS_OTHER", "NMS_SERVER", "NMS_PHONE", "NMS_VIRTUAL_MACHINE", "NMS_NETWORK_MANAGEMENT_AGENT", "UNMANAGED_DEVICE", "MANAGED_DEVICE"]).optional(), updated: z.number().optional(), nodeClassDefault: z.boolean().optional()}).optional(), role: z.object({id: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), nodeClass: z.enum(["WINDOWS_SERVER", "WINDOWS_WORKSTATION", "LINUX_WORKSTATION", "MAC", "ANDROID", "APPLE_IOS", "APPLE_IPADOS", "AOSP", "CHROMEOS", "VMWARE_VM_HOST", "VMWARE_VM_GUEST", "HYPERV_VMM_HOST", "HYPERV_VMM_GUEST", "LINUX_SERVER", "MAC_SERVER", "CLOUD_MONITOR_TARGET", "NMS_SWITCH", "NMS_ROUTER", "NMS_FIREWALL", "NMS_PRIVATE_NETWORK_GATEWAY", "NMS_PRINTER", "NMS_SCANNER", "NMS_DIAL_MANAGER", "NMS_WAP", "NMS_IPSLA", "NMS_COMPUTER", "NMS_VM_HOST", "NMS_APPLIANCE", "NMS_OTHER", "NMS_SERVER", "NMS_PHONE", "NMS_VIRTUAL_MACHINE", "NMS_NETWORK_MANAGEMENT_AGENT", "UNMANAGED_DEVICE", "MANAGED_DEVICE"]).optional(), custom: z.boolean().optional(), chassisType: z.enum(["UNKNOWN", "DESKTOP", "LAPTOP", "MOBILE"]).optional(), created: z.number().optional(), nodeRoleParentId: z.number().int().optional(), icon: z.string().optional()}).optional(), backupUsage: z.object({revisionsCurrentSize: z.number().int().optional(), revisionsPreviousSize: z.number().int().optional(), revisionsDeletedSize: z.number().int().optional(), localFileFolderSize: z.number().int().optional(), localImageSize: z.number().int().optional(), localImageV2Size: z.number().int().optional(), cloudFileFolderSize: z.number().int().optional(), cloudImageSize: z.number().int().optional(), cloudImageV2Size: z.number().int().optional(), cloudNetworkShareSize: z.number().int().optional(), lastSuccessfulBackupJob: z.number().optional(), lastFailedBackupJob: z.number().optional(), revisionsTotalSize: z.number().int().optional(), cloudTotalSize: z.number().int().optional(), localTotalSize: z.number().int().optional()}).optional(), warranty: z.object({startDate: z.number().optional(), endDate: z.number().optional(), manufacturerFulfillmentDate: z.number().optional()}).optional(), assignedOwner: z.object({id: z.number().int().optional(), uid: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), email: z.string().optional(), phone: z.string().optional(), enabled: z.boolean().optional(), administrator: z.boolean().optional(), permitAllClients: z.boolean().optional(), notifyAllClients: z.boolean().optional(), mustChangePw: z.boolean().optional(), mfaConfigured: z.boolean().optional(), userType: z.enum(["TECHNICIAN", "END_USER"]).optional(), invitationStatus: z.enum(["REGISTERED", "PENDING", "EXPIRED"]).optional(), organizationId: z.number().int().optional(), deviceIds: z.array(z.number().int()).optional(), assignedDeviceIds: z.array(z.number().int()).optional(), roles: z.array(z.string()).optional()}).optional(), backupBandwidthThrottle: z.object({enabled: z.boolean().optional(), workHoursKbps: z.number().int().optional(), nonWorkHoursKbps: z.number().int().optional(), workHoursUserUnit: z.string().optional(), nonWorkHoursUserUnit: z.string().optional(), workSchedule: z.object({endHour: z.number().int().optional(), endMinute: z.number().int().optional(), startHour: z.number().int().optional(), startMinute: z.number().int().optional(), weekDays: z.array(z.string()).optional()}).optional()}).optional()}).optional()}).optional(), priority: z.string().optional(), severity: z.string().optional(), conditionName: z.string().optional(), conditionHealthStatus: z.enum(["UNKNOWN", "HEALTHY", "NEEDS_ATTENTION", "UNHEALTHY"]).optional(), useGlobalHealthStatus: 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 }; /** * List active alerts (triggered conditions) * * GET /v2/alerts * * Also accepts auth: sessionKey */ export const getApiV2Alerts = async (args: GetApiV2AlertsArgs, options: GetApiV2AlertsOptions) => { const {baseUrl, fetch: fetchFn = fetch, oauth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.sourceType != null) query.append("sourceType", String(args.sourceType)) if (args.df != null) query.append("df", String(args.df)) if (args.lang != null) query.append("lang", String(args.lang)) if (args.tz != null) query.append("tz", String(args.tz)) if (oauth2 !== undefined) headers.set('authorization', `Bearer ${oauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/alerts${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(getApiV2AlertsResponse, await res.json()) };