@ampsec/platform-client 40.1.0 → 41.0.0

package/build/src/dto/enums/{notification.kind.d.ts → contentStrategy.kind.d.ts}

@@ -1,4 +1,4 @@
-export declare enum NotificationKind {
+export declare enum ContentStrategyKind {
     LLM = "LLM",
     RAW = "RAW",
     TEMPLATE = "TEMPLATE"

package/build/src/dto/enums/contentStrategy.kind.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentStrategyKind = void 0;
+/* eslint-disable no-unused-vars */
+var ContentStrategyKind;
+(function (ContentStrategyKind) {
+    ContentStrategyKind["LLM"] = "LLM";
+    ContentStrategyKind["RAW"] = "RAW";
+    ContentStrategyKind["TEMPLATE"] = "TEMPLATE";
+})(ContentStrategyKind || (exports.ContentStrategyKind = ContentStrategyKind = {}));
+//# sourceMappingURL=contentStrategy.kind.js.map

package/build/src/dto/enums/contentStrategy.kind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentStrategy.kind.js","sourceRoot":"","sources":["../../../../src/dto/enums/contentStrategy.kind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,kCAAW,CAAA;IACX,4CAAqB,CAAA;AACvB,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B"}

package/build/src/dto/enums/deliveryStrategy.kind.d.ts

@@ -0,0 +1,4 @@
+export declare enum DeliveryStrategyKind {
+    EMAIL = "EMAIL",
+    SLACK = "SLACK"
+}

package/build/src/dto/enums/deliveryStrategy.kind.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeliveryStrategyKind = void 0;
+/* eslint-disable no-unused-vars */
+var DeliveryStrategyKind;
+(function (DeliveryStrategyKind) {
+    DeliveryStrategyKind["EMAIL"] = "EMAIL";
+    DeliveryStrategyKind["SLACK"] = "SLACK";
+})(DeliveryStrategyKind || (exports.DeliveryStrategyKind = DeliveryStrategyKind = {}));
+//# sourceMappingURL=deliveryStrategy.kind.js.map

package/build/src/dto/enums/deliveryStrategy.kind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deliveryStrategy.kind.js","sourceRoot":"","sources":["../../../../src/dto/enums/deliveryStrategy.kind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,uCAAe,CAAA;AACjB,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B"}

package/build/src/dto/enums/index.d.ts

@@ -12,4 +12,5 @@ export * from './notification.status';
 export * from './riskContributor.type';
 export * from './saasComponentKind';
 export * from './workflowStep.kind';
-export * from './notification.kind';
+export * from './contentStrategy.kind';
+export * from './deliveryStrategy.kind';

package/build/src/dto/enums/index.js

@@ -28,5 +28,6 @@ __exportStar(require("./notification.status"), exports);
 __exportStar(require("./riskContributor.type"), exports);
 __exportStar(require("./saasComponentKind"), exports);
 __exportStar(require("./workflowStep.kind"), exports);
-__exportStar(require("./notification.kind"), exports);
+__exportStar(require("./contentStrategy.kind"), exports);
+__exportStar(require("./deliveryStrategy.kind"), exports);
 //# sourceMappingURL=index.js.map

package/build/src/dto/enums/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,wDAAsC;AACtC,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,wDAAsC;AACtC,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,0DAAwC"}

package/build/src/dto/enums/requiredDataProperty.enum.d.ts

@@ -0,0 +1,8 @@
+export declare enum RequiredDataProperty {
+    DEVICE_NAME = "DEVICE_NAME",
+    DURATION = "DURATION",
+    ENROLL_DATE = "ENROLL_DATE",
+    SOFTWARE_NAME = "SOFTWARE_NAME",
+    START_DATE = "START_DATE",
+    TITLE = "TITLE"
+}

package/build/src/dto/enums/requiredDataProperty.enum.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequiredDataProperty = void 0;
+/* eslint-disable no-unused-vars */
+var RequiredDataProperty;
+(function (RequiredDataProperty) {
+    RequiredDataProperty["DEVICE_NAME"] = "DEVICE_NAME";
+    RequiredDataProperty["DURATION"] = "DURATION";
+    RequiredDataProperty["ENROLL_DATE"] = "ENROLL_DATE";
+    RequiredDataProperty["SOFTWARE_NAME"] = "SOFTWARE_NAME";
+    RequiredDataProperty["START_DATE"] = "START_DATE";
+    RequiredDataProperty["TITLE"] = "TITLE";
+})(RequiredDataProperty || (exports.RequiredDataProperty = RequiredDataProperty = {}));
+//# sourceMappingURL=requiredDataProperty.enum.js.map

package/build/src/dto/enums/requiredDataProperty.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requiredDataProperty.enum.js","sourceRoot":"","sources":["../../../../src/dto/enums/requiredDataProperty.enum.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,mDAA2B,CAAA;IAC3B,6CAAqB,CAAA;IACrB,mDAA2B,CAAA;IAC3B,uDAA+B,CAAA;IAC/B,iDAAyB,CAAA;IACzB,uCAAe,CAAA;AACjB,CAAC,EAPW,oBAAoB,oCAApB,oBAAoB,QAO/B"}

package/build/src/dto/notification.dto.d.ts

@@ -1,18 +1,9 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
-import { NotificationStatus } from './enums';
-import { NotificationKind } from './enums/notification.kind';
-import { NotificationStepData, TrainingNotificationStepData } from './workflow.dto';
-export type TemplateNotificationSchema = {
-    /** ID of the template to be used for the notification */
-    templateId: string;
-};
-export type RawNotificationSchema = {
-    /** Optional user provided notification message */
-    rawContent: string;
-};
+import { Category, DeliveryStrategyKind, FindingKind, FindingSeverity, NotificationStatus } from './enums';
+import { ContentStrategyKind } from './enums/contentStrategy.kind';
 export type NotificationAddress = {
     /** Connector ID for the notification channel */
-    cid: string;
+    cid?: string;
     /** Group IDs to which the notification is being sent */
     groups?: string[] | number[];
     /** User IDs to which the notification is being sent */
@@ -20,24 +11,77 @@ export type NotificationAddress = {
     /** Webhook URLs to which the notification is being sent */
     webhooks?: string[];
 };
+export type FindingNotificationContext = {
+    /** Severity of the finding */
+    severity: FindingSeverity;
+    /** Category of the finding */
+    category: Category;
+    /** Kind of the finding */
+    kind: FindingKind;
+};
+export type UserNotificationContext = {
+    /** First name of the user */
+    firstName: string;
+    /** Last name of the user */
+    lastName: string;
+    /** Title of the user */
+    title: string;
+    /** Department of the user */
+    department: string;
+};
+export type ProviderNotificationContext = {
+    /** Name of the provider */
+    displayValue: string;
+    /** Categories to which the provider applies */
+    categories: string[];
+};
+export type NotificationContext = {
+    finding?: FindingNotificationContext;
+    provider?: ProviderNotificationContext;
+    user?: UserNotificationContext;
+};
+export type ContentStrategySpecification = {
+    /** Kind of the content strategy */
+    kind: ContentStrategyKind;
+    /** Data to be used for the notification */
+    data?: {
+        [propName: string]: string | number | boolean;
+    };
+};
+export type TemplateContentStrategySpec = ContentStrategySpecification & {
+    /** ID of the template to be used for the notification */
+    templateId: string;
+    /** Context for the notification */
+    context: NotificationContext;
+};
+export type RawContentStrategySpec = ContentStrategySpecification & {
+    /** Content of the notification */
+    content: string;
+};
+export type LlmContentStrategySpec = ContentStrategySpecification & {
+    /** Context for the notification */
+    context: NotificationContext;
+};
+export type DeliveryStrategySpec = {
+    /** Channel type that should be used for sending the notificaiton */
+    kind: DeliveryStrategyKind;
+    /** Recipient address to which the notification is being sent */
+    to: NotificationAddress;
+};
 export type NotificationUpsertDto = BaseUpsertDto & {
-    /** Kind of the notification */
-    kind: NotificationKind;
     /** Workflow ID for which the notification is being created */
     wfid: string;
-    /** Finding ID for which the notification is being created */
-    fid?: string;
-    /** Recipient address to which the notification is being sent */
-    to: NotificationAddress;
-    /** ID of the user to which the notification is being sent */
-    uid?: string;
     /** Step number in the workflow for which the notification is being created */
     stepNumber: number;
     /** Status of the notification */
     status: NotificationStatus;
     /** Data to be used for the notification */
-    data: NotificationStepData | TrainingNotificationStepData;
-    /** Schema for the notification */
-    schema?: RawNotificationSchema | TemplateNotificationSchema;
+    contentStrategy: TemplateContentStrategySpec | RawContentStrategySpec | LlmContentStrategySpec;
+    /** Method of delivery */
+    deliveryStrategy: DeliveryStrategySpec;
+    /** Finding ID for which the notification is being created */
+    fid?: string | null;
+    /** ID of the user to which the notification is being sent */
+    uid?: string | null;
 };
 export type NotificationDto = NotificationUpsertDto & BaseDto;

package/build/src/dto/workflow.dto.d.ts

@@ -1,43 +1,43 @@
 import { BaseDto } from './base.dto';
-import { NotificationKind } from './enums';
+import { ContentStrategyKind, DeliveryStrategyKind } from './enums';
+import { RequiredDataProperty } from './enums/requiredDataProperty.enum';
 import { WorkflowStepKind } from './enums/workflowStep.kind';
 import { WorkflowTriggerKind } from './enums/workflowTrigger.kind';
-import { TemplateNotificationSchema, RawNotificationSchema } from './notification.dto';
-export type NotificationStepData = {
-    /** Name of the device to which the notification of finding applies */
-    deviceName: string | null;
-    /** Estimated time to remediate the finding, in minutes */
-    duration: number;
-    /** Name of the software to which the finding applies */
-    softwareName: string;
+export type WorflowStepDescriptor = {
+    /** Type of the notification step, either NOTIFICATION or PAUSE */
+    kind: WorkflowStepKind;
+    /** Optional default values to be used of no other is provided */
+    defaults?: {
+        [propName: string]: string | number | boolean;
+    };
+};
+export type NotificationStepDescriptor = WorflowStepDescriptor & {
+    /** Delivery strategy to be used for the notification */
+    deliveryStrategyKinds: DeliveryStrategyKind[];
+    /** Required data properties for the notification */
+    requiredData: RequiredDataProperty[];
+};
+export type PauseStepDescriptor = WorflowStepDescriptor & {
+    /** Duration, in days, to wait before executing the next step in the workflow */
+    pauseDuration: number;
 };
-export type TrainingNotificationStepData = NotificationStepData & {
-    /** Name of the training module to which the notification of finding applies */
-    title?: string;
-    /** Date on which the user enrolled in the training module */
-    enrollDate?: string;
-    /** Date on which the user started the training module */
-    startDate?: string;
+export type ContentDescriptor = {
+    /** Kind of the content that will be generated for the notification */
+    kind: ContentStrategyKind;
 };
-export type PauseStepData = {
-    /** Estimated duration, in minutes, to resolve the finding */
-    duration: number;
+export type TemplateContentDescriptor = ContentDescriptor & {
+    /** ID of the template to be used for the notification */
+    templateId: string;
 };
 export type WorkflowStep = {
-    /** Type of the notification step, either NOTIFICATION or PAUSE */
-    kind: WorkflowStepKind;
-    /** Kind of the notification */
-    notificationKind?: NotificationKind;
-    /** Schema for the notification step */
-    schema?: TemplateNotificationSchema | RawNotificationSchema;
-    /** Data associated with the notification step */
-    data: NotificationStepData | TrainingNotificationStepData | PauseStepData;
+    /** Indicates the type of workflow step and contains relevant information for each */
+    stepDescriptor: NotificationStepDescriptor | PauseStepDescriptor;
+    /** Content to be used for the notification */
+    contentDescriptor?: ContentDescriptor | TemplateContentDescriptor;
     /** Step number to transition the workflow to on success */
     successStepNumber: number | null;
     /** Step number to transition the workflow to on failure */
     failureStepNumber: number | null;
-    /** Duration, in days, to wait before executing the next step in the workflow */
-    pauseDuration?: number | null;
 };
 export type WorkflowSteps = {
     [propName: number]: WorkflowStep;
@@ -48,7 +48,7 @@ export type WorkflowTriggerRule = {
     } | WorkflowTriggerRule[];
 };
 export type WorkflowTrigger = {
-    /** Type of the trigger */
+    /** Kind of the trigger */
     kind: WorkflowTriggerKind;
     /** Rule to which the applicable entity type must conform to trigger the workflow */
     rule: unknown;

package/build/src/services/EngageApi.js

@@ -29,13 +29,13 @@ const UserIdentityService_1 = require("./rest/UserIdentityService");
  */
 class EngageApi {
     constructor(rest) {
-        this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.CONNECTORS, constants_1.TARGET_API_ENGAGE); // TODO: add /eng endpoint... needed?
+        this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.CONNECTORS, constants_1.TARGET_API_ENGAGE);
         this.findings = new data_service_1.AmpPatchDataServiceImpl(rest, constants_1.KIND.FINDINGS, constants_1.TARGET_API_ENGAGE);
         this.identity = new UserIdentityService_1.UserIdentityService(rest);
-        this.notifications = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.NOTIFICATIONS, constants_1.TARGET_API_ENGAGE); // TODO: add /eng endpoint
+        this.notifications = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.NOTIFICATIONS, constants_1.TARGET_API_ENGAGE);
         this.providers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.PROVIDERS, constants_1.TARGET_API_AGENT);
         this.reports = new reports_service_1.AmpReportServiceImpl(rest);
-        this.settings = new settings_service_1.AmpSettingsService(rest); // TODO: add /eng endpoint
+        this.settings = new settings_service_1.AmpSettingsService(rest); // TODO: confirm it is not needed. Currently returns NOT_IMPLEMENTED error code
     }
     static instance(options) {
         const rest = (0, rest_1.getAmpRestClient)(options);

package/build/src/services/EngageApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"EngageApi.js","sourceRoot":"","sources":["../../../src/services/EngageApi.ts"],"names":[],"mappings":";;;AACA,qDAAsD;AACtD,iDAAgH;AAChH,iCAA0E;AAC1E,2CAAsE;AACtE,uDAAyE;AACzE,yDAAsD;AACtD,oEAA+D;AAI/D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,SAAS;IASpB,YAAY,IAAgB;QAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,6BAAiB,CAAC,CAAC,CAAC,qCAAqC;QAC7J,IAAI,CAAC,QAAQ,GAAG,IAAI,sCAAuB,CAAqC,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,6BAAiB,CAAC,CAAC;QACxH,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,aAAa,EAAE,6BAAiB,CAAC,CAAC,CAAC,0BAA0B;QACrI,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,EAAE,4BAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B;IAC1E,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAyB;QACvC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AAvBD,8BAuBC"}
+{"version":3,"file":"EngageApi.js","sourceRoot":"","sources":["../../../src/services/EngageApi.ts"],"names":[],"mappings":";;;AACA,qDAAsD;AACtD,iDAAgH;AAChH,iCAA0E;AAC1E,2CAAsE;AACtE,uDAAyE;AACzE,yDAAsD;AACtD,oEAA+D;AAI/D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,SAAS;IASpB,YAAY,IAAgB;QAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,6BAAiB,CAAC,CAAC;QACvH,IAAI,CAAC,QAAQ,GAAG,IAAI,sCAAuB,CAAqC,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,6BAAiB,CAAC,CAAC;QACxH,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,aAAa,EAAE,6BAAiB,CAAC,CAAC;QAC1G,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,EAAE,4BAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,+EAA+E;IAC/H,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAyB;QACvC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AAvBD,8BAuBC"}

package/build/src/services/rest/AgentIdentityService.js

@@ -15,7 +15,7 @@ class AgentIdentityService {
         };
         this.me = async () => {
             const res = await this.rest.call({
-                url: '/api/v1/me',
+                url: '/me',
                 method: 'GET',
             });
             return res.data;

package/build/src/services/rest/AgentIdentityService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AgentIdentityService.js","sourceRoot":"","sources":["../../../../src/services/rest/AgentIdentityService.ts"],"names":[],"mappings":";;;AAOA,MAAa,oBAAoB;IAE/B,YAAY,IAAgB;QAG5B,kBAAa,GAAG,KAAK,EAAE,cAAsB,EAA0B,EAAE;YACvE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,6BAA6B;gBAClC,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE;oBACN,GAAG,EAAE,cAAc;iBACpB;aACF,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAqB,CAAC;QACnC,CAAC,CAAC;QAEF,OAAE,GAAG,KAAK,IAAuB,EAAE;YACjC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,YAAY;gBACjB,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAgB,CAAC;QAC9B,CAAC,CAAC;QAnBA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CAmBF;AAvBD,oDAuBC"}
+{"version":3,"file":"AgentIdentityService.js","sourceRoot":"","sources":["../../../../src/services/rest/AgentIdentityService.ts"],"names":[],"mappings":";;;AAOA,MAAa,oBAAoB;IAE/B,YAAY,IAAgB;QAG5B,kBAAa,GAAG,KAAK,EAAE,cAAsB,EAA0B,EAAE;YACvE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,6BAA6B;gBAClC,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE;oBACN,GAAG,EAAE,cAAc;iBACpB;aACF,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAqB,CAAC;QACnC,CAAC,CAAC;QAEF,OAAE,GAAG,KAAK,IAAuB,EAAE;YACjC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,KAAK;gBACV,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAgB,CAAC;QAC9B,CAAC,CAAC;QAnBA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CAmBF;AAvBD,oDAuBC"}

package/build/src/services/rest/UserIdentityService.js

@@ -5,7 +5,7 @@ class UserIdentityService {
     constructor(rest) {
         this.me = async () => {
             const res = await this.rest.call({
-                url: '/eng/v1/me',
+                url: '/me',
                 method: 'GET',
             });
             return res.data;

package/build/src/services/rest/UserIdentityService.js.map

@@ -1 +1 @@
-{"version":3,"file":"UserIdentityService.js","sourceRoot":"","sources":["../../../../src/services/rest/UserIdentityService.ts"],"names":[],"mappings":";;;AAOA,MAAa,mBAAmB;IAE9B,YAAY,IAAgB;QAG5B,OAAE,GAAG,KAAK,IAA0B,EAAE;YACpC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,YAAY;gBACjB,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAmB,CAAC;QACjC,CAAC,CAAC;QARA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CAQF;AAZD,kDAYC"}
+{"version":3,"file":"UserIdentityService.js","sourceRoot":"","sources":["../../../../src/services/rest/UserIdentityService.ts"],"names":[],"mappings":";;;AAOA,MAAa,mBAAmB;IAE9B,YAAY,IAAgB;QAG5B,OAAE,GAAG,KAAK,IAA0B,EAAE;YACpC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,KAAK;gBACV,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAmB,CAAC;QACjC,CAAC,CAAC;QARA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CAQF;AAZD,kDAYC"}

package/package.json

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

package/src/dto/enums/{notification.kind.ts → contentStrategy.kind.ts}

@@ -1,5 +1,5 @@
 /* eslint-disable no-unused-vars */
-export enum NotificationKind {
+export enum ContentStrategyKind {
   LLM = 'LLM',
   RAW = 'RAW',
   TEMPLATE = 'TEMPLATE',

package/src/dto/enums/deliveryStrategy.kind.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-unused-vars */
+export enum DeliveryStrategyKind {
+  EMAIL = 'EMAIL',
+  SLACK = 'SLACK',
+}

package/src/dto/enums/index.ts

@@ -12,4 +12,5 @@ export * from './notification.status';
 export * from './riskContributor.type';
 export * from './saasComponentKind';
 export * from './workflowStep.kind';
-export * from './notification.kind';
+export * from './contentStrategy.kind';
+export * from './deliveryStrategy.kind';

package/src/dto/enums/requiredDataProperty.enum.ts

@@ -0,0 +1,9 @@
+/* eslint-disable no-unused-vars */
+export enum RequiredDataProperty {
+  DEVICE_NAME = 'DEVICE_NAME',
+  DURATION = 'DURATION',
+  ENROLL_DATE = 'ENROLL_DATE',
+  SOFTWARE_NAME = 'SOFTWARE_NAME',
+  START_DATE = 'START_DATE',
+  TITLE = 'TITLE',
+}

package/src/dto/notification.dto.ts

@@ -1,21 +1,10 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
-import {NotificationStatus} from './enums';
-import {NotificationKind} from './enums/notification.kind';
-import {NotificationStepData, TrainingNotificationStepData} from './workflow.dto';
-
-export type TemplateNotificationSchema = {
-  /** ID of the template to be used for the notification */
-  templateId: string;
-};
-
-export type RawNotificationSchema = {
-  /** Optional user provided notification message */
-  rawContent: string;
-};
+import {Category, DeliveryStrategyKind, FindingKind, FindingSeverity, NotificationStatus} from './enums';
+import {ContentStrategyKind} from './enums/contentStrategy.kind';
 
 export type NotificationAddress = {
   /** Connector ID for the notification channel */
-  cid: string;
+  cid?: string;
   /** Group IDs to which the notification is being sent */
   groups?: string[] | number[];
   /** User IDs to which the notification is being sent */
@@ -24,25 +13,89 @@ export type NotificationAddress = {
   webhooks?: string[];
 };
 
+export type FindingNotificationContext = {
+  /** Severity of the finding */
+  severity: FindingSeverity;
+  /** Category of the finding */
+  category: Category;
+  /** Kind of the finding */
+  kind: FindingKind;
+};
+
+export type UserNotificationContext = {
+  /** First name of the user */
+  firstName: string;
+  /** Last name of the user */
+  lastName: string;
+  /** Title of the user */
+  title: string;
+  /** Department of the user */
+  department: string;
+};
+
+export type ProviderNotificationContext = {
+  /** Name of the provider */
+  displayValue: string;
+  /** Categories to which the provider applies */
+  categories: string[];
+};
+
+export type NotificationContext = {
+  // TODO: determine what this should be
+  // component?: ComponentNotificationContext;
+  finding?: FindingNotificationContext;
+  provider?: ProviderNotificationContext;
+  user?: UserNotificationContext;
+};
+
+export type ContentStrategySpecification = {
+  /** Kind of the content strategy */
+  kind: ContentStrategyKind;
+  /** Data to be used for the notification */
+  data?: {
+    [propName: string]: string | number | boolean;
+  };
+};
+
+export type TemplateContentStrategySpec = ContentStrategySpecification & {
+  /** ID of the template to be used for the notification */
+  templateId: string;
+  /** Context for the notification */
+  context: NotificationContext;
+};
+
+export type RawContentStrategySpec = ContentStrategySpecification & {
+  /** Content of the notification */
+  content: string;
+};
+
+export type LlmContentStrategySpec = ContentStrategySpecification & {
+  /** Context for the notification */
+  context: NotificationContext;
+};
+
+export type DeliveryStrategySpec = {
+  /** Channel type that should be used for sending the notificaiton */
+  kind: DeliveryStrategyKind;
+  /** Recipient address to which the notification is being sent */
+  to: NotificationAddress;
+};
+
 export type NotificationUpsertDto = BaseUpsertDto & {
-  /** Kind of the notification */
-  kind: NotificationKind;
   /** Workflow ID for which the notification is being created */
   wfid: string;
-  /** Finding ID for which the notification is being created */
-  fid?: string;
-  /** Recipient address to which the notification is being sent */
-  to: NotificationAddress;
-  /** ID of the user to which the notification is being sent */
-  uid?: string;
   /** Step number in the workflow for which the notification is being created */
   stepNumber: number;
   /** Status of the notification */
   status: NotificationStatus;
   /** Data to be used for the notification */
-  data: NotificationStepData | TrainingNotificationStepData;
-  /** Schema for the notification */
-  schema?: RawNotificationSchema | TemplateNotificationSchema;
+  contentStrategy: TemplateContentStrategySpec | RawContentStrategySpec | LlmContentStrategySpec;
+  /** Method of delivery */
+  deliveryStrategy: DeliveryStrategySpec;
+  /** Finding ID for which the notification is being created */
+  fid?: string | null;
+  /** ID of the user to which the notification is being sent */
+  uid?: string | null;
 };
 
 export type NotificationDto = NotificationUpsertDto & BaseDto;

package/src/dto/workflow.dto.ts

@@ -1,47 +1,49 @@
 import {BaseDto} from './base.dto';
-import {NotificationKind} from './enums';
+import {ContentStrategyKind, DeliveryStrategyKind} from './enums';
+import {RequiredDataProperty} from './enums/requiredDataProperty.enum';
 import {WorkflowStepKind} from './enums/workflowStep.kind';
 import {WorkflowTriggerKind} from './enums/workflowTrigger.kind';
-import {TemplateNotificationSchema, RawNotificationSchema} from './notification.dto';
 
-export type NotificationStepData = {
-  /** Name of the device to which the notification of finding applies */
-  deviceName: string | null;
-  /** Estimated time to remediate the finding, in minutes */
-  duration: number;
-  /** Name of the software to which the finding applies */
-  softwareName: string;
+export type WorflowStepDescriptor = {
+  /** Type of the notification step, either NOTIFICATION or PAUSE */
+  kind: WorkflowStepKind;
+  /** Optional default values to be used of no other is provided */
+  defaults?: {
+    [propName: string]: string | number | boolean;
+  };
+};
+
+export type NotificationStepDescriptor = WorflowStepDescriptor & {
+  /** Delivery strategy to be used for the notification */
+  deliveryStrategyKinds: DeliveryStrategyKind[];
+  /** Required data properties for the notification */
+  requiredData: RequiredDataProperty[];
+};
+
+export type PauseStepDescriptor = WorflowStepDescriptor & {
+  /** Duration, in days, to wait before executing the next step in the workflow */
+  pauseDuration: number;
 };
 
-export type TrainingNotificationStepData = NotificationStepData & {
-  /** Name of the training module to which the notification of finding applies */
-  title?: string;
-  /** Date on which the user enrolled in the training module */
-  enrollDate?: string;
-  /** Date on which the user started the training module */
-  startDate?: string;
+export type ContentDescriptor = {
+  /** Kind of the content that will be generated for the notification */
+  kind: ContentStrategyKind;
 };
 
-export type PauseStepData = {
-  /** Estimated duration, in minutes, to resolve the finding */
-  duration: number;
+export type TemplateContentDescriptor = ContentDescriptor & {
+  /** ID of the template to be used for the notification */
+  templateId: string;
 };
 
 export type WorkflowStep = {
-  /** Type of the notification step, either NOTIFICATION or PAUSE */
-  kind: WorkflowStepKind;
-  /** Kind of the notification */
-  notificationKind?: NotificationKind;
-  /** Schema for the notification step */
-  schema?: TemplateNotificationSchema | RawNotificationSchema;
-  /** Data associated with the notification step */
-  data: NotificationStepData | TrainingNotificationStepData | PauseStepData;
+  /** Indicates the type of workflow step and contains relevant information for each */
+  stepDescriptor: NotificationStepDescriptor | PauseStepDescriptor;
+  /** Content to be used for the notification */
+  contentDescriptor?: ContentDescriptor | TemplateContentDescriptor;
   /** Step number to transition the workflow to on success */
   successStepNumber: number | null;
   /** Step number to transition the workflow to on failure */
   failureStepNumber: number | null;
-  /** Duration, in days, to wait before executing the next step in the workflow */
-  pauseDuration?: number | null;
 };
 
 export type WorkflowSteps = {
@@ -61,7 +63,7 @@ export type WorkflowTriggerRule = {
 };
 
 export type WorkflowTrigger = {
-  /** Type of the trigger */
+  /** Kind of the trigger */
   kind: WorkflowTriggerKind;
   /** Rule to which the applicable entity type must conform to trigger the workflow */
   rule: unknown;

package/src/services/EngageApi.ts

@@ -38,13 +38,13 @@ export class EngageApi {
   readonly settings: AmpSettingsService;
 
   constructor(rest: RestClient) {
-    this.connectors = new AmpEntityServiceImpl<ConnectorUpsertDto, ConnectorDto>(rest, KIND.CONNECTORS, TARGET_API_ENGAGE); // TODO: add /eng endpoint... needed?
+    this.connectors = new AmpEntityServiceImpl<ConnectorUpsertDto, ConnectorDto>(rest, KIND.CONNECTORS, TARGET_API_ENGAGE);
     this.findings = new AmpPatchDataServiceImpl<FindingsStatusPatchDto, FindingDto>(rest, KIND.FINDINGS, TARGET_API_ENGAGE);
     this.identity = new UserIdentityService(rest);
-    this.notifications = new AmpDataServiceImpl<NotificationDto>(rest, KIND.NOTIFICATIONS, TARGET_API_ENGAGE); // TODO: add /eng endpoint
+    this.notifications = new AmpDataServiceImpl<NotificationDto>(rest, KIND.NOTIFICATIONS, TARGET_API_ENGAGE);
     this.providers = new AmpDataServiceImpl<ProviderDto>(rest, KIND.PROVIDERS, TARGET_API_AGENT);
     this.reports = new AmpReportServiceImpl(rest);
-    this.settings = new AmpSettingsService(rest); // TODO: add /eng endpoint
+    this.settings = new AmpSettingsService(rest); // TODO: confirm it is not needed. Currently returns NOT_IMPLEMENTED error code
   }
 
   static instance(options: EngageApiOptions): EngageApi {

package/src/services/rest/AgentIdentityService.ts

@@ -23,7 +23,7 @@ export class AgentIdentityService {
 
   me = async (): Promise<AgentDto> => {
     const res = await this.rest.call({
-      url: '/api/v1/me',
+      url: '/me',
       method: 'GET',
     });
     return res.data as AgentDto;

package/src/services/rest/UserIdentityService.ts

@@ -12,7 +12,7 @@ export class UserIdentityService {
   }
   me = async (): Promise<AmpJwtToken> => {
     const res = await this.rest.call({
-      url: '/eng/v1/me',
+      url: '/me',
       method: 'GET',
     });
     return res.data as AmpJwtToken;

package/build/src/dto/enums/notification.kind.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationKind = void 0;
-/* eslint-disable no-unused-vars */
-var NotificationKind;
-(function (NotificationKind) {
-    NotificationKind["LLM"] = "LLM";
-    NotificationKind["RAW"] = "RAW";
-    NotificationKind["TEMPLATE"] = "TEMPLATE";
-})(NotificationKind || (exports.NotificationKind = NotificationKind = {}));
-//# sourceMappingURL=notification.kind.js.map

package/build/src/dto/enums/notification.kind.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"notification.kind.js","sourceRoot":"","sources":["../../../../src/dto/enums/notification.kind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;IACX,+BAAW,CAAA;IACX,yCAAqB,CAAA;AACvB,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B"}