@ampsec/platform-client 87.5.2 → 87.6.1

package/build/src/dto/platform/platform.flows.dto.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { FlowSpecStatusKind } from '../flows.dto';
-export declare const _PlatformFlowSpecUpsertDto: z.ZodObject<z.objectUtil.extendShape<Omit<z.objectUtil.extendShape<{
+export declare const _PlatformFlowSpecUpsertDto: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<Omit<z.objectUtil.extendShape<{
     id: z.ZodString;
     createdAt: z.ZodString;
     updatedAt: z.ZodString;
@@ -121,6 +121,16 @@ export declare const _PlatformFlowSpecUpsertDto: z.ZodObject<z.objectUtil.extend
         value?: number | undefined;
         units?: string | undefined;
     }>>;
+    skipWaitingPeriod: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        ignoreBusinessHours: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        ignoreBusinessHours: boolean;
+    }, {
+        enabled: boolean;
+        ignoreBusinessHours?: boolean | undefined;
+    }>>;
     training: z.ZodOptional<z.ZodObject<{
         subject: z.ZodOptional<z.ZodString>;
         context: z.ZodOptional<z.ZodString>;
@@ -862,6 +872,416 @@ export declare const _PlatformFlowSpecUpsertDto: z.ZodObject<z.objectUtil.extend
         value?: number | undefined;
         units?: string | undefined;
     } | undefined;
+    skipWaitingPeriod?: {
+        enabled: boolean;
+        ignoreBusinessHours: boolean;
+    } | undefined;
+    training?: {
+        context?: string | undefined;
+        subject?: string | undefined;
+    } | undefined;
+    triage?: {
+        message: string;
+        yesAction: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        };
+        noAction: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        };
+    } | undefined;
+    reminderInterval?: {
+        minutes: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    } | undefined;
+    escalation?: {
+        interval: {
+            minutes: number;
+            value?: number | undefined;
+            units?: string | undefined;
+        };
+        engagementChannelConnectorIds: string[];
+        redirection?: {
+            kind: import("../flows.dto").EngagementRedirectionKind.SLACK_CHANNEL;
+            channelId: string;
+            includeUser: boolean;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.TEAMS_CHANNEL;
+            channelId: string;
+            includeUser: boolean;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.EMAIL_CHANNEL;
+            channelId: string;
+            includeUser: boolean;
+        } | undefined;
+    } | undefined;
+    escalationToManager?: {
+        interval: {
+            minutes: number;
+            value?: number | undefined;
+            units?: string | undefined;
+        };
+        engagementChannelConnectorIds: string[];
+        redirection?: {
+            kind: import("../flows.dto").EngagementRedirectionKind.SLACK_CHANNEL;
+            channelId: string;
+            includeUser: boolean;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.TEAMS_CHANNEL;
+            channelId: string;
+            includeUser: boolean;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.EMAIL_CHANNEL;
+            channelId: string;
+            includeUser: boolean;
+        } | undefined;
+    } | undefined;
+    rewards?: {
+        minutes: number;
+        isUpperBound: boolean;
+        points: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    }[] | undefined;
+    customMessage?: {
+        template?: string | undefined;
+        append?: boolean | undefined;
+    } | undefined;
+    prependCustomMessage?: {
+        template?: string | undefined;
+    } | undefined;
+    messageTitle?: string | undefined;
+    additionalContext?: {
+        data?: string | undefined;
+    } | undefined;
+    securityTip?: {
+        subject?: import("../flows.dto").SecurityTipSubject | undefined;
+        isConfigured?: boolean | undefined;
+    } | undefined;
+    scheduleConfig?: {
+        required: boolean;
+    } | undefined;
+}, {
+    filter: {
+        cohorts: ({
+            inclusive: boolean;
+            value: string;
+            id: string;
+            displayValue: string;
+            kind: import("../flows.dto").CohortKind;
+        } | undefined)[];
+        custom?: Record<string, unknown> | undefined;
+    };
+    name: string;
+    status: FlowSpecStatusKind;
+    description: string;
+    tid: string;
+    triggerFilter: {
+        trigger: {
+            id: string;
+            displayValue: string;
+            eventType: string;
+            cid?: string | undefined;
+        }[];
+        custom?: Record<string, unknown> | undefined;
+    };
+    engagementChannelCids: string[];
+    id?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    deletedAt?: string | null | undefined;
+    actions?: {
+        includeInstructions?: boolean | undefined;
+        getInstructionsAction?: {
+            includeCustomInstructions?: boolean | undefined;
+            customInstructions?: string | undefined;
+            includeOnlyCustomInstructions?: boolean | undefined;
+        } | undefined;
+        includeMarkComplete?: boolean | undefined;
+        expirationActionId?: string | undefined;
+        expirationAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        simpleTriageYesActId?: string | undefined;
+        simpleTriageNoActId?: string | undefined;
+        resolveNowActionId?: string | undefined;
+        resolveNowAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        scheduleResolutionAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        launchAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        launchActionsV2?: {
+            id: string;
+            actions: {
+                actionId: string | null;
+            }[];
+            findingStatus: import("..").FindingStatus | null;
+        } | undefined;
+        actionButtons?: {
+            id: string;
+            actions: {
+                actionId: string | null;
+            }[];
+            findingStatus: import("..").FindingStatus | null;
+            actionLabel: string;
+        }[] | undefined;
+    } | undefined;
+    redirection?: {
+        kind: import("../flows.dto").EngagementRedirectionKind.SLACK_CHANNEL;
+        channelId: string;
+        includeUser?: boolean | undefined;
+    } | {
+        kind: import("../flows.dto").EngagementRedirectionKind.TEAMS_CHANNEL;
+        channelId: string;
+        includeUser?: boolean | undefined;
+    } | {
+        kind: import("../flows.dto").EngagementRedirectionKind.EMAIL_CHANNEL;
+        channelId: string;
+        includeUser?: boolean | undefined;
+    } | undefined;
+    fslStrategy?: "STANDARD" | undefined;
+    tone?: {
+        kind?: string | undefined;
+    } | undefined;
+    targetResolution?: {
+        minutes: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    } | undefined;
+    delayEngagement?: {
+        minutes: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    } | undefined;
+    skipWaitingPeriod?: {
+        enabled: boolean;
+        ignoreBusinessHours?: boolean | undefined;
+    } | undefined;
+    training?: {
+        context?: string | undefined;
+        subject?: string | undefined;
+    } | undefined;
+    triage?: {
+        message: string;
+        yesAction: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        };
+        noAction: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        };
+    } | undefined;
+    reminderInterval?: {
+        minutes: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    } | undefined;
+    escalation?: {
+        interval: {
+            minutes: number;
+            value?: number | undefined;
+            units?: string | undefined;
+        };
+        engagementChannelConnectorIds: string[];
+        redirection?: {
+            kind: import("../flows.dto").EngagementRedirectionKind.SLACK_CHANNEL;
+            channelId: string;
+            includeUser?: boolean | undefined;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.TEAMS_CHANNEL;
+            channelId: string;
+            includeUser?: boolean | undefined;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.EMAIL_CHANNEL;
+            channelId: string;
+            includeUser?: boolean | undefined;
+        } | undefined;
+    } | undefined;
+    escalationToManager?: {
+        interval: {
+            minutes: number;
+            value?: number | undefined;
+            units?: string | undefined;
+        };
+        engagementChannelConnectorIds: string[];
+        redirection?: {
+            kind: import("../flows.dto").EngagementRedirectionKind.SLACK_CHANNEL;
+            channelId: string;
+            includeUser?: boolean | undefined;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.TEAMS_CHANNEL;
+            channelId: string;
+            includeUser?: boolean | undefined;
+        } | {
+            kind: import("../flows.dto").EngagementRedirectionKind.EMAIL_CHANNEL;
+            channelId: string;
+            includeUser?: boolean | undefined;
+        } | undefined;
+    } | undefined;
+    rewards?: {
+        minutes: number;
+        isUpperBound: boolean;
+        points: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    }[] | undefined;
+    customMessage?: {
+        template?: string | undefined;
+        append?: boolean | undefined;
+    } | undefined;
+    prependCustomMessage?: {
+        template?: string | undefined;
+    } | undefined;
+    messageTitle?: string | undefined;
+    additionalContext?: {
+        data?: string | undefined;
+    } | undefined;
+    securityTip?: {
+        subject?: import("../flows.dto").SecurityTipSubject | undefined;
+        isConfigured?: boolean | undefined;
+    } | undefined;
+    scheduleConfig?: {
+        required: boolean;
+    } | undefined;
+}>, {
+    filter: {
+        cohorts: ({
+            inclusive: boolean;
+            value: string;
+            id: string;
+            displayValue: string;
+            kind: import("../flows.dto").CohortKind;
+        } | undefined)[];
+        custom?: Record<string, unknown> | undefined;
+    };
+    name: string;
+    status: FlowSpecStatusKind;
+    description: string;
+    tid: string;
+    fslStrategy: "STANDARD";
+    triggerFilter: {
+        trigger: {
+            id: string;
+            displayValue: string;
+            eventType: string;
+            cid?: string | undefined;
+        }[];
+        custom?: Record<string, unknown> | undefined;
+    };
+    engagementChannelCids: string[];
+    id?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    deletedAt?: string | null | undefined;
+    actions?: {
+        includeInstructions?: boolean | undefined;
+        getInstructionsAction?: {
+            includeCustomInstructions?: boolean | undefined;
+            customInstructions?: string | undefined;
+            includeOnlyCustomInstructions?: boolean | undefined;
+        } | undefined;
+        includeMarkComplete?: boolean | undefined;
+        expirationActionId?: string | undefined;
+        expirationAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        simpleTriageYesActId?: string | undefined;
+        simpleTriageNoActId?: string | undefined;
+        resolveNowActionId?: string | undefined;
+        resolveNowAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        scheduleResolutionAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        launchAction?: {
+            actionId: string | null;
+            findingStatus?: import("..").FindingStatus | null | undefined;
+            responseMessage?: string | undefined;
+            actionDescriptionContext?: string | undefined;
+        } | undefined;
+        launchActionsV2?: {
+            id: string;
+            actions: {
+                actionId: string | null;
+            }[];
+            findingStatus: import("..").FindingStatus | null;
+        } | undefined;
+        actionButtons?: {
+            id: string;
+            actions: {
+                actionId: string | null;
+            }[];
+            findingStatus: import("..").FindingStatus | null;
+            actionLabel: string;
+        }[] | undefined;
+    } | undefined;
+    redirection?: {
+        kind: import("../flows.dto").EngagementRedirectionKind.SLACK_CHANNEL;
+        channelId: string;
+        includeUser: boolean;
+    } | {
+        kind: import("../flows.dto").EngagementRedirectionKind.TEAMS_CHANNEL;
+        channelId: string;
+        includeUser: boolean;
+    } | {
+        kind: import("../flows.dto").EngagementRedirectionKind.EMAIL_CHANNEL;
+        channelId: string;
+        includeUser: boolean;
+    } | undefined;
+    tone?: {
+        kind?: string | undefined;
+    } | undefined;
+    targetResolution?: {
+        minutes: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    } | undefined;
+    delayEngagement?: {
+        minutes: number;
+        value?: number | undefined;
+        units?: string | undefined;
+    } | undefined;
+    skipWaitingPeriod?: {
+        enabled: boolean;
+        ignoreBusinessHours: boolean;
+    } | undefined;
     training?: {
         context?: string | undefined;
         subject?: string | undefined;
@@ -1061,6 +1481,10 @@ export declare const _PlatformFlowSpecUpsertDto: z.ZodObject<z.objectUtil.extend
         value?: number | undefined;
         units?: string | undefined;
     } | undefined;
+    skipWaitingPeriod?: {
+        enabled: boolean;
+        ignoreBusinessHours?: boolean | undefined;
+    } | undefined;
     training?: {
         context?: string | undefined;
         subject?: string | undefined;
@@ -1275,6 +1699,16 @@ export declare const _PlatformFlowSpecDto: z.ZodObject<z.objectUtil.extendShape<
         value?: number | undefined;
         units?: string | undefined;
     }>>;
+    skipWaitingPeriod: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        ignoreBusinessHours: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        ignoreBusinessHours: boolean;
+    }, {
+        enabled: boolean;
+        ignoreBusinessHours?: boolean | undefined;
+    }>>;
     training: z.ZodOptional<z.ZodObject<{
         subject: z.ZodOptional<z.ZodString>;
         context: z.ZodOptional<z.ZodString>;
@@ -2011,6 +2445,10 @@ export declare const _PlatformFlowSpecDto: z.ZodObject<z.objectUtil.extendShape<
         value?: number | undefined;
         units?: string | undefined;
     } | undefined;
+    skipWaitingPeriod?: {
+        enabled: boolean;
+        ignoreBusinessHours: boolean;
+    } | undefined;
     training?: {
         context?: string | undefined;
         subject?: string | undefined;
@@ -2218,6 +2656,10 @@ export declare const _PlatformFlowSpecDto: z.ZodObject<z.objectUtil.extendShape<
         value?: number | undefined;
         units?: string | undefined;
     } | undefined;
+    skipWaitingPeriod?: {
+        enabled: boolean;
+        ignoreBusinessHours?: boolean | undefined;
+    } | undefined;
     training?: {
         context?: string | undefined;
         subject?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "87.5.2",
+  "version": "87.6.1",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/dto/enums/category.ts

@@ -19,4 +19,5 @@ export enum Category {
   COMPLIANCE_TRAINING = 'COMPLIANCE_TRAINING',
   AI_SERVICE_RISK = 'AI_SERVICE_RISK',
   NEW_HIRE = 'NEW_HIRE',
+  ATTRIBUTION = 'ATTRIBUTION',
 }

package/src/dto/enums/findingBuckets.ts

@@ -27,6 +27,10 @@ export const FINDING_BUCKET_KEYS = {
    * AI SERVICE RISK
    */
   AI_SERVICE_RISK: 'AI_SERVICE_RISK',
+  /**
+   * ATTRIBUTION (e.g. Axonius)
+   */
+  ATTRIBUTION: 'ATTRIBUTION',
   /**
    * OTHER
    */

package/src/dto/enums/findingKind.ts

@@ -67,6 +67,9 @@ export enum FindingKind {
 
   // NEW_HIRE
   NEW_HIRE = 'NEW_HIRE',
+
+  // ATTRIBUTION (e.g. Axonius; extend with specific kinds as needed)
+  ATTRIBUTION = 'ATTRIBUTION',
 }
 
 export const lookupFindingOutcomeByKind = (kind: FindingKind): FindingOutcome => {
@@ -115,6 +118,7 @@ export const lookupFindingOutcomeByKind = (kind: FindingKind): FindingOutcome =>
     case FindingKind.AI_SERVICE_UNTRACKED:
     case FindingKind.AI_SERVICE_UNAPPROVED:
     case FindingKind.NEW_HIRE:
+    case FindingKind.ATTRIBUTION:
     default: {
       return FindingOutcome.REMEDIATION;
     }
@@ -179,6 +183,9 @@ export const lookupFindingKindByCategory = (category: string): FindingKind[] =>
     case Category.NEW_HIRE: {
       return [FindingKind.NEW_HIRE];
     }
+    case Category.ATTRIBUTION: {
+      return [FindingKind.ATTRIBUTION];
+    }
     default: {
       return [];
     }
@@ -232,6 +239,7 @@ export const lookupFindingSeverityByKind = (kind: string): FindingSeverity | und
     case FindingKind.AI_SERVICE_UNAPPROVED:
       return FindingSeverity.HIGH;
     case FindingKind.NEW_HIRE:
+    case FindingKind.ATTRIBUTION:
       return FindingSeverity.INFO;
     default:
       return undefined;
@@ -366,6 +374,14 @@ export const lookupFindingScoreByCategoryKindAndSeverity = (category: Category,
           return 0;
       }
     }
+    case Category.ATTRIBUTION: {
+      switch (kind) {
+        case FindingKind.ATTRIBUTION:
+          return 2;
+        default:
+          return 0;
+      }
+    }
 
     default: {
       return 0;
@@ -389,6 +405,8 @@ export const lookupFindingDisplayValueByKind = (kind: string): string => {
       return 'ai_service_unapproved';
     case FindingKind.NEW_HIRE:
       return 'new_hire';
+    case FindingKind.ATTRIBUTION:
+      return 'attribution';
     default:
       return kind.toLowerCase();
   }
@@ -442,6 +460,8 @@ export const lookupFindingDescriptionByKind = (kind: string): string => {
       return 'Detected use of an AI service that has not been approved';
     case FindingKind.NEW_HIRE:
       return 'New hire employee detected';
+    case FindingKind.ATTRIBUTION:
+      return 'Attribution or coverage gap detected for a user or device';
     default:
       return '';
   }
@@ -633,6 +653,9 @@ export const generateInsights = (category: string, kind: string) => {
     case FindingKind.NEW_HIRE:
       rule.kind = SaasComponentKind.NEW_HIRE;
       break;
+    case FindingKind.ATTRIBUTION:
+      rule.kind = SaasComponentKind.ATTRIBUTION;
+      break;
     default:
       break;
   }

package/src/dto/enums/saasComponentKind.ts

@@ -52,4 +52,8 @@ export enum SaasComponentKind {
   // NEW HIRE
   // ********
   NEW_HIRE = 'NEW_HIRE',
+
+  // ATTRIBUTION (e.g. Axonius)
+  // *************************
+  ATTRIBUTION = 'ATTRIBUTION',
 }

package/src/dto/flows.dto.ts

@@ -300,6 +300,12 @@ export const _FlowSpecDto = _BaseDto.merge(
     tone: _FlowTone.optional(),
     targetResolution: _FlowInterval.optional(),
     delayEngagement: _FlowInterval.optional(),
+    skipWaitingPeriod: z
+      .object({
+        enabled: z.boolean(),
+        ignoreBusinessHours: z.boolean().default(true),
+      })
+      .optional(),
     training: z.object({subject: z.string().optional(), context: z.string().optional()}).optional(),
     triage: z.object({message: z.string(), yesAction: _FlowActionDetails, noAction: _FlowActionDetails}).optional(),
     reminderInterval: _FlowInterval.optional(),
@@ -331,7 +337,18 @@ export const _FlowSpecDto = _BaseDto.merge(
 );
 export type FlowSpecDto = z.infer<typeof _FlowSpecDto>;
 
-export const _FlowSpecUpsertDto = _FlowSpecDto.omit({activity: true}).merge(_BaseUpsertDto);
+export const _FlowSpecUpsertDto = _FlowSpecDto
+  .omit({activity: true})
+  .merge(_BaseUpsertDto)
+  .superRefine((dto, ctx) => {
+    if (dto.delayEngagement && dto.skipWaitingPeriod?.enabled) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        path: ['skipWaitingPeriod'],
+        message: 'skipWaitingPeriod cannot be enabled when delayEngagement is set',
+      });
+    }
+  });
 export type FlowSpecUpsertDto = z.infer<typeof _FlowSpecUpsertDto>;
 
 export const _FlowSpecFilter = _FlowSpecDto.omit({triggerFilter: true, filter: true}).partial().merge(_PaginationFilter).merge(_SortFilter);