@ampsec/platform-client 46.0.0 → 46.2.0

package/build/src/dto/enums/connector.status.d.ts

@@ -2,5 +2,8 @@ export declare enum ConnectorStatus {
     ACTIVE = "ACTIVE",
     DELETED = "DELETED",
     FAILED = "FAILED",
-    DISABLED = "DISABLED"
+    DISABLED = "DISABLED",
+    SYNCING = "SYNCING",
+    DEGRADED = "DEGRADED",
+    PAUSED = "PAUSED"
 }

package/build/src/dto/enums/connector.status.js

@@ -8,5 +8,8 @@ var ConnectorStatus;
     ConnectorStatus["DELETED"] = "DELETED";
     ConnectorStatus["FAILED"] = "FAILED";
     ConnectorStatus["DISABLED"] = "DISABLED";
+    ConnectorStatus["SYNCING"] = "SYNCING";
+    ConnectorStatus["DEGRADED"] = "DEGRADED";
+    ConnectorStatus["PAUSED"] = "PAUSED";
 })(ConnectorStatus || (exports.ConnectorStatus = ConnectorStatus = {}));
 //# sourceMappingURL=connector.status.js.map

package/build/src/dto/enums/connector.status.js.map

@@ -1 +1 @@
-{"version":3,"file":"connector.status.js","sourceRoot":"","sources":["../../../../src/dto/enums/connector.status.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;IACjB,wCAAqB,CAAA;AACvB,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B"}
+{"version":3,"file":"connector.status.js","sourceRoot":"","sources":["../../../../src/dto/enums/connector.status.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,eAQX;AARD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;IACjB,wCAAqB,CAAA;IACrB,sCAAmB,CAAA;IACnB,wCAAqB,CAAA;IACrB,oCAAiB,CAAA;AACnB,CAAC,EARW,eAAe,+BAAf,eAAe,QAQ1B"}

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

@@ -16,6 +16,28 @@ export type AssetNotificationContext = {
     /** Name of the asset */
     deviceName: string;
 };
+export type CreateNotificationOptions = {
+    /** Whether to CC the secops team of the notification, likely a tenant setting once implemented */
+    copySecOpsTeam: boolean;
+};
+export type CreateNotificationContent = {
+    /** Kind of the content strategy */
+    kind: ContentStrategyKind;
+    /** Content of the notification */
+    content: string;
+};
+export type CreateNotificationDto = BaseUpsertDto & {
+    /** Channel type that should be used for sending the notificaiton */
+    channel: DeliveryStrategyKind;
+    /** Content settings of the notification */
+    content: CreateNotificationContent;
+    /** Additional options for the notification */
+    options?: CreateNotificationOptions;
+    /** The user id this notification will be sent to, optional as not all findings are associated to a user */
+    uid?: string;
+    /** The finding id this notification is in regards to */
+    fid?: string;
+};
 export type FindingNotificationContext = {
     /** Severity of the finding */
     severity: FindingSeverity;

package/build/src/services/AmpApi.d.ts

@@ -1,4 +1,4 @@
-import { AgentDto, AgentUpsertDto, AssetDto, ConnectorDto, ConnectorUpsertDto, NotificationDto, NotificationUpsertDto, ProviderDto, ReportResultDto, SaasAssetDto, SaasComponentDto, SaasUserDto, TenantDto, TenantUpsertDto, UserDto } from '../dto';
+import { AgentDto, AgentUpsertDto, AssetDto, ConnectorDto, ConnectorUpsertDto, ProviderDto, ReportResultDto, SaasAssetDto, SaasComponentDto, SaasUserDto, TenantDto, TenantUpsertDto, UserDto } from '../dto';
 import { AmpEntityService } from './entity.service';
 import { AmpDataService } from './data.service';
 import { AmpRestClientOptions, RestClient } from './rest';
@@ -8,6 +8,7 @@ import { AmpSettingsService } from './settings.service';
 import { AgentIdentityService } from './rest/AgentIdentityService';
 import { ConnectorInstallService } from './rest/ConnectorInstallService';
 import { FindingsService } from './findings.service';
+import NotificationService from './notification.service';
 export type AmpApiOptions = AmpRestClientOptions;
 /**
  * AMP API
@@ -29,7 +30,7 @@ export declare class AmpApi {
     readonly findings: FindingsService;
     readonly identity: AgentIdentityService;
     readonly install: ConnectorInstallService;
-    readonly notifications: AmpEntityService<NotificationUpsertDto, NotificationDto>;
+    readonly notifications: NotificationService;
     readonly providers: AmpDataService<ProviderDto>;
     readonly reportResults: AmpDataService<ReportResultDto>;
     readonly reports: AmpReportService;

package/build/src/services/AmpApi.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AmpApi = void 0;
 const entity_service_1 = require("./entity.service");
@@ -11,6 +14,7 @@ const settings_service_1 = require("./settings.service");
 const AgentIdentityService_1 = require("./rest/AgentIdentityService");
 const ConnectorInstallService_1 = require("./rest/ConnectorInstallService");
 const findings_service_1 = require("./findings.service");
+const notification_service_1 = __importDefault(require("./notification.service"));
 /**
  * AMP API
  * This client is a wrapper around the AMP REST API meant to be used by
@@ -32,7 +36,7 @@ class AmpApi {
         this.findings = new findings_service_1.FindingsService(rest);
         this.identity = new AgentIdentityService_1.AgentIdentityService(rest);
         this.install = new ConnectorInstallService_1.ConnectorInstallService(rest, constants_1.TARGET_API_AGENT);
-        this.notifications = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.NOTIFICATIONS);
+        this.notifications = new notification_service_1.default(rest);
         this.providers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.PROVIDERS);
         this.reportResults = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.REPORT_RESULTS);
         this.reports = new reports_service_1.AmpReportServiceImpl(rest);

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

@@ -1 +1 @@
-{"version":3,"file":"AmpApi.js","sourceRoot":"","sources":["../../../src/services/AmpApi.ts"],"names":[],"mappings":";;;AAiBA,qDAAwE;AACxE,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAmD;AACnD,uDAAyE;AACzE,oDAAmE;AACnE,yDAAsD;AACtD,sEAAiE;AACjE,4EAAuE;AACvE,yDAAmD;AAInD;;;;;;;;;;;GAWG;AACH,MAAa,MAAM;IAmBjB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2B,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAW,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,CAAC,KAAK,GAAG,IAAI,gCAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,kCAAe,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,iDAAuB,CAAC,IAAI,EAAE,4BAAgB,CAAC,CAAC;QACnE,IAAI,CAAC,aAAa,GAAG,IAAI,qCAAoB,CAAyC,IAAI,EAAE,gBAAI,CAAC,aAAa,CAAC,CAAC;QAChH,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,CAAC,CAAC;QAC3E,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAkB,CAAe,IAAI,EAAE,gBAAI,CAAC,WAAW,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,GAAG,IAAI,iCAAkB,CAAmB,IAAI,EAAE,gBAAI,CAAC,eAAe,CAAC,CAAC;QAC3F,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,CAAC,CAAC;QACxF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAU,IAAI,EAAE,gBAAI,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AA3CD,wBA2CC"}
+{"version":3,"file":"AmpApi.js","sourceRoot":"","sources":["../../../src/services/AmpApi.ts"],"names":[],"mappings":";;;;;;AAeA,qDAAwE;AACxE,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAmD;AACnD,uDAAyE;AACzE,oDAAmE;AACnE,yDAAsD;AACtD,sEAAiE;AACjE,4EAAuE;AACvE,yDAAmD;AACnD,kFAAyD;AAIzD;;;;;;;;;;;GAWG;AACH,MAAa,MAAM;IAmBjB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2B,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAW,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,CAAC,KAAK,GAAG,IAAI,gCAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,kCAAe,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,iDAAuB,CAAC,IAAI,EAAE,4BAAgB,CAAC,CAAC;QACnE,IAAI,CAAC,aAAa,GAAG,IAAI,8BAAmB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,CAAC,CAAC;QAC3E,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAkB,CAAe,IAAI,EAAE,gBAAI,CAAC,WAAW,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,GAAG,IAAI,iCAAkB,CAAmB,IAAI,EAAE,gBAAI,CAAC,eAAe,CAAC,CAAC;QAC3F,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,CAAC,CAAC;QACxF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAU,IAAI,EAAE,gBAAI,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AA3CD,wBA2CC"}

package/build/src/services/notification.service.d.ts

@@ -0,0 +1,8 @@
+import { CreateNotificationDto, NotificationDto, Page } from '../dto';
+import { AmpDataServiceImpl } from './data.service';
+import { RestClient } from './rest';
+declare class NotificationService extends AmpDataServiceImpl<NotificationDto> {
+    constructor(rest: RestClient);
+    createNew: (notification: CreateNotificationDto | CreateNotificationDto[]) => Promise<Page<NotificationDto>>;
+}
+export default NotificationService;

package/build/src/services/notification.service.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("./constants");
+const data_service_1 = require("./data.service");
+class NotificationService extends data_service_1.AmpDataServiceImpl {
+    constructor(rest) {
+        super(rest, constants_1.KIND.NOTIFICATIONS);
+        this.createNew = (notification) => this.getPage({
+            url: `${this.targetApi}/v1/${this.kind}/create`,
+            method: 'POST',
+            data: Array.isArray(notification) ? notification : [notification],
+        });
+    }
+}
+exports.default = NotificationService;
+//# sourceMappingURL=notification.service.js.map

package/build/src/services/notification.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.service.js","sourceRoot":"","sources":["../../../src/services/notification.service.ts"],"names":[],"mappings":";;AACA,2CAAiC;AACjC,iDAAkD;AAGlD,MAAM,mBAAoB,SAAQ,iCAAmC;IACnE,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,aAAa,CAAC,CAAC;QAGlC,cAAS,GAAG,CAAC,YAA6D,EAAkC,EAAE,CAC5G,IAAI,CAAC,OAAO,CAAC;YACX,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,SAAS;YAC/C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;SAClE,CAAC,CAAC;IAPL,CAAC;CAQF;AAED,kBAAe,mBAAmB,CAAC"}

package/package.json

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

package/src/dto/enums/connector.status.ts

@@ -4,4 +4,7 @@ export enum ConnectorStatus {
   DELETED = 'DELETED',
   FAILED = 'FAILED',
   DISABLED = 'DISABLED',
+  SYNCING = 'SYNCING',
+  DEGRADED = 'DEGRADED',
+  PAUSED = 'PAUSED',
 }

package/src/dto/notification.dto.ts

@@ -19,6 +19,31 @@ export type AssetNotificationContext = {
   deviceName: string;
 };
 
+export type CreateNotificationOptions = {
+  /** Whether to CC the secops team of the notification, likely a tenant setting once implemented */
+  copySecOpsTeam: boolean;
+};
+
+export type CreateNotificationContent = {
+  /** Kind of the content strategy */
+  kind: ContentStrategyKind; // Future kinds will exist, but for now we only support RAW
+  /** Content of the notification */
+  content: string;
+};
+
+export type CreateNotificationDto = BaseUpsertDto & {
+  /** Channel type that should be used for sending the notificaiton */
+  channel: DeliveryStrategyKind;
+  /** Content settings of the notification */
+  content: CreateNotificationContent;
+  /** Additional options for the notification */
+  options?: CreateNotificationOptions;
+  /** The user id this notification will be sent to, optional as not all findings are associated to a user */
+  uid?: string;
+  /** The finding id this notification is in regards to */
+  fid?: string;
+};
+
 export type FindingNotificationContext = {
   /** Severity of the finding */
   severity: FindingSeverity;

package/src/services/AmpApi.ts

@@ -4,8 +4,6 @@ import {
   AssetDto,
   ConnectorDto,
   ConnectorUpsertDto,
-  NotificationDto,
-  NotificationUpsertDto,
   ProviderDto,
   ReportResultDto,
   SaasAssetDto,
@@ -25,6 +23,7 @@ import {AmpSettingsService} from './settings.service';
 import {AgentIdentityService} from './rest/AgentIdentityService';
 import {ConnectorInstallService} from './rest/ConnectorInstallService';
 import {FindingsService} from './findings.service';
+import NotificationService from './notification.service';
 
 export type AmpApiOptions = AmpRestClientOptions;
 
@@ -48,7 +47,7 @@ export class AmpApi {
   readonly findings: FindingsService;
   readonly identity: AgentIdentityService;
   readonly install: ConnectorInstallService;
-  readonly notifications: AmpEntityService<NotificationUpsertDto, NotificationDto>;
+  readonly notifications: NotificationService;
   readonly providers: AmpDataService<ProviderDto>;
   readonly reportResults: AmpDataService<ReportResultDto>;
   readonly reports: AmpReportService;
@@ -67,7 +66,7 @@ export class AmpApi {
     this.findings = new FindingsService(rest);
     this.identity = new AgentIdentityService(rest);
     this.install = new ConnectorInstallService(rest, TARGET_API_AGENT);
-    this.notifications = new AmpEntityServiceImpl<NotificationUpsertDto, NotificationDto>(rest, KIND.NOTIFICATIONS);
+    this.notifications = new NotificationService(rest);
     this.providers = new AmpDataServiceImpl<ProviderDto>(rest, KIND.PROVIDERS);
     this.reportResults = new AmpDataServiceImpl<ReportResultDto>(rest, KIND.REPORT_RESULTS);
     this.reports = new AmpReportServiceImpl(rest);

package/src/services/notification.service.ts

@@ -0,0 +1,19 @@
+import {CreateNotificationDto, NotificationDto, Page} from '../dto';
+import {KIND} from './constants';
+import {AmpDataServiceImpl} from './data.service';
+import {RestClient} from './rest';
+
+class NotificationService extends AmpDataServiceImpl<NotificationDto> {
+  constructor(rest: RestClient) {
+    super(rest, KIND.NOTIFICATIONS);
+  }
+
+  createNew = (notification: CreateNotificationDto | CreateNotificationDto[]): Promise<Page<NotificationDto>> =>
+    this.getPage({
+      url: `${this.targetApi}/v1/${this.kind}/create`,
+      method: 'POST',
+      data: Array.isArray(notification) ? notification : [notification],
+    });
+}
+
+export default NotificationService;