vanta-auditor-api-sdk 0.1.1
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/.devcontainer/README.md +30 -0
- package/FUNCTIONS.md +104 -0
- package/README.md +440 -0
- package/RUNTIMES.md +48 -0
- package/core.d.ts +10 -0
- package/core.d.ts.map +1 -0
- package/core.js +17 -0
- package/core.js.map +1 -0
- package/docs/sdks/auditors/README.md +88 -0
- package/docs/sdks/audits/README.md +748 -0
- package/docs/sdks/vanta/README.md +7 -0
- package/funcs/auditorsCreate.d.ts +15 -0
- package/funcs/auditorsCreate.d.ts.map +1 -0
- package/funcs/auditorsCreate.js +106 -0
- package/funcs/auditorsCreate.js.map +1 -0
- package/funcs/auditsCreateCommentForEvidence.d.ts +16 -0
- package/funcs/auditsCreateCommentForEvidence.d.ts.map +1 -0
- package/funcs/auditsCreateCommentForEvidence.js +117 -0
- package/funcs/auditsCreateCommentForEvidence.js.map +1 -0
- package/funcs/auditsCreateCustomControl.d.ts +16 -0
- package/funcs/auditsCreateCustomControl.d.ts.map +1 -0
- package/funcs/auditsCreateCustomControl.js +115 -0
- package/funcs/auditsCreateCustomControl.js.map +1 -0
- package/funcs/auditsCreateCustomEvidenceRequest.d.ts +16 -0
- package/funcs/auditsCreateCustomEvidenceRequest.d.ts.map +1 -0
- package/funcs/auditsCreateCustomEvidenceRequest.js +115 -0
- package/funcs/auditsCreateCustomEvidenceRequest.js.map +1 -0
- package/funcs/auditsGetEvidenceUrls.d.ts +16 -0
- package/funcs/auditsGetEvidenceUrls.d.ts.map +1 -0
- package/funcs/auditsGetEvidenceUrls.js +121 -0
- package/funcs/auditsGetEvidenceUrls.js.map +1 -0
- package/funcs/auditsList.d.ts +16 -0
- package/funcs/auditsList.d.ts.map +1 -0
- package/funcs/auditsList.js +112 -0
- package/funcs/auditsList.js.map +1 -0
- package/funcs/auditsListComments.d.ts +16 -0
- package/funcs/auditsListComments.d.ts.map +1 -0
- package/funcs/auditsListComments.js +118 -0
- package/funcs/auditsListComments.js.map +1 -0
- package/funcs/auditsListControls.d.ts +16 -0
- package/funcs/auditsListControls.d.ts.map +1 -0
- package/funcs/auditsListControls.js +117 -0
- package/funcs/auditsListControls.js.map +1 -0
- package/funcs/auditsListEvidence.d.ts +16 -0
- package/funcs/auditsListEvidence.d.ts.map +1 -0
- package/funcs/auditsListEvidence.js +118 -0
- package/funcs/auditsListEvidence.js.map +1 -0
- package/funcs/auditsUpdateEvidence.d.ts +16 -0
- package/funcs/auditsUpdateEvidence.d.ts.map +1 -0
- package/funcs/auditsUpdateEvidence.js +119 -0
- package/funcs/auditsUpdateEvidence.js.map +1 -0
- package/hooks/hooks.d.ts +24 -0
- package/hooks/hooks.d.ts.map +1 -0
- package/hooks/hooks.js +86 -0
- package/hooks/hooks.js.map +1 -0
- package/hooks/index.d.ts +3 -0
- package/hooks/index.d.ts.map +1 -0
- package/hooks/index.js +22 -0
- package/hooks/index.js.map +1 -0
- package/hooks/registration.d.ts +3 -0
- package/hooks/registration.d.ts.map +1 -0
- package/hooks/registration.js +15 -0
- package/hooks/registration.js.map +1 -0
- package/hooks/types.d.ts +77 -0
- package/hooks/types.d.ts.map +1 -0
- package/hooks/types.js +6 -0
- package/hooks/types.js.map +1 -0
- package/index.d.ts +4 -0
- package/index.d.ts.map +1 -0
- package/index.js +46 -0
- package/index.js.map +1 -0
- package/lib/base64.d.ts +10 -0
- package/lib/base64.d.ts.map +1 -0
- package/lib/base64.js +71 -0
- package/lib/base64.js.map +1 -0
- package/lib/config.d.ts +34 -0
- package/lib/config.d.ts.map +1 -0
- package/lib/config.js +35 -0
- package/lib/config.js.map +1 -0
- package/lib/dlv.d.ts +14 -0
- package/lib/dlv.d.ts.map +1 -0
- package/lib/dlv.js +49 -0
- package/lib/dlv.js.map +1 -0
- package/lib/encodings.d.ts +51 -0
- package/lib/encodings.d.ts.map +1 -0
- package/lib/encodings.js +342 -0
- package/lib/encodings.js.map +1 -0
- package/lib/env.d.ts +15 -0
- package/lib/env.d.ts.map +1 -0
- package/lib/env.js +65 -0
- package/lib/env.js.map +1 -0
- package/lib/files.d.ts +8 -0
- package/lib/files.d.ts.map +1 -0
- package/lib/files.js +36 -0
- package/lib/files.js.map +1 -0
- package/lib/http.d.ts +67 -0
- package/lib/http.d.ts.map +1 -0
- package/lib/http.js +217 -0
- package/lib/http.js.map +1 -0
- package/lib/is-plain-object.d.ts +2 -0
- package/lib/is-plain-object.d.ts.map +1 -0
- package/lib/is-plain-object.js +41 -0
- package/lib/is-plain-object.js.map +1 -0
- package/lib/logger.d.ts +6 -0
- package/lib/logger.d.ts.map +1 -0
- package/lib/logger.js +6 -0
- package/lib/logger.js.map +1 -0
- package/lib/matchers.d.ts +64 -0
- package/lib/matchers.d.ts.map +1 -0
- package/lib/matchers.js +204 -0
- package/lib/matchers.js.map +1 -0
- package/lib/primitives.d.ts +22 -0
- package/lib/primitives.d.ts.map +1 -0
- package/lib/primitives.js +94 -0
- package/lib/primitives.js.map +1 -0
- package/lib/retries.d.ts +38 -0
- package/lib/retries.d.ts.map +1 -0
- package/lib/retries.js +154 -0
- package/lib/retries.js.map +1 -0
- package/lib/schemas.d.ts +19 -0
- package/lib/schemas.d.ts.map +1 -0
- package/lib/schemas.js +59 -0
- package/lib/schemas.js.map +1 -0
- package/lib/sdks.d.ts +60 -0
- package/lib/sdks.d.ts.map +1 -0
- package/lib/sdks.js +277 -0
- package/lib/sdks.js.map +1 -0
- package/lib/security.d.ts +82 -0
- package/lib/security.d.ts.map +1 -0
- package/lib/security.js +139 -0
- package/lib/security.js.map +1 -0
- package/lib/url.d.ts +5 -0
- package/lib/url.d.ts.map +1 -0
- package/lib/url.js +25 -0
- package/lib/url.js.map +1 -0
- package/models/components/addauditorinput.d.ts +42 -0
- package/models/components/addauditorinput.d.ts.map +1 -0
- package/models/components/addauditorinput.js +73 -0
- package/models/components/addauditorinput.js.map +1 -0
- package/models/components/addcommentinput.d.ts +42 -0
- package/models/components/addcommentinput.d.ts.map +1 -0
- package/models/components/addcommentinput.js +73 -0
- package/models/components/addcommentinput.js.map +1 -0
- package/models/components/audit.d.ts +97 -0
- package/models/components/audit.d.ts.map +1 -0
- package/models/components/audit.js +96 -0
- package/models/components/audit.js.map +1 -0
- package/models/components/auditevidencestate.d.ts +40 -0
- package/models/components/auditevidencestate.d.ts.map +1 -0
- package/models/components/auditevidencestate.js +64 -0
- package/models/components/auditevidencestate.js.map +1 -0
- package/models/components/auditevidencetype.d.ts +31 -0
- package/models/components/auditevidencetype.d.ts.map +1 -0
- package/models/components/auditevidencetype.js +61 -0
- package/models/components/auditevidencetype.js.map +1 -0
- package/models/components/auditevidenceupdateinput.d.ts +60 -0
- package/models/components/auditevidenceupdateinput.d.ts.map +1 -0
- package/models/components/auditevidenceupdateinput.js +99 -0
- package/models/components/auditevidenceupdateinput.js.map +1 -0
- package/models/components/auditor.d.ts +49 -0
- package/models/components/auditor.d.ts.map +1 -0
- package/models/components/auditor.js +77 -0
- package/models/components/auditor.js.map +1 -0
- package/models/components/auditorcontrol.d.ts +111 -0
- package/models/components/auditorcontrol.d.ts.map +1 -0
- package/models/components/auditorcontrol.js +118 -0
- package/models/components/auditorcontrol.js.map +1 -0
- package/models/components/auditorenabledstatetransition.d.ts +34 -0
- package/models/components/auditorenabledstatetransition.d.ts.map +1 -0
- package/models/components/auditorenabledstatetransition.js +62 -0
- package/models/components/auditorenabledstatetransition.js.map +1 -0
- package/models/components/comment.d.ts +57 -0
- package/models/components/comment.d.ts.map +1 -0
- package/models/components/comment.js +79 -0
- package/models/components/comment.js.map +1 -0
- package/models/components/control.d.ts +106 -0
- package/models/components/control.d.ts.map +1 -0
- package/models/components/control.js +115 -0
- package/models/components/control.js.map +1 -0
- package/models/components/controldomain.d.ts +136 -0
- package/models/components/controldomain.d.ts.map +1 -0
- package/models/components/controldomain.js +96 -0
- package/models/components/controldomain.js.map +1 -0
- package/models/components/controlsource.d.ts +28 -0
- package/models/components/controlsource.d.ts.map +1 -0
- package/models/components/controlsource.js +60 -0
- package/models/components/controlsource.js.map +1 -0
- package/models/components/createcustomcontrolinput.d.ts +105 -0
- package/models/components/createcustomcontrolinput.d.ts.map +1 -0
- package/models/components/createcustomcontrolinput.js +109 -0
- package/models/components/createcustomcontrolinput.js.map +1 -0
- package/models/components/createcustomevidencerequestinput.d.ts +52 -0
- package/models/components/createcustomevidencerequestinput.d.ts.map +1 -0
- package/models/components/createcustomevidencerequestinput.js +80 -0
- package/models/components/createcustomevidencerequestinput.js.map +1 -0
- package/models/components/customevidencerequest.d.ts +57 -0
- package/models/components/customevidencerequest.d.ts.map +1 -0
- package/models/components/customevidencerequest.js +82 -0
- package/models/components/customevidencerequest.js.map +1 -0
- package/models/components/evidence.d.ts +84 -0
- package/models/components/evidence.d.ts.map +1 -0
- package/models/components/evidence.js +94 -0
- package/models/components/evidence.js.map +1 -0
- package/models/components/evidencecontrol.d.ts +37 -0
- package/models/components/evidencecontrol.d.ts.map +1 -0
- package/models/components/evidencecontrol.js +71 -0
- package/models/components/evidencecontrol.js.map +1 -0
- package/models/components/evidenceurl.d.ts +47 -0
- package/models/components/evidenceurl.d.ts.map +1 -0
- package/models/components/evidenceurl.js +75 -0
- package/models/components/evidenceurl.js.map +1 -0
- package/models/components/frameworkid.d.ts +127 -0
- package/models/components/frameworkid.d.ts.map +1 -0
- package/models/components/frameworkid.js +94 -0
- package/models/components/frameworkid.js.map +1 -0
- package/models/components/frameworksection.d.ts +53 -0
- package/models/components/frameworksection.d.ts.map +1 -0
- package/models/components/frameworksection.js +95 -0
- package/models/components/frameworksection.js.map +1 -0
- package/models/components/index.d.ts +30 -0
- package/models/components/index.d.ts.map +1 -0
- package/models/components/index.js +49 -0
- package/models/components/index.js.map +1 -0
- package/models/components/pageinfo.d.ts +50 -0
- package/models/components/pageinfo.d.ts.map +1 -0
- package/models/components/pageinfo.js +75 -0
- package/models/components/pageinfo.js.map +1 -0
- package/models/components/paginatedresponseaudit.d.ts +61 -0
- package/models/components/paginatedresponseaudit.d.ts.map +1 -0
- package/models/components/paginatedresponseaudit.js +100 -0
- package/models/components/paginatedresponseaudit.js.map +1 -0
- package/models/components/paginatedresponseauditorcontrol.d.ts +61 -0
- package/models/components/paginatedresponseauditorcontrol.d.ts.map +1 -0
- package/models/components/paginatedresponseauditorcontrol.js +100 -0
- package/models/components/paginatedresponseauditorcontrol.js.map +1 -0
- package/models/components/paginatedresponsecomment.d.ts +61 -0
- package/models/components/paginatedresponsecomment.d.ts.map +1 -0
- package/models/components/paginatedresponsecomment.js +100 -0
- package/models/components/paginatedresponsecomment.js.map +1 -0
- package/models/components/paginatedresponseevidence.d.ts +61 -0
- package/models/components/paginatedresponseevidence.d.ts.map +1 -0
- package/models/components/paginatedresponseevidence.js +100 -0
- package/models/components/paginatedresponseevidence.js.map +1 -0
- package/models/components/paginatedresponseevidenceurl.d.ts +61 -0
- package/models/components/paginatedresponseevidenceurl.d.ts.map +1 -0
- package/models/components/paginatedresponseevidenceurl.js +100 -0
- package/models/components/paginatedresponseevidenceurl.js.map +1 -0
- package/models/components/recurrenceduration.d.ts +43 -0
- package/models/components/recurrenceduration.d.ts.map +1 -0
- package/models/components/recurrenceduration.js +65 -0
- package/models/components/recurrenceduration.js.map +1 -0
- package/models/components/security.d.ts +29 -0
- package/models/components/security.d.ts.map +1 -0
- package/models/components/security.js +69 -0
- package/models/components/security.js.map +1 -0
- package/models/errors/apierror.d.ts +8 -0
- package/models/errors/apierror.d.ts.map +1 -0
- package/models/errors/apierror.js +21 -0
- package/models/errors/apierror.js.map +1 -0
- package/models/errors/httpclienterrors.d.ts +44 -0
- package/models/errors/httpclienterrors.d.ts.map +1 -0
- package/models/errors/httpclienterrors.js +78 -0
- package/models/errors/httpclienterrors.js.map +1 -0
- package/models/errors/index.d.ts +4 -0
- package/models/errors/index.d.ts.map +1 -0
- package/models/errors/index.js +23 -0
- package/models/errors/index.js.map +1 -0
- package/models/errors/sdkvalidationerror.d.ts +20 -0
- package/models/errors/sdkvalidationerror.d.ts.map +1 -0
- package/models/errors/sdkvalidationerror.js +115 -0
- package/models/errors/sdkvalidationerror.js.map +1 -0
- package/models/operations/createcommentforauditevidence.d.ts +34 -0
- package/models/operations/createcommentforauditevidence.d.ts.map +1 -0
- package/models/operations/createcommentforauditevidence.js +83 -0
- package/models/operations/createcommentforauditevidence.js.map +1 -0
- package/models/operations/createcustomcontrol.d.ts +32 -0
- package/models/operations/createcustomcontrol.d.ts.map +1 -0
- package/models/operations/createcustomcontrol.js +81 -0
- package/models/operations/createcustomcontrol.js.map +1 -0
- package/models/operations/createcustomevidencerequest.d.ts +32 -0
- package/models/operations/createcustomevidencerequest.d.ts.map +1 -0
- package/models/operations/createcustomevidencerequest.js +81 -0
- package/models/operations/createcustomevidencerequest.js.map +1 -0
- package/models/operations/index.d.ts +10 -0
- package/models/operations/index.d.ts.map +1 -0
- package/models/operations/index.js +29 -0
- package/models/operations/index.js.map +1 -0
- package/models/operations/listauditcomments.d.ts +38 -0
- package/models/operations/listauditcomments.d.ts.map +1 -0
- package/models/operations/listauditcomments.js +75 -0
- package/models/operations/listauditcomments.js.map +1 -0
- package/models/operations/listauditcontrols.d.ts +33 -0
- package/models/operations/listauditcontrols.d.ts.map +1 -0
- package/models/operations/listauditcontrols.js +73 -0
- package/models/operations/listauditcontrols.js.map +1 -0
- package/models/operations/listauditevidence.d.ts +38 -0
- package/models/operations/listauditevidence.d.ts.map +1 -0
- package/models/operations/listauditevidence.js +75 -0
- package/models/operations/listauditevidence.js.map +1 -0
- package/models/operations/listauditevidenceurls.d.ts +35 -0
- package/models/operations/listauditevidenceurls.d.ts.map +1 -0
- package/models/operations/listauditevidenceurls.js +75 -0
- package/models/operations/listauditevidenceurls.js.map +1 -0
- package/models/operations/listaudits.d.ts +36 -0
- package/models/operations/listaudits.d.ts.map +1 -0
- package/models/operations/listaudits.js +73 -0
- package/models/operations/listaudits.js.map +1 -0
- package/models/operations/updateauditevidence.d.ts +34 -0
- package/models/operations/updateauditevidence.d.ts.map +1 -0
- package/models/operations/updateauditevidence.js +83 -0
- package/models/operations/updateauditevidence.js.map +1 -0
- package/package.json +27 -0
- package/sdk/auditors.d.ts +12 -0
- package/sdk/auditors.d.ts.map +1 -0
- package/sdk/auditors.js +22 -0
- package/sdk/auditors.js.map +1 -0
- package/sdk/audits.d.ts +69 -0
- package/sdk/audits.d.ts.map +1 -0
- package/sdk/audits.js +102 -0
- package/sdk/audits.js.map +1 -0
- package/sdk/index.d.ts +2 -0
- package/sdk/index.d.ts.map +1 -0
- package/sdk/index.js +21 -0
- package/sdk/index.js.map +1 -0
- package/sdk/sdk.d.ts +10 -0
- package/sdk/sdk.d.ts.map +1 -0
- package/sdk/sdk.js +19 -0
- package/sdk/sdk.js.map +1 -0
- package/src/core.ts +13 -0
- package/src/funcs/auditorsCreate.ts +124 -0
- package/src/funcs/auditsCreateCommentForEvidence.ts +141 -0
- package/src/funcs/auditsCreateCustomControl.ts +137 -0
- package/src/funcs/auditsCreateCustomEvidenceRequest.ts +137 -0
- package/src/funcs/auditsGetEvidenceUrls.ts +144 -0
- package/src/funcs/auditsList.ts +131 -0
- package/src/funcs/auditsListComments.ts +138 -0
- package/src/funcs/auditsListControls.ts +137 -0
- package/src/funcs/auditsListEvidence.ts +138 -0
- package/src/funcs/auditsUpdateEvidence.ts +141 -0
- package/src/hooks/hooks.ts +132 -0
- package/src/hooks/index.ts +6 -0
- package/src/hooks/registration.ts +14 -0
- package/src/hooks/types.ts +109 -0
- package/src/index.ts +7 -0
- package/src/lib/base64.ts +37 -0
- package/src/lib/config.ts +61 -0
- package/src/lib/dlv.ts +53 -0
- package/src/lib/encodings.ts +449 -0
- package/src/lib/env.ts +41 -0
- package/src/lib/files.ts +40 -0
- package/src/lib/http.ts +323 -0
- package/src/lib/is-plain-object.ts +43 -0
- package/src/lib/logger.ts +9 -0
- package/src/lib/matchers.ts +322 -0
- package/src/lib/primitives.ts +122 -0
- package/src/lib/retries.ts +219 -0
- package/src/lib/schemas.ts +86 -0
- package/src/lib/sdks.ts +397 -0
- package/src/lib/security.ts +254 -0
- package/src/lib/url.ts +33 -0
- package/src/models/components/addauditorinput.ts +81 -0
- package/src/models/components/addcommentinput.ts +83 -0
- package/src/models/components/audit.ts +167 -0
- package/src/models/components/auditevidencestate.ts +37 -0
- package/src/models/components/auditevidencetype.ts +34 -0
- package/src/models/components/auditevidenceupdateinput.ts +132 -0
- package/src/models/components/auditor.ts +87 -0
- package/src/models/components/auditorcontrol.ts +194 -0
- package/src/models/components/auditorenabledstatetransition.ts +37 -0
- package/src/models/components/comment.ts +101 -0
- package/src/models/components/control.ts +187 -0
- package/src/models/components/controldomain.ts +70 -0
- package/src/models/components/controlsource.ts +33 -0
- package/src/models/components/createcustomcontrolinput.ts +164 -0
- package/src/models/components/createcustomevidencerequestinput.ts +105 -0
- package/src/models/components/customevidencerequest.ts +110 -0
- package/src/models/components/evidence.ts +158 -0
- package/src/models/components/evidencecontrol.ts +74 -0
- package/src/models/components/evidenceurl.ts +86 -0
- package/src/models/components/frameworkid.ts +64 -0
- package/src/models/components/frameworksection.ts +127 -0
- package/src/models/components/index.ts +33 -0
- package/src/models/components/pageinfo.ts +89 -0
- package/src/models/components/paginatedresponseaudit.ts +136 -0
- package/src/models/components/paginatedresponseauditorcontrol.ts +151 -0
- package/src/models/components/paginatedresponsecomment.ts +145 -0
- package/src/models/components/paginatedresponseevidence.ts +145 -0
- package/src/models/components/paginatedresponseevidenceurl.ts +150 -0
- package/src/models/components/recurrenceduration.ts +38 -0
- package/src/models/components/security.ts +62 -0
- package/src/models/errors/apierror.ts +27 -0
- package/src/models/errors/httpclienterrors.ts +62 -0
- package/src/models/errors/index.ts +7 -0
- package/src/models/errors/sdkvalidationerror.ts +97 -0
- package/src/models/operations/createcommentforauditevidence.ts +89 -0
- package/src/models/operations/createcustomcontrol.ts +80 -0
- package/src/models/operations/createcustomevidencerequest.ts +87 -0
- package/src/models/operations/index.ts +13 -0
- package/src/models/operations/listauditcomments.ts +83 -0
- package/src/models/operations/listauditcontrols.ts +74 -0
- package/src/models/operations/listauditevidence.ts +83 -0
- package/src/models/operations/listauditevidenceurls.ts +80 -0
- package/src/models/operations/listaudits.ts +79 -0
- package/src/models/operations/updateauditevidence.ts +84 -0
- package/src/sdk/auditors.ts +27 -0
- package/src/sdk/audits.ts +172 -0
- package/src/sdk/index.ts +5 -0
- package/src/sdk/sdk.ts +19 -0
- package/src/types/blobs.ts +31 -0
- package/src/types/constdatetime.ts +15 -0
- package/src/types/enums.ts +16 -0
- package/src/types/fp.ts +50 -0
- package/src/types/index.ts +11 -0
- package/src/types/operations.ts +105 -0
- package/src/types/rfcdate.ts +54 -0
- package/src/types/streams.ts +21 -0
- package/types/blobs.d.ts +4 -0
- package/types/blobs.d.ts.map +1 -0
- package/types/blobs.js +62 -0
- package/types/blobs.js.map +1 -0
- package/types/constdatetime.d.ts +3 -0
- package/types/constdatetime.d.ts.map +1 -0
- package/types/constdatetime.js +46 -0
- package/types/constdatetime.js.map +1 -0
- package/types/enums.d.ts +12 -0
- package/types/enums.d.ts.map +1 -0
- package/types/enums.js +10 -0
- package/types/enums.js.map +1 -0
- package/types/fp.d.ts +31 -0
- package/types/fp.d.ts.map +1 -0
- package/types/fp.js +37 -0
- package/types/fp.js.map +1 -0
- package/types/index.d.ts +8 -0
- package/types/index.d.ts.map +1 -0
- package/types/index.js +16 -0
- package/types/index.js.map +1 -0
- package/types/operations.d.ts +27 -0
- package/types/operations.d.ts.map +1 -0
- package/types/operations.js +83 -0
- package/types/operations.js.map +1 -0
- package/types/rfcdate.d.ts +21 -0
- package/types/rfcdate.d.ts.map +1 -0
- package/types/rfcdate.js +46 -0
- package/types/rfcdate.js.map +1 -0
- package/types/streams.d.ts +2 -0
- package/types/streams.d.ts.map +1 -0
- package/types/streams.js +18 -0
- package/types/streams.js.map +1 -0
|
@@ -0,0 +1,748 @@
|
|
|
1
|
+
# Audits
|
|
2
|
+
(*audits*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [list](#list) - List audits
|
|
9
|
+
* [getEvidenceUrls](#getevidenceurls) - List audit evidence url
|
|
10
|
+
* [listEvidence](#listevidence) - List audit evidence
|
|
11
|
+
* [listComments](#listcomments) - List audit comments
|
|
12
|
+
* [listControls](#listcontrols) - List audit controls
|
|
13
|
+
* [createCommentForEvidence](#createcommentforevidence) - Create a comment for audit evidence
|
|
14
|
+
* [updateEvidence](#updateevidence) - Update audit evidence
|
|
15
|
+
* [createCustomEvidenceRequest](#createcustomevidencerequest) - Create a custom evidence request for an audit
|
|
16
|
+
* [createCustomControl](#createcustomcontrol) - Create a custom control for an audit
|
|
17
|
+
|
|
18
|
+
## list
|
|
19
|
+
|
|
20
|
+
Returns a paginated list of audits scoped to the audit firm.
|
|
21
|
+
|
|
22
|
+
### Example Usage
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
26
|
+
|
|
27
|
+
const vanta = new Vanta({
|
|
28
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
async function run() {
|
|
32
|
+
const result = await vanta.audits.list({});
|
|
33
|
+
|
|
34
|
+
// Handle the result
|
|
35
|
+
console.log(result);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
run();
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Standalone function
|
|
42
|
+
|
|
43
|
+
The standalone function version of this method:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
47
|
+
import { auditsList } from "vanta-auditor-api-sdk/funcs/auditsList.js";
|
|
48
|
+
|
|
49
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
50
|
+
// You can create one instance of it to use across an application.
|
|
51
|
+
const vanta = new VantaCore({
|
|
52
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
async function run() {
|
|
56
|
+
const res = await auditsList(vanta, {});
|
|
57
|
+
|
|
58
|
+
if (!res.ok) {
|
|
59
|
+
throw res.error;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
const { value: result } = res;
|
|
63
|
+
|
|
64
|
+
// Handle the result
|
|
65
|
+
console.log(result);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
run();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
| Parameter | Type | Required | Description |
|
|
74
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
75
|
+
| `request` | [operations.ListAuditsRequest](../../models/operations/listauditsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
76
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
77
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
78
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
79
|
+
|
|
80
|
+
### Response
|
|
81
|
+
|
|
82
|
+
**Promise\<[components.PaginatedResponseAudit](../../models/components/paginatedresponseaudit.md)\>**
|
|
83
|
+
|
|
84
|
+
### Errors
|
|
85
|
+
|
|
86
|
+
| Error Type | Status Code | Content Type |
|
|
87
|
+
| --------------- | --------------- | --------------- |
|
|
88
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
89
|
+
|
|
90
|
+
## getEvidenceUrls
|
|
91
|
+
|
|
92
|
+
Returns a paginated list of evidence urls for an audit.
|
|
93
|
+
|
|
94
|
+
### Example Usage
|
|
95
|
+
|
|
96
|
+
```typescript
|
|
97
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
98
|
+
|
|
99
|
+
const vanta = new Vanta({
|
|
100
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
async function run() {
|
|
104
|
+
const result = await vanta.audits.getEvidenceUrls({
|
|
105
|
+
auditId: "<id>",
|
|
106
|
+
auditEvidenceId: "<id>",
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
// Handle the result
|
|
110
|
+
console.log(result);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
run();
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Standalone function
|
|
117
|
+
|
|
118
|
+
The standalone function version of this method:
|
|
119
|
+
|
|
120
|
+
```typescript
|
|
121
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
122
|
+
import { auditsGetEvidenceUrls } from "vanta-auditor-api-sdk/funcs/auditsGetEvidenceUrls.js";
|
|
123
|
+
|
|
124
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
125
|
+
// You can create one instance of it to use across an application.
|
|
126
|
+
const vanta = new VantaCore({
|
|
127
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
async function run() {
|
|
131
|
+
const res = await auditsGetEvidenceUrls(vanta, {
|
|
132
|
+
auditId: "<id>",
|
|
133
|
+
auditEvidenceId: "<id>",
|
|
134
|
+
});
|
|
135
|
+
|
|
136
|
+
if (!res.ok) {
|
|
137
|
+
throw res.error;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
const { value: result } = res;
|
|
141
|
+
|
|
142
|
+
// Handle the result
|
|
143
|
+
console.log(result);
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
run();
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Parameters
|
|
150
|
+
|
|
151
|
+
| Parameter | Type | Required | Description |
|
|
152
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
153
|
+
| `request` | [operations.ListAuditEvidenceUrlsRequest](../../models/operations/listauditevidenceurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
154
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
155
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
156
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
157
|
+
|
|
158
|
+
### Response
|
|
159
|
+
|
|
160
|
+
**Promise\<[components.PaginatedResponseEvidenceUrl](../../models/components/paginatedresponseevidenceurl.md)\>**
|
|
161
|
+
|
|
162
|
+
### Errors
|
|
163
|
+
|
|
164
|
+
| Error Type | Status Code | Content Type |
|
|
165
|
+
| --------------- | --------------- | --------------- |
|
|
166
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
167
|
+
|
|
168
|
+
## listEvidence
|
|
169
|
+
|
|
170
|
+
Returns a paginated list of evidence for an audit.
|
|
171
|
+
|
|
172
|
+
### Example Usage
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
176
|
+
|
|
177
|
+
const vanta = new Vanta({
|
|
178
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
async function run() {
|
|
182
|
+
const result = await vanta.audits.listEvidence({
|
|
183
|
+
auditId: "<id>",
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
// Handle the result
|
|
187
|
+
console.log(result);
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
run();
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Standalone function
|
|
194
|
+
|
|
195
|
+
The standalone function version of this method:
|
|
196
|
+
|
|
197
|
+
```typescript
|
|
198
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
199
|
+
import { auditsListEvidence } from "vanta-auditor-api-sdk/funcs/auditsListEvidence.js";
|
|
200
|
+
|
|
201
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
202
|
+
// You can create one instance of it to use across an application.
|
|
203
|
+
const vanta = new VantaCore({
|
|
204
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
async function run() {
|
|
208
|
+
const res = await auditsListEvidence(vanta, {
|
|
209
|
+
auditId: "<id>",
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
if (!res.ok) {
|
|
213
|
+
throw res.error;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
const { value: result } = res;
|
|
217
|
+
|
|
218
|
+
// Handle the result
|
|
219
|
+
console.log(result);
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
run();
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Parameter | Type | Required | Description |
|
|
228
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
229
|
+
| `request` | [operations.ListAuditEvidenceRequest](../../models/operations/listauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
230
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
231
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
232
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
233
|
+
|
|
234
|
+
### Response
|
|
235
|
+
|
|
236
|
+
**Promise\<[components.PaginatedResponseEvidence](../../models/components/paginatedresponseevidence.md)\>**
|
|
237
|
+
|
|
238
|
+
### Errors
|
|
239
|
+
|
|
240
|
+
| Error Type | Status Code | Content Type |
|
|
241
|
+
| --------------- | --------------- | --------------- |
|
|
242
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
243
|
+
|
|
244
|
+
## listComments
|
|
245
|
+
|
|
246
|
+
Returns a paginated list of comments for an audit.
|
|
247
|
+
|
|
248
|
+
### Example Usage
|
|
249
|
+
|
|
250
|
+
```typescript
|
|
251
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
252
|
+
|
|
253
|
+
const vanta = new Vanta({
|
|
254
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
255
|
+
});
|
|
256
|
+
|
|
257
|
+
async function run() {
|
|
258
|
+
const result = await vanta.audits.listComments({
|
|
259
|
+
auditId: "<id>",
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
// Handle the result
|
|
263
|
+
console.log(result);
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
run();
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Standalone function
|
|
270
|
+
|
|
271
|
+
The standalone function version of this method:
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
275
|
+
import { auditsListComments } from "vanta-auditor-api-sdk/funcs/auditsListComments.js";
|
|
276
|
+
|
|
277
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
278
|
+
// You can create one instance of it to use across an application.
|
|
279
|
+
const vanta = new VantaCore({
|
|
280
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
281
|
+
});
|
|
282
|
+
|
|
283
|
+
async function run() {
|
|
284
|
+
const res = await auditsListComments(vanta, {
|
|
285
|
+
auditId: "<id>",
|
|
286
|
+
});
|
|
287
|
+
|
|
288
|
+
if (!res.ok) {
|
|
289
|
+
throw res.error;
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
const { value: result } = res;
|
|
293
|
+
|
|
294
|
+
// Handle the result
|
|
295
|
+
console.log(result);
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
run();
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
| Parameter | Type | Required | Description |
|
|
304
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
305
|
+
| `request` | [operations.ListAuditCommentsRequest](../../models/operations/listauditcommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
306
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
307
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
308
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
309
|
+
|
|
310
|
+
### Response
|
|
311
|
+
|
|
312
|
+
**Promise\<[components.PaginatedResponseComment](../../models/components/paginatedresponsecomment.md)\>**
|
|
313
|
+
|
|
314
|
+
### Errors
|
|
315
|
+
|
|
316
|
+
| Error Type | Status Code | Content Type |
|
|
317
|
+
| --------------- | --------------- | --------------- |
|
|
318
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
319
|
+
|
|
320
|
+
## listControls
|
|
321
|
+
|
|
322
|
+
Returns a paginated list of controls for an audit.
|
|
323
|
+
|
|
324
|
+
### Example Usage
|
|
325
|
+
|
|
326
|
+
```typescript
|
|
327
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
328
|
+
|
|
329
|
+
const vanta = new Vanta({
|
|
330
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
331
|
+
});
|
|
332
|
+
|
|
333
|
+
async function run() {
|
|
334
|
+
const result = await vanta.audits.listControls({
|
|
335
|
+
auditId: "<id>",
|
|
336
|
+
});
|
|
337
|
+
|
|
338
|
+
// Handle the result
|
|
339
|
+
console.log(result);
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
run();
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
### Standalone function
|
|
346
|
+
|
|
347
|
+
The standalone function version of this method:
|
|
348
|
+
|
|
349
|
+
```typescript
|
|
350
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
351
|
+
import { auditsListControls } from "vanta-auditor-api-sdk/funcs/auditsListControls.js";
|
|
352
|
+
|
|
353
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
354
|
+
// You can create one instance of it to use across an application.
|
|
355
|
+
const vanta = new VantaCore({
|
|
356
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
357
|
+
});
|
|
358
|
+
|
|
359
|
+
async function run() {
|
|
360
|
+
const res = await auditsListControls(vanta, {
|
|
361
|
+
auditId: "<id>",
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
if (!res.ok) {
|
|
365
|
+
throw res.error;
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
const { value: result } = res;
|
|
369
|
+
|
|
370
|
+
// Handle the result
|
|
371
|
+
console.log(result);
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
run();
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Parameters
|
|
378
|
+
|
|
379
|
+
| Parameter | Type | Required | Description |
|
|
380
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
381
|
+
| `request` | [operations.ListAuditControlsRequest](../../models/operations/listauditcontrolsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
382
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
383
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
384
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
385
|
+
|
|
386
|
+
### Response
|
|
387
|
+
|
|
388
|
+
**Promise\<[components.PaginatedResponseAuditorControl](../../models/components/paginatedresponseauditorcontrol.md)\>**
|
|
389
|
+
|
|
390
|
+
### Errors
|
|
391
|
+
|
|
392
|
+
| Error Type | Status Code | Content Type |
|
|
393
|
+
| --------------- | --------------- | --------------- |
|
|
394
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
395
|
+
|
|
396
|
+
## createCommentForEvidence
|
|
397
|
+
|
|
398
|
+
Create a comment in Vanta for a piece of evidence.
|
|
399
|
+
|
|
400
|
+
### Example Usage
|
|
401
|
+
|
|
402
|
+
```typescript
|
|
403
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
404
|
+
|
|
405
|
+
const vanta = new Vanta({
|
|
406
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
407
|
+
});
|
|
408
|
+
|
|
409
|
+
async function run() {
|
|
410
|
+
const result = await vanta.audits.createCommentForEvidence({
|
|
411
|
+
auditId: "<id>",
|
|
412
|
+
auditEvidenceId: "<id>",
|
|
413
|
+
addCommentInput: {
|
|
414
|
+
text: "<value>",
|
|
415
|
+
email: "Earnestine28@yahoo.com",
|
|
416
|
+
creationDate: new Date("2024-11-28T04:59:12.710Z"),
|
|
417
|
+
},
|
|
418
|
+
});
|
|
419
|
+
|
|
420
|
+
// Handle the result
|
|
421
|
+
console.log(result);
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
run();
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### Standalone function
|
|
428
|
+
|
|
429
|
+
The standalone function version of this method:
|
|
430
|
+
|
|
431
|
+
```typescript
|
|
432
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
433
|
+
import { auditsCreateCommentForEvidence } from "vanta-auditor-api-sdk/funcs/auditsCreateCommentForEvidence.js";
|
|
434
|
+
|
|
435
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
436
|
+
// You can create one instance of it to use across an application.
|
|
437
|
+
const vanta = new VantaCore({
|
|
438
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
439
|
+
});
|
|
440
|
+
|
|
441
|
+
async function run() {
|
|
442
|
+
const res = await auditsCreateCommentForEvidence(vanta, {
|
|
443
|
+
auditId: "<id>",
|
|
444
|
+
auditEvidenceId: "<id>",
|
|
445
|
+
addCommentInput: {
|
|
446
|
+
text: "<value>",
|
|
447
|
+
email: "Earnestine28@yahoo.com",
|
|
448
|
+
creationDate: new Date("2024-11-28T04:59:12.710Z"),
|
|
449
|
+
},
|
|
450
|
+
});
|
|
451
|
+
|
|
452
|
+
if (!res.ok) {
|
|
453
|
+
throw res.error;
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
const { value: result } = res;
|
|
457
|
+
|
|
458
|
+
// Handle the result
|
|
459
|
+
console.log(result);
|
|
460
|
+
}
|
|
461
|
+
|
|
462
|
+
run();
|
|
463
|
+
```
|
|
464
|
+
|
|
465
|
+
### Parameters
|
|
466
|
+
|
|
467
|
+
| Parameter | Type | Required | Description |
|
|
468
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
469
|
+
| `request` | [operations.CreateCommentForAuditEvidenceRequest](../../models/operations/createcommentforauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
470
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
471
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
472
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
473
|
+
|
|
474
|
+
### Response
|
|
475
|
+
|
|
476
|
+
**Promise\<[components.Comment](../../models/components/comment.md)\>**
|
|
477
|
+
|
|
478
|
+
### Errors
|
|
479
|
+
|
|
480
|
+
| Error Type | Status Code | Content Type |
|
|
481
|
+
| --------------- | --------------- | --------------- |
|
|
482
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
483
|
+
|
|
484
|
+
## updateEvidence
|
|
485
|
+
|
|
486
|
+
Update audit evidence.
|
|
487
|
+
|
|
488
|
+
### Example Usage
|
|
489
|
+
|
|
490
|
+
```typescript
|
|
491
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
492
|
+
|
|
493
|
+
const vanta = new Vanta({
|
|
494
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
495
|
+
});
|
|
496
|
+
|
|
497
|
+
async function run() {
|
|
498
|
+
const result = await vanta.audits.updateEvidence({
|
|
499
|
+
auditId: "<id>",
|
|
500
|
+
auditEvidenceId: "<id>",
|
|
501
|
+
auditEvidenceUpdateInput: {},
|
|
502
|
+
});
|
|
503
|
+
|
|
504
|
+
// Handle the result
|
|
505
|
+
console.log(result);
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
run();
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
### Standalone function
|
|
512
|
+
|
|
513
|
+
The standalone function version of this method:
|
|
514
|
+
|
|
515
|
+
```typescript
|
|
516
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
517
|
+
import { auditsUpdateEvidence } from "vanta-auditor-api-sdk/funcs/auditsUpdateEvidence.js";
|
|
518
|
+
|
|
519
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
520
|
+
// You can create one instance of it to use across an application.
|
|
521
|
+
const vanta = new VantaCore({
|
|
522
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
523
|
+
});
|
|
524
|
+
|
|
525
|
+
async function run() {
|
|
526
|
+
const res = await auditsUpdateEvidence(vanta, {
|
|
527
|
+
auditId: "<id>",
|
|
528
|
+
auditEvidenceId: "<id>",
|
|
529
|
+
auditEvidenceUpdateInput: {},
|
|
530
|
+
});
|
|
531
|
+
|
|
532
|
+
if (!res.ok) {
|
|
533
|
+
throw res.error;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
const { value: result } = res;
|
|
537
|
+
|
|
538
|
+
// Handle the result
|
|
539
|
+
console.log(result);
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
run();
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
### Parameters
|
|
546
|
+
|
|
547
|
+
| Parameter | Type | Required | Description |
|
|
548
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
549
|
+
| `request` | [operations.UpdateAuditEvidenceRequest](../../models/operations/updateauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
550
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
551
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
552
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
553
|
+
|
|
554
|
+
### Response
|
|
555
|
+
|
|
556
|
+
**Promise\<[components.Evidence](../../models/components/evidence.md)\>**
|
|
557
|
+
|
|
558
|
+
### Errors
|
|
559
|
+
|
|
560
|
+
| Error Type | Status Code | Content Type |
|
|
561
|
+
| --------------- | --------------- | --------------- |
|
|
562
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
563
|
+
|
|
564
|
+
## createCustomEvidenceRequest
|
|
565
|
+
|
|
566
|
+
Create a custom evidence request for an audit.
|
|
567
|
+
|
|
568
|
+
### Example Usage
|
|
569
|
+
|
|
570
|
+
```typescript
|
|
571
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
572
|
+
|
|
573
|
+
const vanta = new Vanta({
|
|
574
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
575
|
+
});
|
|
576
|
+
|
|
577
|
+
async function run() {
|
|
578
|
+
const result = await vanta.audits.createCustomEvidenceRequest({
|
|
579
|
+
auditId: "<id>",
|
|
580
|
+
createCustomEvidenceRequestInput: {
|
|
581
|
+
controlIds: [
|
|
582
|
+
"<value>",
|
|
583
|
+
],
|
|
584
|
+
title: "<value>",
|
|
585
|
+
description: "now whoa while",
|
|
586
|
+
cadence: "P3M",
|
|
587
|
+
reminderWindow: "P0D",
|
|
588
|
+
isRestricted: true,
|
|
589
|
+
},
|
|
590
|
+
});
|
|
591
|
+
|
|
592
|
+
// Handle the result
|
|
593
|
+
console.log(result);
|
|
594
|
+
}
|
|
595
|
+
|
|
596
|
+
run();
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
### Standalone function
|
|
600
|
+
|
|
601
|
+
The standalone function version of this method:
|
|
602
|
+
|
|
603
|
+
```typescript
|
|
604
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
605
|
+
import { auditsCreateCustomEvidenceRequest } from "vanta-auditor-api-sdk/funcs/auditsCreateCustomEvidenceRequest.js";
|
|
606
|
+
|
|
607
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
608
|
+
// You can create one instance of it to use across an application.
|
|
609
|
+
const vanta = new VantaCore({
|
|
610
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
611
|
+
});
|
|
612
|
+
|
|
613
|
+
async function run() {
|
|
614
|
+
const res = await auditsCreateCustomEvidenceRequest(vanta, {
|
|
615
|
+
auditId: "<id>",
|
|
616
|
+
createCustomEvidenceRequestInput: {
|
|
617
|
+
controlIds: [
|
|
618
|
+
"<value>",
|
|
619
|
+
],
|
|
620
|
+
title: "<value>",
|
|
621
|
+
description: "now whoa while",
|
|
622
|
+
cadence: "P3M",
|
|
623
|
+
reminderWindow: "P0D",
|
|
624
|
+
isRestricted: true,
|
|
625
|
+
},
|
|
626
|
+
});
|
|
627
|
+
|
|
628
|
+
if (!res.ok) {
|
|
629
|
+
throw res.error;
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
const { value: result } = res;
|
|
633
|
+
|
|
634
|
+
// Handle the result
|
|
635
|
+
console.log(result);
|
|
636
|
+
}
|
|
637
|
+
|
|
638
|
+
run();
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
### Parameters
|
|
642
|
+
|
|
643
|
+
| Parameter | Type | Required | Description |
|
|
644
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
645
|
+
| `request` | [operations.CreateCustomEvidenceRequestRequest](../../models/operations/createcustomevidencerequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
646
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
647
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
648
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
649
|
+
|
|
650
|
+
### Response
|
|
651
|
+
|
|
652
|
+
**Promise\<[components.CustomEvidenceRequest](../../models/components/customevidencerequest.md)\>**
|
|
653
|
+
|
|
654
|
+
### Errors
|
|
655
|
+
|
|
656
|
+
| Error Type | Status Code | Content Type |
|
|
657
|
+
| --------------- | --------------- | --------------- |
|
|
658
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
659
|
+
|
|
660
|
+
## createCustomControl
|
|
661
|
+
|
|
662
|
+
Create a custom control for an audit.
|
|
663
|
+
|
|
664
|
+
### Example Usage
|
|
665
|
+
|
|
666
|
+
```typescript
|
|
667
|
+
import { Vanta } from "vanta-auditor-api-sdk";
|
|
668
|
+
|
|
669
|
+
const vanta = new Vanta({
|
|
670
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
671
|
+
});
|
|
672
|
+
|
|
673
|
+
async function run() {
|
|
674
|
+
const result = await vanta.audits.createCustomControl({
|
|
675
|
+
auditId: "<id>",
|
|
676
|
+
createCustomControlInput: {
|
|
677
|
+
externalId: "<id>",
|
|
678
|
+
name: "<value>",
|
|
679
|
+
description: "even keenly afore mmm yearningly ouch tough yearly intent",
|
|
680
|
+
effectiveDate: new Date("2024-07-08T11:52:30.590Z"),
|
|
681
|
+
category: "THREAT_MANAGEMENT",
|
|
682
|
+
},
|
|
683
|
+
});
|
|
684
|
+
|
|
685
|
+
// Handle the result
|
|
686
|
+
console.log(result);
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
run();
|
|
690
|
+
```
|
|
691
|
+
|
|
692
|
+
### Standalone function
|
|
693
|
+
|
|
694
|
+
The standalone function version of this method:
|
|
695
|
+
|
|
696
|
+
```typescript
|
|
697
|
+
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
|
|
698
|
+
import { auditsCreateCustomControl } from "vanta-auditor-api-sdk/funcs/auditsCreateCustomControl.js";
|
|
699
|
+
|
|
700
|
+
// Use `VantaCore` for best tree-shaking performance.
|
|
701
|
+
// You can create one instance of it to use across an application.
|
|
702
|
+
const vanta = new VantaCore({
|
|
703
|
+
bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
|
|
704
|
+
});
|
|
705
|
+
|
|
706
|
+
async function run() {
|
|
707
|
+
const res = await auditsCreateCustomControl(vanta, {
|
|
708
|
+
auditId: "<id>",
|
|
709
|
+
createCustomControlInput: {
|
|
710
|
+
externalId: "<id>",
|
|
711
|
+
name: "<value>",
|
|
712
|
+
description: "even keenly afore mmm yearningly ouch tough yearly intent",
|
|
713
|
+
effectiveDate: new Date("2024-07-08T11:52:30.590Z"),
|
|
714
|
+
category: "THREAT_MANAGEMENT",
|
|
715
|
+
},
|
|
716
|
+
});
|
|
717
|
+
|
|
718
|
+
if (!res.ok) {
|
|
719
|
+
throw res.error;
|
|
720
|
+
}
|
|
721
|
+
|
|
722
|
+
const { value: result } = res;
|
|
723
|
+
|
|
724
|
+
// Handle the result
|
|
725
|
+
console.log(result);
|
|
726
|
+
}
|
|
727
|
+
|
|
728
|
+
run();
|
|
729
|
+
```
|
|
730
|
+
|
|
731
|
+
### Parameters
|
|
732
|
+
|
|
733
|
+
| Parameter | Type | Required | Description |
|
|
734
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
735
|
+
| `request` | [operations.CreateCustomControlRequest](../../models/operations/createcustomcontrolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
736
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
737
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
738
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
739
|
+
|
|
740
|
+
### Response
|
|
741
|
+
|
|
742
|
+
**Promise\<[components.Control](../../models/components/control.md)\>**
|
|
743
|
+
|
|
744
|
+
### Errors
|
|
745
|
+
|
|
746
|
+
| Error Type | Status Code | Content Type |
|
|
747
|
+
| --------------- | --------------- | --------------- |
|
|
748
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|