@ampsec/platform-client 75.9.0 → 76.1.0

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

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FindingsService = void 0;
 const lodash_1 = __importDefault(require("lodash"));
-const dto_1 = require("../dto");
 const constants_1 = require("./constants");
 const entity_service_1 = require("./entity.service");
 class FindingsService extends entity_service_1.AmpEntityServiceImpl {
@@ -36,54 +35,6 @@ class FindingsService extends entity_service_1.AmpEntityServiceImpl {
             params: finding,
         });
     }
-    /**
-     * Returns a page of FindingBucketSummaryDto scoped to a tenant. The page will contain 1
-     * result for each user + bucket combination. The result will be the MAX(bucketScore) and
-     * MIN(createdAt). The findings are also joined with flowStates to pull any running flows.
-     *
-     * @param tid tenant id
-     * @param offset Optional offset for pagination. Default 0
-     * @param limit Optional limit for pagination. Default 50
-     * @returns Page of FindingBucketSummaryDto scoped to a tenant.
-     */
-    async getFindingBuckets(tid, offset = 0, limit = 50, keepOpenThresholdMs) {
-        const url = `/${this.targetApi}/v1/${this.kind}/_byUserBuckets`;
-        const res = await this.rest.call({
-            url,
-            method: 'GET',
-            params: {
-                tid,
-                limit,
-                offset,
-                keepOpenThresholdMs,
-            },
-        });
-        return (0, dto_1.toTypedPage)(dto_1._FindingBucketSummaryDto, res.data);
-    }
-    /**
-     * Returns a page of pending engagement findings scoped to a tenant.
-     * The page will contain findings that are
-     *  - pending to be engaged i.e no flow state exists for such findings.
-     *  - are not consolidated i.e should not be blocked by consolidation
-     *  - 'OPEN' status
-     *
-     * @param tid tenant id
-     * @param offset Optional offset for pagination. Default 0
-     * @param limit Optional limit for pagination. Default 50
-     * @returns Page of FindingDto scoped to a tenant.
-     */
-    async getPendingEngagements(tid, offset = 0, limit = 50) {
-        const url = `/${this.targetApi}/v1/${this.kind}/_pendingEngagements`;
-        return this.getPage({
-            url,
-            method: 'GET',
-            params: {
-                tid,
-                limit,
-                offset,
-            },
-        });
-    }
 }
 exports.FindingsService = FindingsService;
 //# sourceMappingURL=findings.service.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"findings.service.js","sourceRoot":"","sources":["../../../src/services/findings.service.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,gCAAqK;AAErK,2CAA+D;AAC/D,qDAAsD;AAOtD,MAAa,eAAgB,SAAQ,qCAAkE;IACrG,YAAY,IAAgB,EAAE,YAAuB,KAAK;QACxD,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,EAAU,EAAE,MAA2C;QAC3D,MAAM,GAAG,GAAG,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;QAClH,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,MAAyB;QAChC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,OAAmB;QACjC,MAAM,GAAG,GAAG,IAAI,6BAAiB,OAAO,IAAI,CAAC,IAAI,eAAe,CAAC;QACjE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACpB,GAAG;YACH,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,iBAAiB,CAAC,GAAW,EAAE,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE,EAAE,mBAA2B;QACtF,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,iBAAiB,CAAC;QAChE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,GAAG;YACH,MAAM,EAAE,KAAK;YACb,MAAM,EAAE;gBACN,GAAG;gBACH,KAAK;gBACL,MAAM;gBACN,mBAAmB;aACpB;SACF,CAAC,CAAC;QACH,OAAO,IAAA,iBAAW,EAAC,8BAAwB,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,qBAAqB,CAAC,GAAW,EAAE,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE;QAC7D,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,sBAAsB,CAAC;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,KAAK;YACb,MAAM,EAAE;gBACN,GAAG;gBACH,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAjFD,0CAiFC"}
+{"version":3,"file":"findings.service.js","sourceRoot":"","sources":["../../../src/services/findings.service.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAGvB,2CAA+D;AAC/D,qDAAsD;AAOtD,MAAa,eAAgB,SAAQ,qCAAkE;IACrG,YAAY,IAAgB,EAAE,YAAuB,KAAK;QACxD,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,EAAU,EAAE,MAA2C;QAC3D,MAAM,GAAG,GAAG,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;QAClH,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,MAAyB;QAChC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,OAAmB;QACjC,MAAM,GAAG,GAAG,IAAI,6BAAiB,OAAO,IAAI,CAAC,IAAI,eAAe,CAAC;QACjE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACpB,GAAG;YACH,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AA/BD,0CA+BC"}

package/package.json

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

package/src/dto/flows.dto.ts

@@ -2,7 +2,9 @@ import {z} from 'zod';
 import {_BaseDto, _BaseUpsertDto} from './base.dto';
 import {_PaginationFilter, _SortFilter} from '../FilterCriteria';
 import {FindingStatus} from './enums';
-import {_FindingBucketDto} from './findings.dto';
+
+export const EMAIL_CID = 'E00000000000';
+export const CUSTOM_FINDINGS_CID = 'C00000000000';
 
 export enum FlowSpecStatusKind {
   ACTIVE = 'ACTIVE',
@@ -144,6 +146,7 @@ export type FlowInterval = z.infer<typeof _FlowInterval>;
 const _FlowActionDetails = z.object({
   actionId: z.string().nullable(),
   findingStatus: z.nativeEnum(FindingStatus).optional().nullable(),
+  responseMessage: z.string().optional(),
 });
 
 export const _FlowActions = z.object({
@@ -182,6 +185,12 @@ export const _FlowRewardsConfig = z.object({
 });
 export type FlowRewardsConfig = z.infer<typeof _FlowRewardsConfig>;
 
+export const _EngagementEscalationConfig = z.object({
+  interval: _FlowInterval,
+  engagementChannelConnectorIds: z.array(z.string()),
+});
+export type EngagementEscalationConfig = z.infer<typeof _EngagementEscalationConfig>;
+
 export const _FlowSpecDto = _BaseDto.merge(
   z.object({
     id: z.string(),
@@ -199,7 +208,7 @@ export const _FlowSpecDto = _BaseDto.merge(
     triage: z.object({message: z.string(), yesAction: _FlowActionDetails, noAction: _FlowActionDetails}).optional(),
     reminderInterval: _FlowInterval.optional(),
     actions: _FlowActions.optional(),
-    emailEscalation: _FlowInterval.optional(),
+    escalation: _EngagementEscalationConfig.optional(),
     rewards: z.array(_FlowRewardsConfig).optional(),
     customMessage: z.object({template: z.string().optional(), append: z.boolean().optional()}).optional(),
     additionalContext: z.object({data: z.string().optional()}).optional(),

package/src/services/findings.service.ts

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import {FindingBucketSummaryDto, FindingDto, FindingStatus, Page, PlatformFindingDto, PlatformFindingUpsertDto, _FindingBucketSummaryDto, toTypedPage} from '../dto';
+import {FindingDto, FindingStatus, Page, PlatformFindingDto, PlatformFindingUpsertDto} from '../dto';
 import {RestClient, RestResponse} from './rest';
 import {KIND, TARGET_API_ENGAGE, TargetApi} from './constants';
 import {AmpEntityServiceImpl} from './entity.service';
@@ -40,54 +40,4 @@ export class FindingsService extends AmpEntityServiceImpl<PlatformFindingUpsertD
       params: finding,
     });
   }
-
-  /**
-   * Returns a page of FindingBucketSummaryDto scoped to a tenant. The page will contain 1
-   * result for each user + bucket combination. The result will be the MAX(bucketScore) and
-   * MIN(createdAt). The findings are also joined with flowStates to pull any running flows.
-   *
-   * @param tid tenant id
-   * @param offset Optional offset for pagination. Default 0
-   * @param limit Optional limit for pagination. Default 50
-   * @returns Page of FindingBucketSummaryDto scoped to a tenant.
-   */
-  async getFindingBuckets(tid: string, offset = 0, limit = 50, keepOpenThresholdMs: number): Promise<Page<FindingBucketSummaryDto>> {
-    const url = `/${this.targetApi}/v1/${this.kind}/_byUserBuckets`;
-    const res = await this.rest.call({
-      url,
-      method: 'GET',
-      params: {
-        tid,
-        limit,
-        offset,
-        keepOpenThresholdMs,
-      },
-    });
-    return toTypedPage(_FindingBucketSummaryDto, res.data);
-  }
-
-  /**
-   * Returns a page of pending engagement findings scoped to a tenant.
-   * The page will contain findings that are
-   *  - pending to be engaged i.e no flow state exists for such findings.
-   *  - are not consolidated i.e should not be blocked by consolidation
-   *  - 'OPEN' status
-   *
-   * @param tid tenant id
-   * @param offset Optional offset for pagination. Default 0
-   * @param limit Optional limit for pagination. Default 50
-   * @returns Page of FindingDto scoped to a tenant.
-   */
-  async getPendingEngagements(tid: string, offset = 0, limit = 50): Promise<Page<PlatformFindingDto>> {
-    const url = `/${this.targetApi}/v1/${this.kind}/_pendingEngagements`;
-    return this.getPage({
-      url,
-      method: 'GET',
-      params: {
-        tid,
-        limit,
-        offset,
-      },
-    });
-  }
 }