@ampsec/platform-client 70.3.1 → 70.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/build/src/services/findings.service.d.ts +13 -0
  2. package/build/src/services/findings.service.js +24 -0
  3. package/build/src/services/findings.service.js.map +1 -1
  4. package/package.json +1 -1
  5. package/src/services/findings.service.ts +25 -0
package/build/src/services/findings.service.d.ts CHANGED
@@ -22,4 +22,17 @@ export declare class FindingsService extends AmpEntityServiceImpl<PlatformFindin
22
22
  * @returns Page of FindingBucketSummaryDto scoped to a tenant.
23
23
  */
24
24
  getFindingBuckets(tid: string, offset: number | undefined, limit: number | undefined, keepOpenThresholdMs: number): Promise<Page<FindingBucketSummaryDto>>;
25
+ /**
26
+ * Returns a page of pending engagement findings scoped to a tenant.
27
+ * The page will contain findings that are
28
+ * - pending to be engaged i.e no flow state exists for such findings.
29
+ * - are not consolidated i.e should not be blocked by consolidation
30
+ * - 'OPEN' status
31
+ *
32
+ * @param tid tenant id
33
+ * @param offset Optional offset for pagination. Default 0
34
+ * @param limit Optional limit for pagination. Default 50
35
+ * @returns Page of FindingDto scoped to a tenant.
36
+ */
37
+ getPendingEngagements(tid: string, offset?: number, limit?: number): Promise<Page<PlatformFindingDto>>;
25
38
  }
package/build/src/services/findings.service.js CHANGED
@@ -60,6 +60,30 @@ class FindingsService extends entity_service_1.AmpEntityServiceImpl {
60
60
  });
61
61
  return (0, dto_1.toTypedPage)(dto_1._FindingBucketSummaryDto, res.data);
62
62
  }
63
+ /**
64
+ * Returns a page of pending engagement findings scoped to a tenant.
65
+ * The page will contain findings that are
66
+ * - pending to be engaged i.e no flow state exists for such findings.
67
+ * - are not consolidated i.e should not be blocked by consolidation
68
+ * - 'OPEN' status
69
+ *
70
+ * @param tid tenant id
71
+ * @param offset Optional offset for pagination. Default 0
72
+ * @param limit Optional limit for pagination. Default 50
73
+ * @returns Page of FindingDto scoped to a tenant.
74
+ */
75
+ async getPendingEngagements(tid, offset = 0, limit = 50) {
76
+ const url = `/${this.targetApi}/v1/${this.kind}/_pendingEngagements`;
77
+ return this.getPage({
78
+ url,
79
+ method: 'GET',
80
+ params: {
81
+ tid,
82
+ limit,
83
+ offset,
84
+ },
85
+ });
86
+ }
63
87
  }
64
88
  exports.FindingsService = FindingsService;
65
89
  //# sourceMappingURL=findings.service.js.map
package/build/src/services/findings.service.js.map CHANGED
@@ -1 +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;CACF;AAxDD,0CAwDC"}
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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ampsec/platform-client",
3
- "version": "70.3.1",
3
+ "version": "70.4.0",
4
4
  "description": "",
5
5
  "main": "build/src/index.js",
6
6
  "runkitExampleFilename": "example/main.js",
package/src/services/findings.service.ts CHANGED
@@ -65,4 +65,29 @@ export class FindingsService extends AmpEntityServiceImpl<PlatformFindingUpsertD
65
65
  });
66
66
  return toTypedPage(_FindingBucketSummaryDto, res.data);
67
67
  }
68
+
69
+ /**
70
+ * Returns a page of pending engagement findings scoped to a tenant.
71
+ * The page will contain findings that are
72
+ * - pending to be engaged i.e no flow state exists for such findings.
73
+ * - are not consolidated i.e should not be blocked by consolidation
74
+ * - 'OPEN' status
75
+ *
76
+ * @param tid tenant id
77
+ * @param offset Optional offset for pagination. Default 0
78
+ * @param limit Optional limit for pagination. Default 50
79
+ * @returns Page of FindingDto scoped to a tenant.
80
+ */
81
+ async getPendingEngagements(tid: string, offset = 0, limit = 50): Promise<Page<PlatformFindingDto>> {
82
+ const url = `/${this.targetApi}/v1/${this.kind}/_pendingEngagements`;
83
+ return this.getPage({
84
+ url,
85
+ method: 'GET',
86
+ params: {
87
+ tid,
88
+ limit,
89
+ offset,
90
+ },
91
+ });
92
+ }
68
93
  }