@ampsec/platform-client 29.1.1 → 31.0.0

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

@@ -1,5 +1,10 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 export type AmpSettingKey = string;
+export type AmpSettingDisplayableValue = {
+    cid?: string;
+    displayValue: string;
+};
+export type AmpSettingValue = unknown | AmpSettingDisplayableValue;
 export type AmpSettingUpsertDto = BaseUpsertDto & {
     /** Tenant ID */
     tid: string;
@@ -8,6 +13,6 @@ export type AmpSettingUpsertDto = BaseUpsertDto & {
     /** Setting key */
     key: AmpSettingKey;
     /** Setting value */
-    value?: unknown;
+    value?: AmpSettingValue;
 };
 export type AmpSettingDto = BaseDto & AmpSettingUpsertDto;

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

@@ -0,0 +1,3 @@
+export declare enum AmpSettingKeys {
+    DEFAULT_NOTIFICATION_CONNECTOR = "DEFAULT_NOTIFICATION_CONNECTOR"
+}

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmpSettingKeys = void 0;
+/* eslint-disable no-unused-vars */
+var AmpSettingKeys;
+(function (AmpSettingKeys) {
+    AmpSettingKeys["DEFAULT_NOTIFICATION_CONNECTOR"] = "DEFAULT_NOTIFICATION_CONNECTOR";
+})(AmpSettingKeys || (exports.AmpSettingKeys = AmpSettingKeys = {}));
+//# sourceMappingURL=ampSettingKeys.enum.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ampSettingKeys.enum.js","sourceRoot":"","sources":["../../../../src/dto/enums/ampSettingKeys.enum.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,mFAAiE,CAAA;AACnE,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB"}

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

@@ -1,5 +1,6 @@
 export * from './auth.role';
 export * from './agent.status';
+export * from './ampSettingKeys.enum';
 export * from './category';
 export * from './connector.status';
 export * from './findingKind';

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

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./auth.role"), exports);
 __exportStar(require("./agent.status"), exports);
+__exportStar(require("./ampSettingKeys.enum"), exports);
 __exportStar(require("./category"), exports);
 __exportStar(require("./connector.status"), exports);
 __exportStar(require("./findingKind"), exports);

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,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,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,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,sDAAoC;AACpC,sDAAoC"}

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

@@ -1,4 +1,5 @@
 export declare enum NotificationStatus {
+    INVALID = "INVALID",
     PENDING = "PENDING",
     READ = "READ",
     SENT = "SENT"

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

@@ -4,6 +4,7 @@ exports.NotificationStatus = void 0;
 /* eslint-disable no-unused-vars */
 var NotificationStatus;
 (function (NotificationStatus) {
+    NotificationStatus["INVALID"] = "INVALID";
     NotificationStatus["PENDING"] = "PENDING";
     NotificationStatus["READ"] = "READ";
     NotificationStatus["SENT"] = "SENT";

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

@@ -1 +1 @@
-{"version":3,"file":"notification.status.js","sourceRoot":"","sources":["../../../../src/dto/enums/notification.status.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,mCAAa,CAAA;IACb,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B"}
+{"version":3,"file":"notification.status.js","sourceRoot":"","sources":["../../../../src/dto/enums/notification.status.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,mCAAa,CAAA;IACb,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B"}

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

@@ -37,12 +37,6 @@ export type FindingUpsertDto = BaseUpsertDto & {
     uid?: string | undefined | null;
     /** Id of the SaasComponent related to the given finding */
     scid?: string | undefined | null;
-    /**
-     * Used as the naive implementation of notification schedules inside Flows.
-     * "Resets" notifications schedule after pause or failed verification.
-     * Defaults to "NOW".
-     */
-    nextNotificationAfter?: string;
     /** Number of times this finding was marked PENDING_VERIFIED. Defaults to `0` */
     verificationCount?: number;
     /** Optionally populated when requested through query param `include=user` */

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

@@ -48,11 +48,5 @@ export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {
     extKey: string;
     /** Component display value */
     displayValue: string;
-    /**
-     * Used as the naive implementation of notification schedules inside Flows.
-     * "Resets" notifications schedule after pause or failed verification.
-     * Defaults to "NOW".
-     */
-    nextNotificationAfter?: string;
 };
 export type SaasComponentDto = ChangeAwareDto & SaasComponentUpsertDto;

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

@@ -37,11 +37,5 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
     riskContributors: RiskContributorUpsertDto[];
     /** Health score associated with the user */
     score?: number;
-    /**
-     * Used as the naive implementation of notification schedules inside Flows.
-     * "Resets" notifications schedule after pause or failed verification.
-     * Defaults to "NOW".
-     */
-    nextNotificationAfter?: string;
 };
 export type UserDto = ChangeAwareDto & UserUpsertDto;

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

@@ -3,7 +3,7 @@ import { WorkflowStepType } from './enums/workflowStep.type';
 import { WorkflowTriggerType } from './enums/workflowTrigger.type';
 export type NotificationStepData = {
     /** Name of the device to which the notification of finding applies */
-    deviceName: string;
+    deviceName: string | null;
     /** Estimated time to remediate the finding, in minutes */
     duration: number;
     /** Name of the software to which the finding applies */
@@ -71,5 +71,11 @@ export type WorkflowProgressUpsertDto = {
     uid: string;
     /** whether or not this instance of the workflow has been completed */
     workflowCompleted: boolean;
+    /**
+     * Used as the naive implementation of notification schedules inside Flows.
+     * "Resets" notifications schedule after pause or failed verification.
+     * Defaults to "NOW".
+     */
+    nextNotificationAfter?: string;
 };
 export type WorkflowProgressDto = BaseDto & WorkflowProgressUpsertDto;

package/package.json

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

package/src/dto/ampSetting.dto.ts

@@ -2,6 +2,13 @@ import {BaseDto, BaseUpsertDto} from './base.dto';
 
 export type AmpSettingKey = string;
 
+export type AmpSettingDisplayableValue = {
+  cid?: string;
+  displayValue: string;
+};
+
+export type AmpSettingValue = unknown | AmpSettingDisplayableValue;
+
 export type AmpSettingUpsertDto = BaseUpsertDto & {
   /** Tenant ID */
   tid: string;
@@ -10,7 +17,7 @@ export type AmpSettingUpsertDto = BaseUpsertDto & {
   /** Setting key */
   key: AmpSettingKey;
   /** Setting value */
-  value?: unknown;
+  value?: AmpSettingValue;
 };
 
 export type AmpSettingDto = BaseDto & AmpSettingUpsertDto;

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

@@ -0,0 +1,4 @@
+/* eslint-disable no-unused-vars */
+export enum AmpSettingKeys {
+  DEFAULT_NOTIFICATION_CONNECTOR = 'DEFAULT_NOTIFICATION_CONNECTOR',
+}

package/src/dto/enums/index.ts

@@ -1,5 +1,6 @@
 export * from './auth.role';
 export * from './agent.status';
+export * from './ampSettingKeys.enum';
 export * from './category';
 export * from './connector.status';
 export * from './findingKind';

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

@@ -1,5 +1,6 @@
 /* eslint-disable no-unused-vars */
 export enum NotificationStatus {
+  INVALID = 'INVALID',
   PENDING = 'PENDING',
   READ = 'READ',
   SENT = 'SENT',

package/src/dto/findings.dto.ts

@@ -39,12 +39,6 @@ export type FindingUpsertDto = BaseUpsertDto & {
   uid?: string | undefined | null;
   /** Id of the SaasComponent related to the given finding */
   scid?: string | undefined | null;
-  /**
-   * Used as the naive implementation of notification schedules inside Flows.
-   * "Resets" notifications schedule after pause or failed verification.
-   * Defaults to "NOW".
-   */
-  nextNotificationAfter?: string;
   /** Number of times this finding was marked PENDING_VERIFIED. Defaults to `0` */
   verificationCount?: number;
   /** Optionally populated when requested through query param `include=user` */

package/src/dto/saasComponents.dto.ts

@@ -50,12 +50,6 @@ export type SaasComponentUpsertDto = ChangeAwareUpsertDto & {
   extKey: string;
   /** Component display value */
   displayValue: string;
-  /**
-   * Used as the naive implementation of notification schedules inside Flows.
-   * "Resets" notifications schedule after pause or failed verification.
-   * Defaults to "NOW".
-   */
-  nextNotificationAfter?: string;
 };
 
 export type SaasComponentDto = ChangeAwareDto & SaasComponentUpsertDto;

package/src/dto/users.dto.ts

@@ -39,12 +39,6 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
   riskContributors: RiskContributorUpsertDto[];
   /** Health score associated with the user */
   score?: number;
-  /**
-   * Used as the naive implementation of notification schedules inside Flows.
-   * "Resets" notifications schedule after pause or failed verification.
-   * Defaults to "NOW".
-   */
-  nextNotificationAfter?: string;
 };
 
 export type UserDto = ChangeAwareDto & UserUpsertDto;

package/src/dto/workflow.dto.ts

@@ -4,7 +4,7 @@ import {WorkflowTriggerType} from './enums/workflowTrigger.type';
 
 export type NotificationStepData = {
   /** Name of the device to which the notification of finding applies */
-  deviceName: string;
+  deviceName: string | null;
   /** Estimated time to remediate the finding, in minutes */
   duration: number;
   /** Name of the software to which the finding applies */
@@ -87,6 +87,12 @@ export type WorkflowProgressUpsertDto = {
   uid: string;
   /** whether or not this instance of the workflow has been completed */
   workflowCompleted: boolean;
+  /**
+   * Used as the naive implementation of notification schedules inside Flows.
+   * "Resets" notifications schedule after pause or failed verification.
+   * Defaults to "NOW".
+   */
+  nextNotificationAfter?: string;
 };
 
 export type WorkflowProgressDto = BaseDto & WorkflowProgressUpsertDto;