vanta-auditor-api-sdk 0.4.2 → 0.6.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.
- package/FUNCTIONS.md +2 -2
- package/README.md +65 -20
- package/docs/sdks/auditors/README.md +1 -2
- package/docs/sdks/audits/README.md +1884 -102
- package/funcs/auditorsCreate.d.ts.map +1 -1
- package/funcs/auditorsCreate.js +2 -1
- package/funcs/auditorsCreate.js.map +1 -1
- package/funcs/auditsAcceptInformationRequestEvidence.d.ts +31 -0
- package/funcs/auditsAcceptInformationRequestEvidence.d.ts.map +1 -0
- package/funcs/auditsAcceptInformationRequestEvidence.js +139 -0
- package/funcs/auditsAcceptInformationRequestEvidence.js.map +1 -0
- package/funcs/auditsCreateCommentForEvidence.d.ts.map +1 -1
- package/funcs/auditsCreateCommentForEvidence.js +2 -1
- package/funcs/auditsCreateCommentForEvidence.js.map +1 -1
- package/funcs/auditsCreateCommentForInformationRequest.d.ts +20 -0
- package/funcs/auditsCreateCommentForInformationRequest.d.ts.map +1 -0
- package/funcs/auditsCreateCommentForInformationRequest.js +130 -0
- package/funcs/auditsCreateCommentForInformationRequest.js.map +1 -0
- package/funcs/auditsCreateCustomControl.d.ts.map +1 -1
- package/funcs/auditsCreateCustomControl.js +2 -1
- package/funcs/auditsCreateCustomControl.js.map +1 -1
- package/funcs/auditsCreateCustomEvidenceRequest.d.ts.map +1 -1
- package/funcs/auditsCreateCustomEvidenceRequest.js +2 -1
- package/funcs/auditsCreateCustomEvidenceRequest.js.map +1 -1
- package/funcs/auditsCreateInformationRequest.d.ts +25 -0
- package/funcs/auditsCreateInformationRequest.d.ts.map +1 -0
- package/funcs/auditsCreateInformationRequest.js +131 -0
- package/funcs/auditsCreateInformationRequest.js.map +1 -0
- package/funcs/auditsDeleteCommentForInformationRequest.d.ts +19 -0
- package/funcs/auditsDeleteCommentForInformationRequest.d.ts.map +1 -0
- package/funcs/auditsDeleteCommentForInformationRequest.js +132 -0
- package/funcs/auditsDeleteCommentForInformationRequest.js.map +1 -0
- package/funcs/auditsDeleteInformationRequest.d.ts +27 -0
- package/funcs/auditsDeleteInformationRequest.d.ts.map +1 -0
- package/funcs/auditsDeleteInformationRequest.js +135 -0
- package/funcs/auditsDeleteInformationRequest.js.map +1 -0
- package/funcs/auditsFlagInformationRequestEvidence.d.ts +33 -0
- package/funcs/auditsFlagInformationRequestEvidence.d.ts.map +1 -0
- package/funcs/auditsFlagInformationRequestEvidence.js +143 -0
- package/funcs/auditsFlagInformationRequestEvidence.js.map +1 -0
- package/funcs/auditsGetAudit.d.ts +22 -0
- package/funcs/auditsGetAudit.d.ts.map +1 -0
- package/funcs/auditsGetAudit.js +125 -0
- package/funcs/auditsGetAudit.js.map +1 -0
- package/funcs/auditsGetEvidenceUrls.d.ts +2 -0
- package/funcs/auditsGetEvidenceUrls.d.ts.map +1 -1
- package/funcs/auditsGetEvidenceUrls.js +4 -1
- package/funcs/auditsGetEvidenceUrls.js.map +1 -1
- package/funcs/auditsGetFrameworkCodes.d.ts +23 -0
- package/funcs/auditsGetFrameworkCodes.d.ts.map +1 -0
- package/funcs/auditsGetFrameworkCodes.js +126 -0
- package/funcs/auditsGetFrameworkCodes.js.map +1 -0
- package/funcs/auditsGetInformationRequest.d.ts +23 -0
- package/funcs/auditsGetInformationRequest.d.ts.map +1 -0
- package/funcs/auditsGetInformationRequest.js +130 -0
- package/funcs/auditsGetInformationRequest.js.map +1 -0
- package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.d.ts +30 -0
- package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.d.ts.map +1 -0
- package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.js +143 -0
- package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.js.map +1 -0
- package/funcs/auditsList.d.ts +4 -0
- package/funcs/auditsList.d.ts.map +1 -1
- package/funcs/auditsList.js +6 -1
- package/funcs/auditsList.js.map +1 -1
- package/funcs/auditsListAuditIssues.d.ts +33 -0
- package/funcs/auditsListAuditIssues.d.ts.map +1 -0
- package/funcs/auditsListAuditIssues.js +143 -0
- package/funcs/auditsListAuditIssues.js.map +1 -0
- package/funcs/auditsListAuditSnapshots.d.ts +31 -0
- package/funcs/auditsListAuditSnapshots.d.ts.map +1 -0
- package/funcs/auditsListAuditSnapshots.js +140 -0
- package/funcs/auditsListAuditSnapshots.js.map +1 -0
- package/funcs/auditsListComments.d.ts.map +1 -1
- package/funcs/auditsListComments.js +2 -1
- package/funcs/auditsListComments.js.map +1 -1
- package/funcs/auditsListCommentsForInformationRequest.d.ts +39 -0
- package/funcs/auditsListCommentsForInformationRequest.d.ts.map +1 -0
- package/funcs/auditsListCommentsForInformationRequest.js +152 -0
- package/funcs/auditsListCommentsForInformationRequest.js.map +1 -0
- package/funcs/auditsListControls.d.ts.map +1 -1
- package/funcs/auditsListControls.js +2 -1
- package/funcs/auditsListControls.js.map +1 -1
- package/funcs/auditsListEvidence.d.ts.map +1 -1
- package/funcs/auditsListEvidence.js +2 -1
- package/funcs/auditsListEvidence.js.map +1 -1
- package/funcs/auditsListInformationRequestActivity.d.ts +35 -0
- package/funcs/auditsListInformationRequestActivity.d.ts.map +1 -0
- package/funcs/auditsListInformationRequestActivity.js +148 -0
- package/funcs/auditsListInformationRequestActivity.js.map +1 -0
- package/funcs/auditsListInformationRequestEvidence.d.ts +39 -0
- package/funcs/auditsListInformationRequestEvidence.d.ts.map +1 -0
- package/funcs/auditsListInformationRequestEvidence.js +153 -0
- package/funcs/auditsListInformationRequestEvidence.js.map +1 -0
- package/funcs/auditsListInformationRequests.d.ts +39 -0
- package/funcs/auditsListInformationRequests.d.ts.map +1 -0
- package/funcs/auditsListInformationRequests.js +148 -0
- package/funcs/auditsListInformationRequests.js.map +1 -0
- package/funcs/auditsListInformationRequestsForControl.d.ts +34 -0
- package/funcs/auditsListInformationRequestsForControl.d.ts.map +1 -0
- package/funcs/auditsListInformationRequestsForControl.js +146 -0
- package/funcs/auditsListInformationRequestsForControl.js.map +1 -0
- package/funcs/auditsShareInformationRequestList.d.ts +20 -0
- package/funcs/auditsShareInformationRequestList.d.ts.map +1 -0
- package/funcs/auditsShareInformationRequestList.js +123 -0
- package/funcs/auditsShareInformationRequestList.js.map +1 -0
- package/funcs/auditsUpdateCommentForInformationRequest.d.ts +20 -0
- package/funcs/auditsUpdateCommentForInformationRequest.d.ts.map +1 -0
- package/funcs/auditsUpdateCommentForInformationRequest.js +132 -0
- package/funcs/auditsUpdateCommentForInformationRequest.js.map +1 -0
- package/funcs/auditsUpdateEvidence.d.ts.map +1 -1
- package/funcs/auditsUpdateEvidence.js +2 -1
- package/funcs/auditsUpdateEvidence.js.map +1 -1
- package/funcs/auditsUpdateInformationRequest.d.ts +28 -0
- package/funcs/auditsUpdateInformationRequest.d.ts.map +1 -0
- package/funcs/auditsUpdateInformationRequest.js +138 -0
- package/funcs/auditsUpdateInformationRequest.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +5 -9
- package/lib/config.js.map +1 -1
- package/lib/encodings.d.ts +2 -0
- package/lib/encodings.d.ts.map +1 -1
- package/lib/encodings.js +39 -6
- package/lib/encodings.js.map +1 -1
- package/lib/files.d.ts +13 -0
- package/lib/files.d.ts.map +1 -1
- package/lib/files.js +19 -0
- package/lib/files.js.map +1 -1
- package/lib/matchers.d.ts.map +1 -1
- package/lib/matchers.js +0 -1
- package/lib/matchers.js.map +1 -1
- package/lib/sdks.d.ts +1 -1
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +12 -10
- package/lib/sdks.js.map +1 -1
- package/lib/security.d.ts +1 -1
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js +20 -10
- package/lib/security.js.map +1 -1
- package/lib/url.d.ts.map +1 -1
- package/lib/url.js +4 -2
- package/lib/url.js.map +1 -1
- package/models/components/acceptinformationrequestevidenceinput.d.ts +25 -0
- package/models/components/acceptinformationrequestevidenceinput.d.ts.map +1 -0
- package/models/components/acceptinformationrequestevidenceinput.js +49 -0
- package/models/components/acceptinformationrequestevidenceinput.js.map +1 -0
- package/models/components/addinformationrequestcommentinput.d.ts +44 -0
- package/models/components/addinformationrequestcommentinput.d.ts.map +1 -0
- package/models/components/addinformationrequestcommentinput.js +51 -0
- package/models/components/addinformationrequestcommentinput.js.map +1 -0
- package/models/components/audit.d.ts +31 -0
- package/models/components/audit.d.ts.map +1 -1
- package/models/components/audit.js +11 -1
- package/models/components/audit.js.map +1 -1
- package/models/components/auditorcontrol.d.ts +8 -0
- package/models/components/auditorcontrol.d.ts.map +1 -1
- package/models/components/auditorcontrol.js +2 -0
- package/models/components/auditorcontrol.js.map +1 -1
- package/models/components/comment.d.ts +9 -0
- package/models/components/comment.d.ts.map +1 -1
- package/models/components/comment.js +1 -0
- package/models/components/comment.js.map +1 -1
- package/models/components/control.d.ts +8 -0
- package/models/components/control.d.ts.map +1 -1
- package/models/components/control.js +2 -0
- package/models/components/control.js.map +1 -1
- package/models/components/createinformationrequestinput.d.ts +98 -0
- package/models/components/createinformationrequestinput.d.ts.map +1 -0
- package/models/components/createinformationrequestinput.js +70 -0
- package/models/components/createinformationrequestinput.js.map +1 -0
- package/models/components/deleteinformationrequestcommentinput.d.ts +25 -0
- package/models/components/deleteinformationrequestcommentinput.d.ts.map +1 -0
- package/models/components/deleteinformationrequestcommentinput.js +49 -0
- package/models/components/deleteinformationrequestcommentinput.js.map +1 -0
- package/models/components/evidenceurl.d.ts +4 -0
- package/models/components/evidenceurl.d.ts.map +1 -1
- package/models/components/evidenceurl.js +1 -0
- package/models/components/evidenceurl.js.map +1 -1
- package/models/components/flaginformationrequestevidenceinput.d.ts +36 -0
- package/models/components/flaginformationrequestevidenceinput.d.ts.map +1 -0
- package/models/components/flaginformationrequestevidenceinput.js +50 -0
- package/models/components/flaginformationrequestevidenceinput.js.map +1 -0
- package/models/components/frameworkcodes.d.ts +19 -0
- package/models/components/frameworkcodes.d.ts.map +1 -0
- package/models/components/frameworkcodes.js +50 -0
- package/models/components/frameworkcodes.js.map +1 -0
- package/models/components/index.d.ts +41 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +41 -0
- package/models/components/index.js.map +1 -1
- package/models/components/informationrequest.d.ts +191 -0
- package/models/components/informationrequest.d.ts.map +1 -0
- package/models/components/informationrequest.js +110 -0
- package/models/components/informationrequest.js.map +1 -0
- package/models/components/informationrequestactivitylog.d.ts +110 -0
- package/models/components/informationrequestactivitylog.d.ts.map +1 -0
- package/models/components/informationrequestactivitylog.js +89 -0
- package/models/components/informationrequestactivitylog.js.map +1 -0
- package/models/components/informationrequestactivitytype.d.ts +13 -0
- package/models/components/informationrequestactivitytype.d.ts.map +1 -0
- package/models/components/informationrequestactivitytype.js +50 -0
- package/models/components/informationrequestactivitytype.js.map +1 -0
- package/models/components/informationrequestapprovalstatus.d.ts +28 -0
- package/models/components/informationrequestapprovalstatus.d.ts.map +1 -0
- package/models/components/informationrequestapprovalstatus.js +57 -0
- package/models/components/informationrequestapprovalstatus.js.map +1 -0
- package/models/components/informationrequestcadence.d.ts +18 -0
- package/models/components/informationrequestcadence.d.ts.map +1 -0
- package/models/components/informationrequestcadence.js +52 -0
- package/models/components/informationrequestcadence.js.map +1 -0
- package/models/components/informationrequestcomment.d.ts +72 -0
- package/models/components/informationrequestcomment.d.ts.map +1 -0
- package/models/components/informationrequestcomment.js +56 -0
- package/models/components/informationrequestcomment.js.map +1 -0
- package/models/components/informationrequestevidence.d.ts +59 -0
- package/models/components/informationrequestevidence.d.ts.map +1 -0
- package/models/components/informationrequestevidence.js +58 -0
- package/models/components/informationrequestevidence.js.map +1 -0
- package/models/components/informationrequestevidenceunion.d.ts +21 -0
- package/models/components/informationrequestevidenceunion.d.ts.map +1 -0
- package/models/components/informationrequestevidenceunion.js +63 -0
- package/models/components/informationrequestevidenceunion.js.map +1 -0
- package/models/components/informationrequestsupportedevidencetype.d.ts +17 -0
- package/models/components/informationrequestsupportedevidencetype.d.ts.map +1 -0
- package/models/components/informationrequestsupportedevidencetype.js +55 -0
- package/models/components/informationrequestsupportedevidencetype.js.map +1 -0
- package/models/components/informationrequesttype.d.ts +31 -0
- package/models/components/informationrequesttype.d.ts.map +1 -0
- package/models/components/informationrequesttype.js +59 -0
- package/models/components/informationrequesttype.js.map +1 -0
- package/models/components/issuesnapshotitem.d.ts +65 -0
- package/models/components/issuesnapshotitem.d.ts.map +1 -0
- package/models/components/issuesnapshotitem.js +63 -0
- package/models/components/issuesnapshotitem.js.map +1 -0
- package/models/components/issuesnapshotmetadata.d.ts +25 -0
- package/models/components/issuesnapshotmetadata.d.ts.map +1 -0
- package/models/components/issuesnapshotmetadata.js +54 -0
- package/models/components/issuesnapshotmetadata.js.map +1 -0
- package/models/components/issuestatustypeforsnapshot.d.ts +11 -0
- package/models/components/issuestatustypeforsnapshot.d.ts.map +1 -0
- package/models/components/issuestatustypeforsnapshot.js +48 -0
- package/models/components/issuestatustypeforsnapshot.js.map +1 -0
- package/models/components/linkevidence.d.ts +24 -0
- package/models/components/linkevidence.d.ts.map +1 -0
- package/models/components/linkevidence.js +52 -0
- package/models/components/linkevidence.js.map +1 -0
- package/models/components/observationevidence.d.ts +16 -0
- package/models/components/observationevidence.d.ts.map +1 -0
- package/models/components/observationevidence.js +50 -0
- package/models/components/observationevidence.js.map +1 -0
- package/models/components/paginatedissuesnapshotitemsresponse.d.ts +22 -0
- package/models/components/paginatedissuesnapshotitemsresponse.d.ts.map +1 -0
- package/models/components/paginatedissuesnapshotitemsresponse.js +61 -0
- package/models/components/paginatedissuesnapshotitemsresponse.js.map +1 -0
- package/models/components/paginatedissuesnapshotmetadataresponse.d.ts +22 -0
- package/models/components/paginatedissuesnapshotmetadataresponse.d.ts.map +1 -0
- package/models/components/paginatedissuesnapshotmetadataresponse.js +61 -0
- package/models/components/paginatedissuesnapshotmetadataresponse.js.map +1 -0
- package/models/components/paginatedresponseinformationrequest.d.ts +22 -0
- package/models/components/paginatedresponseinformationrequest.d.ts.map +1 -0
- package/models/components/paginatedresponseinformationrequest.js +61 -0
- package/models/components/paginatedresponseinformationrequest.js.map +1 -0
- package/models/components/paginatedresponseinformationrequestactivitylog.d.ts +22 -0
- package/models/components/paginatedresponseinformationrequestactivitylog.d.ts.map +1 -0
- package/models/components/paginatedresponseinformationrequestactivitylog.js +61 -0
- package/models/components/paginatedresponseinformationrequestactivitylog.js.map +1 -0
- package/models/components/paginatedresponseinformationrequestcomment.d.ts +22 -0
- package/models/components/paginatedresponseinformationrequestcomment.d.ts.map +1 -0
- package/models/components/paginatedresponseinformationrequestcomment.js +61 -0
- package/models/components/paginatedresponseinformationrequestcomment.js.map +1 -0
- package/models/components/paginatedresponseinformationrequestevidence.d.ts +22 -0
- package/models/components/paginatedresponseinformationrequestevidence.d.ts.map +1 -0
- package/models/components/paginatedresponseinformationrequestevidence.js +61 -0
- package/models/components/paginatedresponseinformationrequestevidence.js.map +1 -0
- package/models/components/partialupdateinformationrequest.d.ts +69 -0
- package/models/components/partialupdateinformationrequest.d.ts.map +1 -0
- package/models/components/partialupdateinformationrequest.js +58 -0
- package/models/components/partialupdateinformationrequest.js.map +1 -0
- package/models/components/recurrenceduration.d.ts +1 -0
- package/models/components/recurrenceduration.d.ts.map +1 -1
- package/models/components/recurrenceduration.js +1 -0
- package/models/components/recurrenceduration.js.map +1 -1
- package/models/components/section.d.ts +20 -0
- package/models/components/section.d.ts.map +1 -1
- package/models/components/section.js +11 -1
- package/models/components/section.js.map +1 -1
- package/models/components/updateinformationrequestcommentinput.d.ts +34 -0
- package/models/components/updateinformationrequestcommentinput.d.ts.map +1 -0
- package/models/components/updateinformationrequestcommentinput.js +50 -0
- package/models/components/updateinformationrequestcommentinput.js.map +1 -0
- package/models/components/uploadeddocumentevidence.d.ts +41 -0
- package/models/components/uploadeddocumentevidence.d.ts.map +1 -0
- package/models/components/uploadeddocumentevidence.js +53 -0
- package/models/components/uploadeddocumentevidence.js.map +1 -0
- package/models/components/vantadocumentevidence.d.ts +78 -0
- package/models/components/vantadocumentevidence.d.ts.map +1 -0
- package/models/components/vantadocumentevidence.js +79 -0
- package/models/components/vantadocumentevidence.js.map +1 -0
- package/models/components/vantadocumentlinkevidence.d.ts +27 -0
- package/models/components/vantadocumentlinkevidence.d.ts.map +1 -0
- package/models/components/vantadocumentlinkevidence.js +52 -0
- package/models/components/vantadocumentlinkevidence.js.map +1 -0
- package/models/components/vantadocumentuploadedevidence.d.ts +45 -0
- package/models/components/vantadocumentuploadedevidence.d.ts.map +1 -0
- package/models/components/vantadocumentuploadedevidence.js +54 -0
- package/models/components/vantadocumentuploadedevidence.js.map +1 -0
- package/models/components/vantapolicyevidence.d.ts +126 -0
- package/models/components/vantapolicyevidence.d.ts.map +1 -0
- package/models/components/vantapolicyevidence.js +79 -0
- package/models/components/vantapolicyevidence.js.map +1 -0
- package/models/components/vantatestevidence.d.ts +71 -0
- package/models/components/vantatestevidence.d.ts.map +1 -0
- package/models/components/vantatestevidence.js +67 -0
- package/models/components/vantatestevidence.js.map +1 -0
- package/models/components/vantatestfiletype.d.ts +12 -0
- package/models/components/vantatestfiletype.d.ts.map +1 -0
- package/models/components/vantatestfiletype.js +49 -0
- package/models/components/vantatestfiletype.js.map +1 -0
- package/models/components/vantatestrunstatus.d.ts +14 -0
- package/models/components/vantatestrunstatus.d.ts.map +1 -0
- package/models/components/vantatestrunstatus.js +51 -0
- package/models/components/vantatestrunstatus.js.map +1 -0
- package/models/components/vantatestsnapshotevidence.d.ts +68 -0
- package/models/components/vantatestsnapshotevidence.d.ts.map +1 -0
- package/models/components/vantatestsnapshotevidence.js +68 -0
- package/models/components/vantatestsnapshotevidence.js.map +1 -0
- package/models/components/vantatestsnapshotevidencedetail.d.ts +66 -0
- package/models/components/vantatestsnapshotevidencedetail.d.ts.map +1 -0
- package/models/components/vantatestsnapshotevidencedetail.js +76 -0
- package/models/components/vantatestsnapshotevidencedetail.js.map +1 -0
- package/models/components/vantatestsnapshotintegration.d.ts +14 -0
- package/models/components/vantatestsnapshotintegration.d.ts.map +1 -0
- package/models/components/vantatestsnapshotintegration.js +51 -0
- package/models/components/vantatestsnapshotintegration.js.map +1 -0
- package/models/components/vantatestsnapshotrawtestdatarow.d.ts +41 -0
- package/models/components/vantatestsnapshotrawtestdatarow.d.ts.map +1 -0
- package/models/components/vantatestsnapshotrawtestdatarow.js +52 -0
- package/models/components/vantatestsnapshotrawtestdatarow.js.map +1 -0
- package/models/operations/acceptinformationrequestevidence.d.ts +17 -0
- package/models/operations/acceptinformationrequestevidence.d.ts.map +1 -0
- package/models/operations/acceptinformationrequestevidence.js +57 -0
- package/models/operations/acceptinformationrequestevidence.js.map +1 -0
- package/models/operations/createcommentforinformationrequest.d.ts +17 -0
- package/models/operations/createcommentforinformationrequest.d.ts.map +1 -0
- package/models/operations/createcommentforinformationrequest.js +57 -0
- package/models/operations/createcommentforinformationrequest.js.map +1 -0
- package/models/operations/createinformationrequest.d.ts +15 -0
- package/models/operations/createinformationrequest.d.ts.map +1 -0
- package/models/operations/createinformationrequest.js +56 -0
- package/models/operations/createinformationrequest.js.map +1 -0
- package/models/operations/deletecommentforinformationrequest.d.ts +19 -0
- package/models/operations/deletecommentforinformationrequest.d.ts.map +1 -0
- package/models/operations/deletecommentforinformationrequest.js +58 -0
- package/models/operations/deletecommentforinformationrequest.js.map +1 -0
- package/models/operations/deleteinformationrequest.d.ts +14 -0
- package/models/operations/deleteinformationrequest.d.ts.map +1 -0
- package/models/operations/deleteinformationrequest.js +50 -0
- package/models/operations/deleteinformationrequest.js.map +1 -0
- package/models/operations/flaginformationrequestevidence.d.ts +17 -0
- package/models/operations/flaginformationrequestevidence.d.ts.map +1 -0
- package/models/operations/flaginformationrequestevidence.js +57 -0
- package/models/operations/flaginformationrequestevidence.js.map +1 -0
- package/models/operations/getaudit.d.ts +12 -0
- package/models/operations/getaudit.d.ts.map +1 -0
- package/models/operations/getaudit.js +49 -0
- package/models/operations/getaudit.js.map +1 -0
- package/models/operations/getframeworkcodes.d.ts +12 -0
- package/models/operations/getframeworkcodes.d.ts.map +1 -0
- package/models/operations/getframeworkcodes.js +49 -0
- package/models/operations/getframeworkcodes.js.map +1 -0
- package/models/operations/getinformationrequest.d.ts +14 -0
- package/models/operations/getinformationrequest.d.ts.map +1 -0
- package/models/operations/getinformationrequest.js +50 -0
- package/models/operations/getinformationrequest.js.map +1 -0
- package/models/operations/getinformationrequesttestsnapshotevidencedetail.d.ts +16 -0
- package/models/operations/getinformationrequesttestsnapshotevidencedetail.d.ts.map +1 -0
- package/models/operations/getinformationrequesttestsnapshotevidencedetail.js +51 -0
- package/models/operations/getinformationrequesttestsnapshotevidencedetail.js.map +1 -0
- package/models/operations/index.d.ts +20 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +20 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/listauditissues.d.ts +35 -0
- package/models/operations/listauditissues.d.ts.map +1 -0
- package/models/operations/listauditissues.js +53 -0
- package/models/operations/listauditissues.js.map +1 -0
- package/models/operations/listauditsnapshots.d.ts +30 -0
- package/models/operations/listauditsnapshots.d.ts.map +1 -0
- package/models/operations/listauditsnapshots.js +52 -0
- package/models/operations/listauditsnapshots.js.map +1 -0
- package/models/operations/listcommentsforinformationrequest.d.ts +32 -0
- package/models/operations/listcommentsforinformationrequest.d.ts.map +1 -0
- package/models/operations/listcommentsforinformationrequest.js +53 -0
- package/models/operations/listcommentsforinformationrequest.js.map +1 -0
- package/models/operations/listinformationrequestactivity.d.ts +29 -0
- package/models/operations/listinformationrequestactivity.d.ts.map +1 -0
- package/models/operations/listinformationrequestactivity.js +53 -0
- package/models/operations/listinformationrequestactivity.js.map +1 -0
- package/models/operations/listinformationrequestevidence.d.ts +42 -0
- package/models/operations/listinformationrequestevidence.d.ts.map +1 -0
- package/models/operations/listinformationrequestevidence.js +55 -0
- package/models/operations/listinformationrequestevidence.js.map +1 -0
- package/models/operations/listinformationrequests.d.ts +30 -0
- package/models/operations/listinformationrequests.d.ts.map +1 -0
- package/models/operations/listinformationrequests.js +52 -0
- package/models/operations/listinformationrequests.js.map +1 -0
- package/models/operations/listinformationrequestsforcontrol.d.ts +24 -0
- package/models/operations/listinformationrequestsforcontrol.d.ts.map +1 -0
- package/models/operations/listinformationrequestsforcontrol.js +52 -0
- package/models/operations/listinformationrequestsforcontrol.js.map +1 -0
- package/models/operations/shareinformationrequestlist.d.ts +12 -0
- package/models/operations/shareinformationrequestlist.d.ts.map +1 -0
- package/models/operations/shareinformationrequestlist.js +49 -0
- package/models/operations/shareinformationrequestlist.js.map +1 -0
- package/models/operations/updatecommentforinformationrequest.d.ts +19 -0
- package/models/operations/updatecommentforinformationrequest.d.ts.map +1 -0
- package/models/operations/updatecommentforinformationrequest.js +58 -0
- package/models/operations/updatecommentforinformationrequest.js.map +1 -0
- package/models/operations/updateinformationrequest.d.ts +17 -0
- package/models/operations/updateinformationrequest.d.ts.map +1 -0
- package/models/operations/updateinformationrequest.js +57 -0
- package/models/operations/updateinformationrequest.js.map +1 -0
- package/package.json +3 -3
- package/sdk/audits.d.ts +378 -19
- package/sdk/audits.d.ts.map +1 -1
- package/sdk/audits.js +444 -25
- package/sdk/audits.js.map +1 -1
- package/sdk/sdk.d.ts +2 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +3 -3
- package/sdk/sdk.js.map +1 -1
- package/smoke-test/src/smoke.test.ts +201 -0
- package/smoke-test/vitest.config.ts +11 -0
- package/src/funcs/auditorsCreate.ts +3 -1
- package/src/funcs/auditsAcceptInformationRequestEvidence.ts +195 -0
- package/src/funcs/auditsCreateCommentForEvidence.ts +3 -2
- package/src/funcs/auditsCreateCommentForInformationRequest.ts +182 -0
- package/src/funcs/auditsCreateCustomControl.ts +3 -2
- package/src/funcs/auditsCreateCustomEvidenceRequest.ts +3 -2
- package/src/funcs/auditsCreateInformationRequest.ts +179 -0
- package/src/funcs/auditsDeleteCommentForInformationRequest.ts +188 -0
- package/src/funcs/auditsDeleteInformationRequest.ts +185 -0
- package/src/funcs/auditsFlagInformationRequestEvidence.ts +195 -0
- package/src/funcs/auditsGetAudit.ts +172 -0
- package/src/funcs/auditsGetEvidenceUrls.ts +5 -2
- package/src/funcs/auditsGetFrameworkCodes.ts +173 -0
- package/src/funcs/auditsGetInformationRequest.ts +180 -0
- package/src/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.ts +193 -0
- package/src/funcs/auditsList.ts +7 -1
- package/src/funcs/auditsListAuditIssues.ts +191 -0
- package/src/funcs/auditsListAuditSnapshots.ts +191 -0
- package/src/funcs/auditsListComments.ts +3 -2
- package/src/funcs/auditsListCommentsForInformationRequest.ts +208 -0
- package/src/funcs/auditsListControls.ts +3 -2
- package/src/funcs/auditsListEvidence.ts +3 -2
- package/src/funcs/auditsListInformationRequestActivity.ts +204 -0
- package/src/funcs/auditsListInformationRequestEvidence.ts +209 -0
- package/src/funcs/auditsListInformationRequests.ts +197 -0
- package/src/funcs/auditsListInformationRequestsForControl.ts +199 -0
- package/src/funcs/auditsShareInformationRequestList.ts +173 -0
- package/src/funcs/auditsUpdateCommentForInformationRequest.ts +188 -0
- package/src/funcs/auditsUpdateEvidence.ts +3 -2
- package/src/funcs/auditsUpdateInformationRequest.ts +188 -0
- package/src/lib/config.ts +5 -9
- package/src/lib/encodings.ts +49 -7
- package/src/lib/files.ts +22 -0
- package/src/lib/matchers.ts +3 -2
- package/src/lib/sdks.ts +12 -13
- package/src/lib/security.ts +15 -4
- package/src/lib/url.ts +16 -14
- package/src/models/components/acceptinformationrequestevidenceinput.ts +46 -0
- package/src/models/components/addinformationrequestcommentinput.ts +67 -0
- package/src/models/components/audit.ts +54 -0
- package/src/models/components/auditorcontrol.ts +14 -0
- package/src/models/components/comment.ts +10 -0
- package/src/models/components/control.ts +14 -0
- package/src/models/components/createinformationrequestinput.ts +138 -0
- package/src/models/components/deleteinformationrequestcommentinput.ts +46 -0
- package/src/models/components/evidenceurl.ts +5 -0
- package/src/models/components/flaginformationrequestevidenceinput.ts +58 -0
- package/src/models/components/frameworkcodes.ts +40 -0
- package/src/models/components/index.ts +41 -0
- package/src/models/components/informationrequest.ts +295 -0
- package/src/models/components/informationrequestactivitylog.ts +146 -0
- package/src/models/components/informationrequestactivitytype.ts +22 -0
- package/src/models/components/informationrequestapprovalstatus.ts +37 -0
- package/src/models/components/informationrequestcadence.ts +27 -0
- package/src/models/components/informationrequestcomment.ts +105 -0
- package/src/models/components/informationrequestevidence.ts +100 -0
- package/src/models/components/informationrequestevidenceunion.ts +73 -0
- package/src/models/components/informationrequestsupportedevidencetype.ts +28 -0
- package/src/models/components/informationrequesttype.ts +40 -0
- package/src/models/components/issuesnapshotitem.ts +105 -0
- package/src/models/components/issuesnapshotmetadata.ts +50 -0
- package/src/models/components/issuestatustypeforsnapshot.ts +20 -0
- package/src/models/components/linkevidence.ts +47 -0
- package/src/models/components/observationevidence.ts +37 -0
- package/src/models/components/paginatedissuesnapshotitemsresponse.ts +71 -0
- package/src/models/components/paginatedissuesnapshotmetadataresponse.ts +74 -0
- package/src/models/components/paginatedresponseinformationrequest.ts +71 -0
- package/src/models/components/paginatedresponseinformationrequestactivitylog.ts +80 -0
- package/src/models/components/paginatedresponseinformationrequestcomment.ts +77 -0
- package/src/models/components/paginatedresponseinformationrequestevidence.ts +80 -0
- package/src/models/components/partialupdateinformationrequest.ts +103 -0
- package/src/models/components/recurrenceduration.ts +1 -0
- package/src/models/components/section.ts +39 -0
- package/src/models/components/updateinformationrequestcommentinput.ts +56 -0
- package/src/models/components/uploadeddocumentevidence.ts +65 -0
- package/src/models/components/vantadocumentevidence.ts +145 -0
- package/src/models/components/vantadocumentlinkevidence.ts +50 -0
- package/src/models/components/vantadocumentuploadedevidence.ts +70 -0
- package/src/models/components/vantapolicyevidence.ts +198 -0
- package/src/models/components/vantatestevidence.ts +122 -0
- package/src/models/components/vantatestfiletype.ts +19 -0
- package/src/models/components/vantatestrunstatus.ts +21 -0
- package/src/models/components/vantatestsnapshotevidence.ts +100 -0
- package/src/models/components/vantatestsnapshotevidencedetail.ts +135 -0
- package/src/models/components/vantatestsnapshotintegration.ts +36 -0
- package/src/models/components/vantatestsnapshotrawtestdatarow.ts +64 -0
- package/src/models/operations/acceptinformationrequestevidence.ts +50 -0
- package/src/models/operations/createcommentforinformationrequest.ts +50 -0
- package/src/models/operations/createinformationrequest.ts +44 -0
- package/src/models/operations/deletecommentforinformationrequest.ts +54 -0
- package/src/models/operations/deleteinformationrequest.ts +36 -0
- package/src/models/operations/flaginformationrequestevidence.ts +48 -0
- package/src/models/operations/getaudit.ts +29 -0
- package/src/models/operations/getframeworkcodes.ts +31 -0
- package/src/models/operations/getinformationrequest.ts +36 -0
- package/src/models/operations/getinformationrequesttestsnapshotevidencedetail.ts +41 -0
- package/src/models/operations/index.ts +20 -0
- package/src/models/operations/listauditissues.ts +58 -0
- package/src/models/operations/listauditsnapshots.ts +52 -0
- package/src/models/operations/listcommentsforinformationrequest.ts +58 -0
- package/src/models/operations/listinformationrequestactivity.ts +54 -0
- package/src/models/operations/listinformationrequestevidence.ts +72 -0
- package/src/models/operations/listinformationrequests.ts +54 -0
- package/src/models/operations/listinformationrequestsforcontrol.ts +49 -0
- package/src/models/operations/shareinformationrequestlist.ts +33 -0
- package/src/models/operations/updatecommentforinformationrequest.ts +54 -0
- package/src/models/operations/updateinformationrequest.ts +47 -0
- package/src/sdk/audits.ts +616 -37
- package/src/sdk/sdk.ts +5 -5
- package/src/types/enums.ts +1 -21
- package/src/types/index.ts +2 -1
- package/src/types/unrecognized.ts +35 -0
- package/types/enums.d.ts +1 -8
- package/types/enums.d.ts.map +1 -1
- package/types/enums.js +3 -21
- package/types/enums.js.map +1 -1
- package/types/index.d.ts +2 -1
- package/types/index.d.ts.map +1 -1
- package/types/index.js +15 -0
- package/types/index.js.map +1 -1
- package/types/unrecognized.d.ts +16 -0
- package/types/unrecognized.d.ts.map +1 -0
- package/types/unrecognized.js +34 -0
- package/types/unrecognized.js.map +1 -0
- package/.devcontainer/devcontainer.json +0 -45
- package/examples/package-lock.json +0 -610
- package/examples/package.json +0 -18
- package/tsconfig.json +0 -41
package/src/sdk/audits.ts
CHANGED
|
@@ -2,15 +2,35 @@
|
|
|
2
2
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
|
+
import { auditsAcceptInformationRequestEvidence } from "../funcs/auditsAcceptInformationRequestEvidence.js";
|
|
5
6
|
import { auditsCreateCommentForEvidence } from "../funcs/auditsCreateCommentForEvidence.js";
|
|
7
|
+
import { auditsCreateCommentForInformationRequest } from "../funcs/auditsCreateCommentForInformationRequest.js";
|
|
6
8
|
import { auditsCreateCustomControl } from "../funcs/auditsCreateCustomControl.js";
|
|
7
9
|
import { auditsCreateCustomEvidenceRequest } from "../funcs/auditsCreateCustomEvidenceRequest.js";
|
|
10
|
+
import { auditsCreateInformationRequest } from "../funcs/auditsCreateInformationRequest.js";
|
|
11
|
+
import { auditsDeleteCommentForInformationRequest } from "../funcs/auditsDeleteCommentForInformationRequest.js";
|
|
12
|
+
import { auditsDeleteInformationRequest } from "../funcs/auditsDeleteInformationRequest.js";
|
|
13
|
+
import { auditsFlagInformationRequestEvidence } from "../funcs/auditsFlagInformationRequestEvidence.js";
|
|
14
|
+
import { auditsGetAudit } from "../funcs/auditsGetAudit.js";
|
|
8
15
|
import { auditsGetEvidenceUrls } from "../funcs/auditsGetEvidenceUrls.js";
|
|
16
|
+
import { auditsGetFrameworkCodes } from "../funcs/auditsGetFrameworkCodes.js";
|
|
17
|
+
import { auditsGetInformationRequest } from "../funcs/auditsGetInformationRequest.js";
|
|
18
|
+
import { auditsGetInformationRequestTestSnapshotEvidenceDetail } from "../funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.js";
|
|
9
19
|
import { auditsList } from "../funcs/auditsList.js";
|
|
20
|
+
import { auditsListAuditIssues } from "../funcs/auditsListAuditIssues.js";
|
|
21
|
+
import { auditsListAuditSnapshots } from "../funcs/auditsListAuditSnapshots.js";
|
|
10
22
|
import { auditsListComments } from "../funcs/auditsListComments.js";
|
|
23
|
+
import { auditsListCommentsForInformationRequest } from "../funcs/auditsListCommentsForInformationRequest.js";
|
|
11
24
|
import { auditsListControls } from "../funcs/auditsListControls.js";
|
|
12
25
|
import { auditsListEvidence } from "../funcs/auditsListEvidence.js";
|
|
26
|
+
import { auditsListInformationRequestActivity } from "../funcs/auditsListInformationRequestActivity.js";
|
|
27
|
+
import { auditsListInformationRequestEvidence } from "../funcs/auditsListInformationRequestEvidence.js";
|
|
28
|
+
import { auditsListInformationRequests } from "../funcs/auditsListInformationRequests.js";
|
|
29
|
+
import { auditsListInformationRequestsForControl } from "../funcs/auditsListInformationRequestsForControl.js";
|
|
30
|
+
import { auditsShareInformationRequestList } from "../funcs/auditsShareInformationRequestList.js";
|
|
31
|
+
import { auditsUpdateCommentForInformationRequest } from "../funcs/auditsUpdateCommentForInformationRequest.js";
|
|
13
32
|
import { auditsUpdateEvidence } from "../funcs/auditsUpdateEvidence.js";
|
|
33
|
+
import { auditsUpdateInformationRequest } from "../funcs/auditsUpdateInformationRequest.js";
|
|
14
34
|
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
15
35
|
import * as components from "../models/components/index.js";
|
|
16
36
|
import * as operations from "../models/operations/index.js";
|
|
@@ -22,6 +42,10 @@ export class Audits extends ClientSDK {
|
|
|
22
42
|
*
|
|
23
43
|
* @remarks
|
|
24
44
|
* Returns a paginated list of audits scoped to the audit firm.
|
|
45
|
+
*
|
|
46
|
+
* To identify IRL (Information Request List) audits, check for the presence of the
|
|
47
|
+
* `auditorRequestListMetadata` field. This field is only present for IRL-based audits
|
|
48
|
+
* and will be `undefined` for standard audits.
|
|
25
49
|
*/
|
|
26
50
|
async list(
|
|
27
51
|
request: operations.ListAuditsRequest,
|
|
@@ -35,17 +59,104 @@ export class Audits extends ClientSDK {
|
|
|
35
59
|
}
|
|
36
60
|
|
|
37
61
|
/**
|
|
38
|
-
*
|
|
62
|
+
* Get audit by ID
|
|
39
63
|
*
|
|
40
64
|
* @remarks
|
|
41
|
-
* Returns a
|
|
42
|
-
*
|
|
65
|
+
* Returns a single audit by ID, scoped to the audit firm.
|
|
66
|
+
*
|
|
67
|
+
* To identify IRL (Information Request List) audits, check for the presence of the
|
|
68
|
+
* `auditorRequestListMetadata` field. This field is only present for IRL-based audits
|
|
69
|
+
* and will be `undefined` for standard audits.
|
|
43
70
|
*/
|
|
44
|
-
async
|
|
45
|
-
request: operations.
|
|
71
|
+
async getAudit(
|
|
72
|
+
request: operations.GetAuditRequest,
|
|
46
73
|
options?: RequestOptions,
|
|
47
|
-
): Promise<components.
|
|
48
|
-
return unwrapAsync(
|
|
74
|
+
): Promise<components.Audit> {
|
|
75
|
+
return unwrapAsync(auditsGetAudit(
|
|
76
|
+
this,
|
|
77
|
+
request,
|
|
78
|
+
options,
|
|
79
|
+
));
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* List audit comments
|
|
84
|
+
*
|
|
85
|
+
* @remarks
|
|
86
|
+
* Returns a paginated list of comments for an audit.
|
|
87
|
+
*/
|
|
88
|
+
async listComments(
|
|
89
|
+
request: operations.ListAuditCommentsRequest,
|
|
90
|
+
options?: RequestOptions,
|
|
91
|
+
): Promise<components.PaginatedResponseComment> {
|
|
92
|
+
return unwrapAsync(auditsListComments(
|
|
93
|
+
this,
|
|
94
|
+
request,
|
|
95
|
+
options,
|
|
96
|
+
));
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* List audit controls
|
|
101
|
+
*
|
|
102
|
+
* @remarks
|
|
103
|
+
* Returns a paginated list of controls for an audit.
|
|
104
|
+
*/
|
|
105
|
+
async listControls(
|
|
106
|
+
request: operations.ListAuditControlsRequest,
|
|
107
|
+
options?: RequestOptions,
|
|
108
|
+
): Promise<components.PaginatedResponseAuditorControl> {
|
|
109
|
+
return unwrapAsync(auditsListControls(
|
|
110
|
+
this,
|
|
111
|
+
request,
|
|
112
|
+
options,
|
|
113
|
+
));
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Create a custom control for an audit
|
|
118
|
+
*
|
|
119
|
+
* @remarks
|
|
120
|
+
* Create a custom control for an audit.
|
|
121
|
+
*/
|
|
122
|
+
async createCustomControl(
|
|
123
|
+
request: operations.CreateCustomControlRequest,
|
|
124
|
+
options?: RequestOptions,
|
|
125
|
+
): Promise<components.Control> {
|
|
126
|
+
return unwrapAsync(auditsCreateCustomControl(
|
|
127
|
+
this,
|
|
128
|
+
request,
|
|
129
|
+
options,
|
|
130
|
+
));
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* List information requests linked to a control within an audit
|
|
135
|
+
*
|
|
136
|
+
* @remarks
|
|
137
|
+
* Returns a paginated list of active information requests linked to a specific
|
|
138
|
+
* control within an IRL audit. An information request is linked to a control
|
|
139
|
+
* either via its framework codes (`criteriaIds`) or via a direct association
|
|
140
|
+
* (`additionalControlIds`).
|
|
141
|
+
*
|
|
142
|
+
* Soft-deleted information requests are not included in the response. To
|
|
143
|
+
* synchronize deletions, use `GET /audits/{auditId}/information-requests`,
|
|
144
|
+
* which supports `changedSinceDate` and includes soft-deleted records.
|
|
145
|
+
*
|
|
146
|
+
* Returns 404 when the control is not part of the audit. Returns an empty page
|
|
147
|
+
* when the control is part of the audit but has no active IRLs linked to it.
|
|
148
|
+
*
|
|
149
|
+
* Pagination usage:
|
|
150
|
+
* 1. Make initial request with desired `pageSize`
|
|
151
|
+
* 2. Check `results.pageInfo.hasNextPage` to see if more data exists
|
|
152
|
+
* 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
|
|
153
|
+
* 4. Repeat until `hasNextPage` is false
|
|
154
|
+
*/
|
|
155
|
+
async listInformationRequestsForControl(
|
|
156
|
+
request: operations.ListInformationRequestsForControlRequest,
|
|
157
|
+
options?: RequestOptions,
|
|
158
|
+
): Promise<components.PaginatedResponseInformationRequest> {
|
|
159
|
+
return unwrapAsync(auditsListInformationRequestsForControl(
|
|
49
160
|
this,
|
|
50
161
|
request,
|
|
51
162
|
options,
|
|
@@ -70,16 +181,16 @@ export class Audits extends ClientSDK {
|
|
|
70
181
|
}
|
|
71
182
|
|
|
72
183
|
/**
|
|
73
|
-
*
|
|
184
|
+
* Create a custom evidence request for an audit
|
|
74
185
|
*
|
|
75
186
|
* @remarks
|
|
76
|
-
*
|
|
187
|
+
* Create a custom evidence request for an audit.
|
|
77
188
|
*/
|
|
78
|
-
async
|
|
79
|
-
request: operations.
|
|
189
|
+
async createCustomEvidenceRequest(
|
|
190
|
+
request: operations.CreateCustomEvidenceRequestRequest,
|
|
80
191
|
options?: RequestOptions,
|
|
81
|
-
): Promise<components.
|
|
82
|
-
return unwrapAsync(
|
|
192
|
+
): Promise<components.CustomEvidenceRequest> {
|
|
193
|
+
return unwrapAsync(auditsCreateCustomEvidenceRequest(
|
|
83
194
|
this,
|
|
84
195
|
request,
|
|
85
196
|
options,
|
|
@@ -87,16 +198,16 @@ export class Audits extends ClientSDK {
|
|
|
87
198
|
}
|
|
88
199
|
|
|
89
200
|
/**
|
|
90
|
-
*
|
|
201
|
+
* Update audit evidence
|
|
91
202
|
*
|
|
92
203
|
* @remarks
|
|
93
|
-
*
|
|
204
|
+
* Update audit evidence.
|
|
94
205
|
*/
|
|
95
|
-
async
|
|
96
|
-
request: operations.
|
|
206
|
+
async updateEvidence(
|
|
207
|
+
request: operations.UpdateAuditEvidenceRequest,
|
|
97
208
|
options?: RequestOptions,
|
|
98
|
-
): Promise<components.
|
|
99
|
-
return unwrapAsync(
|
|
209
|
+
): Promise<components.Evidence> {
|
|
210
|
+
return unwrapAsync(auditsUpdateEvidence(
|
|
100
211
|
this,
|
|
101
212
|
request,
|
|
102
213
|
options,
|
|
@@ -121,16 +232,19 @@ export class Audits extends ClientSDK {
|
|
|
121
232
|
}
|
|
122
233
|
|
|
123
234
|
/**
|
|
124
|
-
*
|
|
235
|
+
* List audit evidence url
|
|
125
236
|
*
|
|
126
237
|
* @remarks
|
|
127
|
-
*
|
|
238
|
+
* Returns a paginated list of evidence urls for an audit. This endpoint should be called whenever an
|
|
239
|
+
* evidence is created or has a statusUpdatedAt field that is more recent than the most recent polling event.
|
|
240
|
+
*
|
|
241
|
+
* Evidence must be in one of the following states to retrieve URLs: "Ready for audit", "Accepted", "Flagged", or "NA".
|
|
128
242
|
*/
|
|
129
|
-
async
|
|
130
|
-
request: operations.
|
|
243
|
+
async getEvidenceUrls(
|
|
244
|
+
request: operations.ListAuditEvidenceUrlsRequest,
|
|
131
245
|
options?: RequestOptions,
|
|
132
|
-
): Promise<components.
|
|
133
|
-
return unwrapAsync(
|
|
246
|
+
): Promise<components.PaginatedResponseEvidenceUrl> {
|
|
247
|
+
return unwrapAsync(auditsGetEvidenceUrls(
|
|
134
248
|
this,
|
|
135
249
|
request,
|
|
136
250
|
options,
|
|
@@ -138,16 +252,21 @@ export class Audits extends ClientSDK {
|
|
|
138
252
|
}
|
|
139
253
|
|
|
140
254
|
/**
|
|
141
|
-
*
|
|
255
|
+
* Get framework codes for an audit
|
|
142
256
|
*
|
|
143
257
|
* @remarks
|
|
144
|
-
*
|
|
258
|
+
* Retrieves all valid framework codes for the specified audit. This endpoint helps users discover which framework codes are available for creating and updating information requests for this audit.
|
|
259
|
+
*
|
|
260
|
+
* Use this endpoint to:
|
|
261
|
+
* - Discover available framework codes before creating information requests
|
|
262
|
+
* - Validate framework codes against the audit's framework
|
|
263
|
+
* - Get context about what framework codes are available for the audit type
|
|
145
264
|
*/
|
|
146
|
-
async
|
|
147
|
-
request: operations.
|
|
265
|
+
async getFrameworkCodes(
|
|
266
|
+
request: operations.GetFrameworkCodesRequest,
|
|
148
267
|
options?: RequestOptions,
|
|
149
|
-
): Promise<components.
|
|
150
|
-
return unwrapAsync(
|
|
268
|
+
): Promise<components.FrameworkCodes> {
|
|
269
|
+
return unwrapAsync(auditsGetFrameworkCodes(
|
|
151
270
|
this,
|
|
152
271
|
request,
|
|
153
272
|
options,
|
|
@@ -155,16 +274,476 @@ export class Audits extends ClientSDK {
|
|
|
155
274
|
}
|
|
156
275
|
|
|
157
276
|
/**
|
|
158
|
-
*
|
|
277
|
+
* List information requests for an audit
|
|
159
278
|
*
|
|
160
279
|
* @remarks
|
|
161
|
-
*
|
|
280
|
+
* Retrieves a paginated list of all information requests for an audit, enabling
|
|
281
|
+
* external audit management systems to display and track evidence requests.
|
|
282
|
+
*
|
|
283
|
+
* This endpoint always includes soft-deleted records (where `deletionDate !== null`).
|
|
284
|
+
* Clients should check the `deletionDate` field to identify and handle deleted records
|
|
285
|
+
* appropriately in their systems.
|
|
286
|
+
*
|
|
287
|
+
* This endpoint supports delta synchronization via the `changedSinceDate` parameter,
|
|
288
|
+
* allowing efficient polling for changes without retrieving the entire dataset.
|
|
289
|
+
*
|
|
290
|
+
* Pagination usage:
|
|
291
|
+
* 1. Make initial request with desired `pageSize`
|
|
292
|
+
* 2. Check `results.pageInfo.hasNextPage` to see if more data exists
|
|
293
|
+
* 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
|
|
294
|
+
* 4. Repeat until `hasNextPage` is false
|
|
295
|
+
*
|
|
296
|
+
* Delta sync usage:
|
|
297
|
+
* 1. Store the timestamp of your last sync
|
|
298
|
+
* 2. Pass that timestamp as `changedSinceDate`
|
|
299
|
+
* 3. Only requests created, modified, or deleted since that timestamp are returned
|
|
300
|
+
* 4. Process updates and soft-deletes by checking the `deletionDate` field
|
|
301
|
+
* 5. Update your last sync timestamp to the current time
|
|
162
302
|
*/
|
|
163
|
-
async
|
|
164
|
-
request: operations.
|
|
303
|
+
async listInformationRequests(
|
|
304
|
+
request: operations.ListInformationRequestsRequest,
|
|
165
305
|
options?: RequestOptions,
|
|
166
|
-
): Promise<components.
|
|
167
|
-
return unwrapAsync(
|
|
306
|
+
): Promise<components.PaginatedResponseInformationRequest> {
|
|
307
|
+
return unwrapAsync(auditsListInformationRequests(
|
|
308
|
+
this,
|
|
309
|
+
request,
|
|
310
|
+
options,
|
|
311
|
+
));
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Create a new information request
|
|
316
|
+
*
|
|
317
|
+
* @remarks
|
|
318
|
+
* Creates a new information request for an audit during audit setup or as requirements evolve.
|
|
319
|
+
*
|
|
320
|
+
* After creating all information requests, use POST /audits/{auditId}/share-information-request-list
|
|
321
|
+
* to make them visible to the customer organization. Until shared, requests remain in draft state
|
|
322
|
+
* visible only to auditors.
|
|
323
|
+
*
|
|
324
|
+
* New requests are created in an initial state indicating evidence is needed. The status
|
|
325
|
+
* progresses through the workflow: initial state → awaiting review → approved or flagged.
|
|
326
|
+
*/
|
|
327
|
+
async createInformationRequest(
|
|
328
|
+
request: operations.CreateInformationRequestRequest,
|
|
329
|
+
options?: RequestOptions,
|
|
330
|
+
): Promise<components.InformationRequest> {
|
|
331
|
+
return unwrapAsync(auditsCreateInformationRequest(
|
|
332
|
+
this,
|
|
333
|
+
request,
|
|
334
|
+
options,
|
|
335
|
+
));
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* Get an information request by ID
|
|
340
|
+
*
|
|
341
|
+
* @remarks
|
|
342
|
+
* Retrieves a single information request by its ID for an audit, allowing external
|
|
343
|
+
* audit management systems to fetch the latest state of a specific request without
|
|
344
|
+
* paginating through the full list.
|
|
345
|
+
*
|
|
346
|
+
* Soft-deleted records (where `deletionDate !== null`) are included in the response.
|
|
347
|
+
* Clients should check `deletionDate` to determine whether the request has been deleted.
|
|
348
|
+
*/
|
|
349
|
+
async getInformationRequest(
|
|
350
|
+
request: operations.GetInformationRequestRequest,
|
|
351
|
+
options?: RequestOptions,
|
|
352
|
+
): Promise<components.InformationRequest> {
|
|
353
|
+
return unwrapAsync(auditsGetInformationRequest(
|
|
354
|
+
this,
|
|
355
|
+
request,
|
|
356
|
+
options,
|
|
357
|
+
));
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* Update an information request for an audit
|
|
362
|
+
*
|
|
363
|
+
* @remarks
|
|
364
|
+
* Updates an existing information request for an audit, allowing modification of request
|
|
365
|
+
* details as audit requirements evolve. Supports partial updates where only specified
|
|
366
|
+
* fields are changed; omitted fields remain unchanged.
|
|
367
|
+
*
|
|
368
|
+
* Common use cases:
|
|
369
|
+
* - Updating due dates as audit timelines shift
|
|
370
|
+
* - Refining descriptions to clarify requirements
|
|
371
|
+
* - Adjusting request type
|
|
372
|
+
*
|
|
373
|
+
* Note: The `modificationDate` is automatically updated to the current timestamp
|
|
374
|
+
* when any field is changed.
|
|
375
|
+
*/
|
|
376
|
+
async updateInformationRequest(
|
|
377
|
+
request: operations.UpdateInformationRequestRequest,
|
|
378
|
+
options?: RequestOptions,
|
|
379
|
+
): Promise<components.InformationRequest> {
|
|
380
|
+
return unwrapAsync(auditsUpdateInformationRequest(
|
|
381
|
+
this,
|
|
382
|
+
request,
|
|
383
|
+
options,
|
|
384
|
+
));
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* Delete an information request for an audit
|
|
389
|
+
*
|
|
390
|
+
* @remarks
|
|
391
|
+
* Deletes an information request for an audit. This performs a soft delete, marking
|
|
392
|
+
* the request as deleted (setting `deletionDate`) while preserving it in the system
|
|
393
|
+
* for audit history and compliance tracking.
|
|
394
|
+
*
|
|
395
|
+
* Soft deletion allows:
|
|
396
|
+
* - Maintaining complete audit trail of all requests ever created
|
|
397
|
+
* - Retrieving deleted requests via `changedSinceDate` for synchronization
|
|
398
|
+
*
|
|
399
|
+
* After deletion:
|
|
400
|
+
* - The request will not appear in normal list responses (without `changedSinceDate`)
|
|
401
|
+
* - The request's `deletionDate` field will be populated
|
|
402
|
+
*/
|
|
403
|
+
async deleteInformationRequest(
|
|
404
|
+
request: operations.DeleteInformationRequestRequest,
|
|
405
|
+
options?: RequestOptions,
|
|
406
|
+
): Promise<void> {
|
|
407
|
+
return unwrapAsync(auditsDeleteInformationRequest(
|
|
408
|
+
this,
|
|
409
|
+
request,
|
|
410
|
+
options,
|
|
411
|
+
));
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
/**
|
|
415
|
+
* Accept evidence for an information request
|
|
416
|
+
*
|
|
417
|
+
* @remarks
|
|
418
|
+
* Accepts evidence for an information request, confirming that all submitted evidence
|
|
419
|
+
* meets audit requirements. This action changes the request's approvalStatus to
|
|
420
|
+
* an approved state and creates an activity log entry.
|
|
421
|
+
*
|
|
422
|
+
* Acceptance workflow:
|
|
423
|
+
* 1. Auditor reviews submitted evidence
|
|
424
|
+
* 2. If evidence is satisfactory, auditor calls this endpoint
|
|
425
|
+
* 3. Request status changes to approved state and is considered complete for this audit cycle
|
|
426
|
+
*
|
|
427
|
+
* Use this endpoint when:
|
|
428
|
+
* - All required evidence has been submitted
|
|
429
|
+
* - Evidence quality meets audit standards
|
|
430
|
+
* - Evidence addresses all specified framework codes
|
|
431
|
+
* - No additional information is needed
|
|
432
|
+
*/
|
|
433
|
+
async acceptInformationRequestEvidence(
|
|
434
|
+
request: operations.AcceptInformationRequestEvidenceRequest,
|
|
435
|
+
options?: RequestOptions,
|
|
436
|
+
): Promise<components.InformationRequest> {
|
|
437
|
+
return unwrapAsync(auditsAcceptInformationRequestEvidence(
|
|
438
|
+
this,
|
|
439
|
+
request,
|
|
440
|
+
options,
|
|
441
|
+
));
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
/**
|
|
445
|
+
* List information request activity
|
|
446
|
+
*
|
|
447
|
+
* @remarks
|
|
448
|
+
* Retrieves a paginated list of activity logs for an information request, providing
|
|
449
|
+
* a complete audit trail of all changes and actions.
|
|
450
|
+
*
|
|
451
|
+
* This endpoint supports delta synchronization via the `changedSinceDate` parameter,
|
|
452
|
+
* allowing efficient polling for changes without retrieving the entire dataset.
|
|
453
|
+
*
|
|
454
|
+
* Pagination usage:
|
|
455
|
+
* 1. Make initial request with desired `pageSize`
|
|
456
|
+
* 2. Check `results.pageInfo.hasNextPage` to see if more data exists
|
|
457
|
+
* 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
|
|
458
|
+
* 4. Repeat until `hasNextPage` is false
|
|
459
|
+
*
|
|
460
|
+
* Delta sync usage:
|
|
461
|
+
* 1. Store the timestamp of your last sync
|
|
462
|
+
* 2. Pass that timestamp as `changedSinceDate`
|
|
463
|
+
* 3. Only activity created since that timestamp is returned
|
|
464
|
+
* 4. Process updates to track all changes to the information request
|
|
465
|
+
* 5. Update your last sync timestamp to the current time
|
|
466
|
+
*/
|
|
467
|
+
async listInformationRequestActivity(
|
|
468
|
+
request: operations.ListInformationRequestActivityRequest,
|
|
469
|
+
options?: RequestOptions,
|
|
470
|
+
): Promise<components.PaginatedResponseInformationRequestActivityLog> {
|
|
471
|
+
return unwrapAsync(auditsListInformationRequestActivity(
|
|
472
|
+
this,
|
|
473
|
+
request,
|
|
474
|
+
options,
|
|
475
|
+
));
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
/**
|
|
479
|
+
* List comments for an information request
|
|
480
|
+
*
|
|
481
|
+
* @remarks
|
|
482
|
+
* Retrieves a paginated list of comments for an information request, enabling
|
|
483
|
+
* auditors to view communication history and collaborate with customers.
|
|
484
|
+
*
|
|
485
|
+
* This endpoint always includes soft-deleted records (where `deletionDate !== null`).
|
|
486
|
+
* Clients should check the `deletionDate` field to identify and handle deleted records
|
|
487
|
+
* appropriately in their systems.
|
|
488
|
+
*
|
|
489
|
+
* This endpoint supports delta synchronization via the `changedSinceDate` parameter,
|
|
490
|
+
* allowing efficient polling for changes without retrieving the entire dataset.
|
|
491
|
+
*
|
|
492
|
+
* Pagination usage:
|
|
493
|
+
* 1. Make initial request with desired `pageSize`
|
|
494
|
+
* 2. Check `results.pageInfo.hasNextPage` to see if more data exists
|
|
495
|
+
* 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
|
|
496
|
+
* 4. Repeat until `hasNextPage` is false
|
|
497
|
+
*
|
|
498
|
+
* Delta sync usage:
|
|
499
|
+
* 1. Store the timestamp of your last sync
|
|
500
|
+
* 2. Pass that timestamp as `changedSinceDate`
|
|
501
|
+
* 3. Only comments created, modified, or deleted since that timestamp are returned
|
|
502
|
+
* 4. Process updates, including soft-deletes (deletionDate !== null)
|
|
503
|
+
* 5. Update your last sync timestamp to the current time
|
|
504
|
+
*/
|
|
505
|
+
async listCommentsForInformationRequest(
|
|
506
|
+
request: operations.ListCommentsForInformationRequestRequest,
|
|
507
|
+
options?: RequestOptions,
|
|
508
|
+
): Promise<components.PaginatedResponseInformationRequestComment> {
|
|
509
|
+
return unwrapAsync(auditsListCommentsForInformationRequest(
|
|
510
|
+
this,
|
|
511
|
+
request,
|
|
512
|
+
options,
|
|
513
|
+
));
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
/**
|
|
517
|
+
* Create a comment for an information request
|
|
518
|
+
*
|
|
519
|
+
* @remarks
|
|
520
|
+
* Creates a new comment for an information request. The comment author must be an auditor
|
|
521
|
+
* in the audit firm making the request. The comment will be associated with the information
|
|
522
|
+
* request and visible to all authorized users.
|
|
523
|
+
*/
|
|
524
|
+
async createCommentForInformationRequest(
|
|
525
|
+
request: operations.CreateCommentForInformationRequestRequest,
|
|
526
|
+
options?: RequestOptions,
|
|
527
|
+
): Promise<components.InformationRequestComment> {
|
|
528
|
+
return unwrapAsync(auditsCreateCommentForInformationRequest(
|
|
529
|
+
this,
|
|
530
|
+
request,
|
|
531
|
+
options,
|
|
532
|
+
));
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
/**
|
|
536
|
+
* Update a comment for an information request
|
|
537
|
+
*
|
|
538
|
+
* @remarks
|
|
539
|
+
* Updates an existing comment for an information request. Only the original author
|
|
540
|
+
* of the comment can update it. The author is identified by their email address,
|
|
541
|
+
* which must match the email of the user who created the comment.
|
|
542
|
+
*/
|
|
543
|
+
async updateCommentForInformationRequest(
|
|
544
|
+
request: operations.UpdateCommentForInformationRequestRequest,
|
|
545
|
+
options?: RequestOptions,
|
|
546
|
+
): Promise<components.InformationRequestComment> {
|
|
547
|
+
return unwrapAsync(auditsUpdateCommentForInformationRequest(
|
|
548
|
+
this,
|
|
549
|
+
request,
|
|
550
|
+
options,
|
|
551
|
+
));
|
|
552
|
+
}
|
|
553
|
+
|
|
554
|
+
/**
|
|
555
|
+
* Delete a comment for an information request
|
|
556
|
+
*
|
|
557
|
+
* @remarks
|
|
558
|
+
* Deletes an existing comment for an information request. Only the original author
|
|
559
|
+
* of the comment can delete it. The author is identified by their email address,
|
|
560
|
+
* which must match the email of the user who created the comment.
|
|
561
|
+
*/
|
|
562
|
+
async deleteCommentForInformationRequest(
|
|
563
|
+
request: operations.DeleteCommentForInformationRequestRequest,
|
|
564
|
+
options?: RequestOptions,
|
|
565
|
+
): Promise<void> {
|
|
566
|
+
return unwrapAsync(auditsDeleteCommentForInformationRequest(
|
|
567
|
+
this,
|
|
568
|
+
request,
|
|
569
|
+
options,
|
|
570
|
+
));
|
|
571
|
+
}
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* List evidence for an information request
|
|
575
|
+
*
|
|
576
|
+
* @remarks
|
|
577
|
+
* Retrieves a paginated list of all evidence attached to an information request,
|
|
578
|
+
* enabling auditors to review evidence submitted by customers.
|
|
579
|
+
*
|
|
580
|
+
* This endpoint always includes soft-deleted records (where `deletionDate !== null`).
|
|
581
|
+
* Clients should check the `deletionDate` field to identify and handle deleted records
|
|
582
|
+
* appropriately in their systems.
|
|
583
|
+
*
|
|
584
|
+
* This endpoint supports delta synchronization via the `changedSinceDate` parameter,
|
|
585
|
+
* allowing efficient polling for changes without retrieving the entire dataset.
|
|
586
|
+
*
|
|
587
|
+
* Pagination usage:
|
|
588
|
+
* 1. Make initial request with desired `pageSize`
|
|
589
|
+
* 2. Check `results.pageInfo.hasNextPage` to see if more data exists
|
|
590
|
+
* 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
|
|
591
|
+
* 4. Repeat until `hasNextPage` is false
|
|
592
|
+
*
|
|
593
|
+
* Delta sync usage:
|
|
594
|
+
* 1. Store the timestamp of your last sync
|
|
595
|
+
* 2. Pass that timestamp as `changedSinceDate`
|
|
596
|
+
* 3. Only evidence created, modified, shared, or deleted since that timestamp is returned
|
|
597
|
+
* 4. Process updates, including soft-deletes (deletionDate !== null)
|
|
598
|
+
* 5. Update your last sync timestamp to the current time
|
|
599
|
+
*/
|
|
600
|
+
async listInformationRequestEvidence(
|
|
601
|
+
request: operations.ListInformationRequestEvidenceRequest,
|
|
602
|
+
options?: RequestOptions,
|
|
603
|
+
): Promise<components.PaginatedResponseInformationRequestEvidence> {
|
|
604
|
+
return unwrapAsync(auditsListInformationRequestEvidence(
|
|
605
|
+
this,
|
|
606
|
+
request,
|
|
607
|
+
options,
|
|
608
|
+
));
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
/**
|
|
612
|
+
* Get test snapshot detail for an evidence row
|
|
613
|
+
*
|
|
614
|
+
* @remarks
|
|
615
|
+
* Retrieves the rich detail for a single VANTA_TEST_SNAPSHOT evidence row
|
|
616
|
+
* attached to an information request. The response includes test-level
|
|
617
|
+
* metadata (description, integrations, SLA) and the raw test data captured
|
|
618
|
+
* at snapshot time, presented as a uniform array of rows regardless of
|
|
619
|
+
* whether the snapshot is structured or unstructured.
|
|
620
|
+
*
|
|
621
|
+
* For structured snapshots, the array contains one row per resource the
|
|
622
|
+
* test ran against; each row carries `resourceId`, `resourceType`, and the
|
|
623
|
+
* raw JSON for that resource.
|
|
624
|
+
*
|
|
625
|
+
* For unstructured snapshots, the array contains a single row with
|
|
626
|
+
* `resourceId` and `resourceType` set to `null` and `rawJson` containing
|
|
627
|
+
* the entire test-run JSON blob.
|
|
628
|
+
*/
|
|
629
|
+
async getInformationRequestTestSnapshotEvidenceDetail(
|
|
630
|
+
request: operations.GetInformationRequestTestSnapshotEvidenceDetailRequest,
|
|
631
|
+
options?: RequestOptions,
|
|
632
|
+
): Promise<components.VantaTestSnapshotEvidenceDetail> {
|
|
633
|
+
return unwrapAsync(auditsGetInformationRequestTestSnapshotEvidenceDetail(
|
|
634
|
+
this,
|
|
635
|
+
request,
|
|
636
|
+
options,
|
|
637
|
+
));
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
/**
|
|
641
|
+
* Flag evidence for an information request
|
|
642
|
+
*
|
|
643
|
+
* @remarks
|
|
644
|
+
* Flags evidence for an information request when it doesn't meet audit requirements,
|
|
645
|
+
* marking issues that need to be addressed before approval. This action changes the
|
|
646
|
+
* request's approvalStatus to a flagged state and creates an activity log entry.
|
|
647
|
+
*
|
|
648
|
+
* Flagging workflow:
|
|
649
|
+
* 1. Auditor reviews submitted evidence
|
|
650
|
+
* 2. If issues are found, auditor calls this endpoint with detailed reason
|
|
651
|
+
* 3. Request status changes to flagged state
|
|
652
|
+
* 4. Customer is notified and can see the reason in activity logs
|
|
653
|
+
* 5. Customer addresses issues and updates evidence
|
|
654
|
+
* 6. When ready, customer changes status back to awaiting review
|
|
655
|
+
* 7. Auditor reviews again and either flags again or accepts
|
|
656
|
+
*
|
|
657
|
+
* The `reason` field should clearly explain what's missing or incorrect so the
|
|
658
|
+
* customer knows exactly what to fix. This reason is visible to the customer
|
|
659
|
+
* and appears in the activity log.
|
|
660
|
+
*/
|
|
661
|
+
async flagInformationRequestEvidence(
|
|
662
|
+
request: operations.FlagInformationRequestEvidenceRequest,
|
|
663
|
+
options?: RequestOptions,
|
|
664
|
+
): Promise<components.InformationRequest> {
|
|
665
|
+
return unwrapAsync(auditsFlagInformationRequestEvidence(
|
|
666
|
+
this,
|
|
667
|
+
request,
|
|
668
|
+
options,
|
|
669
|
+
));
|
|
670
|
+
}
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* List snapshotted issues for an audit
|
|
674
|
+
*
|
|
675
|
+
* @remarks
|
|
676
|
+
* Retrieves a list of all issues that have been shared with an audit.
|
|
677
|
+
*
|
|
678
|
+
* The issues returned are immutable, point-in-time snapshots; there may be duplicates of issues that have been snapshotted at different times.
|
|
679
|
+
* The GET /audits/{auditId}/issues/snapshots endpoint can be used to retrieve metadata about the snapshots that issues belong to.
|
|
680
|
+
* Issues represent compliance findings from a variety of sources that need to be tracked and remediated.
|
|
681
|
+
*
|
|
682
|
+
* Supports filtering by:
|
|
683
|
+
* - `search`: full text search across issue title and description
|
|
684
|
+
* - `snapshotId`: filtering to a specific snapshot or snapshots, which represent point-in-time captures of issues. Use the GET /audits/{auditId}/issues/snapshots endpoint to retrieve snapshot IDs and metadata.
|
|
685
|
+
*
|
|
686
|
+
* Results are sorted by issue creation date in descending order (newest first).
|
|
687
|
+
*
|
|
688
|
+
* Uses cursor-based pagination. To paginate:
|
|
689
|
+
* 1. Make initial request with desired `pageSize`
|
|
690
|
+
* 2. Check `results.pageInfo.hasNextPage`
|
|
691
|
+
* 3. Use `results.pageInfo.endCursor` as `pageCursor` for next request
|
|
692
|
+
*/
|
|
693
|
+
async listAuditIssues(
|
|
694
|
+
request: operations.ListAuditIssuesRequest,
|
|
695
|
+
options?: RequestOptions,
|
|
696
|
+
): Promise<components.PaginatedIssueSnapshotItemsResponse> {
|
|
697
|
+
return unwrapAsync(auditsListAuditIssues(
|
|
698
|
+
this,
|
|
699
|
+
request,
|
|
700
|
+
options,
|
|
701
|
+
));
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
/**
|
|
705
|
+
* List snapshotted issues for an audit
|
|
706
|
+
*
|
|
707
|
+
* @remarks
|
|
708
|
+
* Retrieves a list of snapshots that have been shared with an audit.
|
|
709
|
+
*
|
|
710
|
+
* The snapshots returned contain metadata about point-in-time captures of issues for an audit.
|
|
711
|
+
* This data can be used to filter down the list of issues to specific snapshots when querying the GET /audits/{auditId}/issues/items endpoint.
|
|
712
|
+
*
|
|
713
|
+
* Supports filtering by:
|
|
714
|
+
* - `search`: full text search across snapshot title and description
|
|
715
|
+
*
|
|
716
|
+
* Results are sorted by snapshot creation date in descending order (newest first).
|
|
717
|
+
*
|
|
718
|
+
* Uses cursor-based pagination. To paginate:
|
|
719
|
+
* 1. Make initial request with desired `pageSize`
|
|
720
|
+
* 2. Check `results.pageInfo.hasNextPage`
|
|
721
|
+
* 3. Use `results.pageInfo.endCursor` as `pageCursor` for next request
|
|
722
|
+
*/
|
|
723
|
+
async listAuditSnapshots(
|
|
724
|
+
request: operations.ListAuditSnapshotsRequest,
|
|
725
|
+
options?: RequestOptions,
|
|
726
|
+
): Promise<components.PaginatedIssueSnapshotMetadataResponse> {
|
|
727
|
+
return unwrapAsync(auditsListAuditSnapshots(
|
|
728
|
+
this,
|
|
729
|
+
request,
|
|
730
|
+
options,
|
|
731
|
+
));
|
|
732
|
+
}
|
|
733
|
+
|
|
734
|
+
/**
|
|
735
|
+
* Share information request list with customer
|
|
736
|
+
*
|
|
737
|
+
* @remarks
|
|
738
|
+
* Shares the current information request list for an audit with the customer organization,
|
|
739
|
+
* making it visible in their portal. This action allows the customer to see all information
|
|
740
|
+
* requests that have been created for their audit. Only IRL audits are supported.
|
|
741
|
+
*/
|
|
742
|
+
async shareInformationRequestList(
|
|
743
|
+
request: operations.ShareInformationRequestListRequest,
|
|
744
|
+
options?: RequestOptions,
|
|
745
|
+
): Promise<components.Audit> {
|
|
746
|
+
return unwrapAsync(auditsShareInformationRequestList(
|
|
168
747
|
this,
|
|
169
748
|
request,
|
|
170
749
|
options,
|