@ampsec/platform-client 41.0.0 → 43.0.0

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

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

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

@@ -5,6 +5,6 @@ exports.DeliveryStrategyKind = void 0;
 var DeliveryStrategyKind;
 (function (DeliveryStrategyKind) {
     DeliveryStrategyKind["EMAIL"] = "EMAIL";
-    DeliveryStrategyKind["SLACK"] = "SLACK";
+    DeliveryStrategyKind["MESSAGING"] = "MESSAGING";
 })(DeliveryStrategyKind || (exports.DeliveryStrategyKind = DeliveryStrategyKind = {}));
 //# sourceMappingURL=deliveryStrategy.kind.js.map

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

@@ -1 +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"}
+{"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,+CAAuB,CAAA;AACzB,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B"}

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

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

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

@@ -4,11 +4,6 @@ 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

@@ -1 +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"}
+{"version":3,"file":"requiredDataProperty.enum.js","sourceRoot":"","sources":["../../../../src/dto/enums/requiredDataProperty.enum.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,oBAEX;AAFD,WAAY,oBAAoB;IAC9B,6CAAqB,CAAA;AACvB,CAAC,EAFW,oBAAoB,oCAApB,oBAAoB,QAE/B"}

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

@@ -11,6 +11,10 @@ export type NotificationAddress = {
     /** Webhook URLs to which the notification is being sent */
     webhooks?: string[];
 };
+export type AssetNotificationContext = {
+    /** Name of the asset */
+    deviceName: string;
+};
 export type FindingNotificationContext = {
     /** Severity of the finding */
     severity: FindingSeverity;
@@ -19,6 +23,14 @@ export type FindingNotificationContext = {
     /** Kind of the finding */
     kind: FindingKind;
 };
+export type TrainingNotificationContext = {
+    /** Title of the training */
+    title: string;
+    /** Date enrolled in the training */
+    enrollDate: string | null | undefined;
+    /** Date started the training */
+    startDate: string | null | undefined;
+};
 export type UserNotificationContext = {
     /** First name of the user */
     firstName: string;
@@ -31,13 +43,15 @@ export type UserNotificationContext = {
 };
 export type ProviderNotificationContext = {
     /** Name of the provider */
-    displayValue: string;
-    /** Categories to which the provider applies */
-    categories: string[];
+    softwareName: string;
 };
 export type NotificationContext = {
+    /** Estimated completion time for the remediation described by the notification */
+    estimatedCompletionTime: number;
+    asset?: AssetNotificationContext;
     finding?: FindingNotificationContext;
     provider?: ProviderNotificationContext;
+    training?: TrainingNotificationContext;
     user?: UserNotificationContext;
 };
 export type ContentStrategySpecification = {

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

@@ -1,6 +1,5 @@
 import { BaseDto } from './base.dto';
 import { ContentStrategyKind, DeliveryStrategyKind } from './enums';
-import { RequiredDataProperty } from './enums/requiredDataProperty.enum';
 import { WorkflowStepKind } from './enums/workflowStep.kind';
 import { WorkflowTriggerKind } from './enums/workflowTrigger.kind';
 export type WorflowStepDescriptor = {
@@ -14,8 +13,6 @@ export type WorflowStepDescriptor = {
 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 */

package/package.json

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

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

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

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

@@ -1,9 +1,4 @@
 /* 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

@@ -13,6 +13,11 @@ export type NotificationAddress = {
   webhooks?: string[];
 };
 
+export type AssetNotificationContext = {
+  /** Name of the asset */
+  deviceName: string;
+};
+
 export type FindingNotificationContext = {
   /** Severity of the finding */
   severity: FindingSeverity;
@@ -22,6 +27,15 @@ export type FindingNotificationContext = {
   kind: FindingKind;
 };
 
+export type TrainingNotificationContext = {
+  /** Title of the training */
+  title: string;
+  /** Date enrolled in the training */
+  enrollDate: string | null | undefined;
+  /** Date started the training */
+  startDate: string | null | undefined;
+};
+
 export type UserNotificationContext = {
   /** First name of the user */
   firstName: string;
@@ -35,16 +49,18 @@ export type UserNotificationContext = {
 
 export type ProviderNotificationContext = {
   /** Name of the provider */
-  displayValue: string;
-  /** Categories to which the provider applies */
-  categories: string[];
+  softwareName: string;
 };
 
 export type NotificationContext = {
   // TODO: determine what this should be
   // component?: ComponentNotificationContext;
+  /** Estimated completion time for the remediation described by the notification */
+  estimatedCompletionTime: number;
+  asset?: AssetNotificationContext;
   finding?: FindingNotificationContext;
   provider?: ProviderNotificationContext;
+  training?: TrainingNotificationContext;
   user?: UserNotificationContext;
 };
 

package/src/dto/workflow.dto.ts

@@ -1,6 +1,5 @@
 import {BaseDto} from './base.dto';
 import {ContentStrategyKind, DeliveryStrategyKind} from './enums';
-import {RequiredDataProperty} from './enums/requiredDataProperty.enum';
 import {WorkflowStepKind} from './enums/workflowStep.kind';
 import {WorkflowTriggerKind} from './enums/workflowTrigger.kind';
 
@@ -16,8 +15,6 @@ export type WorflowStepDescriptor = {
 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 & {