@oneuptime/common 9.4.12 → 9.5.0

package/Server/Utils/Workspace/Slack/Messages/IncidentEpisode.ts

@@ -0,0 +1,120 @@
+import BadDataException from "../../../../../Types/Exception/BadDataException";
+import ObjectID from "../../../../../Types/ObjectID";
+import {
+  WorkspaceMessageBlock,
+  WorkspaceMessagePayloadButton,
+  WorkspacePayloadButtons,
+  WorkspacePayloadDivider,
+} from "../../../../../Types/Workspace/WorkspaceMessagePayload";
+import IncidentEpisodeService from "../../../../Services/IncidentEpisodeService";
+import SlackActionType from "../../../../Utils/Workspace/Slack/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
+
+export default class SlackIncidentEpisodeMessages {
+  @CaptureSpan()
+  public static async getIncidentEpisodeCreateMessageBlocks(data: {
+    incidentEpisodeId: ObjectID;
+    projectId: ObjectID;
+  }): Promise<Array<WorkspaceMessageBlock>> {
+    if (!data.incidentEpisodeId) {
+      throw new BadDataException("Incident Episode ID is required");
+    }
+
+    // Slack.
+
+    const blockSlack: Array<WorkspaceMessageBlock> = [];
+
+    // add divider.
+
+    const dividerBlock: WorkspacePayloadDivider = {
+      _type: "WorkspacePayloadDivider",
+    };
+
+    blockSlack.push(dividerBlock);
+
+    /*
+     * now add buttons.
+     * View data.
+     * Execute On Call
+     * Acknowledge incident episode
+     * Resolve data.
+     * Change Incident Episode State.
+     * Add Note.
+     */
+
+    const buttons: Array<WorkspaceMessagePayloadButton> = [];
+
+    // view data.
+    const viewIncidentEpisodeButton: WorkspaceMessagePayloadButton = {
+      _type: "WorkspaceMessagePayloadButton",
+      title: "View Episode",
+      url: await IncidentEpisodeService.getEpisodeLinkInDashboard(
+        data.projectId!,
+        data.incidentEpisodeId!,
+      ),
+      value: data.incidentEpisodeId?.toString() || "",
+      actionId: SlackActionType.ViewIncidentEpisode,
+    };
+
+    buttons.push(viewIncidentEpisodeButton);
+
+    // execute on call.
+    const executeOnCallButton: WorkspaceMessagePayloadButton = {
+      _type: "WorkspaceMessagePayloadButton",
+      title: "Execute On Call",
+      value: data.incidentEpisodeId?.toString() || "",
+      actionId: SlackActionType.ViewExecuteIncidentEpisodeOnCallPolicy,
+    };
+
+    buttons.push(executeOnCallButton);
+
+    // acknowledge data.
+    const acknowledgeIncidentEpisodeButton: WorkspaceMessagePayloadButton = {
+      _type: "WorkspaceMessagePayloadButton",
+      title: "Acknowledge Episode",
+      value: data.incidentEpisodeId?.toString() || "",
+      actionId: SlackActionType.AcknowledgeIncidentEpisode,
+    };
+
+    buttons.push(acknowledgeIncidentEpisodeButton);
+
+    // resolve data.
+    const resolveIncidentEpisodeButton: WorkspaceMessagePayloadButton = {
+      _type: "WorkspaceMessagePayloadButton",
+      title: "Resolve Episode",
+      value: data.incidentEpisodeId?.toString() || "",
+      actionId: SlackActionType.ResolveIncidentEpisode,
+    };
+
+    buttons.push(resolveIncidentEpisodeButton);
+
+    // change incident episode state.
+    const changeIncidentEpisodeStateButton: WorkspaceMessagePayloadButton = {
+      _type: "WorkspaceMessagePayloadButton",
+      title: "Change Episode State",
+      value: data.incidentEpisodeId?.toString() || "",
+      actionId: SlackActionType.ViewChangeIncidentEpisodeState,
+    };
+
+    buttons.push(changeIncidentEpisodeStateButton);
+
+    // add note.
+    const addNoteButton: WorkspaceMessagePayloadButton = {
+      _type: "WorkspaceMessagePayloadButton",
+      title: "Add Note",
+      value: data.incidentEpisodeId?.toString() || "",
+      actionId: SlackActionType.ViewAddIncidentEpisodeNote,
+    };
+
+    buttons.push(addNoteButton);
+
+    const workspacePayloadButtons: WorkspacePayloadButtons = {
+      buttons: buttons,
+      _type: "WorkspacePayloadButtons",
+    };
+
+    blockSlack.push(workspacePayloadButtons);
+
+    return blockSlack;
+  }
+}

package/Server/Utils/Workspace/WorkspaceMessages/IncidentEpisode.ts

@@ -0,0 +1,74 @@
+import ObjectID from "../../../../Types/ObjectID";
+import NotificationRuleEventType from "../../../../Types/Workspace/NotificationRules/EventType";
+import NotificationRuleWorkspaceChannel from "../../../../Types/Workspace/NotificationRules/NotificationRuleWorkspaceChannel";
+import { WorkspaceMessageBlock } from "../../../../Types/Workspace/WorkspaceMessagePayload";
+import WorkspaceType from "../../../../Types/Workspace/WorkspaceType";
+import WorkspaceNotificationRuleService, {
+  MessageBlocksByWorkspaceType,
+} from "../../../Services/WorkspaceNotificationRuleService";
+import logger from "../../Logger";
+import SlackIncidentEpisodeMessages from "../Slack/Messages/IncidentEpisode";
+import CaptureSpan from "../../Telemetry/CaptureSpan";
+
+export default class IncidentEpisodeWorkspaceMessages {
+  @CaptureSpan()
+  public static async createChannelsAndInviteUsersToChannels(data: {
+    projectId: ObjectID;
+    incidentEpisodeId: ObjectID;
+    episodeNumber: number;
+  }): Promise<{
+    channelsCreated: NotificationRuleWorkspaceChannel[];
+  } | null> {
+    try {
+      // we will notify the workspace about the incident episode creation with the bot token which is in WorkspaceProjectAuth Table.
+      return await WorkspaceNotificationRuleService.createChannelsAndInviteUsersToChannelsBasedOnRules(
+        {
+          projectId: data.projectId,
+          notificationFor: {
+            incidentEpisodeId: data.incidentEpisodeId,
+          },
+          notificationRuleEventType: NotificationRuleEventType.IncidentEpisode,
+          channelNameSiffix: data.episodeNumber.toString(),
+        },
+      );
+    } catch (err) {
+      // log the error and continue.
+      logger.error(
+        "Error in IncidentEpisode createChannelsAndInviteUsersToChannels",
+      );
+      logger.error(err);
+      return null;
+    }
+  }
+
+  @CaptureSpan()
+  public static async getIncidentEpisodeCreateMessageBlocks(data: {
+    incidentEpisodeId: ObjectID;
+    projectId: ObjectID;
+  }): Promise<Array<MessageBlocksByWorkspaceType>> {
+    const { incidentEpisodeId, projectId } = data;
+
+    const slackBlocks: WorkspaceMessageBlock[] =
+      await SlackIncidentEpisodeMessages.getIncidentEpisodeCreateMessageBlocks({
+        incidentEpisodeId: incidentEpisodeId,
+        projectId: projectId!,
+      });
+
+    const microsoftTeamsBlocks: WorkspaceMessageBlock[] =
+      await SlackIncidentEpisodeMessages.getIncidentEpisodeCreateMessageBlocks({
+        incidentEpisodeId: incidentEpisodeId,
+        projectId: projectId!,
+      });
+
+    return [
+      {
+        workspaceType: WorkspaceType.Slack,
+        messageBlocks: slackBlocks,
+      },
+      {
+        workspaceType: WorkspaceType.MicrosoftTeams,
+        messageBlocks: microsoftTeamsBlocks,
+      },
+    ];
+  }
+}

package/Tests/Server/Services/AlertGroupingEngineService.test.ts

@@ -461,8 +461,9 @@ describe("Template Variable Replacement Logic", () => {
 
   describe("Default Title Generation", () => {
     test("should use monitor name when no template provided", () => {
-      const defaultTitle: string = `Alert Episode: ${mockAlert.monitor?.name || mockAlert.title || "Alert Episode"}`;
-      expect(defaultTitle).toBe("Alert Episode: API Server");
+      const defaultTitle: string =
+        mockAlert.monitor?.name || mockAlert.title || "Untitled Episode";
+      expect(defaultTitle).toBe("API Server");
     });
 
     test("should use alert title when no monitor", () => {
@@ -473,8 +474,11 @@ describe("Template Variable Replacement Logic", () => {
       alertNoMonitor.title = "High CPU Usage";
       // monitor is intentionally not set
 
-      const defaultTitle: string = `Alert Episode: ${alertNoMonitor.monitor?.name || alertNoMonitor.title || "Alert Episode"}`;
-      expect(defaultTitle).toBe("Alert Episode: High CPU Usage");
+      const defaultTitle: string =
+        alertNoMonitor.monitor?.name ||
+        alertNoMonitor.title ||
+        "Untitled Episode";
+      expect(defaultTitle).toBe("High CPU Usage");
     });
 
     test("should use generic title when no monitor and no alert title", () => {
@@ -484,8 +488,9 @@ describe("Template Variable Replacement Logic", () => {
       alertMinimal.id = alertId;
       // monitor and title are intentionally not set
 
-      const defaultTitle: string = `Alert Episode: ${alertMinimal.monitor?.name || alertMinimal.title || "Alert Episode"}`;
-      expect(defaultTitle).toBe("Alert Episode: Alert Episode");
+      const defaultTitle: string =
+        alertMinimal.monitor?.name || alertMinimal.title || "Untitled Episode";
+      expect(defaultTitle).toBe("Untitled Episode");
     });
   });
 });

package/Types/Email/EmailTemplateType.ts

@@ -36,6 +36,7 @@ enum EmailTemplateType {
   IncidentOwnerStateChanged = "IncidentOwnerStateChanged.hbs",
   IncidentOwnerNotePosted = "IncidentOwnerNotePosted.hbs",
   IncidentOwnerResourceCreated = "IncidentOwnerResourceCreated.hbs",
+  IncidentMemberAdded = "IncidentMemberAdded.hbs",
 
   AlertOwnerAdded = "AlertOwnerAdded.hbs",
   AlertOwnerStateChanged = "AlertOwnerStateChanged.hbs",
@@ -47,6 +48,11 @@ enum EmailTemplateType {
   AlertEpisodeOwnerNotePosted = "AlertEpisodeOwnerNotePosted.hbs",
   AlertEpisodeOwnerResourceCreated = "AlertEpisodeOwnerResourceCreated.hbs",
 
+  IncidentEpisodeOwnerAdded = "IncidentEpisodeOwnerAdded.hbs",
+  IncidentEpisodeOwnerStateChanged = "IncidentEpisodeOwnerStateChanged.hbs",
+  IncidentEpisodeOwnerNotePosted = "IncidentEpisodeOwnerNotePosted.hbs",
+  IncidentEpisodeOwnerResourceCreated = "IncidentEpisodeOwnerResourceCreated.hbs",
+
   ScheduledMaintenanceOwnerNotePosted = "ScheduledMaintenanceOwnerNotePosted.hbs",
   ScheduledMaintenanceOwnerAdded = "ScheduledMaintenanceOwnerAdded.hbs",
   ScheduledMaintenanceOwnerStateChanged = "ScheduledMaintenanceOwnerStateChanged.hbs",
@@ -59,6 +65,7 @@ enum EmailTemplateType {
   AcknowledgeIncident = "AcknowledgeIncident.hbs",
   AcknowledgeAlert = "AcknowledgeAlert.hbs",
   AcknowledgeAlertEpisode = "AcknowledgeAlertEpisode.hbs",
+  AcknowledgeIncidentEpisode = "AcknowledgeIncidentEpisode.hbs",
 
   UserAddedToOnCallPolicy = "UserAddedToOnCallPolicy.hbs",
   UserRemovedFromOnCallPolicy = "UserRemovedFromOnCallPolicy.hbs",

package/Types/Incident/IncidentSlaStatus.ts

@@ -0,0 +1,9 @@
+enum IncidentSlaStatus {
+  OnTrack = "On Track",
+  AtRisk = "At Risk",
+  ResponseBreached = "Response Breached",
+  ResolutionBreached = "Resolution Breached",
+  Met = "Met",
+}
+
+export default IncidentSlaStatus;

package/Types/Monitor/CriteriaAlert.ts

@@ -9,6 +9,9 @@ export interface CriteriaAlert {
   remediationNotes?: string | undefined;
   id: string;
   onCallPolicyIds?: Array<ObjectID> | undefined;
+  labelIds?: Array<ObjectID> | undefined;
+  ownerTeamIds?: Array<ObjectID> | undefined;
+  ownerUserIds?: Array<ObjectID> | undefined;
 }
 
 export const CriteriaAlertSchema: ZodSchema = Zod.object({
@@ -19,4 +22,7 @@ export const CriteriaAlertSchema: ZodSchema = Zod.object({
   remediationNotes: Zod.string().optional(),
   id: Zod.string(),
   onCallPolicyIds: Zod.array(Zod.any()).optional(),
+  labelIds: Zod.array(Zod.any()).optional(),
+  ownerTeamIds: Zod.array(Zod.any()).optional(),
+  ownerUserIds: Zod.array(Zod.any()).optional(),
 });

package/Types/Monitor/CriteriaFilter.ts

@@ -54,12 +54,22 @@ export enum CheckOn {
   EmailBody = "Email Body",
   EmailTo = "Email To Address",
   EmailReceivedAt = "Email Received",
+
+  // SNMP monitors.
+  SnmpOidValue = "SNMP OID Value",
+  SnmpOidExists = "SNMP OID Exists",
+  SnmpResponseTime = "SNMP Response Time (in ms)",
+  SnmpIsOnline = "SNMP Device Is Online",
 }
 
 export interface ServerMonitorOptions {
   diskPath?: string | undefined;
 }
 
+export interface SnmpMonitorOptions {
+  oid?: string | undefined;
+}
+
 export enum EvaluateOverTimeType {
   Average = "Average",
   Sum = "Sum",
@@ -95,9 +105,10 @@ export interface CriteriaFilter {
   checkOn: CheckOn;
   serverMonitorOptions?: ServerMonitorOptions | undefined;
   metricMonitorOptions?: MetricMonitorOptions | undefined;
+  snmpMonitorOptions?: SnmpMonitorOptions | undefined;
   filterType: FilterType | undefined;
   value: string | number | undefined;
-  eveluateOverTime?: boolean | undefined;
+  evaluateOverTime?: boolean | undefined;
   evaluateOverTimeOptions?: EvaluateOverTimeOptions | undefined;
 }
 
@@ -130,7 +141,7 @@ export class CriteriaFilterUtil {
   }): boolean {
     const { checkOn } = data;
 
-    if (checkOn === CheckOn.IsOnline) {
+    if (checkOn === CheckOn.IsOnline || checkOn === CheckOn.SnmpIsOnline) {
       return false;
     }
 
@@ -138,6 +149,10 @@ export class CriteriaFilterUtil {
       return false;
     }
 
+    if (checkOn === CheckOn.SnmpOidExists) {
+      return false;
+    }
+
     if (
       checkOn === CheckOn.IsValidCertificate ||
       checkOn === CheckOn.IsSelfSignedCertificate ||
@@ -187,7 +202,9 @@ export class CriteriaFilterUtil {
       checkOn === CheckOn.DiskUsagePercent ||
       checkOn === CheckOn.CPUUsagePercent ||
       checkOn === CheckOn.MemoryUsagePercent ||
-      checkOn === CheckOn.IsOnline
+      checkOn === CheckOn.IsOnline ||
+      checkOn === CheckOn.SnmpResponseTime ||
+      checkOn === CheckOn.SnmpIsOnline
     );
   }
 }
@@ -201,9 +218,12 @@ export const CriteriaFilterSchema: ZodSchema = Zod.object({
     metricAlias: Zod.string().optional(),
     metricAggregationType: Zod.string().optional(),
   }).optional(),
+  snmpMonitorOptions: Zod.object({
+    oid: Zod.string().optional(),
+  }).optional(),
   filterType: Zod.string().optional(),
   value: Zod.union([Zod.string(), Zod.number()]).optional(),
-  eveluateOverTime: Zod.boolean().optional(),
+  evaluateOverTime: Zod.boolean().optional(),
   evaluateOverTimeOptions: Zod.object({
     timeValueInMinutes: Zod.number().optional(),
     evaluateOverTimeType: Zod.string().optional(),

package/Types/Monitor/CriteriaIncident.ts

@@ -1,6 +1,11 @@
 import ObjectID from "../ObjectID";
 import Zod, { ZodSchema } from "../../Utils/Schema/Zod";
 
+export interface IncidentMemberRoleAssignment {
+  roleId: ObjectID;
+  userId: ObjectID;
+}
+
 export interface CriteriaIncident {
   title: string;
   description: string;
@@ -9,6 +14,10 @@ export interface CriteriaIncident {
   remediationNotes?: string | undefined;
   id: string;
   onCallPolicyIds?: Array<ObjectID> | undefined;
+  labelIds?: Array<ObjectID> | undefined;
+  ownerTeamIds?: Array<ObjectID> | undefined;
+  ownerUserIds?: Array<ObjectID> | undefined;
+  incidentMemberRoles?: Array<IncidentMemberRoleAssignment> | undefined;
 }
 
 export const CriteriaIncidentSchema: ZodSchema = Zod.object({
@@ -19,4 +28,13 @@ export const CriteriaIncidentSchema: ZodSchema = Zod.object({
   remediationNotes: Zod.string().optional(),
   id: Zod.string(),
   onCallPolicyIds: Zod.array(Zod.any()).optional(),
+  labelIds: Zod.array(Zod.any()).optional(),
+  ownerTeamIds: Zod.array(Zod.any()).optional(),
+  ownerUserIds: Zod.array(Zod.any()).optional(),
+  incidentMemberRoles: Zod.array(
+    Zod.object({
+      roleId: Zod.any(),
+      userId: Zod.any(),
+    }),
+  ).optional(),
 });

package/Types/Monitor/MonitorCriteriaInstance.ts

@@ -367,6 +367,33 @@ export default class MonitorCriteriaInstance extends DatabaseProperty {
       return monitorCriteriaInstance;
     }
 
+    if (arg.monitorType === MonitorType.SNMP) {
+      const monitorCriteriaInstance: MonitorCriteriaInstance =
+        new MonitorCriteriaInstance();
+
+      monitorCriteriaInstance.data = {
+        id: ObjectID.generate().toString(),
+        monitorStatusId: arg.monitorStatusId,
+        filterCondition: FilterCondition.All,
+        filters: [
+          {
+            checkOn: CheckOn.SnmpIsOnline,
+            filterType: FilterType.True,
+            value: undefined,
+          },
+        ],
+        incidents: [],
+        alerts: [],
+        createAlerts: false,
+        changeMonitorStatus: true,
+        createIncidents: false,
+        name: `Check if ${arg.monitorName} is online`,
+        description: `This criteria checks if the ${arg.monitorName} SNMP device is online`,
+      };
+
+      return monitorCriteriaInstance;
+    }
+
     return null;
   }
 
@@ -428,6 +455,46 @@ export default class MonitorCriteriaInstance extends DatabaseProperty {
       };
     }
 
+    if (arg.monitorType === MonitorType.SNMP) {
+      monitorCriteriaInstance.data = {
+        id: ObjectID.generate().toString(),
+        monitorStatusId: arg.monitorStatusId,
+        filterCondition: FilterCondition.Any,
+        filters: [
+          {
+            checkOn: CheckOn.SnmpIsOnline,
+            filterType: FilterType.False,
+            value: undefined,
+          },
+        ],
+        incidents: [
+          {
+            title: `${arg.monitorName} is offline`,
+            description: `${arg.monitorName} SNMP device is currently offline.`,
+            incidentSeverityId: arg.incidentSeverityId,
+            autoResolveIncident: true,
+            id: ObjectID.generate().toString(),
+            onCallPolicyIds: [],
+          },
+        ],
+        changeMonitorStatus: true,
+        createIncidents: true,
+        createAlerts: false,
+        alerts: [
+          {
+            title: `${arg.monitorName} is offline`,
+            description: `${arg.monitorName} SNMP device is currently offline.`,
+            alertSeverityId: arg.alertSeverityId,
+            autoResolveAlert: true,
+            id: ObjectID.generate().toString(),
+            onCallPolicyIds: [],
+          },
+        ],
+        name: `Check if ${arg.monitorName} is offline`,
+        description: `This criteria checks if the ${arg.monitorName} SNMP device is offline`,
+      };
+    }
+
     if (
       arg.monitorType === MonitorType.API ||
       arg.monitorType === MonitorType.Website

package/Types/Monitor/MonitorStep.ts

@@ -26,6 +26,9 @@ import MonitorStepMetricMonitor, {
 import MonitorStepExceptionMonitor, {
   MonitorStepExceptionMonitorUtil,
 } from "./MonitorStepExceptionMonitor";
+import MonitorStepSnmpMonitor, {
+  MonitorStepSnmpMonitorUtil,
+} from "./MonitorStepSnmpMonitor";
 import Zod, { ZodSchema } from "../../Utils/Schema/Zod";
 
 export interface MonitorStepType {
@@ -66,6 +69,9 @@ export interface MonitorStepType {
 
   // Exception monitor
   exceptionMonitor?: MonitorStepExceptionMonitor | undefined;
+
+  // SNMP monitor
+  snmpMonitor?: MonitorStepSnmpMonitor | undefined;
 }
 
 export default class MonitorStep extends DatabaseProperty {
@@ -91,6 +97,7 @@ export default class MonitorStep extends DatabaseProperty {
       traceMonitor: undefined,
       metricMonitor: undefined,
       exceptionMonitor: undefined,
+      snmpMonitor: undefined,
     };
   }
 
@@ -121,6 +128,7 @@ export default class MonitorStep extends DatabaseProperty {
       traceMonitor: undefined,
       metricMonitor: undefined,
       exceptionMonitor: undefined,
+      snmpMonitor: undefined,
     };
 
     return monitorStep;
@@ -211,6 +219,11 @@ export default class MonitorStep extends DatabaseProperty {
     return this;
   }
 
+  public setSnmpMonitor(snmpMonitor: MonitorStepSnmpMonitor): MonitorStep {
+    this.data!.snmpMonitor = snmpMonitor;
+    return this;
+  }
+
   public setCustomCode(customCode: string): MonitorStep {
     this.data!.customCode = customCode;
     return this;
@@ -302,6 +315,23 @@ export default class MonitorStep extends DatabaseProperty {
       return "Port is required";
     }
 
+    if (monitorType === MonitorType.SNMP) {
+      if (!value.data.snmpMonitor) {
+        return "SNMP configuration is required";
+      }
+
+      if (!value.data.snmpMonitor.hostname) {
+        return "SNMP hostname is required";
+      }
+
+      if (
+        !value.data.snmpMonitor.oids ||
+        value.data.snmpMonitor.oids.length === 0
+      ) {
+        return "At least one OID is required";
+      }
+    }
+
     return null;
   }
 
@@ -344,6 +374,9 @@ export default class MonitorStep extends DatabaseProperty {
                   MonitorStepExceptionMonitorUtil.getDefault(),
               )
             : undefined,
+          snmpMonitor: this.data.snmpMonitor
+            ? MonitorStepSnmpMonitorUtil.toJSON(this.data.snmpMonitor)
+            : undefined,
         },
       });
     }
@@ -446,6 +479,9 @@ export default class MonitorStep extends DatabaseProperty {
       exceptionMonitor: json["exceptionMonitor"]
         ? (json["exceptionMonitor"] as JSONObject)
         : undefined,
+      snmpMonitor: json["snmpMonitor"]
+        ? (json["snmpMonitor"] as JSONObject)
+        : undefined,
     }) as any;
 
     return monitorStep;
@@ -470,6 +506,7 @@ export default class MonitorStep extends DatabaseProperty {
         logMonitor: Zod.any().optional(),
         traceMonitor: Zod.any().optional(),
         metricMonitor: Zod.any().optional(),
+        snmpMonitor: Zod.any().optional(),
       }).openapi({
         type: "object",
         example: {

package/Types/Monitor/MonitorStepSnmpMonitor.ts

@@ -0,0 +1,102 @@
+import { JSONObject } from "../JSON";
+import SnmpOid from "./SnmpMonitor/SnmpOid";
+import SnmpV3Auth from "./SnmpMonitor/SnmpV3Auth";
+import SnmpVersion from "./SnmpMonitor/SnmpVersion";
+import SnmpSecurityLevel from "./SnmpMonitor/SnmpSecurityLevel";
+import SnmpAuthProtocol from "./SnmpMonitor/SnmpAuthProtocol";
+import SnmpPrivProtocol from "./SnmpMonitor/SnmpPrivProtocol";
+
+export default interface MonitorStepSnmpMonitor {
+  snmpVersion: SnmpVersion;
+  hostname: string;
+  port: number;
+  communityString?: string | undefined;
+  snmpV3Auth?: SnmpV3Auth | undefined;
+  oids: Array<SnmpOid>;
+  timeout: number;
+  retries: number;
+}
+
+export class MonitorStepSnmpMonitorUtil {
+  public static getDefault(): MonitorStepSnmpMonitor {
+    return {
+      snmpVersion: SnmpVersion.V2c,
+      hostname: "",
+      port: 161,
+      communityString: "public",
+      oids: [],
+      timeout: 5000,
+      retries: 3,
+    };
+  }
+
+  public static fromJSON(json: JSONObject): MonitorStepSnmpMonitor {
+    return {
+      snmpVersion: (json["snmpVersion"] as SnmpVersion) || SnmpVersion.V2c,
+      hostname: (json["hostname"] as string) || "",
+      port: (json["port"] as number) || 161,
+      communityString: (json["communityString"] as string) || undefined,
+      snmpV3Auth: json["snmpV3Auth"]
+        ? MonitorStepSnmpMonitorUtil.parseSnmpV3Auth(
+            json["snmpV3Auth"] as JSONObject,
+          )
+        : undefined,
+      oids: MonitorStepSnmpMonitorUtil.parseOids(
+        (json["oids"] as Array<JSONObject>) || [],
+      ),
+      timeout: (json["timeout"] as number) || 5000,
+      retries: (json["retries"] as number) || 3,
+    };
+  }
+
+  private static parseSnmpV3Auth(json: JSONObject): SnmpV3Auth {
+    return {
+      securityLevel:
+        (json["securityLevel"] as SnmpSecurityLevel) ||
+        SnmpSecurityLevel.NoAuthNoPriv,
+      username: (json["username"] as string) || "",
+      authProtocol: (json["authProtocol"] as SnmpAuthProtocol) || undefined,
+      authKey: (json["authKey"] as string) || undefined,
+      privProtocol: (json["privProtocol"] as SnmpPrivProtocol) || undefined,
+      privKey: (json["privKey"] as string) || undefined,
+    };
+  }
+
+  private static parseOids(oids: Array<JSONObject>): Array<SnmpOid> {
+    return oids.map((oid: JSONObject) => {
+      return {
+        oid: (oid["oid"] as string) || "",
+        name: (oid["name"] as string) || undefined,
+        description: (oid["description"] as string) || undefined,
+      };
+    });
+  }
+
+  public static toJSON(monitor: MonitorStepSnmpMonitor): JSONObject {
+    return {
+      snmpVersion: monitor.snmpVersion,
+      hostname: monitor.hostname,
+      port: monitor.port,
+      communityString: monitor.communityString,
+      snmpV3Auth: monitor.snmpV3Auth
+        ? {
+            securityLevel: monitor.snmpV3Auth.securityLevel,
+            username: monitor.snmpV3Auth.username,
+            authProtocol: monitor.snmpV3Auth.authProtocol,
+            authKey: monitor.snmpV3Auth.authKey,
+            privProtocol: monitor.snmpV3Auth.privProtocol,
+            privKey: monitor.snmpV3Auth.privKey,
+          }
+        : undefined,
+      oids: monitor.oids.map((oid: SnmpOid) => {
+        return {
+          oid: oid.oid,
+          name: oid.name,
+          description: oid.description,
+        };
+      }),
+      timeout: monitor.timeout,
+      retries: monitor.retries,
+    };
+  }
+}